2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/audio_buffers.h
21 * @brief AudioBuffers class.
24 #ifndef DCPOMATIC_AUDIO_BUFFERS_H
25 #define DCPOMATIC_AUDIO_BUFFERS_H
27 #include <boost/shared_ptr.hpp>
30 /** @class AudioBuffers
31 * @brief A class to hold multi-channel audio data in float format.
33 * The use of int32_t for frame counts in this class is due to the
34 * round-up to the next power-of-2 code in ::ensure_size; if that
35 * were changed the frame count could use any integer type.
40 AudioBuffers (int channels, int32_t frames);
41 AudioBuffers (AudioBuffers const &);
42 AudioBuffers (boost::shared_ptr<const AudioBuffers>);
45 AudioBuffers & operator= (AudioBuffers const &);
47 boost::shared_ptr<AudioBuffers> clone () const;
48 boost::shared_ptr<AudioBuffers> channel (int) const;
50 void ensure_size (int32_t);
52 float** data () const {
56 float* data (int) const;
58 int channels () const {
66 void set_frames (int32_t f);
69 void make_silent (int c);
70 void make_silent (int32_t from, int32_t frames);
72 void apply_gain (float);
74 void copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset);
75 void copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel);
76 void move (int32_t from, int32_t to, int32_t frames);
77 void accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain = 1);
78 void accumulate_frames (AudioBuffers const *, int32_t read_offset, int32_t write_offset, int32_t frames);
81 void allocate (int channels, int32_t frames);
84 /** Number of channels */
86 /** Number of frames (where a frame is one sample across all channels) */
88 /** Number of frames that _data can hold */
89 int32_t _allocated_frames;
90 /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */