Tidying.
[libdcp.git] / src / picture_asset.h
index 9039eceedf8e2304b05c94ff890f7c187f3e1588..6ee3bd24b53662b4b24299b271ef7054f1439899 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
 
     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.
 */
 
-#ifndef LIBDCP_PICTURE_ASSET_H
-#define LIBDCP_PICTURE_ASSET_H
 
 /** @file  src/picture_asset.h
- *  @brief PictureAsset class.
+ *  @brief PictureAsset class
  */
 
+
+#ifndef LIBDCP_PICTURE_ASSET_H
+#define LIBDCP_PICTURE_ASSET_H
+
+
 #include "mxf.h"
 #include "util.h"
 #include "metadata.h"
 
+
 namespace ASDCP {
        namespace JP2K {
                struct PictureDescriptor;
        }
 }
 
-namespace dcp
-{
+
+namespace dcp {
+
 
 class MonoPictureFrame;
 class StereoPictureFrame;
 class PictureAssetWriter;
 
+
 /** @class PictureAsset
- *  @brief An asset made up of JPEG2000 data.
+ *  @brief An asset made up of JPEG2000 data
  */
 class PictureAsset : public Asset, public MXF
 {
 public:
+       /** Load a PictureAsset from a file */
        explicit PictureAsset (boost::filesystem::path file);
-       explicit PictureAsset (Fraction edit_rate);
 
-       virtual boost::shared_ptr<PictureAssetWriter> start_write (
+       /** Create a new PictureAsset with a given edit rate and standard */
+       explicit PictureAsset (Fraction edit_rate, Standard standard);
+
+       virtual std::shared_ptr<PictureAssetWriter> start_write (
                boost::filesystem::path file,
-               Standard standard,
                bool overwrite
                ) = 0;
 
@@ -88,6 +110,8 @@ public:
                return _intrinsic_duration;
        }
 
+       static std::string static_pkl_type (Standard standard);
+
 protected:
        friend class MonoPictureAssetWriter;
        friend class StereoPictureAssetWriter;
@@ -109,7 +133,7 @@ protected:
        /** The total length of this content in video frames.  The amount of
         *  content presented may be less than this.
         */
-       int64_t _intrinsic_duration;
+       int64_t _intrinsic_duration = 0;
        /** picture size in pixels */
        Size _size;
        Fraction _frame_rate;
@@ -122,4 +146,5 @@ private:
 
 }
 
+
 #endif