src/sound_frame.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/sound_frame.h
  21  *  @brief SoundFrame class.
  22  */
  23
  24 #ifndef LIBDCP_SOUND_FRAME_H
  25 #define LIBDCP_SOUND_FRAME_H
  26
  27 #include <boost/noncopyable.hpp>
  28 #include <boost/filesystem.hpp>
  29 #include <stdint.h>
  30 #include <string>
  31
  32 namespace ASDCP {
  33         namespace PCM {
  34                 class FrameBuffer;
  35         }
  36         class AESDecContext;
  37 }
  38
  39 namespace dcp {
  40
  41 /** @class SoundFrame
  42  *  @brief One &lsquo;frame&rsquo; of sound data from a SoundAsset.
  43  */
  44 class SoundFrame : public boost::noncopyable
  45 {
  46 public:
  47         SoundFrame (boost::filesystem::path path, int n, ASDCP::AESDecContext *);
  48         ~SoundFrame ();
  49
  50         uint8_t const * data () const;
  51         int size () const;
  52
  53 private:
  54         /** a buffer to hold the frame */
  55         ASDCP::PCM::FrameBuffer* _buffer;
  56 };
  57
  58 }
  59
  60 #endif