src/sound_frame.h

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp 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.
  10
  11     libdcp 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.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  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                 class MXFReader;
  36         }
  37         class AESDecContext;
  38 }
  39
  40 namespace dcp {
  41
  42 /** @class SoundFrame
  43  *  @brief One &lsquo;frame&rsquo; of sound data from a SoundAsset.
  44  */
  45 class SoundFrame : public boost::noncopyable
  46 {
  47 public:
  48         ~SoundFrame ();
  49
  50         uint8_t const * data () const;
  51         int size () const;
  52
  53 private:
  54         friend class SoundAssetReader;
  55
  56         SoundFrame (ASDCP::PCM::MXFReader* reader, int n, ASDCP::AESDecContext *);
  57
  58         /** a buffer to hold the frame */
  59         ASDCP::PCM::FrameBuffer* _buffer;
  60 };
  61
  62 }
  63
  64 #endif