2 Copyright (C) 2012-2019 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/>.
21 #include "reel_writer.h"
26 #include "dcpomatic_log.h"
29 #include "compose.hpp"
30 #include "audio_buffers.h"
32 #include <dcp/mono_picture_asset.h>
33 #include <dcp/stereo_picture_asset.h>
34 #include <dcp/sound_asset.h>
35 #include <dcp/sound_asset_writer.h>
37 #include <dcp/reel_mono_picture_asset.h>
38 #include <dcp/reel_stereo_picture_asset.h>
39 #include <dcp/reel_sound_asset.h>
40 #include <dcp/reel_subtitle_asset.h>
41 #include <dcp/reel_closed_caption_asset.h>
44 #include <dcp/certificate_chain.h>
45 #include <dcp/interop_subtitle_asset.h>
46 #include <dcp/smpte_subtitle_asset.h>
47 #include <dcp/raw_convert.h>
48 #include <dcp/subtitle_image.h>
49 #include <boost/foreach.hpp>
58 using boost::shared_ptr;
59 using boost::optional;
60 using boost::dynamic_pointer_cast;
62 using dcp::raw_convert;
64 int const ReelWriter::_info_size = 48;
66 /** @param job Related job, or 0 */
67 ReelWriter::ReelWriter (
68 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
72 , _last_written_video_frame (-1)
73 , _last_written_eyes (EYES_RIGHT)
74 , _reel_index (reel_index)
75 , _reel_count (reel_count)
76 , _content_summary (content_summary)
79 /* Create our picture asset in a subdirectory, named according to those
80 film's parameters which affect the video output. We will hard-link
81 it into the DCP later.
84 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
86 if (_film->three_d ()) {
87 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
89 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
92 _picture_asset->set_size (_film->frame_size ());
94 if (_film->encrypted ()) {
95 _picture_asset->set_key (_film->key ());
96 _picture_asset->set_context_id (_film->context_id ());
99 _picture_asset->set_file (
100 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
103 _first_nonexistant_frame = check_existing_picture_asset ();
105 _picture_asset_writer = _picture_asset->start_write (
106 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
107 _first_nonexistant_frame > 0
110 if (_film->audio_channels ()) {
112 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
115 if (_film->encrypted ()) {
116 _sound_asset->set_key (_film->key ());
119 DCPOMATIC_ASSERT (_film->directory());
121 /* Write the sound asset into the film directory so that we leave the creation
122 of the DCP directory until the last minute.
124 _sound_asset_writer = _sound_asset->start_write (
125 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
130 /** @param frame reel-relative frame */
132 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
134 shared_ptr<InfoFileHandle> handle = _film->info_file_handle(_period, false);
135 dcpomatic_fseek (handle->get(), frame_info_position(frame, eyes), SEEK_SET);
136 checked_fwrite (&info.offset, sizeof(info.offset), handle->get(), handle->file());
137 checked_fwrite (&info.size, sizeof (info.size), handle->get(), handle->file());
138 checked_fwrite (info.hash.c_str(), info.hash.size(), handle->get(), handle->file());
142 ReelWriter::read_frame_info (shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const
144 dcp::FrameInfo frame_info;
145 dcpomatic_fseek (info->get(), frame_info_position(frame, eyes), SEEK_SET);
146 checked_fread (&frame_info.offset, sizeof(frame_info.offset), info->get(), info->file());
147 checked_fread (&frame_info.size, sizeof(frame_info.size), info->get(), info->file());
149 char hash_buffer[33];
150 checked_fread (hash_buffer, 32, info->get(), info->file());
151 hash_buffer[32] = '\0';
152 frame_info.hash = hash_buffer;
158 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
162 return frame * _info_size;
164 return frame * _info_size * 2;
166 return frame * _info_size * 2 + _info_size;
168 DCPOMATIC_ASSERT (false);
171 DCPOMATIC_ASSERT (false);
175 ReelWriter::check_existing_picture_asset ()
177 DCPOMATIC_ASSERT (_picture_asset->file());
178 boost::filesystem::path asset = _picture_asset->file().get();
180 shared_ptr<Job> job = _job.lock ();
182 /* If there is an existing asset, break any hard links to it as we are about to change its contents
183 (if only by changing the IDs); see #1126.
186 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
188 job->sub (_("Copying old video file"));
189 copy_in_bits (asset, asset.string() + ".tmp", bind(&Job::set_progress, job.get(), _1, false));
191 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
193 boost::filesystem::remove (asset);
194 boost::filesystem::rename (asset.string() + ".tmp", asset);
198 job->sub (_("Checking existing image data"));
201 /* Try to open the existing asset */
202 FILE* asset_file = fopen_boost (asset, "rb");
204 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
207 LOG_GENERAL ("Opened existing asset at %1", asset.string());
210 shared_ptr<InfoFileHandle> info_file;
213 info_file = _film->info_file_handle (_period, true);
214 } catch (OpenFileError) {
215 LOG_GENERAL_NC ("Could not open film info file");
220 /* Offset of the last dcp::FrameInfo in the info file */
221 int const n = (boost::filesystem::file_size(info_file->file()) / _info_size) - 1;
222 LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->file()), _info_size);
224 Frame first_nonexistant_frame;
225 if (_film->three_d ()) {
226 /* Start looking at the last left frame */
227 first_nonexistant_frame = n / 2;
229 first_nonexistant_frame = n;
232 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
233 --first_nonexistant_frame;
236 if (!_film->three_d() && first_nonexistant_frame > 0) {
237 /* If we are doing 3D we might have found a good L frame with no R, so only
238 do this if we're in 2D and we've just found a good B(oth) frame.
240 ++first_nonexistant_frame;
243 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
247 return first_nonexistant_frame;
251 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
253 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
254 write_frame_info (frame, eyes, fin);
255 _last_written[eyes] = encoded;
256 _last_written_video_frame = frame;
257 _last_written_eyes = eyes;
261 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
263 _picture_asset_writer->fake_write (size);
264 _last_written_video_frame = frame;
265 _last_written_eyes = eyes;
269 ReelWriter::repeat_write (Frame frame, Eyes eyes)
271 dcp::FrameInfo fin = _picture_asset_writer->write (
272 _last_written[eyes]->data().get(),
273 _last_written[eyes]->size()
275 write_frame_info (frame, eyes, fin);
276 _last_written_video_frame = frame;
277 _last_written_eyes = eyes;
281 ReelWriter::finish ()
283 if (!_picture_asset_writer->finalize ()) {
284 /* Nothing was written to the picture asset */
285 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
286 _picture_asset.reset ();
289 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
290 /* Nothing was written to the sound asset */
291 _sound_asset.reset ();
294 /* Hard-link any video asset file into the DCP */
295 if (_picture_asset) {
296 DCPOMATIC_ASSERT (_picture_asset->file());
297 boost::filesystem::path video_from = _picture_asset->file().get();
298 boost::filesystem::path video_to;
299 video_to /= _film->dir (_film->dcp_name());
300 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
302 LOG_GENERAL ("Must put %1 into DCP at %2", video_from.string(), video_to.string());
303 LOG_GENERAL ("%2: %2", video_from.string(), boost::filesystem::is_regular_file(video_from) ? "yes" : "no");
304 LOG_GENERAL ("%1: %2", video_to.string(), boost::filesystem::is_regular_file(video_to) ? "yes" : "no");
306 boost::system::error_code ec;
307 boost::filesystem::create_hard_link (video_from, video_to, ec);
309 LOG_WARNING ("Hard-link failed (%1); copying instead", ec.message());
310 shared_ptr<Job> job = _job.lock ();
312 job->sub (_("Copying video file into DCP"));
314 copy_in_bits (video_from, video_to, bind(&Job::set_progress, job.get(), _1, false));
315 } catch (exception& e) {
316 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), e.what());
317 throw FileError (e.what(), video_from);
320 boost::filesystem::copy_file (video_from, video_to, ec);
322 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
323 throw FileError (ec.message(), video_from);
328 _picture_asset->set_file (video_to);
331 /* Move the audio asset into the DCP */
333 boost::filesystem::path audio_to;
334 audio_to /= _film->dir (_film->dcp_name ());
335 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
338 boost::system::error_code ec;
339 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
342 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
346 _sound_asset->set_file (audio_to);
353 shared_ptr<dcp::SubtitleAsset> asset,
354 int64_t picture_duration,
355 shared_ptr<dcp::Reel> reel,
356 list<ReferencedReelAsset> const & refs,
357 list<shared_ptr<Font> > const & fonts,
358 shared_ptr<const Film> film,
362 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
364 shared_ptr<T> reel_asset;
367 boost::filesystem::path liberation_normal;
369 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
370 if (!boost::filesystem::exists (liberation_normal)) {
371 /* Hack for unit tests */
372 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
374 } catch (boost::filesystem::filesystem_error& e) {
378 if (!boost::filesystem::exists(liberation_normal)) {
379 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
382 /* Add the font to the subtitle content */
383 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
384 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
387 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
388 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
389 boost::filesystem::create_directories (directory);
390 asset->write (directory / ("sub_" + asset->id() + ".xml"));
392 /* All our assets should be the same length; use the picture asset length here
393 as a reference to set the subtitle one. We'll use the duration rather than
394 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
395 just interested in its presentation length.
397 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
400 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
407 dcp::Fraction (film->video_frame_rate(), 1),
413 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
414 BOOST_FOREACH (ReferencedReelAsset j, refs) {
415 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
416 if (k && j.period == period) {
418 /* If we have a hash for this asset in the CPL, assume that it is correct */
420 k->asset_ref()->set_hash (k->hash().get());
427 if (reel_asset->duration() != period_duration) {
428 throw ProgrammingError (
430 String::compose ("%1 vs %2", reel_asset->duration(), period_duration)
433 reel->add (reel_asset);
439 shared_ptr<dcp::Reel>
440 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
442 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
444 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
446 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
448 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
450 if (_picture_asset) {
451 /* We have made a picture asset of our own. Put it into the reel */
452 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
454 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
457 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
459 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
462 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
463 /* We don't have a picture asset of our own; hopefully we have one to reference */
464 BOOST_FOREACH (ReferencedReelAsset j, refs) {
465 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
467 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
469 if (k && j.period == _period) {
470 reel_picture_asset = k;
475 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
477 DCPOMATIC_ASSERT (reel_picture_asset);
478 if (reel_picture_asset->duration() != period_duration) {
479 throw ProgrammingError (
481 String::compose ("%1 vs %2", reel_picture_asset->duration(), period_duration)
484 reel->add (reel_picture_asset);
486 /* If we have a hash for this asset in the CPL, assume that it is correct */
487 if (reel_picture_asset->hash()) {
488 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
491 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
494 /* We have made a sound asset of our own. Put it into the reel */
495 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
497 LOG_GENERAL ("no sound asset of our own; look through %1", refs.size());
498 /* We don't have a sound asset of our own; hopefully we have one to reference */
499 BOOST_FOREACH (ReferencedReelAsset j, refs) {
500 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
502 LOG_GENERAL ("candidate sound asset period is %1-%2", j.period.from.get(), j.period.to.get());
504 if (k && j.period == _period) {
505 reel_sound_asset = k;
506 /* If we have a hash for this asset in the CPL, assume that it is correct */
508 k->asset_ref()->set_hash (k->hash().get());
514 DCPOMATIC_ASSERT (reel_sound_asset);
515 if (reel_sound_asset->duration() != period_duration) {
517 "Reel sound asset has length %1 but reel period is %2",
518 reel_sound_asset->duration(),
521 if (reel_sound_asset->duration() != period_duration) {
522 throw ProgrammingError (
524 String::compose ("%1 vs %2", reel_sound_asset->duration(), period_duration)
529 reel->add (reel_sound_asset);
531 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->duration(), reel, refs, fonts, _film, _period);
532 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
533 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
534 i->second, reel_picture_asset->duration(), reel, refs, fonts, _film, _period
536 a->set_annotation_text (i->first.name);
537 a->set_language (i->first.language);
544 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
546 if (_picture_asset) {
547 _picture_asset->hash (set_progress);
551 _sound_asset->hash (set_progress);
556 ReelWriter::start () const
558 return _period.from.frames_floor (_film->video_frame_rate());
563 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
565 if (!_sound_asset_writer) {
569 DCPOMATIC_ASSERT (audio);
570 _sound_asset_writer->write (audio->data(), audio->frames());
574 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
576 shared_ptr<dcp::SubtitleAsset> asset;
579 case TEXT_OPEN_SUBTITLE:
580 asset = _subtitle_asset;
582 case TEXT_CLOSED_CAPTION:
583 DCPOMATIC_ASSERT (track);
584 asset = _closed_caption_assets[*track];
587 DCPOMATIC_ASSERT (false);
591 string lang = _film->subtitle_language ();
592 if (_film->interop ()) {
593 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
594 s->set_movie_title (_film->name ());
595 if (type == TEXT_OPEN_SUBTITLE) {
596 s->set_language (lang.empty() ? "Unknown" : lang);
598 s->set_language (track->language);
600 s->set_reel_number (raw_convert<string> (_reel_index + 1));
603 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
604 s->set_content_title_text (_film->name ());
605 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
606 s->set_language (lang);
608 s->set_language (track->language);
610 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
611 s->set_reel_number (_reel_index + 1);
612 s->set_time_code_rate (_film->video_frame_rate ());
613 s->set_start_time (dcp::Time ());
614 if (_film->encrypted ()) {
615 s->set_key (_film->key ());
622 case TEXT_OPEN_SUBTITLE:
623 _subtitle_asset = asset;
625 case TEXT_CLOSED_CAPTION:
626 DCPOMATIC_ASSERT (track);
627 _closed_caption_assets[*track] = asset;
630 DCPOMATIC_ASSERT (false);
633 BOOST_FOREACH (StringText i, subs.string) {
634 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
635 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
636 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
637 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
640 BOOST_FOREACH (BitmapText i, subs.bitmap) {
642 shared_ptr<dcp::Subtitle>(
643 new dcp::SubtitleImage(
645 dcp::Time(period.from.seconds() - _period.from.seconds(), _film->video_frame_rate()),
646 dcp::Time(period.to.seconds() - _period.from.seconds(), _film->video_frame_rate()),
647 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
648 dcp::Time(), dcp::Time()
656 ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr<InfoFileHandle> info_file, Frame frame) const
658 LOG_GENERAL ("Checking existing picture frame %1", frame);
660 /* Read the data from the info file; for 3D we just check the left
661 frames until we find a good one.
663 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
667 /* Read the data from the asset and hash it */
668 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
669 Data data (info.size);
670 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
671 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
672 if (read != static_cast<size_t> (data.size ())) {
673 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
677 digester.add (data.data().get(), data.size());
678 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
679 if (digester.get() != info.hash) {
680 LOG_GENERAL ("Existing frame %1 failed hash check", frame);