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
  35 #include <ardour/midi_region.h>
  36 #include <ardour/session.h>
  37 #include <ardour/gain.h>
  38 #include <ardour/dB.h>
  39 #include <ardour/playlist.h>
  40 #include <ardour/midi_source.h>
  41 #include <ardour/types.h>
  42 #include <ardour/midi_ring_buffer.h>
  43
  44 #include "i18n.h"
  45 #include <locale.h>
  46
  47 using namespace std;
  48 using namespace ARDOUR;
  49
  50 /** Basic MidiRegion constructor (one channel) */
  51 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, jack_nframes_t start, jack_nframes_t length)
  52         : Region (src, start, length, PBD::basename_nosuffix(src->name()), DataType::MIDI, 0,  Region::Flag(Region::DefaultFlags|Region::External))
  53 {
  54         assert(_name.find("/") == string::npos);
  55 }
  56
  57 /* Basic MidiRegion constructor (one channel) */
  58 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t layer, Flag flags)
  59         : Region (src, start, length, name, DataType::MIDI, layer, flags)
  60 {
  61         assert(_name.find("/") == string::npos);
  62 }
  63
  64 /* Basic MidiRegion constructor (many channels) */
  65 MidiRegion::MidiRegion (SourceList& srcs, jack_nframes_t start, jack_nframes_t length, const string& name, layer_t layer, Flag flags)
  66         : Region (srcs, start, length, name, DataType::MIDI, layer, flags)
  67 {
  68         assert(_name.find("/") == string::npos);
  69 }
  70
  71
  72 /** Create a new MidiRegion, that is part of an existing one */
  73 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, jack_nframes_t offset, jack_nframes_t length, const string& name, layer_t layer, Flag flags)
  74         : Region (other, offset, length, name, layer, flags)
  75 {
  76         assert(_name.find("/") == string::npos);
  77 }
  78
  79 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
  80         : Region (other)
  81 {
  82         assert(_name.find("/") == string::npos);
  83 }
  84
  85 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, const XMLNode& node)
  86         : Region (src, node)
  87 {
  88         if (set_state (node)) {
  89                 throw failed_constructor();
  90         }
  91
  92         assert(_name.find("/") == string::npos);
  93         assert(_type == DataType::MIDI);
  94 }
  95
  96 MidiRegion::MidiRegion (SourceList& srcs, const XMLNode& node)
  97         : Region (srcs, node)
  98 {
  99         if (set_state (node)) {
 100                 throw failed_constructor();
 101         }
 102
 103         assert(_name.find("/") == string::npos);
 104         assert(_type == DataType::MIDI);
 105 }
 106
 107 MidiRegion::~MidiRegion ()
 108 {
 109 }
 110
 111 jack_nframes_t
 112 MidiRegion::read_at (MidiRingBuffer& out, jack_nframes_t position,
 113                       jack_nframes_t dur,
 114                       uint32_t chan_n, jack_nframes_t read_frames, jack_nframes_t skip_frames) const
 115 {
 116         return _read_at (_sources, out, position, dur, chan_n, read_frames, skip_frames);
 117 }
 118
 119 jack_nframes_t
 120 MidiRegion::master_read_at (MidiRingBuffer& out, jack_nframes_t position,
 121                              jack_nframes_t dur, uint32_t chan_n) const
 122 {
 123         return _read_at (_master_sources, out, position, dur, chan_n, 0, 0);
 124 }
 125
 126 jack_nframes_t
 127 MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer& dst,
 128                        jack_nframes_t position, jack_nframes_t dur,
 129                        uint32_t chan_n, jack_nframes_t read_frames, jack_nframes_t skip_frames) const
 130 {
 131         // cerr << _name << "._read_at(" << position << ") - " << _position << endl;
 132
 133         jack_nframes_t internal_offset = 0;
 134         jack_nframes_t src_offset      = 0;
 135         jack_nframes_t to_read         = 0;
 136
 137         /* precondition: caller has verified that we cover the desired section */
 138
 139         assert(chan_n == 0);
 140
 141         if (position < _position) {
 142                 internal_offset = 0;
 143                 src_offset = _position - position;
 144                 dur -= src_offset;
 145         } else {
 146                 internal_offset = position - _position;
 147                 src_offset = 0;
 148         }
 149
 150         if (internal_offset >= _length) {
 151                 return 0; /* read nothing */
 152         }
 153
 154
 155         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 156                 return 0; /* read nothing */
 157         }
 158
 159         // FIXME: non-opaque MIDI regions not yet supported
 160         assert(opaque());
 161
 162         if (muted()) {
 163                 return 0; /* read nothing */
 164         }
 165
 166         _read_data_count = 0;
 167
 168         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 169         if (src->read (dst, _start + internal_offset, to_read, _position) != to_read) {
 170                 return 0; /* "read nothing" */
 171         }
 172
 173         _read_data_count += src->read_data_count(); // FIXME: semantics?
 174
 175         return to_read;
 176 }
 177
 178 XMLNode&
 179 MidiRegion::state (bool full)
 180 {
 181         XMLNode& node (Region::state (full));
 182         XMLNode *child;
 183         char buf[64];
 184         char buf2[64];
 185         LocaleGuard lg (X_("POSIX"));
 186
 187         snprintf (buf, sizeof (buf), "0x%x", (int) _flags);
 188         node.add_property ("flags", buf);
 189
 190         for (uint32_t n=0; n < _sources.size(); ++n) {
 191                 snprintf (buf2, sizeof(buf2), "source-%d", n);
 192                 _sources[n]->id().print (buf, sizeof(buf));
 193                 node.add_property (buf2, buf);
 194         }
 195
 196         snprintf (buf, sizeof (buf), "%u", (uint32_t) _sources.size());
 197         node.add_property ("channels", buf);
 198
 199         child = node.add_child ("Envelope");
 200
 201         if ( ! full) {
 202                 child->add_property ("default", "yes");
 203         }
 204
 205         if (full && _extra_xml) {
 206                 node.add_child_copy (*_extra_xml);
 207         }
 208
 209         return node;
 210 }
 211
 212 int
 213 MidiRegion::set_state (const XMLNode& node)
 214 {
 215         const XMLNodeList& nlist = node.children();
 216         const XMLProperty *prop;
 217         LocaleGuard lg (X_("POSIX"));
 218
 219         Region::set_state (node);
 220
 221         if ((prop = node.property ("flags")) != 0) {
 222                 _flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
 223         }
 224
 225         /* Now find child items */
 226         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
 227
 228                 XMLNode *child;
 229                 //XMLProperty *prop;
 230
 231                 child = (*niter);
 232
 233                 /** Hello, children */
 234         }
 235
 236         return 0;
 237 }
 238
 239 void
 240 MidiRegion::recompute_at_end ()
 241 {
 242         /* our length has changed
 243          * (non destructively) "chop" notes that pass the end boundary, to
 244          * prevent stuck notes.
 245          */
 246 }
 247
 248 void
 249 MidiRegion::recompute_at_start ()
 250 {
 251         /* as above, but the shift was from the front
 252          * maybe bump currently active note's note-ons up so they sound here?
 253          * that could be undesireable in certain situations though.. maybe
 254          * remove the note entirely, including it's note off?  something needs to
 255          * be done to keep the played MIDI sane to avoid messing up voices of
 256          * polyhonic things etc........
 257          */
 258 }
 259
 260 int
 261 MidiRegion::separate_by_channel (Session& session, vector<MidiRegion*>& v) const
 262 {
 263         // Separate by MIDI channel?  bit different from audio since this is separating based
 264         // on the actual contained data and destructively modifies and creates new sources..
 265
 266 #if 0
 267         SourceList srcs;
 268         string new_name;
 269
 270         for (SourceList::const_iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
 271
 272                 srcs.clear ();
 273                 srcs.push_back (*i);
 274
 275                 /* generate a new name */
 276
 277                 if (session.region_name (new_name, _name)) {
 278                         return -1;
 279                 }
 280
 281                 /* create a copy with just one source */
 282
 283                 v.push_back (new MidiRegion (srcs, _start, _length, new_name, _layer, _flags));
 284         }
 285 #endif
 286
 287         // Actually, I would prefer not if that's alright
 288         return -1;
 289 }
 290
 291 boost::shared_ptr<MidiSource>
 292 MidiRegion::midi_source (uint32_t n) const
 293 {
 294         // Guaranteed to succeed (use a static cast?)
 295         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 296 }
 297