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"
28 #include "compose.hpp"
29 #include "audio_buffers.h"
31 #include <dcp/mono_picture_asset.h>
32 #include <dcp/stereo_picture_asset.h>
33 #include <dcp/sound_asset.h>
34 #include <dcp/sound_asset_writer.h>
36 #include <dcp/reel_mono_picture_asset.h>
37 #include <dcp/reel_stereo_picture_asset.h>
38 #include <dcp/reel_sound_asset.h>
39 #include <dcp/reel_subtitle_asset.h>
40 #include <dcp/reel_closed_caption_asset.h>
43 #include <dcp/certificate_chain.h>
44 #include <dcp/interop_subtitle_asset.h>
45 #include <dcp/smpte_subtitle_asset.h>
46 #include <dcp/raw_convert.h>
47 #include <dcp/subtitle_image.h>
48 #include <boost/foreach.hpp>
52 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
53 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
54 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
55 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
61 using boost::shared_ptr;
62 using boost::optional;
63 using boost::dynamic_pointer_cast;
65 using dcp::raw_convert;
67 int const ReelWriter::_info_size = 48;
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)
80 /* Create our picture asset in a subdirectory, named according to those
81 film's parameters which affect the video output. We will hard-link
82 it into the DCP later.
85 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
87 if (_film->three_d ()) {
88 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
90 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
93 _picture_asset->set_size (_film->frame_size ());
95 if (_film->encrypted ()) {
96 _picture_asset->set_key (_film->key ());
97 _picture_asset->set_context_id (_film->context_id ());
100 _picture_asset->set_file (
101 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
104 job->sub (_("Checking existing image data"));
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
137 boost::filesystem::path info_file = _film->info_file (_period);
139 bool const read = boost::filesystem::exists (info_file);
142 file = fopen_boost (info_file, "r+b");
144 file = fopen_boost (info_file, "wb");
147 throw OpenFileError (info_file, errno, read);
149 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
150 fwrite (&info.offset, sizeof (info.offset), 1, file);
151 fwrite (&info.size, sizeof (info.size), 1, file);
152 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
157 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
160 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
161 fread (&info.offset, sizeof (info.offset), 1, file);
162 fread (&info.size, sizeof (info.size), 1, file);
164 char hash_buffer[33];
165 fread (hash_buffer, 1, 32, file);
166 hash_buffer[32] = '\0';
167 info.hash = hash_buffer;
173 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
177 return frame * _info_size;
179 return frame * _info_size * 2;
181 return frame * _info_size * 2 + _info_size;
183 DCPOMATIC_ASSERT (false);
186 DCPOMATIC_ASSERT (false);
190 ReelWriter::check_existing_picture_asset ()
192 DCPOMATIC_ASSERT (_picture_asset->file());
193 boost::filesystem::path asset = _picture_asset->file().get();
195 /* If there is an existing asset, break any hard links to it as we are about to change its contents
196 (if only by changing the IDs); see #1126.
199 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
200 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
201 boost::filesystem::remove (asset);
202 boost::filesystem::rename (asset.string() + ".tmp", asset);
205 /* Try to open the existing asset */
206 FILE* asset_file = fopen_boost (asset, "rb");
208 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
211 LOG_GENERAL ("Opened existing asset at %1", asset.string());
214 /* Offset of the last dcp::FrameInfo in the info file */
215 int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
216 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);
218 FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
220 LOG_GENERAL_NC ("Could not open film info file");
225 Frame first_nonexistant_frame;
226 if (_film->three_d ()) {
227 /* Start looking at the last left frame */
228 first_nonexistant_frame = n / 2;
230 first_nonexistant_frame = n;
233 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
234 --first_nonexistant_frame;
237 if (!_film->three_d() && first_nonexistant_frame > 0) {
238 /* If we are doing 3D we might have found a good L frame with no R, so only
239 do this if we're in 2D and we've just found a good B(oth) frame.
241 ++first_nonexistant_frame;
244 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 boost::filesystem::copy_file (video_from, video_to, ec);
310 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
311 throw FileError (ec.message(), video_from);
315 _picture_asset->set_file (video_to);
318 /* Move the audio asset into the DCP */
320 boost::filesystem::path audio_to;
321 audio_to /= _film->dir (_film->dcp_name ());
322 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
325 boost::system::error_code ec;
326 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
329 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
333 _sound_asset->set_file (audio_to);
340 shared_ptr<dcp::SubtitleAsset> asset,
341 int64_t picture_duration,
342 shared_ptr<dcp::Reel> reel,
343 list<ReferencedReelAsset> const & refs,
344 list<shared_ptr<Font> > const & fonts,
345 shared_ptr<const Film> film,
349 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
351 shared_ptr<T> reel_asset;
354 boost::filesystem::path liberation_normal;
356 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
357 if (!boost::filesystem::exists (liberation_normal)) {
358 /* Hack for unit tests */
359 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
361 } catch (boost::filesystem::filesystem_error& e) {
365 if (!boost::filesystem::exists(liberation_normal)) {
366 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
369 /* Add all the fonts to the subtitle content */
370 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
371 asset->add_font (j->id(), j->file(FontFiles::NORMAL).get_value_or(liberation_normal));
374 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
375 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
376 boost::filesystem::create_directories (directory);
377 asset->write (directory / ("sub_" + asset->id() + ".xml"));
379 /* All our assets should be the same length; use the picture asset length here
380 as a reference to set the subtitle one. We'll use the duration rather than
381 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
382 just interested in its presentation length.
384 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
387 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
394 dcp::Fraction (film->video_frame_rate(), 1),
400 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
401 BOOST_FOREACH (ReferencedReelAsset j, refs) {
402 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
403 if (k && j.period == period) {
405 /* If we have a hash for this asset in the CPL, assume that it is correct */
407 k->asset_ref()->set_hash (k->hash().get());
414 if (reel_asset->duration() != period_duration) {
415 throw ProgrammingError (
417 String::compose ("%1 vs %2", reel_asset->duration(), period_duration)
420 reel->add (reel_asset);
424 shared_ptr<dcp::Reel>
425 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
427 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
429 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
431 if (_picture_asset) {
432 /* We have made a picture asset of our own. Put it into the reel */
433 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
435 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
438 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
440 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
443 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
444 /* We don't have a picture asset of our own; hopefully we have one to reference */
445 BOOST_FOREACH (ReferencedReelAsset j, refs) {
446 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
448 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
450 if (k && j.period == _period) {
451 reel_picture_asset = k;
456 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
458 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
460 DCPOMATIC_ASSERT (reel_picture_asset);
461 if (reel_picture_asset->duration() != period_duration) {
462 throw ProgrammingError (
464 String::compose ("%1 vs %2", reel_picture_asset->duration(), period_duration)
467 reel->add (reel_picture_asset);
469 /* If we have a hash for this asset in the CPL, assume that it is correct */
470 if (reel_picture_asset->hash()) {
471 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
474 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
477 /* We have made a sound asset of our own. Put it into the reel */
478 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
480 /* We don't have a sound asset of our own; hopefully we have one to reference */
481 BOOST_FOREACH (ReferencedReelAsset j, refs) {
482 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
483 if (k && j.period == _period) {
484 reel_sound_asset = k;
485 /* If we have a hash for this asset in the CPL, assume that it is correct */
487 k->asset_ref()->set_hash (k->hash().get());
493 DCPOMATIC_ASSERT (reel_sound_asset);
494 if (reel_sound_asset->duration() != period_duration) {
496 "Reel sound asset has length %1 but reel period is %2",
497 reel_sound_asset->duration(),
500 if (reel_sound_asset->duration() != period_duration) {
501 throw ProgrammingError (
503 String::compose ("%1 vs %2", reel_sound_asset->duration(), period_duration)
508 reel->add (reel_sound_asset);
510 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->duration(), reel, refs, fonts, _film, _period);
511 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
512 maybe_add_text<dcp::ReelClosedCaptionAsset> (i->second, reel_picture_asset->duration(), reel, refs, fonts, _film, _period);
519 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
521 if (_picture_asset) {
522 _picture_asset->hash (set_progress);
526 _sound_asset->hash (set_progress);
531 ReelWriter::start () const
533 return _period.from.frames_floor (_film->video_frame_rate());
538 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
540 if (!_sound_asset_writer) {
544 DCPOMATIC_ASSERT (audio);
545 _sound_asset_writer->write (audio->data(), audio->frames());
549 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
551 shared_ptr<dcp::SubtitleAsset> asset;
554 case TEXT_OPEN_SUBTITLE:
555 asset = _subtitle_asset;
557 case TEXT_CLOSED_CAPTION:
558 DCPOMATIC_ASSERT (track);
559 asset = _closed_caption_assets[*track];
562 DCPOMATIC_ASSERT (false);
566 string lang = _film->subtitle_language ();
570 if (_film->interop ()) {
571 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
572 s->set_movie_title (_film->name ());
573 s->set_language (lang);
574 s->set_reel_number (raw_convert<string> (_reel_index + 1));
577 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
578 s->set_content_title_text (_film->name ());
579 s->set_language (lang);
580 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
581 s->set_reel_number (_reel_index + 1);
582 s->set_time_code_rate (_film->video_frame_rate ());
583 s->set_start_time (dcp::Time ());
584 if (_film->encrypted ()) {
585 s->set_key (_film->key ());
592 case TEXT_OPEN_SUBTITLE:
593 _subtitle_asset = asset;
595 case TEXT_CLOSED_CAPTION:
596 DCPOMATIC_ASSERT (track);
597 _closed_caption_assets[*track] = asset;
600 DCPOMATIC_ASSERT (false);
603 BOOST_FOREACH (StringText i, subs.string) {
604 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
605 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
606 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
607 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
610 BOOST_FOREACH (BitmapText i, subs.bitmap) {
612 shared_ptr<dcp::Subtitle>(
613 new dcp::SubtitleImage(
615 dcp::Time(period.from.seconds(), _film->video_frame_rate()),
616 dcp::Time(period.to.seconds(), _film->video_frame_rate()),
617 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
618 dcp::Time(), dcp::Time()
626 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file, Frame frame) const
628 LOG_GENERAL ("Checking existing picture frame %1", frame);
630 /* Read the data from the info file; for 3D we just check the left
631 frames until we find a good one.
633 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
637 /* Read the data from the asset and hash it */
638 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
639 Data data (info.size);
640 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
641 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
642 if (read != static_cast<size_t> (data.size ())) {
643 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
647 digester.add (data.data().get(), data.size());
648 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
649 if (digester.get() != info.hash) {
650 LOG_GENERAL ("Existing frame %1 failed hash check", frame);