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.
19 #ifndef __ardour_buffer_set_h__
20 #define __ardour_buffer_set_h__
23 #include "libardour-config.h"
28 #include "ardour/chan_count.h"
29 #include "ardour/data_type.h"
30 #include "ardour/libardour_visibility.h"
31 #include "ardour/types.h"
33 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT || defined MACVST_SUPPORT
34 #include "evoral/Event.hpp"
36 typedef struct _VstEvents VstEvents;
38 typedef struct _VstMidiEvent VstMidiEvent;
42 typedef struct LV2_Evbuf_Impl LV2_Evbuf;
52 /** A set of buffers of various types.
54 * These are mainly accessed from Session and passed around as scratch buffers
55 * (eg as parameters to run() methods) to do in-place signal processing.
57 * There are two types of counts associated with a BufferSet - available,
58 * and the 'use count'. Available is the actual number of allocated buffers
59 * (and so is the maximum acceptable value for the use counts).
61 * The use counts are how things determine the form of their input and inform
62 * others the form of their output (eg what they did to the BufferSet).
63 * Setting the use counts is realtime safe.
65 class LIBARDOUR_API BufferSet
73 void attach_buffers (PortSet& ports);
74 void get_backend_port_addresses (PortSet &, samplecnt_t);
76 /* the capacity here is a size_t and has a different interpretation depending
77 on the DataType of the buffers. for audio, its a sample count. for MIDI
81 void ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity);
82 void ensure_buffers(const ChanCount& chns, size_t buffer_capacity);
84 const ChanCount& available() const { return _available; }
85 ChanCount& available() { return _available; }
87 const ChanCount& count() const { return _count; }
88 ChanCount& count() { return _count; }
90 void silence (samplecnt_t nframes, samplecnt_t offset);
91 bool is_mirror() const { return _is_mirror; }
93 void set_count(const ChanCount& count) { assert(count <= _available); _count = count; }
95 size_t buffer_capacity(DataType type) const;
97 Buffer& get(DataType type, size_t i);
98 const Buffer& get(DataType type, size_t i) const;
100 AudioBuffer& get_audio(size_t i) {
101 return (AudioBuffer&)get(DataType::AUDIO, i);
103 const AudioBuffer& get_audio(size_t i) const {
104 return (const AudioBuffer&)get(DataType::AUDIO, i);
107 MidiBuffer& get_midi(size_t i) {
108 return (MidiBuffer&)get(DataType::MIDI, i);
110 const MidiBuffer& get_midi(size_t i) const {
111 return (const MidiBuffer&)get(DataType::MIDI, i);
115 /** Get a MIDI buffer translated into an LV2 MIDI buffer for use with
116 * plugins. The index here corresponds directly to MIDI buffer numbers
117 * (i.e. the index passed to get_midi), translation back and forth will
118 * happen as needed. If old_api is true, the returned buffer will be in
119 * old event format. Otherwise it will be in new atom sequence format.
121 LV2_Evbuf* get_lv2_midi(bool input, size_t i, bool old_api);
123 /** ensure minimum size of LV2 Atom port buffer */
124 void ensure_lv2_bufsize(bool input, size_t i, size_t buffer_capacity);
126 /** Flush modified LV2 event output buffers back to Ardour buffers */
127 void flush_lv2_midi(bool input, size_t i);
129 /** Forward plugin MIDI output to to Ardour buffers */
130 void forward_lv2_midi(LV2_Evbuf*, size_t, bool purge_ardour_buffer = true);
133 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT || defined MACVST_SUPPORT
134 VstEvents* get_vst_midi (size_t);
137 void read_from(const BufferSet& in, samplecnt_t nframes);
138 void read_from(const BufferSet& in, samplecnt_t nframes, DataType);
139 void merge_from(const BufferSet& in, samplecnt_t nframes);
141 template <typename BS, typename B>
142 class iterator_base {
144 B& operator*() { return (B&)_set.get(_type, _index); }
145 B* operator->() { return &(B&)_set.get(_type, _index); }
146 iterator_base<BS,B>& operator++() { ++_index; return *this; } // yes, prefix only
147 bool operator==(const iterator_base<BS,B>& other) { return (_index == other._index); }
148 bool operator!=(const iterator_base<BS,B>& other) { return (_index != other._index); }
149 iterator_base<BS,B> operator=(const iterator_base<BS,B>& other) {
150 _set = other._set; _type = other._type; _index = other._index; return *this;
154 friend class BufferSet;
156 iterator_base(BS& list, DataType type, size_t index)
157 : _set(list), _type(type), _index(index) {}
164 typedef iterator_base<BufferSet, Buffer> iterator;
165 iterator begin(DataType type) { return iterator(*this, type, 0); }
166 iterator end(DataType type) { return iterator(*this, type, _count.get(type)); }
168 typedef iterator_base<const BufferSet, const Buffer> const_iterator;
169 const_iterator begin(DataType type) const { return const_iterator(*this, type, 0); }
170 const_iterator end(DataType type) const { return const_iterator(*this, type, _count.get(type)); }
172 typedef iterator_base<BufferSet, AudioBuffer> audio_iterator;
173 audio_iterator audio_begin() { return audio_iterator(*this, DataType::AUDIO, 0); }
174 audio_iterator audio_end() { return audio_iterator(*this, DataType::AUDIO, _count.n_audio()); }
176 typedef iterator_base<BufferSet, MidiBuffer> midi_iterator;
177 midi_iterator midi_begin() { return midi_iterator(*this, DataType::MIDI, 0); }
178 midi_iterator midi_end() { return midi_iterator(*this, DataType::MIDI, _count.n_midi()); }
181 typedef std::vector<Buffer*> BufferVec;
183 /// Vector of vectors, indexed by DataType
184 std::vector<BufferVec> _buffers;
187 /// LV2 MIDI buffers (for conversion to/from MIDI buffers)
188 typedef std::vector< std::pair<bool, LV2_Evbuf*> > LV2Buffers;
189 LV2Buffers _lv2_buffers;
192 #if defined WINDOWS_VST_SUPPORT || defined LXVST_SUPPORT || defined MACVST_SUPPORT
199 void push_back (Evoral::Event<samplepos_t> const &);
200 VstEvents* events () const {
205 /* prevent copy construction */
206 VSTBuffer (VSTBuffer const &);
208 VstEvents* _events; /// the parent VSTEvents struct
209 VstMidiEvent* _midi_events; ///< storage area for VSTMidiEvents
213 typedef std::vector<VSTBuffer*> VSTBuffers;
214 VSTBuffers _vst_buffers;
217 /// Use counts (there may be more actual buffers than this)
220 /// Available counts (number of buffers actually allocated)
221 ChanCount _available;
223 /// False if we 'own' the contained buffers, if true we mirror a PortSet)
228 } // namespace ARDOUR
230 #endif // __ardour_buffer_set_h__