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>
42 #include <dcp/reel_markers_asset.h>
45 #include <dcp/certificate_chain.h>
46 #include <dcp/interop_subtitle_asset.h>
47 #include <dcp/smpte_subtitle_asset.h>
48 #include <dcp/raw_convert.h>
49 #include <dcp/subtitle_image.h>
50 #include <boost/foreach.hpp>
59 using boost::shared_ptr;
60 using boost::optional;
61 using boost::dynamic_pointer_cast;
63 using dcp::raw_convert;
64 using namespace dcpomatic;
66 int const ReelWriter::_info_size = 48;
68 /** @param job Related job, or 0 */
69 ReelWriter::ReelWriter (
70 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
74 , _last_written_video_frame (-1)
75 , _last_written_eyes (EYES_RIGHT)
76 , _reel_index (reel_index)
77 , _reel_count (reel_count)
78 , _content_summary (content_summary)
81 /* Create our picture asset in a subdirectory, named according to those
82 film's parameters which affect the video output. We will hard-link
83 it into the DCP later.
86 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
88 if (_film->three_d ()) {
89 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
91 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
94 _picture_asset->set_size (_film->frame_size ());
96 if (_film->encrypted ()) {
97 _picture_asset->set_key (_film->key ());
98 _picture_asset->set_context_id (_film->context_id ());
101 _picture_asset->set_file (
102 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
105 _first_nonexistant_frame = check_existing_picture_asset ();
107 _picture_asset_writer = _picture_asset->start_write (
108 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
109 _first_nonexistant_frame > 0
112 if (_film->audio_channels ()) {
114 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
117 if (_film->encrypted ()) {
118 _sound_asset->set_key (_film->key ());
121 DCPOMATIC_ASSERT (_film->directory());
123 /* Write the sound asset into the film directory so that we leave the creation
124 of the DCP directory until the last minute.
126 _sound_asset_writer = _sound_asset->start_write (
127 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
132 /** @param frame reel-relative frame */
134 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
136 shared_ptr<InfoFileHandle> handle = _film->info_file_handle(_period, false);
137 dcpomatic_fseek (handle->get(), frame_info_position(frame, eyes), SEEK_SET);
138 checked_fwrite (&info.offset, sizeof(info.offset), handle->get(), handle->file());
139 checked_fwrite (&info.size, sizeof (info.size), handle->get(), handle->file());
140 checked_fwrite (info.hash.c_str(), info.hash.size(), handle->get(), handle->file());
144 ReelWriter::read_frame_info (shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const
146 dcp::FrameInfo frame_info;
147 dcpomatic_fseek (info->get(), frame_info_position(frame, eyes), SEEK_SET);
148 checked_fread (&frame_info.offset, sizeof(frame_info.offset), info->get(), info->file());
149 checked_fread (&frame_info.size, sizeof(frame_info.size), info->get(), info->file());
151 char hash_buffer[33];
152 checked_fread (hash_buffer, 32, info->get(), info->file());
153 hash_buffer[32] = '\0';
154 frame_info.hash = hash_buffer;
160 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
164 return frame * _info_size;
166 return frame * _info_size * 2;
168 return frame * _info_size * 2 + _info_size;
170 DCPOMATIC_ASSERT (false);
173 DCPOMATIC_ASSERT (false);
177 ReelWriter::check_existing_picture_asset ()
179 DCPOMATIC_ASSERT (_picture_asset->file());
180 boost::filesystem::path asset = _picture_asset->file().get();
182 shared_ptr<Job> job = _job.lock ();
184 /* If there is an existing asset, break any hard links to it as we are about to change its contents
185 (if only by changing the IDs); see #1126.
188 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
190 job->sub (_("Copying old video file"));
191 copy_in_bits (asset, asset.string() + ".tmp", bind(&Job::set_progress, job.get(), _1, false));
193 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
195 boost::filesystem::remove (asset);
196 boost::filesystem::rename (asset.string() + ".tmp", asset);
200 job->sub (_("Checking existing image data"));
203 /* Try to open the existing asset */
204 FILE* asset_file = fopen_boost (asset, "rb");
206 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
209 LOG_GENERAL ("Opened existing asset at %1", asset.string());
212 shared_ptr<InfoFileHandle> info_file;
215 info_file = _film->info_file_handle (_period, true);
216 } catch (OpenFileError) {
217 LOG_GENERAL_NC ("Could not open film info file");
222 /* Offset of the last dcp::FrameInfo in the info file */
223 int const n = (boost::filesystem::file_size(info_file->file()) / _info_size) - 1;
224 LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->file()), _info_size);
226 Frame first_nonexistant_frame;
227 if (_film->three_d ()) {
228 /* Start looking at the last left frame */
229 first_nonexistant_frame = n / 2;
231 first_nonexistant_frame = n;
234 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
235 --first_nonexistant_frame;
238 if (!_film->three_d() && first_nonexistant_frame > 0) {
239 /* If we are doing 3D we might have found a good L frame with no R, so only
240 do this if we're in 2D and we've just found a good B(oth) frame.
242 ++first_nonexistant_frame;
245 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
249 return first_nonexistant_frame;
253 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
255 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
256 write_frame_info (frame, eyes, fin);
257 _last_written[eyes] = encoded;
258 _last_written_video_frame = frame;
259 _last_written_eyes = eyes;
263 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
265 _picture_asset_writer->fake_write (size);
266 _last_written_video_frame = frame;
267 _last_written_eyes = eyes;
271 ReelWriter::repeat_write (Frame frame, Eyes eyes)
273 dcp::FrameInfo fin = _picture_asset_writer->write (
274 _last_written[eyes]->data().get(),
275 _last_written[eyes]->size()
277 write_frame_info (frame, eyes, fin);
278 _last_written_video_frame = frame;
279 _last_written_eyes = eyes;
283 ReelWriter::finish ()
285 if (!_picture_asset_writer->finalize ()) {
286 /* Nothing was written to the picture asset */
287 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
288 _picture_asset.reset ();
291 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
292 /* Nothing was written to the sound asset */
293 _sound_asset.reset ();
296 /* Hard-link any video asset file into the DCP */
297 if (_picture_asset) {
298 DCPOMATIC_ASSERT (_picture_asset->file());
299 boost::filesystem::path video_from = _picture_asset->file().get();
300 boost::filesystem::path video_to;
301 video_to /= _film->dir (_film->dcp_name());
302 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
304 boost::system::error_code ec;
305 boost::filesystem::create_hard_link (video_from, video_to, ec);
307 LOG_WARNING_NC ("Hard-link failed; copying instead");
308 shared_ptr<Job> job = _job.lock ();
310 job->sub (_("Copying video file into DCP"));
312 copy_in_bits (video_from, video_to, bind(&Job::set_progress, job.get(), _1, false));
313 } catch (exception& e) {
314 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), e.what());
315 throw FileError (e.what(), video_from);
318 boost::filesystem::copy_file (video_from, video_to, ec);
320 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
321 throw FileError (ec.message(), video_from);
326 _picture_asset->set_file (video_to);
329 /* Move the audio asset into the DCP */
331 boost::filesystem::path audio_to;
332 audio_to /= _film->dir (_film->dcp_name ());
333 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
336 boost::system::error_code ec;
337 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
340 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
344 _sound_asset->set_file (audio_to);
351 shared_ptr<dcp::SubtitleAsset> asset,
352 int64_t picture_duration,
353 shared_ptr<dcp::Reel> reel,
354 list<ReferencedReelAsset> const & refs,
355 list<shared_ptr<Font> > const & fonts,
356 shared_ptr<const Film> film,
360 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
362 shared_ptr<T> reel_asset;
365 boost::filesystem::path liberation_normal;
367 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
368 if (!boost::filesystem::exists (liberation_normal)) {
369 /* Hack for unit tests */
370 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
372 } catch (boost::filesystem::filesystem_error& e) {
376 if (!boost::filesystem::exists(liberation_normal)) {
377 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
380 /* Add the font to the subtitle content */
381 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
382 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
385 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
386 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
387 boost::filesystem::create_directories (directory);
388 asset->write (directory / ("sub_" + asset->id() + ".xml"));
390 /* All our assets should be the same length; use the picture asset length here
391 as a reference to set the subtitle one. We'll use the duration rather than
392 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
393 just interested in its presentation length.
395 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
398 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
405 dcp::Fraction (film->video_frame_rate(), 1),
411 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
412 BOOST_FOREACH (ReferencedReelAsset j, refs) {
413 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
414 if (k && j.period == period) {
416 /* If we have a hash for this asset in the CPL, assume that it is correct */
418 k->asset_ref()->set_hash (k->hash().get());
425 if (reel_asset->actual_duration() != period_duration) {
426 throw ProgrammingError (
428 String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration)
431 reel->add (reel_asset);
437 shared_ptr<dcp::Reel>
438 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
440 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
442 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
444 if (_picture_asset) {
445 /* We have made a picture asset of our own. Put it into the reel */
446 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
448 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
451 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
453 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
456 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
457 /* We don't have a picture asset of our own; hopefully we have one to reference */
458 BOOST_FOREACH (ReferencedReelAsset j, refs) {
459 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
461 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
463 if (k && j.period == _period) {
464 reel_picture_asset = k;
469 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
471 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
473 DCPOMATIC_ASSERT (reel_picture_asset);
474 if (reel_picture_asset->duration() != period_duration) {
475 throw ProgrammingError (
477 String::compose ("%1 vs %2", reel_picture_asset->actual_duration(), period_duration)
480 reel->add (reel_picture_asset);
482 /* If we have a hash for this asset in the CPL, assume that it is correct */
483 if (reel_picture_asset->hash()) {
484 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
487 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
490 /* We have made a sound asset of our own. Put it into the reel */
491 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
493 /* We don't have a sound asset of our own; hopefully we have one to reference */
494 BOOST_FOREACH (ReferencedReelAsset j, refs) {
495 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
496 if (k && j.period == _period) {
497 reel_sound_asset = k;
498 /* If we have a hash for this asset in the CPL, assume that it is correct */
500 k->asset_ref()->set_hash (k->hash().get());
506 DCPOMATIC_ASSERT (reel_sound_asset);
507 if (reel_sound_asset->actual_duration() != period_duration) {
509 "Reel sound asset has length %1 but reel period is %2",
510 reel_sound_asset->actual_duration(),
513 if (reel_sound_asset->actual_duration() != period_duration) {
514 throw ProgrammingError (
516 String::compose ("%1 vs %2", reel_sound_asset->actual_duration(), period_duration)
521 reel->add (reel_sound_asset);
523 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period);
524 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
525 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
526 i->second, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period
528 a->set_annotation_text (i->first.name);
529 a->set_language (i->first.language);
532 map<dcp::Marker, DCPTime> markers = _film->markers ();
533 map<dcp::Marker, DCPTime> reel_markers;
534 for (map<dcp::Marker, DCPTime>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
535 if (_period.contains(i->second)) {
536 reel_markers[i->first] = i->second;
540 if (!reel_markers.empty ()) {
541 shared_ptr<dcp::ReelMarkersAsset> ma (new dcp::ReelMarkersAsset(dcp::Fraction(_film->video_frame_rate(), 1), 0));
542 for (map<dcp::Marker, DCPTime>::const_iterator i = reel_markers.begin(); i != reel_markers.end(); ++i) {
544 DCPTime relative = i->second - _period.from;
545 relative.split (_film->video_frame_rate(), h, m, s, f);
546 ma->set (i->first, dcp::Time(h, m, s, f, _film->video_frame_rate()));
555 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
557 if (_picture_asset) {
558 _picture_asset->hash (set_progress);
562 _sound_asset->hash (set_progress);
567 ReelWriter::start () const
569 return _period.from.frames_floor (_film->video_frame_rate());
574 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
576 if (!_sound_asset_writer) {
580 DCPOMATIC_ASSERT (audio);
581 _sound_asset_writer->write (audio->data(), audio->frames());
585 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
587 shared_ptr<dcp::SubtitleAsset> asset;
590 case TEXT_OPEN_SUBTITLE:
591 asset = _subtitle_asset;
593 case TEXT_CLOSED_CAPTION:
594 DCPOMATIC_ASSERT (track);
595 asset = _closed_caption_assets[*track];
598 DCPOMATIC_ASSERT (false);
602 string lang = _film->subtitle_language ();
603 if (_film->interop ()) {
604 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
605 s->set_movie_title (_film->name ());
606 if (type == TEXT_OPEN_SUBTITLE) {
607 s->set_language (lang.empty() ? "Unknown" : lang);
609 s->set_language (track->language);
611 s->set_reel_number (raw_convert<string> (_reel_index + 1));
614 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
615 s->set_content_title_text (_film->name ());
616 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
617 s->set_language (lang);
619 s->set_language (track->language);
621 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
622 s->set_reel_number (_reel_index + 1);
623 s->set_time_code_rate (_film->video_frame_rate ());
624 s->set_start_time (dcp::Time ());
625 if (_film->encrypted ()) {
626 s->set_key (_film->key ());
633 case TEXT_OPEN_SUBTITLE:
634 _subtitle_asset = asset;
636 case TEXT_CLOSED_CAPTION:
637 DCPOMATIC_ASSERT (track);
638 _closed_caption_assets[*track] = asset;
641 DCPOMATIC_ASSERT (false);
644 BOOST_FOREACH (StringText i, subs.string) {
645 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
646 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
647 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
648 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
651 BOOST_FOREACH (BitmapText i, subs.bitmap) {
653 shared_ptr<dcp::Subtitle>(
654 new dcp::SubtitleImage(
656 dcp::Time(period.from.seconds() - _period.from.seconds(), _film->video_frame_rate()),
657 dcp::Time(period.to.seconds() - _period.from.seconds(), _film->video_frame_rate()),
658 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
659 dcp::Time(), dcp::Time()
667 ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr<InfoFileHandle> info_file, Frame frame) const
669 LOG_GENERAL ("Checking existing picture frame %1", frame);
671 /* Read the data from the info file; for 3D we just check the left
672 frames until we find a good one.
674 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
678 /* Read the data from the asset and hash it */
679 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
680 Data data (info.size);
681 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
682 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
683 if (read != static_cast<size_t> (data.size ())) {
684 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
688 digester.add (data.data().get(), data.size());
689 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
690 if (digester.get() != info.hash) {
691 LOG_GENERAL ("Existing frame %1 failed hash check", frame);