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 #include "evoral/Control.hpp"
  28
  29 #include "ardour/beats_samples_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/region_factory.h"
  37 #include "ardour/session.h"
  38 #include "ardour/tempo.h"
  39 #include "ardour/types.h"
  40
  41 #include "pbd/i18n.h"
  42
  43 using namespace ARDOUR;
  44 using namespace PBD;
  45 using namespace std;
  46
  47 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
  48         : Playlist (session, node, DataType::MIDI, hidden)
  49         , _note_mode(Sustained)
  50         , _read_end(0)
  51 {
  52 #ifndef NDEBUG
  53         XMLProperty const * prop = node.property("type");
  54         assert(prop && DataType(prop->value()) == DataType::MIDI);
  55 #endif
  56
  57         in_set_state++;
  58         if (set_state (node, Stateful::loading_state_version)) {
  59                 throw failed_constructor ();
  60         }
  61         in_set_state--;
  62
  63         relayer ();
  64 }
  65
  66 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
  67         : Playlist (session, name, DataType::MIDI, hidden)
  68         , _note_mode(Sustained)
  69         , _read_end(0)
  70 {
  71 }
  72
  73 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
  74         : Playlist (other, name, hidden)
  75         , _note_mode(other->_note_mode)
  76         , _read_end(0)
  77 {
  78 }
  79
  80 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other,
  81                             samplepos_t                            start,
  82                             samplecnt_t                            dur,
  83                             string                                name,
  84                             bool                                  hidden)
  85         : Playlist (other, start, dur, name, hidden)
  86         , _note_mode(other->_note_mode)
  87         , _read_end(0)
  88 {
  89 }
  90
  91 MidiPlaylist::~MidiPlaylist ()
  92 {
  93 }
  94
  95 template<typename Time>
  96 struct EventsSortByTimeAndType {
  97     bool operator() (const Evoral::Event<Time>* a, const Evoral::Event<Time>* b) {
  98             if (a->time() == b->time()) {
  99                     if (parameter_is_midi ((AutomationType)a->event_type()) &&
 100                         parameter_is_midi ((AutomationType)b->event_type())) {
 101                             /* negate return value since we must return whether
 102                              * or not a should sort before b, not b before a
 103                              */
 104                             return !MidiBuffer::second_simultaneous_midi_byte_is_first (a->buffer()[0], b->buffer()[0]);
 105                     }
 106             }
 107             return a->time() < b->time();
 108     }
 109 };
 110
 111 samplecnt_t
 112 MidiPlaylist::read (Evoral::EventSink<samplepos_t>& dst,
 113                     samplepos_t                     start,
 114                     samplecnt_t                     dur,
 115                     Evoral::Range<samplepos_t>*     loop_range,
 116                     unsigned                       chan_n,
 117                     MidiChannelFilter*             filter)
 118 {
 119         typedef pair<MidiStateTracker*,samplepos_t> TrackerInfo;
 120
 121         Playlist::RegionReadLock rl (this);
 122
 123         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 124                      string_compose ("---- MidiPlaylist::read %1 .. %2 (%3 trackers) ----\n",
 125                                      start, start + dur, _note_trackers.size()));
 126
 127         /* First, emit any queued edit fixup events at start. */
 128         for (NoteTrackers::iterator t = _note_trackers.begin(); t != _note_trackers.end(); ++t) {
 129                 t->second->fixer.emit(dst, _read_end, t->second->tracker);
 130         }
 131
 132         /* Find relevant regions that overlap [start..end] */
 133         const samplepos_t                         end = start + dur - 1;
 134         std::vector< boost::shared_ptr<Region> > regs;
 135         std::vector< boost::shared_ptr<Region> > ended;
 136         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 137                 switch ((*i)->coverage (start, end)) {
 138                 case Evoral::OverlapStart:
 139                 case Evoral::OverlapInternal:
 140                         regs.push_back (*i);
 141                         break;
 142
 143                 case Evoral::OverlapExternal:
 144                         /* this region is entirely contained in the read range */
 145                         regs.push_back (*i);
 146                         ended.push_back (*i);
 147                         break;
 148
 149                 case Evoral::OverlapEnd:
 150                         /* this region ends within the read range */
 151                         regs.push_back (*i);
 152                         ended.push_back (*i);
 153                         break;
 154
 155                 default:
 156                         /* we don't care */
 157                         break;
 158                 }
 159         }
 160
 161         /* If we are reading from a single region, we can read directly into dst.  Otherwise,
 162            we read into a temporarily list, sort it, then write that to dst. */
 163         const bool direct_read = regs.size() == 1 &&
 164                 (ended.empty() || (ended.size() == 1 && ended.front() == regs.front()));
 165
 166         Evoral::EventList<samplepos_t>  evlist;
 167         Evoral::EventSink<samplepos_t>& tgt = direct_read ? dst : evlist;
 168
 169         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 170                      string_compose ("\t%1 regions to read, direct: %2\n", regs.size(), direct_read));
 171
 172         for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
 173                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
 174                 if (!mr) {
 175                         continue;
 176                 }
 177
 178                 /* Get the existing note tracker for this region, or create a new one. */
 179                 NoteTrackers::iterator           t           = _note_trackers.find (mr.get());
 180                 bool                             new_tracker = false;
 181                 boost::shared_ptr<RegionTracker> tracker;
 182                 if (t == _note_trackers.end()) {
 183                         tracker     = boost::shared_ptr<RegionTracker>(new RegionTracker);
 184                         new_tracker = true;
 185                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 186                                      string_compose ("\tPre-read %1 (%2 .. %3): new tracker\n",
 187                                                      mr->name(), mr->position(), mr->last_sample()));
 188                 } else {
 189                         tracker = t->second;
 190                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 191                                      string_compose ("\tPre-read %1 (%2 .. %3): %4 active notes\n",
 192                                                      mr->name(), mr->position(), mr->last_sample(), tracker->tracker.on()));
 193                 }
 194
 195                 /* Read from region into target. */
 196                 DEBUG_TRACE (DEBUG::MidiPlaylistIO, string_compose ("read from %1 at %2 for %3 LR %4 .. %5\n",
 197                                                                     mr->name(), start, dur,
 198                                                                     (loop_range ? loop_range->from : -1),
 199                                                                     (loop_range ? loop_range->to : -1)));
 200                 mr->read_at (tgt, start, dur, loop_range, tracker->cursor, chan_n, _note_mode, &tracker->tracker, filter);
 201                 DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 202                              string_compose ("\tPost-read: %1 active notes\n", tracker->tracker.on()));
 203
 204                 if (find (ended.begin(), ended.end(), *i) != ended.end()) {
 205                         /* Region ended within the read range, so resolve any active notes
 206                            (either stuck notes in the data, or notes that end after the end
 207                            of the region). */
 208                         DEBUG_TRACE (DEBUG::MidiPlaylistIO,
 209                                      string_compose ("\t%1 ended, resolve notes and delete (%2) tracker\n",
 210                                                      mr->name(), ((new_tracker) ? "new" : "old")));
 211
 212                         tracker->tracker.resolve_notes (tgt, loop_range ? loop_range->squish ((*i)->last_sample()) : (*i)->last_sample());
 213                         tracker->cursor.invalidate (false);
 214                         if (!new_tracker) {
 215                                 _note_trackers.erase (t);
 216                         }
 217
 218                 } else {
 219
 220                         if (new_tracker) {
 221                                 _note_trackers.insert (make_pair (mr.get(), tracker));
 222                                 DEBUG_TRACE (DEBUG::MidiPlaylistIO, "\tadded tracker to trackers\n");
 223                         }
 224                 }
 225         }
 226
 227         if (!direct_read && !evlist.empty()) {
 228                 /* We've read from multiple regions, sort the event list by time. */
 229                 EventsSortByTimeAndType<samplepos_t> cmp;
 230                 evlist.sort (cmp);
 231
 232                 /* Copy ordered events from event list to dst. */
 233                 for (Evoral::EventList<samplepos_t>::iterator e = evlist.begin(); e != evlist.end(); ++e) {
 234                         Evoral::Event<samplepos_t>* ev (*e);
 235                         dst.write (ev->time(), ev->event_type(), ev->size(), ev->buffer());
 236                         delete ev;
 237                 }
 238         }
 239
 240         DEBUG_TRACE (DEBUG::MidiPlaylistIO, "---- End MidiPlaylist::read ----\n");
 241         _read_end = start + dur;
 242         return dur;
 243 }
 244
 245 void
 246 MidiPlaylist::region_edited(boost::shared_ptr<Region>         region,
 247                             const MidiModel::NoteDiffCommand* cmd)
 248 {
 249         typedef MidiModel::NoteDiffCommand Command;
 250
 251         boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
 252         if (!mr || !_session.transport_rolling()) {
 253                 return;
 254         }
 255
 256         /* Take write lock to prevent concurrency with read(). */
 257         Playlist::RegionWriteLock lock(this);
 258
 259         NoteTrackers::iterator t = _note_trackers.find(mr.get());
 260         if (t == _note_trackers.end()) {
 261                 return; /* Region is not currently active, nothing to do. */
 262         }
 263
 264         /* Queue any necessary edit compensation events. */
 265         t->second->fixer.prepare(
 266                 _session.tempo_map(), cmd, mr->position() - mr->start(),
 267                 _read_end, t->second->cursor.active_notes);
 268 }
 269
 270 void
 271 MidiPlaylist::reset_note_trackers ()
 272 {
 273         Playlist::RegionWriteLock rl (this, false);
 274
 275         DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 reset all note trackers\n", name()));
 276         _note_trackers.clear ();
 277 }
 278
 279 void
 280 MidiPlaylist::resolve_note_trackers (Evoral::EventSink<samplepos_t>& dst, samplepos_t time)
 281 {
 282         Playlist::RegionWriteLock rl (this, false);
 283
 284         for (NoteTrackers::iterator n = _note_trackers.begin(); n != _note_trackers.end(); ++n) {
 285                 n->second->tracker.resolve_notes(dst, time);
 286         }
 287         DEBUG_TRACE (DEBUG::MidiTrackers, string_compose ("%1 resolve all note trackers\n", name()));
 288         _note_trackers.clear ();
 289 }
 290
 291 void
 292 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 293 {
 294         /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
 295         _note_trackers.erase(region.get());
 296 }
 297
 298 void
 299 MidiPlaylist::region_going_away (boost::weak_ptr<Region> region)
 300 {
 301         boost::shared_ptr<Region> r = region.lock();
 302         if (r) {
 303                 remove_dependents(r);
 304         }
 305 }
 306
 307 int
 308 MidiPlaylist::set_state (const XMLNode& node, int version)
 309 {
 310         in_set_state++;
 311         freeze ();
 312
 313         if (Playlist::set_state (node, version)) {
 314                 return -1;
 315         }
 316
 317         thaw();
 318         in_set_state--;
 319
 320         return 0;
 321 }
 322
 323 void
 324 MidiPlaylist::dump () const
 325 {
 326         boost::shared_ptr<Region> r;
 327
 328         cerr << "Playlist \"" << _name << "\" " << endl
 329         << regions.size() << " regions "
 330         << endl;
 331
 332         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
 333                 r = *i;
 334                 cerr << "  " << r->name() << " @ " << r << " ["
 335                 << r->start() << "+" << r->length()
 336                 << "] at "
 337                 << r->position()
 338                 << " on layer "
 339                 << r->layer ()
 340                 << endl;
 341         }
 342 }
 343
 344 bool
 345 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
 346 {
 347         boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
 348
 349         if (!r) {
 350                 return false;
 351         }
 352
 353         bool changed = false;
 354
 355         {
 356                 RegionWriteLock rlock (this);
 357                 RegionList::iterator i;
 358                 RegionList::iterator tmp;
 359
 360                 for (i = regions.begin(); i != regions.end(); ) {
 361
 362                         tmp = i;
 363                         ++tmp;
 364
 365                         if ((*i) == region) {
 366                                 regions.erase (i);
 367                                 changed = true;
 368                         }
 369
 370                         i = tmp;
 371                 }
 372
 373                 NoteTrackers::iterator t = _note_trackers.find(region.get());
 374                 if (t != _note_trackers.end()) {
 375                         _note_trackers.erase(t);
 376                 }
 377         }
 378
 379         if (changed) {
 380                 /* overload this, it normally means "removed", not destroyed */
 381                 notify_region_removed (region);
 382         }
 383
 384         return changed;
 385 }
 386 void
 387 MidiPlaylist::_split_region (boost::shared_ptr<Region> region, const MusicSample& playlist_position)
 388 {
 389         if (!region->covers (playlist_position.sample)) {
 390                 return;
 391         }
 392
 393         if (region->position() == playlist_position.sample ||
 394             region->last_sample() == playlist_position.sample) {
 395                 return;
 396         }
 397
 398         boost::shared_ptr<const MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
 399
 400         if (mr == 0) {
 401                 return;
 402         }
 403
 404         boost::shared_ptr<Region> left;
 405         boost::shared_ptr<Region> right;
 406
 407         string before_name;
 408         string after_name;
 409         const double before_qn = _session.tempo_map().exact_qn_at_sample (playlist_position.sample, playlist_position.division) - region->quarter_note();
 410         const double after_qn = mr->length_beats() - before_qn;
 411         MusicSample before (playlist_position.sample - region->position(), playlist_position.division);
 412         MusicSample after (region->length() - before.sample, playlist_position.division);
 413
 414         /* split doesn't change anything about length, so don't try to splice */
 415         bool old_sp = _splicing;
 416         _splicing = true;
 417
 418         RegionFactory::region_name (before_name, region->name(), false);
 419
 420         {
 421                 PropertyList plist;
 422
 423                 plist.add (Properties::length, before.sample);
 424                 plist.add (Properties::length_beats, before_qn);
 425                 plist.add (Properties::name, before_name);
 426                 plist.add (Properties::left_of_split, true);
 427                 plist.add (Properties::layering_index, region->layering_index ());
 428                 plist.add (Properties::layer, region->layer ());
 429
 430                 /* note: we must use the version of ::create with an offset here,
 431                    since it supplies that offset to the Region constructor, which
 432                    is necessary to get audio region gain envelopes right.
 433                 */
 434                 left = RegionFactory::create (region, MusicSample (0, 0), plist, true);
 435         }
 436
 437         RegionFactory::region_name (after_name, region->name(), false);
 438
 439         {
 440                 PropertyList plist;
 441
 442                 plist.add (Properties::length, after.sample);
 443                 plist.add (Properties::length_beats, after_qn);
 444                 plist.add (Properties::name, after_name);
 445                 plist.add (Properties::right_of_split, true);
 446                 plist.add (Properties::layering_index, region->layering_index ());
 447                 plist.add (Properties::layer, region->layer ());
 448
 449                 /* same note as above */
 450                 right = RegionFactory::create (region, before, plist, true);
 451         }
 452
 453         add_region_internal (left, region->position(), 0, region->quarter_note(), true);
 454         add_region_internal (right, region->position() + before.sample, before.division, region->quarter_note() + before_qn, true);
 455
 456         remove_region_internal (region);
 457
 458         _splicing = old_sp;
 459 }
 460
 461 set<Evoral::Parameter>
 462 MidiPlaylist::contained_automation()
 463 {
 464         /* this function is never called from a realtime thread, so
 465            its OK to block (for short intervals).
 466         */
 467
 468         Playlist::RegionReadLock rl (this);
 469         set<Evoral::Parameter> ret;
 470
 471         for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
 472                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
 473
 474                 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
 475                                 c != mr->model()->controls().end(); ++c) {
 476                         if (c->second->list()->size() > 0) {
 477                                 ret.insert(c->first);
 478                         }
 479                 }
 480         }
 481
 482         return ret;
 483 }