Use MXFAsset::_interop to decide on whether to write asset XML as Interop or SMPTE.
[libdcp.git] / src / picture_asset.h
index 495c6647ebc89cf94fbe295448f3decf9fcc49a6..b8dab05205e1f17542e934dbde8d25dfdebfbfc7 100644 (file)
 #include "util.h"
 #include "metadata.h"
 
+namespace ASDCP {
+       namespace JP2K {
+               class PictureDescriptor;
+       }
+}
+
 namespace libdcp
 {
 
@@ -41,46 +47,36 @@ class PictureAsset : public MXFAsset
 {
 public:
        /** 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 (boost::filesystem::path 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 (
-               boost::filesystem::path directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               Size
-               );
+       PictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
 
        /** Start a progressive write to this asset.
+        *  The following parameters must be set up (if required) before calling this:
+        *      Interop mode (set_interop)
+        *      Edit rate    (set_edit_rate)
+        *      MXF Metadata (set_metadata)
+        *      
         *  @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;
+       virtual boost::shared_ptr<PictureAssetWriter> start_write (bool overwrite) = 0;
 
+       virtual void read () = 0;
+       virtual void create (std::vector<boost::filesystem::path> const &) {}
+       virtual void create (boost::function<boost::filesystem::path (int)>) {}
+       
        Size size () const {
                return _size;
        }
 
-       void write_to_cpl (xmlpp::Element *, bool) const;
+       void set_size (Size s) {
+               _size = s;
+       }
+
+       void write_to_cpl (xmlpp::Element *) const;
 
 protected:     
 
@@ -89,6 +85,10 @@ protected:
                uint8_t const * data_A, unsigned int size_A, uint8_t const * data_B, unsigned int size_B
                ) const;
 
+       bool descriptor_equals (
+               ASDCP::JP2K::PictureDescriptor const & a, ASDCP::JP2K::PictureDescriptor const & b, boost::function<void (NoteType, std::string)>
+               ) const;
+
        /** picture size in pixels */
        Size _size;
 
@@ -96,113 +96,6 @@ 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 Video frames per second.
-        *  @param intrinsic_duration Total number of frames in the asset.
-        *  @param size Size of images in pixels.
-        */
-       MonoPictureAsset (
-               std::vector<boost::filesystem::path> const & files,
-               boost::filesystem::path directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               Size size,
-               bool interop,
-               MXFMetadata const & metadata = MXFMetadata ()
-               );
-
-       /** 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 Video frames per second.
-        *  @param intrinsic_duration Total number of frames in the asset.
-        *  @param size Size of images in pixels.
-        */
-       MonoPictureAsset (
-               boost::function<boost::filesystem::path (int)> get_path,
-               boost::filesystem::path directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               Size size,
-               bool interop,
-               MXFMetadata const & metadata = MXFMetadata ()
-               );
-
-       /** 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'.
-        */
-       MonoPictureAsset (boost::filesystem::path 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 (boost::filesystem::path 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;
-
-private:
-       boost::filesystem::path path_from_list (int f, std::vector<boost::filesystem::path> const & files) const;
-       void construct (boost::function<boost::filesystem::path (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 (boost::filesystem::path 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 (boost::filesystem::path 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;
-};
        
 
 }