libs/ardour/ardour/buffer.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_h__
  20 #define __ardour_buffer_h__
  21
  22 #include <cstdlib>
  23 #include <cassert>
  24 #include <iostream>
  25 #include <ardour/types.h>
  26 #include <ardour/data_type.h>
  27
  28 namespace ARDOUR {
  29
  30
  31 /** A buffer of recordable/playable data.
  32  *
  33  * This is a datatype-agnostic base class for all buffers (there are no
  34  * methods to actually access the data).  This provides a way for code that
  35  * doesn't care about the data type to still deal with buffers (which is
  36  * why the base class can't be a template).
  37  *
  38  * To actually read/write buffer contents, use the appropriate derived class.
  39  */
  40 class Buffer
  41 {
  42 public:
  43         virtual ~Buffer() {}
  44
  45         /** Factory function */
  46         static Buffer* create(DataType type, size_t capacity);
  47
  48         /** Maximum capacity of buffer.
  49          * Note in some cases the entire buffer may not contain valid data, use size. */
  50         size_t capacity() const { return _capacity; }
  51
  52         /** Amount of valid data in buffer.  Use this over capacity almost always. */
  53         size_t size() const { return _size; }
  54
  55         /** Type of this buffer.
  56          * Based on this you can static cast a Buffer* to the desired type. */
  57         DataType type() const { return _type; }
  58
  59         bool silent() const { return _silent; }
  60
  61         /** Clear (eg zero, or empty) buffer starting at TIME @a offset */
  62         virtual void silence(jack_nframes_t len, jack_nframes_t offset=0) = 0;
  63
  64         /** Clear the entire buffer */
  65         virtual void clear() { silence(_capacity, 0); }
  66
  67         virtual void read_from(const Buffer& src, jack_nframes_t offset, jack_nframes_t len) = 0;
  68
  69 protected:
  70         Buffer(DataType type, size_t capacity)
  71         : _type(type), _capacity(capacity), _size(0), _silent(true)
  72         {}
  73
  74         DataType _type;
  75         size_t   _capacity;
  76         size_t   _size;
  77         bool     _silent;
  78
  79 private:
  80         // Prevent copies (undefined)
  81         Buffer(const Buffer& copy);
  82         void operator=(const Buffer& other);
  83 };
  84
  85
  86 /* Inside every class with a type in it's name is a template waiting to get out... */
  87
  88
  89 /** Buffer containing 32-bit floating point (audio) data. */
  90 class AudioBuffer : public Buffer
  91 {
  92 public:
  93         AudioBuffer(size_t capacity);
  94
  95         ~AudioBuffer();
  96
  97         void silence(jack_nframes_t len, jack_nframes_t offset=0)
  98         {
  99                 if (!_silent) {
 100                         assert(_capacity > 0);
 101                         assert(offset + len <= _capacity);
 102                         memset(_data + offset, 0, sizeof (Sample) * len);
 103                         if (offset == 0 && len == _capacity) {
 104                                 _silent = true;
 105                         }
 106                 }
 107         }
 108
 109         /** Read @a len frames FROM THE START OF @a src into self at @a offset */
 110         void read_from(const Buffer& src, jack_nframes_t len, jack_nframes_t offset)
 111         {
 112                 assert(_capacity > 0);
 113                 assert(src.type() == _type == DataType::AUDIO);
 114                 assert(offset + len <= _capacity);
 115                 memcpy(_data + offset, ((AudioBuffer&)src).data(len), sizeof(Sample) * len);
 116                 _silent = src.silent();
 117         }
 118
 119         /** Accumulate (add)@a len frames FROM THE START OF @a src into self at @a offset */
 120         void accumulate_from(const AudioBuffer& src, jack_nframes_t len, jack_nframes_t offset)
 121         {
 122                 assert(_capacity > 0);
 123                 assert(offset + len <= _capacity);
 124
 125                 Sample*       const dst_raw = _data + offset;
 126                 const Sample* const src_raw = src.data(len);
 127
 128                 for (jack_nframes_t n = 0; n < len; ++n) {
 129                         dst_raw[n] += src_raw[n];
 130                 }
 131
 132                 _silent = (src.silent() && _silent);
 133         }
 134
 135         /** Accumulate (add) @a len frames FROM THE START OF @a src into self at @a offset
 136          * scaling by @a gain_coeff */
 137         void accumulate_with_gain_from(const AudioBuffer& src, jack_nframes_t len, jack_nframes_t offset, gain_t gain_coeff)
 138         {
 139                 assert(_capacity > 0);
 140                 assert(offset + len <= _capacity);
 141
 142                 Sample*       const dst_raw = _data + offset;
 143                 const Sample* const src_raw = src.data(len);
 144
 145                 for (jack_nframes_t n = 0; n < len; ++n) {
 146                         dst_raw[n] += src_raw[n] * gain_coeff;
 147                 }
 148
 149                 _silent = ( (src.silent() && _silent) || (_silent && gain_coeff == 0) );
 150         }
 151
 152         void apply_gain(gain_t gain, jack_nframes_t len, jack_nframes_t offset=0) {
 153                 Sample* const buf = _data + offset;
 154
 155                 for (jack_nframes_t n = 0; n < len; ++n) {
 156                         buf[n] *= gain;
 157                 }
 158
 159                 _silent = (_silent || gain == 0);
 160         }
 161
 162         /** Set the data contained by this buffer manually (for setting directly to jack buffer).
 163          *
 164          * Constructor MUST have been passed capacity=0 or this will die (to prevent mem leaks).
 165          */
 166         void set_data(Sample* data, size_t size)
 167         {
 168                 assert(!_owns_data); // prevent leaks
 169                 _capacity = size;
 170                 _size = size;
 171                 _data = data;
 172                 _silent = false;
 173         }
 174
 175         const Sample* data(jack_nframes_t nframes, jack_nframes_t offset=0) const
 176                 { assert(offset + nframes <= _capacity); return _data + offset; }
 177
 178         Sample* data(jack_nframes_t nframes, jack_nframes_t offset=0)
 179                 { assert(offset + nframes <= _capacity); return _data + offset; }
 180
 181 private:
 182         // These are undefined (prevent copies)
 183         AudioBuffer(const AudioBuffer& copy);
 184         AudioBuffer& operator=(const AudioBuffer& copy);
 185
 186         bool    _owns_data;
 187         Sample* _data; ///< Actual buffer contents
 188 };
 189
 190
 191
 192 /** Buffer containing 8-bit unsigned char (MIDI) data. */
 193 class MidiBuffer : public Buffer
 194 {
 195 public:
 196         MidiBuffer(size_t capacity);
 197
 198         ~MidiBuffer();
 199
 200         void silence(jack_nframes_t dur, jack_nframes_t offset=0);
 201
 202         void read_from(const Buffer& src, jack_nframes_t nframes, jack_nframes_t offset);
 203
 204         bool push_back(const MidiEvent& event);
 205
 206         const MidiEvent& operator[](size_t i) const { assert(i < _size); return _events[i]; }
 207         MidiEvent& operator[](size_t i) { assert(i < _size); return _events[i]; }
 208
 209         static size_t max_event_size() { return MAX_EVENT_SIZE; }
 210
 211         //void set_size(size_t size) { _size = size; }
 212
 213         //const RawMidi* data() const { return _data; }
 214         //RawMidi*       data()       { return _data; }
 215
 216 private:
 217         // These are undefined (prevent copies)
 218         MidiBuffer(const MidiBuffer& copy);
 219         MidiBuffer& operator=(const MidiBuffer& copy);
 220
 221         // FIXME: Jack needs to tell us this
 222         static const size_t MAX_EVENT_SIZE = 4; // bytes
 223
 224         /* We use _size as "number of events", so the size of _data is
 225          * (_size * MAX_EVENT_SIZE)
 226          */
 227
 228         MidiEvent* _events;     ///< Event structs that point to offsets in _data
 229         RawMidi*   _data;       ///< MIDI, straight up.  No time stamps.
 230 };
 231
 232 } // namespace ARDOUR
 233
 234 #endif // __ardour_buffer_h__