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