More consistent error message in a subtitle exception.

[libdcp.git] / src / sound_frame.h

diff --git a/src/sound_frame.h b/src/sound_frame.h
index ad4f9604d2f074094c8de20b290bc554853e9507..4c061fdc7ed5b1bcb654a0479107a182de5d33bd 100644 (file)
--- a/src/sound_frame.h
+++ b/src/sound_frame.h
@@ -1,46 +1,75 @@
 /*
-    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
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
 
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+/** @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 <boost/filesystem.hpp>
 #include <stdint.h>
+#include <string>
 
 namespace ASDCP {
        namespace PCM {
                class FrameBuffer;
+               class MXFReader;
        }
+       class AESDecContext;
 }
 
-namespace libdcp {
+namespace dcp {
 
-class SoundFrame
+/** @class SoundFrame
+ *  @brief One &lsquo;frame&rsquo; of sound data from a SoundAsset.
+ */
+class SoundFrame : public boost::noncopyable
 {
 public:
-       SoundFrame (std::string mxf_path, int n);
        ~SoundFrame ();
 
        uint8_t const * data () const;
        int size () const;
 
 private:
+       friend class SoundAssetReader;
+
+       SoundFrame (ASDCP::PCM::MXFReader* reader, int n, ASDCP::AESDecContext *);
+
+       /** a buffer to hold the frame */
        ASDCP::PCM::FrameBuffer* _buffer;
 };