2 Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 #ifndef DCPOMATIC_DCP_CONTENT_H
21 #define DCPOMATIC_DCP_CONTENT_H
23 /** @file src/lib/dcp_content.h
24 * @brief DCPContent class.
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>
33 class DCPContentProperty
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;
43 * @brief An existing DCP used as input.
45 class DCPContent : public VideoContent, public SingleStreamAudioContent, public SubtitleContent
48 DCPContent (boost::shared_ptr<const Film>, boost::filesystem::path p);
49 DCPContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
51 boost::shared_ptr<DCPContent> shared_from_this () {
52 return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
55 boost::shared_ptr<const DCPContent> shared_from_this () const {
56 return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
59 DCPTime full_length () const;
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;
67 void set_default_colour_conversion ();
68 std::list<DCPTime> reel_split_points () const;
72 bool has_text_subtitles () const {
73 boost::mutex::scoped_lock lm (_mutex);
74 return _has_subtitles;
77 bool has_image_subtitles () const {
81 double subtitle_video_frame_rate () const {
82 return video_frame_rate ();
85 boost::filesystem::path directory () const;
87 bool encrypted () const {
88 boost::mutex::scoped_lock lm (_mutex);
92 void add_kdm (dcp::EncryptedKDM);
94 boost::optional<dcp::EncryptedKDM> kdm () const {
98 bool can_be_played () const;
100 void set_reference_video (bool r);
102 bool reference_video () const {
103 boost::mutex::scoped_lock lm (_mutex);
104 return _reference_video;
107 bool can_reference_video (std::list<std::string> &) const;
109 void set_reference_audio (bool r);
111 bool reference_audio () const {
112 boost::mutex::scoped_lock lm (_mutex);
113 return _reference_audio;
116 bool can_reference_audio (std::list<std::string> &) const;
118 void set_reference_subtitle (bool r);
120 bool reference_subtitle () const {
121 boost::mutex::scoped_lock lm (_mutex);
122 return _reference_subtitle;
125 bool can_reference_subtitle (std::list<std::string> &) const;
128 void add_properties (std::list<UserProperty>& p) const;
131 void read_directory (boost::filesystem::path);
132 std::list<DCPTimePeriod> reels () const;
133 template <class T> bool can_reference (std::string overlapping, std::list<std::string>& why_not) const;
137 /** true if our DCP is encrypted */
139 boost::optional<dcp::EncryptedKDM> _kdm;
140 /** true if _kdm successfully decrypts the first frame of our DCP */
142 /** true if the video in this DCP should be included in the output by reference
143 * rather than by rewrapping.
145 bool _reference_video;
146 /** true if the audio in this DCP should be included in the output by reference
147 * rather than by rewrapping.
149 bool _reference_audio;
150 /** true if the subtitle in this DCP should be included in the output by reference
151 * rather than by rewrapping.
153 bool _reference_subtitle;