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         }
  54 }
  55
  56 void
  57 MidiRegion::make_property_quarks ()
  58 {
  59         Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
  60         DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
  61 }
  62
  63 void
  64 MidiRegion::register_properties ()
  65 {
  66         /* none yet, but its only a matter of time */
  67 }
  68
  69 /* Basic MidiRegion constructor (many channels) */
  70 MidiRegion::MidiRegion (const SourceList& srcs)
  71         : Region (srcs)
  72 {
  73         register_properties ();
  74
  75         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
  76         model_changed ();
  77         assert(_name.val().find("/") == string::npos);
  78         assert(_type == DataType::MIDI);
  79 }
  80
  81 /** Create a new MidiRegion, that is part of an existing one */
  82 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, bool offset_relative)
  83         : Region (other, offset, offset_relative)
  84 {
  85         register_properties ();
  86
  87         assert(_name.val().find("/") == string::npos);
  88         midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
  89         model_changed ();
  90 }
  91
  92 MidiRegion::~MidiRegion ()
  93 {
  94 }
  95
  96 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
  97  */
  98 boost::shared_ptr<MidiRegion>
  99 MidiRegion::clone ()
 100 {
 101         BeatsFramesConverter bfc (_session.tempo_map(), _position);
 102         double bbegin = bfc.from (_position);
 103         double bend = bfc.from (last_frame() + 1);
 104
 105         boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
 106
 107         PropertyList plist;
 108
 109         plist.add (Properties::name, ms->name());
 110         plist.add (Properties::whole_file, true);
 111         plist.add (Properties::start, 0);
 112         plist.add (Properties::length, _length);
 113         plist.add (Properties::layer, 0);
 114
 115         return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
 116 }
 117
 118 void
 119 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
 120 {
 121         BeatsFramesConverter old_converter(_session.tempo_map(), _position - _start);
 122         double length_beats = old_converter.from(_length);
 123
 124         Region::set_position_internal(pos, allow_bbt_recompute);
 125
 126         BeatsFramesConverter new_converter(_session.tempo_map(), pos - _start);
 127
 128         set_length(new_converter.to(length_beats), 0);
 129 }
 130
 131 framecnt_t
 132 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
 133 {
 134         return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
 135 }
 136
 137 framecnt_t
 138 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
 139 {
 140         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
 141 }
 142
 143 framecnt_t
 144 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n,
 145                       NoteMode mode, MidiStateTracker* tracker) const
 146 {
 147         frameoffset_t internal_offset = 0;
 148         framecnt_t to_read         = 0;
 149
 150         /* precondition: caller has verified that we cover the desired section */
 151
 152         assert(chan_n == 0);
 153
 154         if (muted()) {
 155                 return 0; /* read nothing */
 156         }
 157
 158         if (position < _position) {
 159                 /* we are starting the read from before the start of the region */
 160                 internal_offset = 0;
 161                 dur -= _position - position;
 162         } else {
 163                 /* we are starting the read from after the start of the region */
 164                 internal_offset = position - _position;
 165         }
 166
 167         if (internal_offset >= _length) {
 168                 return 0; /* read nothing */
 169         }
 170
 171         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 172                 return 0; /* read nothing */
 173         }
 174
 175         _read_data_count = 0;
 176
 177         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 178         src->set_note_mode(mode);
 179
 180         /*
 181           cerr << "MR read @ " << position << " * " << to_read
 182           << " _position = " << _position
 183           << " _start = " << _start
 184           << " intoffset = " << internal_offset
 185           << endl;
 186         */
 187
 188         /* This call reads events from a source and writes them to `dst' timed in session frames */
 189
 190         if (src->midi_read (
 191                         dst, // destination buffer
 192                         _position - _start, // start position of the source in session frames
 193                         _start + internal_offset, // where to start reading in the source
 194                         to_read, // read duration in frames
 195                         tracker,
 196                         _filtered_parameters
 197                     ) != to_read) {
 198                 return 0; /* "read nothing" */
 199         }
 200
 201         _read_data_count += src->read_data_count();
 202
 203         return to_read;
 204 }
 205
 206 XMLNode&
 207 MidiRegion::state ()
 208 {
 209         return Region::state ();
 210 }
 211
 212 int
 213 MidiRegion::set_state (const XMLNode& node, int version)
 214 {
 215         return Region::set_state (node, version);
 216 }
 217
 218 void
 219 MidiRegion::recompute_at_end ()
 220 {
 221         /* our length has changed
 222          * so what? stuck notes are dealt with via a note state tracker
 223          */
 224 }
 225
 226 void
 227 MidiRegion::recompute_at_start ()
 228 {
 229         /* as above, but the shift was from the front
 230          * maybe bump currently active note's note-ons up so they sound here?
 231          * that could be undesireable in certain situations though.. maybe
 232          * remove the note entirely, including it's note off?  something needs to
 233          * be done to keep the played MIDI sane to avoid messing up voices of
 234          * polyhonic things etc........
 235          */
 236 }
 237
 238 int
 239 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 240 {
 241         // TODO
 242         return -1;
 243 }
 244
 245 int
 246 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
 247 {
 248         return -1;
 249 }
 250
 251 boost::shared_ptr<MidiSource>
 252 MidiRegion::midi_source (uint32_t n) const
 253 {
 254         // Guaranteed to succeed (use a static cast?)
 255         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 256 }
 257
 258 void
 259 MidiRegion::model_changed ()
 260 {
 261         if (!model()) {
 262                 return;
 263         }
 264
 265         /* build list of filtered Parameters, being those whose automation state is not `Play' */
 266
 267         _filtered_parameters.clear ();
 268
 269         Automatable::Controls const & c = model()->controls();
 270
 271         for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
 272                 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
 273                 assert (ac);
 274                 if (ac->alist()->automation_state() != Play) {
 275                         _filtered_parameters.insert (ac->parameter ());
 276                 }
 277         }
 278
 279         /* watch for changes to controls' AutoState */
 280         midi_source()->AutomationStateChanged.connect_same_thread (
 281                 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
 282                 );
 283
 284         model()->ContentsChanged.connect_same_thread (
 285                 _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
 286 }
 287
 288 void
 289 MidiRegion::model_contents_changed ()
 290 {
 291         send_change (PropertyChange (Properties::midi_data));
 292 }
 293
 294 void
 295 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
 296 {
 297         /* Update our filtered parameters list after a change to a parameter's AutoState */
 298
 299         boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
 300         assert (ac);
 301
 302         if (ac->alist()->automation_state() == Play) {
 303                 _filtered_parameters.erase (p);
 304         } else {
 305                 _filtered_parameters.insert (p);
 306         }
 307
 308         /* the source will have an iterator into the model, and that iterator will have been set up
 309            for a given set of filtered_paramters, so now that we've changed that list we must invalidate
 310            the iterator.
 311         */
 312         Glib::Mutex::Lock lm (midi_source(0)->mutex());
 313         midi_source(0)->invalidate ();
 314 }