src/lib/audio_buffers.cc

   1 /*
   2     Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #include "audio_buffers.h"
  22 #include "dcpomatic_assert.h"
  23 #include <cassert>
  24 #include <cstring>
  25 #include <cmath>
  26 #include <stdexcept>
  27
  28 using std::bad_alloc;
  29 using boost::shared_ptr;
  30
  31 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
  32  *  @param channels Number of channels.
  33  *  @param frames Number of frames to reserve space for.
  34  */
  35 AudioBuffers::AudioBuffers (int channels, int32_t frames)
  36 {
  37         allocate (channels, frames);
  38 }
  39
  40 /** Copy constructor.
  41  *  @param other Other AudioBuffers; data is copied.
  42  */
  43 AudioBuffers::AudioBuffers (AudioBuffers const & other)
  44 {
  45         allocate (other._channels, other._frames);
  46         copy_from (&other, other._frames, 0, 0);
  47 }
  48
  49 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
  50 {
  51         allocate (other->_channels, other->_frames);
  52         copy_from (other.get(), other->_frames, 0, 0);
  53 }
  54
  55 AudioBuffers &
  56 AudioBuffers::operator= (AudioBuffers const & other)
  57 {
  58         if (this == &other) {
  59                 return *this;
  60         }
  61
  62         deallocate ();
  63         allocate (other._channels, other._frames);
  64         copy_from (&other, other._frames, 0, 0);
  65
  66         return *this;
  67 }
  68
  69 /** AudioBuffers destructor */
  70 AudioBuffers::~AudioBuffers ()
  71 {
  72         deallocate ();
  73 }
  74
  75 void
  76 AudioBuffers::allocate (int channels, int32_t frames)
  77 {
  78         DCPOMATIC_ASSERT (frames >= 0);
  79         DCPOMATIC_ASSERT (channels >= 0);
  80
  81         _channels = channels;
  82         _frames = frames;
  83         _allocated_frames = frames;
  84
  85         _data = static_cast<float**> (malloc (_channels * sizeof (float *)));
  86         if (!_data) {
  87                 throw bad_alloc ();
  88         }
  89
  90         for (int i = 0; i < _channels; ++i) {
  91                 _data[i] = static_cast<float*> (malloc (frames * sizeof (float)));
  92                 if (!_data[i]) {
  93                         throw bad_alloc ();
  94                 }
  95         }
  96 }
  97
  98 void
  99 AudioBuffers::deallocate ()
 100 {
 101         for (int i = 0; i < _channels; ++i) {
 102                 free (_data[i]);
 103         }
 104
 105         free (_data);
 106 }
 107
 108 /** @param c Channel index.
 109  *  @return Buffer for this channel.
 110  */
 111 float*
 112 AudioBuffers::data (int c) const
 113 {
 114         DCPOMATIC_ASSERT (c >= 0 && c < _channels);
 115         return _data[c];
 116 }
 117
 118 /** Set the number of frames that these AudioBuffers will report themselves
 119  *  as having.  If we reduce the number of frames, the `lost' frames will
 120  *  be silenced.
 121  *  @param f Frames; must be less than or equal to the number of allocated frames.
 122  */
 123 void
 124 AudioBuffers::set_frames (int32_t f)
 125 {
 126         DCPOMATIC_ASSERT (f <= _allocated_frames);
 127
 128         for (int c = 0; c < _channels; ++c) {
 129                 for (int i = f; i < _frames; ++i) {
 130                         _data[c][i] = 0;
 131                 }
 132         }
 133
 134         _frames = f;
 135 }
 136
 137 /** Make all frames silent */
 138 void
 139 AudioBuffers::make_silent ()
 140 {
 141         for (int i = 0; i < _channels; ++i) {
 142                 make_silent (i);
 143         }
 144 }
 145
 146 /** Make all samples on a given channel silent.
 147  *  @param c Channel.
 148  */
 149 void
 150 AudioBuffers::make_silent (int c)
 151 {
 152         DCPOMATIC_ASSERT (c >= 0 && c < _channels);
 153
 154         for (int i = 0; i < _frames; ++i) {
 155                 _data[c][i] = 0;
 156         }
 157 }
 158
 159 /** Make some frames.
 160  *  @param from Start frame.
 161  *  @param frames Number of frames to silence.
 162  */
 163 void
 164 AudioBuffers::make_silent (int32_t from, int32_t frames)
 165 {
 166         DCPOMATIC_ASSERT ((from + frames) <= _allocated_frames);
 167
 168         for (int c = 0; c < _channels; ++c) {
 169                 for (int i = from; i < (from + frames); ++i) {
 170                         _data[c][i] = 0;
 171                 }
 172         }
 173 }
 174
 175 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 176  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 177  *  @param frames_to_copy Number of frames to copy.
 178  *  @param read_offset Offset to read from in `from'.
 179  *  @param write_offset Offset to write to in `to'.
 180  */
 181 void
 182 AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset)
 183 {
 184         if (frames_to_copy == 0) {
 185                 /* Prevent the asserts from firing if there is nothing to do */
 186                 return;
 187         }
 188
 189         DCPOMATIC_ASSERT (from->channels() == channels());
 190
 191         DCPOMATIC_ASSERT (from);
 192         DCPOMATIC_ASSERT (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 193         if (write_offset < 0 || (write_offset + frames_to_copy) > _allocated_frames) {
 194                 throw ProgrammingError(
 195                                 __FILE__, __LINE__,
 196                                 String::compose("frames_to_copy=%1, read_offset=%2, write_offset=%3", frames_to_copy, read_offset, write_offset)
 197                                 );
 198         }
 199
 200         for (int i = 0; i < _channels; ++i) {
 201                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 202         }
 203 }
 204
 205 /** Move audio data around.
 206  *  @param from Offset to move from.
 207  *  @param to Offset to move to.
 208  *  @param frames Number of frames to move.
 209  */
 210 void
 211 AudioBuffers::move (int32_t frames, int32_t from, int32_t to)
 212 {
 213         if (frames == 0) {
 214                 return;
 215         }
 216
 217         DCPOMATIC_ASSERT (from >= 0);
 218         DCPOMATIC_ASSERT (from < _frames);
 219         DCPOMATIC_ASSERT (to >= 0);
 220         DCPOMATIC_ASSERT (to < _frames);
 221         DCPOMATIC_ASSERT (frames > 0);
 222         DCPOMATIC_ASSERT (frames <= _frames);
 223         DCPOMATIC_ASSERT ((from + frames) <= _frames);
 224         DCPOMATIC_ASSERT ((to + frames) <= _allocated_frames);
 225
 226         for (int i = 0; i < _channels; ++i) {
 227                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 228         }
 229 }
 230
 231 /** Add data from from `from', `from_channel' to our channel `to_channel'.
 232  *  @param from Buffers to copy data from.
 233  *  @param from_channel Channel index to read in \p from.
 234  *  @param to_channel Channel index to accumulate into.
 235  *  @param gain Linear gain to apply to the data before it is added.
 236  */
 237 void
 238 AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain)
 239 {
 240         int const N = frames ();
 241         DCPOMATIC_ASSERT (from->frames() == N);
 242         DCPOMATIC_ASSERT (to_channel <= _channels);
 243
 244         float* s = from->data (from_channel);
 245         float* d = _data[to_channel];
 246
 247         for (int i = 0; i < N; ++i) {
 248                 *d++ += (*s++) * gain;
 249         }
 250 }
 251
 252 /** Ensure we have space for at least a certain number of frames.  If we extend
 253  *  the buffers, fill the new space with silence.
 254  */
 255 void
 256 AudioBuffers::ensure_size (int32_t frames)
 257 {
 258         if (_allocated_frames >= frames) {
 259                 return;
 260         }
 261
 262         /* Round up frames to the next power of 2 to reduce the number
 263            of realloc()s that are necessary.
 264         */
 265         frames--;
 266         frames |= frames >> 1;
 267         frames |= frames >> 2;
 268         frames |= frames >> 4;
 269         frames |= frames >> 8;
 270         frames |= frames >> 16;
 271         frames++;
 272
 273         for (int i = 0; i < _channels; ++i) {
 274                 _data[i] = static_cast<float*> (realloc (_data[i], frames * sizeof (float)));
 275                 if (!_data[i]) {
 276                         throw bad_alloc ();
 277                 }
 278                 for (int j = _allocated_frames; j < frames; ++j) {
 279                         _data[i][j] = 0;
 280                 }
 281         }
 282
 283         _allocated_frames = frames;
 284 }
 285
 286 /** Mix some other buffers with these ones.  The AudioBuffers must have the same number of channels.
 287  *  @param from Audio buffers to get data from.
 288  *  @param frames Number of frames to mix.
 289  *  @param read_offset Offset within `from' to read from.
 290  *  @param write_offset Offset within this to mix into.
 291  */
 292 void
 293 AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset)
 294 {
 295         DCPOMATIC_ASSERT (_channels == from->channels ());
 296         DCPOMATIC_ASSERT (read_offset >= 0);
 297         DCPOMATIC_ASSERT (write_offset >= 0);
 298
 299         float** from_data = from->data ();
 300         for (int i = 0; i < _channels; ++i) {
 301                 for (int j = 0; j < frames; ++j) {
 302                         _data[i][j + write_offset] += from_data[i][j + read_offset];
 303                 }
 304         }
 305 }
 306
 307 /** @param dB gain in dB */
 308 void
 309 AudioBuffers::apply_gain (float dB)
 310 {
 311         float const linear = pow (10, dB / 20);
 312
 313         for (int i = 0; i < _channels; ++i) {
 314                 for (int j = 0; j < _frames; ++j) {
 315                         _data[i][j] *= linear;
 316                 }
 317         }
 318 }
 319
 320 /** @param c Channel index.
 321  *  @return AudioBuffers object containing only channel `c' from this AudioBuffers.
 322  */
 323 shared_ptr<AudioBuffers>
 324 AudioBuffers::channel (int c) const
 325 {
 326         shared_ptr<AudioBuffers> o (new AudioBuffers (1, frames ()));
 327         o->copy_channel_from (this, c, 0);
 328         return o;
 329 }
 330
 331 /** Copy all the samples from a channel on another AudioBuffers to a channel on this one.
 332  *  @param from AudioBuffers to copy from.
 333  *  @param from_channel Channel index in `from' to copy from.
 334  *  @param to_channel Channel index in this to copy into, overwriting what's already there.
 335  */
 336 void
 337 AudioBuffers::copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel)
 338 {
 339         DCPOMATIC_ASSERT (from->frames() == frames());
 340         memcpy (data(to_channel), from->data(from_channel), frames() * sizeof (float));
 341 }
 342
 343 /** Make a copy of these AudioBuffers */
 344 shared_ptr<AudioBuffers>
 345 AudioBuffers::clone () const
 346 {
 347         shared_ptr<AudioBuffers> b (new AudioBuffers (channels (), frames ()));
 348         b->copy_from (this, frames (), 0, 0);
 349         return b;
 350 }
 351
 352 /** Extend these buffers with the data from another.  The AudioBuffers must have the same number of channels. */
 353 void
 354 AudioBuffers::append (shared_ptr<const AudioBuffers> other)
 355 {
 356         DCPOMATIC_ASSERT (channels() == other->channels());
 357         ensure_size (_frames + other->frames());
 358         copy_from (other.get(), other->frames(), 0, _frames);
 359         _frames += other->frames();
 360 }
 361
 362 /** Remove some frames from the start of these AudioBuffers */
 363 void
 364 AudioBuffers::trim_start (int32_t frames)
 365 {
 366         DCPOMATIC_ASSERT (frames <= _frames);
 367         move (_frames - frames, frames, 0);
 368         set_frames (_frames - frames);
 369 }