Tidying.

[libdcp.git] / src / stereo_picture_asset.h

diff --git a/src/stereo_picture_asset.h b/src/stereo_picture_asset.h
index 4e56989d57f5cc87fbfbfda94929708b1ed993ac..897ed4a4d0eff879cd32ef82a3118a2e4019d0ed 100644 (file)
--- a/src/stereo_picture_asset.h
+++ b/src/stereo_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,35 +15,61 @@
 
     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/stereo_picture_asset.h
+ *  @brief StereoPictureAsset class
+ */
+
+
 #ifndef LIBDCP_STEREO_PICTURE_ASSET_H
 #define LIBDCP_STEREO_PICTURE_ASSET_H
 
+
 #include "picture_asset.h"
+#include "stereo_picture_asset_reader.h"
+
 
 namespace dcp {
 
-class StereoPictureAssetReader;
 
-/** A 3D (stereoscopic) picture asset */
+/** @class StereoPictureAsset
+ *  @brief A 3D (stereoscopic) picture asset
+ */
 class StereoPictureAsset : public PictureAsset
 {
 public:
-       StereoPictureAsset (boost::filesystem::path file);
-       StereoPictureAsset (Fraction edit_rate);
+       explicit StereoPictureAsset (boost::filesystem::path file);
+       explicit StereoPictureAsset (Fraction edit_rate, Standard standard);
 
        /** Start a progressive write to a StereoPictureAsset */
-       boost::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path file, Standard, bool);
-       boost::shared_ptr<StereoPictureAssetReader> start_read () const;
+       std::shared_ptr<PictureAssetWriter> start_write (boost::filesystem::path file, bool);
+       std::shared_ptr<StereoPictureAssetReader> start_read () const;
 
        bool equals (
-               boost::shared_ptr<const Asset> other,
+               std::shared_ptr<const Asset> other,
                EqualityOptions opt,
                NoteHandler note
                ) const;
 };
 
+
 }
 
+
 #endif