src/reel.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 #ifndef LIBDCP_REEL_H
  35 #define LIBDCP_REEL_H
  36
  37 #include "key.h"
  38 #include "types.h"
  39 #include "ref.h"
  40 #include <memory>
  41 #include <boost/function.hpp>
  42
  43 namespace cxml {
  44         class Node;
  45 }
  46
  47 namespace xmlpp {
  48         class Element;
  49 }
  50
  51 namespace dcp {
  52
  53 class DecryptedKDM;
  54 class ReelAsset;
  55 class ReelPictureAsset;
  56 class ReelSoundAsset;
  57 class ReelSubtitleAsset;
  58 class ReelMarkersAsset;
  59 class ReelClosedCaptionAsset;
  60 class ReelAtmosAsset;
  61 class Content;
  62
  63 /** @brief A reel within a DCP; the part which actually refers to picture, sound, subtitle, marker and Atmos data */
  64 class Reel : public Object
  65 {
  66 public:
  67         Reel () {}
  68
  69         Reel (
  70                 std::shared_ptr<ReelPictureAsset> picture,
  71                 std::shared_ptr<ReelSoundAsset> sound = std::shared_ptr<ReelSoundAsset> (),
  72                 std::shared_ptr<ReelSubtitleAsset> subtitle = std::shared_ptr<ReelSubtitleAsset> (),
  73                 std::shared_ptr<ReelMarkersAsset> markers = std::shared_ptr<ReelMarkersAsset> (),
  74                 std::shared_ptr<ReelAtmosAsset> atmos = std::shared_ptr<ReelAtmosAsset> ()
  75                 )
  76                 : _main_picture (picture)
  77                 , _main_sound (sound)
  78                 , _main_subtitle (subtitle)
  79                 , _main_markers (markers)
  80                 , _atmos (atmos)
  81         {}
  82
  83         explicit Reel (std::shared_ptr<const cxml::Node>);
  84
  85         std::shared_ptr<ReelPictureAsset> main_picture () const {
  86                 return _main_picture;
  87         }
  88
  89         std::shared_ptr<ReelSoundAsset> main_sound () const {
  90                 return _main_sound;
  91         }
  92
  93         std::shared_ptr<ReelSubtitleAsset> main_subtitle () const {
  94                 return _main_subtitle;
  95         }
  96
  97         std::shared_ptr<ReelMarkersAsset> main_markers () const {
  98                 return _main_markers;
  99         }
 100
 101         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> closed_captions () const {
 102                 return _closed_captions;
 103         }
 104
 105         std::shared_ptr<ReelAtmosAsset> atmos () const {
 106                 return _atmos;
 107         }
 108
 109         int64_t duration () const;
 110
 111         void add (std::shared_ptr<ReelAsset> asset);
 112
 113         std::vector<std::shared_ptr<ReelAsset>> assets () const;
 114
 115         xmlpp::Element* write_to_cpl (xmlpp::Element* node, Standard standard) const;
 116
 117         bool encrypted () const;
 118
 119         bool equals (std::shared_ptr<const Reel> other, EqualityOptions opt, NoteHandler notes) const;
 120
 121         void add (DecryptedKDM const &);
 122
 123         void resolve_refs (std::vector<std::shared_ptr<Asset>>);
 124
 125 private:
 126         std::shared_ptr<ReelPictureAsset> _main_picture;
 127         std::shared_ptr<ReelSoundAsset> _main_sound;
 128         std::shared_ptr<ReelSubtitleAsset> _main_subtitle;
 129         std::shared_ptr<ReelMarkersAsset> _main_markers;
 130         std::vector<std::shared_ptr<ReelClosedCaptionAsset>> _closed_captions;
 131         std::shared_ptr<ReelAtmosAsset> _atmos;
 132 };
 133
 134 }
 135
 136 #endif