src/atmos_asset.h

   1 /*
   2     Copyright (C) 2016-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/atmos_asset.h
  36  *  @brief AtmosAsset class
  37  */
  38
  39
  40 #ifndef LIBDCP_ATMOS_ASSET_H
  41 #define LIBDCP_ATMOS_ASSET_H
  42
  43
  44 #include "asset.h"
  45 #include "mxf.h"
  46 #include "atmos_asset_reader.h"
  47
  48
  49 namespace dcp {
  50
  51
  52 class AtmosAssetWriter;
  53
  54
  55 /** @class AtmosAsset
  56  *  @brief An asset of Dolby ATMOS sound data
  57  */
  58 class AtmosAsset : public Asset, public MXF
  59 {
  60 public:
  61         AtmosAsset (Fraction edit_rate, int first_frame, int max_channel_count, int max_object_count, int atmos_version);
  62         explicit AtmosAsset (boost::filesystem::path file);
  63
  64         std::shared_ptr<AtmosAssetWriter> start_write (boost::filesystem::path file);
  65         std::shared_ptr<AtmosAssetReader> start_read () const;
  66
  67         static std::string static_pkl_type (Standard);
  68         std::string pkl_type (Standard s) const {
  69                 return static_pkl_type (s);
  70         }
  71
  72         Fraction edit_rate () const {
  73                 return _edit_rate;
  74         }
  75
  76         int64_t intrinsic_duration () const {
  77                 return _intrinsic_duration;
  78         }
  79
  80         /** @return frame number of the frame to align with the FFOA of the picture track */
  81         int first_frame () const {
  82                 return _first_frame;
  83         }
  84
  85         /** @return maximum number of channels in bitstream */
  86         int max_channel_count () const {
  87                 return _max_channel_count;
  88         }
  89
  90         /** @return maximum number of objects in bitstream */
  91         int max_object_count () const {
  92                 return _max_object_count;
  93         }
  94
  95         std::string atmos_id () const {
  96                 return _atmos_id;
  97         }
  98
  99         int atmos_version () const {
 100                 return _atmos_version;
 101         }
 102
 103 private:
 104         friend class AtmosAssetWriter;
 105
 106         Fraction _edit_rate;
 107         int64_t _intrinsic_duration = 0;
 108         int _first_frame = 0;
 109         int _max_channel_count = 0;
 110         int _max_object_count = 0;
 111         std::string _atmos_id;
 112         int _atmos_version = 0;
 113 };
 114
 115
 116 }
 117
 118
 119 #endif