Support reading of encrypted subtitles.
[libdcp.git] / src / mono_picture_frame.h
index 83b80c5cb5c246fc95c090ea10ffa6659282f840..cb4afd6f5ffc1e7b339b0cadff2359899b4d3c54 100644 (file)
@@ -1,50 +1,82 @@
 /*
-    Copyright (C) 2012-2013 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/mono_picture_frame.h
+ *  @brief MonoPictureFrame class.
+ */
+
+#include "types.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/noncopyable.hpp>
+#include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
 #include <string>
 #include <stdint.h>
-#include <boost/shared_ptr.hpp>
-#include "types.h"
 
 namespace ASDCP {
        namespace JP2K {
                class FrameBuffer;
+               class MXFReader;
        }
        class AESDecContext;
 }
 
-namespace libdcp {
+namespace dcp {
 
-class ARGBFrame;
+class OpenJPEGImage;
+class DecryptionContext;
 
-/** A single frame of a 2D (monoscopic) picture asset */       
-class MonoPictureFrame
+/** @class MonoPictureFrame
+ *  @brief A single frame of a 2D (monoscopic) picture asset.
+ */
+class MonoPictureFrame : public boost::noncopyable
 {
 public:
-       MonoPictureFrame (std::string mxf_path, int n, ASDCP::AESDecContext *);
+       explicit MonoPictureFrame (boost::filesystem::path path);
+       MonoPictureFrame (uint8_t const * data, int size);
        ~MonoPictureFrame ();
 
-       boost::shared_ptr<ARGBFrame> argb_frame (int reduce = 0, float srgb_gamma = 2.4) const;
+       boost::shared_ptr<OpenJPEGImage> xyz_image (int reduce = 0) const;
+
        uint8_t const * j2k_data () const;
+       uint8_t* j2k_data ();
        int j2k_size () const;
 
 private:
+       friend class MonoPictureAssetReader;
+
+       MonoPictureFrame (ASDCP::JP2K::MXFReader* reader, int n, boost::shared_ptr<DecryptionContext>);
+
        ASDCP::JP2K::FrameBuffer* _buffer;
 };