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 "constants.h"
24 #include "dcp_content.h"
25 #include "dcp_examiner.h"
26 #include "dcpomatic_log.h"
27 #include "exceptions.h"
28 #include "font_id_allocator.h"
30 #include "text_content.h"
34 #include <dcp/decrypted_kdm.h>
35 #include <dcp/mono_j2k_picture_asset.h>
36 #include <dcp/mono_j2k_picture_asset_reader.h>
37 #include <dcp/mono_j2k_picture_frame.h>
39 #include <dcp/reel_atmos_asset.h>
40 #include <dcp/reel_closed_caption_asset.h>
41 #include <dcp/reel_markers_asset.h>
42 #include <dcp/reel_picture_asset.h>
43 #include <dcp/reel_sound_asset.h>
44 #include <dcp/reel_subtitle_asset.h>
45 #include <dcp/search.h>
46 #include <dcp/sound_asset.h>
47 #include <dcp/sound_asset.h>
48 #include <dcp/sound_asset_reader.h>
49 #include <dcp/stereo_j2k_picture_asset.h>
50 #include <dcp/stereo_j2k_picture_asset_reader.h>
51 #include <dcp/stereo_j2k_picture_frame.h>
52 #include <dcp/subtitle_asset.h>
59 using std::dynamic_pointer_cast;
60 using std::make_shared;
61 using std::shared_ptr;
64 using boost::optional;
67 DCPExaminer::DCPExaminer (shared_ptr<const DCPContent> content, bool tolerant)
69 shared_ptr<dcp::CPL> selected_cpl;
71 auto cpls = dcp::find_and_resolve_cpls (content->directories(), tolerant);
73 if (content->cpl ()) {
74 /* Use the CPL that was specified, or that the content was using before */
75 auto iter = std::find_if(cpls.begin(), cpls.end(), [content](shared_ptr<dcp::CPL> cpl) { return cpl->id() == content->cpl().get(); });
76 if (iter == cpls.end()) {
77 throw CPLNotFoundError(content->cpl().get());
81 /* Choose the CPL with the fewest unsatisfied references */
83 int least_unsatisfied = INT_MAX;
85 for (auto cpl: cpls) {
87 for (auto const& reel: cpl->reels()) {
88 if (reel->main_picture() && !reel->main_picture()->asset_ref().resolved()) {
91 if (reel->main_sound() && !reel->main_sound()->asset_ref().resolved()) {
94 if (reel->main_subtitle() && !reel->main_subtitle()->asset_ref().resolved()) {
97 if (reel->atmos() && !reel->atmos()->asset_ref().resolved()) {
102 if (unsatisfied < least_unsatisfied) {
103 least_unsatisfied = unsatisfied;
110 throw DCPError ("No CPLs found in DCP");
113 if (content->kdm()) {
114 selected_cpl->add(decrypt_kdm_with_helpful_error(content->kdm().get()));
117 _cpl = selected_cpl->id();
118 _name = selected_cpl->content_title_text();
119 _content_kind = selected_cpl->content_kind();
121 LOG_GENERAL ("Selected CPL %1", _cpl);
123 auto try_to_parse_language = [](optional<string> lang) -> boost::optional<dcp::LanguageTag> {
126 return dcp::LanguageTag (*lang);
132 LOG_GENERAL("Looking at %1 reels", selected_cpl->reels().size());
135 for (auto reel: selected_cpl->reels()) {
136 LOG_GENERAL("Reel %1", reel->id());
138 if (reel->main_picture()) {
139 /* This will mean a VF can be displayed in the timeline even if its picture asset
140 * is yet be resolved.
143 _video_length += reel->main_picture()->actual_duration();
145 if (!reel->main_picture()->asset_ref().resolved()) {
146 LOG_GENERAL("Main picture %1 of reel %2 is missing", reel->main_picture()->id(), reel->id());
147 _needs_assets = true;
149 LOG_GENERAL("Main picture %1 of reel %2 found", reel->main_picture()->id(), reel->id());
151 auto const frac = reel->main_picture()->edit_rate();
152 float const fr = float(frac.numerator) / frac.denominator;
153 if (!_video_frame_rate) {
154 _video_frame_rate = fr;
155 } else if (_video_frame_rate.get() != fr) {
156 throw DCPError (_("Mismatched frame rates in DCP"));
159 auto asset = reel->main_picture()->asset();
161 _video_size = asset->size ();
162 } else if (_video_size.get() != asset->size ()) {
163 throw DCPError (_("Mismatched video sizes in DCP"));
168 if (reel->main_sound()) {
170 _audio_length += reel->main_sound()->actual_duration();
172 if (!reel->main_sound()->asset_ref().resolved()) {
173 LOG_GENERAL("Main sound %1 of reel %2 is missing", reel->main_sound()->id(), reel->id());
174 _needs_assets = true;
176 LOG_GENERAL("Main sound %1 of reel %2 found", reel->main_sound()->id(), reel->id());
178 auto asset = reel->main_sound()->asset();
180 if (!_audio_channels) {
181 _audio_channels = asset->channels();
182 } else if (_audio_channels.get() != asset->channels()) {
183 throw DCPError (_("Mismatched audio channel counts in DCP"));
186 _active_audio_channels = std::max(_active_audio_channels.get_value_or(0), asset->active_channels());
188 if (!_audio_frame_rate) {
189 _audio_frame_rate = asset->sampling_rate ();
190 } else if (_audio_frame_rate.get() != asset->sampling_rate ()) {
191 throw DCPError (_("Mismatched audio sample rates in DCP"));
194 _audio_language = try_to_parse_language (asset->language());
198 if (auto sub = reel->main_subtitle()) {
199 if (sub->entry_point().get_value_or(0) != 0) {
200 _has_non_zero_entry_point[TextType::OPEN_SUBTITLE] = true;
202 if (!sub->asset_ref().resolved()) {
203 LOG_GENERAL("Main subtitle %1 of reel %2 is missing", sub->id(), reel->id());
204 _needs_assets = true;
206 LOG_GENERAL("Main subtitle %1 of reel %2 found", sub->id(), reel->id());
208 _text_count[TextType::OPEN_SUBTITLE] = 1;
209 _open_subtitle_language = try_to_parse_language(sub->language());
211 auto asset = sub->asset();
212 for (auto const& font: asset->font_data()) {
213 _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
218 _text_count[TextType::CLOSED_CAPTION] = std::max(_text_count[TextType::CLOSED_CAPTION], static_cast<int>(reel->closed_captions().size()));
219 if (_dcp_text_tracks.size() < reel->closed_captions().size()) {
220 /* We only want to add 1 DCPTextTrack to _dcp_text_tracks per closed caption. I guess it's possible that different
221 * reels have different numbers of tracks (though I don't think they should) so make sure that _dcp_text_tracks ends
222 * up with the maximum.
224 _dcp_text_tracks.clear();
225 for (auto ccap: reel->closed_captions()) {
226 _dcp_text_tracks.push_back(DCPTextTrack(ccap->annotation_text().get_value_or(""), try_to_parse_language(ccap->language())));
230 for (auto ccap: reel->closed_captions()) {
231 if (ccap->entry_point().get_value_or(0) != 0) {
232 _has_non_zero_entry_point[TextType::CLOSED_CAPTION] = true;
234 if (!ccap->asset_ref().resolved()) {
235 LOG_GENERAL("Closed caption %1 of reel %2 is missing", ccap->id(), reel->id());
236 _needs_assets = true;
238 LOG_GENERAL("Closed caption %1 of reel %2 found", ccap->id(), reel->id());
240 auto asset = ccap->asset();
241 for (auto const& font: asset->font_data()) {
242 _fonts.push_back({reel_index, asset->id(), make_shared<dcpomatic::Font>(font.first, font.second)});
247 if (reel->main_markers ()) {
248 auto rm = reel->main_markers()->get();
249 _markers.insert (rm.begin(), rm.end());
254 _atmos_length += reel->atmos()->actual_duration();
255 if (_atmos_edit_rate != dcp::Fraction()) {
256 DCPOMATIC_ASSERT(reel->atmos()->edit_rate() == _atmos_edit_rate);
258 _atmos_edit_rate = reel->atmos()->edit_rate();
261 if (reel->main_picture()) {
262 _reel_lengths.push_back(reel->main_picture()->actual_duration());
263 } else if (reel->main_sound()) {
264 _reel_lengths.push_back(reel->main_sound()->actual_duration());
265 } else if (reel->main_subtitle()) {
266 _reel_lengths.push_back(reel->main_subtitle()->actual_duration());
267 } else if (!reel->closed_captions().empty()) {
268 _reel_lengths.push_back(reel->closed_captions().front()->actual_duration());
269 } else if (!reel->atmos()) {
270 _reel_lengths.push_back(reel->atmos()->actual_duration());
276 _encrypted = selected_cpl->any_encrypted();
279 LOG_GENERAL_NC ("Check that everything encrypted has a key");
281 /* Check first that anything encrypted has a key. We must do this, as if we try to
282 * read encrypted data with asdcplib without even offering a key it will just return
283 * the encrypted data. Secondly, check that we can read the first thing from each
284 * asset in each reel. This checks that when we do have a key it's the right one.
287 for (auto i: selected_cpl->reels()) {
288 LOG_GENERAL ("Reel %1", i->id());
289 if (i->main_picture() && i->main_picture()->asset_ref().resolved()) {
290 auto pic = i->main_picture()->asset();
291 if (pic->encrypted() && !pic->key()) {
293 LOG_GENERAL_NC ("Picture has no key");
296 auto j2k_mono = dynamic_pointer_cast<dcp::MonoJ2KPictureAsset>(pic);
297 auto j2k_stereo = dynamic_pointer_cast<dcp::StereoJ2KPictureAsset>(pic);
300 auto reader = j2k_mono->start_read();
301 reader->set_check_hmac (false);
302 reader->get_frame(0)->xyz_image();
303 } else if (j2k_stereo) {
304 auto reader = j2k_stereo->start_read();
305 reader->set_check_hmac (false);
306 reader->get_frame(0)->xyz_image(dcp::Eye::LEFT);
310 if (i->main_sound() && i->main_sound()->asset_ref().resolved()) {
311 auto sound = i->main_sound()->asset();
312 if (sound->encrypted() && !sound->key()) {
314 LOG_GENERAL_NC ("Sound has no key");
317 auto reader = sound->start_read();
318 reader->set_check_hmac (false);
319 reader->get_frame(0);
322 if (i->main_subtitle() && i->main_subtitle()->asset_ref().resolved()) {
323 auto sub = i->main_subtitle()->asset();
324 auto mxf_sub = dynamic_pointer_cast<dcp::MXF>(sub);
325 if (mxf_sub && mxf_sub->encrypted() && !mxf_sub->key()) {
327 LOG_GENERAL_NC ("Subtitle has no key");
333 if (i->atmos() && i->atmos()->asset_ref().resolved()) {
334 if (auto atmos = i->atmos()->asset()) {
335 if (atmos->encrypted() && !atmos->key()) {
337 LOG_GENERAL_NC ("ATMOS sound has no key");
340 auto reader = atmos->start_read();
341 reader->set_check_hmac (false);
342 reader->get_frame(0);
346 } catch (dcp::ReadError& e) {
348 LOG_GENERAL ("KDM is invalid: %1", e.what());
349 } catch (dcp::MiscError& e) {
351 LOG_GENERAL ("KDM is invalid: %1", e.what());
354 _standard = selected_cpl->standard();
355 if (!selected_cpl->reels().empty()) {
356 auto first_reel = selected_cpl->reels()[0];
357 _three_d = first_reel->main_picture() && first_reel->main_picture()->asset_ref().resolved() && dynamic_pointer_cast<dcp::StereoJ2KPictureAsset>(first_reel->main_picture()->asset());
359 _ratings = selected_cpl->ratings();
360 for (auto version: selected_cpl->content_versions()) {
361 _content_versions.push_back(version.label_text);
364 _cpl = selected_cpl->id();
369 DCPExaminer::add_fonts(shared_ptr<TextContent> content)
371 FontIDAllocator font_id_allocator;
373 for (auto const& font: _fonts) {
374 font_id_allocator.add_font(font.reel_index, font.asset_id, font.font->id());
377 font_id_allocator.allocate();
379 for (auto const& font: _fonts) {
380 auto font_copy = make_shared<dcpomatic::Font>(*font.font);
381 font_copy->set_id(font_id_allocator.font_id(font.reel_index, font.asset_id, font.font->id()));
382 content->add_font(font_copy);
385 if (!font_id_allocator.has_default_font()) {
386 content->add_font(make_shared<dcpomatic::Font>(font_id_allocator.default_font_id(), default_font_file()));