2 Copyright (C) 2012-2016 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"
30 #include <dcp/mono_picture_asset.h>
31 #include <dcp/stereo_picture_asset.h>
32 #include <dcp/sound_asset.h>
33 #include <dcp/sound_asset_writer.h>
35 #include <dcp/reel_mono_picture_asset.h>
36 #include <dcp/reel_stereo_picture_asset.h>
37 #include <dcp/reel_sound_asset.h>
38 #include <dcp/reel_subtitle_asset.h>
41 #include <dcp/certificate_chain.h>
42 #include <dcp/interop_subtitle_asset.h>
43 #include <dcp/smpte_subtitle_asset.h>
44 #include <dcp/raw_convert.h>
45 #include <boost/foreach.hpp>
49 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
50 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
51 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
52 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
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 , _first_nonexistant_frame (0)
71 , _last_written_video_frame (-1)
72 , _last_written_eyes (EYES_RIGHT)
73 , _total_written_audio_frames (0)
74 , _reel_index (reel_index)
75 , _reel_count (reel_count)
76 , _content_summary (content_summary)
78 /* Create our picture asset in a subdirectory, named according to those
79 film's parameters which affect the video output. We will hard-link
80 it into the DCP later.
83 if (_film->three_d ()) {
84 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
86 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
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 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 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
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 ())
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),
125 _film->interop() ? dcp::INTEROP : dcp::SMPTE
130 /** @param frame reel-relative frame */
132 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
135 boost::filesystem::path info_file = _film->info_file (_period);
137 bool const read = boost::filesystem::exists (info_file);
139 #ifdef DCPOMATIC_WINDOWS
142 "Checked %1 (which exists) length is %2 perms are %3",
143 info_file, boost::filesystem::file_size (info_file), int(boost::filesystem::status(info_file).permissions())
146 LOG_GENERAL ("Checked %1 (which does not exist)", info_file);
151 file = fopen_boost (info_file, "r+b");
153 file = fopen_boost (info_file, "wb");
156 throw OpenFileError (info_file, errno, read);
158 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
159 fwrite (&info.offset, sizeof (info.offset), 1, file);
160 fwrite (&info.size, sizeof (info.size), 1, file);
161 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
166 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
169 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
170 fread (&info.offset, sizeof (info.offset), 1, file);
171 fread (&info.size, sizeof (info.size), 1, file);
173 char hash_buffer[33];
174 fread (hash_buffer, 1, 32, file);
175 hash_buffer[32] = '\0';
176 info.hash = hash_buffer;
182 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
186 return frame * _info_size;
188 return frame * _info_size * 2;
190 return frame * _info_size * 2 + _info_size;
192 DCPOMATIC_ASSERT (false);
195 DCPOMATIC_ASSERT (false);
199 ReelWriter::check_existing_picture_asset ()
201 /* Try to open the existing asset */
202 DCPOMATIC_ASSERT (_picture_asset->file());
203 FILE* asset_file = fopen_boost (_picture_asset->file().get(), "rb");
205 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file()->string(), errno);
208 LOG_GENERAL ("Opened existing asset at %1", _picture_asset->file()->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 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 > 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);
247 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
249 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
250 write_frame_info (frame, eyes, fin);
251 _last_written[eyes] = encoded;
252 _last_written_video_frame = frame;
253 _last_written_eyes = eyes;
257 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
259 _picture_asset_writer->fake_write (size);
260 _last_written_video_frame = frame;
261 _last_written_eyes = eyes;
265 ReelWriter::repeat_write (Frame frame, Eyes eyes)
267 dcp::FrameInfo fin = _picture_asset_writer->write (
268 _last_written[eyes]->data().get(),
269 _last_written[eyes]->size()
271 write_frame_info (frame, eyes, fin);
272 _last_written_video_frame = frame;
273 _last_written_eyes = eyes;
277 ReelWriter::finish ()
279 if (!_picture_asset_writer->finalize ()) {
280 /* Nothing was written to the picture asset */
281 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
282 _picture_asset.reset ();
285 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
286 /* Nothing was written to the sound asset */
287 _sound_asset.reset ();
290 /* Hard-link any video asset file into the DCP */
291 if (_picture_asset) {
292 DCPOMATIC_ASSERT (_picture_asset->file());
293 boost::filesystem::path video_from = _picture_asset->file().get();
294 boost::filesystem::path video_to;
295 video_to /= _film->dir (_film->dcp_name());
296 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
298 boost::system::error_code ec;
299 boost::filesystem::create_hard_link (video_from, video_to, ec);
301 LOG_WARNING_NC ("Hard-link failed; copying instead");
302 boost::filesystem::copy_file (video_from, video_to, ec);
304 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
305 throw FileError (ec.message(), video_from);
309 _picture_asset->set_file (video_to);
312 /* Move the audio asset into the DCP */
314 boost::filesystem::path audio_to;
315 audio_to /= _film->dir (_film->dcp_name ());
316 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
319 boost::system::error_code ec;
320 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
323 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
327 _sound_asset->set_file (audio_to);
331 shared_ptr<dcp::Reel>
332 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
334 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
336 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
338 if (_picture_asset) {
339 /* We have made a picture asset of our own. Put it into the reel */
340 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
342 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
345 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
347 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
350 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
351 /* We don't have a picture asset of our own; hopefully we have one to reference */
352 BOOST_FOREACH (ReferencedReelAsset j, refs) {
353 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
355 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
357 if (k && j.period == _period) {
358 reel_picture_asset = k;
363 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
365 DCPOMATIC_ASSERT (reel_picture_asset);
366 if (reel_picture_asset->duration() != _period.duration().frames_round (_film->video_frame_rate ())) {
367 throw ProgrammingError (
369 String::compose ("%1 vs %2", reel_picture_asset->duration(), _period.duration().frames_round (_film->video_frame_rate ()))
372 reel->add (reel_picture_asset);
374 /* If we have a hash for this asset in the CPL, assume that it is correct */
375 if (reel_picture_asset->hash()) {
376 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
379 shared_ptr<dcp::ReelSoundAsset> reel_sound_asset;
382 /* We have made a sound asset of our own. Put it into the reel */
383 reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0));
385 /* We don't have a sound asset of our own; hopefully we have one to reference */
386 BOOST_FOREACH (ReferencedReelAsset j, refs) {
387 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
388 if (k && j.period == _period) {
389 reel_sound_asset = k;
390 /* If we have a hash for this asset in the CPL, assume that it is correct */
392 k->asset_ref()->set_hash (k->hash().get());
398 DCPOMATIC_ASSERT (reel_sound_asset);
399 if (reel_sound_asset->duration() != _period.duration().frames_round (_film->video_frame_rate ())) {
401 "Reel sound asset has length %1 but reel period is %2",
402 reel_sound_asset->duration(),
403 _period.duration().frames_round(_film->video_frame_rate())
405 DCPOMATIC_ASSERT (reel_sound_asset->duration() == _period.duration().frames_round (_film->video_frame_rate ()));
407 reel->add (reel_sound_asset);
409 shared_ptr<dcp::ReelSubtitleAsset> reel_subtitle_asset;
411 if (_subtitle_asset) {
413 boost::filesystem::path liberation_normal;
415 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
416 if (!boost::filesystem::exists (liberation_normal)) {
417 /* Hack for unit tests */
418 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
420 } catch (boost::filesystem::filesystem_error& e) {
424 if (!boost::filesystem::exists(liberation_normal)) {
425 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
428 /* Add all the fonts to the subtitle content */
429 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
430 _subtitle_asset->add_font (j->id(), j->file(FontFiles::NORMAL).get_value_or(liberation_normal));
433 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
434 boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
435 boost::filesystem::create_directories (directory);
436 _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
439 /* All our assets should be the same length; use the picture asset length here
440 as a reference to set the subtitle one.
442 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(_subtitle_asset)->set_intrinsic_duration (
443 reel_picture_asset->intrinsic_duration ()
446 _subtitle_asset->write (
447 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
451 reel_subtitle_asset.reset (
452 new dcp::ReelSubtitleAsset (
454 dcp::Fraction (_film->video_frame_rate(), 1),
455 reel_picture_asset->intrinsic_duration (),
460 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
461 BOOST_FOREACH (ReferencedReelAsset j, refs) {
462 shared_ptr<dcp::ReelSubtitleAsset> k = dynamic_pointer_cast<dcp::ReelSubtitleAsset> (j.asset);
463 if (k && j.period == _period) {
464 reel_subtitle_asset = k;
465 /* If we have a hash for this asset in the CPL, assume that it is correct */
467 k->asset_ref()->set_hash (k->hash().get());
473 if (reel_subtitle_asset) {
474 DCPOMATIC_ASSERT (reel_subtitle_asset->duration() == _period.duration().frames_round (_film->video_frame_rate ()));
475 reel->add (reel_subtitle_asset);
482 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
484 if (_picture_asset) {
485 _picture_asset->hash (set_progress);
489 _sound_asset->hash (set_progress);
494 ReelWriter::start () const
496 return _period.from.frames_floor (_film->video_frame_rate());
501 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
503 if (!_sound_asset_writer) {
508 _sound_asset_writer->write (audio->data(), audio->frames());
511 _total_written_audio_frames += audio->frames ();
515 ReelWriter::write (PlayerSubtitles subs)
517 if (!_subtitle_asset) {
518 string lang = _film->subtitle_language ();
522 if (_film->interop ()) {
523 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
524 s->set_movie_title (_film->name ());
525 s->set_language (lang);
526 s->set_reel_number (raw_convert<string> (_reel_index + 1));
529 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
530 s->set_content_title_text (_film->name ());
531 s->set_language (lang);
532 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
533 s->set_reel_number (_reel_index + 1);
534 s->set_time_code_rate (_film->video_frame_rate ());
535 s->set_start_time (dcp::Time ());
536 if (_film->encrypted ()) {
537 s->set_key (_film->key ());
543 BOOST_FOREACH (SubtitleString i, subs.text) {
544 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
545 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
546 _subtitle_asset->add (i);
551 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file) const
553 LOG_GENERAL ("Checking existing picture frame %1", _first_nonexistant_frame);
555 /* Read the data from the info file; for 3D we just check the left
556 frames until we find a good one.
558 dcp::FrameInfo const info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
562 /* Read the data from the asset and hash it */
563 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
564 Data data (info.size);
565 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
566 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
567 if (read != static_cast<size_t> (data.size ())) {
568 LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
572 digester.add (data.data().get(), data.size());
573 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
574 if (digester.get() != info.hash) {
575 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);