libs/ardour/ardour/buffer_set.h

   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 #ifndef __ardour_buffer_set_h__
  20 #define __ardour_buffer_set_h__
  21
  22 #ifdef WAF_BUILD
  23 #include "libardour-config.h"
  24 #endif
  25
  26 #include <cassert>
  27 #include <vector>
  28 #include "ardour/chan_count.h"
  29 #include "ardour/data_type.h"
  30 #include "ardour/types.h"
  31
  32 #if defined VST_SUPPORT || defined LXVST_SUPPORT
  33 #include "evoral/MIDIEvent.hpp"
  34 struct _VstEvents;
  35 typedef struct _VstEvents VstEvents;
  36 struct _VstMidiEvent;
  37 typedef struct _VstMidiEvent VstMidiEvent;
  38 #endif
  39
  40 #ifdef LV2_SUPPORT
  41 typedef struct LV2_Evbuf_Impl LV2_Evbuf;
  42 #endif
  43
  44 namespace ARDOUR {
  45
  46 class Buffer;
  47 class AudioBuffer;
  48 class MidiBuffer;
  49 class PortSet;
  50
  51 /** A set of buffers of various types.
  52  *
  53  * These are mainly accessed from Session and passed around as scratch buffers
  54  * (eg as parameters to run() methods) to do in-place signal processing.
  55  *
  56  * There are two types of counts associated with a BufferSet - available,
  57  * and the 'use count'.  Available is the actual number of allocated buffers
  58  * (and so is the maximum acceptable value for the use counts).
  59  *
  60  * The use counts are how things determine the form of their input and inform
  61  * others the form of their output (eg what they did to the BufferSet).
  62  * Setting the use counts is realtime safe.
  63  */
  64 class BufferSet
  65 {
  66 public:
  67         BufferSet();
  68         ~BufferSet();
  69
  70         void clear();
  71
  72         void attach_buffers (PortSet& ports);
  73         void get_backend_port_addresses (PortSet &, framecnt_t);
  74
  75         /* the capacity here is a size_t and has a different interpretation depending
  76            on the DataType of the buffers. for audio, its a frame count. for MIDI
  77            its a byte count.
  78         */
  79
  80         void ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity);
  81         void ensure_buffers(const ChanCount& chns, size_t buffer_capacity);
  82
  83         const ChanCount& available() const { return _available; }
  84         ChanCount&       available()       { return _available; }
  85
  86         const ChanCount& count() const { return _count; }
  87         ChanCount&       count()       { return _count; }
  88
  89         void silence (framecnt_t nframes, framecnt_t offset);
  90         bool is_mirror() const { return _is_mirror; }
  91
  92         void set_count(const ChanCount& count) { assert(count <= _available); _count = count; }
  93
  94         size_t buffer_capacity(DataType type) const;
  95
  96         Buffer&       get(DataType type, size_t i);
  97         const Buffer& get(DataType type, size_t i) const;
  98
  99         AudioBuffer& get_audio(size_t i) {
 100                 return (AudioBuffer&)get(DataType::AUDIO, i);
 101         }
 102         const AudioBuffer& get_audio(size_t i) const {
 103                 return (const AudioBuffer&)get(DataType::AUDIO, i);
 104         }
 105
 106         MidiBuffer& get_midi(size_t i) {
 107                 return (MidiBuffer&)get(DataType::MIDI, i);
 108         }
 109         const MidiBuffer& get_midi(size_t i) const {
 110                 return (const MidiBuffer&)get(DataType::MIDI, i);
 111         }
 112
 113 #ifdef LV2_SUPPORT
 114         /** Get a MIDI buffer translated into an LV2 MIDI buffer for use with
 115          * plugins.  The index here corresponds directly to MIDI buffer numbers
 116          * (i.e. the index passed to get_midi), translation back and forth will
 117          * happen as needed.  If old_api is true, the returned buffer will be in
 118          * old event format.  Otherwise it will be in new atom sequence format.
 119          */
 120         LV2_Evbuf* get_lv2_midi(bool input, size_t i, bool old_api);
 121
 122         /** ensure minimum size of LV2 Atom port buffer */
 123         void ensure_lv2_bufsize(bool input, size_t i, size_t buffer_capacity);
 124
 125         /** Flush modified LV2 event output buffers back to Ardour buffers */
 126         void flush_lv2_midi(bool input, size_t i);
 127
 128         /** Forward plugin MIDI output to to Ardour buffers */
 129         void forward_lv2_midi(LV2_Evbuf*, size_t, bool purge_ardour_buffer = true);
 130 #endif
 131
 132 #if defined VST_SUPPORT || defined LXVST_SUPPORT
 133         VstEvents* get_vst_midi (size_t);
 134 #endif
 135
 136         void read_from(const BufferSet& in, framecnt_t nframes);
 137         void read_from(const BufferSet& in, framecnt_t nframes, DataType);
 138         void merge_from(const BufferSet& in, framecnt_t nframes);
 139
 140         template <typename BS, typename B>
 141         class iterator_base {
 142         public:
 143                 B& operator*()  { return (B&)_set.get(_type, _index); }
 144                 B* operator->() { return &(B&)_set.get(_type, _index); }
 145                 iterator_base<BS,B>& operator++() { ++_index; return *this; } // yes, prefix only
 146                 bool operator==(const iterator_base<BS,B>& other) { return (_index == other._index); }
 147                 bool operator!=(const iterator_base<BS,B>& other) { return (_index != other._index); }
 148                 iterator_base<BS,B> operator=(const iterator_base<BS,B>& other) {
 149                         _set = other._set; _type = other._type; _index = other._index; return *this;
 150                 }
 151
 152         private:
 153                 friend class BufferSet;
 154
 155                 iterator_base(BS& list, DataType type, size_t index)
 156                         : _set(list), _type(type), _index(index) {}
 157
 158                 BS&      _set;
 159                 DataType _type;
 160                 size_t   _index;
 161         };
 162
 163         typedef iterator_base<BufferSet, Buffer> iterator;
 164         iterator begin(DataType type) { return iterator(*this, type, 0); }
 165         iterator end(DataType type)   { return iterator(*this, type, _count.get(type)); }
 166
 167         typedef iterator_base<const BufferSet, const Buffer> const_iterator;
 168         const_iterator begin(DataType type) const { return const_iterator(*this, type, 0); }
 169         const_iterator end(DataType type)   const { return const_iterator(*this, type, _count.get(type)); }
 170
 171         typedef iterator_base<BufferSet, AudioBuffer> audio_iterator;
 172         audio_iterator audio_begin() { return audio_iterator(*this, DataType::AUDIO, 0); }
 173         audio_iterator audio_end()   { return audio_iterator(*this, DataType::AUDIO, _count.n_audio()); }
 174
 175         typedef iterator_base<BufferSet, MidiBuffer> midi_iterator;
 176         midi_iterator midi_begin() { return midi_iterator(*this, DataType::MIDI, 0); }
 177         midi_iterator midi_end()   { return midi_iterator(*this, DataType::MIDI, _count.n_midi()); }
 178
 179 private:
 180         typedef std::vector<Buffer*> BufferVec;
 181
 182         /// Vector of vectors, indexed by DataType
 183         std::vector<BufferVec> _buffers;
 184
 185 #ifdef LV2_SUPPORT
 186         /// LV2 MIDI buffers (for conversion to/from MIDI buffers)
 187         typedef std::vector< std::pair<bool, LV2_Evbuf*> > LV2Buffers;
 188         LV2Buffers _lv2_buffers;
 189 #endif
 190
 191 #if defined VST_SUPPORT || defined LXVST_SUPPORT
 192         class VSTBuffer {
 193         public:
 194                 VSTBuffer (size_t);
 195                 ~VSTBuffer ();
 196
 197                 void clear ();
 198                 void push_back (Evoral::MIDIEvent<framepos_t> const &);
 199                 VstEvents* events () const {
 200                         return _events;
 201                 }
 202
 203         private:
 204                 /* prevent copy construction */
 205                 VSTBuffer (VSTBuffer const &);
 206
 207                 VstEvents* _events; /// the parent VSTEvents struct
 208                 VstMidiEvent* _midi_events; ///< storage area for VSTMidiEvents
 209                 size_t _capacity;
 210         };
 211
 212         typedef std::vector<VSTBuffer*> VSTBuffers;
 213         VSTBuffers _vst_buffers;
 214 #endif
 215
 216         /// Use counts (there may be more actual buffers than this)
 217         ChanCount _count;
 218
 219         /// Available counts (number of buffers actually allocated)
 220         ChanCount _available;
 221
 222         /// False if we 'own' the contained buffers, if true we mirror a PortSet)
 223         bool _is_mirror;
 224 };
 225
 226
 227 } // namespace ARDOUR
 228
 229 #endif // __ardour_buffer_set_h__