Cleanup: improve some variable names.
[dcpomatic.git] / src / lib / audio_buffers.cc
index 4c3c2d4a7a20515b8f58d4acbf17d1feb18b2039..51f6c6c337846cd49bbf3eb5267a31b25c4bc300 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
 
 */
 
+
 #include "audio_buffers.h"
 #include "dcpomatic_assert.h"
-#include <boost/make_shared.hpp>
+#include "maths_util.h"
 #include <cassert>
 #include <cstring>
 #include <cmath>
 #include <stdexcept>
 
+
 using std::bad_alloc;
-using boost::shared_ptr;
-using boost::make_shared;
+using std::shared_ptr;
+using std::make_shared;
+
 
 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
  *  @param channels Number of channels.
@@ -39,6 +42,7 @@ AudioBuffers::AudioBuffers (int channels, int32_t frames)
        allocate (channels, frames);
 }
 
+
 /** Copy constructor.
  *  @param other Other AudioBuffers; data is copied.
  */
@@ -48,12 +52,21 @@ AudioBuffers::AudioBuffers (AudioBuffers const & other)
        copy_from (&other, other._frames, 0, 0);
 }
 
-AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
+
+AudioBuffers::AudioBuffers (std::shared_ptr<const AudioBuffers> other)
 {
        allocate (other->_channels, other->_frames);
        copy_from (other.get(), other->_frames, 0, 0);
 }
 
+
+AudioBuffers::AudioBuffers (std::shared_ptr<const AudioBuffers> other, int32_t frames_to_copy, int32_t read_offset)
+{
+       allocate (other->_channels, frames_to_copy);
+       copy_from (other.get(), frames_to_copy, read_offset, 0);
+}
+
+
 AudioBuffers &
 AudioBuffers::operator= (AudioBuffers const & other)
 {
@@ -68,12 +81,14 @@ AudioBuffers::operator= (AudioBuffers const & other)
        return *this;
 }
 
+
 /** AudioBuffers destructor */
 AudioBuffers::~AudioBuffers ()
 {
        deallocate ();
 }
 
+
 void
 AudioBuffers::allocate (int channels, int32_t frames)
 {
@@ -84,19 +99,20 @@ AudioBuffers::allocate (int channels, int32_t frames)
        _frames = frames;
        _allocated_frames = frames;
 
-       _data = static_cast<float**> (malloc (_channels * sizeof (float *)));
+       _data = static_cast<float**> (malloc(_channels * sizeof(float *)));
        if (!_data) {
                throw bad_alloc ();
        }
 
        for (int i = 0; i < _channels; ++i) {
-               _data[i] = static_cast<float*> (malloc (frames * sizeof (float)));
+               _data[i] = static_cast<float*> (malloc(frames * sizeof(float)));
                if (!_data[i]) {
                        throw bad_alloc ();
                }
        }
 }
 
+
 void
 AudioBuffers::deallocate ()
 {
@@ -107,69 +123,76 @@ AudioBuffers::deallocate ()
        free (_data);
 }
 
-/** @param c Channel index.
+
+/** @param channel Channel index.
  *  @return Buffer for this channel.
  */
 float*
-AudioBuffers::data (int c) const
+AudioBuffers::data (int channel) const
 {
-       DCPOMATIC_ASSERT (c >= 0 && c < _channels);
-       return _data[c];
+       DCPOMATIC_ASSERT (channel >= 0 && channel < _channels);
+       return _data[channel];
 }
 
+
 /** Set the number of frames that these AudioBuffers will report themselves
  *  as having.  If we reduce the number of frames, the `lost' frames will
  *  be silenced.
  *  @param f Frames; must be less than or equal to the number of allocated frames.
  */
 void
