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 <sigc++/bind.h>
  28 #include <sigc++/class_slot.h>
  29
  30 #include <glibmm/thread.h>
  31
  32 #include "pbd/basename.h"
  33 #include "pbd/xml++.h"
  34 #include "pbd/enumwriter.h"
  35
  36 #include "ardour/midi_region.h"
  37 #include "ardour/session.h"
  38 #include "ardour/gain.h"
  39 #include "ardour/dB.h"
  40 #include "ardour/playlist.h"
  41 #include "ardour/midi_source.h"
  42 #include "ardour/types.h"
  43 #include "ardour/midi_ring_buffer.h"
  44
  45 #include "i18n.h"
  46 #include <locale.h>
  47
  48 using namespace std;
  49 using namespace ARDOUR;
  50
  51 /** Basic MidiRegion constructor (one channel) */
  52 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length)
  53         : Region (src, start, length, PBD::basename_nosuffix(src->name()), DataType::MIDI, 0,  Region::Flag(Region::DefaultFlags|Region::External))
  54 {
  55         assert(_name.find("/") == string::npos);
  56         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  57 }
  58
  59 /* Basic MidiRegion constructor (one channel) */
  60 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
  61         : Region (src, start, length, name, DataType::MIDI, layer, flags)
  62 {
  63         assert(_name.find("/") == string::npos);
  64         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  65 }
  66
  67 /* Basic MidiRegion constructor (many channels) */
  68 MidiRegion::MidiRegion (const SourceList& srcs, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
  69         : Region (srcs, start, length, name, DataType::MIDI, layer, flags)
  70 {
  71         assert(_name.find("/") == string::npos);
  72         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  73 }
  74
  75
  76 /** Create a new MidiRegion, that is part of an existing one */
  77 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, nframes_t offset, nframes_t length, const string& name, layer_t layer, Flag flags)
  78         : Region (other, offset, length, name, layer, flags)
  79 {
  80         assert(_name.find("/") == string::npos);
  81         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  82 }
  83
  84 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
  85         : Region (other)
  86 {
  87         assert(_name.find("/") == string::npos);
  88         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  89 }
  90
  91 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, const XMLNode& node)
  92         : Region (src, node)
  93 {
  94         if (set_state (node)) {
  95                 throw failed_constructor();
  96         }
  97
  98         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
  99         assert(_name.find("/") == string::npos);
 100         assert(_type == DataType::MIDI);
 101 }
 102
 103 MidiRegion::MidiRegion (const SourceList& srcs, const XMLNode& node)
 104         : Region (srcs, node)
 105 {
 106         if (set_state (node)) {
 107                 throw failed_constructor();
 108         }
 109
 110         midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
 111         assert(_name.find("/") == string::npos);
 112         assert(_type == DataType::MIDI);
 113 }
 114
 115 MidiRegion::~MidiRegion ()
 116 {
 117 }
 118
 119 void
 120 MidiRegion::set_position_internal (nframes_t pos, bool allow_bbt_recompute)
 121 {
 122         BeatsFramesConverter old_converter(_session, _position - _start);
 123         double length_beats = old_converter.from(_length);
 124
 125         Region::set_position_internal(pos, allow_bbt_recompute);
 126
 127         BeatsFramesConverter new_converter(_session, pos - _start);
 128
 129         set_length(new_converter.to(length_beats), 0);
 130 }
 131
 132 nframes_t
 133 MidiRegion::read_at (MidiRingBuffer<nframes_t>& out, sframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 134 {
 135         return _read_at (_sources, out, position, dur, chan_n, mode);
 136 }
 137
 138 nframes_t
 139 MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, sframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 140 {
 141         return _read_at (_master_sources, out, position, dur, chan_n, mode);
 142 }
 143
 144 nframes_t
 145 MidiRegion::_read_at (const SourceList& /*srcs*/, MidiRingBuffer<nframes_t>& dst, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 146 {
 147         nframes_t internal_offset = 0;
 148         nframes_t src_offset      = 0;
 149         nframes_t to_read         = 0;
 150
 151         /* precondition: caller has verified that we cover the desired section */
 152
 153         assert(chan_n == 0);
 154
 155         if (position < _position) {
 156                 internal_offset = 0;
 157                 src_offset = _position - position;
 158                 dur -= src_offset;
 159         } else {
 160                 internal_offset = position - _position;
 161                 src_offset = 0;
 162         }
 163
 164         if (internal_offset >= _length) {
 165                 return 0; /* read nothing */
 166         }
 167
 168         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 169                 return 0; /* read nothing */
 170         }
 171
 172         // FIXME: non-opaque MIDI regions not yet supported
 173         assert(opaque());
 174
 175         if (muted()) {
 176                 return 0; /* read nothing */
 177         }
 178
 179         _read_data_count = 0;
 180
 181         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 182         src->set_note_mode(mode);
 183
 184         nframes_t output_buffer_position = 0;
 185         nframes_t negative_output_buffer_position = 0;
 186         if (_position >= _start) {
 187                 // handle resizing of beginnings of regions correctly
 188                 output_buffer_position = _position - _start;
 189         } else {
 190                 // when _start is greater than _position, we have to subtract
 191                 // _start from the note times in the midi source
 192                 negative_output_buffer_position = _start;
 193         }
 194
 195 #if 0
 196         cerr << "\t\tsource read from " << _position << " - " << _start << " (" << _position - _start << ") "
 197              << " start in source " << _start << " + " << internal_offset << " (" << _start + internal_offset << ") "
 198              << " dur = " << to_read
 199              << " offset = " << output_buffer_position
 200              << " negoffset = " << negative_output_buffer_position
 201              << endl;
 202 #endif
 203
 204         if (src->midi_read (
 205                         dst, // destination buffer
 206                         _position - _start, // start position of the source in this read context
 207                         _start + internal_offset, // where to start reading in the source
 208                         to_read, // read duration in frames
 209                         output_buffer_position, // the offset in the output buffer
 210                         negative_output_buffer_position // amount to substract from note times
 211                 ) != to_read) {
 212                 return 0; /* "read nothing" */
 213         }
 214
 215         _read_data_count += src->read_data_count();
 216
 217         return to_read;
 218 }
 219
 220 XMLNode&
 221 MidiRegion::state (bool full)
 222 {
 223         XMLNode& node (Region::state (full));
 224         char buf[64];
 225         char buf2[64];
 226         LocaleGuard lg (X_("POSIX"));
 227
 228         node.add_property ("flags", enum_2_string (_flags));
 229
 230         // XXX these should move into Region
 231
 232         for (uint32_t n=0; n < _sources.size(); ++n) {
 233                 snprintf (buf2, sizeof(buf2), "source-%d", n);
 234                 _sources[n]->id().print (buf, sizeof(buf));
 235                 node.add_property (buf2, buf);
 236         }
 237
 238         for (uint32_t n=0; n < _master_sources.size(); ++n) {
 239                 snprintf (buf2, sizeof(buf2), "master-source-%d", n);
 240                 _master_sources[n]->id().print (buf, sizeof (buf));
 241                 node.add_property (buf2, buf);
 242         }
 243
 244         if (full && _extra_xml) {
 245                 node.add_child_copy (*_extra_xml);
 246         }
 247
 248         return node;
 249 }
 250
 251 int
 252 MidiRegion::set_live_state (const XMLNode& node, Change& what_changed, bool send)
 253 {
 254         const XMLProperty *prop;
 255         LocaleGuard lg (X_("POSIX"));
 256
 257         Region::set_live_state (node, what_changed, false);
 258
 259         uint32_t old_flags = _flags;
 260
 261         if ((prop = node.property ("flags")) != 0) {
 262                 _flags = Flag (string_2_enum (prop->value(), _flags));
 263
 264                 //_flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
 265
 266                 _flags = Flag (_flags & ~Region::LeftOfSplit);
 267                 _flags = Flag (_flags & ~Region::RightOfSplit);
 268         }
 269
 270         if ((old_flags ^ _flags) & Muted) {
 271                 what_changed = Change (what_changed|MuteChanged);
 272         }
 273         if ((old_flags ^ _flags) & Opaque) {
 274                 what_changed = Change (what_changed|OpacityChanged);
 275         }
 276         if ((old_flags ^ _flags) & Locked) {
 277                 what_changed = Change (what_changed|LockChanged);
 278         }
 279
 280         if (send) {
 281                 send_change (what_changed);
 282         }
 283
 284         return 0;
 285 }
 286
 287 int
 288 MidiRegion::set_state (const XMLNode& node)
 289 {
 290         /* Region::set_state() calls the virtual set_live_state(),
 291            which will get us back to AudioRegion::set_live_state()
 292            to handle the relevant stuff.
 293         */
 294
 295         return Region::set_state (node);
 296 }
 297
 298 void
 299 MidiRegion::recompute_at_end ()
 300 {
 301         /* our length has changed
 302          * (non destructively) "chop" notes that pass the end boundary, to
 303          * prevent stuck notes.
 304          */
 305 }
 306
 307 void
 308 MidiRegion::recompute_at_start ()
 309 {
 310         /* as above, but the shift was from the front
 311          * maybe bump currently active note's note-ons up so they sound here?
 312          * that could be undesireable in certain situations though.. maybe
 313          * remove the note entirely, including it's note off?  something needs to
 314          * be done to keep the played MIDI sane to avoid messing up voices of
 315          * polyhonic things etc........
 316          */
 317 }
 318
 319 int
 320 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
 321 {
 322         // TODO
 323         return -1;
 324 }
 325
 326 int
 327 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
 328 {
 329         return -1;
 330 }
 331
 332 boost::shared_ptr<MidiSource>
 333 MidiRegion::midi_source (uint32_t n) const
 334 {
 335         // Guaranteed to succeed (use a static cast?)
 336         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 337 }
 338
 339
 340 void
 341 MidiRegion::switch_source(boost::shared_ptr<Source> src)
 342 {
 343         boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
 344         if (!msrc)
 345                 return;
 346
 347         // MIDI regions have only one source
 348         _sources.clear();
 349         _sources.push_back(msrc);
 350
 351         set_name(msrc->name());
 352 }
 353