Cleanup: pass EqualityOptions as const&

[libdcp.git] / src / sound_asset.h

diff --git a/src/sound_asset.h b/src/sound_asset.h
index b3e5fec3cf6f689afa13163b9d510a7f97e7ad6b..125fe94b67322111b1d12389ade37cf47485645f 100644 (file)
--- a/src/sound_asset.h
+++ b/src/sound_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,23 +31,40 @@
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/sound_asset.h
  *  @brief SoundAsset class
  */
 
+
 #ifndef LIBDCP_SOUND_ASSET_H
 #define LIBDCP_SOUND_ASSET_H
 
+
 #include "mxf.h"
 #include "types.h"
+#include "language_tag.h"
 #include "metadata.h"
+#include "sound_frame.h"
+#include "sound_asset_reader.h"
+
+
+namespace dcp {
+       class SoundAsset;
+}
+
+
+extern std::shared_ptr<dcp::SoundAsset> simple_sound (
+       boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language, int frames, int sample_rate, boost::optional<dcp::Key>, int channels
+       );
+
 
 namespace dcp
 {
 
-class SoundFrame;
+
 class SoundAssetWriter;
-class SoundAssetReader;
+
 
 /** @class SoundAsset
  *  @brief Representation of a sound asset
@@ -56,22 +73,44 @@ class SoundAsset : public Asset, public MXF
 {
 public:
        explicit SoundAsset (boost::filesystem::path file);
-       SoundAsset (Fraction edit_rate, int sampling_rate, int channels);
+       SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
 
-       boost::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, Standard standard, ChannelAssignment assign);
-       boost::shared_ptr<SoundAssetReader> start_read () const;
+       enum class AtmosSync {
+               ENABLED,
+               DISABLED
+       };
+
+       enum class MCASubDescriptors {
+               ENABLED,
+               DISABLED
+       };
+
+       /** @param extra_active_channels list of channels that are active in the asset, other than the basic 5.1
+        *  which are assumed always to be active.
+        */
+       std::shared_ptr<SoundAssetWriter> start_write(
+               boost::filesystem::path file,
+               std::vector<dcp::Channel> extra_active_channels,
+               AtmosSync atmos_sync,
+               MCASubDescriptors mca_subdescriptors
+               );
+
+       std::shared_ptr<SoundAssetReader> 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;
 
-       /** @return number of channels */
+       /** @return number of channels in the MXF */
        int channels () const {
                return _channels;
        }
 
+       /** @return An estimate of the number of channels that are actually in use */
+       int active_channels() const;
+
        /** @return sampling rate in Hz */
        int sampling_rate () const {
                return _sampling_rate;
@@ -85,22 +124,36 @@ public:
                return _intrinsic_duration;
        }
 
+       boost::optional<std::string> language () const {
+               return _language;
+       }
+
        static bool valid_mxf (boost::filesystem::path);
+       static std::string static_pkl_type (Standard standard);
 
 private:
        friend class SoundAssetWriter;
+       friend std::shared_ptr<dcp::SoundAsset> (::simple_sound) (
+               boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language, int frames, int sample_rate, boost::optional<dcp::Key>, int channels
+               );
 
-       std::string pkl_type (Standard standard) const;
+       std::string pkl_type (Standard standard) const override {
+               return static_pkl_type (standard);
+       }
 
        Fraction _edit_rate;
        /** The total length of this content in video frames.  The amount of
         *  content presented may be less than this.
         */
-       int64_t _intrinsic_duration;
-       int _channels;      ///< number of channels
-       int _sampling_rate; ///< sampling rate in Hz
+       int64_t _intrinsic_duration = 0;
+       int _channels = 0;                     ///< number of channels in the MXF
+       boost::optional<int> _active_channels; ///< estimate of the number of active channels
+       int _sampling_rate = 0;                ///< sampling rate in Hz
+       boost::optional<std::string> _language;
 };
 
+
 }
 
+
 #endif