Comments / tweaks.
[libdcp.git] / 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 <stdint.h>
29 #include <string>
30
31 namespace ASDCP {
32         namespace PCM {
33                 class FrameBuffer;
34         }
35         class AESDecContext;
36 }
37
38 namespace dcp {
39
40 /** @class SoundFrame
41  *  @brief One &lsquo;frame&rsquo; of sound data from a MXF.
42  */
43 class SoundFrame : public boost::noncopyable
44 {
45 public:
46         SoundFrame (boost::filesystem::path mxf_path, int n, ASDCP::AESDecContext *);
47         ~SoundFrame ();
48
49         uint8_t const * data () const;
50         int size () const;
51
52 private:
53         /** a buffer to hold the frame */
54         ASDCP::PCM::FrameBuffer* _buffer;
55 };
56
57 }
58
59 #endif