2 Copyright (C) 2012-2021 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/>.
22 /** @file src/lib/audio_buffers.h
23 * @brief AudioBuffers class.
27 #ifndef DCPOMATIC_AUDIO_BUFFERS_H
28 #define DCPOMATIC_AUDIO_BUFFERS_H
35 /** @class AudioBuffers
36 * @brief A class to hold multi-channel audio data in float format.
38 * The use of int32_t for frame counts in this class is due to the
39 * round-up to the next power-of-2 code in ensure_size(); if that
40 * were changed the frame count could use any integer type.
45 AudioBuffers (int channels, int32_t frames);
46 AudioBuffers (AudioBuffers const &);
47 explicit AudioBuffers (std::shared_ptr<const AudioBuffers>);
48 AudioBuffers (std::shared_ptr<const AudioBuffers> other, int32_t frames_to_copy, int32_t read_offset);
51 AudioBuffers & operator= (AudioBuffers const &);
53 std::shared_ptr<AudioBuffers> clone () const;
54 std::shared_ptr<AudioBuffers> channel (int) const;
56 void ensure_size (int32_t);
58 float** data () const {
62 float* data (int) const;
64 int channels () const {
72 void set_frames (int32_t f);
75 void make_silent (int c);
76 void make_silent (int32_t from, int32_t frames);
78 void apply_gain (float);
80 void copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset);
81 void copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel);
82 void move (int32_t frames, int32_t from, int32_t to);
83 void accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain = 1);
84 void accumulate_frames (AudioBuffers const * from, int32_t frames, int32_t read_offset, int32_t write_offset);
85 void append (std::shared_ptr<const AudioBuffers> other);
86 void trim_start (int32_t frames);
89 void allocate (int channels, int32_t frames);
92 /** Number of channels */
94 /** Number of frames (where a frame is one sample across all channels) */
96 /** Number of frames that _data can hold */
97 int32_t _allocated_frames;
98 /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */