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>
58 using boost::shared_ptr;
59 using boost::optional;
60 using boost::dynamic_pointer_cast;
62 using dcp::raw_convert;
63 using namespace dcpomatic;
65 int const ReelWriter::_info_size = 48;
67 /** @param job Related job, or 0 */
68 ReelWriter::ReelWriter (
69 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
73 , _last_written_video_frame (-1)
74 , _last_written_eyes (EYES_RIGHT)
75 , _reel_index (reel_index)
76 , _reel_count (reel_count)
77 , _content_summary (content_summary)
79 /* Create our picture asset in a subdirectory, named according to those
80 film's parameters which affect the video output. We will hard-link
81 it into the DCP later.
84 dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE;
86 if (_film->three_d ()) {
87 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
89 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard));
92 _picture_asset->set_size (_film->frame_size ());
94 if (_film->encrypted ()) {
95 _picture_asset->set_key (_film->key ());
96 _picture_asset->set_context_id (_film->context_id ());
99 _picture_asset->set_file (
100 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
104 job->sub (_("Checking existing image data"));
106 _first_nonexistant_frame = check_existing_picture_asset ();
108 _picture_asset_writer = _picture_asset->start_write (
109 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
110 _first_nonexistant_frame > 0
113 if (_film->audio_channels ()) {
115 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard)
118 if (_film->encrypted ()) {
119 _sound_asset->set_key (_film->key ());
122 DCPOMATIC_ASSERT (_film->directory());
124 /* Write the sound asset into the film directory so that we leave the creation
125 of the DCP directory until the last minute.
127 _sound_asset_writer = _sound_asset->start_write (
128 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary)
133 /** @param frame reel-relative frame */
135 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
137 shared_ptr<InfoFileHandle> handle = _film->info_file_handle(_period, false);
138 dcpomatic_fseek (handle->get(), frame_info_position(frame, eyes), SEEK_SET);
139 checked_fwrite (&info.offset, sizeof(info.offset), handle->get(), handle->file());
140 checked_fwrite (&info.size, sizeof (info.size), handle->get(), handle->file());
141 checked_fwrite (info.hash.c_str(), info.hash.size(), handle->get(), handle->file());
145 ReelWriter::read_frame_info (shared_ptr<InfoFileHandle> info, Frame frame, Eyes eyes) const
147 dcp::FrameInfo frame_info;
148 dcpomatic_fseek (info->get(), frame_info_position(frame, eyes), SEEK_SET);
149 checked_fread (&frame_info.offset, sizeof(frame_info.offset), info->get(), info->file());
150 checked_fread (&frame_info.size, sizeof(frame_info.size), info->get(), info->file());
152 char hash_buffer[33];
153 checked_fread (hash_buffer, 32, info->get(), info->file());
154 hash_buffer[32] = '\0';
155 frame_info.hash = hash_buffer;
161 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
165 return frame * _info_size;
167 return frame * _info_size * 2;
169 return frame * _info_size * 2 + _info_size;
171 DCPOMATIC_ASSERT (false);
174 DCPOMATIC_ASSERT (false);
178 ReelWriter::check_existing_picture_asset ()
180 DCPOMATIC_ASSERT (_picture_asset->file());
181 boost::filesystem::path asset = _picture_asset->file().get();
183 /* If there is an existing asset, break any hard links to it as we are about to change its contents
184 (if only by changing the IDs); see #1126.
187 if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) {
188 boost::filesystem::copy_file (asset, asset.string() + ".tmp");
189 boost::filesystem::remove (asset);
190 boost::filesystem::rename (asset.string() + ".tmp", asset);
193 /* Try to open the existing asset */
194 FILE* asset_file = fopen_boost (asset, "rb");
196 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno);
199 LOG_GENERAL ("Opened existing asset at %1", asset.string());
202 shared_ptr<InfoFileHandle> info_file;
205 info_file = _film->info_file_handle (_period, true);
206 } catch (OpenFileError) {
207 LOG_GENERAL_NC ("Could not open film info file");
212 /* Offset of the last dcp::FrameInfo in the info file */
213 int const n = (boost::filesystem::file_size(info_file->file()) / _info_size) - 1;
214 LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->file()), _info_size);
216 Frame first_nonexistant_frame;
217 if (_film->three_d ()) {
218 /* Start looking at the last left frame */
219 first_nonexistant_frame = n / 2;
221 first_nonexistant_frame = n;
224 while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) {
225 --first_nonexistant_frame;
228 if (!_film->three_d() && first_nonexistant_frame > 0) {
229 /* If we are doing 3D we might have found a good L frame with no R, so only
230 do this if we're in 2D and we've just found a good B(oth) frame.
232 ++first_nonexistant_frame;
235 LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame);
239 return first_nonexistant_frame;
243 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
245 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
246 write_frame_info (frame, eyes, fin);
247 _last_written[eyes] = encoded;
248 _last_written_video_frame = frame;
249 _last_written_eyes = eyes;
253 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
255 _picture_asset_writer->fake_write (size);
256 _last_written_video_frame = frame;
257 _last_written_eyes = eyes;
261 ReelWriter::repeat_write (Frame frame, Eyes eyes)
263 dcp::FrameInfo fin = _picture_asset_writer->write (
264 _last_written[eyes]->data().get(),
265 _last_written[eyes]->size()
267 write_frame_info (frame, eyes, fin);
268 _last_written_video_frame = frame;
269 _last_written_eyes = eyes;
273 ReelWriter::finish ()
275 if (!_picture_asset_writer->finalize ()) {
276 /* Nothing was written to the picture asset */
277 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
278 _picture_asset.reset ();
281 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
282 /* Nothing was written to the sound asset */
283 _sound_asset.reset ();
286 /* Hard-link any video asset file into the DCP */
287 if (_picture_asset) {
288 DCPOMATIC_ASSERT (_picture_asset->file());
289 boost::filesystem::path video_from = _picture_asset->file().get();
290 boost::filesystem::path video_to;
291 video_to /= _film->dir (_film->dcp_name());
292 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
294 boost::system::error_code ec;
295 boost::filesystem::create_hard_link (video_from, video_to, ec);
297 LOG_WARNING_NC ("Hard-link failed; copying instead");
298 boost::filesystem::copy_file (video_from, video_to, ec);
300 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
301 throw FileError (ec.message(), video_from);
305 _picture_asset->set_file (video_to);
308 /* Move the audio asset into the DCP */
310 boost::filesystem::path audio_to;
311 audio_to /= _film->dir (_film->dcp_name ());
312 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
315 boost::system::error_code ec;
316 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
319 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
323 _sound_asset->set_file (audio_to);
330 shared_ptr<dcp::SubtitleAsset> asset,
331 int64_t picture_duration,
332 shared_ptr<dcp::Reel> reel,
333 list<ReferencedReelAsset> const & refs,
334 list<shared_ptr<Font> > const & fonts,
335 shared_ptr<const Film> film,
339 Frame const period_duration = period.duration().frames_round(film->video_frame_rate());
341 shared_ptr<T> reel_asset;
344 boost::filesystem::path liberation_normal;
346 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
347 if (!boost::filesystem::exists (liberation_normal)) {
348 /* Hack for unit tests */
349 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
351 } catch (boost::filesystem::filesystem_error& e) {
355 if (!boost::filesystem::exists(liberation_normal)) {
356 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
359 /* Add the font to the subtitle content */
360 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
361 asset->add_font (j->id(), j->file().get_value_or(liberation_normal));
364 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (asset)) {
365 boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id ();
366 boost::filesystem::create_directories (directory);
367 asset->write (directory / ("sub_" + asset->id() + ".xml"));
369 /* All our assets should be the same length; use the picture asset length here
370 as a reference to set the subtitle one. We'll use the duration rather than
371 the intrinsic duration; we don't care if the picture asset has been trimmed, we're
372 just interested in its presentation length.
374 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(asset)->set_intrinsic_duration (picture_duration);
377 film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf")
384 dcp::Fraction (film->video_frame_rate(), 1),
390 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
391 BOOST_FOREACH (ReferencedReelAsset j, refs) {
392 shared_ptr<T> k = dynamic_pointer_cast<T> (j.asset);
393 if (k && j.period == period) {
395 /* If we have a hash for this asset in the CPL, assume that it is correct */
397 k->asset_ref()->set_hash (k->hash().get());
404 if (reel_asset->actual_duration() != period_duration) {
405 throw ProgrammingError (
407 String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration)
410 reel->add (reel_asset);
416 shared_ptr<dcp::Reel>
417 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
419 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
421 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
423 if (_picture_asset) {
424 /* We have made a picture asset of our own. Put it into the reel */
425 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
427 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
430 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
432 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
435 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
436 /* We don't have a picture asset of our own; hopefully we have one to reference */
437 BOOST_FOREACH (ReferencedReelAsset j, refs) {
438 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
440 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
442 if (k && j.period == _period) {
443 reel_picture_asset = k;
448 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
450 Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate());
452 DCPOMATIC_ASSERT (reel_picture_asset);
453 if (reel_picture_asset->duration() != period_duration) {
454 throw ProgrammingError (
456 String::compose ("%1 vs %2", reel_picture_asset->actual_duration(), period_duration)
459 reel->add (reel_picture_asset);
461 /* If we have a hash for this asset in the CPL, assume that it is correct */
462 if (reel_picture_asset->hash()) {
463 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
466 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
469 /* We have made a sound asset of our own. Put it into the reel */
470 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
472 /* We don't have a sound asset of our own; hopefully we have one to reference */
473 BOOST_FOREACH (ReferencedReelAsset j, refs) {
474 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
475 if (k && j.period == _period) {
476 reel_sound_asset = k;
477 /* If we have a hash for this asset in the CPL, assume that it is correct */
479 k->asset_ref()->set_hash (k->hash().get());
485 DCPOMATIC_ASSERT (reel_sound_asset);
486 if (reel_sound_asset->actual_duration() != period_duration) {
488 "Reel sound asset has length %1 but reel period is %2",
489 reel_sound_asset->actual_duration(),
492 if (reel_sound_asset->actual_duration() != period_duration) {
493 throw ProgrammingError (
495 String::compose ("%1 vs %2", reel_sound_asset->actual_duration(), period_duration)
500 reel->add (reel_sound_asset);
502 maybe_add_text<dcp::ReelSubtitleAsset> (_subtitle_asset, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period);
503 for (map<DCPTextTrack, shared_ptr<dcp::SubtitleAsset> >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) {
504 shared_ptr<dcp::ReelClosedCaptionAsset> a = maybe_add_text<dcp::ReelClosedCaptionAsset> (
505 i->second, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period
507 a->set_annotation_text (i->first.name);
508 a->set_language (i->first.language);
511 map<dcp::Marker, DCPTime> markers = _film->markers ();
512 map<dcp::Marker, DCPTime> reel_markers;
513 for (map<dcp::Marker, DCPTime>::const_iterator i = markers.begin(); i != markers.end(); ++i) {
514 if (_period.contains(i->second)) {
515 reel_markers[i->first] = i->second;
519 if (!reel_markers.empty ()) {
520 shared_ptr<dcp::ReelMarkersAsset> ma (new dcp::ReelMarkersAsset(dcp::Fraction(_film->video_frame_rate(), 1), 0));
521 for (map<dcp::Marker, DCPTime>::const_iterator i = reel_markers.begin(); i != reel_markers.end(); ++i) {
523 DCPTime relative = i->second - _period.from;
524 relative.split (_film->video_frame_rate(), h, m, s, f);
525 ma->set (i->first, dcp::Time(h, m, s, f, _film->video_frame_rate()));
534 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
536 if (_picture_asset) {
537 _picture_asset->hash (set_progress);
541 _sound_asset->hash (set_progress);
546 ReelWriter::start () const
548 return _period.from.frames_floor (_film->video_frame_rate());
553 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
555 if (!_sound_asset_writer) {
559 DCPOMATIC_ASSERT (audio);
560 _sound_asset_writer->write (audio->data(), audio->frames());
564 ReelWriter::write (PlayerText subs, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
566 shared_ptr<dcp::SubtitleAsset> asset;
569 case TEXT_OPEN_SUBTITLE:
570 asset = _subtitle_asset;
572 case TEXT_CLOSED_CAPTION:
573 DCPOMATIC_ASSERT (track);
574 asset = _closed_caption_assets[*track];
577 DCPOMATIC_ASSERT (false);
581 string lang = _film->subtitle_language ();
582 if (_film->interop ()) {
583 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
584 s->set_movie_title (_film->name ());
585 if (type == TEXT_OPEN_SUBTITLE) {
586 s->set_language (lang.empty() ? "Unknown" : lang);
588 s->set_language (track->language);
590 s->set_reel_number (raw_convert<string> (_reel_index + 1));
593 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
594 s->set_content_title_text (_film->name ());
595 if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) {
596 s->set_language (lang);
598 s->set_language (track->language);
600 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
601 s->set_reel_number (_reel_index + 1);
602 s->set_time_code_rate (_film->video_frame_rate ());
603 s->set_start_time (dcp::Time ());
604 if (_film->encrypted ()) {
605 s->set_key (_film->key ());
612 case TEXT_OPEN_SUBTITLE:
613 _subtitle_asset = asset;
615 case TEXT_CLOSED_CAPTION:
616 DCPOMATIC_ASSERT (track);
617 _closed_caption_assets[*track] = asset;
620 DCPOMATIC_ASSERT (false);
623 BOOST_FOREACH (StringText i, subs.string) {
624 /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */
625 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
626 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
627 asset->add (shared_ptr<dcp::Subtitle>(new dcp::SubtitleString(i)));
630 BOOST_FOREACH (BitmapText i, subs.bitmap) {
632 shared_ptr<dcp::Subtitle>(
633 new dcp::SubtitleImage(
635 dcp::Time(period.from.seconds() - _period.from.seconds(), _film->video_frame_rate()),
636 dcp::Time(period.to.seconds() - _period.from.seconds(), _film->video_frame_rate()),
637 i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP,
638 dcp::Time(), dcp::Time()
646 ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr<InfoFileHandle> info_file, Frame frame) const
648 LOG_GENERAL ("Checking existing picture frame %1", frame);
650 /* Read the data from the info file; for 3D we just check the left
651 frames until we find a good one.
653 dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
657 /* Read the data from the asset and hash it */
658 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
659 Data data (info.size);
660 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
661 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
662 if (read != static_cast<size_t> (data.size ())) {
663 LOG_GENERAL ("Existing frame %1 is incomplete", frame);
667 digester.add (data.data().get(), data.size());
668 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
669 if (digester.get() != info.hash) {
670 LOG_GENERAL ("Existing frame %1 failed hash check", frame);