2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 libdcp is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
35 /** @file src/sound_asset.h
36 * @brief SoundAsset class
40 #ifndef LIBDCP_SOUND_ASSET_H
41 #define LIBDCP_SOUND_ASSET_H
46 #include "language_tag.h"
48 #include "sound_frame.h"
49 #include "sound_asset_reader.h"
57 extern std::shared_ptr<dcp::SoundAsset> simple_sound (
58 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
66 class SoundAssetWriter;
70 * @brief Representation of a sound asset
72 class SoundAsset : public Asset, public MXF
75 explicit SoundAsset (boost::filesystem::path file);
76 SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
78 enum class AtmosSync {
83 enum class MCASubDescriptors {
88 /** @param extra_active_channels list of channels that are active in the asset, other than the basic 5.1
89 * which are assumed always to be active.
91 std::shared_ptr<SoundAssetWriter> start_write(
92 boost::filesystem::path file,
93 std::vector<dcp::Channel> extra_active_channels,
95 MCASubDescriptors mca_subdescriptors
98 std::shared_ptr<SoundAssetReader> start_read () const;
101 std::shared_ptr<const Asset> other,
102 EqualityOptions const& opt,
106 /** @return number of channels in the MXF */
107 int channels () const {
111 /** @return An estimate of the number of channels that are actually in use */
112 int active_channels() const;
114 /** @return sampling rate in Hz */
115 int sampling_rate () const {
116 return _sampling_rate;
119 Fraction edit_rate () const {
123 int64_t intrinsic_duration () const {
124 return _intrinsic_duration;
127 boost::optional<std::string> language () const {
131 static bool valid_mxf (boost::filesystem::path);
132 static std::string static_pkl_type (Standard standard);
135 friend class SoundAssetWriter;
136 friend std::shared_ptr<dcp::SoundAsset> (::simple_sound) (
137 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
140 std::string pkl_type (Standard standard) const override {
141 return static_pkl_type (standard);
145 /** The total length of this content in video frames. The amount of
146 * content presented may be less than this.
148 int64_t _intrinsic_duration = 0;
149 int _channels = 0; ///< number of channels in the MXF
150 boost::optional<int> _active_channels; ///< estimate of the number of active channels
151 int _sampling_rate = 0; ///< sampling rate in Hz
152 boost::optional<std::string> _language;