libs/ardour/buffer_set.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19
  20 #ifdef WAF_BUILD
  21 #include "libardour-config.h"
  22 #endif
  23
  24 #include <iostream>
  25 #include <algorithm>
  26 #include "ardour/buffer.h"
  27 #include "ardour/buffer_set.h"
  28 #include "ardour/midi_buffer.h"
  29 #include "ardour/port.h"
  30 #include "ardour/port_set.h"
  31 #include "ardour/audioengine.h"
  32 #ifdef HAVE_SLV2
  33 #include "ardour/lv2_plugin.h"
  34 #include "ardour/lv2_event_buffer.h"
  35 #endif
  36 #ifdef VST_SUPPORT
  37 #include "vestige/aeffectx.h"
  38 #endif
  39
  40 namespace ARDOUR {
  41
  42 /** Create a new, empty BufferSet */
  43 BufferSet::BufferSet()
  44         : _is_mirror(false)
  45 {
  46         for (size_t i=0; i < DataType::num_types; ++i) {
  47                 _buffers.push_back(BufferVec());
  48         }
  49
  50         _count.reset();
  51         _available.reset();
  52 }
  53
  54 BufferSet::~BufferSet()
  55 {
  56         clear();
  57 }
  58
  59 /** Destroy all contained buffers.
  60  */
  61 void
  62 BufferSet::clear()
  63 {
  64         if (!_is_mirror) {
  65                 for (std::vector<BufferVec>::iterator i = _buffers.begin(); i != _buffers.end(); ++i) {
  66                         for (BufferVec::iterator j = (*i).begin(); j != (*i).end(); ++j) {
  67                                 delete *j;
  68                         }
  69                         (*i).clear();
  70                 }
  71         }
  72         _buffers.clear();
  73         _count.reset();
  74         _available.reset();
  75
  76 #ifdef VST_SUPPORT
  77         for (VSTBuffers::iterator i = _vst_buffers.begin(); i != _vst_buffers.end(); ++i) {
  78                 delete *i;
  79         }
  80
  81         _vst_buffers.clear ();
  82 #endif
  83 }
  84
  85 /** Make this BufferSet a direct mirror of a PortSet's buffers.
  86  */
  87 void
  88 BufferSet::attach_buffers(PortSet& ports, nframes_t nframes, nframes_t offset)
  89 {
  90         clear();
  91
  92         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
  93                 _buffers.push_back(BufferVec());
  94                 BufferVec& v = _buffers[*t];
  95
  96                 for (PortSet::iterator p = ports.begin(*t); p != ports.end(*t); ++p) {
  97                         assert(p->type() == *t);
  98                         v.push_back(&(p->get_buffer(nframes, offset)));
  99                 }
 100         }
 101
 102         _count = ports.count();
 103         _available = ports.count();
 104
 105         _is_mirror = true;
 106 }
 107
 108 /** Ensure that there are @a num_buffers buffers of type @a type available,
 109  * each of size at least @a buffer_size
 110  */
 111 void
 112 BufferSet::ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity)
 113 {
 114         assert(type != DataType::NIL);
 115         assert(type < _buffers.size());
 116
 117         if (num_buffers == 0) {
 118                 return;
 119         }
 120
 121         // The vector of buffers of the type we care about
 122         BufferVec& bufs = _buffers[type];
 123
 124         // If we're a mirror just make sure we're ok
 125         if (_is_mirror) {
 126                 assert(_count.get(type) >= num_buffers);
 127                 assert(bufs[0]->type() == type);
 128                 return;
 129         }
 130
 131         // If there's not enough or they're too small, just nuke the whole thing and
 132         // rebuild it (so I'm lazy..)
 133         if (bufs.size() < num_buffers
 134                         || (bufs.size() > 0 && bufs[0]->capacity() < buffer_capacity)) {
 135
 136                 // Nuke it
 137                 for (BufferVec::iterator i = bufs.begin(); i != bufs.end(); ++i) {
 138                         delete (*i);
 139                 }
 140                 bufs.clear();
 141
 142                 // Rebuild it
 143                 for (size_t i = 0; i < num_buffers; ++i) {
 144                         bufs.push_back(Buffer::create(type, buffer_capacity));
 145                 }
 146
 147                 _available.set(type, num_buffers);
 148                 _count.set (type, num_buffers);
 149         }
 150
 151 #ifdef HAVE_SLV2
 152         // Ensure enough low level MIDI format buffers are available for conversion
 153         // in both directions (input & output, out-of-place)
 154         if (type == DataType::MIDI && _lv2_buffers.size() < _buffers[type].size() * 2 + 1) {
 155                 while (_lv2_buffers.size() < _buffers[type].size() * 2) {
 156                         _lv2_buffers.push_back(std::make_pair(false, new LV2EventBuffer(buffer_capacity)));
 157                 }
 158         }
 159 #endif
 160
 161 #ifdef VST_SUPPORT
 162         // As above but for VST
 163         if (type == DataType::MIDI) {
 164                 while (_vst_buffers.size() < _buffers[type].size()) {
 165                         _vst_buffers.push_back (new VSTBuffer (buffer_capacity));
 166                 }
 167         }
 168 #endif
 169
 170         // Post-conditions
 171         assert(bufs[0]->type() == type);
 172         assert(bufs.size() >= num_buffers);
 173         assert(bufs.size() == _available.get(type));
 174         assert(bufs[0]->capacity() >= buffer_capacity);
 175 }
 176
 177 /** Ensure that the number of buffers of each type @a type matches @a chns
 178  * and each buffer is of size at least @a buffer_capacity
 179  */
 180 void
 181 BufferSet::ensure_buffers(const ChanCount& chns, size_t buffer_capacity)
 182 {
 183         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
 184                 ensure_buffers (*i, chns.get (*i), buffer_capacity);
 185         }
 186 }
 187
 188 /** Get the capacity (size) of the available buffers of the given type.
 189  *
 190  * All buffers of a certain type always have the same capacity.
 191  */
 192 size_t
 193 BufferSet::buffer_capacity(DataType type) const
 194 {
 195         assert(_available.get(type) > 0);
 196         return _buffers[type][0]->capacity();
 197 }
 198
 199 Buffer&
 200 BufferSet::get(DataType type, size_t i)
 201 {
 202         assert(i < _available.get(type));
 203         return *_buffers[type][i];
 204 }
 205
 206 const Buffer&
 207 BufferSet::get(DataType type, size_t i) const
 208 {
 209         assert(i < _available.get(type));
 210         return *_buffers[type][i];
 211 }
 212
 213 #ifdef HAVE_SLV2
 214
 215 LV2EventBuffer&
 216 BufferSet::get_lv2_midi(bool input, size_t i)
 217 {
 218         MidiBuffer& mbuf = get_midi(i);
 219         LV2Buffers::value_type b = _lv2_buffers.at(i * 2 + (input ? 0 : 1));
 220         LV2EventBuffer* ebuf = b.second;
 221
 222         ebuf->reset();
 223         if (input) {
 224                 for (MidiBuffer::iterator e = mbuf.begin(); e != mbuf.end(); ++e) {
 225                         const Evoral::MIDIEvent<nframes_t> ev(*e, false);
 226                         uint32_t type = LV2Plugin::midi_event_type();
 227                         ebuf->append(ev.time(), 0, type, ev.size(), ev.buffer());
 228                 }
 229         }
 230         return *ebuf;
 231 }
 232
 233 void
 234 BufferSet::flush_lv2_midi(bool input, size_t i)
 235 {
 236         MidiBuffer& mbuf = get_midi(i);
 237         LV2Buffers::value_type b = _lv2_buffers.at(i * 2 + (input ? 0 : 1));
 238         LV2EventBuffer* ebuf = b.second;
 239
 240         mbuf.silence(0, 0);
 241         for (ebuf->rewind(); ebuf->is_valid(); ebuf->increment()) {
 242                 uint32_t frames;
 243                 uint32_t subframes;
 244                 uint16_t type;
 245                 uint16_t size;
 246                 uint8_t* data;
 247                 ebuf->get_event(&frames, &subframes, &type, &size, &data);
 248                 mbuf.push_back(frames, size, data);
 249         }
 250 }
 251
 252 #endif /* HAVE_SLV2 */
 253
 254 #ifdef VST_SUPPORT
 255
 256 VstEvents*
 257 BufferSet::get_vst_midi (size_t b)
 258 {
 259         MidiBuffer& m = get_midi (b);
 260         VSTBuffer* vst = _vst_buffers[b];
 261
 262         vst->clear ();
 263
 264         for (MidiBuffer::iterator i = m.begin(); i != m.end(); ++i) {
 265                 vst->push_back (*i);
 266         }
 267
 268         return vst->events();
 269 }
 270
 271 BufferSet::VSTBuffer::VSTBuffer (size_t c)
 272   : _capacity (c)
 273 {
 274         _events = static_cast<VstEvents*> (malloc (sizeof (VstEvents) + _capacity * sizeof (VstEvent *)));
 275         _midi_events = static_cast<VstMidiEvent*> (malloc (sizeof (VstMidiEvent) * _capacity));
 276
 277         if (_events == 0 || _midi_events == 0) {
 278                 free (_events);
 279                 free (_midi_events);
 280                 throw failed_constructor ();
 281         }
 282
 283         _events->numEvents = 0;
 284         _events->reserved = 0;
 285 }
 286
 287 BufferSet::VSTBuffer::~VSTBuffer ()
 288 {
 289         free (_events);
 290         free (_midi_events);
 291 }
 292
 293 void
 294 BufferSet::VSTBuffer::clear ()
 295 {
 296         _events->numEvents = 0;
 297 }
 298
 299 void
 300 BufferSet::VSTBuffer::push_back (Evoral::MIDIEvent<nframes_t> const & ev)
 301 {
 302         if (ev.size() > 3) {
 303                 /* XXX: this will silently drop MIDI messages longer than 3 bytes, so
 304                    they won't be passed to VST plugins or VSTis
 305                 */
 306                 return;
 307         }
 308         int const n = _events->numEvents;
 309         assert (n < (int) _capacity);
 310
 311         _events->events[n] = reinterpret_cast<VstEvent*> (_midi_events + n);
 312         VstMidiEvent* v = reinterpret_cast<VstMidiEvent*> (_events->events[n]);
 313
 314         v->type = kVstMidiType;
 315         v->byteSize = sizeof (VstMidiEvent);
 316         v->deltaFrames = ev.time ();
 317
 318         v->flags = 0;
 319         v->detune = 0;
 320         v->noteLength = 0;
 321         v->noteOffset = 0;
 322         v->reserved1 = 0;
 323         v->reserved2 = 0;
 324         v->noteOffVelocity = 0;
 325         memcpy (v->midiData, ev.buffer(), ev.size());
 326         v->midiData[3] = 0;
 327
 328         _events->numEvents++;
 329 }
 330
 331 #endif /* VST_SUPPORT */
 332
 333 void
 334 BufferSet::read_from (const BufferSet& in, nframes_t nframes)
 335 {
 336         assert(available() >= in.count());
 337
 338         // Copy all buffers 1:1
 339         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 340                 BufferSet::iterator o = begin(*t);
 341                 for (BufferSet::const_iterator i = in.begin(*t); i != in.end(*t); ++i, ++o) {
 342                         o->read_from (*i, nframes);
 343                 }
 344         }
 345
 346         set_count(in.count());
 347 }
 348
 349 void
 350 BufferSet::merge_from (const BufferSet& in, nframes_t nframes)
 351 {
 352         /* merge all input buffers into out existing buffers.
 353
 354            NOTE: if "in" contains more buffers than this set,
 355            we will drop the extra buffers.
 356
 357         */
 358
 359         for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 360                 BufferSet::iterator o = begin(*t);
 361                 for (BufferSet::const_iterator i = in.begin(*t); i != in.end(*t) && o != end (*t); ++i, ++o) {
 362                         o->merge_from (*i, nframes);
 363                 }
 364         }
 365 }
 366
 367 void
 368 BufferSet::silence (nframes_t nframes, nframes_t offset)
 369 {
 370         for (std::vector<BufferVec>::iterator i = _buffers.begin(); i != _buffers.end(); ++i) {
 371                 for (BufferVec::iterator b = i->begin(); b != i->end(); ++b) {
 372                         (*b)->silence (nframes, offset);
 373                 }
 374         }
 375 }
 376
 377 void
 378 BufferSet::is_silent (bool yn)
 379 {
 380         for (std::vector<BufferVec>::iterator i = _buffers.begin(); i != _buffers.end(); ++i) {
 381                 for (BufferVec::iterator b = i->begin(); b != i->end(); ++b) {
 382                         (*b)->is_silent (yn);
 383                 }
 384         }
 385
 386 }
 387
 388 } // namespace ARDOUR
 389