src/sound_asset.h

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