libs/ardour/ardour/audio_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_audio_buffer_h__
  20 #define __ardour_audio_buffer_h__
  21
  22 #include <cstring>
  23 #include "ardour/buffer.h"
  24
  25 namespace ARDOUR {
  26
  27 class AudioBuffer : public Buffer
  28 {
  29 public:
  30         AudioBuffer(size_t capacity);
  31         ~AudioBuffer();
  32
  33         void silence (framecnt_t len, framecnt_t offset = 0) {
  34                 if (!_silent) {
  35                         assert(_capacity > 0);
  36                         assert(offset + len <= _capacity);
  37                         memset(_data + offset, 0, sizeof (Sample) * len);
  38                         if (len == _capacity) {
  39                                 _silent = true;
  40                         }
  41                 }
  42                 _written = true;
  43         }
  44
  45         /** Read @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/
  46         void read_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
  47                 assert(&src != this);
  48                 assert(_capacity > 0);
  49                 assert(src.type() == DataType::AUDIO);
  50                 assert(len <= _capacity);
  51                 memcpy(_data + dst_offset, ((AudioBuffer&)src).data() + src_offset, sizeof(Sample) * len);
  52                 if (dst_offset == 0 && src_offset == 0 && len == _capacity) {
  53                         _silent = src.silent();
  54                 } else {
  55                         _silent = _silent && src.silent();
  56                 }
  57                 _written = true;
  58         }
  59
  60         /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/
  61         void merge_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
  62                 const AudioBuffer* ab = dynamic_cast<const AudioBuffer*>(&src);
  63                 assert (ab);
  64                 accumulate_from (*ab, len, dst_offset, src_offset);
  65         }
  66
  67         /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/
  68         void accumulate_from (const AudioBuffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
  69                 assert(_capacity > 0);
  70                 assert(len <= _capacity);
  71
  72                 Sample*       const dst_raw = _data + dst_offset;
  73                 const Sample* const src_raw = src.data() + src_offset;
  74
  75                 mix_buffers_no_gain(dst_raw, src_raw, len);
  76
  77                 _silent = (src.silent() && _silent);
  78                 _written = true;
  79         }
  80
  81         /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset
  82          * scaling by @a gain_coeff */
  83         void accumulate_with_gain_from (const AudioBuffer& src, framecnt_t len, gain_t gain_coeff, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) {
  84
  85                 assert(_capacity > 0);
  86                 assert(len <= _capacity);
  87
  88                 if (src.silent()) {
  89                         return;
  90                 }
  91
  92                 Sample*       const dst_raw = _data + dst_offset;
  93                 const Sample* const src_raw = src.data() + src_offset;
  94
  95                 mix_buffers_with_gain (dst_raw, src_raw, len, gain_coeff);
  96
  97                 _silent = ( (src.silent() && _silent) || (_silent && gain_coeff == 0) );
  98                 _written = true;
  99         }
 100
 101         /** Accumulate (add) @a len frames FROM THE START OF @a src into self
 102          * scaling by @a gain_coeff */
 103         void accumulate_with_gain_from (const Sample* src_raw, framecnt_t len, gain_t gain_coeff, framecnt_t dst_offset = 0) {
 104
 105                 assert(_capacity > 0);
 106                 assert(len <= _capacity);
 107
 108                 Sample*       const dst_raw = _data + dst_offset;
 109
 110                 mix_buffers_with_gain (dst_raw, src_raw, len, gain_coeff);
 111
 112                 _silent = (_silent && gain_coeff == 0);
 113                 _written = true;
 114         }
 115
 116         /** Accumulate (add) @a len frames FROM THE START OF @a src into self
 117          * scaling by @a gain_coeff */
 118         void accumulate_with_ramped_gain_from (const Sample* src, framecnt_t len, gain_t initial, gain_t target, framecnt_t dst_offset = 0) {
 119
 120                 assert(_capacity > 0);
 121                 assert(len <= _capacity);
 122
 123                 Sample* dst = _data + dst_offset;
 124                 gain_t  gain_delta = (target - initial)/len;
 125
 126                 for (framecnt_t n = 0; n < len; ++n) {
 127                         *dst++ += (*src++ * initial);
 128                         initial += gain_delta;
 129                 }
 130
 131                 _silent = (_silent && initial == 0 && target == 0);
 132                 _written = true;
 133         }
 134
 135         void apply_gain (gain_t gain, framecnt_t len) {
 136                 apply_gain_to_buffer (_data, len, gain);
 137         }
 138
 139         /** Set the data contained by this buffer manually (for setting directly to jack buffer).
 140          *
 141          * Constructor MUST have been passed capacity=0 or this will die (to prevent mem leaks).
 142          */
 143         void set_data (Sample* data, size_t size) {
 144                 assert(!_owns_data); // prevent leaks
 145                 _capacity = size;
 146                 _size = size;
 147                 _data = data;
 148                 _silent = false;
 149                 _written = false;
 150         }
 151
 152         /** Reallocate the buffer used internally to handle at least @nframes of data
 153          *
 154          * Constructor MUST have been passed capacity!=0 or this will die (to prevent mem leaks).
 155          */
 156         void resize (size_t nframes);
 157
 158
 159         const Sample* data (framecnt_t offset = 0) const {
 160                 assert(offset <= _capacity);
 161                 return _data + offset;
 162         }
 163
 164         Sample* data (framecnt_t offset = 0) {
 165                 assert(offset <= _capacity);
 166                 return _data + offset;
 167         }
 168
 169         void prepare () { _written = false; _silent = false; }
 170         bool written() const { return _written; }
 171
 172   private:
 173         bool    _owns_data;
 174         bool    _written;
 175         Sample* _data; ///< Actual buffer contents
 176 };
 177
 178
 179 } // namespace ARDOUR
 180
 181 #endif // __ardour_audio_audio_buffer_h__