Comments / tweaks.

[libdcp.git] / src / sound_frame.h

diff --git a/src/sound_frame.h b/src/sound_frame.h
index 9cb8aa0d77f17c0406d7ee69307f829f120c1810..de58a034e3fd46cd10f53721d1f6a45006380d4b 100644 (file)
--- a/src/sound_frame.h
+++ b/src/sound_frame.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,30 +17,40 @@
 
 */
 
+/** @file  src/sound_frame.h
+ *  @brief SoundFrame class.
+ */
+
 #ifndef LIBDCP_SOUND_FRAME_H
 #define LIBDCP_SOUND_FRAME_H
 
-#include <string>
+#include <boost/noncopyable.hpp>
 #include <stdint.h>
+#include <string>
 
 namespace ASDCP {
        namespace PCM {
                class FrameBuffer;
        }
+       class AESDecContext;
 }
 
-namespace libdcp {
+namespace dcp {
 
-class SoundFrame
+/** @class SoundFrame
+ *  @brief One &lsquo;frame&rsquo; 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;
 };