2 Copyright (C) 2012-2018 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>
57 using boost::shared_ptr;
58 using boost::optional;
59 using boost::dynamic_pointer_cast;
61 using dcp::raw_convert;
63 int const ReelWriter::_info_size = 48;
65 ReelWriter::ReelWriter (
66 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
70 , _last_written_video_frame (-1)
71 , _last_written_eyes (EYES_RIGHT)
72 , _reel_index (reel_index)
73 , _reel_count (reel_count)
74 , _content_summary (content_summary)
76 /* Create our picture asset in a subdirectory, named according to those
77 film's parameters which affect the video output. We will hard-link
78 it into the DCP later.
81 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
83 if (_film->three_d ()) {
84 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
86 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
89 _picture_asset->set_size (_film->frame_size ());
91 if (_film->encrypted ()) {
92 _picture_asset->set_key (_film->key ());
93 _picture_asset->set_context_id (_film->context_id ());
96 _picture_asset->set_file (
97 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
100 job->sub (_("Checking existing image data"));
101 _first_nonexistant_frame = check_existing_picture_asset ();
103 _picture_asset_writer = _picture_asset->start_write (
104 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
105 _first_nonexistant_frame > 0
108 if (_film->audio_channels ()) {
110 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
113 if (_film->encrypted ()) {
114 _sound_asset->set_key (_film->key ());
117 DCPOMATIC_ASSERT (_film->directory());
119 /* Write the sound asset into the film directory so that we leave the creation
120 of the DCP directory until the last minute.
122 _sound_asset_writer = _sound_asset->start_write (
123 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
128 /** @param frame reel-relative frame */
130 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
133 boost::filesystem::path info_file = _film->info_file (_period);
135 bool const read = boost::filesystem::exists (info_file);
138 file = fopen_boost (info_file, "r+b");
140 file = fopen_boost (info_file, "wb");
143 throw OpenFileError (info_file, errno, read);
145 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
146 checked_fwrite (&info.offset, sizeof (info.offset), file, info_file);
147 checked_fwrite (&info.size, sizeof (info.size), file, info_file);
148 checked_fwrite (info.hash.c_str(), info.hash.size(), file, info_file);
153 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
156 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
157 checked_fread (&info.offset, sizeof(info.offset), file, _film->info_file(_period));
158 checked_fread (&info.size, sizeof(info.size), file, _film->info_file(_period));
160 char hash_buffer[33];
161 checked_fread (hash_buffer, 32, file, _film->info_file(_period));
162 hash_buffer[32] = '\0';
163 info.hash = hash_buffer;
169 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
173 return frame * _info_size;
175 return frame * _info_size * 2;
177 return frame * _info_size * 2 + _info_size;
179 DCPOMATIC_ASSERT (false);
182 DCPOMATIC_ASSERT (false);
186 ReelWriter::check_existing_picture_asset ()
188 DCPOMATIC_ASSERT (_picture_asset->file());
189 boost::filesystem::path asset = _picture_asset->file().get();
191 /* If there is an existing asset, break any hard links to it as we are about to change its contents
192 (if only by changing the IDs); see #1126.
195 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
196 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
197 boost::filesystem::remove (asset);
198 boost::filesystem::rename (asset.string() + ".tmp", asset);
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 /* Offset of the last dcp::FrameInfo in the info file */
211 int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
212 LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size (_film->info_file(_period)), _info_size);
214 FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
216 LOG_GENERAL_NC ("Could not open film info file");
221 Frame first_nonexistant_frame;
222 if (_film->three_d ()) {
223 /* Start looking at the last left frame */
224 first_nonexistant_frame = n / 2;
226 first_nonexistant_frame = n;
229 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
230 --first_nonexistant_frame;
233 if (!_film->three_d() && first_nonexistant_frame > 0) {
234 /* If we are doing 3D we might have found a good L frame with no R, so only
235 do this if we're in 2D and we've just found a good B(oth) frame.
237 ++first_nonexistant_frame;
240 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
245 return first_nonexistant_frame;
249 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
251 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
252 write_frame_info (frame, eyes, fin);
253 _last_written[eyes] = encoded;
254 _last_written_video_frame = frame;
255 _last_written_eyes = eyes;
259 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
261 _picture_asset_writer->fake_write (size);
262 _last_written_video_frame = frame;
263 _last_written_eyes = eyes;
267 ReelWriter::repeat_write (Frame frame, Eyes eyes)
269 dcp::FrameInfo fin = _picture_asset_writer->write (
270 _last_written[eyes]->data().get(),
271 _last_written[eyes]->size()
273 write_frame_info (frame, eyes, fin);
274 _last_written_video_frame = frame;
275 _last_written_eyes = eyes;
279 ReelWriter::finish ()
281 if (!_picture_asset_writer->finalize ()) {
282 /* Nothing was written to the picture asset */
283 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
284 _picture_asset.reset ();
287 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
288 /* Nothing was written to the sound asset */
289 _sound_asset.reset ();
292 /* Hard-link any video asset file into the DCP */
293 if (_picture_asset) {
294 DCPOMATIC_ASSERT (_picture_asset->file());
295 boost::filesystem::path video_from = _picture_asset->file().get();
296 boost::filesystem::path video_to;
297 video_to /= _film->dir (_film->dcp_name());
298 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
300 boost::system::error_code ec;
301 boost::filesystem::create_hard_link (video_from, video_to, ec);
303 LOG_WARNING_NC ("Hard-link failed; copying instead");
304 boost::filesystem::copy_file (video_from, video_to, ec);
306 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
307 throw FileError (ec.message(), video_from);
311 _picture_asset->set_file (video_to);
314 /* Move the audio asset into the DCP */
316 boost::filesystem::path audio_to;
317 audio_to /= _film->dir (_film->dcp_name ());
318 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
321 boost::system::error_code ec;
322 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
325 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
329 _sound_asset->set_file (audio_to);
336 shared_ptr<dcp::SubtitleAsset> asset,
337 int64_t picture_duration,
338 shared_ptr<dcp::Reel> reel,
339 list<ReferencedReelAsset> const & refs,
340 list<shared_ptr<Font> > const & fonts,
341 shared_ptr<const Film> film,
345 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
347 shared_ptr<T> reel_asset;
350 boost::filesystem::path liberation_normal;
352 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
353 if (!boost::filesystem::exists (liberation_normal)) {
354 /* Hack for unit tests */
355 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
357 } catch (boost::filesystem::filesystem_error& e) {
361 if (!boost::filesystem::exists(liberation_normal)) {
362 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
365 /* Add the font to the subtitle content */
366 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
367 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
370 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
371 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
372 boost::filesystem::create_directories (directory);
373 asset->write (directory / ("sub_" + asset->id() + ".xml"));
375 /* All our assets should be the same length; use the picture asset length here
376 as a reference to set the subtitle one. We'll use the duration rather than
377 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
378 just interested in its presentation length.
380 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
383 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
390 dcp::Fraction (film->video_frame_rate(), 1),
396 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
397 BOOST_FOREACH (ReferencedReelAsset j, refs) {
398 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
399 if (k && j.period == period) {
401 /* If we have a hash for this asset in the CPL, assume that it is correct */
403 k->asset_ref()->set_hash (k->hash().get());
410 if (reel_asset->duration() != period_duration) {
411 throw ProgrammingError (
413 String::compose ("%1 vs %2", reel_asset->duration(), period_duration)
416 reel->add (reel_asset);
422 shared_ptr<dcp::Reel>
423 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
425 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
427 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
429 if (_picture_asset) {
430 /* We have made a picture asset of our own. Put it into the reel */
431 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
433 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
436 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
438 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
441 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
442 /* We don't have a picture asset of our own; hopefully we have one to reference */
443 BOOST_FOREACH (ReferencedReelAsset j, refs) {
444 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
446 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
448 if (k && j.period == _period) {
449 reel_picture_asset = k;
454 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
456 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
458 DCPOMATIC_ASSERT (reel_picture_asset);
459 if (reel_picture_asset->duration() != period_duration) {
460 throw ProgrammingError (
462 String::compose ("%1 vs %2", reel_picture_asset->duration(), period_duration)
465 reel->add (reel_picture_asset);
467 /* If we have a hash for this asset in the CPL, assume that it is correct */
468 if (reel_picture_asset->hash()) {
469 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
472 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
475 /* We have made a sound asset of our own. Put it into the reel */
476 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
478 /* We don't have a sound asset of our own; hopefully we have one to reference */
479 BOOST_FOREACH (ReferencedReelAsset j, refs) {
480 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
481 if (k && j.period == _period) {
482 reel_sound_asset = k;
483 /* If we have a hash for this asset in the CPL, assume that it is correct */
485 k->asset_ref()->set_hash (k->hash().get());
491 DCPOMATIC_ASSERT (reel_sound_asset);
492 if (reel_sound_asset->duration() != period_duration) {
494 "Reel sound asset has length %1 but reel period is %2",
495 reel_sound_asset->duration(),
498 if (reel_sound_asset->duration() != period_duration) {
499 throw ProgrammingError (
501 String::compose ("%1 vs %2", reel_sound_asset->duration(), period_duration)
506 reel->add (reel_sound_asset);
508 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->duration(), reel, refs, fonts, _film, _period);
509 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
510 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
511 i->second, reel_picture_asset->duration(), reel, refs, fonts, _film, _period
513 a->set_annotation_text (i->first.name);
514 a->set_language (i->first.language);
521 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
523 if (_picture_asset) {
524 _picture_asset->hash (set_progress);
528 _sound_asset->hash (set_progress);
533 ReelWriter::start () const
535 return _period.from.frames_floor (_film->video_frame_rate());
540 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
542 if (!_sound_asset_writer) {
546 DCPOMATIC_ASSERT (audio);
547 _sound_asset_writer->write (audio->data(), audio->frames());
551 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
553 shared_ptr<dcp::SubtitleAsset> asset;
556 case TEXT_OPEN_SUBTITLE:
557 asset = _subtitle_asset;
559 case TEXT_CLOSED_CAPTION:
560 DCPOMATIC_ASSERT (track);
561 asset = _closed_caption_assets[*track];
564 DCPOMATIC_ASSERT (false);
568 string lang = _film->subtitle_language ();
569 if (_film->interop ()) {
570 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
571 s->set_movie_title (_film->name ());
572 if (type == TEXT_OPEN_SUBTITLE) {
573 s->set_language (lang.empty() ? "Unknown" : lang);
575 s->set_language (track->language);
577 s->set_reel_number (raw_convert<string> (_reel_index + 1));
580 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
581 s->set_content_title_text (_film->name ());
582 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
583 s->set_language (lang);
585 s->set_language (track->language);
587 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
588 s->set_reel_number (_reel_index + 1);
589 s->set_time_code_rate (_film->video_frame_rate ());
590 s->set_start_time (dcp::Time ());
591 if (_film->encrypted ()) {
592 s->set_key (_film->key ());
599 case TEXT_OPEN_SUBTITLE:
600 _subtitle_asset = asset;
602 case TEXT_CLOSED_CAPTION:
603 DCPOMATIC_ASSERT (track);
604 _closed_caption_assets[*track] = asset;
607 DCPOMATIC_ASSERT (false);
610 BOOST_FOREACH (StringText i, subs.string) {
611 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
612 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
613 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
614 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
617 BOOST_FOREACH (BitmapText i, subs.bitmap) {
619 shared_ptr<dcp::Subtitle>(
620 new dcp::SubtitleImage(
622 dcp::Time(period.from.seconds(), _film->video_frame_rate()),
623 dcp::Time(period.to.seconds(), _film->video_frame_rate()),
624 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
625 dcp::Time(), dcp::Time()
633 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file, Frame frame) const
635 LOG_GENERAL ("Checking existing picture frame %1", frame);
637 /* Read the data from the info file; for 3D we just check the left
638 frames until we find a good one.
640 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
644 /* Read the data from the asset and hash it */
645 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
646 Data data (info.size);
647 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
648 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
649 if (read != static_cast<size_t> (data.size ())) {
650 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
654 digester.add (data.data().get(), data.size());
655 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
656 if (digester.get() != info.hash) {
657 LOG_GENERAL ("Existing frame %1 failed hash check", frame);