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