2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "evoral/EventList.hpp"
28 #include "ardour/beats_frames_converter.h"
29 #include "ardour/debug.h"
30 #include "ardour/midi_model.h"
31 #include "ardour/midi_playlist.h"
32 #include "ardour/midi_region.h"
33 #include "ardour/midi_source.h"
34 #include "ardour/midi_state_tracker.h"
35 #include "ardour/session.h"
36 #include "ardour/types.h"
40 using namespace ARDOUR;
44 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
45 : Playlist (session, node, DataType::MIDI, hidden)
46 , _note_mode(Sustained)
50 const XMLProperty* prop = node.property("type");
51 assert(prop && DataType(prop->value()) == DataType::MIDI);
55 if (set_state (node, Stateful::loading_state_version)) {
56 throw failed_constructor ();
63 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
64 : Playlist (session, name, DataType::MIDI, hidden)
65 , _note_mode(Sustained)
70 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
71 : Playlist (other, name, hidden)
72 , _note_mode(other->_note_mode)
77 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
82 : Playlist (other, start, dur, name, hidden)
83 , _note_mode(other->_note_mode)
88 MidiPlaylist::~MidiPlaylist ()
92 template<typename Time>
93 struct EventsSortByTimeAndType {
94 bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
95 if (a->time() == b->time()) {
96 if (parameter_is_midi ((AutomationType)a->event_type()) &&
97 parameter_is_midi ((AutomationType)b->event_type())) {
98 /* negate return value since we must return whether
99 * or not a should sort before b, not b before a
101 return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
104 return a->time() < b->time();
109 MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst,
113 MidiChannelFilter* filter)
115 typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
117 Playlist::RegionReadLock rl (this);
119 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
120 string_compose ("---- MidiPlaylist::read %1 .. %2 (%3 trackers) ----\n",
121 start, start + dur, _note_trackers.size()));
123 /* First, emit any queued edit fixup events at start. */
124 for (NoteTrackers::iterator t = _note_trackers.begin(); t != _note_trackers.end(); ++t) {
125 t->second->fixer.emit(dst, _read_end, t->second->tracker);
128 /* Find relevant regions that overlap [start..end] */
129 const framepos_t end = start + dur - 1;
130 std::vector< boost::shared_ptr<Region> > regs;
131 std::vector< boost::shared_ptr<Region> > ended;
132 for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
133 switch ((*i)->coverage (start, end)) {
134 case Evoral::OverlapStart:
135 case Evoral::OverlapInternal:
139 case Evoral::OverlapExternal:
140 /* this region is entirely contained in the read range */
142 ended.push_back (*i);
145 case Evoral::OverlapEnd:
146 /* this region ends within the read range */
148 ended.push_back (*i);
157 /* If we are reading from a single region, we can read directly into dst. Otherwise,
158 we read into a temporarily list, sort it, then write that to dst. */
159 const bool direct_read = regs.size() == 1 &&
160 (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()));
162 Evoral::EventList<framepos_t> evlist;
163 Evoral::EventSink<framepos_t>& tgt = direct_read ? dst : evlist;
165 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
166 string_compose ("\t%1 regions to read, direct: %2\n", regs.size(), direct_read));
168 for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
169 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
174 /* Get the existing note tracker for this region, or create a new one. */
175 NoteTrackers::iterator t = _note_trackers.find (mr.get());
176 bool new_tracker = false;
177 boost::shared_ptr<RegionTracker> tracker;
178 if (t == _note_trackers.end()) {
179 tracker = boost::shared_ptr<RegionTracker>(new RegionTracker);
181 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
182 string_compose ("\tPre-read %1 (%2 .. %3): new tracker\n",
183 mr->name(), mr->position(), mr->last_frame()));
186 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
187 string_compose ("\tPre-read %1 (%2 .. %3): %4 active notes\n",
188 mr->name(), mr->position(), mr->last_frame(), tracker->tracker.on()));
191 /* Read from region into target. */
192 mr->read_at (tgt, start, dur, chan_n, _note_mode, &tracker->tracker, filter);
193 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
194 string_compose ("\tPost-read: %1 active notes\n", tracker->tracker.on()));
196 if (find (ended.begin(), ended.end(), *i) != ended.end()) {
197 /* Region ended within the read range, so resolve any active notes
198 (either stuck notes in the data, or notes that end after the end
200 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
201 string_compose ("\t%1 ended, resolve notes and delete (%2) tracker\n",
202 mr->name(), ((new_tracker) ? "new" : "old")));
204 tracker->tracker.resolve_notes (tgt, (*i)->last_frame());
206 _note_trackers.erase (t);
212 _note_trackers.insert (make_pair (mr.get(), tracker));
213 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
218 if (!direct_read && !evlist.empty()) {
219 /* We've read from multiple regions, sort the event list by time. */
220 EventsSortByTimeAndType<framepos_t> cmp;
223 /* Copy ordered events from event list to dst. */
224 for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
225 Evoral::Event<framepos_t>* ev (*e);
226 dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
231 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "---- End MidiPlaylist::read ----\n");
232 _read_end = start + dur;
237 MidiPlaylist::region_edited(boost::shared_ptr<Region> region,
238 const MidiModel::NoteDiffCommand* cmd)
240 typedef MidiModel::NoteDiffCommand Command;
242 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
243 if (!mr || !_session.transport_rolling()) {
247 /* Take write lock to prevent concurrency with read(). */
248 Playlist::RegionWriteLock lock(this);
250 NoteTrackers::iterator t = _note_trackers.find(mr.get());
251 if (t == _note_trackers.end()) {
252 return; /* Region is not currently active, nothing to do. */
255 /* Queue any necessary edit compensation events. */
256 t->second->fixer.prepare(
257 _session.tempo_map(), cmd, mr->position() - mr->start(),
258 _read_end, mr->midi_source()->model()->active_notes());
262 MidiPlaylist::reset_note_trackers ()
264 Playlist::RegionWriteLock rl (this, false);
266 DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 reset all note trackers\n", name()));
267 _note_trackers.clear ();
271 MidiPlaylist::resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time)
273 Playlist::RegionWriteLock rl (this, false);
275 for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
276 n->second->tracker.resolve_notes(dst, time);
278 DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 resolve all note trackers\n", name()));
279 _note_trackers.clear ();
283 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
285 /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
286 _note_trackers.erase(region.get());
290 MidiPlaylist::set_state (const XMLNode& node, int version)
295 if (Playlist::set_state (node, version)) {
306 MidiPlaylist::dump () const
308 boost::shared_ptr<Region> r;
310 cerr << "Playlist \"" << _name << "\" " << endl
311 << regions.size() << " regions "
314 for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
316 cerr << " " << r->name() << " @ " << r << " ["
317 << r->start() << "+" << r->length()
327 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
329 boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
335 bool changed = false;
338 RegionWriteLock rlock (this);
339 RegionList::iterator i;
340 RegionList::iterator tmp;
342 for (i = regions.begin(); i != regions.end(); ) {
347 if ((*i) == region) {
358 /* overload this, it normally means "removed", not destroyed */
359 notify_region_removed (region);
365 set<Evoral::Parameter>
366 MidiPlaylist::contained_automation()
368 /* this function is never called from a realtime thread, so
369 its OK to block (for short intervals).
372 Playlist::RegionReadLock rl (this);
373 set<Evoral::Parameter> ret;
375 for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
376 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
378 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
379 c != mr->model()->controls().end(); ++c) {
380 ret.insert(c->first);