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>
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>
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 ReelWriter::ReelWriter (
67 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
71 , _last_written_video_frame (-1)
72 , _last_written_eyes (EYES_RIGHT)
73 , _reel_index (reel_index)
74 , _reel_count (reel_count)
75 , _content_summary (content_summary)
77 /* Create our picture asset in a subdirectory, named according to those
78 film's parameters which affect the video output. We will hard-link
79 it into the DCP later.
82 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
84 if (_film->three_d ()) {
85 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
87 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
90 _picture_asset->set_size (_film->frame_size ());
92 if (_film->encrypted ()) {
93 _picture_asset->set_key (_film->key ());
94 _picture_asset->set_context_id (_film->context_id ());
97 _picture_asset->set_file (
98 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
101 job->sub (_("Checking existing image data"));
102 _first_nonexistant_frame = check_existing_picture_asset ();
104 _picture_asset_writer = _picture_asset->start_write (
105 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
106 _first_nonexistant_frame > 0
109 if (_film->audio_channels ()) {
111 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
114 if (_film->encrypted ()) {
115 _sound_asset->set_key (_film->key ());
118 DCPOMATIC_ASSERT (_film->directory());
120 /* Write the sound asset into the film directory so that we leave the creation
121 of the DCP directory until the last minute.
123 _sound_asset_writer = _sound_asset->start_write (
124 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
129 /** @param frame reel-relative frame */
131 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
134 boost::filesystem::path info_file = _film->info_file (_period);
136 bool const read = boost::filesystem::exists (info_file);
139 file = fopen_boost (info_file, "r+b");
141 file = fopen_boost (info_file, "wb");
144 throw OpenFileError (info_file, errno, read);
146 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
147 checked_fwrite (&info.offset, sizeof (info.offset), file, info_file);
148 checked_fwrite (&info.size, sizeof (info.size), file, info_file);
149 checked_fwrite (info.hash.c_str(), info.hash.size(), file, info_file);
154 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
157 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
158 checked_fread (&info.offset, sizeof(info.offset), file, _film->info_file(_period));
159 checked_fread (&info.size, sizeof(info.size), file, _film->info_file(_period));
161 char hash_buffer[33];
162 checked_fread (hash_buffer, 32, file, _film->info_file(_period));
163 hash_buffer[32] = '\0';
164 info.hash = hash_buffer;
170 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
174 return frame * _info_size;
176 return frame * _info_size * 2;
178 return frame * _info_size * 2 + _info_size;
180 DCPOMATIC_ASSERT (false);
183 DCPOMATIC_ASSERT (false);
187 ReelWriter::check_existing_picture_asset ()
189 DCPOMATIC_ASSERT (_picture_asset->file());
190 boost::filesystem::path asset = _picture_asset->file().get();
192 /* If there is an existing asset, break any hard links to it as we are about to change its contents
193 (if only by changing the IDs); see #1126.
196 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
197 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
198 boost::filesystem::remove (asset);
199 boost::filesystem::rename (asset.string() + ".tmp", asset);
202 /* Try to open the existing asset */
203 FILE* asset_file = fopen_boost (asset, "rb");
205 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
208 LOG_GENERAL ("Opened existing asset at %1", asset.string());
211 /* Offset of the last dcp::FrameInfo in the info file */
212 int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
213 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);
215 FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
217 LOG_GENERAL_NC ("Could not open film info file");
222 Frame first_nonexistant_frame;
223 if (_film->three_d ()) {
224 /* Start looking at the last left frame */
225 first_nonexistant_frame = n / 2;
227 first_nonexistant_frame = n;
230 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
231 --first_nonexistant_frame;
234 if (!_film->three_d() && first_nonexistant_frame > 0) {
235 /* If we are doing 3D we might have found a good L frame with no R, so only
236 do this if we're in 2D and we've just found a good B(oth) frame.
238 ++first_nonexistant_frame;
241 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
246 return first_nonexistant_frame;
250 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
252 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
253 write_frame_info (frame, eyes, fin);
254 _last_written[eyes] = encoded;
255 _last_written_video_frame = frame;
256 _last_written_eyes = eyes;
260 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
262 _picture_asset_writer->fake_write (size);
263 _last_written_video_frame = frame;
264 _last_written_eyes = eyes;
268 ReelWriter::repeat_write (Frame frame, Eyes eyes)
270 dcp::FrameInfo fin = _picture_asset_writer->write (
271 _last_written[eyes]->data().get(),
272 _last_written[eyes]->size()
274 write_frame_info (frame, eyes, fin);
275 _last_written_video_frame = frame;
276 _last_written_eyes = eyes;
280 ReelWriter::finish ()
282 if (!_picture_asset_writer->finalize ()) {
283 /* Nothing was written to the picture asset */
284 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
285 _picture_asset.reset ();
288 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
289 /* Nothing was written to the sound asset */
290 _sound_asset.reset ();
293 /* Hard-link any video asset file into the DCP */
294 if (_picture_asset) {
295 DCPOMATIC_ASSERT (_picture_asset->file());
296 boost::filesystem::path video_from = _picture_asset->file().get();
297 boost::filesystem::path video_to;
298 video_to /= _film->dir (_film->dcp_name());
299 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
301 boost::system::error_code ec;
302 boost::filesystem::create_hard_link (video_from, video_to, ec);
304 LOG_WARNING_NC ("Hard-link failed; copying instead");
305 boost::filesystem::copy_file (video_from, video_to, ec);
307 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
308 throw FileError (ec.message(), video_from);
312 _picture_asset->set_file (video_to);
315 /* Move the audio asset into the DCP */
317 boost::filesystem::path audio_to;
318 audio_to /= _film->dir (_film->dcp_name ());
319 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
322 boost::system::error_code ec;
323 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
326 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
330 _sound_asset->set_file (audio_to);
337 shared_ptr<dcp::SubtitleAsset> asset,
338 int64_t picture_duration,
339 shared_ptr<dcp::Reel> reel,
340 list<ReferencedReelAsset> const & refs,
341 list<shared_ptr<Font> > const & fonts,
342 shared_ptr<const Film> film,
346 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
348 shared_ptr<T> reel_asset;
351 boost::filesystem::path liberation_normal;
353 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
354 if (!boost::filesystem::exists (liberation_normal)) {
355 /* Hack for unit tests */
356 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
358 } catch (boost::filesystem::filesystem_error& e) {
362 if (!boost::filesystem::exists(liberation_normal)) {
363 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
366 /* Add the font to the subtitle content */
367 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
368 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
371 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
372 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
373 boost::filesystem::create_directories (directory);
374 asset->write (directory / ("sub_" + asset->id() + ".xml"));
376 /* All our assets should be the same length; use the picture asset length here
377 as a reference to set the subtitle one. We'll use the duration rather than
378 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
379 just interested in its presentation length.
381 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
384 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
391 dcp::Fraction (film->video_frame_rate(), 1),
397 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
398 BOOST_FOREACH (ReferencedReelAsset j, refs) {
399 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
400 if (k && j.period == period) {
402 /* If we have a hash for this asset in the CPL, assume that it is correct */
404 k->asset_ref()->set_hash (k->hash().get());
411 if (reel_asset->actual_duration() != period_duration) {
412 throw ProgrammingError (
414 String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration)
417 reel->add (reel_asset);
423 shared_ptr<dcp::Reel>
424 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
426 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
428 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
430 if (_picture_asset) {
431 /* We have made a picture asset of our own. Put it into the reel */
432 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
434 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
437 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
439 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
442 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
443 /* We don't have a picture asset of our own; hopefully we have one to reference */
444 BOOST_FOREACH (ReferencedReelAsset j, refs) {
445 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
447 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
449 if (k && j.period == _period) {
450 reel_picture_asset = k;
455 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
457 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
459 DCPOMATIC_ASSERT (reel_picture_asset);
460 if (reel_picture_asset->duration() != period_duration) {
461 throw ProgrammingError (
463 String::compose ("%1 vs %2", reel_picture_asset->actual_duration(), period_duration)
466 reel->add (reel_picture_asset);
468 /* If we have a hash for this asset in the CPL, assume that it is correct */
469 if (reel_picture_asset->hash()) {
470 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
473 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
476 /* We have made a sound asset of our own. Put it into the reel */
477 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
479 /* We don't have a sound asset of our own; hopefully we have one to reference */
480 BOOST_FOREACH (ReferencedReelAsset j, refs) {
481 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
482 if (k && j.period == _period) {
483 reel_sound_asset = k;
484 /* If we have a hash for this asset in the CPL, assume that it is correct */
486 k->asset_ref()->set_hash (k->hash().get());
492 DCPOMATIC_ASSERT (reel_sound_asset);
493 if (reel_sound_asset->actual_duration() != period_duration) {
495 "Reel sound asset has length %1 but reel period is %2",
496 reel_sound_asset->actual_duration(),
499 if (reel_sound_asset->actual_duration() != period_duration) {
500 throw ProgrammingError (
502 String::compose ("%1 vs %2", reel_sound_asset->actual_duration(), period_duration)
507 reel->add (reel_sound_asset);
509 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period);
510 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
511 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
512 i->second, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period
514 a->set_annotation_text (i->first.name);
515 a->set_language (i->first.language);
518 map<dcp::Marker, DCPTime> markers = _film->markers ();
519 map<dcp::Marker, DCPTime> reel_markers;
520 for (map<dcp::Marker, DCPTime>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
521 if (_period.contains(i->second)) {
522 reel_markers[i->first] = i->second;
526 if (!reel_markers.empty ()) {
527 shared_ptr<dcp::ReelMarkersAsset> ma (new dcp::ReelMarkersAsset(dcp::Fraction(_film->video_frame_rate(), 1), 0));
528 for (map<dcp::Marker, DCPTime>::const_iterator i = reel_markers.begin(); i != reel_markers.end(); ++i) {
530 DCPTime relative = i->second - _period.from;
531 relative.split (_film->video_frame_rate(), h, m, s, f);
532 ma->set (i->first, dcp::Time(h, m, s, f, _film->video_frame_rate()));
541 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
543 if (_picture_asset) {
544 _picture_asset->hash (set_progress);
548 _sound_asset->hash (set_progress);
553 ReelWriter::start () const
555 return _period.from.frames_floor (_film->video_frame_rate());
560 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
562 if (!_sound_asset_writer) {
566 DCPOMATIC_ASSERT (audio);
567 _sound_asset_writer->write (audio->data(), audio->frames());
571 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
573 shared_ptr<dcp::SubtitleAsset> asset;
576 case TEXT_OPEN_SUBTITLE:
577 asset = _subtitle_asset;
579 case TEXT_CLOSED_CAPTION:
580 DCPOMATIC_ASSERT (track);
581 asset = _closed_caption_assets[*track];
584 DCPOMATIC_ASSERT (false);
588 string lang = _film->subtitle_language ();
589 if (_film->interop ()) {
590 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
591 s->set_movie_title (_film->name ());
592 if (type == TEXT_OPEN_SUBTITLE) {
593 s->set_language (lang.empty() ? "Unknown" : lang);
595 s->set_language (track->language);
597 s->set_reel_number (raw_convert<string> (_reel_index + 1));
600 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
601 s->set_content_title_text (_film->name ());
602 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
603 s->set_language (lang);
605 s->set_language (track->language);
607 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
608 s->set_reel_number (_reel_index + 1);
609 s->set_time_code_rate (_film->video_frame_rate ());
610 s->set_start_time (dcp::Time ());
611 if (_film->encrypted ()) {
612 s->set_key (_film->key ());
619 case TEXT_OPEN_SUBTITLE:
620 _subtitle_asset = asset;
622 case TEXT_CLOSED_CAPTION:
623 DCPOMATIC_ASSERT (track);
624 _closed_caption_assets[*track] = asset;
627 DCPOMATIC_ASSERT (false);
630 BOOST_FOREACH (StringText i, subs.string) {
631 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
632 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
633 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
634 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
637 BOOST_FOREACH (BitmapText i, subs.bitmap) {
639 shared_ptr<dcp::Subtitle>(
640 new dcp::SubtitleImage(
642 dcp::Time(period.from.seconds(), _film->video_frame_rate()),
643 dcp::Time(period.to.seconds(), _film->video_frame_rate()),
644 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
645 dcp::Time(), dcp::Time()
653 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file, Frame frame) const
655 LOG_GENERAL ("Checking existing picture frame %1", frame);
657 /* Read the data from the info file; for 3D we just check the left
658 frames until we find a good one.
660 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
664 /* Read the data from the asset and hash it */
665 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
666 Data data (info.size);
667 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
668 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
669 if (read != static_cast<size_t> (data.size ())) {
670 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
674 digester.add (data.data().get(), data.size());
675 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
676 if (digester.get() != info.hash) {
677 LOG_GENERAL ("Existing frame %1 failed hash check", frame);