Make similar changes to the previous commit for _xml_id.
[libdcp.git] / src / mono_picture_frame.h
index 0eedfb95033d1030fbefe504fd0a5dfbf3ac7549..95b0d111d3ad22b6fc47655c0f431b7ffc5ea032 100644 (file)
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 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.
 */
 
-#include <string>
-#include <stdint.h>
-#include <boost/shared_ptr.hpp>
+
+/** @file  src/mono_picture_frame.h
+ *  @brief MonoPictureFrame class
+ */
+
+
+#ifndef LIBDCP_MONO_PICTURE_FRAME_H
+#define LIBDCP_MONO_PICTURE_FRAME_H
+
+
+#include "asset_reader.h"
 #include "types.h"
+#include <boost/filesystem.hpp>
+#include <boost/optional.hpp>
+#include <memory>
+#include <stdint.h>
+#include <string>
+
 
 namespace ASDCP {
        namespace JP2K {
                class FrameBuffer;
+               class MXFReader;
        }
        class AESDecContext;
 }
 
-namespace libdcp {
 
-class ARGBFrame;
+namespace dcp {
+
+
+class OpenJPEGImage;
 
-/** 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 Data
 {
 public:
-       MonoPictureFrame (boost::filesystem::path mxf_path, int n, ASDCP::AESDecContext *);
-       ~MonoPictureFrame ();
+       /** Make a picture frame from a JPEG2000 file.
+        *  @param path Path to JPEG2000 file.
+        */
+       explicit MonoPictureFrame (boost::filesystem::path path);
+       MonoPictureFrame (uint8_t const * data, int size);
+
+       MonoPictureFrame (MonoPictureFrame const&) = delete;
+       MonoPictureFrame& operator= (MonoPictureFrame const&) = delete;
+
+       /** @param reduce a factor by which to reduce the resolution
+        *  of the image, expressed as a power of two (pass 0 for no
+        *  reduction).
+        */
+       std::shared_ptr<OpenJPEGImage> xyz_image (int reduce = 0) const;
 
-       boost::shared_ptr<ARGBFrame> argb_frame (int reduce = 0, float srgb_gamma = 2.4) const;
-       uint8_t const * j2k_data () const;
-       int j2k_size () const;
+       /** @return Pointer to JPEG2000 data */
+       uint8_t const * data () const override;
+
+       /** @return Pointer to JPEG2000 data */
+       uint8_t* data () override;
+
+       /** @return Size of JPEG2000 data in bytes */
+       int size () const override;
 
 private:
-       ASDCP::JP2K::FrameBuffer* _buffer;
+       /* XXX: this is a bit of a shame, but I tried friend MonoPictureAssetReader and it's
+          rejected by some (seemingly older) GCCs.
+       */
+       friend class AssetReader<ASDCP::JP2K::MXFReader, MonoPictureFrame>;
+
+       MonoPictureFrame (ASDCP::JP2K::MXFReader* reader, int n, std::shared_ptr<DecryptionContext>);
+
+       std::shared_ptr<ASDCP::JP2K::FrameBuffer> _buffer;
 };
 
 }
+
+#endif