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