Use MXFAsset::_interop to decide on whether to write asset XML as Interop or SMPTE.
[libdcp.git] / src / picture_asset.h
index d2c6f656a546662a5c3b2bd26eea4ab8c492c46c..b8dab05205e1f17542e934dbde8d25dfdebfbfc7 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 <openjpeg.h>
 #include "mxf_asset.h"
 #include "util.h"
+#include "metadata.h"
+
+namespace ASDCP {
+       namespace JP2K {
+               class PictureDescriptor;
+       }
+}
 
 namespace libdcp
 {
 
 class MonoPictureFrame;        
-class StereoPictureFrame;      
+class StereoPictureFrame;
+class PictureAssetWriter;
 
-/** @brief An asset made up of JPEG2000 files */
+/** @brief An asset made up of JPEG2000 data */
 class PictureAsset : public MXFAsset
 {
 public:
-       PictureAsset (std::string directory, std::string mxf_name, boost::signals2::signal<void (float)>* progress, int fps, int intrinsic_duration);
-       
-       /** Write details of this asset to a CPL stream.
-        *  @param s Stream.
+       /** Construct a PictureAsset.
+        *  
+        *  @param directory Directory where MXF file is.
+        *  @param mxf_name Name of MXF file.
         */
-       void write_to_cpl (std::ostream& s) const;
-
-       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
+       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.
+        */
+       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 set_size (Size s) {
+               _size = s;
+       }
+
+       void write_to_cpl (xmlpp::Element *) const;
+
 protected:     
 
        bool frame_buffer_equals (
-               int frame, EqualityOptions opt, std::list<std::string>& notes,
+               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;
 
+       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;
-};
-
-/** A 2D (monoscopic) picture asset */
-class MonoPictureAsset : public PictureAsset
-{
-public:
-       /** Construct a PictureAsset, 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 intrinsic_duration Length of the whole asset in frames.
-        *  @param size Size of images in pixels.
-        */
-       MonoPictureAsset (
-               std::vector<std::string> const & files,
-               std::string directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               Size size
-               );
-
-       /** Construct a PictureAsset, 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 intrinsic_duration Length of the whole asset in frames.
-        *  @param size Size of images in pixels.
-        */
-       MonoPictureAsset (
-               boost::function<std::string (int)> get_path,
-               std::string directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               Size size
-               );
-
-       MonoPictureAsset (std::string directory, std::string mxf_name, int fps, int intrinsic_duration);
-       
-       boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
-       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
 
 private:
-       std::string path_from_list (int f, std::vector<std::string> const & files) const;
-       void construct (boost::function<std::string (int)>);
-};
-
-/** A 3D (stereoscopic) picture asset */       
-class StereoPictureAsset : public PictureAsset
-{
-public:
-       StereoPictureAsset (std::string directory, std::string mxf_name, int fps, int intrinsic_duration);
-       
-       boost::shared_ptr<const StereoPictureFrame> get_frame (int n) const;
-       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
+       std::string key_type () const;
+       virtual int edit_rate_factor () const = 0;
 };
        
 
 }
+
+#endif