summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/midi_model.h
blob: 8e7d7867225546f10f77b0dae92c3d50c6906115 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
/*
    Copyright (C) 2007 Paul Davis
    Author: Dave Robillard

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_midi_model_h__ 
#define __ardour_midi_model_h__

#include <queue>
#include <deque>
#include <utility>
#include <boost/utility.hpp>
#include <glibmm/thread.h>
#include <pbd/command.h>
#include <ardour/types.h>
#include <ardour/midi_buffer.h>
#include <ardour/midi_ring_buffer.h>
#include <ardour/automatable.h>
#include <ardour/note.h>

namespace ARDOUR {

class Session;
class MidiSource;
	
//                                                                     x   ,  y
typedef std::pair<boost::shared_ptr<const AutomationList>, std::pair<double,double> >
		MidiControlIterator;


/** This is a slightly higher level (than MidiBuffer) model of MIDI note data.
 * Currently it only represents note data, which is represented as complete
 * note events (ie with a start time and a duration) rather than separate
 * note on and off events (controller data is not here since it's represented
 * as an AutomationList)
 */
class MidiModel : public boost::noncopyable, public Automatable {
public:
	MidiModel(Session& s, size_t size=0);
	
	// This is crap.
	void write_lock()        { _lock.writer_lock(); _automation_lock.lock(); }
	void write_unlock()      { _lock.writer_unlock(); _automation_lock.unlock(); }
	void read_lock()   const { _lock.reader_lock(); /*_automation_lock.lock();*/ }
	void read_unlock() const { _lock.reader_unlock(); /*_automation_lock.unlock();*/ }

	void clear() { _notes.clear(); }

	NoteMode note_mode() const            { return _note_mode; }
	void     set_note_mode(NoteMode mode) { _note_mode = mode; }

	void start_write();
	bool writing() const { return _writing; }
	void end_write(bool delete_stuck=false);

	size_t read (MidiRingBuffer& dst, nframes_t start, nframes_t nframes, nframes_t stamp_offset) const;

	/** Resizes vector if necessary (NOT realtime safe) */
	void append(const MidiEvent& ev);
	
	inline const boost::shared_ptr<const Note> note_at(unsigned i) const { return _notes[i]; }
	inline const boost::shared_ptr<Note>       note_at(unsigned i)       { return _notes[i]; }

	inline size_t n_notes() const { return _notes.size(); }
	inline bool   empty()   const { return _notes.size() == 0 && _controls.size() == 0; }

	/* FIXME: use better data structure */
	typedef std::vector< boost::shared_ptr<Note> > Notes;
	
	inline static bool note_time_comparator (const boost::shared_ptr<const Note> a,
	                                         const boost::shared_ptr<const Note> b) { 
		return a->time() < b->time();
	}

	struct LaterNoteEndComparator {
		typedef const Note* value_type;
		inline bool operator()(const boost::shared_ptr<const Note> a,
		                       const boost::shared_ptr<const Note> b) const { 
			return a->end_time() > b->end_time();
		}
	};

	inline       Notes& notes()       { return _notes; }
	inline const Notes& notes() const { return _notes; }
	
	/** Add/Remove notes.
	 * Technically all operations can be implemented as one of these.
	 */
	class DeltaCommand : public Command
	{
	public:
		DeltaCommand (MidiModel& m, const std::string& name)
			: Command(name), _model(m), _name(name) {}
		//DeltaCommand (MidiModel&, const XMLNode& node);

		const std::string& name() const { return _name; }
		
		void operator()();
		void undo();
		
		/*int set_state (const XMLNode&);
		XMLNode& get_state ();*/

		void add(const boost::shared_ptr<Note> note);
		void remove(const boost::shared_ptr<Note> note);

	private:
		MidiModel&                           _model;
		const std::string                    _name;
		std::list< boost::shared_ptr<Note> > _added_notes;
		std::list< boost::shared_ptr<Note> > _removed_notes;
	};

	MidiModel::DeltaCommand* new_delta_command(const std::string name="midi edit");
	void                     apply_command(Command* cmd);

	bool edited() const { return _edited; }
	void set_edited(bool yn) { _edited = yn; }
	bool write_to(boost::shared_ptr<MidiSource> source);
		
	// MidiModel doesn't use the normal AutomationList serialisation code, as CC data is in the .mid
	XMLNode& get_state();
	int set_state(const XMLNode&) { return 0; }

	sigc::signal<void> ContentsChanged;
	
	/** Read iterator */
	class const_iterator {
	public:
		const_iterator(const MidiModel& model, double t);
		~const_iterator();

		inline bool locked() const { return _locked; }

		const MidiEvent& operator*()  const { return _event; }
		const MidiEvent* operator->() const { return &_event; }

		const const_iterator& operator++(); // prefix only
		bool operator==(const const_iterator& other) const;
		bool operator!=(const const_iterator& other) const { return ! operator==(other); }
		
		const_iterator& operator=(const const_iterator& other);

	private:
		friend class MidiModel;

		const MidiModel* _model;
		MidiEvent        _event;

		typedef std::priority_queue<
				boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
				LaterNoteEndComparator>
			ActiveNotes;
		
		mutable ActiveNotes _active_notes;

		bool                                       _is_end;
		bool                                       _locked;
		Notes::const_iterator                      _note_iter;
		std::vector<MidiControlIterator>           _control_iters;
		std::vector<MidiControlIterator>::iterator _control_iter;
	};
	
	const_iterator        begin() const { return const_iterator(*this, 0); }
	const const_iterator& end()   const { return _end_iter; }
	
private:
	friend class DeltaCommand;
	void add_note_unlocked(const boost::shared_ptr<Note> note);
	void remove_note_unlocked(const boost::shared_ptr<const Note> note);

	friend class const_iterator;
	bool control_to_midi_event(MidiEvent& ev, const MidiControlIterator& iter) const;

#ifndef NDEBUG
	bool is_sorted() const;
#endif

	void append_note_on_unlocked(double time, uint8_t note, uint8_t velocity);
	void append_note_off_unlocked(double time, uint8_t note);
	void append_cc_unlocked(double time, uint8_t number, uint8_t value);

	mutable Glib::RWLock _lock;

	Notes    _notes;
	NoteMode _note_mode;
	
	typedef std::vector<size_t> WriteNotes;
	WriteNotes _write_notes;
	bool       _writing;
	bool       _edited;

	const const_iterator _end_iter;

	mutable nframes_t      _next_read;
	mutable const_iterator _read_iter;

	typedef std::priority_queue<
			boost::shared_ptr<Note>, std::deque< boost::shared_ptr<Note> >,
			LaterNoteEndComparator>
		ActiveNotes;
};

} /* namespace ARDOUR */

#endif /* __ardour_midi_model_h__ */