Add and use dB/linear conversion functions.
[dcpomatic.git] / src / lib / audio_buffers.cc
index 7b3af91e0069324efb4ca69f5e7c41a19ead512a..cfe762659ebdb6d91128557b35cccb3c08c56144 100644 (file)
@@ -1,26 +1,30 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
+#include "util.h"
+#include "audio_buffers.h"
+#include "dcpomatic_assert.h"
 #include <cassert>
 #include <cstring>
+#include <cmath>
 #include <stdexcept>
-#include "audio_buffers.h"
 
 using std::bad_alloc;
 using boost::shared_ptr;
@@ -29,70 +33,77 @@ using boost::shared_ptr;
  *  @param channels Number of channels.
  *  @param frames Number of frames to reserve space for.
  */
-AudioBuffers::AudioBuffers (int channels, int frames)
-       : _channels (channels)
-       , _frames (frames)
-       , _allocated_frames (frames)
+AudioBuffers::AudioBuffers (int channels, int32_t frames)
 {
-       _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)));
-               if (!_data[i]) {
-                       throw bad_alloc ();
-               }
-       }
+       allocate (channels, frames);
 }
 
 /** Copy constructor.
  *  @param other Other AudioBuffers; data is copied.
  */
 AudioBuffers::AudioBuffers (AudioBuffers const & other)
-       : _channels (other._channels)
-       , _frames (other._frames)
-       , _allocated_frames (other._frames)
 {
-       _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)));
-               if (!_data[i]) {
-                       throw bad_alloc ();
-               }
-               memcpy (_data[i], other._data[i], _frames * sizeof (float));
-       }
+       allocate (other._channels, other._frames);
+       copy_from (&other, other._frames, 0, 0);
 }
 
-/* XXX: it's a shame that this is a copy-and-paste of the above;
-   probably fixable with c++0x.
-*/
 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
-       : _channels (other->_channels)
-       , _frames (other->_frames)
-       , _allocated_frames (other->_frames)
 {
+       allocate (other->_channels, other->_frames);
+       copy_from (other.get(), other->_frames, 0, 0);
+}
+
+AudioBuffers::AudioBuffers (boost::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)
+{
+       if (this == &other) {
+               return *this;
+       }
+
+       deallocate ();
+       allocate (other._channels, other._frames);
+       copy_from (&other, other._frames, 0, 0);
+
+       return *this;
+}
+
+/** AudioBuffers destructor */
+AudioBuffers::~AudioBuffers ()
+{
+       deallocate ();
+}
+
+void
+AudioBuffers::allocate (int channels, int32_t frames)
+{
+       DCPOMATIC_ASSERT (frames >= 0);
+       DCPOMATIC_ASSERT (channels >= 0);
+
+       _channels = channels;
+       _frames = frames;
+       _allocated_frames = frames;
+
        _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 ();
                }
-               memcpy (_data[i], other->_data[i], _frames * sizeof (float));
        }
 }
 
