src/lib/dcp_content.h

   1 /*
   2     Copyright (C) 2014 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 "video_content.h"
  28 #include "single_stream_audio_content.h"
  29 #include "subtitle_content.h"
  30 #include <libcxml/cxml.h>
  31 #include <dcp/encrypted_kdm.h>
  32
  33 class DCPContentProperty
  34 {
  35 public:
  36         static int const CAN_BE_PLAYED;
  37         static int const REFERENCE_VIDEO;
  38         static int const REFERENCE_AUDIO;
  39         static int const REFERENCE_SUBTITLE;
  40 };
  41
  42 /** @class DCPContent
  43  *  @brief An existing DCP used as input.
  44  */
  45 class DCPContent : public VideoContent, public SingleStreamAudioContent, public SubtitleContent
  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         /* SubtitleContent */
  71
  72         bool has_text_subtitles () const {
  73                 boost::mutex::scoped_lock lm (_mutex);
  74                 return _has_subtitles;
  75         }
  76
  77         bool has_image_subtitles () const {
  78                 return false;
  79         }
  80
  81         double subtitle_video_frame_rate () const {
  82                 return video_frame_rate ();
  83         }
  84
  85         boost::filesystem::path directory () const;
  86
  87         bool encrypted () const {
  88                 boost::mutex::scoped_lock lm (_mutex);
  89                 return _encrypted;
  90         }
  91
  92         void add_kdm (dcp::EncryptedKDM);
  93
  94         boost::optional<dcp::EncryptedKDM> kdm () const {
  95                 return _kdm;
  96         }
  97
  98         bool can_be_played () const;
  99
 100         void set_reference_video (bool r);
 101
 102         bool reference_video () const {
 103                 boost::mutex::scoped_lock lm (_mutex);
 104                 return _reference_video;
 105         }
 106
 107         void set_reference_audio (bool r);
 108
 109         bool reference_audio () const {
 110                 boost::mutex::scoped_lock lm (_mutex);
 111                 return _reference_audio;
 112         }
 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 protected:
 122         void add_properties (std::list<std::pair<std::string, std::string> >& p) const;
 123
 124 private:
 125         void read_directory (boost::filesystem::path);
 126
 127         std::string _name;
 128         bool _has_subtitles;
 129         /** true if our DCP is encrypted */
 130         bool _encrypted;
 131         boost::optional<dcp::EncryptedKDM> _kdm;
 132         /** true if _kdm successfully decrypts the first frame of our DCP */
 133         bool _kdm_valid;
 134         /** true if the video in this DCP should be included in the output by reference
 135          *  rather than by rewrapping.
 136          */
 137         bool _reference_video;
 138         /** true if the audio in this DCP should be included in the output by reference
 139          *  rather than by rewrapping.
 140          */
 141         bool _reference_audio;
 142         /** true if the subtitle in this DCP should be included in the output by reference
 143          *  rather than by rewrapping.
 144          */
 145         bool _reference_subtitle;
 146 };
 147
 148 #endif