No-op: whitespace.
[libdcp.git] / src / mono_picture_asset.h
index ae2df4d23e525397a4b1b3f1dc030223eb8033db..a10eada00f1261548ce83e6d4e92c8ea21f9a789 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include "picture_asset.h"
 
-namespace libdcp {
+namespace dcp {
 
-/** A 2D (monoscopic) picture asset */
+class MonoPictureAssetWriter;
+
+/** @class MonoPictureAsset
+ *  @brief A 2D (monoscopic) picture asset.
+ */
 class MonoPictureAsset : public PictureAsset
 {
 public:
-       MonoPictureAsset (boost::filesystem::path directory, boost::filesystem::path mxf_name);
-
-       void read ();
-
-       /** 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)
+       /** Create a MonoPictureAsset by reading a file.
+        *  @param file Asset file to read.
         */
-       void create (std::vector<boost::filesystem::path> const & files);
+       MonoPictureAsset (boost::filesystem::path file);
 
-       /** 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)
+       /** Create a MonoPictureAsset with a given edit rate.
+        *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
         */
-       void create (boost::function<boost::filesystem::path (int)> get_path);
+       MonoPictureAsset (Fraction edit_rate);
 
        /** Start a progressive write to a MonoPictureAsset */
-       boost::shared_ptr<PictureAssetWriter> start_write (bool);
+       boost::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path, Standard standard, bool);
+
+       bool equals (
+               boost::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               NoteHandler note
+               ) const;
 
        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;
 };
 
-}      
+}
 
 #endif