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