Improve a comment.

[libdcp.git] / src / mono_picture_asset.h

diff --git a/src/mono_picture_asset.h b/src/mono_picture_asset.h
index 6ade93bd2553cab287aa09fa68dc83f9013daad0..505d3c20923a9f2292308d2847ddab8e2846ad93 100644 (file)
--- a/src/mono_picture_asset.h
+++ b/src/mono_picture_asset.h
@@ -1,52 +1,93 @@
 /*
-    Copyright (C) 2012-2013 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    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 libdcp {
 
-/** A 2D (monoscopic) picture asset */
+namespace dcp {
+
+
+class MonoPictureAssetWriter;
+
+
+/** @class MonoPictureAsset
+ *  @brief A 2D (monoscopic) picture asset
+ */
 class MonoPictureAsset : public PictureAsset
 {
 public:
-       MonoPictureAsset (boost::filesystem::path directory, std::string mxf_name);
+       /** Create a MonoPictureAsset by reading a file.
+        *  @param file Asset file to read.
+        */
+       explicit MonoPictureAsset (boost::filesystem::path file);
 
-       void read ();
-       void create (std::vector<boost::filesystem::path> const & files);
-       void create (boost::function<boost::filesystem::path (int)> get_path);
+       /** 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, Standard standard);
 
-       /** Start a progressive write to a MonoPictureAsset */
-       boost::shared_ptr<PictureAssetWriter> start_write (bool);
+       /** Start a progressive write to a MonoPictureAsset.
+        *  @path file File to write to.
+        *  @path overwrite true to overwrite an existing file; for use when continuing a write which
+        *  previously failed.  If in doubt, use false here.
+        */
+       std::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path file, bool overwrite);
+       std::shared_ptr<MonoPictureAssetReader> start_read () 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;
+       bool equals (
+               std::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               NoteHandler 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