2 Copyright (C) 2014-2017 Carl Hetherington <cth@carlh.net>
4 This file is part of libdcp.
6 libdcp 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 libdcp 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 libdcp. If not, see <http://www.gnu.org/licenses/>.
19 In addition, as a special exception, the copyright holders give
20 permission to link the code of portions of this program with the
21 OpenSSL library under certain conditions as described in each
22 individual source file, and distribute linked combinations
25 You must obey the GNU General Public License in all respects
26 for all of the code used other than OpenSSL. If you modify
27 file(s) with this exception, you may extend this exception to your
28 version of the file(s), but you are not obligated to do so. If you
29 do not wish to do so, delete this exception statement from your
30 version. If you delete this exception statement from all source
31 files in the program, then also delete it here.
36 #include "picture_asset.h"
37 #include "mono_picture_asset.h"
38 #include "stereo_picture_asset.h"
39 #include "sound_asset.h"
40 #include "subtitle_asset.h"
41 #include "reel_mono_picture_asset.h"
42 #include "reel_stereo_picture_asset.h"
43 #include "reel_sound_asset.h"
44 #include "reel_subtitle_asset.h"
45 #include "reel_markers_asset.h"
46 #include "decrypted_kdm_key.h"
47 #include "decrypted_kdm.h"
48 #include "interop_subtitle_asset.h"
49 #include "smpte_subtitle_asset.h"
50 #include "reel_atmos_asset.h"
51 #include "reel_closed_caption_asset.h"
52 #include <libxml++/nodes/element.h>
53 #include <boost/foreach.hpp>
59 using boost::shared_ptr;
60 using boost::dynamic_pointer_cast;
63 Reel::Reel (boost::shared_ptr<const cxml::Node> node)
64 : Object (remove_urn_uuid (node->string_child ("Id")))
66 shared_ptr<cxml::Node> asset_list = node->node_child ("AssetList");
68 shared_ptr<cxml::Node> main_picture = asset_list->optional_node_child ("MainPicture");
70 _main_picture.reset (new ReelMonoPictureAsset (main_picture));
73 shared_ptr<cxml::Node> main_stereoscopic_picture = asset_list->optional_node_child ("MainStereoscopicPicture");
74 if (main_stereoscopic_picture) {
75 _main_picture.reset (new ReelStereoPictureAsset (main_stereoscopic_picture));
78 shared_ptr<cxml::Node> main_sound = asset_list->optional_node_child ("MainSound");
80 _main_sound.reset (new ReelSoundAsset (main_sound));
83 shared_ptr<cxml::Node> main_subtitle = asset_list->optional_node_child ("MainSubtitle");
85 _main_subtitle.reset (new ReelSubtitleAsset (main_subtitle));
88 shared_ptr<cxml::Node> main_markers = asset_list->optional_node_child ("MainMarkers");
90 _main_markers.reset (new ReelMarkersAsset (main_markers));
93 /* XXX: it's not ideal that we silently tolerate Interop or SMPTE nodes here */
94 /* XXX: not sure if Interop supports multiple closed captions */
95 list<shared_ptr<cxml::Node> > closed_captions = asset_list->node_children ("MainClosedCaption");
96 if (closed_captions.empty()) {
97 closed_captions = asset_list->node_children ("ClosedCaption");
99 BOOST_FOREACH (shared_ptr<cxml::Node> i, closed_captions) {
100 _closed_captions.push_back (shared_ptr<ReelClosedCaptionAsset>(new ReelClosedCaptionAsset(i)));
103 shared_ptr<cxml::Node> atmos = asset_list->optional_node_child ("AuxData");
105 _atmos.reset (new ReelAtmosAsset (atmos));
108 node->ignore_child ("AnnotationText");
113 Reel::write_to_cpl (xmlpp::Element* node, Standard standard) const
115 xmlpp::Element* reel = node->add_child ("Reel");
116 reel->add_child("Id")->add_child_text ("urn:uuid:" + make_uuid());
117 xmlpp::Element* asset_list = reel->add_child ("AssetList");
120 _main_markers->write_to_cpl (asset_list, standard);
123 if (_main_picture && dynamic_pointer_cast<ReelMonoPictureAsset> (_main_picture)) {
124 /* Mono pictures come before other stuff... */
125 _main_picture->write_to_cpl (asset_list, standard);
129 _main_sound->write_to_cpl (asset_list, standard);
132 if (_main_subtitle) {
133 _main_subtitle->write_to_cpl (asset_list, standard);
136 BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> i, _closed_captions) {
137 i->write_to_cpl (asset_list, standard);
140 if (_main_picture && dynamic_pointer_cast<ReelStereoPictureAsset> (_main_picture)) {
141 /* ... but stereo pictures must come after */
142 _main_picture->write_to_cpl (asset_list, standard);
146 _atmos->write_to_cpl (asset_list, standard);
151 Reel::equals (boost::shared_ptr<const Reel> other, EqualityOptions opt, NoteHandler note) const
153 if ((_main_picture && !other->_main_picture) || (!_main_picture && other->_main_picture)) {
154 note (DCP_ERROR, "Reel: picture assets differ");
158 if (_main_picture && !_main_picture->equals (other->_main_picture, opt, note)) {
162 if ((_main_sound && !other->_main_sound) || (!_main_sound && other->_main_sound)) {
163 note (DCP_ERROR, "Reel: sound assets differ");
167 if (_main_sound && !_main_sound->equals (other->_main_sound, opt, note)) {
171 if ((_main_subtitle && !other->_main_subtitle) || (!_main_subtitle && other->_main_subtitle)) {
172 note (DCP_ERROR, "Reel: subtitle assets differ");
176 if (_main_subtitle && !_main_subtitle->equals (other->_main_subtitle, opt, note)) {
180 if (_main_markers && !_main_markers->equals (other->_main_markers, opt, note)) {
184 if (_closed_captions.size() != other->_closed_captions.size()) {
188 list<shared_ptr<ReelClosedCaptionAsset> >::const_iterator i = _closed_captions.begin();
189 list<shared_ptr<ReelClosedCaptionAsset> >::const_iterator j = other->_closed_captions.begin();
190 while (i != _closed_captions.end()) {
191 if (!(*i)->equals(*j, opt, note)) {
198 if ((_atmos && !other->_atmos) || (!_atmos && other->_atmos)) {
199 note (DCP_ERROR, "Reel: atmos assets differ");
203 if (_atmos && !_atmos->equals (other->_atmos, opt, note)) {
211 Reel::encrypted () const
214 BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> i, _closed_captions) {
215 if (i->encrypted()) {
221 (_main_picture && _main_picture->encrypted ()) ||
222 (_main_sound && _main_sound->encrypted ()) ||
223 (_main_subtitle && _main_subtitle->encrypted ()) ||
225 (_atmos && _atmos->encrypted ())
230 Reel::add (DecryptedKDM const & kdm)
232 list<DecryptedKDMKey> keys = kdm.keys ();
234 for (list<DecryptedKDMKey>::iterator i = keys.begin(); i != keys.end(); ++i) {
235 if (_main_picture && i->id() == _main_picture->key_id()) {
236 _main_picture->asset()->set_key (i->key ());
238 if (_main_sound && i->id() == _main_sound->key_id()) {
239 _main_sound->asset()->set_key (i->key ());
241 if (_main_subtitle && i->id() == _main_subtitle->key_id()) {
242 shared_ptr<SMPTESubtitleAsset> s = dynamic_pointer_cast<SMPTESubtitleAsset> (_main_subtitle->asset());
244 s->set_key (i->key ());
247 BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> j, _closed_captions) {
248 if (i->id() == j->key_id()) {
249 shared_ptr<SMPTESubtitleAsset> s = dynamic_pointer_cast<SMPTESubtitleAsset> (j->asset());
251 s->set_key (i->key ());
255 if (_atmos && i->id() == _atmos->key_id()) {
256 _atmos->asset()->set_key (i->key ());
262 Reel::add (shared_ptr<ReelAsset> asset)
264 shared_ptr<ReelPictureAsset> p = dynamic_pointer_cast<ReelPictureAsset> (asset);
265 shared_ptr<ReelSoundAsset> so = dynamic_pointer_cast<ReelSoundAsset> (asset);
266 shared_ptr<ReelSubtitleAsset> su = dynamic_pointer_cast<ReelSubtitleAsset> (asset);
267 shared_ptr<ReelMarkersAsset> m = dynamic_pointer_cast<ReelMarkersAsset> (asset);
268 shared_ptr<ReelClosedCaptionAsset> c = dynamic_pointer_cast<ReelClosedCaptionAsset> (asset);
269 shared_ptr<ReelAtmosAsset> a = dynamic_pointer_cast<ReelAtmosAsset> (asset);
279 _closed_captions.push_back (c);
286 Reel::resolve_refs (list<shared_ptr<Asset> > assets)
289 _main_picture->asset_ref().resolve (assets);
293 _main_sound->asset_ref().resolve (assets);
296 if (_main_subtitle) {
297 _main_subtitle->asset_ref().resolve (assets);
299 /* Interop subtitle handling is all special cases */
300 if (_main_subtitle->asset_ref().resolved()) {
301 shared_ptr<InteropSubtitleAsset> iop = dynamic_pointer_cast<InteropSubtitleAsset> (_main_subtitle->asset_ref().asset());
303 iop->resolve_fonts (assets);
308 BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> i, _closed_captions) {
309 i->asset_ref().resolve(assets);
311 /* Interop subtitle handling is all special cases */
312 if (i->asset_ref().resolved()) {
313 shared_ptr<InteropSubtitleAsset> iop = dynamic_pointer_cast<InteropSubtitleAsset> (i->asset_ref().asset());
315 iop->resolve_fonts (assets);
321 _atmos->asset_ref().resolve (assets);
326 Reel::duration () const
331 d = max (d, _main_picture->duration ());
334 d = max (d, _main_sound->duration ());
336 if (_main_subtitle) {
337 d = max (d, _main_subtitle->duration ());
340 d = max (d, _main_markers->duration ());
342 BOOST_FOREACH (shared_ptr<ReelClosedCaptionAsset> i, _closed_captions) {
343 d = max (d, i->duration());
346 d = max (d, _atmos->duration ());