diff options
Diffstat (limited to 'src/sound_frame.h')
| -rw-r--r-- | src/sound_frame.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/sound_frame.h b/src/sound_frame.h index e7b13885..de58a034 100644 --- a/src/sound_frame.h +++ b/src/sound_frame.h @@ -17,6 +17,10 @@ */ +/** @file src/sound_frame.h + * @brief SoundFrame class. + */ + #ifndef LIBDCP_SOUND_FRAME_H #define LIBDCP_SOUND_FRAME_H @@ -33,16 +37,20 @@ namespace ASDCP { namespace dcp { +/** @class SoundFrame + * @brief One ‘frame’ of sound data from a MXF. + */ class SoundFrame : public boost::noncopyable { public: - SoundFrame (std::string mxf_path, int n, ASDCP::AESDecContext *); + SoundFrame (boost::filesystem::path mxf_path, int n, ASDCP::AESDecContext *); ~SoundFrame (); uint8_t const * data () const; int size () const; private: + /** a buffer to hold the frame */ ASDCP::PCM::FrameBuffer* _buffer; }; |
