2 Copyright (C) 2014-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef DCPOMATIC_DCP_CONTENT_H
22 #define DCPOMATIC_DCP_CONTENT_H
24 /** @file src/lib/dcp_content.h
25 * @brief DCPContent class.
29 #include <libcxml/cxml.h>
30 #include <dcp/encrypted_kdm.h>
32 class DCPContentProperty
35 static int const CAN_BE_PLAYED;
36 static int const REFERENCE_VIDEO;
37 static int const REFERENCE_AUDIO;
38 static int const REFERENCE_SUBTITLE;
44 * @brief An existing DCP used as input.
46 class DCPContent : public Content
49 DCPContent (boost::shared_ptr<const Film>, boost::filesystem::path p);
50 DCPContent (boost::shared_ptr<const Film>, cxml::ConstNodePtr, int version);
52 boost::shared_ptr<DCPContent> shared_from_this () {
53 return boost::dynamic_pointer_cast<DCPContent> (Content::shared_from_this ());
56 boost::shared_ptr<const DCPContent> shared_from_this () const {
57 return boost::dynamic_pointer_cast<const DCPContent> (Content::shared_from_this ());
60 DCPTime full_length () const;
62 void examine (boost::shared_ptr<Job>);
63 std::string summary () const;
64 std::string technical_summary () const;
65 void as_xml (xmlpp::Node *, bool with_paths) const;
66 std::string identifier () const;
67 void use_template (boost::shared_ptr<const Content> c);
69 void set_default_colour_conversion ();
70 std::list<DCPTime> reel_split_points () const;
72 std::vector<boost::filesystem::path> directories () const;
74 bool encrypted () const {
75 boost::mutex::scoped_lock lm (_mutex);
79 void add_kdm (dcp::EncryptedKDM);
80 void add_ov (boost::filesystem::path ov);
82 boost::optional<dcp::EncryptedKDM> kdm () const {
86 bool can_be_played () const;
87 bool needs_kdm () const;
88 bool needs_assets () const;
90 void set_reference_video (bool r);
92 bool reference_video () const {
93 boost::mutex::scoped_lock lm (_mutex);
94 return _reference_video;
97 bool can_reference_video (std::list<std::string> &) const;
99 void set_reference_audio (bool r);
101 bool reference_audio () const {
102 boost::mutex::scoped_lock lm (_mutex);
103 return _reference_audio;
106 bool can_reference_audio (std::list<std::string> &) const;
108 void set_reference_subtitle (bool r);
110 bool reference_subtitle () const {
111 boost::mutex::scoped_lock lm (_mutex);
112 return _reference_subtitle;
115 bool can_reference_subtitle (std::list<std::string> &) const;
117 boost::optional<std::string> cpl () const {
118 boost::mutex::scoped_lock lm (_mutex);
123 friend class reels_test5;
125 void add_properties (std::list<UserProperty>& p) const;
127 void read_directory (boost::filesystem::path);
128 std::list<DCPTimePeriod> reels () const;
130 boost::function <boost::shared_ptr<ContentPart> (boost::shared_ptr<const Content>)>,
131 std::string overlapping,
132 std::list<std::string>& why_not
136 /** true if our DCP is encrypted */
138 /** true if this DCP needs more assets before it can be played */
140 boost::optional<dcp::EncryptedKDM> _kdm;
141 /** true if _kdm successfully decrypts the first frame of our DCP */
143 /** true if the video in this DCP should be included in the output by reference
144 * rather than by rewrapping.
146 bool _reference_video;
147 /** true if the audio in this DCP should be included in the output by reference
148 * rather than by rewrapping.
150 bool _reference_audio;
151 /** true if the subtitle in this DCP should be included in the output by reference
152 * rather than by rewrapping.
154 bool _reference_subtitle;
156 boost::optional<dcp::Standard> _standard;
158 /** ID of the CPL to use; older metadata might not specify this: in that case
159 * just use the only CPL.
161 boost::optional<std::string> _cpl;