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_jack_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 set_is_silent(bool yn);
  90         void silence (framecnt_t nframes, framecnt_t offset);
  91         bool is_mirror() const { return _is_mirror; }
  92
  93         void set_count(const ChanCount& count) { assert(count <= _available); _count = count; }
  94
  95         size_t buffer_capacity(DataType type) const;
  96
  97         Buffer&       get(DataType type, size_t i);
  98         const Buffer& get(DataType type, size_t i) const;
  99
 100         AudioBuffer& get_audio(size_t i) {
 101                 return (AudioBuffer&)get(DataType::AUDIO, i);
 102         }
 103         const AudioBuffer& get_audio(size_t i) const {
 104                 return (const AudioBuffer&)get(DataType::AUDIO, i);
 105         }
 106
 107         MidiBuffer& get_midi(size_t i) {
 108                 return (MidiBuffer&)get(DataType::MIDI, i);
 109         }
 110         const MidiBuffer& get_midi(size_t i) const {
 111                 return (const MidiBuffer&)get(DataType::MIDI, i);
 112         }
 113
 114 #ifdef LV2_SUPPORT
 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.
 120          */
 121         LV2_Evbuf* get_lv2_midi(bool input, size_t i, bool old_api);
 122
 123         /** Flush modified LV2 event output buffers back to Ardour buffers */
 124         void flush_lv2_midi(bool input, size_t i);
 125 #endif
 126
 127 #if defined VST_SUPPORT || defined LXVST_SUPPORT
 128         VstEvents* get_vst_midi (size_t);
 129 #endif
 130
 131         void read_from(const BufferSet& in, framecnt_t nframes);
 132         void read_from(const BufferSet& in, framecnt_t nframes, DataType);
 133         void merge_from(const BufferSet& in, framecnt_t nframes);
 134
 135         template <typename BS, typename B>
 136         class iterator_base {
 137         public:
 138                 B& operator*()  { return (B&)_set.get(_type, _index); }
 139                 B* operator->() { return &(B&)_set.get(_type, _index); }
 140                 iterator_base<BS,B>& operator++() { ++_index; return *this; } // yes, prefix only
 141                 bool operator==(const iterator_base<BS,B>& other) { return (_index == other._index); }
 142                 bool operator!=(const iterator_base<BS,B>& other) { return (_index != other._index); }
 143                 iterator_base<BS,B> operator=(const iterator_base<BS,B>& other) {
 144                         _set = other._set; _type = other._type; _index = other._index; return *this;
 145                 }
 146
 147         private:
 148                 friend class BufferSet;
 149
 150                 iterator_base(BS& list, DataType type, size_t index)
 151                         : _set(list), _type(type), _index(index) {}
 152
 153                 BS&      _set;
 154                 DataType _type;
 155                 size_t   _index;
 156         };
 157
 158         typedef iterator_base<BufferSet, Buffer> iterator;
 159         iterator begin(DataType type) { return iterator(*this, type, 0); }
 160         iterator end(DataType type)   { return iterator(*this, type, _count.get(type)); }
 161
 162         typedef iterator_base<const BufferSet, const Buffer> const_iterator;
 163         const_iterator begin(DataType type) const { return const_iterator(*this, type, 0); }
 164         const_iterator end(DataType type)   const { return const_iterator(*this, type, _count.get(type)); }
 165
 166         typedef iterator_base<BufferSet, AudioBuffer> audio_iterator;
 167         audio_iterator audio_begin() { return audio_iterator(*this, DataType::AUDIO, 0); }
 168         audio_iterator audio_end()   { return audio_iterator(*this, DataType::AUDIO, _count.n_audio()); }
 169
 170         typedef iterator_base<BufferSet, MidiBuffer> midi_iterator;
 171         midi_iterator midi_begin() { return midi_iterator(*this, DataType::MIDI, 0); }
 172         midi_iterator midi_end()   { return midi_iterator(*this, DataType::MIDI, _count.n_midi()); }
 173
 174 private:
 175         typedef std::vector<Buffer*> BufferVec;
 176
 177         /// Vector of vectors, indexed by DataType
 178         std::vector<BufferVec> _buffers;
 179
 180 #ifdef LV2_SUPPORT
 181         /// LV2 MIDI buffers (for conversion to/from MIDI buffers)
 182         typedef std::vector< std::pair<bool, LV2_Evbuf*> > LV2Buffers;
 183         LV2Buffers _lv2_buffers;
 184 #endif
 185
 186 #if defined VST_SUPPORT || defined LXVST_SUPPORT
 187         class VSTBuffer {
 188         public:
 189                 VSTBuffer (size_t);
 190                 ~VSTBuffer ();
 191
 192                 void clear ();
 193                 void push_back (Evoral::MIDIEvent<framepos_t> const &);
 194                 VstEvents* events () const {
 195                         return _events;
 196                 }
 197
 198         private:
 199                 /* prevent copy construction */
 200                 VSTBuffer (VSTBuffer const &);
 201
 202                 VstEvents* _events; /// the parent VSTEvents struct
 203                 VstMidiEvent* _midi_events; ///< storage area for VSTMidiEvents
 204                 size_t _capacity;
 205         };
 206
 207         typedef std::vector<VSTBuffer*> VSTBuffers;
 208         VSTBuffers _vst_buffers;
 209 #endif
 210
 211         /// Use counts (there may be more actual buffers than this)
 212         ChanCount _count;
 213
 214         /// Available counts (number of buffers actually allocated)
 215         ChanCount _available;
 216
 217         /// False if we 'own' the contained buffers, if true we mirror a PortSet)
 218         bool _is_mirror;
 219 };
 220
 221
 222 } // namespace ARDOUR
 223
 224 #endif // __ardour_buffer_set_h__