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