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 DCPContent
  41  *  @brief An existing DCP used as input.
  42  */
  43 class DCPContent : public Content
  44 {
  45 public:
  46         DCPContent (boost::shared_ptr<const Film>, boost::filesystem::path p);
  47         DCPContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
  48
  49         boost::shared_ptr<DCPContent> shared_from_this () {
  50                 return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
  51         }
  52
  53         boost::shared_ptr<const DCPContent> shared_from_this () const {
  54                 return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
  55         }
  56
  57         DCPTime full_length () const;
  58
  59         void examine (boost::shared_ptr<Job>);
  60         std::string summary () const;
  61         std::string technical_summary () const;
  62         void as_xml (xmlpp::Node *) const;
  63         std::string identifier () const;
  64
  65         void set_default_colour_conversion ();
  66         std::list<DCPTime> reel_split_points () const;
  67
  68         bool has_text_subtitles () const {
  69                 boost::mutex::scoped_lock lm (_mutex);
  70                 return _has_subtitles;
  71         }
  72
  73         bool has_image_subtitles () const {
  74                 return false;
  75         }
  76
  77         void changed (int property);
  78
  79         boost::filesystem::path directory () const;
  80
  81         bool encrypted () const {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 return _encrypted;
  84         }
  85
  86         void add_kdm (dcp::EncryptedKDM);
  87
  88         boost::optional<dcp::EncryptedKDM> kdm () const {
  89                 return _kdm;
  90         }
  91
  92         bool can_be_played () const;
  93
  94         void set_reference_video (bool r);
  95
  96         bool reference_video () const {
  97                 boost::mutex::scoped_lock lm (_mutex);
  98                 return _reference_video;
  99         }
 100
 101         bool can_reference_video (std::list<std::string> &) const;
 102
 103         void set_reference_audio (bool r);
 104
 105         bool reference_audio () const {
 106                 boost::mutex::scoped_lock lm (_mutex);
 107                 return _reference_audio;
 108         }
 109
 110         bool can_reference_audio (std::list<std::string> &) const;
 111
 112         void set_reference_subtitle (bool r);
 113
 114         bool reference_subtitle () const {
 115                 boost::mutex::scoped_lock lm (_mutex);
 116                 return _reference_subtitle;
 117         }
 118
 119         bool can_reference_subtitle (std::list<std::string> &) const;
 120
 121 private:
 122         void add_properties (std::list<UserProperty>& p) const;
 123
 124         void read_directory (boost::filesystem::path);
 125         std::list<DCPTimePeriod> reels () const;
 126         template <class T> bool can_reference (std::string overlapping, std::list<std::string>& why_not) const;
 127
 128         std::string _name;
 129         bool _has_subtitles;
 130         /** true if our DCP is encrypted */
 131         bool _encrypted;
 132         boost::optional<dcp::EncryptedKDM> _kdm;
 133         /** true if _kdm successfully decrypts the first frame of our DCP */
 134         bool _kdm_valid;
 135         /** true if the video in this DCP should be included in the output by reference
 136          *  rather than by rewrapping.
 137          */
 138         bool _reference_video;
 139         /** true if the audio in this DCP should be included in the output by reference
 140          *  rather than by rewrapping.
 141          */
 142         bool _reference_audio;
 143         /** true if the subtitle in this DCP should be included in the output by reference
 144          *  rather than by rewrapping.
 145          */
 146         bool _reference_subtitle;
 147 };
 148
 149 #endif