-AudioBuffers::set_frames (int32_t f)
+AudioBuffers::set_frames (int32_t frames)
 {
-       DCPOMATIC_ASSERT (f <= _allocated_frames);
+       DCPOMATIC_ASSERT (frames <= _allocated_frames);
 
-       for (int c = 0; c < _channels; ++c) {
-               for (int i = f; i < _frames; ++i) {
-                       _data[c][i] = 0;
-               }
+       if (frames < _frames) {
+               make_silent (frames, _frames - frames);
        }
-
-       _frames = f;
+       _frames = frames;
 }
 
-/** Make all samples on all channels silent */
+
+/** Make all frames silent */
 void
 AudioBuffers::make_silent ()
 {
-       for (int i = 0; i < _channels; ++i) {
-               make_silent (i);
+       for (int channel = 0; channel < _channels; ++channel) {
+               make_silent (channel);
        }
 }
 
-/** Make all samples on a given channel silent.
- *  @param c Channel.
- */
+
+/** Make all samples on a given channel silent */
 void
-AudioBuffers::make_silent (int c)
+AudioBuffers::make_silent (int channel)
 {
-       DCPOMATIC_ASSERT (c >= 0 && c < _channels);
+       DCPOMATIC_ASSERT (channel >= 0 && channel < _channels);
 
-       for (int i = 0; i < _frames; ++i) {
-               _data[c][i] = 0;
-       }
+       /* This isn't really allowed, as all-bits-0 is not guaranteed to mean a 0 float,
+          but it seems that we can get away with it.
+       */
+       memset (_data[channel], 0, _frames * sizeof(float));
 }
 
+
+/** Make some frames.
+ *  @param from Start frame.
+ *  @param frames Number of frames to silence.
+ */
 void
 AudioBuffers::make_silent (int32_t from, int32_t frames)
 {
        DCPOMATIC_ASSERT ((from + frames) <= _allocated_frames);
 
-       for (int c = 0; c < _channels; ++c) {
-               for (int i = from; i < (from + frames); ++i) {
-                       _data[c][i] = 0;
-               }
+       for (int channel = 0; channel < _channels; ++channel) {
+               /* This isn't really allowed, as all-bits-0 is not guaranteed to mean a 0 float,
+                  but it seems that we can get away with it.
+               */
+               memset (_data[channel] + from, 0, frames * sizeof(float));
        }
 }
 
+
 /** Copy data from another AudioBuffers to this one.  All channels are copied.
  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
  *  @param frames_to_copy Number of frames to copy.
@@ -184,9 +207,8 @@ AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int3
                return;
        }
 
-       DCPOMATIC_ASSERT (from->channels() == channels());
-
        DCPOMATIC_ASSERT (from);
+       DCPOMATIC_ASSERT (from->channels() == channels());
        DCPOMATIC_ASSERT (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
        DCPOMATIC_ASSERT (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 
@@ -195,14 +217,14 @@ AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int3
        }
 }
 
+
 /** Move audio data around.
  *  @param from Offset to move from.
  *  @param to Offset to move to.
  *  @param frames Number of frames to move.
  */
-
 void
-AudioBuffers::move (int32_t from, int32_t to, int32_t frames)
+AudioBuffers::move (int32_t frames, int32_t from, int32_t to)
 {
        if (frames == 0) {
                return;
@@ -222,7 +244,11 @@ AudioBuffers::move (int32_t from, int32_t to, int32_t frames)
        }
 }
 
+
 /** Add data from from `from', `from_channel' to our channel `to_channel'.
+ *  @param from Buffers to copy data from.
+ *  @param from_channel Channel index to read in \p from.
+ *  @param to_channel Channel index to accumulate into.
  *  @param gain Linear gain to apply to the data before it is added.
  */
 void
@@ -232,14 +258,15 @@ AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, i
        DCPOMATIC_ASSERT (from->frames() == N);
        DCPOMATIC_ASSERT (to_channel <= _channels);
 
-       float* s = from->data (from_channel);
-       float* d = _data[to_channel];
+       auto s = from->data (from_channel);
+       auto d = _data[to_channel];
 
        for (int i = 0; i < N; ++i) {
                *d++ += (*s++) * gain;
        }
 }
 
+
 /** Ensure we have space for at least a certain number of frames.  If we extend
  *  the buffers, fill the new space with silence.
  */
@@ -262,37 +289,47 @@ AudioBuffers::ensure_size (int32_t frames)
        frames++;
 
        for (int i = 0; i < _channels; ++i) {
-               _data[i] = static_cast<float*> (realloc (_data[i], frames * sizeof (float)));
+               _data[i] = static_cast<float*> (realloc(_data[i], frames * sizeof(float)));
                if (!_data[i]) {
                        throw bad_alloc ();
                }
-               for (int j = _allocated_frames; j < frames; ++j) {
-                       _data[i][j] = 0;
-               }
        }
 
+       auto const old_allocated = _allocated_frames;
        _allocated_frames = frames;
+       if (old_allocated < _allocated_frames) {
+               make_silent (old_allocated, _allocated_frames - old_allocated);
+       }
 }
 
+
+/** Mix some other buffers with these ones.  The AudioBuffers must have the same number of channels.
+ *  @param from Audio buffers to get data from.
+ *  @param frames Number of frames to mix.
+ *  @param read_offset Offset within `from' to read from.
+ *  @param write_offset Offset within this to mix into.
+ */
 void
-AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t read_offset, int32_t write_offset, int32_t frames)
+AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset)
 {
        DCPOMATIC_ASSERT (_channels == from->channels ());
        DCPOMATIC_ASSERT (read_offset >= 0);
        DCPOMATIC_ASSERT (write_offset >= 0);
 
+       auto from_data = from->data ();
        for (int i = 0; i < _channels; ++i) {
                for (int j = 0; j < frames; ++j) {
-                       _data[i][j + write_offset] += from->data()[i][j + read_offset];
+                       _data[i][j + write_offset] += from_data[i][j + read_offset];
                }
        }
 }
 
