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 namespace ARDOUR {
  33
  34 class Buffer;
  35 class AudioBuffer;
  36 class MidiBuffer;
  37 class PortSet;
  38 #ifdef HAVE_SLV2
  39 class LV2EventBuffer;
  40 #endif
  41
  42 /** A set of buffers of various types.
  43  *
  44  * These are mainly accessed from Session and passed around as scratch buffers
  45  * (eg as parameters to run() methods) to do in-place signal processing.
  46  *
  47  * There are two types of counts associated with a BufferSet - available,
  48  * and the 'use count'.  Available is the actual number of allocated buffers
  49  * (and so is the maximum acceptable value for the use counts).
  50  *
  51  * The use counts are how things determine the form of their input and inform
  52  * others the form of their output (eg what they did to the BufferSet).
  53  * Setting the use counts is realtime safe.
  54  */
  55 class BufferSet
  56 {
  57 public:
  58         BufferSet();
  59         ~BufferSet();
  60
  61         void clear();
  62
  63         void attach_buffers(PortSet& ports, nframes_t nframes, nframes_t offset = 0);
  64
  65         /* the capacity here is a size_t and has a different interpretation depending
  66            on the DataType of the buffers. for audio, its a frame count. for MIDI
  67            its a byte count.
  68         */
  69
  70         void ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity);
  71         void ensure_buffers(const ChanCount& chns, size_t buffer_capacity);
  72
  73         const ChanCount& available() const { return _available; }
  74         ChanCount&       available()       { return _available; }
  75
  76         const ChanCount& count() const { return _count; }
  77         ChanCount&       count()       { return _count; }
  78
  79         void is_silent(bool yn) { _is_silent = yn; }
  80         bool is_silent() const  { return _is_silent; }
  81         void silence (nframes_t nframes, nframes_t offset);
  82         bool is_mirror() const { return _is_mirror; }
  83
  84         void set_count(const ChanCount& count) { assert(count <= _available); _count = count; }
  85
  86         size_t buffer_capacity(DataType type) const;
  87
  88         Buffer& get(DataType type, size_t i);
  89
  90         AudioBuffer& get_audio(size_t i) {
  91                 return (AudioBuffer&)get(DataType::AUDIO, i);
  92         }
  93
  94         MidiBuffer& get_midi(size_t i) {
  95                 return (MidiBuffer&)get(DataType::MIDI, i);
  96         }
  97
  98 #ifdef HAVE_SLV2
  99         /** Get a MIDI buffer translated into an LV2 MIDI buffer for use with plugins.
 100          * The index here corresponds directly to MIDI buffer numbers (i.e. the index
 101          * passed to get_midi), translation back and forth will happen as needed */
 102         LV2EventBuffer& get_lv2_midi(bool input, size_t i);
 103
 104         /** Flush modified LV2 event output buffers back to Ardour buffers */
 105         void flush_lv2_midi(bool input, size_t i);
 106 #endif
 107
 108         void read_from(BufferSet& in, nframes_t nframes);
 109         void merge_from(BufferSet& in, nframes_t nframes);
 110
 111         // ITERATORS
 112         // FIXME: possible to combine these?  templates?
 113
 114         class audio_iterator {
 115         public:
 116                 AudioBuffer& operator*()  { return _set.get_audio(_index); }
 117                 AudioBuffer* operator->() { return &_set.get_audio(_index); }
 118                 audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
 119                 bool operator==(const audio_iterator& other) { return (_index == other._index); }
 120                 bool operator!=(const audio_iterator& other) { return (_index != other._index); }
 121
 122         private:
 123                 friend class BufferSet;
 124
 125                 audio_iterator(BufferSet& list, size_t index) : _set(list), _index(index) {}
 126
 127                 BufferSet& _set;
 128                 size_t    _index;
 129         };
 130
 131         audio_iterator audio_begin() { return audio_iterator(*this, 0); }
 132         audio_iterator audio_end()   { return audio_iterator(*this, _count.n_audio()); }
 133
 134         class midi_iterator {
 135         public:
 136                 MidiBuffer& operator*()  { return _set.get_midi(_index); }
 137                 MidiBuffer* operator->() { return &_set.get_midi(_index); }
 138                 midi_iterator& operator++() { ++_index; return *this; } // yes, prefix only
 139                 bool operator==(const midi_iterator& other) { return (_index == other._index); }
 140                 bool operator!=(const midi_iterator& other) { return (_index != other._index); }
 141
 142         private:
 143                 friend class BufferSet;
 144
 145                 midi_iterator(BufferSet& list, size_t index) : _set(list), _index(index) {}
 146
 147                 BufferSet& _set;
 148                 size_t    _index;
 149         };
 150
 151         midi_iterator midi_begin() { return midi_iterator(*this, 0); }
 152         midi_iterator midi_end()   { return midi_iterator(*this, _count.n_midi()); }
 153
 154         class iterator {
 155         public:
 156                 Buffer& operator*()  { return _set.get(_type, _index); }
 157                 Buffer* operator->() { return &_set.get(_type, _index); }
 158                 iterator& operator++() { ++_index; return *this; } // yes, prefix only
 159                 bool operator==(const iterator& other) { return (_index == other._index); }
 160                 bool operator!=(const iterator& other) { return (_index != other._index); }
 161                 iterator operator=(const iterator& other) {
 162                         _set = other._set; _type = other._type; _index = other._index; return *this;
 163                 }
 164
 165         private:
 166                 friend class BufferSet;
 167
 168                 iterator(BufferSet& list, DataType type, size_t index)
 169                         : _set(list), _type(type), _index(index) {}
 170
 171                 BufferSet& _set;
 172                 DataType   _type;
 173                 size_t     _index;
 174         };
 175
 176         iterator begin(DataType type) { return iterator(*this, type, 0); }
 177         iterator end(DataType type)   { return iterator(*this, type, _count.get(type)); }
 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 HAVE_SLV2
 186         /// LV2 MIDI buffers (for conversion to/from MIDI buffers)
 187         typedef std::vector< std::pair<bool, LV2EventBuffer*> > LV2Buffers;
 188         LV2Buffers _lv2_buffers;
 189 #endif
 190
 191         /// Use counts (there may be more actual buffers than this)
 192         ChanCount _count;
 193
 194         /// Available counts (number of buffers actually allocated)
 195         ChanCount _available;
 196
 197         /// False if we 'own' the contained buffers, if true we mirror a PortSet)
 198         bool _is_mirror;
 199
 200         /// Whether the buffer set should be considered silent
 201         bool _is_silent;
 202 };
 203
 204
 205 } // namespace ARDOUR
 206
 207 #endif // __ardour_buffer_set_h__