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