libs/ardour/midi_region.cc

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18     $Id: midiregion.cc 746 2006-08-02 02:44:23Z drobilla $
  19 */
  20
  21 #include <cmath>
  22 #include <climits>
  23 #include <cfloat>
  24
  25 #include <set>
  26
  27 #include <glibmm/threads.h>
  28 #include <glibmm/fileutils.h>
  29 #include <glibmm/miscutils.h>
  30
  31 #include "evoral/Beats.hpp"
  32
  33 #include "pbd/xml++.h"
  34 #include "pbd/basename.h"
  35
  36 #include "ardour/automation_control.h"
  37 #include "ardour/midi_model.h"
  38 #include "ardour/midi_region.h"
  39 #include "ardour/midi_ring_buffer.h"
  40 #include "ardour/midi_source.h"
  41 #include "ardour/region_factory.h"
  42 #include "ardour/session.h"
  43 #include "ardour/source_factory.h"
  44 #include "ardour/tempo.h"
  45 #include "ardour/types.h"
  46
  47 #include "i18n.h"
  48 #include <locale.h>
  49
  50 using namespace std;
  51 using namespace ARDOUR;
  52 using namespace PBD;
  53
  54 namespace ARDOUR {
  55         namespace Properties {
  56                 PBD::PropertyDescriptor<Evoral::Beats> start_beats;
  57                 PBD::PropertyDescriptor<Evoral::Beats> length_beats;
  58         }
  59 }
  60
  61 void
  62 MidiRegion::make_property_quarks ()
  63 {
  64         Properties::start_beats.property_id = g_quark_from_static_string (X_("start-beats"));
  65         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for start-beats = %1\n", Properties::start_beats.property_id));
  66         Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
  67         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
  68 }
  69
  70 void
  71 MidiRegion::register_properties ()
  72 {
  73         add_property (_start_beats);
  74         add_property (_length_beats);
  75 }
  76
  77 /* Basic MidiRegion constructor (many channels) */
  78 MidiRegion::MidiRegion (const SourceList& srcs)
  79         : Region (srcs)
  80         , _start_beats (Properties::start_beats, Evoral::Beats())
  81         , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
  82 {
  83         register_properties ();
  84
  85         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
  86         model_changed ();
  87         assert(_name.val().find("/") == string::npos);
  88         assert(_type == DataType::MIDI);
  89 }
  90
  91 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
  92         : Region (other)
  93         , _start_beats (Properties::start_beats, other->_start_beats)
  94         , _length_beats (Properties::length_beats, other->_length_beats)
  95 {
  96         //update_length_beats ();
  97         register_properties ();
  98
  99         assert(_name.val().find("/") == string::npos);
 100         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
 101         model_changed ();
 102 }
 103
 104 /** Create a new MidiRegion that is part of an existing one */
 105 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, const int32_t& sub_num)
 106         : Region (other, offset, sub_num)
 107         , _start_beats (Properties::start_beats, Evoral::Beats())
 108         , _length_beats (Properties::length_beats, other->_length_beats)
 109 {
 110         _start_beats = Evoral::Beats (_session.tempo_map().exact_beat_at_frame (other->_position + offset - other->_start, sub_num) - other->beat());
 111         update_length_beats (sub_num);
 112         register_properties ();
 113
 114         assert(_name.val().find("/") == string::npos);
 115         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
 116         model_changed ();
 117 }
 118
 119 MidiRegion::~MidiRegion ()
 120 {
 121 }
 122
 123 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
 124  */
 125 boost::shared_ptr<MidiRegion>
 126 MidiRegion::clone (string path) const
 127 {
 128         boost::shared_ptr<MidiSource> newsrc;
 129
 130         /* caller must check for pre-existing file */
 131         assert (!path.empty());
 132         assert (!Glib::file_test (path, Glib::FILE_TEST_EXISTS));
 133         newsrc = boost::dynamic_pointer_cast<MidiSource>(
 134                 SourceFactory::createWritable(DataType::MIDI, _session,
 135                                               path, false, _session.frame_rate()));
 136         return clone (newsrc);
 137 }
 138
 139 boost::shared_ptr<MidiRegion>
 140 MidiRegion::clone (boost::shared_ptr<MidiSource> newsrc) const
 141 {
 142         BeatsFramesConverter bfc (_session.tempo_map(), _position);
 143         Evoral::Beats const bbegin = bfc.from (_start);
 144         Evoral::Beats const bend = bfc.from (_start + _length);
 145
 146         {
 147                 /* Lock our source since we'll be reading from it.  write_to() will
 148                    take a lock on newsrc. */
 149                 Source::Lock lm (midi_source(0)->mutex());
 150                 if (midi_source(0)->write_to (lm, newsrc, bbegin, bend)) {
 151                         return boost::shared_ptr<MidiRegion> ();
 152                 }
 153         }
 154
 155         PropertyList plist;
 156
 157         plist.add (Properties::name, PBD::basename_nosuffix (newsrc->name()));
 158         plist.add (Properties::whole_file, true);
 159         plist.add (Properties::start, _start);
 160         plist.add (Properties::start_beats, _start_beats);
 161         plist.add (Properties::length, _length);
 162         plist.add (Properties::length_beats, _length_beats);
 163         plist.add (Properties::layer, 0);
 164
 165         boost::shared_ptr<MidiRegion> ret (boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true)));
 166         ret->set_beat (beat());
 167
 168         return ret;
 169 }
 170
 171 void
 172 MidiRegion::post_set (const PropertyChange& pc)
 173 {
 174         Region::post_set (pc);
 175
 176         if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
 177                 /* update non-musically */
 178                 update_length_beats (0);
 179         } else if (pc.contains (Properties::start) && !pc.contains (Properties::start_beats)) {
 180                 set_start_beats_from_start_frames ();
 181         }
 182 }
 183
 184 void
 185 MidiRegion::set_start_beats_from_start_frames ()
 186 {
 187         _start_beats = Evoral::Beats (beat() - _session.tempo_map().beat_at_frame (_position - _start));
 188 }
 189
 190 void
 191 MidiRegion::set_length_internal (framecnt_t len, const int32_t& sub_num)
 192 {
 193         Region::set_length_internal (len, sub_num);
 194         update_length_beats (sub_num);
 195 }
 196
 197 void
 198 MidiRegion::update_after_tempo_map_change (bool /* send */)
 199 {
 200         Region::update_after_tempo_map_change (false);
 201
 202         /* _start has now been updated. */
 203         _length = _session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position;
 204
 205         PropertyChange s_and_l;
 206         s_and_l.add (Properties::start);
 207         s_and_l.add (Properties::length);
 208         s_and_l.add (Properties::length_beats);
 209         s_and_l.add (Properties::position);
 210
 211         send_change (s_and_l);
 212 }
 213
 214 void
 215 MidiRegion::update_length_beats (const int32_t& sub_num)
 216 {
 217         _length_beats = Evoral::Beats (_session.tempo_map().exact_beat_at_frame (_position + _length, sub_num) - beat());
 218 }
 219
 220 void
 221 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute, const int32_t& sub_num)
 222 {
 223         Region::set_position_internal (pos, allow_bbt_recompute, sub_num);
 224
 225         /* set _start to new position in tempo map */
 226         _start = _position - _session.tempo_map().frame_at_beat (beat() - _start_beats.val().to_double());
 227
 228         /* leave _length_beats alone, and change _length to reflect the state of things
 229            at the new position (tempo map may dictate a different number of frames).
 230         */
 231         Region::set_length_internal (_session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position, sub_num);
 232 }
 233
 234 framecnt_t
 235 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out,
 236                      framepos_t                     position,
 237                      framecnt_t                     dur,
 238                      uint32_t                       chan_n,
 239                      NoteMode                       mode,
 240                      MidiStateTracker*              tracker,
 241                      MidiChannelFilter*             filter) const
 242 {
 243         return _read_at (_sources, out, position, dur, chan_n, mode, tracker, filter);
 244 }
 245
 246 framecnt_t
 247 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 248 {
 249         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 250 }
 251
 252 framecnt_t
 253 MidiRegion::_read_at (const SourceList&              /*srcs*/,
 254                       Evoral::EventSink<framepos_t>& dst,
 255                       framepos_t                     position,
 256                       framecnt_t                     dur,
 257                       uint32_t                       chan_n,
 258                       NoteMode                       mode,
 259                       MidiStateTracker*              tracker,
 260                       MidiChannelFilter*             filter) const
 261 {
 262         frameoffset_t internal_offset = 0;
 263         framecnt_t    to_read         = 0;
 264
 265         /* precondition: caller has verified that we cover the desired section */
 266
 267         assert(chan_n == 0);
 268
 269         if (muted()) {
 270                 return 0; /* read nothing */
 271         }
 272
 273         if (position < _position) {
 274                 /* we are starting the read from before the start of the region */
 275                 internal_offset = 0;
 276                 dur -= _position - position;
 277         } else {
 278                 /* we are starting the read from after the start of the region */
 279                 internal_offset = position - _position;
 280         }
 281
 282         if (internal_offset >= _length) {
 283                 return 0; /* read nothing */
 284         }
 285
 286         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 287                 return 0; /* read nothing */
 288         }
 289
 290         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 291
 292         Glib::Threads::Mutex::Lock lm(src->mutex());
 293
 294         src->set_note_mode(lm, mode);
 295
 296         /*
 297           cerr << "MR " << name () << " read @ " << position << " * " << to_read
 298           << " _position = " << _position
 299           << " _start = " << _start
 300           << " intoffset = " << internal_offset
 301           << endl;
 302         */
 303
 304         /* This call reads events from a source and writes them to `dst' timed in session frames */
 305
 306         if (src->midi_read (
 307                     lm, // source lock
 308                         dst, // destination buffer
 309                         _position - _start, // start position of the source in session frames
 310                         _start + internal_offset, // where to start reading in the source
 311                         to_read, // read duration in frames
 312                         tracker,
 313                         filter,
 314                         _filtered_parameters
 315                     ) != to_read) {
 316                 return 0; /* "read nothing" */
 317         }
 318
 319         return to_read;
 320 }
 321
 322 XMLNode&
 323 MidiRegion::state ()
 324 {
 325         return Region::state ();
 326 }
 327
 328 int
 329 MidiRegion::set_state (const XMLNode& node, int version)
 330 {
 331         int ret = Region::set_state (node, version);
 332
 333         if (ret == 0) {
 334                 /* set length beats to the frame (non-musical) */
 335                 if (position_lock_style() == AudioTime) {
 336                         update_length_beats (0);
 337                 }
 338         }
 339
 340         return ret;
 341 }
 342
 343 void
 344 MidiRegion::recompute_at_end ()
 345 {
 346         /* our length has changed
 347          * so what? stuck notes are dealt with via a note state tracker
 348          */
 349 }
 350
 351 void
 352 MidiRegion::recompute_at_start ()
 353 {
 354         /* as above, but the shift was from the front
 355          * maybe bump currently active note's note-ons up so they sound here?
 356          * that could be undesireable in certain situations though.. maybe
 357          * remove the note entirely, including it's note off?  something needs to
 358          * be done to keep the played MIDI sane to avoid messing up voices of
 359          * polyhonic things etc........
 360          */
 361 }
 362
 363 int
 364 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 365 {
 366         // TODO
 367         return -1;
 368 }
 369
 370 boost::shared_ptr<Evoral::Control>
 371 MidiRegion::control (const Evoral::Parameter& id, bool create)
 372 {
 373         return model()->control(id, create);
 374 }
 375
 376 boost::shared_ptr<const Evoral::Control>
 377 MidiRegion::control (const Evoral::Parameter& id) const
 378 {
 379         return model()->control(id);
 380 }
 381
 382 boost::shared_ptr<MidiModel>
 383 MidiRegion::model()
 384 {
 385         return midi_source()->model();
 386 }
 387
 388 boost::shared_ptr<const MidiModel>
 389 MidiRegion::model() const
 390 {
 391         return midi_source()->model();
 392 }
 393
 394 boost::shared_ptr<MidiSource>
 395 MidiRegion::midi_source (uint32_t n) const
 396 {
 397         // Guaranteed to succeed (use a static cast?)
 398         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 399 }
 400
 401 void
 402 MidiRegion::model_changed ()
 403 {
 404         if (!model()) {
 405                 return;
 406         }
 407
 408         /* build list of filtered Parameters, being those whose automation state is not `Play' */
 409
 410         _filtered_parameters.clear ();
 411
 412         Automatable::Controls const & c = model()->controls();
 413
 414         for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
 415                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 416                 assert (ac);
 417                 if (ac->alist()->automation_state() != Play) {
 418                         _filtered_parameters.insert (ac->parameter ());
 419                 }
 420         }
 421
 422         /* watch for changes to controls' AutoState */
 423         midi_source()->AutomationStateChanged.connect_same_thread (
 424                 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
 425                 );
 426 }
 427
 428 void
 429 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
 430 {
 431         /* Update our filtered parameters list after a change to a parameter's AutoState */
 432
 433         boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
 434         if (!ac || ac->alist()->automation_state() == Play) {
 435                 /* It should be "impossible" for ac to be NULL, but if it is, don't
 436                    filter the parameter so events aren't lost. */
 437                 _filtered_parameters.erase (p);
 438         } else {
 439                 _filtered_parameters.insert (p);
 440         }
 441
 442         /* the source will have an iterator into the model, and that iterator will have been set up
 443            for a given set of filtered_parameters, so now that we've changed that list we must invalidate
 444            the iterator.
 445         */
 446         Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex(), Glib::Threads::TRY_LOCK);
 447         if (lm.locked()) {
 448                 /* TODO: This is too aggressive, we need more fine-grained invalidation. */
 449                 midi_source(0)->invalidate (lm);
 450         }
 451 }
 452
 453 /** This is called when a trim drag has resulted in a -ve _start time for this region.
 454  *  Fix it up by adding some empty space to the source.
 455  */
 456 void
 457 MidiRegion::fix_negative_start ()
 458 {
 459         BeatsFramesConverter c (_session.tempo_map(), _position);
 460
 461         model()->insert_silence_at_start (c.from (-_start));
 462         _start = 0;
 463         _start_beats = Evoral::Beats();
 464 }
 465
 466 void
 467 MidiRegion::set_start_internal (framecnt_t s, const int32_t& sub_num)
 468 {
 469         Region::set_start_internal (s, sub_num);
 470
 471         if (position_lock_style() == AudioTime) {
 472                 set_start_beats_from_start_frames ();
 473         }
 474 }
 475
 476 void
 477 MidiRegion::trim_to_internal (framepos_t position, framecnt_t length, const int32_t& sub_num)
 478 {
 479         framepos_t new_start;
 480
 481         if (locked()) {
 482                 return;
 483         }
 484
 485         PropertyChange what_changed;
 486
 487         /* beat has not been set by set_position_internal */
 488         const double beat_delta = _session.tempo_map().exact_beat_at_frame (position, sub_num) - beat();
 489
 490         /* Set position before length, otherwise for MIDI regions this bad thing happens:
 491          * 1. we call set_length_internal; length in beats is computed using the region's current
 492          *    (soon-to-be old) position
 493          * 2. we call set_position_internal; position is set and length in frames re-computed using
 494          *    length in beats from (1) but at the new position, which is wrong if the region
 495          *    straddles a tempo/meter change.
 496          */
 497
 498         if (_position != position) {
 499                 set_position_internal (position, true, sub_num);
 500                 what_changed.add (Properties::position);
 501         }
 502
 503         const double new_beat = _session.tempo_map().exact_beat_at_frame (position, sub_num);
 504         const double new_start_beat = _start_beats.val().to_double() + beat_delta;
 505
 506         new_start = _position - _session.tempo_map().frame_at_beat (new_beat - new_start_beat);
 507
 508         if (!verify_start_and_length (new_start, length)) {
 509                 return;
 510         }
 511
 512         if (_start != new_start) {
 513                 _start_beats = Evoral::Beats (new_start_beat);
 514                 what_changed.add (Properties::start_beats);
 515
 516                 set_start_internal (new_start, sub_num);
 517                 what_changed.add (Properties::start);
 518         }
 519
 520         if (_length != length) {
 521                 set_length_internal (length, sub_num);
 522                 what_changed.add (Properties::length);
 523                 what_changed.add (Properties::length_beats);
 524         }
 525
 526         set_whole_file (false);
 527
 528         PropertyChange start_and_length;
 529
 530         start_and_length.add (Properties::start);
 531         start_and_length.add (Properties::length);
 532
 533         if (what_changed.contains (start_and_length)) {
 534                 first_edit ();
 535         }
 536
 537         if (!what_changed.empty()) {
 538                 send_change (what_changed);
 539         }
 540 }