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 <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 SingleStreamAudioContent
  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         /* SubtitleContent */
  69
  70         bool has_text_subtitles () const {
  71                 boost::mutex::scoped_lock lm (_mutex);
  72                 return _has_subtitles;
  73         }
  74
  75         bool has_image_subtitles () const {
  76                 return false;
  77         }
  78
  79         double subtitle_video_frame_rate () const;
  80
  81         boost::filesystem::path directory () const;
  82
  83         bool encrypted () const {
  84                 boost::mutex::scoped_lock lm (_mutex);
  85                 return _encrypted;
  86         }
  87
  88         void add_kdm (dcp::EncryptedKDM);
  89
  90         boost::optional<dcp::EncryptedKDM> kdm () const {
  91                 return _kdm;
  92         }
  93
  94         bool can_be_played () const;
  95
  96         void set_reference_video (bool r);
  97
  98         bool reference_video () const {
  99                 boost::mutex::scoped_lock lm (_mutex);
 100                 return _reference_video;
 101         }
 102
 103         bool can_reference_video (std::list<std::string> &) const;
 104
 105         void set_reference_audio (bool r);
 106
 107         bool reference_audio () const {
 108                 boost::mutex::scoped_lock lm (_mutex);
 109                 return _reference_audio;
 110         }
 111
 112         bool can_reference_audio (std::list<std::string> &) const;
 113
 114         void set_reference_subtitle (bool r);
 115
 116         bool reference_subtitle () const {
 117                 boost::mutex::scoped_lock lm (_mutex);
 118                 return _reference_subtitle;
 119         }
 120
 121         bool can_reference_subtitle (std::list<std::string> &) const;
 122
 123 protected:
 124         void add_properties (std::list<UserProperty>& p) const;
 125
 126 private:
 127         void read_directory (boost::filesystem::path);
 128         std::list<DCPTimePeriod> reels () const;
 129         template <class T> bool can_reference (std::string overlapping, std::list<std::string>& why_not) const;
 130
 131         std::string _name;
 132         bool _has_subtitles;
 133         /** true if our DCP is encrypted */
 134         bool _encrypted;
 135         boost::optional<dcp::EncryptedKDM> _kdm;
 136         /** true if _kdm successfully decrypts the first frame of our DCP */
 137         bool _kdm_valid;
 138         /** true if the video in this DCP should be included in the output by reference
 139          *  rather than by rewrapping.
 140          */
 141         bool _reference_video;
 142         /** true if the audio in this DCP should be included in the output by reference
 143          *  rather than by rewrapping.
 144          */
 145         bool _reference_audio;
 146         /** true if the subtitle in this DCP should be included in the output by reference
 147          *  rather than by rewrapping.
 148          */
 149         bool _reference_subtitle;
 150 };
 151
 152 #endif