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::MusicalTime>  start_beats;
  58                 PBD::PropertyDescriptor<Evoral::MusicalTime>  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::MusicalTime())
  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::MusicalTime())
  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::MusicalTime())
 111         , _length_beats (Properties::length_beats, Evoral::MusicalTime())
 112 {
 113         BeatsFramesConverter bfc (_session.tempo_map(), _position);
 114         Evoral::MusicalTime 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::MusicalTime const bbegin = bfc.from (_start);
 151         Evoral::MusicalTime const bend = bfc.from (_start + _length);
 152
 153         if (midi_source(0)->write_to (newsrc, bbegin, bend)) {
 154                 return boost::shared_ptr<MidiRegion> ();
 155         }
 156
 157         PropertyList plist;
 158
 159         plist.add (Properties::name, PBD::basename_nosuffix (newsrc->name()));
 160         plist.add (Properties::whole_file, true);
 161         plist.add (Properties::start, _start);
 162         plist.add (Properties::start_beats, _start_beats);
 163         plist.add (Properties::length, _length);
 164         plist.add (Properties::length_beats, _length_beats);
 165         plist.add (Properties::layer, 0);
 166
 167         return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (newsrc, plist, true));
 168 }
 169
 170 void
 171 MidiRegion::post_set (const PropertyChange& pc)
 172 {
 173         Region::post_set (pc);
 174
 175         if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
 176                 update_length_beats ();
 177         } else if (pc.contains (Properties::start) && !pc.contains (Properties::start_beats)) {
 178                 set_start_beats_from_start_frames ();
 179         }
 180 }
 181
 182 void
 183 MidiRegion::set_start_beats_from_start_frames ()
 184 {
 185         BeatsFramesConverter c (_session.tempo_map(), _position - _start);
 186         _start_beats = c.from (_start);
 187 }
 188
 189 void
 190 MidiRegion::set_length_internal (framecnt_t len)
 191 {
 192         Region::set_length_internal (len);
 193         update_length_beats ();
 194 }
 195
 196 void
 197 MidiRegion::update_after_tempo_map_change ()
 198 {
 199         Region::update_after_tempo_map_change ();
 200
 201         /* _position has now been updated for the new tempo map */
 202         _start = _position - _session.tempo_map().framepos_minus_beats (_position, _start_beats);
 203
 204         send_change (Properties::start);
 205 }
 206
 207 void
 208 MidiRegion::update_length_beats ()
 209 {
 210         BeatsFramesConverter converter (_session.tempo_map(), _position);
 211         _length_beats = converter.from (_length);
 212 }
 213
 214 void
 215 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 216 {
 217         Region::set_position_internal (pos, allow_bbt_recompute);
 218         /* zero length regions don't exist - so if _length_beats is zero, this object
 219            is under construction.
 220         */
 221         if (_length_beats.val() == Evoral::MusicalTime()) {
 222                 /* leave _length_beats alone, and change _length to reflect the state of things
 223                    at the new position (tempo map may dictate a different number of frames
 224                 */
 225                 BeatsFramesConverter converter (_session.tempo_map(), _position);
 226                 Region::set_length_internal (converter.to (_length_beats));
 227         }
 228 }
 229
 230 framecnt_t
 231 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 232 {
 233         return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 234 }
 235
 236 framecnt_t
 237 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 238 {
 239         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 240 }
 241
 242 framecnt_t
 243 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n,
 244                       NoteMode mode, MidiStateTracker* tracker) const
 245 {
 246         frameoffset_t internal_offset = 0;
 247         framecnt_t to_read         = 0;
 248
 249         /* precondition: caller has verified that we cover the desired section */
 250
 251         assert(chan_n == 0);
 252
 253         if (muted()) {
 254                 return 0; /* read nothing */
 255         }
 256
 257         if (position < _position) {
 258                 /* we are starting the read from before the start of the region */
 259                 internal_offset = 0;
 260                 dur -= _position - position;
 261         } else {
 262                 /* we are starting the read from after the start of the region */
 263                 internal_offset = position - _position;
 264         }
 265
 266         if (internal_offset >= _length) {
 267                 return 0; /* read nothing */
 268         }
 269
 270         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 271                 return 0; /* read nothing */
 272         }
 273
 274         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 275         src->set_note_mode(mode);
 276
 277         /*
 278           cerr << "MR " << name () << " read @ " << position << " * " << to_read
 279           << " _position = " << _position
 280           << " _start = " << _start
 281           << " intoffset = " << internal_offset
 282           << endl;
 283         */
 284
 285         /* This call reads events from a source and writes them to `dst' timed in session frames */
 286
 287         if (src->midi_read (
 288                         dst, // destination buffer
 289                         _position - _start, // start position of the source in session frames
 290                         _start + internal_offset, // where to start reading in the source
 291                         to_read, // read duration in frames
 292                         tracker,
 293                         _filtered_parameters
 294                     ) != to_read) {
 295                 return 0; /* "read nothing" */
 296         }
 297
 298         return to_read;
 299 }
 300
 301 XMLNode&
 302 MidiRegion::state ()
 303 {
 304         return Region::state ();
 305 }
 306
 307 int
 308 MidiRegion::set_state (const XMLNode& node, int version)
 309 {
 310         int ret = Region::set_state (node, version);
 311
 312         if (ret == 0) {
 313                 update_length_beats ();
 314         }
 315
 316         return ret;
 317 }
 318
 319 void
 320 MidiRegion::recompute_at_end ()
 321 {
 322         /* our length has changed
 323          * so what? stuck notes are dealt with via a note state tracker
 324          */
 325 }
 326
 327 void
 328 MidiRegion::recompute_at_start ()
 329 {
 330         /* as above, but the shift was from the front
 331          * maybe bump currently active note's note-ons up so they sound here?
 332          * that could be undesireable in certain situations though.. maybe
 333          * remove the note entirely, including it's note off?  something needs to
 334          * be done to keep the played MIDI sane to avoid messing up voices of
 335          * polyhonic things etc........
 336          */
 337 }
 338
 339 int
 340 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 341 {
 342         // TODO
 343         return -1;
 344 }
 345
 346 boost::shared_ptr<Evoral::Control>
 347 MidiRegion::control (const Evoral::Parameter& id, bool create)
 348 {
 349         return model()->control(id, create);
 350 }
 351
 352 boost::shared_ptr<const Evoral::Control>
 353 MidiRegion::control (const Evoral::Parameter& id) const
 354 {
 355         return model()->control(id);
 356 }
 357
 358 boost::shared_ptr<MidiModel>
 359 MidiRegion::model()
 360 {
 361         return midi_source()->model();
 362 }
 363
 364 boost::shared_ptr<const MidiModel>
 365 MidiRegion::model() const
 366 {
 367         return midi_source()->model();
 368 }
 369
 370 boost::shared_ptr<MidiSource>
 371 MidiRegion::midi_source (uint32_t n) const
 372 {
 373         // Guaranteed to succeed (use a static cast?)
 374         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 375 }
 376
 377 void
 378 MidiRegion::model_changed ()
 379 {
 380         if (!model()) {
 381                 return;
 382         }
 383
 384         /* build list of filtered Parameters, being those whose automation state is not `Play' */
 385
 386         _filtered_parameters.clear ();
 387
 388         Automatable::Controls const & c = model()->controls();
 389
 390         for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
 391                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 392                 assert (ac);
 393                 if (ac->alist()->automation_state() != Play) {
 394                         _filtered_parameters.insert (ac->parameter ());
 395                 }
 396         }
 397
 398         /* watch for changes to controls' AutoState */
 399         midi_source()->AutomationStateChanged.connect_same_thread (
 400                 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
 401                 );
 402
 403         model()->ContentsChanged.connect_same_thread (
 404                 _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
 405 }
 406
 407 void
 408 MidiRegion::model_contents_changed ()
 409 {
 410         send_change (PropertyChange (Properties::midi_data));
 411 }
 412
 413 void
 414 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
 415 {
 416         /* Update our filtered parameters list after a change to a parameter's AutoState */
 417
 418         boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
 419         if (!ac || ac->alist()->automation_state() == Play) {
 420                 /* It should be "impossible" for ac to be NULL, but if it is, don't
 421                    filter the parameter so events aren't lost. */
 422                 _filtered_parameters.erase (p);
 423         } else {
 424                 _filtered_parameters.insert (p);
 425         }
 426
 427         /* the source will have an iterator into the model, and that iterator will have been set up
 428            for a given set of filtered_parameters, so now that we've changed that list we must invalidate
 429            the iterator.
 430         */
 431         Glib::Threads::Mutex::Lock lm (midi_source(0)->mutex());
 432         midi_source(0)->invalidate ();
 433 }
 434
 435 /** This is called when a trim drag has resulted in a -ve _start time for this region.
 436  *  Fix it up by adding some empty space to the source.
 437  */
 438 void
 439 MidiRegion::fix_negative_start ()
 440 {
 441         BeatsFramesConverter c (_session.tempo_map(), _position);
 442
 443         model()->insert_silence_at_start (c.from (-_start));
 444         _start = 0;
 445         _start_beats = Evoral::MusicalTime();
 446 }
 447
 448 /** Transpose the notes in this region by a given number of semitones */
 449 void
 450 MidiRegion::transpose (int semitones)
 451 {
 452         BeatsFramesConverter c (_session.tempo_map(), _start);
 453         model()->transpose (c.from (_start), c.from (_start + _length), semitones);
 454 }
 455
 456 void
 457 MidiRegion::set_start_internal (framecnt_t s)
 458 {
 459         Region::set_start_internal (s);
 460         set_start_beats_from_start_frames ();
 461 }