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         if (f < _frames) {
 129                 make_silent (f, _frames - f);
 130         }
 131         _frames = f;
 132 }
 133
 134 /** Make all frames silent */
 135 void
 136 AudioBuffers::make_silent ()
 137 {
 138         for (int i = 0; i < _channels; ++i) {
 139                 make_silent (i);
 140         }
 141 }
 142
 143 /** Make all samples on a given channel silent.
 144  *  @param c Channel.
 145  */
 146 void
 147 AudioBuffers::make_silent (int c)
 148 {
 149         DCPOMATIC_ASSERT (c >= 0 && c < _channels);
 150
 151         /* This isn't really allowed, as all-bits-0 is not guaranteed to mean a 0 float,
 152            but it seems that we can get away with it.
 153         */
 154         memset (_data[c], 0, _frames * sizeof(float));
 155 }
 156
 157 /** Make some frames.
 158  *  @param from Start frame.
 159  *  @param frames Number of frames to silence.
 160  */
 161 void
 162 AudioBuffers::make_silent (int32_t from, int32_t frames)
 163 {
 164         DCPOMATIC_ASSERT ((from + frames) <= _allocated_frames);
 165
 166         for (int c = 0; c < _channels; ++c) {
 167                 /* This isn't really allowed, as all-bits-0 is not guaranteed to mean a 0 float,
 168                    but it seems that we can get away with it.
 169                 */
 170                 memset (_data[c] + from, 0, frames * sizeof(float));
 171         }
 172 }
 173
 174 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 175  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 176  *  @param frames_to_copy Number of frames to copy.
 177  *  @param read_offset Offset to read from in `from'.
 178  *  @param write_offset Offset to write to in `to'.
 179  */
 180 void
 181 AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset)
 182 {
 183         if (frames_to_copy == 0) {
 184                 /* Prevent the asserts from firing if there is nothing to do */
 185                 return;
 186         }
 187
 188         DCPOMATIC_ASSERT (from->channels() == channels());
 189
 190         DCPOMATIC_ASSERT (from);
 191         DCPOMATIC_ASSERT (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 192         DCPOMATIC_ASSERT (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 193
 194         for (int i = 0; i < _channels; ++i) {
 195                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 196         }
 197 }
 198
 199 /** Move audio data around.
 200  *  @param from Offset to move from.
 201  *  @param to Offset to move to.
 202  *  @param frames Number of frames to move.
 203  */
 204 void
 205 AudioBuffers::move (int32_t frames, int32_t from, int32_t to)
 206 {
 207         if (frames == 0) {
 208                 return;
 209         }
 210
 211         DCPOMATIC_ASSERT (from >= 0);
 212         DCPOMATIC_ASSERT (from < _frames);
 213         DCPOMATIC_ASSERT (to >= 0);
 214         DCPOMATIC_ASSERT (to < _frames);
 215         DCPOMATIC_ASSERT (frames > 0);
 216         DCPOMATIC_ASSERT (frames <= _frames);
 217         DCPOMATIC_ASSERT ((from + frames) <= _frames);
 218         DCPOMATIC_ASSERT ((to + frames) <= _allocated_frames);
 219
 220         for (int i = 0; i < _channels; ++i) {
 221                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 222         }
 223 }
 224
 225 /** Add data from from `from', `from_channel' to our channel `to_channel'.
 226  *  @param from Buffers to copy data from.
 227  *  @param from_channel Channel index to read in \p from.
 228  *  @param to_channel Channel index to accumulate into.
 229  *  @param gain Linear gain to apply to the data before it is added.
 230  */
 231 void
 232 AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain)
 233 {
 234         int const N = frames ();
 235         DCPOMATIC_ASSERT (from->frames() == N);
 236         DCPOMATIC_ASSERT (to_channel <= _channels);
 237
 238         float* s = from->data (from_channel);
 239         float* d = _data[to_channel];
 240
 241         for (int i = 0; i < N; ++i) {
 242                 *d++ += (*s++) * gain;
 243         }
 244 }
 245
 246 /** Ensure we have space for at least a certain number of frames.  If we extend
 247  *  the buffers, fill the new space with silence.
 248  */
 249 void
 250 AudioBuffers::ensure_size (int32_t frames)
 251 {
 252         if (_allocated_frames >= frames) {
 253                 return;
 254         }
 255
 256         /* Round up frames to the next power of 2 to reduce the number
 257            of realloc()s that are necessary.
 258         */
 259         frames--;
 260         frames |= frames >> 1;
 261         frames |= frames >> 2;
 262         frames |= frames >> 4;
 263         frames |= frames >> 8;
 264         frames |= frames >> 16;
 265         frames++;
 266
 267         for (int i = 0; i < _channels; ++i) {
 268                 _data[i] = static_cast<float*> (realloc (_data[i], frames * sizeof (float)));
 269                 if (!_data[i]) {
 270                         throw bad_alloc ();
 271                 }
 272         }
 273
 274         int32_t const old_allocated = _allocated_frames;
 275         _allocated_frames = frames;
 276         if (old_allocated < _allocated_frames) {
 277                 make_silent (old_allocated, _allocated_frames - old_allocated);
 278         }
 279 }
 280
 281 /** Mix some other buffers with these ones.  The AudioBuffers must have the same number of channels.
 282  *  @param from Audio buffers to get data from.
 283  *  @param frames Number of frames to mix.
 284  *  @param read_offset Offset within `from' to read from.
 285  *  @param write_offset Offset within this to mix into.
 286  */
 287 void
 288 AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset)
 289 {
 290         DCPOMATIC_ASSERT (_channels == from->channels ());
 291         DCPOMATIC_ASSERT (read_offset >= 0);
 292         DCPOMATIC_ASSERT (write_offset >= 0);
 293
 294         float** from_data = from->data ();
 295         for (int i = 0; i < _channels; ++i) {
 296                 for (int j = 0; j < frames; ++j) {
 297                         _data[i][j + write_offset] += from_data[i][j + read_offset];
 298                 }
 299         }
 300 }
 301
 302 /** @param dB gain in dB */
 303 void
 304 AudioBuffers::apply_gain (float dB)
 305 {
 306         float const linear = pow (10, dB / 20);
 307
 308         for (int i = 0; i < _channels; ++i) {
 309                 for (int j = 0; j < _frames; ++j) {
 310                         _data[i][j] *= linear;
 311                 }
 312         }
 313 }
 314
 315 /** @param c Channel index.
 316  *  @return AudioBuffers object containing only channel `c' from this AudioBuffers.
 317  */
 318 shared_ptr<AudioBuffers>
 319 AudioBuffers::channel (int c) const
 320 {
 321         shared_ptr<AudioBuffers> o (new AudioBuffers (1, frames ()));
 322         o->copy_channel_from (this, c, 0);
 323         return o;
 324 }
 325
 326 /** Copy all the samples from a channel on another AudioBuffers to a channel on this one.
 327  *  @param from AudioBuffers to copy from.
 328  *  @param from_channel Channel index in `from' to copy from.
 329  *  @param to_channel Channel index in this to copy into, overwriting what's already there.
 330  */
 331 void
 332 AudioBuffers::copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel)
 333 {
 334         DCPOMATIC_ASSERT (from->frames() == frames());
 335         memcpy (data(to_channel), from->data(from_channel), frames() * sizeof (float));
 336 }
 337
 338 /** Make a copy of these AudioBuffers */
 339 shared_ptr<AudioBuffers>
 340 AudioBuffers::clone () const
 341 {
 342         shared_ptr<AudioBuffers> b (new AudioBuffers (channels (), frames ()));
 343         b->copy_from (this, frames (), 0, 0);
 344         return b;
 345 }
 346
 347 /** Extend these buffers with the data from another.  The AudioBuffers must have the same number of channels. */
 348 void
 349 AudioBuffers::append (shared_ptr<const AudioBuffers> other)
 350 {
 351         DCPOMATIC_ASSERT (channels() == other->channels());
 352         ensure_size (_frames + other->frames());
 353         copy_from (other.get(), other->frames(), 0, _frames);
 354         _frames += other->frames();
 355 }
 356
 357 /** Remove some frames from the start of these AudioBuffers */
 358 void
 359 AudioBuffers::trim_start (int32_t frames)
 360 {
 361         DCPOMATIC_ASSERT (frames <= _frames);
 362         move (_frames - frames, frames, 0);
 363         set_frames (_frames - frames);
 364 }