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::make_shared;
58 using std::shared_ptr;
61 using boost::optional;
64 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
66 shared_ptr<dcp::CPL> cpl;
68 auto cpls = dcp::find_and_resolve_cpls (content->directories(), tolerant);
70 if (content->cpl ()) {
71 /* Use the CPL that was specified, or that the content was using before */
72 auto iter = std::find_if(cpls.begin(), cpls.end(), [content](shared_ptr<dcp::CPL> cpl) { return cpl->id() == content->cpl().get(); });
73 if (iter == cpls.end()) {
74 throw CPLNotFoundError(content->cpl().get());
78 /* Choose the CPL with the fewest unsatisfied references */
80 int least_unsatisfied = INT_MAX;
84 for (auto j: i->reels()) {
85 if (j->main_picture() && !j->main_picture()->asset_ref().resolved()) {
88 if (j->main_sound() && !j->main_sound()->asset_ref().resolved()) {
91 if (j->main_subtitle() && !j->main_subtitle()->asset_ref().resolved()) {
94 if (j->atmos() && !j->atmos()->asset_ref().resolved()) {
99 if (unsatisfied < least_unsatisfied) {
100 least_unsatisfied = unsatisfied;
107 throw DCPError ("No CPLs found in DCP");
110 if (content->kdm()) {
111 cpl->add (decrypt_kdm_with_helpful_error(content->kdm().get()));
115 _name = cpl->content_title_text ();
116 _content_kind = cpl->content_kind ();
118 LOG_GENERAL ("Selected CPL %1", _cpl);
120 auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
123 return dcp::LanguageTag (*lang);
129 LOG_GENERAL ("Looking at %1 reels", cpl->reels().size());
131 for (auto i: cpl->reels()) {
132 LOG_GENERAL ("Reel %1", i->id());
133 vector<shared_ptr<dcpomatic::Font>> reel_fonts;
135 if (i->main_picture ()) {
136 if (!i->main_picture()->asset_ref().resolved()) {
137 /* We are missing this asset so we can't continue; examination will be repeated later */
138 _needs_assets = true;
139 LOG_GENERAL ("Main picture %1 of reel %2 is missing", i->main_picture()->id(), i->id());
143 LOG_GENERAL ("Main picture %1 of reel %2 found", i->main_picture()->id(), i->id());
145 auto const frac = i->main_picture()->edit_rate ();
146 float const fr = float(frac.numerator) / frac.denominator;
147 if (!_video_frame_rate) {
148 _video_frame_rate = fr;
149 } else if (_video_frame_rate.get() != fr) {
150 throw DCPError (_("Mismatched frame rates in DCP"));
154 auto asset = i->main_picture()->asset();
156 _video_size = asset->size ();
157 } else if (_video_size.get() != asset->size ()) {
158 throw DCPError (_("Mismatched video sizes in DCP"));
161 _video_length += i->main_picture()->actual_duration();
164 if (i->main_sound ()) {
165 if (!i->main_sound()->asset_ref().resolved()) {
166 /* We are missing this asset so we can't continue; examination will be repeated later */
167 _needs_assets = true;
168 LOG_GENERAL ("Main sound %1 of reel %2 is missing", i->main_sound()->id(), i->id());
172 LOG_GENERAL ("Main sound %1 of reel %2 found", i->main_sound()->id(), i->id());
175 auto asset = i->main_sound()->asset();
177 if (!_audio_channels) {
178 _audio_channels = asset->channels ();
179 } else if (_audio_channels.get() != asset->channels ()) {
180 throw DCPError (_("Mismatched audio channel counts in DCP"));
183 if (!_audio_frame_rate) {
184 _audio_frame_rate = asset->sampling_rate ();
185 } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
186 throw DCPError (_("Mismatched audio sample rates in DCP"));
189 _audio_length += i->main_sound()->actual_duration();
190 _audio_language = try_to_parse_language (asset->language());
193 if (i->main_subtitle ()) {
194 if (!i->main_subtitle()->asset_ref().resolved()) {
195 /* We are missing this asset so we can't continue; examination will be repeated later */
196 _needs_assets = true;
197 LOG_GENERAL ("Main subtitle %1 of reel %2 is missing", i->main_subtitle()->id(), i->id());
201 LOG_GENERAL ("Main subtitle %1 of reel %2 found", i->main_subtitle()->id(), i->id());
203 _text_count[TextType::OPEN_SUBTITLE] = 1;
204 _open_subtitle_language = try_to_parse_language (i->main_subtitle()->language());
206 for (auto const& font: i->main_subtitle()->asset()->font_data()) {
207 reel_fonts.push_back(make_shared<dcpomatic::Font>(font.first, font.second));
211 for (auto j: i->closed_captions()) {
212 if (!j->asset_ref().resolved()) {
213 /* We are missing this asset so we can't continue; examination will be repeated later */
214 _needs_assets = true;
215 LOG_GENERAL ("Closed caption %1 of reel %2 is missing", j->id(), i->id());
219 LOG_GENERAL ("Closed caption %1 of reel %2 found", j->id(), i->id());
221 _text_count[TextType::CLOSED_CAPTION]++;
222 _dcp_text_tracks.push_back (DCPTextTrack(j->annotation_text().get_value_or(""), try_to_parse_language(j->language())));
225 if (i->main_markers ()) {
226 auto rm = i->main_markers()->get();
227 _markers.insert (rm.begin(), rm.end());
232 _atmos_length += i->atmos()->actual_duration();
233 if (_atmos_edit_rate != dcp::Fraction()) {
234 DCPOMATIC_ASSERT (i->atmos()->edit_rate() == _atmos_edit_rate);
236 _atmos_edit_rate = i->atmos()->edit_rate();
239 if (i->main_picture()) {
240 _reel_lengths.push_back (i->main_picture()->actual_duration());
241 } else if (i->main_sound()) {
242 _reel_lengths.push_back (i->main_sound()->actual_duration());
243 } else if (i->main_subtitle()) {
244 _reel_lengths.push_back (i->main_subtitle()->actual_duration());
245 } else if (!i->closed_captions().empty()) {
246 _reel_lengths.push_back (i->closed_captions().front()->actual_duration());
247 } else if (!i->atmos()) {
248 _reel_lengths.push_back (i->atmos()->actual_duration());
251 if (reel_fonts.empty()) {
252 reel_fonts.push_back(make_shared<dcpomatic::Font>(""));
255 _fonts.push_back(reel_fonts);
258 _encrypted = cpl->any_encrypted ();
261 LOG_GENERAL_NC ("Check that everything encrypted has a key");
263 /* Check first that anything encrypted has a key. We must do this, as if we try to
264 * read encrypted data with asdcplib without even offering a key it will just return
265 * the encrypted data. Secondly, check that we can read the first thing from each
266 * asset in each reel. This checks that when we do have a key it's the right one.
269 for (auto i: cpl->reels()) {
270 LOG_GENERAL ("Reel %1", i->id());
271 auto pic = i->main_picture()->asset();
272 if (pic->encrypted() && !pic->key()) {
274 LOG_GENERAL_NC ("Picture has no key");
277 auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
278 auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
281 auto reader = mono->start_read();
282 reader->set_check_hmac (false);
283 reader->get_frame(0)->xyz_image();
285 auto reader = stereo->start_read();
286 reader->set_check_hmac (false);
287 reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
290 if (i->main_sound()) {
291 auto sound = i->main_sound()->asset ();
292 if (sound->encrypted() && !sound->key()) {
294 LOG_GENERAL_NC ("Sound has no key");
297 auto reader = i->main_sound()->asset()->start_read();
298 reader->set_check_hmac (false);
299 reader->get_frame(0);
302 if (i->main_subtitle()) {
303 auto sub = i->main_subtitle()->asset();
304 auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
305 if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
307 LOG_GENERAL_NC ("Subtitle has no key");
314 auto atmos = i->atmos()->asset();
315 if (atmos->encrypted() && !atmos->key()) {
317 LOG_GENERAL_NC ("ATMOS sound has no key");
320 auto reader = atmos->start_read();
321 reader->set_check_hmac (false);
322 reader->get_frame(0);
325 } catch (dcp::ReadError& e) {
327 LOG_GENERAL ("KDM is invalid: %1", e.what());
328 } catch (dcp::MiscError& e) {
330 LOG_GENERAL ("KDM is invalid: %1", e.what());
333 _standard = cpl->standard();
334 _three_d = !cpl->reels().empty() && cpl->reels().front()->main_picture() &&
335 dynamic_pointer_cast<dcp::StereoPictureAsset> (cpl->reels().front()->main_picture()->asset());
336 _ratings = cpl->ratings();
337 for (auto i: cpl->content_versions()) {
338 _content_versions.push_back (i.label_text);