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