src/lib/audio_buffers.h

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 /** @file  src/lib/audio_buffers.h
  21  *  @brief AudioBuffers class.
  22  */
  23
  24 #ifndef DCPOMATIC_AUDIO_BUFFERS_H
  25 #define DCPOMATIC_AUDIO_BUFFERS_H
  26
  27 #include <boost/shared_ptr.hpp>
  28
  29 /** @class AudioBuffers
  30  *  @brief A class to hold multi-channel audio data in float format.
  31  *
  32  *  The use of int32_t for frame counts in this class is due to the
  33  *  round-up to the next power-of-2 code in ::ensure_size; if that
  34  *  were changed the frame count could use any integer type.
  35  */
  36 class AudioBuffers
  37 {
  38 public:
  39         AudioBuffers (int channels, int32_t frames);
  40         AudioBuffers (AudioBuffers const &);
  41         AudioBuffers (boost::shared_ptr<const AudioBuffers>);
  42         ~AudioBuffers ();
  43
  44         AudioBuffers & operator= (AudioBuffers const &);
  45
  46         boost::shared_ptr<AudioBuffers> clone () const;
  47         boost::shared_ptr<AudioBuffers> channel (int) const;
  48
  49         void ensure_size (int32_t);
  50
  51         float** data () const {
  52                 return _data;
  53         }
  54
  55         float* data (int) const;
  56
  57         int channels () const {
  58                 return _channels;
  59         }
  60
  61         int frames () const {
  62                 return _frames;
  63         }
  64
  65         void set_frames (int32_t f);
  66
  67         void make_silent ();
  68         void make_silent (int c);
  69         void make_silent (int32_t from, int32_t frames);
  70
  71         void apply_gain (float);
  72
  73         void copy_from (AudioBuffers const * from, int32_t frames_to_copy, int32_t read_offset, int32_t write_offset);
  74         void copy_channel_from (AudioBuffers const * from, int from_channel, int to_channel);
  75         void move (int32_t from, int32_t to, int32_t frames);
  76         void accumulate_channel (AudioBuffers const * from, int from_channel, int to_channel, float gain = 1);
  77         void accumulate_frames (AudioBuffers const *, int32_t read_offset, int32_t write_offset, int32_t frames);
  78
  79 private:
  80         void allocate (int channels, int32_t frames);
  81         void deallocate ();
  82
  83         /** Number of channels */
  84         int _channels;
  85         /** Number of frames (where a frame is one sample across all channels) */
  86         int32_t _frames;
  87         /** Number of frames that _data can hold */
  88         int32_t _allocated_frames;
  89         /** Audio data (so that, e.g. _data[2][6] is channel 2, sample 6) */
  90         float** _data;
  91 };
  92
  93 #endif