src/lib/dcp_content.h

   1 /*
   2     Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef DCPOMATIC_DCP_CONTENT_H
  21 #define DCPOMATIC_DCP_CONTENT_H
  22
  23 /** @file  src/lib/dcp_content.h
  24  *  @brief DCPContent class.
  25  */
  26
  27 #include "content.h"
  28 #include <libcxml/cxml.h>
  29 #include <dcp/encrypted_kdm.h>
  30
  31 class DCPContentProperty
  32 {
  33 public:
  34         static int const CAN_BE_PLAYED;
  35         static int const REFERENCE_VIDEO;
  36         static int const REFERENCE_AUDIO;
  37         static int const REFERENCE_SUBTITLE;
  38 };
  39
  40 class ContentPart;
  41
  42 /** @class DCPContent
  43  *  @brief An existing DCP used as input.
  44  */
  45 class DCPContent : public Content
  46 {
  47 public:
  48         DCPContent (boost::shared_ptr<const Film>, boost::filesystem::path p);
  49         DCPContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  50
  51         boost::shared_ptr<DCPContent> shared_from_this () {
  52                 return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
  53         }
  54
  55         boost::shared_ptr<const DCPContent> shared_from_this () const {
  56                 return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
  57         }
  58
  59         DCPTime full_length () const;
  60
  61         void examine (boost::shared_ptr<Job>);
  62         std::string summary () const;
  63         std::string technical_summary () const;
  64         void as_xml (xmlpp::Node *) const;
  65         std::string identifier () const;
  66
  67         void set_default_colour_conversion ();
  68         std::list<DCPTime> reel_split_points () const;
  69
  70         boost::filesystem::path directory () const;
  71
  72         bool encrypted () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _encrypted;
  75         }
  76
  77         void add_kdm (dcp::EncryptedKDM);
  78
  79         boost::optional<dcp::EncryptedKDM> kdm () const {
  80                 return _kdm;
  81         }
  82
  83         bool can_be_played () const;
  84
  85         void set_reference_video (bool r);
  86
  87         bool reference_video () const {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 return _reference_video;
  90         }
  91
  92         bool can_reference_video (std::list<std::string> &) const;
  93
  94         void set_reference_audio (bool r);
  95
  96         bool reference_audio () const {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 return _reference_audio;
  99         }
 100
 101         bool can_reference_audio (std::list<std::string> &) const;
 102
 103         void set_reference_subtitle (bool r);
 104
 105         bool reference_subtitle () const {
 106                 boost::mutex::scoped_lock lm (_mutex);
 107                 return _reference_subtitle;
 108         }
 109
 110         bool can_reference_subtitle (std::list<std::string> &) const;
 111
 112 private:
 113         void add_properties (std::list<UserProperty>& p) const;
 114
 115         void read_directory (boost::filesystem::path);
 116         std::list<DCPTimePeriod> reels () const;
 117         bool can_reference (
 118                 boost::function <boost::shared_ptr<ContentPart> (boost::shared_ptr<const Content>)>,
 119                 std::string overlapping,
 120                 std::list<std::string>& why_not
 121                 ) const;
 122
 123         std::string _name;
 124         /** true if our DCP is encrypted */
 125         bool _encrypted;
 126         boost::optional<dcp::EncryptedKDM> _kdm;
 127         /** true if _kdm successfully decrypts the first frame of our DCP */
 128         bool _kdm_valid;
 129         /** true if the video in this DCP should be included in the output by reference
 130          *  rather than by rewrapping.
 131          */
 132         bool _reference_video;
 133         /** true if the audio in this DCP should be included in the output by reference
 134          *  rather than by rewrapping.
 135          */
 136         bool _reference_audio;
 137         /** true if the subtitle in this DCP should be included in the output by reference
 138          *  rather than by rewrapping.
 139          */
 140         bool _reference_subtitle;
 141
 142         boost::optional<dcp::Standard> _standard;
 143 };
 144
 145 #endif