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