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 <boost/foreach.hpp>
48 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
49 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
50 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
51 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
56 using boost::shared_ptr;
57 using boost::optional;
58 using boost::dynamic_pointer_cast;
61 int const ReelWriter::_info_size = 48;
63 ReelWriter::ReelWriter (
64 shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job, int reel_index, int reel_count, optional<string> content_summary
68 , _first_nonexistant_frame (0)
69 , _last_written_video_frame (-1)
70 , _last_written_eyes (EYES_RIGHT)
71 , _total_written_audio_frames (0)
72 , _reel_index (reel_index)
73 , _reel_count (reel_count)
74 , _content_summary (content_summary)
76 /* Create our picture asset in a subdirectory, named according to those
77 film's parameters which affect the video output. We will hard-link
78 it into the DCP later.
81 if (_film->three_d ()) {
82 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
84 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
87 _picture_asset->set_size (_film->frame_size ());
89 if (_film->encrypted ()) {
90 _picture_asset->set_key (_film->key ());
91 _picture_asset->set_context_id (_film->context_id ());
94 _picture_asset->set_file (
95 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
98 job->sub (_("Checking existing image data"));
99 check_existing_picture_asset ();
101 _picture_asset_writer = _picture_asset->start_write (
102 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
103 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
104 _first_nonexistant_frame > 0
107 if (_film->audio_channels ()) {
109 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
112 if (_film->encrypted ()) {
113 _sound_asset->set_key (_film->key ());
116 DCPOMATIC_ASSERT (_film->directory());
118 /* Write the sound asset into the film directory so that we leave the creation
119 of the DCP directory until the last minute.
121 _sound_asset_writer = _sound_asset->start_write (
122 _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary),
123 _film->interop() ? dcp::INTEROP : dcp::SMPTE
128 /** @param frame reel-relative frame */
130 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
133 boost::filesystem::path info_file = _film->info_file (_period);
135 bool const read = boost::filesystem::exists (info_file);
137 #ifdef DCPOMATIC_WINDOWS
140 "Checked %1 (which exists) length is %2 perms are %3",
141 info_file, boost::filesystem::file_size (info_file), int(boost::filesystem::status(info_file).permissions())
144 LOG_GENERAL ("Checked %1 (which does not exist)", info_file);
149 file = fopen_boost (info_file, "r+b");
151 file = fopen_boost (info_file, "wb");
154 throw OpenFileError (info_file, errno, read);
156 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
157 fwrite (&info.offset, sizeof (info.offset), 1, file);
158 fwrite (&info.size, sizeof (info.size), 1, file);
159 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
164 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
167 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
168 fread (&info.offset, sizeof (info.offset), 1, file);
169 fread (&info.size, sizeof (info.size), 1, file);
171 char hash_buffer[33];
172 fread (hash_buffer, 1, 32, file);
173 hash_buffer[32] = '\0';
174 info.hash = hash_buffer;
180 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
184 return frame * _info_size;
186 return frame * _info_size * 2;
188 return frame * _info_size * 2 + _info_size;
190 DCPOMATIC_ASSERT (false);
193 DCPOMATIC_ASSERT (false);
197 ReelWriter::check_existing_picture_asset ()
199 /* Try to open the existing asset */
200 DCPOMATIC_ASSERT (_picture_asset->file());
201 FILE* asset_file = fopen_boost (_picture_asset->file().get(), "rb");
203 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file()->string(), errno);
206 LOG_GENERAL ("Opened existing asset at %1", _picture_asset->file()->string());
209 /* Offset of the last dcp::FrameInfo in the info file */
210 int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
211 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);
213 FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
215 LOG_GENERAL_NC ("Could not open film info file");
220 if (_film->three_d ()) {
221 /* Start looking at the last left frame */
222 _first_nonexistant_frame = n / 2;
224 _first_nonexistant_frame = n;
227 while (!existing_picture_frame_ok(asset_file, info_file) && _first_nonexistant_frame > 0) {
228 --_first_nonexistant_frame;
231 if (!_film->three_d() && _first_nonexistant_frame > 0) {
232 /* If we are doing 3D we might have found a good L frame with no R, so only
233 do this if we're in 2D and we've just found a good B(oth) frame.
235 ++_first_nonexistant_frame;
238 LOG_GENERAL ("Proceeding with first nonexistant frame %1", _first_nonexistant_frame);
245 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
247 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
248 write_frame_info (frame, eyes, fin);
249 _last_written[eyes] = encoded;
250 _last_written_video_frame = frame;
251 _last_written_eyes = eyes;
255 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
257 _picture_asset_writer->fake_write (size);
258 _last_written_video_frame = frame;
259 _last_written_eyes = eyes;
263 ReelWriter::repeat_write (Frame frame, Eyes eyes)
265 dcp::FrameInfo fin = _picture_asset_writer->write (
266 _last_written[eyes]->data().get(),
267 _last_written[eyes]->size()
269 write_frame_info (frame, eyes, fin);
270 _last_written_video_frame = frame;
271 _last_written_eyes = eyes;
275 ReelWriter::finish ()
277 if (!_picture_asset_writer->finalize ()) {
278 /* Nothing was written to the picture asset */
279 LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count);
280 _picture_asset.reset ();
283 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
284 /* Nothing was written to the sound asset */
285 _sound_asset.reset ();
288 /* Hard-link any video asset file into the DCP */
289 if (_picture_asset) {
290 DCPOMATIC_ASSERT (_picture_asset->file());
291 boost::filesystem::path video_from = _picture_asset->file().get();
292 boost::filesystem::path video_to;
293 video_to /= _film->dir (_film->dcp_name());
294 video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary);
296 boost::system::error_code ec;
297 boost::filesystem::create_hard_link (video_from, video_to, ec);
299 LOG_WARNING_NC ("Hard-link failed; copying instead");
300 boost::filesystem::copy_file (video_from, video_to, ec);
302 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
303 throw FileError (ec.message(), video_from);
307 _picture_asset->set_file (video_to);
310 /* Move the audio asset into the DCP */
312 boost::filesystem::path audio_to;
313 audio_to /= _film->dir (_film->dcp_name ());
314 string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary);
317 boost::system::error_code ec;
318 boost::filesystem::rename (_film->file (aaf), audio_to, ec);
321 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf
325 _sound_asset->set_file (audio_to);
329 shared_ptr<dcp::Reel>
330 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
332 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
334 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
336 if (_picture_asset) {
337 /* We have made a picture asset of our own. Put it into the reel */
338 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
340 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
343 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
345 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
348 LOG_GENERAL ("no picture asset of our own; look through %1", refs.size());
349 /* We don't have a picture asset of our own; hopefully we have one to reference */
350 BOOST_FOREACH (ReferencedReelAsset j, refs) {
351 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
353 LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get());
355 if (k && j.period == _period) {
356 reel_picture_asset = k;
361 LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count);
363 DCPOMATIC_ASSERT (reel_picture_asset);
364 reel->add (reel_picture_asset);
366 /* If we have a hash for this asset in the CPL, assume that it is correct */
367 if (reel_picture_asset->hash()) {
368 reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get());
372 /* We have made a sound asset of our own. Put it into the reel */
373 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
375 /* We don't have a sound asset of our own; hopefully we have one to reference */
376 BOOST_FOREACH (ReferencedReelAsset j, refs) {
377 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
378 if (k && j.period == _period) {
380 /* If we have a hash for this asset in the CPL, assume that it is correct */
382 k->asset_ref()->set_hash (k->hash().get());
388 if (_subtitle_asset) {
390 boost::filesystem::path liberation_normal;
392 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
393 if (!boost::filesystem::exists (liberation_normal)) {
394 /* Hack for unit tests */
395 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
397 } catch (boost::filesystem::filesystem_error& e) {
401 if (!boost::filesystem::exists(liberation_normal)) {
402 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
405 /* Add all the fonts to the subtitle content */
406 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
407 _subtitle_asset->add_font (j->id(), j->file(FontFiles::NORMAL).get_value_or(liberation_normal));
410 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
411 boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
412 boost::filesystem::create_directories (directory);
413 _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
416 /* All our assets should be the same length; use the picture asset length here
417 as a reference to set the subtitle one.
419 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(_subtitle_asset)->set_intrinsic_duration (
420 reel_picture_asset->intrinsic_duration ()
423 _subtitle_asset->write (
424 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
428 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
429 new dcp::ReelSubtitleAsset (
431 dcp::Fraction (_film->video_frame_rate(), 1),
432 reel_picture_asset->intrinsic_duration (),
437 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
438 BOOST_FOREACH (ReferencedReelAsset j, refs) {
439 shared_ptr<dcp::ReelSubtitleAsset> k = dynamic_pointer_cast<dcp::ReelSubtitleAsset> (j.asset);
440 if (k && j.period == _period) {
442 /* If we have a hash for this asset in the CPL, assume that it is correct */
444 k->asset_ref()->set_hash (k->hash().get());
454 ReelWriter::calculate_digests (boost::function<void (float)> set_progress)
456 if (_picture_asset) {
457 _picture_asset->hash (set_progress);
461 _sound_asset->hash (set_progress);
466 ReelWriter::start () const
468 return _period.from.frames_floor (_film->video_frame_rate());
473 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
475 if (!_sound_asset_writer) {
480 _sound_asset_writer->write (audio->data(), audio->frames());
483 ++_total_written_audio_frames;
487 ReelWriter::write (PlayerSubtitles subs)
489 if (!_subtitle_asset) {
490 string lang = _film->subtitle_language ();
494 if (_film->interop ()) {
495 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
496 s->set_movie_title (_film->name ());
497 s->set_language (lang);
498 s->set_reel_number ("1");
501 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
502 s->set_content_title_text (_film->name ());
503 s->set_language (lang);
504 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
505 s->set_reel_number (1);
506 s->set_time_code_rate (_film->video_frame_rate ());
507 s->set_start_time (dcp::Time ());
508 if (_film->encrypted ()) {
509 s->set_key (_film->key ());
515 BOOST_FOREACH (SubtitleString i, subs.text) {
516 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
517 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
518 _subtitle_asset->add (i);
523 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file) const
525 LOG_GENERAL ("Checking existing picture frame %1", _first_nonexistant_frame);
527 /* Read the data from the info file; for 3D we just check the left
528 frames until we find a good one.
530 dcp::FrameInfo const info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
534 /* Read the data from the asset and hash it */
535 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
536 Data data (info.size);
537 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
538 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
539 if (read != static_cast<size_t> (data.size ())) {
540 LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
544 digester.add (data.data().get(), data.size());
545 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
546 if (digester.get() != info.hash) {
547 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);