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);
  80         void silence (nframes_t nframes, nframes_t offset);
  81         bool is_mirror() const { return _is_mirror; }
  82
  83         void set_count(const ChanCount& count) { assert(count <= _available); _count = count; }
  84
  85         size_t buffer_capacity(DataType type) const;
  86
  87         Buffer&       get(DataType type, size_t i);
  88         const Buffer& get(DataType type, size_t i) const;
  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(const BufferSet& in, nframes_t nframes);
 109         void merge_from(const BufferSet& in, nframes_t nframes);
 110
 111         template <typename BS, typename B>
 112         class iterator_base {
 113         public:
 114                 B& operator*()  { return (B&)_set.get(_type, _index); }
 115                 B* operator->() { return &(B&)_set.get(_type, _index); }
 116                 iterator_base<BS,B>& operator++() { ++_index; return *this; } // yes, prefix only
 117                 bool operator==(const iterator_base<BS,B>& other) { return (_index == other._index); }
 118                 bool operator!=(const iterator_base<BS,B>& other) { return (_index != other._index); }
 119                 iterator_base<BS,B> operator=(const iterator_base<BS,B>& other) {
 120                         _set = other._set; _type = other._type; _index = other._index; return *this;
 121                 }
 122
 123         private:
 124                 friend class BufferSet;
 125
 126                 iterator_base(BS& list, DataType type, size_t index)
 127                         : _set(list), _type(type), _index(index) {}
 128
 129                 BS&      _set;
 130                 DataType _type;
 131                 size_t   _index;
 132         };
 133
 134         typedef iterator_base<BufferSet, Buffer> iterator;
 135         iterator begin(DataType type) { return iterator(*this, type, 0); }
 136         iterator end(DataType type)   { return iterator(*this, type, _count.get(type)); }
 137
 138         typedef iterator_base<const BufferSet, const Buffer> const_iterator;
 139         const_iterator begin(DataType type) const { return const_iterator(*this, type, 0); }
 140         const_iterator end(DataType type)   const { return const_iterator(*this, type, _count.get(type)); }
 141
 142         typedef iterator_base<BufferSet, AudioBuffer> audio_iterator;
 143         audio_iterator audio_begin() { return audio_iterator(*this, DataType::AUDIO, 0); }
 144         audio_iterator audio_end()   { return audio_iterator(*this, DataType::AUDIO, _count.n_audio()); }
 145
 146         typedef iterator_base<BufferSet, MidiBuffer> midi_iterator;
 147         midi_iterator midi_begin() { return midi_iterator(*this, DataType::MIDI, 0); }
 148         midi_iterator midi_end()   { return midi_iterator(*this, DataType::MIDI, _count.n_midi()); }
 149
 150 private:
 151         typedef std::vector<Buffer*> BufferVec;
 152
 153         /// Vector of vectors, indexed by DataType
 154         std::vector<BufferVec> _buffers;
 155
 156 #ifdef HAVE_SLV2
 157         /// LV2 MIDI buffers (for conversion to/from MIDI buffers)
 158         typedef std::vector< std::pair<bool, LV2EventBuffer*> > LV2Buffers;
 159         LV2Buffers _lv2_buffers;
 160 #endif
 161
 162         /// Use counts (there may be more actual buffers than this)
 163         ChanCount _count;
 164
 165         /// Available counts (number of buffers actually allocated)
 166         ChanCount _available;
 167
 168         /// False if we 'own' the contained buffers, if true we mirror a PortSet)
 169         bool _is_mirror;
 170 };
 171
 172
 173 } // namespace ARDOUR
 174
 175 #endif // __ardour_buffer_set_h__