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.
27 #include "pbd/error.h"
29 #include "evoral/EventList.hpp"
31 #include "ardour/configuration.h"
32 #include "ardour/debug.h"
33 #include "ardour/midi_model.h"
34 #include "ardour/midi_playlist.h"
35 #include "ardour/midi_region.h"
36 #include "ardour/midi_ring_buffer.h"
37 #include "ardour/session.h"
38 #include "ardour/types.h"
42 using namespace ARDOUR;
46 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
47 : Playlist (session, node, DataType::MIDI, hidden)
48 , _note_mode(Sustained)
51 const XMLProperty* prop = node.property("type");
52 assert(prop && DataType(prop->value()) == DataType::MIDI);
56 if (set_state (node, Stateful::loading_state_version)) {
57 throw failed_constructor ();
62 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
63 : Playlist (session, name, DataType::MIDI, hidden)
64 , _note_mode(Sustained)
68 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
69 : Playlist (other, name, hidden)
70 , _note_mode(other->_note_mode)
74 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, framepos_t start, framecnt_t dur, string name, bool hidden)
75 : Playlist (other, start, dur, name, hidden)
76 , _note_mode(other->_note_mode)
78 /* this constructor does NOT notify others (session) */
81 MidiPlaylist::~MidiPlaylist ()
85 template<typename Time>
86 struct EventsSortByTime {
87 bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
88 return a->time() < b->time();
92 /** Returns the number of frames in time duration read (eg could be large when 0 events are read) */
94 MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framecnt_t dur, unsigned chan_n)
96 /* this function is never called from a realtime thread, so
97 its OK to block (for short intervals).
100 Glib::RecMutex::Lock rm (region_lock);
101 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("++++++ %1 .. %2 +++++++++++++++++++++++++++++++++++++++++++++++\n", start, start + dur));
103 framepos_t end = start + dur - 1;
105 // relevent regions overlapping start <--> end
106 vector< boost::shared_ptr<Region> > regs;
107 typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
108 vector<TrackerInfo> tracker_info;
109 uint32_t note_cnt = 0;
111 for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
112 if ((*i)->coverage (start, end) != OverlapNone) {
115 NoteTrackers::iterator t = _note_trackers.find ((*i).get());
116 if (t != _note_trackers.end()) {
118 /* add it the set of trackers we will do note resolution
119 on, and remove it from the list we are keeping
120 around, because we don't need it anymore.
122 if the end of the region (where we want to theoretically resolve notes)
123 is outside the current read range, then just do it at the start
127 framepos_t resolve_at = (*i)->last_frame();
128 if (resolve_at < start || resolve_at >= end) {
132 tracker_info.push_back (TrackerInfo (t->second, resolve_at));
133 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("time to resolve & remove tracker for %1 @ %2\n", (*i)->name(), resolve_at));
134 note_cnt += (t->second->on());
135 _note_trackers.erase (t);
140 if (note_cnt == 0 && !tracker_info.empty()) {
141 /* trackers to dispose of, but they have no notes in them */
142 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Clearing %1 empty trackers\n", tracker_info.size()));
143 for (vector<TrackerInfo>::iterator t = tracker_info.begin(); t != tracker_info.end(); ++t) {
146 tracker_info.clear ();
149 if (regs.size() == 1 && tracker_info.empty()) {
151 /* just a single region - read directly into dst */
153 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Single region (%1) read, no out-of-bound region tracking info\n", regs.front()->name()));
155 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(regs.front());
159 NoteTrackers::iterator t = _note_trackers.find (mr.get());
160 MidiStateTracker* tracker;
161 bool new_tracker = false;
163 if (t == _note_trackers.end()) {
164 tracker = new MidiStateTracker;
166 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
169 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
172 mr->read_at (dst, start, dur, chan_n, _note_mode, tracker);
173 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
176 pair<Region*,MidiStateTracker*> newpair;
177 newpair.first = mr.get();
178 newpair.second = tracker;
179 _note_trackers.insert (newpair);
180 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
186 /* multiple regions and/or note resolution: sort by layer, read into a temporary non-monotonically
187 sorted EventSink, sort and then insert into dst.
190 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("%1 regions to read, plus %2 trackers\n", regs.size(), tracker_info.size()));
192 Evoral::EventList<framepos_t> evlist;
194 for (vector<TrackerInfo>::iterator t = tracker_info.begin(); t != tracker_info.end(); ++t) {
195 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Resolve %1 notes\n", (*t).first->on()));
196 (*t).first->resolve_notes (evlist, (*t).second);
201 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After resolution we now have %1 events\n", evlist.size()));
202 for (Evoral::EventList<framepos_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
203 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
207 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("for %1 .. %2 we have %3 to consider\n", start, start+dur-1, regs.size()));
209 for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
210 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
215 NoteTrackers::iterator t = _note_trackers.find (mr.get());
216 MidiStateTracker* tracker;
217 bool new_tracker = false;
220 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()));
222 if (t == _note_trackers.end()) {
223 tracker = new MidiStateTracker;
225 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tBEFORE: new tracker\n");
228 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tBEFORE: tracker says there are %1 on notes\n", tracker->on()));
232 mr->read_at (evlist, start, dur, chan_n, _note_mode, tracker);
235 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("After %1 (%2 .. %3) we now have %4\n", mr->name(), mr->position(), mr->last_frame(), evlist.size()));
236 for (Evoral::EventList<framepos_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
237 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
239 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\tAFTER: tracker says there are %1 on notes\n", tracker->on()));
243 pair<Region*,MidiStateTracker*> newpair;
244 newpair.first = mr.get();
245 newpair.second = tracker;
246 _note_trackers.insert (newpair);
247 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
251 if (!evlist.empty()) {
253 /* sort the event list */
254 EventsSortByTime<framepos_t> time_cmp;
255 evlist.sort (time_cmp);
258 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("Final we now have %1 events\n", evlist.size()));
259 for (Evoral::EventList<framepos_t>::iterator x = evlist.begin(); x != evlist.end(); ++x) {
260 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("\t%1\n", **x));
264 for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
265 Evoral::Event<framepos_t>* ev (*e);
266 dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
273 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "-------------------------------------------------------------\n");
278 MidiPlaylist::clear_note_trackers ()
280 Glib::RecMutex::Lock rm (region_lock);
281 for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
284 _note_trackers.clear ();
288 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
290 /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
291 NoteTrackers::iterator t = _note_trackers.find (region.get());
293 /* GACK! THREAD SAFETY! */
295 if (t != _note_trackers.end()) {
297 _note_trackers.erase (t);
303 MidiPlaylist::refresh_dependents (boost::shared_ptr<Region> /*r*/)
305 /* MIDI regions have no dependents (crossfades) */
309 MidiPlaylist::finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/)
311 /* No MIDI crossfading (yet?), so nothing to do here */
315 MidiPlaylist::check_dependents (boost::shared_ptr<Region> /*r*/, bool /*norefresh*/)
317 /* MIDI regions have no dependents (crossfades) */
322 MidiPlaylist::set_state (const XMLNode& node, int version)
327 if (Playlist::set_state (node, version)) {
338 MidiPlaylist::dump () const
340 boost::shared_ptr<Region> r;
342 cerr << "Playlist \"" << _name << "\" " << endl
343 << regions.size() << " regions "
346 for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
348 cerr << " " << r->name() << " @ " << r << " ["
349 << r->start() << "+" << r->length()
359 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
361 boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
367 bool changed = false;
370 RegionLock rlock (this);
371 RegionList::iterator i;
372 RegionList::iterator tmp;
374 for (i = regions.begin(); i != regions.end(); ) {
379 if ((*i) == region) {
390 /* overload this, it normally means "removed", not destroyed */
391 notify_region_removed (region);
397 set<Evoral::Parameter>
398 MidiPlaylist::contained_automation()
400 /* this function is never called from a realtime thread, so
401 its OK to block (for short intervals).
404 Glib::RecMutex::Lock rm (region_lock);
406 set<Evoral::Parameter> ret;
408 for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
409 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
411 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
412 c != mr->model()->controls().end(); ++c) {
413 ret.insert(c->first);
422 MidiPlaylist::region_changed (const PBD::PropertyChange& what_changed, boost::shared_ptr<Region> region)
424 if (in_flush || in_set_state) {
428 PBD::PropertyChange our_interests;
429 our_interests.add (Properties::midi_data);
431 bool parent_wants_notify = Playlist::region_changed (what_changed, region);
433 if (parent_wants_notify || what_changed.contains (our_interests)) {
434 notify_contents_changed ();