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> selected_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;
82 for (auto cpl: cpls) {
84 for (auto reel: cpl->reels()) {
85 if (reel->main_picture() && !reel->main_picture()->asset_ref().resolved()) {
88 if (reel->main_sound() && !reel->main_sound()->asset_ref().resolved()) {
91 if (reel->main_subtitle() && !reel->main_subtitle()->asset_ref().resolved()) {
94 if (reel->atmos() && !reel->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 selected_cpl->add(decrypt_kdm_with_helpful_error(content->kdm().get()));
114 _cpl = selected_cpl->id();
115 _name = selected_cpl->content_title_text();
116 _content_kind = selected_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", selected_cpl->reels().size());
131 for (auto reel: selected_cpl->reels()) {
132 LOG_GENERAL("Reel %1", reel->id());
133 vector<shared_ptr<dcpomatic::Font>> reel_fonts;
135 if (reel->main_picture()) {
136 if (!reel->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", reel->main_picture()->id(), reel->id());
143 LOG_GENERAL("Main picture %1 of reel %2 found", reel->main_picture()->id(), reel->id());
145 auto const frac = reel->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 = reel->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 += reel->main_picture()->actual_duration();
164 if (reel->main_sound()) {
165 if (!reel->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", reel->main_sound()->id(), reel->id());
172 LOG_GENERAL("Main sound %1 of reel %2 found", reel->main_sound()->id(), reel->id());
175 auto asset = reel->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 += reel->main_sound()->actual_duration();
190 _audio_language = try_to_parse_language (asset->language());
193 if (reel->main_subtitle()) {
194 if (!reel->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", reel->main_subtitle()->id(), reel->id());
201 LOG_GENERAL("Main subtitle %1 of reel %2 found", reel->main_subtitle()->id(), reel->id());
203 _text_count[TextType::OPEN_SUBTITLE] = 1;
204 _open_subtitle_language = try_to_parse_language(reel->main_subtitle()->language());
206 for (auto const& font: reel->main_subtitle()->asset()->font_data()) {
207 reel_fonts.push_back(make_shared<dcpomatic::Font>(font.first, font.second));
211 _text_count[TextType::CLOSED_CAPTION] = std::max(_text_count[TextType::CLOSED_CAPTION], static_cast<int>(reel->closed_captions().size()));
212 if (_dcp_text_tracks.size() < reel->closed_captions().size()) {
213 /* We only want to add 1 DCPTextTrack to _dcp_text_tracks per closed caption. I guess it's possible that different
214 * reels have different numbers of tracks (though I don't think they should) so make sure that _dcp_text_tracks ends
215 * up with the maximum.
217 _dcp_text_tracks.clear();
218 for (auto ccap: reel->closed_captions()) {
219 _dcp_text_tracks.push_back(DCPTextTrack(ccap->annotation_text().get_value_or(""), try_to_parse_language(ccap->language())));
223 for (auto ccap: reel->closed_captions()) {
224 if (!ccap->asset_ref().resolved()) {
225 /* We are missing this asset so we can't continue; examination will be repeated later */
226 _needs_assets = true;
227 LOG_GENERAL("Closed caption %1 of reel %2 is missing", ccap->id(), reel->id());
231 LOG_GENERAL("Closed caption %1 of reel %2 found", ccap->id(), reel->id());
233 for (auto const& font: ccap->asset()->font_data()) {
234 reel_fonts.push_back(make_shared<dcpomatic::Font>(font.first, font.second));
238 if (reel->main_markers ()) {
239 auto rm = reel->main_markers()->get();
240 _markers.insert (rm.begin(), rm.end());
245 _atmos_length += reel->atmos()->actual_duration();
246 if (_atmos_edit_rate != dcp::Fraction()) {
247 DCPOMATIC_ASSERT(reel->atmos()->edit_rate() == _atmos_edit_rate);
249 _atmos_edit_rate = reel->atmos()->edit_rate();
252 if (reel->main_picture()) {
253 _reel_lengths.push_back(reel->main_picture()->actual_duration());
254 } else if (reel->main_sound()) {
255 _reel_lengths.push_back(reel->main_sound()->actual_duration());
256 } else if (reel->main_subtitle()) {
257 _reel_lengths.push_back(reel->main_subtitle()->actual_duration());
258 } else if (!reel->closed_captions().empty()) {
259 _reel_lengths.push_back(reel->closed_captions().front()->actual_duration());
260 } else if (!reel->atmos()) {
261 _reel_lengths.push_back(reel->atmos()->actual_duration());
264 if (reel_fonts.empty()) {
265 reel_fonts.push_back(make_shared<dcpomatic::Font>(""));
268 _fonts.push_back(reel_fonts);
271 _encrypted = selected_cpl->any_encrypted();
274 LOG_GENERAL_NC ("Check that everything encrypted has a key");
276 /* Check first that anything encrypted has a key. We must do this, as if we try to
277 * read encrypted data with asdcplib without even offering a key it will just return
278 * the encrypted data. Secondly, check that we can read the first thing from each
279 * asset in each reel. This checks that when we do have a key it's the right one.
282 for (auto i: selected_cpl->reels()) {
283 LOG_GENERAL ("Reel %1", i->id());
284 auto pic = i->main_picture()->asset();
285 if (pic->encrypted() && !pic->key()) {
287 LOG_GENERAL_NC ("Picture has no key");
290 auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset>(pic);
291 auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset>(pic);
294 auto reader = mono->start_read();
295 reader->set_check_hmac (false);
296 reader->get_frame(0)->xyz_image();
298 auto reader = stereo->start_read();
299 reader->set_check_hmac (false);
300 reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
303 if (i->main_sound()) {
304 auto sound = i->main_sound()->asset ();
305 if (sound->encrypted() && !sound->key()) {
307 LOG_GENERAL_NC ("Sound has no key");
310 auto reader = i->main_sound()->asset()->start_read();
311 reader->set_check_hmac (false);
312 reader->get_frame(0);
315 if (i->main_subtitle()) {
316 auto sub = i->main_subtitle()->asset();
317 auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
318 if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
320 LOG_GENERAL_NC ("Subtitle has no key");
327 auto atmos = i->atmos()->asset();
328 if (atmos->encrypted() && !atmos->key()) {
330 LOG_GENERAL_NC ("ATMOS sound has no key");
333 auto reader = atmos->start_read();
334 reader->set_check_hmac (false);
335 reader->get_frame(0);
338 } catch (dcp::ReadError& e) {
340 LOG_GENERAL ("KDM is invalid: %1", e.what());
341 } catch (dcp::MiscError& e) {
343 LOG_GENERAL ("KDM is invalid: %1", e.what());
346 _standard = selected_cpl->standard();
347 _three_d = !selected_cpl->reels().empty() && selected_cpl->reels().front()->main_picture() &&
348 dynamic_pointer_cast<dcp::StereoPictureAsset>(selected_cpl->reels().front()->main_picture()->asset());
349 _ratings = selected_cpl->ratings();
350 for (auto version: selected_cpl->content_versions()) {
351 _content_versions.push_back(version.label_text);
354 _cpl = selected_cpl->id();