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/types.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<void*>         midi_data;
  57                 PBD::PropertyDescriptor<Evoral::Beats> start_beats;
  58                 PBD::PropertyDescriptor<Evoral::Beats> length_beats;
  59         }
  60 }
  61
  62 void
  63 MidiRegion::make_property_quarks ()
  64 {
  65         Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
  66         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
  67         Properties::start_beats.property_id = g_quark_from_static_string (X_("start-beats"));
  68         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for start-beats = %1\n", Properties::start_beats.property_id));
  69         Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
  70         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
  71 }
  72
  73 void
  74 MidiRegion::register_properties ()
  75 {
  76         add_property (_start_beats);
  77         add_property (_length_beats);
  78 }
  79
  80 /* Basic MidiRegion constructor (many channels) */
  81 MidiRegion::MidiRegion (const SourceList& srcs)
  82         : Region (srcs)
  83         , _start_beats (Properties::start_beats, Evoral::Beats())
  84         , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
  85 {
  86         register_properties ();
  87
  88         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
  89         model_changed ();
  90         assert(_name.val().find("/") == string::npos);
  91         assert(_type == DataType::MIDI);
  92 }
  93
  94 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
  95         : Region (other)
  96         , _start_beats (Properties::start_beats, other->_start_beats)
  97         , _length_beats (Properties::length_beats, Evoral::Beats())
  98 {
  99         update_length_beats ();
 100         register_properties ();
 101
 102         assert(_name.val().find("/") == string::npos);
 103         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
 104         model_changed ();
 105 }
 106
 107 /** Create a new MidiRegion that is part of an existing one */
 108 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset)
 109         : Region (other, offset)
 110         , _start_beats (Properties::start_beats, Evoral::Beats())
 111         , _length_beats (Properties::length_beats, Evoral::Beats())
 112 {
 113         BeatsFramesConverter bfc (_session.tempo_map(), _position);
 114         Evoral::Beats const offset_beats = bfc.from (offset);
 115
 116         _start_beats  = other->_start_beats.val() + offset_beats;
 117         _length_beats = other->_length_beats.val() - offset_beats;
 118
 119         register_properties ();
 120
 121         assert(_name.val().find("/") == string::npos);
 122         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
 123         model_changed ();
 124 }
 125
 126 MidiRegion::~MidiRegion ()
 127 {
 128 }
 129
 130 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
 131  */
 132 boost::shared_ptr<MidiRegion>
 133 MidiRegion::clone (string path) const
 134 {
 135         boost::shared_ptr<MidiSource> newsrc;
 136
 137         /* caller must check for pre-existing file */
 138         assert (!path.empty());
 139         assert (!Glib::file_test (path, Glib::FILE_TEST_EXISTS));
 140         newsrc = boost::dynamic_pointer_cast<MidiSource>(
 141                 SourceFactory::createWritable(DataType::MIDI, _session,
 142                                               path, false, _session.frame_rate()));
 143         return clone (newsrc);
 144 }
 145
 146 boost::shared_ptr<MidiRegion>
 147 MidiRegion::clone (boost::shared_ptr<MidiSource> newsrc) const
 148 {
 149         BeatsFramesConverter bfc (_session.tempo_map(), _position);
 150         Evoral::Beats const bbegin = bfc.from (_start);
 151         Evoral::Beats const bend = bfc.from (_start + _length);
 152
 153         {
 154                 /* Lock our source since we'll be reading from it.  write_to() will
 155                    take a lock on newsrc. */
 156                 Source::Lock lm (midi_source(0)->mutex());
 157                 if (midi_source(0)->write_to (lm, newsrc, bbegin, bend)) {
 158                         return boost::shared_ptr<MidiRegion> ();
 159                 }
 160         }
 161
 162         PropertyList plist;
 163
 164         plist.add (Properties::name, PBD::basename_nosuffix (newsrc->name()));
 165         plist.add (Properties::whole_file, true);
 166         plist.add (Properties::start, _start);
 167         plist.add (Properties::start_beats, _start_beats);
 168         plist.add (Properties::length, _length);
 169         plist.add (Properties::length_beats, _length_beats);
 170         plist.add (Properties::layer, 0);
 171
 172         return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true));
 173 }
 174
 175 void
 176 MidiRegion::post_set (const PropertyChange& pc)
 177 {
 178         Region::post_set (pc);
 179
 180         if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
 181                 update_length_beats ();
 182         } else if (pc.contains (Properties::start) && !pc.contains (Properties::start_beats)) {
 183                 set_start_beats_from_start_frames ();
 184         }
 185 }
 186
 187 void
 188 MidiRegion::set_start_beats_from_start_frames ()
 189 {
 190         BeatsFramesConverter c (_session.tempo_map(), _position - _start);
 191         _start_beats = c.from (_start);
 192 }
 193
 194 void
 195 MidiRegion::set_length_internal (framecnt_t len)
 196 {
 197         Region::set_length_internal (len);
 198         update_length_beats ();
 199 }
 200
 201 void
 202 MidiRegion::update_after_tempo_map_change ()
 203 {
 204         Region::update_after_tempo_map_change ();
 205
 206         /* _position has now been updated for the new tempo map */
 207         _start = _position - _session.tempo_map().framepos_minus_beats (_position, _start_beats);
 208
 209         send_change (Properties::start);
 210 }
 211
 212 void
 213 MidiRegion::update_length_beats ()
 214 {
 215         BeatsFramesConverter converter (_session.tempo_map(), _position);
 216         _length_beats = converter.from (_length);
 217 }
 218
 219 void
 220 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 221 {
 222         Region::set_position_internal (pos, allow_bbt_recompute);
 223         /* zero length regions don't exist - so if _length_beats is zero, this object
 224            is under construction.
 225         */
 226         if (_length_beats.val() == Evoral::Beats()) {
 227                 /* leave _length_beats alone, and change _length to reflect the state of things
 228                    at the new position (tempo map may dictate a different number of frames
 229                 */
 230                 BeatsFramesConverter converter (_session.tempo_map(), _position);
 231                 Region::set_length_internal (converter.to (_length_beats));
 232         }
 233 }
 234
 235 framecnt_t
 236 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 237 {
 238         return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 239 }
 240
 241 framecnt_t
 242 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 243 {
 244         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 245 }
 246
 247 framecnt_t
 248 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n,
 249                       NoteMode mode, MidiStateTracker* tracker) const
 250 {
 251         frameoffset_t internal_offset = 0;
 252         framecnt_t to_read         = 0;
 253
 254         /* precondition: caller has verified that we cover the desired section */
 255
 256         assert(chan_n == 0);
 257
 258         if (muted()) {
 259                 return 0; /* read nothing */
 260         }
 261
 262         if (position < _position) {
 263                 /* we are starting the read from before the start of the region */
 264                 internal_offset = 0;
 265                 dur -= _position - position;
 266         } else {
 267                 /* we are starting the read from after the start of the region */
 268                 internal_offset = position - _position;
 269         }
 270
 271         if (internal_offset >= _length) {
 272                 return 0; /* read nothing */
 273         }
 274
 275         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 276                 return 0; /* read nothing */
 277         }
 278
 279         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 280
 281         Glib::Threads::Mutex::Lock lm(src->mutex());
 282
 283         src->set_note_mode(lm, mode);
 284
 285         /*
 286           cerr << "MR " << name () << " read @ " << position << " * " << to_read
 287           << " _position = " << _position
 288           << " _start = " << _start
 289           << " intoffset = " << internal_offset
 290           << endl;
 291         */
 292
 293         /* This call reads events from a source and writes them to `dst' timed in session frames */
 294
 295         if (src->midi_read (
 296                     lm, // source lock
 297                         dst, // destination buffer
 298                         _position - _start, // start position of the source in session frames
 299                         _start + internal_offset, // where to start reading in the source
 300                         to_read, // read duration in frames
 301                         tracker,
 302                         _filtered_parameters
 303                     ) != to_read) {
 304                 return 0; /* "read nothing" */
 305         }
 306
 307         return to_read;
 308 }
 309
 310 XMLNode&
 311 MidiRegion::state ()
 312 {
 313         return Region::state ();
 314 }
 315
 316 int
 317 MidiRegion::set_state (const XMLNode& node, int version)
 318 {
 319         int ret = Region::set_state (node, version);
 320
 321         if (ret == 0) {
 322                 update_length_beats ();
 323         }
 324
 325         return ret;
 326 }
 327
 328 void
 329 MidiRegion::recompute_at_end ()
 330 {
 331         /* our length has changed
 332          * so what? stuck notes are dealt with via a note state tracker
 333          */
 334 }
 335
 336 void
 337 MidiRegion::recompute_at_start ()
 338 {
 339         /* as above, but the shift was from the front
 340          * maybe bump currently active note's note-ons up so they sound here?
 341          * that could be undesireable in certain situations though.. maybe
 342          * remove the note entirely, including it's note off?  something needs to
 343          * be done to keep the played MIDI sane to avoid messing up voices of
 344          * polyhonic things etc........
 345          */
 346 }
 347
 348 int
 349 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 350 {
 351         // TODO
 352         return -1;
 353 }
 354
 355 boost::shared_ptr<Evoral::Control>
 356 MidiRegion::control (const Evoral::Parameter& id, bool create)
 357 {
 358         return model()->control(id, create);
 359 }
 360
 361 boost::shared_ptr<const Evoral::Control>
 362 MidiRegion::control (const Evoral::Parameter& id) const
 363 {
 364         return model()->control(id);
 365 }
 366
 367 boost::shared_ptr<MidiModel>
 368 MidiRegion::model()
 369 {
 370         return midi_source()->model();
 371 }
 372
 373 boost::shared_ptr<const MidiModel>
 374 MidiRegion::model() const
 375 {
 376         return midi_source()->model();
 377 }
 378
 379 boost::shared_ptr<MidiSource>
 380 MidiRegion::midi_source (uint32_t n) const
 381 {
 382         // Guaranteed to succeed (use a static cast?)
 383         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 384 }
 385
 386 void
 387 MidiRegion::model_changed ()
 388 {
 389         if (!model()) {
 390                 return;
 391         }
 392
 393         /* build list of filtered Parameters, being those whose automation state is not `Play' */
 394
 395         _filtered_parameters.clear ();
 396
 397         Automatable::Controls const & c = model()->controls();
 398
 399         for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
 400                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 401                 assert (ac);
 402                 if (ac->alist()->automation_state() != Play) {
 403                         _filtered_parameters.insert (ac->parameter ());
 404                 }
 405         }
 406
 407         /* watch for changes to controls' AutoState */
 408         midi_source()->AutomationStateChanged.connect_same_thread (
 409                 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
 410                 );
 411
 412         model()->ContentsChanged.connect_same_thread (
 413                 _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
 414 }
 415
 416 void
 417 MidiRegion::model_contents_changed ()
 418 {
 419         {
 420                 /* Invalidate source iterator to force reading new contents even if the
 421                    calls to read() progress linearly.  Try-lock only to avoid deadlock
 422                    when called while writing with the source already locked. */
 423                 Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex(), Glib::Threads::TRY_LOCK);
 424                 if (lm.locked()) {
 425                         midi_source(0)->invalidate (lm);
 426                 }
 427         }
 428         send_change (PropertyChange (Properties::midi_data));
 429 }
 430
 431 void
 432 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
 433 {
 434         /* Update our filtered parameters list after a change to a parameter's AutoState */
 435
 436         boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
 437         if (!ac || ac->alist()->automation_state() == Play) {
 438                 /* It should be "impossible" for ac to be NULL, but if it is, don't
 439                    filter the parameter so events aren't lost. */
 440                 _filtered_parameters.erase (p);
 441         } else {
 442                 _filtered_parameters.insert (p);
 443         }
 444
 445         /* the source will have an iterator into the model, and that iterator will have been set up
 446            for a given set of filtered_parameters, so now that we've changed that list we must invalidate
 447            the iterator.
 448         */
 449         Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex(), Glib::Threads::TRY_LOCK);
 450         if (lm.locked()) {
 451                 midi_source(0)->invalidate (lm);
 452         }
 453 }
 454
 455 /** This is called when a trim drag has resulted in a -ve _start time for this region.
 456  *  Fix it up by adding some empty space to the source.
 457  */
 458 void
 459 MidiRegion::fix_negative_start ()
 460 {
 461         BeatsFramesConverter c (_session.tempo_map(), _position);
 462
 463         model()->insert_silence_at_start (c.from (-_start));
 464         _start = 0;
 465         _start_beats = Evoral::Beats();
 466 }
 467
 468 /** Transpose the notes in this region by a given number of semitones */
 469 void
 470 MidiRegion::transpose (int semitones)
 471 {
 472         BeatsFramesConverter c (_session.tempo_map(), _start);
 473         model()->transpose (c.from (_start), c.from (_start + _length), semitones);
 474 }
 475
 476 void
 477 MidiRegion::set_start_internal (framecnt_t s)
 478 {
 479         Region::set_start_internal (s);
 480         set_start_beats_from_start_frames ();
 481 }