2 Copyright (C) 2014-2022 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/>.
22 #include "atmos_decoder.h"
23 #include "audio_content.h"
24 #include "audio_decoder.h"
26 #include "dcp_content.h"
27 #include "dcp_decoder.h"
29 #include "ffmpeg_image_proxy.h"
30 #include "frame_interval_checker.h"
32 #include "j2k_image_proxy.h"
33 #include "text_decoder.h"
34 #include "video_decoder.h"
37 #include <dcp/decrypted_kdm.h>
38 #include <dcp/mono_picture_asset.h>
39 #include <dcp/mono_picture_asset_reader.h>
40 #include <dcp/mono_picture_frame.h>
42 #include <dcp/reel_atmos_asset.h>
43 #include <dcp/reel_closed_caption_asset.h>
44 #include <dcp/reel_picture_asset.h>
45 #include <dcp/reel_sound_asset.h>
46 #include <dcp/reel_subtitle_asset.h>
47 #include <dcp/sound_asset_reader.h>
48 #include <dcp/sound_frame.h>
49 #include <dcp/stereo_picture_asset.h>
50 #include <dcp/stereo_picture_asset_reader.h>
51 #include <dcp/stereo_picture_frame.h>
52 #include <dcp/subtitle_image.h>
59 using std::dynamic_pointer_cast;
61 using std::make_shared;
63 using std::shared_ptr;
66 using boost::optional;
67 using namespace dcpomatic;
70 DCPDecoder::DCPDecoder (shared_ptr<const Film> film, shared_ptr<const DCPContent> content, bool fast, bool tolerant, shared_ptr<DCPDecoder> old)
71 : DCP (content, tolerant)
74 if (content->can_be_played()) {
76 video = make_shared<VideoDecoder>(this, content);
79 audio = make_shared<AudioDecoder>(this, content->audio, fast);
81 for (auto i: content->text) {
82 /* XXX: this time here should be the time of the first subtitle, not 0 */
83 text.push_back (make_shared<TextDecoder>(this, i, ContentTime()));
86 atmos = make_shared<AtmosDecoder>(this, content);
90 /* We try to avoid re-scanning the DCP's files every time we make a new DCPDecoder; we do this
91 by re-using the _reels list. Before we do this we need to check that nothing too serious
92 has changed in the DCPContent.
94 We do this by storing a digest of the important bits of the DCPContent and then checking that's
95 the same before we re-use _reels.
98 _lazy_digest = calculate_lazy_digest (content);
100 if (old && old->lazy_digest() == _lazy_digest) {
101 _reels = old->_reels;
104 auto cpl_list = cpls ();
106 if (cpl_list.empty()) {
107 throw DCPError (_("No CPLs found in DCP."));
110 shared_ptr<dcp::CPL> cpl;
111 for (auto i: cpl_list) {
112 if (_dcp_content->cpl() && i->id() == _dcp_content->cpl().get()) {
118 /* No CPL found; probably an old file that doesn't specify it;
119 just use the first one.
121 cpl = cpls().front ();
124 _reels = cpl->reels ();
127 set_decode_referenced (false);
129 _reel = _reels.begin ();
137 if (!_dcp_content->can_be_played()) {
141 if (_reel == _reels.end()) {
148 auto const vfr = _dcp_content->active_video_frame_rate (film());
150 /* Frame within the (played part of the) reel that is coming up next */
151 auto const frame = _next.frames_round (vfr);
153 auto picture_asset = (*_reel)->main_picture()->asset();
154 DCPOMATIC_ASSERT (picture_asset);
156 /* We must emit texts first as when we emit the video for this frame
157 it will expect already to have the texts.
159 pass_texts (_next, picture_asset->size());
161 if ((_mono_reader || _stereo_reader) && (_decode_referenced || !_dcp_content->reference_video())) {
162 auto const entry_point = (*_reel)->main_picture()->entry_point().get_value_or(0);
166 std::make_shared<J2KImageProxy>(
167 _mono_reader->get_frame (entry_point + frame),
168 picture_asset->size(),
177 std::make_shared<J2KImageProxy>(
178 _stereo_reader->get_frame (entry_point + frame),
179 picture_asset->size(),
189 std::make_shared<J2KImageProxy>(
190 _stereo_reader->get_frame (entry_point + frame),
191 picture_asset->size(),
201 if (_sound_reader && (_decode_referenced || !_dcp_content->reference_audio())) {
202 auto const entry_point = (*_reel)->main_sound()->entry_point().get_value_or(0);
203 auto sf = _sound_reader->get_frame (entry_point + frame);
204 auto from = sf->data ();
206 int const channels = _dcp_content->audio->stream()->channels ();
207 int const frames = sf->size() / (3 * channels);
208 auto data = make_shared<AudioBuffers>(channels, frames);
209 auto data_data = data->data();
210 for (int i = 0; i < frames; ++i) {
211 for (int j = 0; j < channels; ++j) {
212 data_data[j][i] = static_cast<int> ((from[0] << 8) | (from[1] << 16) | (from[2] << 24)) / static_cast<float> (INT_MAX - 256);
217 audio->emit (film(), _dcp_content->audio->stream(), data, ContentTime::from_frames (_offset, vfr) + _next);
221 DCPOMATIC_ASSERT (_atmos_metadata);
222 auto const entry_point = (*_reel)->atmos()->entry_point().get_value_or(0);
223 atmos->emit (film(), _atmos_reader->get_frame(entry_point + frame), _offset + frame, *_atmos_metadata);
226 _next += ContentTime::from_frames (1, vfr);
228 if ((*_reel)->main_picture ()) {
229 if (_next.frames_round (vfr) >= (*_reel)->main_picture()->duration()) {
231 _next = ContentTime ();
240 DCPDecoder::pass_texts (ContentTime next, dcp::Size size)
242 auto decoder = text.begin ();
243 if (decoder == text.end()) {
244 /* It's possible that there is now a main subtitle but no TextDecoders, for example if
245 the CPL has just changed but the TextContent's texts have not been recreated yet.
250 if ((*_reel)->main_subtitle()) {
253 (*_reel)->main_subtitle()->asset(),
254 _dcp_content->reference_text(TextType::OPEN_SUBTITLE),
255 (*_reel)->main_subtitle()->entry_point().get_value_or(0),
262 for (auto i: (*_reel)->closed_captions()) {
264 next, i->asset(), _dcp_content->reference_text(TextType::CLOSED_CAPTION), i->entry_point().get_value_or(0), *decoder, size
271 DCPDecoder::pass_texts (
272 ContentTime next, shared_ptr<dcp::SubtitleAsset> asset, bool reference, int64_t entry_point, shared_ptr<TextDecoder> decoder, dcp::Size size
275 auto const vfr = _dcp_content->active_video_frame_rate (film());
276 /* Frame within the (played part of the) reel that is coming up next */
277 auto const frame = next.frames_round (vfr);
279 if (_decode_referenced || !reference) {
280 auto subs = asset->subtitles_during (
281 dcp::Time (entry_point + frame, vfr, vfr),
282 dcp::Time (entry_point + frame + 1, vfr, vfr),
286 list<dcp::SubtitleString> strings;
289 auto is = dynamic_pointer_cast<const dcp::SubtitleString>(i);
291 if (!strings.empty() && (strings.back().in() != is->in() || strings.back().out() != is->out())) {
292 auto b = strings.back();
293 decoder->emit_plain (
295 ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
296 ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
303 strings.push_back (*is);
306 /* XXX: perhaps these image subs should also be collected together like the string ones are;
307 this would need to be done both here and in DCPSubtitleDecoder.
310 auto ii = dynamic_pointer_cast<const dcp::SubtitleImage>(i);
312 emit_subtitle_image (
314 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->in().as_seconds ()),
315 ContentTime::from_frames (_offset - entry_point, vfr) + ContentTime::from_seconds (i->out().as_seconds ())
324 if (!strings.empty()) {
325 auto b = strings.back();
326 decoder->emit_plain (
328 ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.in().as_seconds()),
329 ContentTime::from_frames(_offset - entry_point, vfr) + ContentTime::from_seconds(b.out().as_seconds())
340 DCPDecoder::next_reel ()
342 _offset += (*_reel)->main_picture()->actual_duration();
349 DCPDecoder::get_readers ()
351 if (_reel == _reels.end() || !_dcp_content->can_be_played ()) {
352 _mono_reader.reset ();
353 _stereo_reader.reset ();
354 _sound_reader.reset ();
355 _atmos_reader.reset ();
359 if ((*_reel)->main_picture()) {
360 auto asset = (*_reel)->main_picture()->asset ();
361 auto mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (asset);
362 auto stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (asset);
363 DCPOMATIC_ASSERT (mono || stereo);
365 _mono_reader = mono->start_read ();
366 _mono_reader->set_check_hmac (false);
367 _stereo_reader.reset ();
369 _stereo_reader = stereo->start_read ();
370 _stereo_reader->set_check_hmac (false);
371 _mono_reader.reset ();
374 _mono_reader.reset ();
375 _stereo_reader.reset ();
378 if ((*_reel)->main_sound()) {
379 _sound_reader = (*_reel)->main_sound()->asset()->start_read ();
380 _sound_reader->set_check_hmac (false);
382 _sound_reader.reset ();
385 if ((*_reel)->atmos()) {
386 auto asset = (*_reel)->atmos()->asset();
387 _atmos_reader = asset->start_read();
388 _atmos_reader->set_check_hmac (false);
389 _atmos_metadata = AtmosMetadata (asset);
391 _atmos_reader.reset ();
392 _atmos_metadata = boost::none;
398 DCPDecoder::seek (ContentTime t, bool accurate)
400 if (!_dcp_content->can_be_played ()) {
404 Decoder::seek (t, accurate);
406 _reel = _reels.begin ();
410 int const pre_roll_seconds = 2;
412 /* Pre-roll for subs */
414 auto pre = t - ContentTime::from_seconds (pre_roll_seconds);
415 if (pre < ContentTime()) {
416 pre = ContentTime ();
419 /* Seek to pre-roll position */
422 _reel != _reels.end() &&
423 pre >= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()))
426 auto rd = ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()));
432 /* Pass texts in the pre-roll */
434 auto const vfr = _dcp_content->active_video_frame_rate (film());
435 for (int i = 0; i < pre_roll_seconds * vfr; ++i) {
436 pass_texts (pre, (*_reel)->main_picture()->asset()->size());
437 pre += ContentTime::from_frames (1, vfr);
440 /* Seek to correct position */
443 _reel != _reels.end() &&
444 t >= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()))
447 t -= ContentTime::from_frames ((*_reel)->main_picture()->actual_duration(), _dcp_content->active_video_frame_rate(film()));
456 DCPDecoder::set_decode_referenced (bool r)
458 _decode_referenced = r;
461 video->set_ignore (_dcp_content->reference_video() && !_decode_referenced);
464 audio->set_ignore (_dcp_content->reference_audio() && !_decode_referenced);
470 DCPDecoder::set_forced_reduction (optional<int> reduction)
472 _forced_reduction = reduction;
477 DCPDecoder::calculate_lazy_digest (shared_ptr<const DCPContent> c) const
480 for (auto i: c->paths()) {
483 if (_dcp_content->kdm()) {
484 d.add(_dcp_content->kdm()->id());
486 d.add (static_cast<bool>(c->cpl()));
488 d.add (c->cpl().get());
495 DCPDecoder::position () const
497 return ContentTime::from_frames(_offset, _dcp_content->active_video_frame_rate(film())) + _next;
502 DCPDecoder::fonts () const
504 vector<FontData> data;
505 for (auto i: _reels) {
506 if (i->main_subtitle() && i->main_subtitle()->asset()) {
507 for (auto const& j: i->main_subtitle()->asset()->font_data()) {
508 data.push_back (FontData(j.first, j.second));