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 nframes_t
 120 MidiRegion::read_at (MidiRingBuffer& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 121 {
 122         return _read_at (_sources, out, position, dur, chan_n, mode);
 123 }
 124
 125 nframes_t
 126 MidiRegion::master_read_at (MidiRingBuffer& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 127 {
 128         return _read_at (_master_sources, out, position, dur, chan_n, mode);
 129 }
 130
 131 nframes_t
 132 MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer& dst, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
 133 {
 134         // cerr << _name << "._read_at(" << position << ") - " << _position << endl;
 135
 136         nframes_t internal_offset = 0;
 137         nframes_t src_offset      = 0;
 138         nframes_t to_read         = 0;
 139
 140         /* precondition: caller has verified that we cover the desired section */
 141
 142         assert(chan_n == 0);
 143
 144         if (position < _position) {
 145                 internal_offset = 0;
 146                 src_offset = _position - position;
 147                 dur -= src_offset;
 148         } else {
 149                 internal_offset = position - _position;
 150                 src_offset = 0;
 151         }
 152
 153         if (internal_offset >= _length) {
 154                 return 0; /* read nothing */
 155         }
 156
 157
 158         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 159                 return 0; /* read nothing */
 160         }
 161
 162         // FIXME: non-opaque MIDI regions not yet supported
 163         assert(opaque());
 164
 165         if (muted()) {
 166                 return 0; /* read nothing */
 167         }
 168
 169         _read_data_count = 0;
 170
 171         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 172         src->set_note_mode(mode);
 173
 174         if (src->midi_read (dst, _start + internal_offset, to_read, _position) != to_read) {
 175                 return 0; /* "read nothing" */
 176         }
 177
 178         _read_data_count += src->read_data_count();
 179
 180         return to_read;
 181 }
 182
 183 XMLNode&
 184 MidiRegion::state (bool full)
 185 {
 186         XMLNode& node (Region::state (full));
 187         char buf[64];
 188         char buf2[64];
 189         LocaleGuard lg (X_("POSIX"));
 190
 191         node.add_property ("flags", enum_2_string (_flags));
 192
 193         // XXX these should move into Region
 194
 195         for (uint32_t n=0; n < _sources.size(); ++n) {
 196                 snprintf (buf2, sizeof(buf2), "source-%d", n);
 197                 _sources[n]->id().print (buf, sizeof(buf));
 198                 node.add_property (buf2, buf);
 199         }
 200
 201         for (uint32_t n=0; n < _master_sources.size(); ++n) {
 202                 snprintf (buf2, sizeof(buf2), "master-source-%d", n);
 203                 _master_sources[n]->id().print (buf, sizeof (buf));
 204                 node.add_property (buf2, buf);
 205         }
 206
 207         if (full && _extra_xml) {
 208                 node.add_child_copy (*_extra_xml);
 209         }
 210
 211         return node;
 212 }
 213
 214 int
 215 MidiRegion::set_live_state (const XMLNode& node, Change& what_changed, bool send)
 216 {
 217         const XMLProperty *prop;
 218         LocaleGuard lg (X_("POSIX"));
 219
 220         Region::set_live_state (node, what_changed, false);
 221
 222         uint32_t old_flags = _flags;
 223
 224         if ((prop = node.property ("flags")) != 0) {
 225                 _flags = Flag (string_2_enum (prop->value(), _flags));
 226
 227                 //_flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
 228
 229                 _flags = Flag (_flags & ~Region::LeftOfSplit);
 230                 _flags = Flag (_flags & ~Region::RightOfSplit);
 231         }
 232
 233         if ((old_flags ^ _flags) & Muted) {
 234                 what_changed = Change (what_changed|MuteChanged);
 235         }
 236         if ((old_flags ^ _flags) & Opaque) {
 237                 what_changed = Change (what_changed|OpacityChanged);
 238         }
 239         if ((old_flags ^ _flags) & Locked) {
 240                 what_changed = Change (what_changed|LockChanged);
 241         }
 242
 243         if (send) {
 244                 send_change (what_changed);
 245         }
 246
 247         return 0;
 248 }
 249
 250 int
 251 MidiRegion::set_state (const XMLNode& node)
 252 {
 253         /* Region::set_state() calls the virtual set_live_state(),
 254            which will get us back to AudioRegion::set_live_state()
 255            to handle the relevant stuff.
 256         */
 257
 258         return Region::set_state (node);
 259 }
 260
 261 void
 262 MidiRegion::recompute_at_end ()
 263 {
 264         /* our length has changed
 265          * (non destructively) "chop" notes that pass the end boundary, to
 266          * prevent stuck notes.
 267          */
 268 }
 269
 270 void
 271 MidiRegion::recompute_at_start ()
 272 {
 273         /* as above, but the shift was from the front
 274          * maybe bump currently active note's note-ons up so they sound here?
 275          * that could be undesireable in certain situations though.. maybe
 276          * remove the note entirely, including it's note off?  something needs to
 277          * be done to keep the played MIDI sane to avoid messing up voices of
 278          * polyhonic things etc........
 279          */
 280 }
 281
 282 int
 283 MidiRegion::separate_by_channel (Session& session, vector<MidiRegion*>& v) const
 284 {
 285         // Separate by MIDI channel?  bit different from audio since this is separating based
 286         // on the actual contained data and destructively modifies and creates new sources..
 287
 288 #if 0
 289         SourceList srcs;
 290         string new_name;
 291
 292         for (SourceList::const_iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
 293
 294                 srcs.clear ();
 295                 srcs.push_back (*i);
 296
 297                 /* generate a new name */
 298
 299                 if (session.region_name (new_name, _name)) {
 300                         return -1;
 301                 }
 302
 303                 /* create a copy with just one source */
 304
 305                 v.push_back (new MidiRegion (srcs, _start, _length, new_name, _layer, _flags));
 306         }
 307 #endif
 308
 309         // Actually, I would prefer not if that's alright
 310         return -1;
 311 }
 312
 313 int
 314 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
 315 {
 316         return -1;
 317 }
 318
 319 boost::shared_ptr<MidiSource>
 320 MidiRegion::midi_source (uint32_t n) const
 321 {
 322         // Guaranteed to succeed (use a static cast?)
 323         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 324 }
 325
 326
 327 void
 328 MidiRegion::switch_source(boost::shared_ptr<Source> src)
 329 {
 330         boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
 331         if (!msrc)
 332                 return;
 333
 334         // MIDI regions have only one source
 335         _sources.clear();
 336         _sources.push_back(msrc);
 337
 338         set_name(msrc->name());
 339 }
 340