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