libs/ardour/midi_playlist.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: David Robillard
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #include <algorithm>
  21 #include <cassert>
  22 #include <cstdlib>
  23 #include <iostream>
  24 #include <utility>
  25
  26 #include "evoral/EventList.hpp"
  27
  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"
  37
  38 #include "i18n.h"
  39
  40 using namespace ARDOUR;
  41 using namespace PBD;
  42 using namespace std;
  43
  44 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
  45         : Playlist (session, node, DataType::MIDI, hidden)
  46         , _note_mode(Sustained)
  47         , _read_end(0)
  48 {
  49 #ifndef NDEBUG
  50         const XMLProperty* prop = node.property("type");
  51         assert(prop && DataType(prop->value()) == DataType::MIDI);
  52 #endif
  53
  54         in_set_state++;
  55         if (set_state (node, Stateful::loading_state_version)) {
  56                 throw failed_constructor ();
  57         }
  58         in_set_state--;
  59
  60         relayer ();
  61 }
  62
  63 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
  64         : Playlist (session, name, DataType::MIDI, hidden)
  65         , _note_mode(Sustained)
  66         , _read_end(0)
  67 {
  68 }
  69
  70 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
  71         : Playlist (other, name, hidden)
  72         , _note_mode(other->_note_mode)
  73         , _read_end(0)
  74 {
  75 }
  76
  77 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
  78                             framepos_t                            start,
  79                             framecnt_t                            dur,
  80                             string                                name,
  81                             bool                                  hidden)
  82         : Playlist (other, start, dur, name, hidden)
  83         , _note_mode(other->_note_mode)
  84         , _read_end(0)
  85 {
  86 }
  87
  88 MidiPlaylist::~MidiPlaylist ()
  89 {
  90 }
  91
  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
 100                              */
 101                             return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
 102                     }
 103             }
 104             return a->time() < b->time();
 105     }
 106 };
 107
 108 framecnt_t
 109 MidiPlaylist::read (Evoral::EventSink<framepos_t>& dst, framepos_t start, framecnt_t dur, unsigned chan_n)
 110 {
 111         typedef pair<MidiStateTracker*,framepos_t> TrackerInfo;
 112
 113         Playlist::RegionReadLock rl (this);
 114
 115         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 116                      string_compose ("---- MidiPlaylist::read %1 .. %2 (%3 trackers) ----\n",
 117                                      start, start + dur, _note_trackers.size()));
 118
 119         /* First, emit any queued edit fixup events at start. */
 120         for (NoteTrackers::iterator t = _note_trackers.begin(); t != _note_trackers.end(); ++t) {
 121                 t->second->fixer.emit(dst, _read_end, t->second->tracker);
 122         }
 123
 124         /* Find relevant regions that overlap [start..end] */
 125         const framepos_t                         end = start + dur - 1;
 126         std::vector< boost::shared_ptr<Region> > regs;
 127         std::vector< boost::shared_ptr<Region> > ended;
 128         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 129                 switch ((*i)->coverage (start, end)) {
 130                 case Evoral::OverlapStart:
 131                 case Evoral::OverlapInternal:
 132                         regs.push_back (*i);
 133                         break;
 134
 135                 case Evoral::OverlapExternal:
 136                         /* this region is entirely contained in the read range */
 137                         regs.push_back (*i);
 138                         ended.push_back (*i);
 139                         break;
 140
 141                 case Evoral::OverlapEnd:
 142                         /* this region ends within the read range */
 143                         regs.push_back (*i);
 144                         ended.push_back (*i);
 145                         break;
 146
 147                 default:
 148                         /* we don't care */
 149                         break;
 150                 }
 151         }
 152
 153         /* If we are reading from a single region, we can read directly into dst.  Otherwise,
 154            we read into a temporarily list, sort it, then write that to dst. */
 155         const bool direct_read = regs.size() == 1 &&
 156                 (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()));
 157
 158         Evoral::EventList<framepos_t>  evlist;
 159         Evoral::EventSink<framepos_t>& tgt = direct_read ? dst : evlist;
 160
 161         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 162                      string_compose ("\t%1 regions to read, direct: %2\n", regs.size(), direct_read));
 163
 164         for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
 165                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
 166                 if (!mr) {
 167                         continue;
 168                 }
 169
 170                 /* Get the existing note tracker for this region, or create a new one. */
 171                 NoteTrackers::iterator           t           = _note_trackers.find (mr.get());
 172                 bool                             new_tracker = false;
 173                 boost::shared_ptr<RegionTracker> tracker;
 174                 if (t == _note_trackers.end()) {
 175                         tracker     = boost::shared_ptr<RegionTracker>(new RegionTracker);
 176                         new_tracker = true;
 177                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 178                                      string_compose ("\tPre-read %1 (%2 .. %3): new tracker\n",
 179                                                      mr->name(), mr->position(), mr->last_frame()));
 180                 } else {
 181                         tracker = t->second;
 182                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 183                                      string_compose ("\tPre-read %1 (%2 .. %3): %4 active notes\n",
 184                                                      mr->name(), mr->position(), mr->last_frame(), tracker->tracker.on()));
 185                 }
 186
 187                 /* Read from region into target. */
 188                 mr->read_at (tgt, start, dur, chan_n, _note_mode, &tracker->tracker);
 189                 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 190                              string_compose ("\tPost-read: %1 active notes\n", tracker->tracker.on()));
 191
 192                 if (find (ended.begin(), ended.end(), *i) != ended.end()) {
 193                         /* Region ended within the read range, so resolve any active notes
 194                            (either stuck notes in the data, or notes that end after the end
 195                            of the region). */
 196                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 197                                      string_compose ("\t%1 ended, resolve notes and delete (%2) tracker\n",
 198                                                      mr->name(), ((new_tracker) ? "new" : "old")));
 199
 200                         tracker->tracker.resolve_notes (tgt, (*i)->last_frame());
 201                         if (!new_tracker) {
 202                                 _note_trackers.erase (t);
 203                         }
 204
 205                 } else {
 206
 207                         if (new_tracker) {
 208                                 _note_trackers.insert (make_pair (mr.get(), tracker));
 209                                 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
 210                         }
 211                 }
 212         }
 213
 214         if (!direct_read && !evlist.empty()) {
 215                 /* We've read from multiple regions, sort the event list by time. */
 216                 EventsSortByTimeAndType<framepos_t> cmp;
 217                 evlist.sort (cmp);
 218
 219                 /* Copy ordered events from event list to dst. */
 220                 for (Evoral::EventList<framepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
 221                         Evoral::Event<framepos_t>* ev (*e);
 222                         dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
 223                         delete ev;
 224                 }
 225         }
 226
 227         DEBUG_TRACE (DEBUG::MidiPlaylistIO, "---- End MidiPlaylist::read ----\n");
 228         _read_end = start + dur;
 229         return dur;
 230 }
 231
 232 void
 233 MidiPlaylist::region_edited(boost::shared_ptr<Region>         region,
 234                             const MidiModel::NoteDiffCommand* cmd)
 235 {
 236         typedef MidiModel::NoteDiffCommand Command;
 237
 238         boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
 239         if (!mr || !_session.transport_rolling()) {
 240                 return;
 241         }
 242
 243         /* Take write lock to prevent concurrency with read(). */
 244         Playlist::RegionWriteLock lock(this);
 245
 246         NoteTrackers::iterator t = _note_trackers.find(mr.get());
 247         if (t == _note_trackers.end()) {
 248                 return; /* Region is not currently active, nothing to do. */
 249         }
 250
 251         /* Queue any necessary edit compensation events. */
 252         t->second->fixer.prepare(
 253                 _session.tempo_map(), cmd, mr->position() - mr->start(),
 254                 _read_end, mr->midi_source()->model()->active_notes());
 255 }
 256
 257 void
 258 MidiPlaylist::reset_note_trackers ()
 259 {
 260         Playlist::RegionWriteLock rl (this, false);
 261
 262         DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 reset all note trackers\n", name()));
 263         _note_trackers.clear ();
 264 }
 265
 266 void
 267 MidiPlaylist::resolve_note_trackers (Evoral::EventSink<framepos_t>& dst, framepos_t time)
 268 {
 269         Playlist::RegionWriteLock rl (this, false);
 270
 271         for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
 272                 n->second->tracker.resolve_notes(dst, time);
 273         }
 274         DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 resolve all note trackers\n", name()));
 275         _note_trackers.clear ();
 276 }
 277
 278 void
 279 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 280 {
 281         /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
 282         _note_trackers.erase(region.get());
 283 }
 284
 285 int
 286 MidiPlaylist::set_state (const XMLNode& node, int version)
 287 {
 288         in_set_state++;
 289         freeze ();
 290
 291         if (Playlist::set_state (node, version)) {
 292                 return -1;
 293         }
 294
 295         thaw();
 296         in_set_state--;
 297
 298         return 0;
 299 }
 300
 301 void
 302 MidiPlaylist::dump () const
 303 {
 304         boost::shared_ptr<Region> r;
 305
 306         cerr << "Playlist \"" << _name << "\" " << endl
 307         << regions.size() << " regions "
 308         << endl;
 309
 310         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
 311                 r = *i;
 312                 cerr << "  " << r->name() << " @ " << r << " ["
 313                 << r->start() << "+" << r->length()
 314                 << "] at "
 315                 << r->position()
 316                 << " on layer "
 317                 << r->layer ()
 318                 << endl;
 319         }
 320 }
 321
 322 bool
 323 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
 324 {
 325         boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
 326
 327         if (!r) {
 328                 return false;
 329         }
 330
 331         bool changed = false;
 332
 333         {
 334                 RegionWriteLock rlock (this);
 335                 RegionList::iterator i;
 336                 RegionList::iterator tmp;
 337
 338                 for (i = regions.begin(); i != regions.end(); ) {
 339
 340                         tmp = i;
 341                         ++tmp;
 342
 343                         if ((*i) == region) {
 344                                 regions.erase (i);
 345                                 changed = true;
 346                         }
 347
 348                         i = tmp;
 349                 }
 350         }
 351
 352
 353         if (changed) {
 354                 /* overload this, it normally means "removed", not destroyed */
 355                 notify_region_removed (region);
 356         }
 357
 358         return changed;
 359 }
 360
 361 set<Evoral::Parameter>
 362 MidiPlaylist::contained_automation()
 363 {
 364         /* this function is never called from a realtime thread, so
 365            its OK to block (for short intervals).
 366         */
 367
 368         Playlist::RegionReadLock rl (this);
 369         set<Evoral::Parameter> ret;
 370
 371         for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
 372                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
 373
 374                 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
 375                                 c != mr->model()->controls().end(); ++c) {
 376                         ret.insert(c->first);
 377                 }
 378         }
 379
 380         return ret;
 381 }