2 Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "audio_buffers.h"
22 #include "dcpomatic_assert.h"
29 using boost::shared_ptr;
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.
35 AudioBuffers::AudioBuffers (int channels, int32_t frames)
37 allocate (channels, frames);
41 * @param other Other AudioBuffers; data is copied.
43 AudioBuffers::AudioBuffers (AudioBuffers const & other)
45 allocate (other._channels, other._frames);
46 copy_from (&other, other._frames, 0, 0);
49 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
51 allocate (other->_channels, other->_frames);
52 copy_from (other.get(), other->_frames, 0, 0);
56 AudioBuffers::operator= (AudioBuffers const & other)
63 allocate (other._channels, other._frames);
64 copy_from (&other, other._frames, 0, 0);
69 /** AudioBuffers destructor */
70 AudioBuffers::~AudioBuffers ()
76 AudioBuffers::allocate (int channels, int32_t frames)
78 DCPOMATIC_ASSERT (frames >= 0);
79 DCPOMATIC_ASSERT (channels >= 0);
83 _allocated_frames = frames;
85 _data = static_cast<float**> (malloc (_channels * sizeof (float *)));
90 for (int i = 0; i < _channels; ++i) {
91 _data[i] = static_cast<float*> (malloc (frames * sizeof (float)));
99 AudioBuffers::deallocate ()
101 for (int i = 0; i < _channels; ++i) {
108 /** @param c Channel index.
109 * @return Buffer for this channel.
112 AudioBuffers::data (int c) const
114 DCPOMATIC_ASSERT (c >= 0 && c < _channels);
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
121 * @param f Frames; must be less than or equal to the number of allocated frames.
124 AudioBuffers::set_frames (int32_t f)
126 DCPOMATIC_ASSERT (f <= _allocated_frames);
128 for (int c = 0; c < _channels; ++c) {
129 for (int i = f; i < _frames; ++i) {
137 /** Make all frames silent */
139 AudioBuffers::make_silent ()
141 for (int i = 0; i < _channels; ++i) {
146 /** Make all samples on a given channel silent.
150 AudioBuffers::make_silent (int c)
152 DCPOMATIC_ASSERT (c >= 0 && c < _channels);
154 for (int i = 0; i < _frames; ++i) {
159 /** Make some frames.
160 * @param from Start frame.
161 * @param frames Number of frames to silence.
164 AudioBuffers::make_silent (int32_t from, int32_t frames)
166 DCPOMATIC_ASSERT ((from + frames) <= _allocated_frames);
168 for (int c = 0; c < _channels; ++c) {
169 for (int i = from; i < (from + frames); ++i) {
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'.
182 AudioBuffers::copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset)
184 if (frames_to_copy == 0) {
185 /* Prevent the asserts from firing if there is nothing to do */
189 DCPOMATIC_ASSERT (from->channels() == channels());
191 DCPOMATIC_ASSERT (from);
192 DCPOMATIC_ASSERT (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
193 DCPOMATIC_ASSERT (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
195 for (int i = 0; i < _channels; ++i) {
196 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
200 /** Move audio data around.
201 * @param from Offset to move from.
202 * @param to Offset to move to.
203 * @param frames Number of frames to move.
206 AudioBuffers::move (int32_t frames, int32_t from, int32_t to)
212 DCPOMATIC_ASSERT (from >= 0);
213 DCPOMATIC_ASSERT (from < _frames);
214 DCPOMATIC_ASSERT (to >= 0);
215 DCPOMATIC_ASSERT (to < _frames);
216 DCPOMATIC_ASSERT (frames > 0);
217 DCPOMATIC_ASSERT (frames <= _frames);
218 DCPOMATIC_ASSERT ((from + frames) <= _frames);
219 DCPOMATIC_ASSERT ((to + frames) <= _allocated_frames);
221 for (int i = 0; i < _channels; ++i) {
222 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
226 /** Add data from from `from', `from_channel' to our channel `to_channel'.
227 * @param from Buffers to copy data from.
228 * @param from_channel Channel index to read in \p from.
229 * @param to_channel Channel index to accumulate into.
230 * @param gain Linear gain to apply to the data before it is added.
233 AudioBuffers::accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain)
235 int const N = frames ();
236 DCPOMATIC_ASSERT (from->frames() == N);
237 DCPOMATIC_ASSERT (to_channel <= _channels);
239 float* s = from->data (from_channel);
240 float* d = _data[to_channel];
242 for (int i = 0; i < N; ++i) {
243 *d++ += (*s++) * gain;
247 /** Ensure we have space for at least a certain number of frames. If we extend
248 * the buffers, fill the new space with silence.
251 AudioBuffers::ensure_size (int32_t frames)
253 if (_allocated_frames >= frames) {
257 /* Round up frames to the next power of 2 to reduce the number
258 of realloc()s that are necessary.
261 frames |= frames >> 1;
262 frames |= frames >> 2;
263 frames |= frames >> 4;
264 frames |= frames >> 8;
265 frames |= frames >> 16;
268 for (int i = 0; i < _channels; ++i) {
269 _data[i] = static_cast<float*> (realloc (_data[i], frames * sizeof (float)));
273 for (int j = _allocated_frames; j < frames; ++j) {
278 _allocated_frames = frames;
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.
288 AudioBuffers::accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset)
290 DCPOMATIC_ASSERT (_channels == from->channels ());
291 DCPOMATIC_ASSERT (read_offset >= 0);
292 DCPOMATIC_ASSERT (write_offset >= 0);
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];
302 /** @param dB gain in dB */
304 AudioBuffers::apply_gain (float dB)
306 float const linear = pow (10, dB / 20);
308 for (int i = 0; i < _channels; ++i) {
309 for (int j = 0; j < _frames; ++j) {
310 _data[i][j] *= linear;
315 /** @param c Channel index.
316 * @return AudioBuffers object containing only channel `c' from this AudioBuffers.
318 shared_ptr<AudioBuffers>
319 AudioBuffers::channel (int c) const
321 shared_ptr<AudioBuffers> o (new AudioBuffers (1, frames ()));
322 o->copy_channel_from (this, c, 0);
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.
332 AudioBuffers::copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel)
334 DCPOMATIC_ASSERT (from->frames() == frames());
335 memcpy (data(to_channel), from->data(from_channel), frames() * sizeof (float));
338 /** Make a copy of these AudioBuffers */
339 shared_ptr<AudioBuffers>
340 AudioBuffers::clone () const
342 shared_ptr<AudioBuffers> b (new AudioBuffers (channels (), frames ()));
343 b->copy_from (this, frames (), 0, 0);
347 /** Extend these buffers with the data from another. The AudioBuffers must have the same number of channels. */
349 AudioBuffers::append (shared_ptr<const AudioBuffers> other)
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();
357 /** Remove some frames from the start of these AudioBuffers */
359 AudioBuffers::trim_start (int32_t frames)
361 DCPOMATIC_ASSERT (frames <= _frames);
362 move (_frames - frames, frames, 0);
363 set_frames (_frames - frames);