Rename ReelMXF -> ReelFileAsset.
[libdcp.git] / src / atmos_asset.h
index 602beb317ce94afea0cfd4c8cbf2d69fff517dcd..7ee55d922223b8f144ae5690255f62898a96800b 100644 (file)
@@ -1,36 +1,81 @@
 /*
-    Copyright (C) 2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2016-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/atmos_asset.h
+ *  @brief AtmosAsset class
+ */
+
+
 #ifndef LIBDCP_ATMOS_ASSET_H
 #define LIBDCP_ATMOS_ASSET_H
 
+
 #include "asset.h"
 #include "mxf.h"
+#include "atmos_asset_reader.h"
+
 
 namespace dcp {
 
+
+class AtmosAssetWriter;
+
+
+/** @class AtmosAsset
+ *  @brief An asset of Dolby ATMOS sound data
+ */
 class AtmosAsset : public Asset, public MXF
 {
 public:
-       AtmosAsset (boost::filesystem::path file);
+       AtmosAsset (Fraction edit_rate, int first_frame, int max_channel_count, int max_object_count, int atmos_version);
+       explicit AtmosAsset (boost::filesystem::path file);
+
+       std::shared_ptr<AtmosAssetWriter> start_write (boost::filesystem::path file);
+       std::shared_ptr<AtmosAssetReader> start_read () const;
 
-       std::string pkl_type (Standard) const;
+       static std::string static_pkl_type (Standard);
+       std::string pkl_type (Standard s) const {
+               return static_pkl_type (s);
+       }
+
+       Fraction edit_rate () const {
+               return _edit_rate;
+       }
+
+       int64_t intrinsic_duration () const {
+               return _intrinsic_duration;
+       }
 
        /** @return frame number of the frame to align with the FFOA of the picture track */
        int first_frame () const {
@@ -47,12 +92,28 @@ public:
                return _max_object_count;
        }
 
+       std::string atmos_id () const {
+               return _atmos_id;
+       }
+
+       int atmos_version () const {
+               return _atmos_version;
+       }
+
 private:
-       int _first_frame;
-       int _max_channel_count;
-       int _max_object_count;
+       friend class AtmosAssetWriter;
+
+       Fraction _edit_rate;
+       int64_t _intrinsic_duration = 0;
+       int _first_frame = 0;
+       int _max_channel_count = 0;
+       int _max_object_count = 0;
+       std::string _atmos_id;
+       int _atmos_version = 0;
 };
 
+
 }
 
+
 #endif