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 "types.h"
  46 #include "language_tag.h"
  47 #include "metadata.h"
  48 #include "sound_frame.h"
  49 #include "sound_asset_reader.h"
  50
  51
  52 namespace dcp {
  53         class SoundAsset;
  54 }
  55
  56
  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
  59         );
  60
  61
  62 namespace dcp
  63 {
  64
  65
  66 class SoundAssetWriter;
  67
  68
  69 /** @class SoundAsset
  70  *  @brief Representation of a sound asset
  71  */
  72 class SoundAsset : public Asset, public MXF
  73 {
  74 public:
  75         explicit SoundAsset (boost::filesystem::path file);
  76         SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
  77
  78         std::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, std::vector<Channel> active_channels, bool atmos_sync = false);
  79         std::shared_ptr<SoundAssetReader> start_read () const;
  80
  81         bool equals (
  82                 std::shared_ptr<const Asset> other,
  83                 EqualityOptions opt,
  84                 NoteHandler note
  85                 ) const;
  86
  87         /** @return number of channels */
  88         int channels () const {
  89                 return _channels;
  90         }
  91
  92         /** @return sampling rate in Hz */
  93         int sampling_rate () const {
  94                 return _sampling_rate;
  95         }
  96
  97         Fraction edit_rate () const {
  98                 return _edit_rate;
  99         }
 100
 101         int64_t intrinsic_duration () const {
 102                 return _intrinsic_duration;
 103         }
 104
 105         std::string language () const {
 106                 return _language;
 107         }
 108
 109         static bool valid_mxf (boost::filesystem::path);
 110         static std::string static_pkl_type (Standard standard);
 111
 112 private:
 113         friend class SoundAssetWriter;
 114         friend std::shared_ptr<dcp::SoundAsset> (::simple_sound) (
 115                 boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language, int frames, int sample_rate
 116                 );
 117
 118         std::string pkl_type (Standard standard) const {
 119                 return static_pkl_type (standard);
 120         }
 121
 122         Fraction _edit_rate;
 123         /** The total length of this content in video frames.  The amount of
 124          *  content presented may be less than this.
 125          */
 126         int64_t _intrinsic_duration = 0;
 127         int _channels = 0;      ///< number of channels
 128         int _sampling_rate = 0; ///< sampling rate in Hz
 129         std::string _language;
 130 };
 131
 132
 133 }
 134
 135
 136 #endif