-/** AudioBuffers destructor */
-AudioBuffers::~AudioBuffers ()
+void
+AudioBuffers::deallocate ()
 {
        for (int i = 0; i < _channels; ++i) {
                free (_data[i]);
@@ -107,22 +118,27 @@ AudioBuffers::~AudioBuffers ()
 float*
 AudioBuffers::data (int c) const
 {
-       assert (c >= 0 && c < _channels);
+       DCPOMATIC_ASSERT (c >= 0 && c < _channels);
        return _data[c];
 }
 
 /** Set the number of frames that these AudioBuffers will report themselves
- *  as having.
+ *  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 (int f)
+AudioBuffers::set_frames (int32_t f)
 {
-       assert (f <= _allocated_frames);
+       DCPOMATIC_ASSERT (f <= _allocated_frames);
+
+       if (f < _frames) {
+               make_silent (f, _frames - f);
+       }
        _frames = f;
 }
 
-/** Make all samples on all channels silent */
+/** Make all frames silent */
 void
 AudioBuffers::make_silent ()
 {
@@ -137,22 +153,28 @@ AudioBuffers::make_silent ()
 void
 AudioBuffers::make_silent (int c)
 {
-       assert (c >= 0 && c < _channels);
-       
-       for (int i = 0; i < _frames; ++i) {
-               _data[c][i] = 0;
-       }
+       DCPOMATIC_ASSERT (c >= 0 && c < _channels);
+
+       /* 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[c], 0, _frames * sizeof(float));
 }
 
+/** Make some frames.
+ *  @param from Start frame.
+ *  @param frames Number of frames to silence.
+ */
 void
-AudioBuffers::make_silent (int from, int frames)
+AudioBuffers::make_silent (int32_t from, int32_t frames)
 {
-       assert ((from + frames) <= _allocated_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;
-               }
+               /* 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[c] + from, 0, frames * sizeof(float));
        }
 }
 
@@ -163,13 +185,18 @@ AudioBuffers::make_silent (int from, int frames)
  *  @param write_offset Offset to write to in `to'.
  */
 void
-AudioBuffers::copy_from (AudioBuffers const * from, int frames_to_copy, int read_offset, int write_offset)
+AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset)
 {
-       assert (from->channels() == channels());
+       if (frames_to_copy == 0) {
+               /* Prevent the asserts from firing if there is nothing to do */
+               return;
+       }
+
+       DCPOMATIC_ASSERT (from->channels() == channels());
 
-       assert (from);
-       assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
-       assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
+       DCPOMATIC_ASSERT (from);
+       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);
 
        for (int i = 0; i < _channels; ++i) {
                memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
@@ -181,41 +208,45 @@ AudioBuffers::copy_from (AudioBuffers const * from, int frames_to_copy, int read
  *  @param to Offset to move to.
  *  @param frames Number of frames to move.
  */
-    
 void
-AudioBuffers::move (int from, int to, int frames)
+AudioBuffers::move (int32_t frames, int32_t from, int32_t to)
 {
        if (frames == 0) {
                return;
        }
-       
-       assert (from >= 0);
-       assert (from < _frames);
-       assert (to >= 0);
-       assert (to < _frames);
-       assert (frames > 0);
-       assert (frames <= _frames);
-       assert ((from + frames) <= _frames);
-       assert ((to + frames) <= _frames);
-       
+
+       DCPOMATIC_ASSERT (from >= 0);
+       DCPOMATIC_ASSERT (from < _frames);
+       DCPOMATIC_ASSERT (to >= 0);
+       DCPOMATIC_ASSERT (to < _frames);
+       DCPOMATIC_ASSERT (frames > 0);
+       DCPOMATIC_ASSERT (frames <= _frames);
+       DCPOMATIC_ASSERT ((from + frames) <= _frames);
+       DCPOMATIC_ASSERT ((to + frames) <= _allocated_frames);
+
        for (int i = 0; i < _channels; ++i) {
                memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
        }
 }
 
-/** Add data from from `from', `from_channel' to our channel `to_channel' */
+/** 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
-AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel)
+AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain)
 {
        int const N = frames ();
-       assert (from->frames() == N);
-       assert (to_channel <= _channels);
+       DCPOMATIC_ASSERT (from->frames() == N);
+       DCPOMATIC_ASSERT (to_channel <= _channels);
 
        float* s = from->data (from_channel);
        float* d = _data[to_channel];
 
        for (int i = 0; i < N; ++i) {
-               *d++ += *s++;
+               *d++ += (*s++) * gain;
        }
 }
 
@@ -223,34 +254,118 @@ AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, i
  *  the buffers, fill the new space with silence.
  */
 void
-AudioBuffers::ensure_size (int frames)
+AudioBuffers::ensure_size (int32_t frames)
 {
        if (_allocated_frames >= frames) {
                return;
        }
 
+       /* Round up frames to the next power of 2 to reduce the number
+          of realloc()s that are necessary.
+       */
+       frames--;
+       frames |= frames >> 1;
+       frames |= frames >> 2;
+       frames |= frames >> 4;
+       frames |= frames >> 8;
+       frames |= frames >> 16;
+       frames++;
+
        for (int i = 0; i < _channels; ++i) {
                _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;
-               }
        }
 
+       int32_t 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, int read_offset, int write_offset, int frames)
+AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset)
 {
-       assert (_channels == from->channels ());
+       DCPOMATIC_ASSERT (_channels == from->channels ());
+       DCPOMATIC_ASSERT (read_offset >= 0);
+       DCPOMATIC_ASSERT (write_offset >= 0);
 
+       float** 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 = db_to_linear (dB);
+
+       for (int i = 0; i < _channels; ++i) {
+               for (int j = 0; j < _frames; ++j) {
+                       _data[i][j] *= linear;
                }
        }
 }
 
+/** @param c Channel index.
+ *  @return AudioBuffers object containing only channel `c' from this AudioBuffers.
+ */
+shared_ptr<AudioBuffers>
+AudioBuffers::channel (int c) const
+{
+       shared_ptr<AudioBuffers> o (new AudioBuffers (1, frames ()));
+       o->copy_channel_from (this, c, 0);
+       return o;
+}
+
+/** 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)
+{
+       DCPOMATIC_ASSERT (from->frames() == frames());
+       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 (new 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);
+}