src/lib/dcp_content.h

   1 /*
   2     Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic 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     DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_DCP_CONTENT_H
  22 #define DCPOMATIC_DCP_CONTENT_H
  23
  24 /** @file  src/lib/dcp_content.h
  25  *  @brief DCPContent class.
  26  */
  27
  28 #include "content.h"
  29 #include <libcxml/cxml.h>
  30 #include <dcp/encrypted_kdm.h>
  31
  32 class DCPContentProperty
  33 {
  34 public:
  35         static int const NEEDS_KDM;
  36         static int const NEEDS_ASSETS;
  37         static int const REFERENCE_VIDEO;
  38         static int const REFERENCE_AUDIO;
  39         static int const REFERENCE_SUBTITLE;
  40 };
  41
  42 class ContentPart;
  43
  44 /** @class DCPContent
  45  *  @brief An existing DCP used as input.
  46  */
  47 class DCPContent : public Content
  48 {
  49 public:
  50         DCPContent (boost::shared_ptr<const Film>, boost::filesystem::path p);
  51         DCPContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  52
  53         boost::shared_ptr<DCPContent> shared_from_this () {
  54                 return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
  55         }
  56
  57         boost::shared_ptr<const DCPContent> shared_from_this () const {
  58                 return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
  59         }
  60
  61         DCPTime full_length () const;
  62
  63         void examine (boost::shared_ptr<Job>);
  64         std::string summary () const;
  65         std::string technical_summary () const;
  66         void as_xml (xmlpp::Node *, bool with_paths) const;
  67         std::string identifier () const;
  68         void use_template (boost::shared_ptr<const Content> c);
  69
  70         void set_default_colour_conversion ();
  71         std::list<DCPTime> reel_split_points () const;
  72
  73         std::vector<boost::filesystem::path> directories () const;
  74
  75         bool encrypted () const {
  76                 boost::mutex::scoped_lock lm (_mutex);
  77                 return _encrypted;
  78         }
  79
  80         void add_kdm (dcp::EncryptedKDM);
  81         void add_ov (boost::filesystem::path ov);
  82
  83         boost::optional<dcp::EncryptedKDM> kdm () const {
  84                 return _kdm;
  85         }
  86
  87         bool can_be_played () const;
  88         bool needs_kdm () const;
  89         bool needs_assets () const;
  90
  91         void set_reference_video (bool r);
  92
  93         bool reference_video () const {
  94                 boost::mutex::scoped_lock lm (_mutex);
  95                 return _reference_video;
  96         }
  97
  98         bool can_reference_video (std::list<std::string> &) const;
  99
 100         void set_reference_audio (bool r);
 101
 102         bool reference_audio () const {
 103                 boost::mutex::scoped_lock lm (_mutex);
 104                 return _reference_audio;
 105         }
 106
 107         bool can_reference_audio (std::list<std::string> &) const;
 108
 109         void set_reference_subtitle (bool r);
 110
 111         bool reference_subtitle () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _reference_subtitle;
 114         }
 115
 116         bool can_reference_subtitle (std::list<std::string> &) const;
 117
 118         void set_cpl (std::string id);
 119
 120         boost::optional<std::string> cpl () const {
 121                 boost::mutex::scoped_lock lm (_mutex);
 122                 return _cpl;
 123         }
 124
 125 private:
 126         friend class reels_test5;
 127
 128         void add_properties (std::list<UserProperty>& p) const;
 129
 130         void read_directory (boost::filesystem::path);
 131         std::list<DCPTimePeriod> reels () const;
 132         bool can_reference (
 133                 boost::function <boost::shared_ptr<ContentPart> (boost::shared_ptr<const Content>)>,
 134                 std::string overlapping,
 135                 std::list<std::string>& why_not
 136                 ) const;
 137
 138         std::string _name;
 139         /** true if our DCP is encrypted */
 140         bool _encrypted;
 141         /** true if this DCP needs more assets before it can be played */
 142         bool _needs_assets;
 143         boost::optional<dcp::EncryptedKDM> _kdm;
 144         /** true if _kdm successfully decrypts the first frame of our DCP */
 145         bool _kdm_valid;
 146         /** true if the video in this DCP should be included in the output by reference
 147          *  rather than by rewrapping.
 148          */
 149         bool _reference_video;
 150         /** true if the audio in this DCP should be included in the output by reference
 151          *  rather than by rewrapping.
 152          */
 153         bool _reference_audio;
 154         /** true if the subtitle in this DCP should be included in the output by reference
 155          *  rather than by rewrapping.
 156          */
 157         bool _reference_subtitle;
 158
 159         boost::optional<dcp::Standard> _standard;
 160         bool _three_d;
 161         /** ID of the CPL to use; older metadata might not specify this: in that case
 162          *  just use the only CPL.
 163          */
 164         boost::optional<std::string> _cpl;
 165 };
 166
 167 #endif