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>
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 /** @param job Related job, or 0 */
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)
102 job->sub (_("Checking existing image data"));
104 _first_nonexistant_frame = check_existing_picture_asset ();
106 _picture_asset_writer = _picture_asset->start_write (
107 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
108 _first_nonexistant_frame > 0
111 if (_film->audio_channels ()) {
113 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
116 if (_film->encrypted ()) {
117 _sound_asset->set_key (_film->key ());
120 DCPOMATIC_ASSERT (_film->directory());
122 /* Write the sound asset into the film directory so that we leave the creation
123 of the DCP directory until the last minute.
125 _sound_asset_writer = _sound_asset->start_write (
126 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
131 /** @param frame reel-relative frame */
133 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
135 shared_ptr<InfoFileHandle> handle = _film->info_file_handle(_period, false);
136 dcpomatic_fseek (handle->get(), frame_info_position(frame, eyes), SEEK_SET);
137 checked_fwrite (&info.offset, sizeof(info.offset), handle->get(), handle->file());
138 checked_fwrite (&info.size, sizeof (info.size), handle->get(), handle->file());
139 checked_fwrite (info.hash.c_str(), info.hash.size(), handle->get(), handle->file());
143 ReelWriter::read_frame_info (shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const
145 dcp::FrameInfo frame_info;
146 dcpomatic_fseek (info->get(), frame_info_position(frame, eyes), SEEK_SET);
147 checked_fread (&frame_info.offset, sizeof(frame_info.offset), info->get(), info->file());
148 checked_fread (&frame_info.size, sizeof(frame_info.size), info->get(), info->file());
150 char hash_buffer[33];
151 checked_fread (hash_buffer, 32, info->get(), info->file());
152 hash_buffer[32] = '\0';
153 frame_info.hash = hash_buffer;
159 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
163 return frame * _info_size;
165 return frame * _info_size * 2;
167 return frame * _info_size * 2 + _info_size;
169 DCPOMATIC_ASSERT (false);
172 DCPOMATIC_ASSERT (false);
176 ReelWriter::check_existing_picture_asset ()
178 DCPOMATIC_ASSERT (_picture_asset->file());
179 boost::filesystem::path asset = _picture_asset->file().get();
181 /* If there is an existing asset, break any hard links to it as we are about to change its contents
182 (if only by changing the IDs); see #1126.
185 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
186 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
187 boost::filesystem::remove (asset);
188 boost::filesystem::rename (asset.string() + ".tmp", asset);
191 /* Try to open the existing asset */
192 FILE* asset_file = fopen_boost (asset, "rb");
194 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
197 LOG_GENERAL ("Opened existing asset at %1", asset.string());
200 shared_ptr<InfoFileHandle> info_file;
203 info_file = _film->info_file_handle (_period, true);
204 } catch (OpenFileError) {
205 LOG_GENERAL_NC ("Could not open film info file");
210 /* Offset of the last dcp::FrameInfo in the info file */
211 int const n = (boost::filesystem::file_size(info_file->file()) / _info_size) - 1;
212 LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->file()), _info_size);
214 Frame first_nonexistant_frame;
215 if (_film->three_d ()) {
216 /* Start looking at the last left frame */
217 first_nonexistant_frame = n / 2;
219 first_nonexistant_frame = n;
222 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
223 --first_nonexistant_frame;
226 if (!_film->three_d() && first_nonexistant_frame > 0) {
227 /* If we are doing 3D we might have found a good L frame with no R, so only
228 do this if we're in 2D and we've just found a good B(oth) frame.
230 ++first_nonexistant_frame;
233 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
237 return first_nonexistant_frame;
241 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
243 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
244 write_frame_info (frame, eyes, fin);
245 _last_written[eyes] = encoded;
246 _last_written_video_frame = frame;
247 _last_written_eyes = eyes;
251 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
253 _picture_asset_writer->fake_write (size);
254 _last_written_video_frame = frame;
255 _last_written_eyes = eyes;
259 ReelWriter::repeat_write (Frame frame, Eyes eyes)
261 dcp::FrameInfo fin = _picture_asset_writer->write (
262 _last_written[eyes]->data().get(),
263 _last_written[eyes]->size()
265 write_frame_info (frame, eyes, fin);
266 _last_written_video_frame = frame;
267 _last_written_eyes = eyes;
271 ReelWriter::finish ()
273 if (!_picture_asset_writer->finalize ()) {
274 /* Nothing was written to the picture asset */
275 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
276 _picture_asset.reset ();
279 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
280 /* Nothing was written to the sound asset */
281 _sound_asset.reset ();
284 /* Hard-link any video asset file into the DCP */
285 if (_picture_asset) {
286 DCPOMATIC_ASSERT (_picture_asset->file());
287 boost::filesystem::path video_from = _picture_asset->file().get();
288 boost::filesystem::path video_to;
289 video_to /= _film->dir (_film->dcp_name());
290 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
292 boost::system::error_code ec;
293 boost::filesystem::create_hard_link (video_from, video_to, ec);
295 LOG_WARNING_NC ("Hard-link failed; copying instead");
296 boost::filesystem::copy_file (video_from, video_to, ec);
298 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
299 throw FileError (ec.message(), video_from);
303 _picture_asset->set_file (video_to);
306 /* Move the audio asset into the DCP */
308 boost::filesystem::path audio_to;
309 audio_to /= _film->dir (_film->dcp_name ());
310 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
313 boost::system::error_code ec;
314 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
317 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
321 _sound_asset->set_file (audio_to);
328 shared_ptr<dcp::SubtitleAsset> asset,
329 int64_t picture_duration,
330 shared_ptr<dcp::Reel> reel,
331 list<ReferencedReelAsset> const & refs,
332 list<shared_ptr<Font> > const & fonts,
333 shared_ptr<const Film> film,
337 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
339 shared_ptr<T> reel_asset;
342 boost::filesystem::path liberation_normal;
344 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
345 if (!boost::filesystem::exists (liberation_normal)) {
346 /* Hack for unit tests */
347 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
349 } catch (boost::filesystem::filesystem_error& e) {
353 if (!boost::filesystem::exists(liberation_normal)) {
354 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
357 /* Add the font to the subtitle content */
358 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
359 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
362 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
363 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
364 boost::filesystem::create_directories (directory);
365 asset->write (directory / ("sub_" + asset->id() + ".xml"));
367 /* All our assets should be the same length; use the picture asset length here
368 as a reference to set the subtitle one. We'll use the duration rather than
369 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
370 just interested in its presentation length.
372 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
375 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
382 dcp::Fraction (film->video_frame_rate(), 1),
388 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
389 BOOST_FOREACH (ReferencedReelAsset j, refs) {
390 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
391 if (k && j.period == period) {
393 /* If we have a hash for this asset in the CPL, assume that it is correct */
395 k->asset_ref()->set_hash (k->hash().get());
402 if (reel_asset->duration() != period_duration) {
403 throw ProgrammingError (
405 String::compose ("%1 vs %2", reel_asset->duration(), period_duration)
408 reel->add (reel_asset);
414 shared_ptr<dcp::Reel>
415 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
417 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
419 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
421 if (_picture_asset) {
422 /* We have made a picture asset of our own. Put it into the reel */
423 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
425 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
428 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
430 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
433 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
434 /* We don't have a picture asset of our own; hopefully we have one to reference */
435 BOOST_FOREACH (ReferencedReelAsset j, refs) {
436 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
438 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
440 if (k && j.period == _period) {
441 reel_picture_asset = k;
446 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
448 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
450 DCPOMATIC_ASSERT (reel_picture_asset);
451 if (reel_picture_asset->duration() != period_duration) {
452 throw ProgrammingError (
454 String::compose ("%1 vs %2", reel_picture_asset->duration(), period_duration)
457 reel->add (reel_picture_asset);
459 /* If we have a hash for this asset in the CPL, assume that it is correct */
460 if (reel_picture_asset->hash()) {
461 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
464 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
467 /* We have made a sound asset of our own. Put it into the reel */
468 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
470 /* We don't have a sound asset of our own; hopefully we have one to reference */
471 BOOST_FOREACH (ReferencedReelAsset j, refs) {
472 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
473 if (k && j.period == _period) {
474 reel_sound_asset = k;
475 /* If we have a hash for this asset in the CPL, assume that it is correct */
477 k->asset_ref()->set_hash (k->hash().get());
483 DCPOMATIC_ASSERT (reel_sound_asset);
484 if (reel_sound_asset->duration() != period_duration) {
486 "Reel sound asset has length %1 but reel period is %2",
487 reel_sound_asset->duration(),
490 if (reel_sound_asset->duration() != period_duration) {
491 throw ProgrammingError (
493 String::compose ("%1 vs %2", reel_sound_asset->duration(), period_duration)
498 reel->add (reel_sound_asset);
500 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->duration(), reel, refs, fonts, _film, _period);
501 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
502 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
503 i->second, reel_picture_asset->duration(), reel, refs, fonts, _film, _period
505 a->set_annotation_text (i->first.name);
506 a->set_language (i->first.language);
513 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
515 if (_picture_asset) {
516 _picture_asset->hash (set_progress);
520 _sound_asset->hash (set_progress);
525 ReelWriter::start () const
527 return _period.from.frames_floor (_film->video_frame_rate());
532 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
534 if (!_sound_asset_writer) {
538 DCPOMATIC_ASSERT (audio);
539 _sound_asset_writer->write (audio->data(), audio->frames());
543 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
545 shared_ptr<dcp::SubtitleAsset> asset;
548 case TEXT_OPEN_SUBTITLE:
549 asset = _subtitle_asset;
551 case TEXT_CLOSED_CAPTION:
552 DCPOMATIC_ASSERT (track);
553 asset = _closed_caption_assets[*track];
556 DCPOMATIC_ASSERT (false);
560 string lang = _film->subtitle_language ();
561 if (_film->interop ()) {
562 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
563 s->set_movie_title (_film->name ());
564 if (type == TEXT_OPEN_SUBTITLE) {
565 s->set_language (lang.empty() ? "Unknown" : lang);
567 s->set_language (track->language);
569 s->set_reel_number (raw_convert<string> (_reel_index + 1));
572 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
573 s->set_content_title_text (_film->name ());
574 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
575 s->set_language (lang);
577 s->set_language (track->language);
579 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
580 s->set_reel_number (_reel_index + 1);
581 s->set_time_code_rate (_film->video_frame_rate ());
582 s->set_start_time (dcp::Time ());
583 if (_film->encrypted ()) {
584 s->set_key (_film->key ());
591 case TEXT_OPEN_SUBTITLE:
592 _subtitle_asset = asset;
594 case TEXT_CLOSED_CAPTION:
595 DCPOMATIC_ASSERT (track);
596 _closed_caption_assets[*track] = asset;
599 DCPOMATIC_ASSERT (false);
602 BOOST_FOREACH (StringText i, subs.string) {
603 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
604 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
605 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
606 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
609 BOOST_FOREACH (BitmapText i, subs.bitmap) {
611 shared_ptr<dcp::Subtitle>(
612 new dcp::SubtitleImage(
614 dcp::Time(period.from.seconds() - _period.from.seconds(), _film->video_frame_rate()),
615 dcp::Time(period.to.seconds() - _period.from.seconds(), _film->video_frame_rate()),
616 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
617 dcp::Time(), dcp::Time()
625 ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr<InfoFileHandle> info_file, Frame frame) const
627 LOG_GENERAL ("Checking existing picture frame %1", frame);
629 /* Read the data from the info file; for 3D we just check the left
630 frames until we find a good one.
632 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
636 /* Read the data from the asset and hash it */
637 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
638 Data data (info.size);
639 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
640 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
641 if (read != static_cast<size_t> (data.size ())) {
642 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
646 digester.add (data.data().get(), data.size());
647 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
648 if (digester.get() != info.hash) {
649 LOG_GENERAL ("Existing frame %1 failed hash check", frame);