2 Copyright (C) 2014-2021 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/>.
23 #include "dcp_content.h"
24 #include "dcp_examiner.h"
25 #include "dcpomatic_log.h"
26 #include "exceptions.h"
31 #include <dcp/decrypted_kdm.h>
32 #include <dcp/mono_picture_asset.h>
33 #include <dcp/mono_picture_asset_reader.h>
34 #include <dcp/mono_picture_frame.h>
36 #include <dcp/reel_atmos_asset.h>
37 #include <dcp/reel_closed_caption_asset.h>
38 #include <dcp/reel_markers_asset.h>
39 #include <dcp/reel_picture_asset.h>
40 #include <dcp/reel_sound_asset.h>
41 #include <dcp/reel_subtitle_asset.h>
42 #include <dcp/search.h>
43 #include <dcp/sound_asset.h>
44 #include <dcp/sound_asset.h>
45 #include <dcp/sound_asset_reader.h>
46 #include <dcp/stereo_picture_asset.h>
47 #include <dcp/stereo_picture_asset_reader.h>
48 #include <dcp/stereo_picture_frame.h>
49 #include <dcp/subtitle_asset.h>
56 using std::dynamic_pointer_cast;
57 using std::shared_ptr;
59 using boost::optional;
62 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
64 shared_ptr<dcp::CPL> cpl;
66 for (int i = 0; i < static_cast<int>(TextType::COUNT); ++i) {
70 auto cpls = dcp::find_and_resolve_cpls (content->directories(), tolerant);
72 if (content->cpl ()) {
73 /* Use the CPL that the content was using before */
75 if (i->id() == content->cpl().get()) {
80 /* Choose the CPL with the fewest unsatisfied references */
82 int least_unsatisfied = INT_MAX;
86 for (auto j: i->reels()) {
87 if (j->main_picture() && !j->main_picture()->asset_ref().resolved()) {
90 if (j->main_sound() && !j->main_sound()->asset_ref().resolved()) {
93 if (j->main_subtitle() && !j->main_subtitle()->asset_ref().resolved()) {
96 if (j->atmos() && !j->atmos()->asset_ref().resolved()) {
101 if (unsatisfied < least_unsatisfied) {
102 least_unsatisfied = unsatisfied;
109 throw DCPError ("No CPLs found in DCP");
112 if (content->kdm()) {
113 cpl->add (decrypt_kdm_with_helpful_error(content->kdm().get()));
117 _name = cpl->content_title_text ();
118 _content_kind = cpl->content_kind ();
120 LOG_GENERAL ("Selected CPL %1", _cpl);
122 auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
125 return dcp::LanguageTag (*lang);
131 LOG_GENERAL ("Looking at %1 reels", cpl->reels().size());
133 for (auto i: cpl->reels()) {
134 LOG_GENERAL ("Reel %1", i->id());
136 if (i->main_picture ()) {
137 if (!i->main_picture()->asset_ref().resolved()) {
138 /* We are missing this asset so we can't continue; examination will be repeated later */
139 _needs_assets = true;
140 LOG_GENERAL ("Main picture %1 of reel %2 is missing", i->main_picture()->id(), i->id());
144 LOG_GENERAL ("Main picture %1 of reel %2 found", i->main_picture()->id(), i->id());
146 auto const frac = i->main_picture()->edit_rate ();
147 float const fr = float(frac.numerator) / frac.denominator;
148 if (!_video_frame_rate) {
149 _video_frame_rate = fr;
150 } else if (_video_frame_rate.get() != fr) {
151 throw DCPError (_("Mismatched frame rates in DCP"));
155 auto asset = i->main_picture()->asset();
157 _video_size = asset->size ();
158 } else if (_video_size.get() != asset->size ()) {
159 throw DCPError (_("Mismatched video sizes in DCP"));
162 _video_length += i->main_picture()->actual_duration();
165 if (i->main_sound ()) {
166 if (!i->main_sound()->asset_ref().resolved()) {
167 /* We are missing this asset so we can't continue; examination will be repeated later */
168 _needs_assets = true;
169 LOG_GENERAL ("Main sound %1 of reel %2 is missing", i->main_sound()->id(), i->id());
173 LOG_GENERAL ("Main sound %1 of reel %2 found", i->main_sound()->id(), i->id());
176 auto asset = i->main_sound()->asset();
178 if (!_audio_channels) {
179 _audio_channels = asset->channels ();
180 } else if (_audio_channels.get() != asset->channels ()) {
181 throw DCPError (_("Mismatched audio channel counts in DCP"));
184 if (!_audio_frame_rate) {
185 _audio_frame_rate = asset->sampling_rate ();
186 } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
187 throw DCPError (_("Mismatched audio sample rates in DCP"));
190 _audio_length += i->main_sound()->actual_duration();
191 _audio_language = try_to_parse_language (asset->language());
194 if (i->main_subtitle ()) {
195 if (!i->main_subtitle()->asset_ref().resolved()) {
196 /* We are missing this asset so we can't continue; examination will be repeated later */
197 _needs_assets = true;
198 LOG_GENERAL ("Main subtitle %1 of reel %2 is missing", i->main_subtitle()->id(), i->id());
202 LOG_GENERAL ("Main subtitle %1 of reel %2 found", i->main_subtitle()->id(), i->id());
204 _text_count[static_cast<int>(TextType::OPEN_SUBTITLE)] = 1;
205 _open_subtitle_language = try_to_parse_language (i->main_subtitle()->language());
208 for (auto j: i->closed_captions()) {
209 if (!j->asset_ref().resolved()) {
210 /* We are missing this asset so we can't continue; examination will be repeated later */
211 _needs_assets = true;
212 LOG_GENERAL ("Closed caption %1 of reel %2 is missing", j->id(), i->id());
216 LOG_GENERAL ("Closed caption %1 of reel %2 found", j->id(), i->id());
218 _text_count[static_cast<int>(TextType::CLOSED_CAPTION)]++;
219 _dcp_text_tracks.push_back (DCPTextTrack(j->annotation_text().get_value_or(""), try_to_parse_language(j->language())));
222 if (i->main_markers ()) {
223 auto rm = i->main_markers()->get();
224 _markers.insert (rm.begin(), rm.end());
229 _atmos_length += i->atmos()->actual_duration();
230 if (_atmos_edit_rate != dcp::Fraction()) {
231 DCPOMATIC_ASSERT (i->atmos()->edit_rate() == _atmos_edit_rate);
233 _atmos_edit_rate = i->atmos()->edit_rate();
236 if (i->main_picture()) {
237 _reel_lengths.push_back (i->main_picture()->actual_duration());
238 } else if (i->main_sound()) {
239 _reel_lengths.push_back (i->main_sound()->actual_duration());
240 } else if (i->main_subtitle()) {
241 _reel_lengths.push_back (i->main_subtitle()->actual_duration());
242 } else if (!i->closed_captions().empty()) {
243 _reel_lengths.push_back (i->closed_captions().front()->actual_duration());
244 } else if (!i->atmos()) {
245 _reel_lengths.push_back (i->atmos()->actual_duration());
249 _encrypted = cpl->any_encrypted ();
252 LOG_GENERAL_NC ("Check that everything encrypted has a key");
254 /* Check first that anything encrypted has a key. We must do this, as if we try to
255 * read encrypted data with asdcplib without even offering a key it will just return
256 * the encrypted data. Secondly, check that we can read the first thing from each
257 * asset in each reel. This checks that when we do have a key it's the right one.
260 for (auto i: cpl->reels()) {
261 LOG_GENERAL ("Reel %1", i->id());
262 auto pic = i->main_picture()->asset();
263 if (pic->encrypted() && !pic->key()) {
265 LOG_GENERAL_NC ("Picture has no key");
268 auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
269 auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
272 auto reader = mono->start_read();
273 reader->set_check_hmac (false);
274 reader->get_frame(0)->xyz_image();
276 auto reader = stereo->start_read();
277 reader->set_check_hmac (false);
278 reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
281 if (i->main_sound()) {
282 auto sound = i->main_sound()->asset ();
283 if (sound->encrypted() && !sound->key()) {
285 LOG_GENERAL_NC ("Sound has no key");
288 auto reader = i->main_sound()->asset()->start_read();
289 reader->set_check_hmac (false);
290 reader->get_frame(0);
293 if (i->main_subtitle()) {
294 auto sub = i->main_subtitle()->asset();
295 auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
296 if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
298 LOG_GENERAL_NC ("Subtitle has no key");
305 auto atmos = i->atmos()->asset();
306 if (atmos->encrypted() && !atmos->key()) {
308 LOG_GENERAL_NC ("ATMOS sound has no key");
311 auto reader = atmos->start_read();
312 reader->set_check_hmac (false);
313 reader->get_frame(0);
316 } catch (dcp::ReadError& e) {
318 LOG_GENERAL ("KDM is invalid: %1", e.what());
319 } catch (dcp::MiscError& e) {
321 LOG_GENERAL ("KDM is invalid: %1", e.what());
324 _standard = cpl->standard();
325 _three_d = !cpl->reels().empty() && cpl->reels().front()->main_picture() &&
326 dynamic_pointer_cast<dcp::StereoPictureAsset> (cpl->reels().front()->main_picture()->asset());
327 _ratings = cpl->ratings();
328 for (auto i: cpl->content_versions()) {
329 _content_versions.push_back (i.label_text);