src/sound_asset.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   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.
  10
  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.
  15
  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/>.
  18
  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
  23     including the two.
  24
  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.
  32 */
  33
  34
  35 /** @file  src/sound_asset.h
  36  *  @brief SoundAsset class
  37  */
  38
  39
  40 #ifndef LIBDCP_SOUND_ASSET_H
  41 #define LIBDCP_SOUND_ASSET_H
  42
  43
  44 #include "mxf.h"
  45 #include "language_tag.h"
  46 #include "metadata.h"
  47 #include "sound_frame.h"
  48 #include "sound_asset_reader.h"
  49
  50
  51 namespace dcp {
  52         class SoundAsset;
  53 }
  54
  55
  56 extern std::shared_ptr<dcp::SoundAsset> simple_sound (
  57         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
  58         );
  59
  60
  61 namespace dcp
  62 {
  63
  64
  65 class SoundAssetWriter;
  66
  67
  68 /** @class SoundAsset
  69  *  @brief Representation of a sound asset
  70  */
  71 class SoundAsset : public Asset, public MXF
  72 {
  73 public:
  74         explicit SoundAsset (boost::filesystem::path file);
  75         SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
  76
  77         enum class AtmosSync {
  78                 ENABLED,
  79                 DISABLED
  80         };
  81
  82         enum class MCASubDescriptors {
  83                 ENABLED,
  84                 DISABLED
  85         };
  86
  87         /** @param extra_active_channels list of channels that are active in the asset, other than the basic 5.1
  88          *  which are assumed always to be active.
  89          */
  90         std::shared_ptr<SoundAssetWriter> start_write(
  91                 boost::filesystem::path file,
  92                 std::vector<dcp::Channel> extra_active_channels,
  93                 AtmosSync atmos_sync,
  94                 MCASubDescriptors mca_subdescriptors
  95                 );
  96
  97         std::shared_ptr<SoundAssetReader> start_read () const;
  98
  99         bool equals (
 100                 std::shared_ptr<const Asset> other,
 101                 EqualityOptions const& opt,
 102                 NoteHandler note
 103                 ) const override;
 104
 105         /** @return number of channels in the MXF */
 106         int channels () const {
 107                 return _channels;
 108         }
 109
 110         /** @return An estimate of the number of channels that are actually in use */
 111         int active_channels() const;
 112
 113         /** @return sampling rate in Hz */
 114         int sampling_rate () const {
 115                 return _sampling_rate;
 116         }
 117
 118         Fraction edit_rate () const {
 119                 return _edit_rate;
 120         }
 121
 122         int64_t intrinsic_duration () const {
 123                 return _intrinsic_duration;
 124         }
 125
 126         boost::optional<std::string> language () const {
 127                 return _language;
 128         }
 129
 130         static bool valid_mxf (boost::filesystem::path);
 131         static std::string static_pkl_type (Standard standard);
 132
 133 private:
 134         friend class SoundAssetWriter;
 135         friend std::shared_ptr<dcp::SoundAsset> (::simple_sound) (
 136                 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
 137                 );
 138
 139         std::string pkl_type (Standard standard) const override {
 140                 return static_pkl_type (standard);
 141         }
 142
 143         Fraction _edit_rate;
 144         /** The total length of this content in video frames.  The amount of
 145          *  content presented may be less than this.
 146          */
 147         int64_t _intrinsic_duration = 0;
 148         int _channels = 0;                     ///< number of channels in the MXF
 149         boost::optional<int> _active_channels; ///< estimate of the number of active channels
 150         int _sampling_rate = 0;                ///< sampling rate in Hz
 151         boost::optional<std::string> _language;
 152 };
 153
 154
 155 }
 156
 157
 158 #endif