2 Copyright (C) 2012-2015 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 "md5_digester.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 (shared_ptr<const Film> film, DCPTimePeriod period, shared_ptr<Job> job)
66 , _first_nonexistant_frame (0)
67 , _last_written_video_frame (-1)
68 , _last_written_eyes (EYES_RIGHT)
69 , _total_written_audio_frames (0)
71 /* Create our picture asset in a subdirectory, named according to those
72 film's parameters which affect the video output. We will hard-link
73 it into the DCP later.
76 if (_film->three_d ()) {
77 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
79 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
82 _picture_asset->set_size (_film->frame_size ());
84 if (_film->encrypted ()) {
85 _picture_asset->set_key (_film->key ());
88 _picture_asset->set_file (
89 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period)
92 job->sub (_("Checking existing image data"));
93 check_existing_picture_asset ();
95 _picture_asset_writer = _picture_asset->start_write (
96 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period),
97 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
98 _first_nonexistant_frame > 0
101 if (_film->audio_channels ()) {
103 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
106 if (_film->encrypted ()) {
107 _sound_asset->set_key (_film->key ());
110 /* Write the sound asset into the film directory so that we leave the creation
111 of the DCP directory until the last minute.
113 _sound_asset_writer = _sound_asset->start_write (
114 _film->directory() / audio_asset_filename (_sound_asset),
115 _film->interop() ? dcp::INTEROP : dcp::SMPTE
120 /** @param frame reel-relative frame */
122 ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const
125 boost::filesystem::path info_file = _film->info_file (_period);
126 if (boost::filesystem::exists (info_file)) {
127 file = fopen_boost (info_file, "r+b");
129 file = fopen_boost (info_file, "wb");
132 throw OpenFileError (info_file);
134 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
135 fwrite (&info.offset, sizeof (info.offset), 1, file);
136 fwrite (&info.size, sizeof (info.size), 1, file);
137 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
142 ReelWriter::read_frame_info (FILE* file, Frame frame, Eyes eyes) const
145 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
146 fread (&info.offset, sizeof (info.offset), 1, file);
147 fread (&info.size, sizeof (info.size), 1, file);
149 char hash_buffer[33];
150 fread (hash_buffer, 1, 32, file);
151 hash_buffer[32] = '\0';
152 info.hash = hash_buffer;
158 ReelWriter::frame_info_position (Frame frame, Eyes eyes) const
162 return frame * _info_size;
164 return frame * _info_size * 2;
166 return frame * _info_size * 2 + _info_size;
168 DCPOMATIC_ASSERT (false);
171 DCPOMATIC_ASSERT (false);
175 ReelWriter::check_existing_picture_asset ()
177 /* Try to open the existing asset */
178 FILE* asset_file = fopen_boost (_picture_asset->file(), "rb");
180 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file().string(), errno);
183 LOG_GENERAL ("Opened existing asset at %1", _picture_asset->file().string());
186 /* Offset of the last dcp::FrameInfo in the info file */
187 int const n = (boost::filesystem::file_size (_film->info_file(_period)) / _info_size) - 1;
188 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);
190 FILE* info_file = fopen_boost (_film->info_file(_period), "rb");
192 LOG_GENERAL_NC ("Could not open film info file");
197 if (_film->three_d ()) {
198 /* Start looking at the last left frame */
199 _first_nonexistant_frame = n / 2;
201 _first_nonexistant_frame = n;
204 while (!existing_picture_frame_ok(asset_file, info_file) && _first_nonexistant_frame > 0) {
205 --_first_nonexistant_frame;
208 if (!_film->three_d() && _first_nonexistant_frame > 0) {
209 /* If we are doing 3D we might have found a good L frame with no R, so only
210 do this if we're in 2D and we've just found a good B(oth) frame.
212 ++_first_nonexistant_frame;
215 LOG_GENERAL ("Proceeding with first nonexistant frame %1", _first_nonexistant_frame);
222 ReelWriter::write (optional<Data> encoded, Frame frame, Eyes eyes)
224 dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size());
225 write_frame_info (frame, eyes, fin);
226 _last_written[eyes] = encoded;
227 _last_written_video_frame = frame;
228 _last_written_eyes = eyes;
232 ReelWriter::fake_write (Frame frame, Eyes eyes, int size)
234 _picture_asset_writer->fake_write (size);
235 _last_written_video_frame = frame;
236 _last_written_eyes = eyes;
240 ReelWriter::repeat_write (Frame frame, Eyes eyes)
242 dcp::FrameInfo fin = _picture_asset_writer->write (
243 _last_written[eyes]->data().get(),
244 _last_written[eyes]->size()
246 write_frame_info (frame, eyes, fin);
247 _last_written_video_frame = frame;
248 _last_written_eyes = eyes;
252 ReelWriter::finish ()
254 if (!_picture_asset_writer->finalize ()) {
255 /* Nothing was written to the picture asset */
256 _picture_asset.reset ();
259 if (_sound_asset_writer && !_sound_asset_writer->finalize ()) {
260 /* Nothing was written to the sound asset */
261 _sound_asset.reset ();
264 /* Hard-link any video asset file into the DCP */
265 if (_picture_asset) {
266 boost::filesystem::path video_from = _picture_asset->file ();
267 boost::filesystem::path video_to;
268 video_to /= _film->dir (_film->dcp_name());
269 video_to /= video_asset_filename (_picture_asset);
271 boost::system::error_code ec;
272 boost::filesystem::create_hard_link (video_from, video_to, ec);
274 LOG_WARNING_NC ("Hard-link failed; copying instead");
275 boost::filesystem::copy_file (video_from, video_to, ec);
277 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
278 throw FileError (ec.message(), video_from);
282 _picture_asset->set_file (video_to);
285 /* Move the audio asset into the DCP */
287 boost::filesystem::path audio_to;
288 audio_to /= _film->dir (_film->dcp_name ());
289 audio_to /= audio_asset_filename (_sound_asset);
291 boost::system::error_code ec;
292 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
295 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
299 _sound_asset->set_file (audio_to);
303 shared_ptr<dcp::Reel>
304 ReelWriter::create_reel (list<ReferencedReelAsset> const & refs, list<shared_ptr<Font> > const & fonts)
306 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
308 shared_ptr<dcp::ReelPictureAsset> reel_picture_asset;
310 if (_picture_asset) {
311 /* We have made a picture asset of our own. Put it into the reel */
312 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
314 reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0));
317 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
319 reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0));
322 /* We don't have a picture asset of our own; hopefully we have one to reference */
323 BOOST_FOREACH (ReferencedReelAsset j, refs) {
324 shared_ptr<dcp::ReelPictureAsset> k = dynamic_pointer_cast<dcp::ReelPictureAsset> (j.asset);
325 if (k && j.period == _period) {
326 reel_picture_asset = k;
331 reel->add (reel_picture_asset);
334 /* We have made a sound asset of our own. Put it into the reel */
335 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
337 /* We don't have a sound asset of our own; hopefully we have one to reference */
338 BOOST_FOREACH (ReferencedReelAsset j, refs) {
339 shared_ptr<dcp::ReelSoundAsset> k = dynamic_pointer_cast<dcp::ReelSoundAsset> (j.asset);
340 if (k && j.period == _period) {
346 if (_subtitle_asset) {
348 boost::filesystem::path liberation_normal;
350 liberation_normal = shared_path() / "LiberationSans-Regular.ttf";
351 if (!boost::filesystem::exists (liberation_normal)) {
352 /* Hack for unit tests */
353 liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf";
355 } catch (boost::filesystem::filesystem_error& e) {
359 if (!boost::filesystem::exists(liberation_normal)) {
360 liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
363 /* Add all the fonts to the subtitle content */
364 BOOST_FOREACH (shared_ptr<Font> j, fonts) {
365 _subtitle_asset->add_font (j->id(), j->file(FontFiles::NORMAL).get_value_or(liberation_normal));
368 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
369 boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
370 boost::filesystem::create_directories (directory);
371 _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
374 /* All our assets should be the same length; use the picture asset length here
375 as a reference to set the subtitle one.
377 dynamic_pointer_cast<dcp::SMPTESubtitleAsset>(_subtitle_asset)->set_intrinsic_duration (
378 reel_picture_asset->intrinsic_duration ()
381 _subtitle_asset->write (
382 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
386 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
387 new dcp::ReelSubtitleAsset (
389 dcp::Fraction (_film->video_frame_rate(), 1),
390 reel_picture_asset->intrinsic_duration (),
395 /* We don't have a subtitle asset of our own; hopefully we have one to reference */
396 BOOST_FOREACH (ReferencedReelAsset j, refs) {
397 shared_ptr<dcp::ReelSubtitleAsset> k = dynamic_pointer_cast<dcp::ReelSubtitleAsset> (j.asset);
398 if (k && j.period == _period) {
408 ReelWriter::calculate_digests (shared_ptr<Job> job)
410 job->sub (_("Computing image digest"));
411 if (_picture_asset) {
412 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
416 job->sub (_("Computing audio digest"));
417 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
422 ReelWriter::start () const
424 return _period.from.frames_floor (_film->video_frame_rate());
429 ReelWriter::write (shared_ptr<const AudioBuffers> audio)
431 if (!_sound_asset_writer) {
436 _sound_asset_writer->write (audio->data(), audio->frames());
439 ++_total_written_audio_frames;
443 ReelWriter::write (PlayerSubtitles subs)
445 if (!_subtitle_asset) {
446 string lang = _film->subtitle_language ();
450 if (_film->interop ()) {
451 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
452 s->set_movie_title (_film->name ());
453 s->set_language (lang);
454 s->set_reel_number ("1");
457 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
458 s->set_content_title_text (_film->name ());
459 s->set_language (lang);
460 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
461 s->set_reel_number (1);
462 s->set_time_code_rate (_film->video_frame_rate ());
463 s->set_start_time (dcp::Time ());
468 BOOST_FOREACH (dcp::SubtitleString i, subs.text) {
469 i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr));
470 i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr));
471 _subtitle_asset->add (i);
476 ReelWriter::existing_picture_frame_ok (FILE* asset_file, FILE* info_file) const
478 LOG_GENERAL ("Checking existing picture frame %1", _first_nonexistant_frame);
480 /* Read the data from the info file; for 3D we just check the left
481 frames until we find a good one.
483 dcp::FrameInfo const info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
487 /* Read the data from the asset and hash it */
488 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
489 Data data (info.size);
490 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
491 LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size);
492 if (read != static_cast<size_t> (data.size ())) {
493 LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
496 MD5Digester digester;
497 digester.add (data.data().get(), data.size());
498 LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash);
499 if (digester.get() != info.hash) {
500 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);