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