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, nframes_t start, 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, nframes_t start, 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, nframes_t start, 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, nframes_t offset, 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 nframes_t
 112 MidiRegion::read_at (MidiRingBuffer& out, nframes_t position, nframes_t dur, uint32_t chan_n) const
 113 {
 114         return _read_at (_sources, out, position, dur, chan_n);
 115 }
 116
 117 nframes_t
 118 MidiRegion::master_read_at (MidiRingBuffer& out, nframes_t position, nframes_t dur, uint32_t chan_n) const
 119 {
 120         return _read_at (_master_sources, out, position, dur, chan_n);
 121 }
 122
 123 nframes_t
 124 MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer& dst, nframes_t position, nframes_t dur, uint32_t chan_n) const
 125 {
 126         // cerr << _name << "._read_at(" << position << ") - " << _position << endl;
 127
 128         nframes_t internal_offset = 0;
 129         nframes_t src_offset      = 0;
 130         nframes_t to_read         = 0;
 131
 132         /* precondition: caller has verified that we cover the desired section */
 133
 134         assert(chan_n == 0);
 135
 136         if (position < _position) {
 137                 internal_offset = 0;
 138                 src_offset = _position - position;
 139                 dur -= src_offset;
 140         } else {
 141                 internal_offset = position - _position;
 142                 src_offset = 0;
 143         }
 144
 145         if (internal_offset >= _length) {
 146                 return 0; /* read nothing */
 147         }
 148
 149
 150         if ((to_read = min (dur, _length - internal_offset)) == 0) {
 151                 return 0; /* read nothing */
 152         }
 153
 154         // FIXME: non-opaque MIDI regions not yet supported
 155         assert(opaque());
 156
 157         if (muted()) {
 158                 return 0; /* read nothing */
 159         }
 160
 161         _read_data_count = 0;
 162
 163         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
 164         if (src->read (dst, _start + internal_offset, to_read, _position) != to_read) {
 165                 return 0; /* "read nothing" */
 166         }
 167
 168         _read_data_count += src->read_data_count(); // FIXME: semantics?
 169
 170         return to_read;
 171 }
 172
 173 XMLNode&
 174 MidiRegion::state (bool full)
 175 {
 176         XMLNode& node (Region::state (full));
 177         XMLNode *child;
 178         char buf[64];
 179         char buf2[64];
 180         LocaleGuard lg (X_("POSIX"));
 181
 182         snprintf (buf, sizeof (buf), "0x%x", (int) _flags);
 183         node.add_property ("flags", buf);
 184
 185         for (uint32_t n=0; n < _sources.size(); ++n) {
 186                 snprintf (buf2, sizeof(buf2), "source-%d", n);
 187                 _sources[n]->id().print (buf, sizeof(buf));
 188                 node.add_property (buf2, buf);
 189         }
 190
 191         snprintf (buf, sizeof (buf), "%u", (uint32_t) _sources.size());
 192         node.add_property ("channels", buf);
 193
 194         child = node.add_child ("Envelope");
 195
 196         if ( ! full) {
 197                 child->add_property ("default", "yes");
 198         }
 199
 200         if (full && _extra_xml) {
 201                 node.add_child_copy (*_extra_xml);
 202         }
 203
 204         return node;
 205 }
 206
 207 int
 208 MidiRegion::set_state (const XMLNode& node)
 209 {
 210         const XMLNodeList& nlist = node.children();
 211         const XMLProperty *prop;
 212         LocaleGuard lg (X_("POSIX"));
 213
 214         Region::set_state (node);
 215
 216         if ((prop = node.property ("flags")) != 0) {
 217                 _flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
 218         }
 219
 220         /* Now find child items */
 221         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
 222
 223                 XMLNode *child;
 224                 //XMLProperty *prop;
 225
 226                 child = (*niter);
 227
 228                 /** Hello, children */
 229         }
 230
 231         return 0;
 232 }
 233
 234 void
 235 MidiRegion::recompute_at_end ()
 236 {
 237         /* our length has changed
 238          * (non destructively) "chop" notes that pass the end boundary, to
 239          * prevent stuck notes.
 240          */
 241 }
 242
 243 void
 244 MidiRegion::recompute_at_start ()
 245 {
 246         /* as above, but the shift was from the front
 247          * maybe bump currently active note's note-ons up so they sound here?
 248          * that could be undesireable in certain situations though.. maybe
 249          * remove the note entirely, including it's note off?  something needs to
 250          * be done to keep the played MIDI sane to avoid messing up voices of
 251          * polyhonic things etc........
 252          */
 253 }
 254
 255 int
 256 MidiRegion::separate_by_channel (Session& session, vector<MidiRegion*>& v) const
 257 {
 258         // Separate by MIDI channel?  bit different from audio since this is separating based
 259         // on the actual contained data and destructively modifies and creates new sources..
 260
 261 #if 0
 262         SourceList srcs;
 263         string new_name;
 264
 265         for (SourceList::const_iterator i = _master_sources.begin(); i != _master_sources.end(); ++i) {
 266
 267                 srcs.clear ();
 268                 srcs.push_back (*i);
 269
 270                 /* generate a new name */
 271
 272                 if (session.region_name (new_name, _name)) {
 273                         return -1;
 274                 }
 275
 276                 /* create a copy with just one source */
 277
 278                 v.push_back (new MidiRegion (srcs, _start, _length, new_name, _layer, _flags));
 279         }
 280 #endif
 281
 282         // Actually, I would prefer not if that's alright
 283         return -1;
 284 }
 285
 286 boost::shared_ptr<MidiSource>
 287 MidiRegion::midi_source (uint32_t n) const
 288 {
 289         // Guaranteed to succeed (use a static cast?)
 290         return boost::dynamic_pointer_cast<MidiSource>(source(n));
 291 }
 292