2 Copyright (C) 2006 Paul Davis
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)
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
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.
21 #include "libardour-config.h"
28 #include "pbd/compose.h"
29 #include "pbd/failed_constructor.h"
31 #include "ardour/buffer.h"
32 #include "ardour/buffer_set.h"
33 #include "ardour/debug.h"
34 #include "ardour/midi_buffer.h"
35 #include "ardour/port.h"
36 #include "ardour/port_set.h"
37 #include "ardour/uri_map.h"
39 #include "ardour/lv2_plugin.h"
40 #include "lv2_evbuf.h"
42 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT
43 #include "ardour/vestige/aeffectx.h"
48 /** Create a new, empty BufferSet */
49 BufferSet::BufferSet()
52 for (size_t i=0; i < DataType::num_types; ++i) {
53 _buffers.push_back(BufferVec());
60 BufferSet::~BufferSet()
65 /** Destroy all contained buffers.
71 for (std::vector<BufferVec>::iterator i = _buffers.begin(); i != _buffers.end(); ++i) {
72 for (BufferVec::iterator j = (*i).begin(); j != (*i).end(); ++j) {
82 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT
83 for (VSTBuffers::iterator i = _vst_buffers.begin(); i != _vst_buffers.end(); ++i) {
87 _vst_buffers.clear ();
91 for (LV2Buffers::iterator i = _lv2_buffers.begin(); i != _lv2_buffers.end(); ++i) {
94 _lv2_buffers.clear ();
99 /** Set up this BufferSet so that its data structures mirror a PortSet's buffers.
100 * This is quite expensive and not RT-safe, so it should not be called in a process context;
101 * get_backend_port_addresses() will fill in a structure set up by this method.
103 * XXX: this *is* called in a process context; I'm not sure quite what `should not' means above.
106 BufferSet::attach_buffers (PortSet& ports)
108 const ChanCount& count (ports.count());
112 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
113 _buffers.push_back (BufferVec());
114 BufferVec& v = _buffers[*t];
115 v.assign (count.n (*t), (Buffer*) 0);
118 _count = ports.count();
119 _available = ports.count();
125 /** Write the backend port addresses from a PortSet into our data structures. This
126 * call assumes that attach_buffers() has already been called for the same PortSet.
127 * Does not allocate, so RT-safe BUT you can only call Port::get_buffer() from
128 * the process() callback tree anyway, so this has to be called in RT context.
131 BufferSet::get_backend_port_addresses (PortSet& ports, framecnt_t nframes)
133 assert (_count == ports.count ());
134 assert (_available == ports.count ());
137 assert (_buffers.size() == DataType::num_types);
139 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
140 BufferVec& v = _buffers[*t];
142 assert (v.size() == ports.num_ports (*t));
145 for (PortSet::iterator p = ports.begin(*t); p != ports.end(*t); ++p) {
146 v[i] = &p->get_buffer (nframes);
152 /** Ensure that there are @a num_buffers buffers of type @a type available,
153 * each of size at least @a buffer_size
156 BufferSet::ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity)
158 assert(type != DataType::NIL);
159 assert(type < _buffers.size());
161 if (num_buffers == 0) {
165 // The vector of buffers of the type we care about
166 BufferVec& bufs = _buffers[type];
168 // If we're a mirror just make sure we're ok
170 assert(_count.get(type) >= num_buffers);
171 assert(bufs[0]->type() == type);
175 // If there's not enough or they're too small, just nuke the whole thing and
176 // rebuild it (so I'm lazy..)
177 if (bufs.size() < num_buffers
178 || (bufs.size() > 0 && bufs[0]->capacity() < buffer_capacity)) {
181 for (BufferVec::iterator i = bufs.begin(); i != bufs.end(); ++i) {
187 for (size_t i = 0; i < num_buffers; ++i) {
188 bufs.push_back(Buffer::create(type, buffer_capacity));
191 _available.set(type, num_buffers);
192 _count.set (type, num_buffers);
196 // Ensure enough low level MIDI format buffers are available for conversion
197 // in both directions (input & output, out-of-place)
198 if (type == DataType::MIDI && _lv2_buffers.size() < _buffers[type].size() * 2 + 1) {
199 while (_lv2_buffers.size() < _buffers[type].size() * 2) {
200 _lv2_buffers.push_back(
201 std::make_pair(false, lv2_evbuf_new(buffer_capacity,
203 URIMap::instance().urids.atom_Chunk,
204 URIMap::instance().urids.atom_Sequence)));
209 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT
210 // As above but for VST
211 if (type == DataType::MIDI) {
212 while (_vst_buffers.size() < _buffers[type].size()) {
213 _vst_buffers.push_back (new VSTBuffer (buffer_capacity));
219 assert(bufs[0]->type() == type);
220 assert(bufs.size() >= num_buffers);
221 assert(bufs.size() == _available.get(type));
222 assert(bufs[0]->capacity() >= buffer_capacity);
225 /** Ensure that the number of buffers of each type @a type matches @a chns
226 * and each buffer is of size at least @a buffer_capacity
229 BufferSet::ensure_buffers(const ChanCount& chns, size_t buffer_capacity)
231 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
232 ensure_buffers (*i, chns.get (*i), buffer_capacity);
236 /** Get the capacity (size) of the available buffers of the given type.
238 * All buffers of a certain type always have the same capacity.
241 BufferSet::buffer_capacity(DataType type) const
243 assert(_available.get(type) > 0);
244 return _buffers[type][0]->capacity();
248 BufferSet::get(DataType type, size_t i)
250 assert(i < _available.get(type));
251 return *_buffers[type][i];
255 BufferSet::get(DataType type, size_t i) const
257 assert(i < _available.get(type));
258 return *_buffers[type][i];
264 BufferSet::ensure_lv2_bufsize(bool input, size_t i, size_t buffer_capacity)
266 assert(count().get(DataType::MIDI) > i);
268 LV2Buffers::value_type b = _lv2_buffers.at(i * 2 + (input ? 0 : 1));
269 LV2_Evbuf* evbuf = b.second;
271 if (lv2_evbuf_get_capacity(evbuf) >= buffer_capacity) return;
273 lv2_evbuf_free(b.second);
274 _lv2_buffers.at(i * 2 + (input ? 0 : 1)) =
275 std::make_pair(false, lv2_evbuf_new(
278 URIMap::instance().urids.atom_Chunk,
279 URIMap::instance().urids.atom_Sequence));
283 BufferSet::get_lv2_midi(bool input, size_t i, bool old_api)
285 assert(count().get(DataType::MIDI) > i);
287 LV2Buffers::value_type b = _lv2_buffers.at(i * 2 + (input ? 0 : 1));
288 LV2_Evbuf* evbuf = b.second;
290 lv2_evbuf_set_type(evbuf, old_api ? LV2_EVBUF_EVENT : LV2_EVBUF_ATOM);
291 lv2_evbuf_reset(evbuf, input);
296 BufferSet::forward_lv2_midi(LV2_Evbuf* buf, size_t i, bool purge_ardour_buffer)
298 MidiBuffer& mbuf = get_midi(i);
299 if (purge_ardour_buffer) {
302 for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(buf);
303 lv2_evbuf_is_valid(i);
304 i = lv2_evbuf_next(i)) {
305 uint32_t frames, subframes, type, size;
307 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
308 if (type == URIMap::instance().urids.midi_MidiEvent) {
309 mbuf.push_back(frames, size, data);
315 BufferSet::flush_lv2_midi(bool input, size_t i)
317 MidiBuffer& mbuf = get_midi(i);
318 LV2Buffers::value_type b = _lv2_buffers.at(i * 2 + (input ? 0 : 1));
319 LV2_Evbuf* evbuf = b.second;
322 for (LV2_Evbuf_Iterator i = lv2_evbuf_begin(evbuf);
323 lv2_evbuf_is_valid(i);
324 i = lv2_evbuf_next(i)) {
330 lv2_evbuf_get(i, &frames, &subframes, &type, &size, &data);
332 DEBUG_TRACE (PBD::DEBUG::LV2, string_compose ("(FLUSH) MIDI event of size %1\n", size));
333 for (uint16_t x = 0; x < size; ++x) {
334 DEBUG_TRACE (PBD::DEBUG::LV2, string_compose ("\tByte[%1] = %2\n", x, (int) data[x]));
337 if (type == URIMap::instance().urids.midi_MidiEvent) {
338 // TODO: Make Ardour event buffers generic so plugins can communicate
339 mbuf.push_back(frames, size, data);
344 #endif /* LV2_SUPPORT */
346 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT
349 BufferSet::get_vst_midi (size_t b)
351 MidiBuffer& m = get_midi (b);
352 VSTBuffer* vst = _vst_buffers[b];
356 for (MidiBuffer::iterator i = m.begin(); i != m.end(); ++i) {
360 return vst->events();
363 BufferSet::VSTBuffer::VSTBuffer (size_t c)
366 _events = static_cast<VstEvents*> (malloc (sizeof (VstEvents) + _capacity * sizeof (VstEvent *)));
367 _midi_events = static_cast<VstMidiEvent*> (malloc (sizeof (VstMidiEvent) * _capacity));
369 if (_events == 0 || _midi_events == 0) {
372 throw failed_constructor ();
375 _events->numEvents = 0;
376 _events->reserved = 0;
379 BufferSet::VSTBuffer::~VSTBuffer ()
386 BufferSet::VSTBuffer::clear ()
388 _events->numEvents = 0;
392 BufferSet::VSTBuffer::push_back (Evoral::MIDIEvent<framepos_t> const & ev)
395 /* XXX: this will silently drop MIDI messages longer than 3 bytes, so
396 they won't be passed to VST plugins or VSTis
400 int const n = _events->numEvents;
401 assert (n < (int) _capacity);
403 _events->events[n] = reinterpret_cast<VstEvent*> (_midi_events + n);
404 VstMidiEvent* v = reinterpret_cast<VstMidiEvent*> (_events->events[n]);
406 v->type = kVstMidiType;
407 v->byteSize = sizeof (VstMidiEvent);
408 v->deltaFrames = ev.time ();
416 v->noteOffVelocity = 0;
417 memcpy (v->midiData, ev.buffer(), ev.size());
420 _events->numEvents++;
423 #endif /* WINDOWS_VST_SUPPORT */
425 /** Copy buffers of one type from `in' to this BufferSet */
427 BufferSet::read_from (const BufferSet& in, framecnt_t nframes, DataType type)
429 assert (available().get (type) >= in.count().get (type));
431 BufferSet::iterator o = begin (type);
432 for (BufferSet::const_iterator i = in.begin (type); i != in.end (type); ++i, ++o) {
433 o->read_from (*i, nframes);
436 _count.set (type, in.count().get (type));
439 /** Copy buffers of all types from `in' to this BufferSet */
441 BufferSet::read_from (const BufferSet& in, framecnt_t nframes)
443 assert(available() >= in.count());
445 // Copy all buffers 1:1
446 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
447 read_from (in, nframes, *t);
452 BufferSet::merge_from (const BufferSet& in, framecnt_t nframes)
454 /* merge all input buffers into out existing buffers.
456 NOTE: if "in" contains more buffers than this set,
457 we will drop the extra buffers.
461 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
462 BufferSet::iterator o = begin(*t);
463 for (BufferSet::const_iterator i = in.begin(*t); i != in.end(*t) && o != end (*t); ++i, ++o) {
464 o->merge_from (*i, nframes);
470 BufferSet::silence (framecnt_t nframes, framecnt_t offset)
472 for (std::vector<BufferVec>::iterator i = _buffers.begin(); i != _buffers.end(); ++i) {
473 for (BufferVec::iterator b = i->begin(); b != i->end(); ++b) {
474 (*b)->silence (nframes, offset);
479 } // namespace ARDOUR