Add OK note when PKL and CPL annotation texts match.

[libdcp.git] / src / mono_picture_asset.h

diff --git a/src/mono_picture_asset.h b/src/mono_picture_asset.h
index c2079bedc29d9095e17bdad759e848d94498693c..9658dcf644bd8d70b6b144edb043559c7e82f8d3 100644 (file)
--- a/src/mono_picture_asset.h
+++ b/src/mono_picture_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -15,20 +15,44 @@
 
     You should have received a copy of the GNU General Public License
     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
+/** @file  src/mono_picture_asset.cc
+ *  @brief MonoPictureAsset class
+ */
+
+
 #ifndef LIBDCP_MONO_PICTURE_ASSET_H
 #define LIBDCP_MONO_PICTURE_ASSET_H
 
+
 #include "picture_asset.h"
+#include "mono_picture_asset_reader.h"
+
 
 namespace dcp {
 
+
 class MonoPictureAssetWriter;
-class MonoPictureAssetReader;
+
 
 /** @class MonoPictureAsset
- *  @brief A 2D (monoscopic) picture asset.
+ *  @brief A 2D (monoscopic) picture asset
  */
 class MonoPictureAsset : public PictureAsset
 {
@@ -40,23 +64,31 @@ public:
 
        /** Create a MonoPictureAsset with a given edit rate.
         *  @param edit_rate Edit rate (i.e. frame rate) in frames per second.
+        *  @param standard DCP standard (INTEROP or SMPTE).
         */
-       explicit MonoPictureAsset (Fraction edit_rate);
+       MonoPictureAsset(Fraction edit_rate, Standard standard);
 
-       /** Start a progressive write to a MonoPictureAsset */
-       boost::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path, Standard standard, bool);
-       boost::shared_ptr<MonoPictureAssetReader> start_read () const;
+       /** Start a progressive write to a MonoPictureAsset.
+        *  @path file File to write to.
+        *  @path behaviour OVERWRITE_EXISTING to overwrite and potentially add to an existing file
+        *  (after a write previously failed), MAKE_NEW to create a new file.
+        *  If in doubt, use MAKE_NEW here.
+        */
+       std::shared_ptr<PictureAssetWriter> start_write(boost::filesystem::path file, Behaviour behaviour) override;
+       std::shared_ptr<MonoPictureAssetReader> start_read () const;
 
        bool equals (
-               boost::shared_ptr<const Asset> other,
-               EqualityOptions opt,
+               std::shared_ptr<const Asset> other,
+               EqualityOptions const& opt,
                NoteHandler note
-               ) const;
+               ) const override;
 
 private:
        std::string cpl_node_name () const;
 };
 
+
 }
 
+
 #endif