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__
24 #include <ardour/chan_count.h>
25 #include <ardour/data_type.h>
26 #include <ardour/types.h>
36 /** A set of buffers of various types.
38 * These are mainly accessed from Session and passed around as scratch buffers
39 * (eg as parameters to run() methods) to do in-place signal processing.
41 * There are two types of counts associated with a BufferSet - available,
42 * and the 'use count'. Available is the actual number of allocated buffers
43 * (and so is the maximum acceptable value for the use counts).
45 * The use counts are how things determine the form of their input and inform
46 * others the form of their output (eg what they did to the BufferSet).
47 * Setting the use counts is realtime safe.
57 void attach_buffers(PortSet& ports, nframes_t nframes, nframes_t offset);
59 void ensure_buffers(const ChanCount& count, size_t buffer_capacity);
60 void ensure_buffers(DataType type, size_t num_buffers, size_t buffer_capacity);
62 const ChanCount& available() const { return _available; }
63 ChanCount& available() { return _available; }
65 const ChanCount& count() const { return _count; }
66 ChanCount& count() { return _count; }
68 void set_count(const ChanCount& count) { _count = count; }
70 size_t buffer_capacity(DataType type) const;
72 Buffer& get(DataType type, size_t i)
74 assert(i <= _count.get(type));
75 return *_buffers[type][i];
78 AudioBuffer& get_audio(size_t i)
80 return (AudioBuffer&)get(DataType::AUDIO, i);
83 MidiBuffer& get_midi(size_t i)
85 return (MidiBuffer&)get(DataType::MIDI, i);
88 void read_from(BufferSet& in, jack_nframes_t nframes, jack_nframes_t offset=0);
92 // FIXME: this is a filthy copy-and-paste mess
93 // FIXME: litter these with assertions
95 class audio_iterator {
98 AudioBuffer& operator*() { return _set.get_audio(_index); }
99 AudioBuffer* operator->() { return &_set.get_audio(_index); }
100 audio_iterator& operator++() { ++_index; return *this; } // yes, prefix only
101 bool operator==(const audio_iterator& other) { return (_index == other._index); }
102 bool operator!=(const audio_iterator& other) { return (_index != other._index); }
105 friend class BufferSet;
107 audio_iterator(BufferSet& list, size_t index) : _set(list), _index(index) {}
113 audio_iterator audio_begin() { return audio_iterator(*this, 0); }
114 audio_iterator audio_end() { return audio_iterator(*this, _count.n_audio()); }
119 Buffer& operator*() { return _set.get(_type, _index); }
120 Buffer* operator->() { return &_set.get(_type, _index); }
121 iterator& operator++() { ++_index; return *this; } // yes, prefix only
122 bool operator==(const iterator& other) { return (_index == other._index); }
123 bool operator!=(const iterator& other) { return (_index != other._index); }
124 iterator operator=(const iterator& other) { _set = other._set; _type = other._type; _index = other._index; return *this; }
127 friend class BufferSet;
129 iterator(BufferSet& list, DataType type, size_t index)
130 : _set(list), _type(type), _index(index) {}
137 iterator begin(DataType type) { return iterator(*this, type, 0); }
138 iterator end(DataType type) { return iterator(*this, type, _count.get(type)); }
142 typedef std::vector<Buffer*> BufferVec;
144 /// Vector of vectors, indexed by DataType
145 std::vector<BufferVec> _buffers;
147 /// Use counts (there may be more actual buffers than this)
150 /// Available counts (number of buffers actually allocated)
151 ChanCount _available;
153 /// Whether we (don't) 'own' the contained buffers (otherwise we mirror a PortSet)
158 } // namespace ARDOUR
160 #endif // __ardour_buffer_set_h__