+
 /** @param dB gain in dB */
 void
 AudioBuffers::apply_gain (float dB)
 {
-       float const linear = pow (10, dB / 20);
+       auto const linear = db_to_linear (dB);
 
        for (int i = 0; i < _channels; ++i) {
                for (int j = 0; j < _frames; ++j) {
@@ -301,17 +338,21 @@ AudioBuffers::apply_gain (float dB)
        }
 }
 
-/** @param c Channel index.
- *  @return AudioBuffers object containing only channel `c' from this AudioBuffers.
- */
+
 shared_ptr<AudioBuffers>
-AudioBuffers::channel (int c) const
+AudioBuffers::channel (int channel) const
 {
-       shared_ptr<AudioBuffers> o = make_shared<AudioBuffers> (1, frames ());
-       o->copy_channel_from (this, c, 0);
-       return o;
+       auto output = make_shared<AudioBuffers>(1, frames());
+       output->copy_channel_from (this, channel, 0);
+       return output;
 }
 
+
+/** Copy all the samples from a channel on another AudioBuffers to a channel on this one.
+ *  @param from AudioBuffers to copy from.
+ *  @param from_channel Channel index in `from' to copy from.
+ *  @param to_channel Channel index in this to copy into, overwriting what's already there.
+ */
 void
 AudioBuffers::copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel)
 {
@@ -319,10 +360,33 @@ AudioBuffers::copy_channel_from (AudioBuffers const * from, int from_channel, in
        memcpy (data(to_channel), from->data(from_channel), frames() * sizeof (float));
 }
 
+
+/** Make a copy of these AudioBuffers */
 shared_ptr<AudioBuffers>
 AudioBuffers::clone () const
 {
-       shared_ptr<AudioBuffers> b = make_shared<AudioBuffers> (channels (), frames ());
-       b->copy_from (this, frames (), 0, 0);
+       auto b = make_shared<AudioBuffers>(channels(), frames());
+       b->copy_from (this, frames(), 0, 0);
        return b;
 }
+
+
+/** Extend these buffers with the data from another.  The AudioBuffers must have the same number of channels. */
+void
+AudioBuffers::append (shared_ptr<const AudioBuffers> other)
+{
+       DCPOMATIC_ASSERT (channels() == other->channels());
+       ensure_size (_frames + other->frames());
+       copy_from (other.get(), other->frames(), 0, _frames);
+       _frames += other->frames();
+}
+
+
+/** Remove some frames from the start of these AudioBuffers */
+void
+AudioBuffers::trim_start (int32_t frames)
+{
+       DCPOMATIC_ASSERT (frames <= _frames);
+       move (_frames - frames, frames, 0);
+       set_frames (_frames - frames);
+}