libs/ardour/midi_playlist.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Written by Dave Robillard, 2006
   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 <cassert>
  21
  22 #include <algorithm>
  23
  24 #include <stdlib.h>
  25
  26 #include <sigc++/bind.h>
  27
  28 #include "ardour/types.h"
  29 #include "ardour/configuration.h"
  30 #include "ardour/midi_playlist.h"
  31 #include "ardour/midi_region.h"
  32 #include "ardour/session.h"
  33 #include "ardour/midi_ring_buffer.h"
  34
  35 #include "pbd/error.h"
  36
  37 #include "i18n.h"
  38
  39 using namespace ARDOUR;
  40 using namespace sigc;
  41 using namespace std;
  42
  43 MidiPlaylist::MidiPlaylist (Session& session, const XMLNode& node, bool hidden)
  44                 : Playlist (session, node, DataType::MIDI, hidden)
  45                 , _note_mode(Sustained)
  46 {
  47         const XMLProperty* prop = node.property("type");
  48         assert(prop && DataType(prop->value()) == DataType::MIDI);
  49
  50         in_set_state++;
  51         set_state (node, Stateful::loading_state_version);
  52         in_set_state--;
  53 }
  54
  55 MidiPlaylist::MidiPlaylist (Session& session, string name, bool hidden)
  56                 : Playlist (session, name, DataType::MIDI, hidden)
  57 {
  58 }
  59
  60 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, string name, bool hidden)
  61                 : Playlist (other, name, hidden)
  62 {
  63         throw; // nope
  64
  65         /*
  66         list<Region*>::const_iterator in_o  = other.regions.begin();
  67         list<Region*>::iterator in_n = regions.begin();
  68
  69         while (in_o != other.regions.end()) {
  70                 MidiRegion *ar = dynamic_cast<MidiRegion *>( (*in_o) );
  71
  72                 for (list<Crossfade *>::const_iterator xfades = other._crossfades.begin(); xfades != other._crossfades.end(); ++xfades) {
  73                         if ( &(*xfades)->in() == ar) {
  74                                 // We found one! Now copy it!
  75
  76                                 list<Region*>::const_iterator out_o = other.regions.begin();
  77                                 list<Region*>::const_iterator out_n = regions.begin();
  78
  79                                 while (out_o != other.regions.end()) {
  80
  81                                         MidiRegion *ar2 = dynamic_cast<MidiRegion *>( (*out_o) );
  82
  83                                         if ( &(*xfades)->out() == ar2) {
  84                                                 MidiRegion *in  = dynamic_cast<MidiRegion*>( (*in_n) );
  85                                                 MidiRegion *out = dynamic_cast<MidiRegion*>( (*out_n) );
  86                                                 Crossfade *new_fade = new Crossfade( *(*xfades), in, out);
  87                                                 add_crossfade(*new_fade);
  88                                                 break;
  89                                         }
  90
  91                                         out_o++;
  92                                         out_n++;
  93                                 }
  94                                 // cerr << "HUH!? second region in the crossfade not found!" << endl;
  95                         }
  96                 }
  97
  98                 in_o++;
  99                 in_n++;
 100         }
 101 */
 102 }
 103
 104 MidiPlaylist::MidiPlaylist (boost::shared_ptr<const MidiPlaylist> other, nframes_t start, nframes_t dur, string name, bool hidden)
 105                 : Playlist (other, start, dur, name, hidden)
 106 {
 107         /* this constructor does NOT notify others (session) */
 108 }
 109
 110 MidiPlaylist::~MidiPlaylist ()
 111 {
 112         GoingAway (); /* EMIT SIGNAL */
 113
 114         /* drop connections to signals */
 115
 116         notify_callbacks ();
 117 }
 118
 119 struct RegionSortByLayer {
 120     bool operator() (boost::shared_ptr<Region> a, boost::shared_ptr<Region> b) {
 121             return a->layer() < b->layer();
 122     }
 123 };
 124
 125 /** Returns the number of frames in time duration read (eg could be large when 0 events are read) */
 126 nframes_t
 127 MidiPlaylist::read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t dur, unsigned chan_n)
 128 {
 129         /* this function is never called from a realtime thread, so
 130            its OK to block (for short intervals).
 131         */
 132
 133         Glib::RecMutex::Lock rm (region_lock);
 134
 135         nframes_t end = start + dur - 1;
 136
 137         _read_data_count = 0;
 138
 139         // relevent regions overlapping start <--> end
 140         vector<boost::shared_ptr<Region> > regs;
 141
 142         for (RegionList::iterator i = regions.begin(); i != regions.end(); ++i) {
 143                 if ((*i)->coverage (start, end) != OverlapNone) {
 144                         regs.push_back(*i);
 145                 } else {
 146                         /* region does not cover the current read boundaries, so make
 147                            sure that we silence any notes that it had turned on
 148                         */
 149                         NoteTrackers::iterator t = _note_trackers.find ((*i).get());
 150                         if (t != _note_trackers.end()) {
 151                                 t->second->resolve_notes (dst, (*i)->last_frame());
 152                                 delete t->second;
 153                                 _note_trackers.erase (t);
 154                         }
 155                 }
 156         }
 157
 158         RegionSortByLayer layer_cmp;
 159         sort(regs.begin(), regs.end(), layer_cmp);
 160
 161         for (vector<boost::shared_ptr<Region> >::iterator i = regs.begin(); i != regs.end(); ++i) {
 162                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*i);
 163                 if (mr) {
 164
 165                         NoteTrackers::iterator t = _note_trackers.find ((*i).get());
 166                         MidiStateTracker* tracker;
 167
 168                         if (t == _note_trackers.end()) {
 169                                 pair<Region*,MidiStateTracker*> newpair;
 170                                 newpair.first = (*i).get();
 171                                 tracker = newpair.second = new MidiStateTracker;
 172                                 _note_trackers.insert (newpair);
 173                         } else {
 174                                 tracker = t->second;
 175                         }
 176
 177                         mr->read_at (dst, start, dur, chan_n, _note_mode, tracker);
 178                         _read_data_count += mr->read_data_count();
 179                 }
 180         }
 181
 182         return dur;
 183 }
 184
 185 void
 186 MidiPlaylist::remove_dependents (boost::shared_ptr<Region> region)
 187 {
 188         /* MIDI regions have no dependents (crossfades) but we might be tracking notes */
 189         NoteTrackers::iterator t = _note_trackers.find (region.get());
 190
 191         /* GACK! THREAD SAFETY! */
 192
 193         if (t != _note_trackers.end()) {
 194                 delete t->second;
 195                 _note_trackers.erase (t);
 196         }
 197 }
 198
 199
 200 void
 201 MidiPlaylist::refresh_dependents (boost::shared_ptr<Region> /*r*/)
 202 {
 203         /* MIDI regions have no dependents (crossfades) */
 204 }
 205
 206 void
 207 MidiPlaylist::finalize_split_region (boost::shared_ptr<Region> /*original*/, boost::shared_ptr<Region> /*left*/, boost::shared_ptr<Region> /*right*/)
 208 {
 209         /* No MIDI crossfading (yet?), so nothing to do here */
 210 }
 211
 212 void
 213 MidiPlaylist::check_dependents (boost::shared_ptr<Region> /*r*/, bool /*norefresh*/)
 214 {
 215         /* MIDI regions have no dependents (crossfades) */
 216 }
 217
 218
 219 int
 220 MidiPlaylist::set_state (const XMLNode& node, int version)
 221 {
 222         in_set_state++;
 223         freeze ();
 224
 225         Playlist::set_state (node, version);
 226
 227         thaw();
 228         in_set_state--;
 229
 230         return 0;
 231 }
 232
 233 void
 234 MidiPlaylist::dump () const
 235 {
 236         boost::shared_ptr<Region> r;
 237
 238         cerr << "Playlist \"" << _name << "\" " << endl
 239         << regions.size() << " regions "
 240         << endl;
 241
 242         for (RegionList::const_iterator i = regions.begin(); i != regions.end(); ++i) {
 243                 r = *i;
 244                 cerr << "  " << r->name() << " @ " << r << " ["
 245                 << r->start() << "+" << r->length()
 246                 << "] at "
 247                 << r->position()
 248                 << " on layer "
 249                 << r->layer ()
 250                 << endl;
 251         }
 252 }
 253
 254 bool
 255 MidiPlaylist::destroy_region (boost::shared_ptr<Region> region)
 256 {
 257         boost::shared_ptr<MidiRegion> r = boost::dynamic_pointer_cast<MidiRegion> (region);
 258         bool changed = false;
 259
 260         if (r == 0) {
 261                 PBD::fatal << _("programming error: non-midi Region passed to remove_overlap in midi playlist")
 262                 << endmsg;
 263                 /*NOTREACHED*/
 264                 return false;
 265         }
 266
 267         {
 268                 RegionLock rlock (this);
 269                 RegionList::iterator i;
 270                 RegionList::iterator tmp;
 271
 272                 for (i = regions.begin(); i != regions.end(); ) {
 273
 274                         tmp = i;
 275                         ++tmp;
 276
 277                         if ((*i) == region) {
 278                                 regions.erase (i);
 279                                 changed = true;
 280                         }
 281
 282                         i = tmp;
 283                 }
 284         }
 285
 286
 287         if (changed) {
 288                 /* overload this, it normally means "removed", not destroyed */
 289                 notify_region_removed (region);
 290         }
 291
 292         return changed;
 293 }
 294
 295 set<Evoral::Parameter>
 296 MidiPlaylist::contained_automation()
 297 {
 298         /* this function is never called from a realtime thread, so
 299            its OK to block (for short intervals).
 300         */
 301
 302         Glib::RecMutex::Lock rm (region_lock);
 303
 304         set<Evoral::Parameter> ret;
 305
 306         for (RegionList::const_iterator r = regions.begin(); r != regions.end(); ++r) {
 307                 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(*r);
 308
 309                 for (Automatable::Controls::iterator c = mr->model()->controls().begin();
 310                                 c != mr->model()->controls().end(); ++c) {
 311                         ret.insert(c->first);
 312                 }
 313         }
 314
 315         return ret;
 316 }
 317
 318
 319 bool
 320 MidiPlaylist::region_changed (Change what_changed, boost::shared_ptr<Region> region)
 321 {
 322         if (in_flush || in_set_state) {
 323                 return false;
 324         }
 325
 326         // Feeling rather uninterested today, but thanks for the heads up anyway!
 327
 328         Change our_interests = Change (/*MidiRegion::FadeInChanged|
 329                                        MidiRegion::FadeOutChanged|
 330                                        MidiRegion::FadeInActiveChanged|
 331                                        MidiRegion::FadeOutActiveChanged|
 332                                        MidiRegion::EnvelopeActiveChanged|
 333                                        MidiRegion::ScaleAmplitudeChanged|
 334                                        MidiRegion::EnvelopeChanged*/);
 335         bool parent_wants_notify;
 336
 337         parent_wants_notify = Playlist::region_changed (what_changed, region);
 338
 339         if ((parent_wants_notify || (what_changed & our_interests))) {
 340                 notify_modified ();
 341         }
 342
 343         return true;
 344 }
 345