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.
28 #include "evoral/EventList.hpp"
30 #include "ardour/debug.h"
31 #include "ardour/midi_model.h"
32 #include "ardour/midi_playlist.h"
33 #include "ardour/midi_region.h"
34 #include "ardour/types.h"
38 using namespace ARDOUR;
42 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
43 : Playlist (session, node, DataType::MIDI, hidden)
44 , _note_mode(Sustained)
47 const XMLProperty* prop = node.property("type");
48 assert(prop && DataType(prop->value()) == DataType::MIDI);
52 if (set_state (node, Stateful::loading_state_version)) {
53 throw failed_constructor ();
60 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
61 : Playlist (session, name, DataType::MIDI, hidden)
62 , _note_mode(Sustained)
66 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
67 : Playlist (other, name, hidden)
68 , _note_mode(other->_note_mode)
72 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, framepos_t start, framecnt_t dur, string name, bool hidden)
73 : Playlist (other, start, dur, name, hidden)
74 , _note_mode(other->_note_mode)
76 /* this constructor does NOT notify others (session) */
79 MidiPlaylist::~MidiPlaylist ()
83 template<typename Time>
84 struct EventsSortByTimeAndType {
85 bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
86 if (a->time() == b->time()) {
87 if (EventTypeMap::instance().type_is_midi (a->event_type()) && EventTypeMap::instance().type_is_midi (b->event_type())) {
88 /* negate return value since we must return whether
89 * or not a should sort before b, not b before a
91 return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
94 return a->time() < b->time();
98 /** Returns the number of frames in time duration read (eg could be large when 0 events are read) */
100 MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framecnt_t dur, unsigned chan_n)
102 /* this function is never called from a realtime thread, so
103 its OK to block (for short intervals).
106 Playlist::RegionReadLock rl (this);
108 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("++++++ %1 .. %2 +++++++ %3 trackers +++++++++++++++++\n",
109 start, start + dur, _note_trackers.size()));
111 framepos_t end = start + dur - 1;
113 // relevent regions overlapping start <--> end
114 vector< boost::shared_ptr<Region> > regs;
115 vector< boost::shared_ptr<Region> > ended;
116 typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
117 vector<TrackerInfo> tracker_info;
118 NoteTrackers::iterator t;
120 for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
122 /* in this call to coverage, the return value indicates the
123 * overlap status of the read range (start...end) WRT to
127 switch ((*i)->coverage (start, end)) {
128 case Evoral::OverlapStart:
129 case Evoral::OverlapInternal:
130 case Evoral::OverlapExternal:
134 case Evoral::OverlapEnd:
135 /* this region ends within the read range */
137 ended.push_back (*i);
145 if (regs.size() == 1 &&
146 (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()))) {
148 /* just a single region - read directly into dst */
150 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Single region (%1) read, ended during this read %2\n", regs.front()->name(),
153 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(regs.front());
157 NoteTrackers::iterator t = _note_trackers.find (mr.get());
158 MidiStateTracker* tracker;
159 bool new_tracker = false;
161 if (t == _note_trackers.end()) {
162 tracker = new MidiStateTracker;
164 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
167 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
170 mr->read_at (dst, start, dur, chan_n, _note_mode, tracker);
171 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
173 if (!ended.empty()) {
174 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1 ended in this read, resolve notes and delete (%2) tracker\n",
175 mr->name(), ((new_tracker) ? "new" : "old")));
176 tracker->resolve_notes (dst, mr->last_frame());
179 _note_trackers.erase (t);
183 pair<Region*,MidiStateTracker*> newpair;
184 newpair.first = mr.get();
185 newpair.second = tracker;
186 _note_trackers.insert (newpair);
187 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
194 /* multiple regions and/or note resolution: sort by layer, read into a temporary non-monotonically
195 sorted EventSink, sort and then insert into dst.
198 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("%1 regions to read, plus %2 trackers\n", regs.size(), tracker_info.size()));
200 Evoral::EventList<framepos_t> evlist;
202 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("for %1 .. %2 we have %3 to consider\n", start, start+dur-1, regs.size()));
204 for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
206 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
212 NoteTrackers::iterator t = _note_trackers.find (mr.get());
213 MidiStateTracker* tracker;
214 bool new_tracker = false;
216 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Before %1 (%2 .. %3) we now have %4 events\n", mr->name(), mr->position(), mr->last_frame(), evlist.size()));
218 if (t == _note_trackers.end()) {
219 tracker = new MidiStateTracker;
221 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
224 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
228 mr->read_at (evlist, start, dur, chan_n, _note_mode, tracker);
231 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After %1 (%2 .. %3) we now have %4\n", mr->name(), mr->position(), mr->last_frame(), evlist.size()));
232 for (Evoral::EventList<framepos_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
233 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
235 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
237 if (find (ended.begin(), ended.end(), *i) != ended.end()) {
239 /* the region ended within the read range, so
240 * resolve any dangling notes (i.e. notes whose
241 * end is beyond the end of the region).
244 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1 ended in this read, resolve notes and delete (%2) tracker\n",
245 mr->name(), ((new_tracker) ? "new" : "old")));
247 tracker->resolve_notes (evlist, (*i)->last_frame());
250 _note_trackers.erase (t);
256 _note_trackers.insert (make_pair (mr.get(), tracker));
257 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
262 if (!evlist.empty()) {
264 /* sort the event list */
265 EventsSortByTimeAndType<framepos_t> cmp;
269 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Final we now have %1 events\n", evlist.size()));
270 for (Evoral::EventList<framepos_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
271 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
275 for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
276 Evoral::Event<framepos_t>* ev (*e);
277 dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
284 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "-------------------------------------------------------------\n");
289 MidiPlaylist::clear_note_trackers ()
291 Playlist::RegionWriteLock rl (this, false);
293 for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
296 DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 clears all note trackers\n", name()));
297 _note_trackers.clear ();
301 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
303 /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
304 NoteTrackers::iterator t = _note_trackers.find (region.get());
306 /* GACK! THREAD SAFETY! */
308 if (t != _note_trackers.end()) {
310 _note_trackers.erase (t);
315 MidiPlaylist::set_state (const XMLNode& node, int version)
320 if (Playlist::set_state (node, version)) {
331 MidiPlaylist::dump () const
333 boost::shared_ptr<Region> r;
335 cerr << "Playlist \"" << _name << "\" " << endl
336 << regions.size() << " regions "
339 for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
341 cerr << " " << r->name() << " @ " << r << " ["
342 << r->start() << "+" << r->length()
352 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
354 boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
360 bool changed = false;
363 RegionWriteLock rlock (this);
364 RegionList::iterator i;
365 RegionList::iterator tmp;
367 for (i = regions.begin(); i != regions.end(); ) {
372 if ((*i) == region) {
383 /* overload this, it normally means "removed", not destroyed */
384 notify_region_removed (region);
390 set<Evoral::Parameter>
391 MidiPlaylist::contained_automation()
393 /* this function is never called from a realtime thread, so
394 its OK to block (for short intervals).
397 Playlist::RegionReadLock rl (this);
398 set<Evoral::Parameter> ret;
400 for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
401 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
403 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
404 c != mr->model()->controls().end(); ++c) {
405 ret.insert(c->first);
414 MidiPlaylist::region_changed (const PBD::PropertyChange& what_changed, boost::shared_ptr<Region> region)
416 if (in_flush || in_set_state) {
420 PBD::PropertyChange our_interests;
421 our_interests.add (Properties::midi_data);
423 bool parent_wants_notify = Playlist::region_changed (what_changed, region);
425 if (parent_wants_notify || what_changed.contains (our_interests)) {
426 notify_contents_changed ();