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 "pbd/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), sub_num) - other->beat()) + other->_start_beats;
 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         boost::shared_ptr<Playlist> pl (playlist());
 201
 202         if (!pl || position_lock_style() != MusicTime) {
 203                 return;
 204         }
 205
 206         const framepos_t old_pos = _position;
 207         const framepos_t old_length = _length;
 208         const framepos_t old_start = _start;
 209
 210         Region::update_after_tempo_map_change (false);
 211
 212         /* _start has now been updated. */
 213         _length = _session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position;
 214
 215         PropertyChange s_and_l;
 216         if (old_start != _start) {
 217                 s_and_l.add (Properties::start);
 218         }
 219         if (old_length != _length) {
 220                 s_and_l.add (Properties::length);
 221         }
 222         if (old_pos != _position) {
 223                 s_and_l.add (Properties::position);
 224         }
 225
 226         send_change (s_and_l);
 227 }
 228
 229 void
 230 MidiRegion::update_length_beats (const int32_t sub_num)
 231 {
 232         _length_beats = Evoral::Beats (_session.tempo_map().exact_beat_at_frame (_position + _length, sub_num) - beat());
 233 }
 234
 235 void
 236 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute, const int32_t sub_num)
 237 {
 238         Region::set_position_internal (pos, allow_bbt_recompute, sub_num);
 239
 240         /* set _start to new position in tempo map */
 241         _start = _position - _session.tempo_map().frame_at_beat (beat() - _start_beats.val().to_double());
 242
 243         /* in construction from src */
 244         if (_length_beats == Evoral::Beats()) {
 245                 update_length_beats (sub_num);
 246         }
 247
 248         /* leave _length_beats alone, and change _length to reflect the state of things
 249            at the new position (tempo map may dictate a different number of frames).
 250         */
 251         Region::set_length_internal (_session.tempo_map().frame_at_beat (beat() + _length_beats.val().to_double()) - _position, sub_num);
 252 }
 253
 254 framecnt_t
 255 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out,
 256                      framepos_t                     position,
 257                      framecnt_t                     dur,
 258                      uint32_t                       chan_n,
 259                      NoteMode                       mode,
 260                      MidiStateTracker*              tracker,
 261                      MidiChannelFilter*             filter) const
 262 {
 263         return _read_at (_sources, out, position, dur, chan_n, mode, tracker, filter);
 264 }
 265
 266 framecnt_t
 267 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 268 {
 269         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 270 }
 271
 272 framecnt_t
 273 MidiRegion::_read_at (const SourceList&              /*srcs*/,
 274                       Evoral::EventSink<framepos_t>& dst,
 275                       framepos_t                     position,
 276                       framecnt_t                     dur,
 277                       uint32_t                       chan_n,
 278                       NoteMode                       mode,
 279                       MidiStateTracker*              tracker,
 280                       MidiChannelFilter*             filter) const
 281 {
 282         frameoffset_t internal_offset = 0;
 283         framecnt_t    to_read         = 0;
 284
 285         /* precondition: caller has verified that we cover the desired section */
 286
 287         assert(chan_n == 0);
 288
 289         if (muted()) {
 290                 return 0; /* read nothing */
 291         }
 292
 293         if (position < _position) {
 294                 /* we are starting the read from before the start of the region */
 295                 internal_offset = 0;
 296                 dur -= _position - position;
 297         } else {
 298                 /* we are starting the read from after the start of the region */
 299                 internal_offset = position - _position;
 300         }
 301
 302         if (internal_offset >= _length) {
 303                 return 0; /* read nothing */
 304         }
 305
 306         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 307                 return 0; /* read nothing */
 308         }
 309
 310         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 311
 312         Glib::Threads::Mutex::Lock lm(src->mutex());
 313
 314         src->set_note_mode(lm, mode);
 315
 316         /*
 317           cerr << "MR " << name () << " read @ " << position << " * " << to_read
 318           << " _position = " << _position
 319           << " _start = " << _start
 320           << " intoffset = " << internal_offset
 321           << endl;
 322         */
 323
 324         /* This call reads events from a source and writes them to `dst' timed in session frames */
 325
 326         if (src->midi_read (
 327                     lm, // source lock
 328                         dst, // destination buffer
 329                         _position - _start, // start position of the source in session frames
 330                         _start + internal_offset, // where to start reading in the source
 331                         to_read, // read duration in frames
 332                         tracker,
 333                         filter,
 334                         _filtered_parameters,
 335                         beat(),
 336                         _start_beats.val().to_double()
 337                     ) != to_read) {
 338                 return 0; /* "read nothing" */
 339         }
 340
 341         return to_read;
 342 }
 343
 344 XMLNode&
 345 MidiRegion::state ()
 346 {
 347         return Region::state ();
 348 }
 349
 350 int
 351 MidiRegion::set_state (const XMLNode& node, int version)
 352 {
 353         int ret = Region::set_state (node, version);
 354
 355         if (ret == 0) {
 356                 /* set length beats to the frame (non-musical) */
 357                 if (position_lock_style() == AudioTime) {
 358                         update_length_beats (0);
 359                 }
 360         }
 361
 362         return ret;
 363 }
 364
 365 void
 366 MidiRegion::recompute_at_end ()
 367 {
 368         /* our length has changed
 369          * so what? stuck notes are dealt with via a note state tracker
 370          */
 371 }
 372
 373 void
 374 MidiRegion::recompute_at_start ()
 375 {
 376         /* as above, but the shift was from the front
 377          * maybe bump currently active note's note-ons up so they sound here?
 378          * that could be undesireable in certain situations though.. maybe
 379          * remove the note entirely, including it's note off?  something needs to
 380          * be done to keep the played MIDI sane to avoid messing up voices of
 381          * polyhonic things etc........
 382          */
 383 }
 384
 385 int
 386 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 387 {
 388         // TODO
 389         return -1;
 390 }
 391
 392 boost::shared_ptr<Evoral::Control>
 393 MidiRegion::control (const Evoral::Parameter& id, bool create)
 394 {
 395         return model()->control(id, create);
 396 }
 397
 398 boost::shared_ptr<const Evoral::Control>
 399 MidiRegion::control (const Evoral::Parameter& id) const
 400 {
 401         return model()->control(id);
 402 }
 403
 404 boost::shared_ptr<MidiModel>
 405 MidiRegion::model()
 406 {
 407         return midi_source()->model();
 408 }
 409
 410 boost::shared_ptr<const MidiModel>
 411 MidiRegion::model() const
 412 {
 413         return midi_source()->model();
 414 }
 415
 416 boost::shared_ptr<MidiSource>
 417 MidiRegion::midi_source (uint32_t n) const
 418 {
 419         // Guaranteed to succeed (use a static cast?)
 420         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 421 }
 422
 423 void
 424 MidiRegion::model_changed ()
 425 {
 426         if (!model()) {
 427                 return;
 428         }
 429
 430         /* build list of filtered Parameters, being those whose automation state is not `Play' */
 431
 432         _filtered_parameters.clear ();
 433
 434         Automatable::Controls const & c = model()->controls();
 435
 436         for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
 437                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 438                 assert (ac);
 439                 if (ac->alist()->automation_state() != Play) {
 440                         _filtered_parameters.insert (ac->parameter ());
 441                 }
 442         }
 443
 444         /* watch for changes to controls' AutoState */
 445         midi_source()->AutomationStateChanged.connect_same_thread (
 446                 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
 447                 );
 448 }
 449
 450 void
 451 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
 452 {
 453         /* Update our filtered parameters list after a change to a parameter's AutoState */
 454
 455         boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
 456         if (!ac || ac->alist()->automation_state() == Play) {
 457                 /* It should be "impossible" for ac to be NULL, but if it is, don't
 458                    filter the parameter so events aren't lost. */
 459                 _filtered_parameters.erase (p);
 460         } else {
 461                 _filtered_parameters.insert (p);
 462         }
 463
 464         /* the source will have an iterator into the model, and that iterator will have been set up
 465            for a given set of filtered_parameters, so now that we've changed that list we must invalidate
 466            the iterator.
 467         */
 468         Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex(), Glib::Threads::TRY_LOCK);
 469         if (lm.locked()) {
 470                 /* TODO: This is too aggressive, we need more fine-grained invalidation. */
 471                 midi_source(0)->invalidate (lm);
 472         }
 473 }
 474
 475 /** This is called when a trim drag has resulted in a -ve _start time for this region.
 476  *  Fix it up by adding some empty space to the source.
 477  */
 478 void
 479 MidiRegion::fix_negative_start ()
 480 {
 481         BeatsFramesConverter c (_session.tempo_map(), _position);
 482
 483         model()->insert_silence_at_start (c.from (-_start));
 484         _start = 0;
 485         _start_beats = Evoral::Beats();
 486 }
 487
 488 void
 489 MidiRegion::set_start_internal (framecnt_t s, const int32_t sub_num)
 490 {
 491         Region::set_start_internal (s, sub_num);
 492
 493         if (position_lock_style() == AudioTime) {
 494                 set_start_beats_from_start_frames ();
 495                 }
 496 }
 497
 498 void
 499 MidiRegion::trim_to_internal (framepos_t position, framecnt_t length, const int32_t sub_num)
 500 {
 501         framepos_t new_start;
 502
 503         if (locked()) {
 504                 return;
 505         }
 506
 507         PropertyChange what_changed;
 508
 509         /* beat has been set exactly by set_position_internal, but the source starts on a frame.
 510            working in beats seems the correct thing to do, but reports of a missing first note
 511            on playback suggest otherwise. for now, we work in exact beats.
 512         */
 513         const double pos_beat = _session.tempo_map().exact_beat_at_frame (position, sub_num);
 514         const double beat_delta = pos_beat - beat();
 515
 516         /* Set position before length, otherwise for MIDI regions this bad thing happens:
 517          * 1. we call set_length_internal; length in beats is computed using the region's current
 518          *    (soon-to-be old) position
 519          * 2. we call set_position_internal; position is set and length in frames re-computed using
 520          *    length in beats from (1) but at the new position, which is wrong if the region
 521          *    straddles a tempo/meter change.
 522          */
 523
 524         if (_position != position) {
 525                 set_position_internal (position, true, sub_num);
 526                 what_changed.add (Properties::position);
 527         }
 528
 529         const double new_start_beat = _start_beats.val().to_double() + beat_delta;
 530         new_start = _position - _session.tempo_map().frame_at_beat (beat() - new_start_beat);
 531
 532         if (!verify_start_and_length (new_start, length)) {
 533                 return;
 534         }
 535
 536         if (_start != new_start) {
 537                 _start_beats = Evoral::Beats (new_start_beat);
 538                 what_changed.add (Properties::start_beats);
 539
 540                 set_start_internal (new_start, sub_num);
 541                 what_changed.add (Properties::start);
 542         }
 543
 544         if (_length != length) {
 545                 set_length_internal (length, sub_num);
 546                 what_changed.add (Properties::length);
 547                 what_changed.add (Properties::length_beats);
 548         }
 549
 550         set_whole_file (false);
 551
 552         PropertyChange start_and_length;
 553
 554         start_and_length.add (Properties::start);
 555         start_and_length.add (Properties::length);
 556
 557         if (what_changed.contains (start_and_length)) {
 558                 first_edit ();
 559         }
 560
 561         if (!what_changed.empty()) {
 562                 send_change (what_changed);
 563         }
 564 }