Various work.

[libdcp.git] / src / mono_picture_mxf.h

diff --git a/src/mono_picture_mxf.h b/src/mono_picture_mxf.h
index 029ccce503c219d0895cc95eff6232eba62f2255..8c8ee53123c322df94fe5b7beee43db5c5ba25b8 100644 (file)
--- a/src/mono_picture_mxf.h
+++ b/src/mono_picture_mxf.h
@@ -24,23 +24,29 @@
 
 namespace dcp {
 
-/** A 2D (monoscopic) picture asset */
+/** @class MonoPictureMXF
+ *  @brief A 2D (monoscopic) picture MXF.
+ */
 class MonoPictureMXF : public PictureMXF
 {
 public:
-       MonoPictureMXF (boost::filesystem::path directory, boost::filesystem::path mxf_name);
+       /** Create a MonoPictureMXF by reading a file.
+        *  @param file MXF file to read.
+        */
+       MonoPictureMXF (boost::filesystem::path file);
 
-       void read ();
+       /** Create a MonoPictureMXF with a given edit rate.
+        *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
+        */
+       MonoPictureMXF (int edit_rate);
 
        /** Start a progressive write to a MonoPictureMXF */
-       boost::shared_ptr<PictureMXFWriter> start_write (bool);
+       boost::shared_ptr<PictureMXFWriter> start_write (boost::filesystem::path, bool);
 
        boost::shared_ptr<const MonoPictureFrame> get_frame (int n) const;
-       bool equals (boost::shared_ptr<const ContentAsset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+       bool equals (boost::shared_ptr<const Content> 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;
 };