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         DCPTime full_length () const;
  56
  57         void examine (boost::shared_ptr<Job>);
  58         std::string summary () const;
  59         std::string technical_summary () const;
  60         void as_xml (xmlpp::Node *) const;
  61         std::string identifier () const;
  62
  63         void set_default_colour_conversion ();
  64
  65         /* SubtitleContent */
  66
  67         bool has_text_subtitles () const {
  68                 boost::mutex::scoped_lock lm (_mutex);
  69                 return _has_subtitles;
  70         }
  71
  72         bool has_image_subtitles () const {
  73                 return false;
  74         }
  75
  76         double subtitle_video_frame_rate () const {
  77                 return video_frame_rate ();
  78         }
  79
  80         boost::filesystem::path directory () const;
  81
  82         bool encrypted () const {
  83                 boost::mutex::scoped_lock lm (_mutex);
  84                 return _encrypted;
  85         }
  86
  87         void add_kdm (dcp::EncryptedKDM);
  88
  89         boost::optional<dcp::EncryptedKDM> kdm () const {
  90                 return _kdm;
  91         }
  92
  93         bool can_be_played () const;
  94
  95         void set_reference_video (bool r);
  96
  97         bool reference_video () const {
  98                 boost::mutex::scoped_lock lm (_mutex);
  99                 return _reference_video;
 100         }
 101
 102         void set_reference_audio (bool r);
 103
 104         bool reference_audio () const {
 105                 boost::mutex::scoped_lock lm (_mutex);
 106                 return _reference_audio;
 107         }
 108
 109         void set_reference_subtitle (bool r);
 110
 111         bool reference_subtitle () const {
 112                 boost::mutex::scoped_lock lm (_mutex);
 113                 return _reference_subtitle;
 114         }
 115
 116 protected:
 117         void add_properties (std::list<std::pair<std::string, std::string> >& p) const;
 118
 119 private:
 120         void read_directory (boost::filesystem::path);
 121
 122         std::string _name;
 123         bool _has_subtitles;
 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
 143 #endif