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"
27 #include "evoral/Control.hpp"
29 #include "ardour/beats_frames_converter.h"
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/midi_source.h"
35 #include "ardour/midi_state_tracker.h"
36 #include "ardour/session.h"
37 #include "ardour/types.h"
41 using namespace ARDOUR;
45 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
46 : Playlist (session, node, DataType::MIDI, hidden)
47 , _note_mode(Sustained)
51 XMLProperty const * 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 ();
64 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
65 : Playlist (session, name, DataType::MIDI, hidden)
66 , _note_mode(Sustained)
71 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
72 : Playlist (other, name, hidden)
73 , _note_mode(other->_note_mode)
78 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
83 : Playlist (other, start, dur, name, hidden)
84 , _note_mode(other->_note_mode)
89 MidiPlaylist::~MidiPlaylist ()
93 template<typename Time>
94 struct EventsSortByTimeAndType {
95 bool operator() (Evoral::Event<Time>* a, Evoral::Event<Time>* b) {
96 if (a->time() == b->time()) {
97 if (parameter_is_midi ((AutomationType)a->event_type()) &&
98 parameter_is_midi ((AutomationType)b->event_type())) {
99 /* negate return value since we must return whether
100 * or not a should sort before b, not b before a
102 return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
105 return a->time() < b->time();
110 MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst,
114 MidiChannelFilter* filter)
116 typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
118 Playlist::RegionReadLock rl (this);
120 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
121 string_compose ("---- MidiPlaylist::read %1 .. %2 (%3 trackers) ----\n",
122 start, start + dur, _note_trackers.size()));
124 /* First, emit any queued edit fixup events at start. */
125 for (NoteTrackers::iterator t = _note_trackers.begin(); t != _note_trackers.end(); ++t) {
126 t->second->fixer.emit(dst, _read_end, t->second->tracker);
129 /* Find relevant regions that overlap [start..end] */
130 const framepos_t end = start + dur - 1;
131 std::vector< boost::shared_ptr<Region> > regs;
132 std::vector< boost::shared_ptr<Region> > ended;
133 for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
134 switch ((*i)->coverage (start, end)) {
135 case Evoral::OverlapStart:
136 case Evoral::OverlapInternal:
140 case Evoral::OverlapExternal:
141 /* this region is entirely contained in the read range */
143 ended.push_back (*i);
146 case Evoral::OverlapEnd:
147 /* this region ends within the read range */
149 ended.push_back (*i);
158 /* If we are reading from a single region, we can read directly into dst. Otherwise,
159 we read into a temporarily list, sort it, then write that to dst. */
160 const bool direct_read = regs.size() == 1 &&
161 (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()));
163 Evoral::EventList<framepos_t> evlist;
164 Evoral::EventSink<framepos_t>& tgt = direct_read ? dst : evlist;
166 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
167 string_compose ("\t%1 regions to read, direct: %2\n", regs.size(), direct_read));
169 for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
170 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
175 /* Get the existing note tracker for this region, or create a new one. */
176 NoteTrackers::iterator t = _note_trackers.find (mr.get());
177 bool new_tracker = false;
178 boost::shared_ptr<RegionTracker> tracker;
179 if (t == _note_trackers.end()) {
180 tracker = boost::shared_ptr<RegionTracker>(new RegionTracker);
182 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
183 string_compose ("\tPre-read %1 (%2 .. %3): new tracker\n",
184 mr->name(), mr->position(), mr->last_frame()));
187 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
188 string_compose ("\tPre-read %1 (%2 .. %3): %4 active notes\n",
189 mr->name(), mr->position(), mr->last_frame(), tracker->tracker.on()));
192 /* Read from region into target. */
193 mr->read_at (tgt, start, dur, chan_n, _note_mode, &tracker->tracker, filter);
194 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
195 string_compose ("\tPost-read: %1 active notes\n", tracker->tracker.on()));
197 if (find (ended.begin(), ended.end(), *i) != ended.end()) {
198 /* Region ended within the read range, so resolve any active notes
199 (either stuck notes in the data, or notes that end after the end
201 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
202 string_compose ("\t%1 ended, resolve notes and delete (%2) tracker\n",
203 mr->name(), ((new_tracker) ? "new" : "old")));
205 tracker->tracker.resolve_notes (tgt, (*i)->last_frame());
207 _note_trackers.erase (t);
213 _note_trackers.insert (make_pair (mr.get(), tracker));
214 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
219 if (!direct_read && !evlist.empty()) {
220 /* We've read from multiple regions, sort the event list by time. */
221 EventsSortByTimeAndType<framepos_t> cmp;
224 /* Copy ordered events from event list to dst. */
225 for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
226 Evoral::Event<framepos_t>* ev (*e);
227 dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
232 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "---- End MidiPlaylist::read ----\n");
233 _read_end = start + dur;
238 MidiPlaylist::region_edited(boost::shared_ptr<Region> region,
239 const MidiModel::NoteDiffCommand* cmd)
241 typedef MidiModel::NoteDiffCommand Command;
243 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
244 if (!mr || !_session.transport_rolling()) {
248 /* Take write lock to prevent concurrency with read(). */
249 Playlist::RegionWriteLock lock(this);
251 NoteTrackers::iterator t = _note_trackers.find(mr.get());
252 if (t == _note_trackers.end()) {
253 return; /* Region is not currently active, nothing to do. */
256 /* Queue any necessary edit compensation events. */
257 t->second->fixer.prepare(
258 _session.tempo_map(), cmd, mr->position() - mr->start(),
259 _read_end, mr->midi_source()->model()->active_notes());
263 MidiPlaylist::reset_note_trackers ()
265 Playlist::RegionWriteLock rl (this, false);
267 DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 reset all note trackers\n", name()));
268 _note_trackers.clear ();
272 MidiPlaylist::resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time)
274 Playlist::RegionWriteLock rl (this, false);
276 for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
277 n->second->tracker.resolve_notes(dst, time);
279 DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 resolve all note trackers\n", name()));
280 _note_trackers.clear ();
284 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
286 /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
287 _note_trackers.erase(region.get());
291 MidiPlaylist::set_state (const XMLNode& node, int version)
296 if (Playlist::set_state (node, version)) {
307 MidiPlaylist::dump () const
309 boost::shared_ptr<Region> r;
311 cerr << "Playlist \"" << _name << "\" " << endl
312 << regions.size() << " regions "
315 for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
317 cerr << " " << r->name() << " @ " << r << " ["
318 << r->start() << "+" << r->length()
328 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
330 boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
336 bool changed = false;
339 RegionWriteLock rlock (this);
340 RegionList::iterator i;
341 RegionList::iterator tmp;
343 for (i = regions.begin(); i != regions.end(); ) {
348 if ((*i) == region) {
359 /* overload this, it normally means "removed", not destroyed */
360 notify_region_removed (region);
366 set<Evoral::Parameter>
367 MidiPlaylist::contained_automation()
369 /* this function is never called from a realtime thread, so
370 its OK to block (for short intervals).
373 Playlist::RegionReadLock rl (this);
374 set<Evoral::Parameter> ret;
376 for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
377 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
379 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
380 c != mr->model()->controls().end(); ++c) {
381 if (c->second->list()->size() > 0) {
382 ret.insert(c->first);