Various encryption-related stuff.
[libdcp.git] / src / picture_asset.h
index cccea0f33dfaf527f4bcc8e62809e27de04d3456..398f886840834e73e519a787e19ebe3cb28e683d 100644 (file)
 
 */
 
+#ifndef LIBDCP_PICTURE_ASSET_H
+#define LIBDCP_PICTURE_ASSET_H
+
 /** @file  src/picture_asset.h
- *  @brief An asset made up of JPEG2000 files
+ *  @brief An asset made up of JPEG2000 data
  */
 
-#include "asset.h"
+#include <openjpeg.h>
+#include "mxf_asset.h"
+#include "util.h"
+#include "metadata.h"
 
 namespace libdcp
 {
 
-/** @brief An asset made up of JPEG2000 files */
-class PictureAsset : public Asset
+class MonoPictureFrame;        
+class StereoPictureFrame;
+class PictureAssetWriter;
+
+/** @brief An asset made up of JPEG2000 data */
+class PictureAsset : public MXFAsset
 {
 public:
-       /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
+       /** Construct a PictureAsset.
+        *  This class will not write anything to disk in this constructor, but subclasses may.
+        *  
+        *  @param directory Directory where MXF file is.
+        *  @param mxf_name Name of MXF file.
+        */
+       PictureAsset (std::string directory, std::string mxf_name);
+
+       /** Construct a PictureAsset.
+        *  This class will not write anything to disk in this constructor, but subclasses may.
+        *
+        *  @param directory Directory where MXF file is.
+        *  @param mxf_name Name of MXF file.
+        *  @param progress Signal to use to inform of progres, or 0.
+        *  @param fps Video frames per second.
+        *  @param intrinsic_duration Total number of frames in the asset.
+        *  @param size Size of video frame images in pixels.
+        */
+       PictureAsset (
+               std::string directory,
+               std::string mxf_name,
+               boost::signals2::signal<void (float)>* progress,
+               int fps,
+               int intrinsic_duration,
+               Size
+               );
+
+       /** Start a progressive write to this asset.
+        *  @param overwrite true to overwrite an existing MXF file; in this mode, writing can be resumed to a partially-written MXF; false if the
+        *  MXF file does not exist.
+        *  @param metadata MXF metadata to use.
+        */
+       virtual boost::shared_ptr<PictureAssetWriter> start_write (bool overwrite, bool interop, MXFMetadata const & metadata = MXFMetadata ()) = 0;
+       
+       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+
+       Size size () const {
+               return _size;
+       }
+
+       void write_to_cpl (xmlpp::Element *, bool) const;
+
+protected:     
+
+       bool frame_buffer_equals (
+               int frame, EqualityOptions opt, boost::function<void (NoteType, std::string)> note,
+               uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
+               ) const;
+
+       /** picture size in pixels */
+       Size _size;
+
+private:
+       std::string key_type () const;
+       virtual int edit_rate_factor () const = 0;
+};
+
+/** A 2D (monoscopic) picture asset */
+class MonoPictureAsset : public PictureAsset
+{
+public:
+       /** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files.
         *  This may take some time; progress is indicated by emission of the Progress signal.
+        *
         *  @param files Pathnames of JPEG2000 files, in frame order.
         *  @param directory Directory in which to create MXF file.
         *  @param mxf_name Name of MXF file to create.
         *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
-        *  @param width Width of images in pixels.
-        *  @param height Height of images in pixels.
+        *  @param fps Video frames per second.
+        *  @param intrinsic_duration Total number of frames in the asset.
+        *  @param size Size of images in pixels.
         */
-       PictureAsset (
+       MonoPictureAsset (
                std::vector<std::string> const & files,
                std::string directory,
                std::string mxf_name,
-               sigc::signal1<void, float>* progress,
+               boost::signals2::signal<void (float)>* progress,
                int fps,
-               int length,
-               int width,
-               int height
+               int intrinsic_duration,
+               Size size,
+               bool interop,
+               MXFMetadata const & metadata = MXFMetadata ()
                );
 
-       /** Construct a PictureAsset, generating the MXF from the JPEG2000 files.
+       /** Construct a MonoPictureAsset, generating the MXF from the JPEG2000 files.
         *  This may take some time; progress is indicated by emission of the Progress signal.
+        *
         *  @param get_path Functor which returns a JPEG2000 file path for a given frame (frames counted from 0).
         *  @param directory Directory in which to create MXF file.
         *  @param mxf_name Name of MXF file to create.
         *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
-        *  @param width Width of images in pixels.
-        *  @param height Height of images in pixels.
+        *  @param fps Video frames per second.
+        *  @param intrinsic_duration Total number of frames in the asset.
+        *  @param size Size of images in pixels.
         */
-       PictureAsset (
-               sigc::slot<std::string, int> get_path,
+       MonoPictureAsset (
+               boost::function<std::string (int)> get_path,
                std::string directory,
                std::string mxf_name,
-               sigc::signal1<void, float>* progress,
+               boost::signals2::signal<void (float)>* progress,
                int fps,
-               int length,
-               int width,
-               int height
+               int intrinsic_duration,
+               Size size,
+               bool interop,
+               MXFMetadata const & metadata = MXFMetadata ()
                );
 
-       PictureAsset (std::string directory, std::string mxf_name, int fps, int length, int width, int height);
-       
-       /** Write details of this asset to a CPL stream.
-        *  @param s Stream.
+       /** Construct a MonoPictureAsset, reading the MXF from disk.
+        *  @param directory Directory that the MXF is in.
+        *  @param mxf_name The filename of the MXF within `directory'.
         */
-       void write_to_cpl (std::ostream& s) const;
+       MonoPictureAsset (std::string directory, std::string mxf_name);
+
+       /** Construct a MonoPictureAsset for progressive writing using
+        *  start_write() and a MonoPictureAssetWriter.
+        *
+        *  @param directory Directory to put the MXF in.
+        *  @param mxf_name Filename of the MXF within this directory.
+        *  @param fps Video frames per second.
+        *  @param size Size in pixels that the picture frames will be.
+        */
+       MonoPictureAsset (std::string directory, std::string mxf_name, int fps, Size size);
+
+       /** Start a progressive write to a MonoPictureAsset */
+       boost::shared_ptr<PictureAssetWriter> start_write (bool, bool, MXFMetadata const & metadata = MXFMetadata ());
+
+       boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
+       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
 
-       std::list<std::string> equals (boost::shared_ptr<const Asset> other, EqualityFlags flags) const;
-       
 private:
        std::string path_from_list (int f, std::vector<std::string> const & files) const;
-       void construct (sigc::slot<std::string, int>);
-       
-       /** picture width in pixels */
-       int _width;
-       /** picture height in pixels */
-       int _height;
+       void construct (boost::function<std::string (int)>, bool, MXFMetadata const &);
+       std::string cpl_node_name () const;
+       int edit_rate_factor () const;
+};
+
+/** A 3D (stereoscopic) picture asset */       
+class StereoPictureAsset : public PictureAsset
+{
+public:
+       StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int intrinsic_duration);
+
+       /** Construct a StereoPictureAsset for progressive writing using
+        *  start_write() and a StereoPictureAssetWriter.
+        *
+        *  @param directory Directory to put the MXF in.
+        *  @param mxf_name Filename of the MXF within this directory.
+        *  @param fps Video frames per second.
+        *  @param size Size in pixels that the picture frames will be.
+        */
+       StereoPictureAsset (std::string directory, std::string mxf_name, int fps, Size size);
+
+       /** Start a progressive write to a StereoPictureAsset */
+       boost::shared_ptr<PictureAssetWriter> start_write (bool, bool, MXFMetadata const & metadata = MXFMetadata ());
+
+       boost::shared_ptr<const StereoPictureFrame> get_frame (int n) const;
+       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+
+private:
+       std::string cpl_node_name () const;
+       std::pair<std::string, std::string> cpl_node_attribute (bool) const;
+       int edit_rate_factor () const;
 };
+       
 
 }
+
+#endif