2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "compose.hpp"
25 #include "dcp_video.h"
26 #include "dcp_content_type.h"
27 #include "audio_mapping.h"
31 #include "audio_buffers.h"
32 #include "md5_digester.h"
37 #include <dcp/mono_picture_asset.h>
38 #include <dcp/stereo_picture_asset.h>
39 #include <dcp/sound_asset.h>
40 #include <dcp/sound_asset_writer.h>
42 #include <dcp/reel_mono_picture_asset.h>
43 #include <dcp/reel_stereo_picture_asset.h>
44 #include <dcp/reel_sound_asset.h>
45 #include <dcp/reel_subtitle_asset.h>
48 #include <dcp/certificate_chain.h>
49 #include <dcp/interop_subtitle_asset.h>
50 #include <dcp/smpte_subtitle_asset.h>
51 #include <boost/foreach.hpp>
57 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
58 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_GENERAL);
59 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_DEBUG_ENCODE);
60 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
61 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
62 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_WARNING);
63 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
65 /* OS X strikes again */
73 using boost::shared_ptr;
74 using boost::weak_ptr;
75 using boost::dynamic_pointer_cast;
77 int const Writer::_info_size = 48;
79 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
82 , _first_nonexistant_frame (0)
85 , _queued_full_in_memory (0)
86 , _last_written_frame (-1)
87 , _last_written_eyes (EYES_RIGHT)
88 , _maximum_frames_in_memory (0)
94 /* Remove any old DCP */
95 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
97 shared_ptr<Job> job = _job.lock ();
98 DCPOMATIC_ASSERT (job);
100 /* Create our picture asset in a subdirectory, named according to those
101 film's parameters which affect the video output. We will hard-link
102 it into the DCP later.
105 if (_film->three_d ()) {
106 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
108 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
111 _picture_asset->set_size (_film->frame_size ());
113 if (_film->encrypted ()) {
114 _picture_asset->set_key (_film->key ());
117 _picture_asset->set_file (
118 _film->internal_video_asset_dir() / _film->internal_video_asset_filename()
121 job->sub (_("Checking existing image data"));
122 check_existing_picture_asset ();
124 _picture_asset_writer = _picture_asset->start_write (
125 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(),
126 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
127 _first_nonexistant_frame > 0
130 if (_film->audio_channels ()) {
132 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
135 if (_film->encrypted ()) {
136 _sound_asset->set_key (_film->key ());
139 /* Write the sound asset into the film directory so that we leave the creation
140 of the DCP directory until the last minute.
142 _sound_asset_writer = _sound_asset->start_write (
143 _film->directory() / audio_asset_filename (_sound_asset),
144 _film->interop() ? dcp::INTEROP : dcp::SMPTE
148 /* Check that the signer is OK if we need one */
149 if (_film->is_signed() && !Config::instance()->signer_chain()->valid ()) {
150 throw InvalidSignerError ();
153 job->sub (_("Encoding image data"));
159 _thread = new boost::thread (boost::bind (&Writer::thread, this));
164 terminate_thread (false);
168 Writer::write (Data encoded, int frame, Eyes eyes)
170 boost::mutex::scoped_lock lock (_state_mutex);
172 while (_queued_full_in_memory > _maximum_frames_in_memory) {
173 /* The queue is too big; wait until that is sorted out */
174 _full_condition.wait (lock);
178 qi.type = QueueItem::FULL;
179 qi.encoded = encoded;
182 if (_film->three_d() && eyes == EYES_BOTH) {
183 /* 2D material in a 3D DCP; fake the 3D */
185 _queue.push_back (qi);
186 ++_queued_full_in_memory;
187 qi.eyes = EYES_RIGHT;
188 _queue.push_back (qi);
189 ++_queued_full_in_memory;
192 _queue.push_back (qi);
193 ++_queued_full_in_memory;
196 /* Now there's something to do: wake anything wait()ing on _empty_condition */
197 _empty_condition.notify_all ();
201 Writer::repeat (int frame, Eyes eyes)
203 boost::mutex::scoped_lock lock (_state_mutex);
205 while (_queued_full_in_memory > _maximum_frames_in_memory) {
206 /* The queue is too big; wait until that is sorted out */
207 _full_condition.wait (lock);
211 qi.type = QueueItem::REPEAT;
213 if (_film->three_d() && eyes == EYES_BOTH) {
215 _queue.push_back (qi);
216 qi.eyes = EYES_RIGHT;
217 _queue.push_back (qi);
220 _queue.push_back (qi);
223 /* Now there's something to do: wake anything wait()ing on _empty_condition */
224 _empty_condition.notify_all ();
228 Writer::fake_write (int frame, Eyes eyes)
230 boost::mutex::scoped_lock lock (_state_mutex);
232 while (_queued_full_in_memory > _maximum_frames_in_memory) {
233 /* The queue is too big; wait until that is sorted out */
234 _full_condition.wait (lock);
237 FILE* file = fopen_boost (_film->info_file (), "rb");
239 throw ReadFileError (_film->info_file ());
241 dcp::FrameInfo info = read_frame_info (file, frame, eyes);
245 qi.type = QueueItem::FAKE;
248 if (_film->three_d() && eyes == EYES_BOTH) {
250 _queue.push_back (qi);
251 qi.eyes = EYES_RIGHT;
252 _queue.push_back (qi);
255 _queue.push_back (qi);
258 /* Now there's something to do: wake anything wait()ing on _empty_condition */
259 _empty_condition.notify_all ();
262 /** This method is not thread safe */
264 Writer::write (shared_ptr<const AudioBuffers> audio)
266 if (_sound_asset_writer) {
267 _sound_asset_writer->write (audio->data(), audio->frames());
271 /** This must be called from Writer::thread() with an appropriate lock held */
273 Writer::have_sequenced_image_at_queue_head ()
275 if (_queue.empty ()) {
281 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
283 if (_queue.front().eyes == EYES_BOTH) {
285 return _queue.front().frame == (_last_written_frame + 1);
290 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
294 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
302 Writer::write_frame_info (int frame, Eyes eyes, dcp::FrameInfo info) const
305 if (boost::filesystem::exists (_film->info_file ())) {
306 file = fopen_boost (_film->info_file(), "r+b");
308 file = fopen_boost (_film->info_file(), "wb");
311 throw OpenFileError (_film->info_file ());
313 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
314 fwrite (&info.offset, sizeof (info.offset), 1, file);
315 fwrite (&info.size, sizeof (info.size), 1, file);
316 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
326 boost::mutex::scoped_lock lock (_state_mutex);
330 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
331 /* We've got something to do: go and do it */
335 /* Nothing to do: wait until something happens which may indicate that we do */
336 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
337 _empty_condition.wait (lock);
338 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
341 if (_finish && _queue.empty()) {
345 /* We stop here if we have been asked to finish, and if either the queue
346 is empty or we do not have a sequenced image at its head (if this is the
347 case we will never terminate as no new frames will be sent once
350 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
351 /* (Hopefully temporarily) log anything that was not written */
352 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
353 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
354 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
355 if (i->type == QueueItem::FULL) {
356 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
358 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
361 LOG_WARNING (N_("Last written frame %1, last written eyes %2"), _last_written_frame, _last_written_eyes);
365 /* Write any frames that we can write; i.e. those that are in sequence. */
366 while (have_sequenced_image_at_queue_head ()) {
367 QueueItem qi = _queue.front ();
369 if (qi.type == QueueItem::FULL && qi.encoded) {
370 --_queued_full_in_memory;
375 case QueueItem::FULL:
377 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
379 qi.encoded = Data (_film->j2c_path (qi.frame, qi.eyes, false));
382 dcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data().get (), qi.encoded->size());
383 write_frame_info (qi.frame, qi.eyes, fin);
384 _last_written[qi.eyes] = qi.encoded;
388 case QueueItem::FAKE:
389 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
390 _picture_asset_writer->fake_write (qi.size);
391 _last_written[qi.eyes].reset ();
394 case QueueItem::REPEAT:
395 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
396 dcp::FrameInfo fin = _picture_asset_writer->write (
397 _last_written[qi.eyes]->data().get(),
398 _last_written[qi.eyes]->size()
400 write_frame_info (qi.frame, qi.eyes, fin);
406 _last_written_frame = qi.frame;
407 _last_written_eyes = qi.eyes;
409 shared_ptr<Job> job = _job.lock ();
410 DCPOMATIC_ASSERT (job);
411 int64_t total = _film->length().frames_round (_film->video_frame_rate ());
412 if (_film->three_d ()) {
413 /* _full_written and so on are incremented for each eye, so we need to double the total
414 frames to get the correct progress.
419 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
423 while (_queued_full_in_memory > _maximum_frames_in_memory) {
424 /* Too many frames in memory which can't yet be written to the stream.
425 Write some FULL frames to disk.
428 /* Find one from the back of the queue */
430 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
431 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
435 DCPOMATIC_ASSERT (i != _queue.rend());
439 /* i is valid here, even though we don't hold a lock on the mutex,
440 since list iterators are unaffected by insertion and only this
441 thread could erase the last item in the list.
445 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
446 _last_written_frame + 1,
447 _last_written_eyes, i->frame
450 i->encoded->write_via_temp (_film->j2c_path (i->frame, i->eyes, true), _film->j2c_path (i->frame, i->eyes, false));
454 --_queued_full_in_memory;
457 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
458 _full_condition.notify_all ();
467 Writer::terminate_thread (bool can_throw)
469 boost::mutex::scoped_lock lock (_state_mutex);
475 _empty_condition.notify_all ();
476 _full_condition.notify_all ();
495 terminate_thread (true);
497 _picture_asset_writer->finalize ();
498 if (_sound_asset_writer) {
499 _sound_asset_writer->finalize ();
502 /* Hard-link the video asset into the DCP */
503 boost::filesystem::path video_from = _picture_asset->file ();
505 boost::filesystem::path video_to;
506 video_to /= _film->dir (_film->dcp_name());
507 video_to /= video_asset_filename (_picture_asset);
509 boost::system::error_code ec;
510 boost::filesystem::create_hard_link (video_from, video_to, ec);
512 LOG_WARNING_NC ("Hard-link failed; copying instead");
513 boost::filesystem::copy_file (video_from, video_to, ec);
515 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
516 throw FileError (ec.message(), video_from);
520 _picture_asset->set_file (video_to);
522 /* Move the audio asset into the DCP */
525 boost::filesystem::path audio_to;
526 audio_to /= _film->dir (_film->dcp_name ());
527 audio_to /= audio_asset_filename (_sound_asset);
529 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
532 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
536 _sound_asset->set_file (audio_to);
539 dcp::DCP dcp (_film->dir (_film->dcp_name()));
541 shared_ptr<dcp::CPL> cpl (
544 _film->dcp_content_type()->libdcp_kind ()
550 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
552 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
554 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
557 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
559 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
563 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
566 if (_subtitle_asset) {
567 boost::filesystem::path liberation;
569 liberation = shared_path () / "LiberationSans-Regular.ttf";
570 } catch (boost::filesystem::filesystem_error& e) {
571 /* Hack: try the debian/ubuntu location if getting the shared path failed */
572 liberation = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf";
575 /* Add all the fonts to the subtitle content */
576 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
577 _subtitle_asset->add_font (i->id(), i->file().get_value_or (liberation));
580 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
581 boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
582 boost::filesystem::create_directories (directory);
583 _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
585 _subtitle_asset->write (
586 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
590 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
591 new dcp::ReelSubtitleAsset (
593 dcp::Fraction (_film->video_frame_rate(), 1),
594 _picture_asset->intrinsic_duration (),
602 shared_ptr<Job> job = _job.lock ();
603 DCPOMATIC_ASSERT (job);
605 job->sub (_("Computing image digest"));
606 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
609 job->sub (_("Computing audio digest"));
610 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
613 dcp::XMLMetadata meta;
614 meta.creator = Config::instance()->dcp_creator ();
615 if (meta.creator.empty ()) {
616 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
618 meta.issuer = Config::instance()->dcp_issuer ();
619 if (meta.issuer.empty ()) {
620 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
622 meta.set_issue_date_now ();
624 cpl->set_metadata (meta);
626 shared_ptr<const dcp::CertificateChain> signer;
627 if (_film->is_signed ()) {
628 signer = Config::instance()->signer_chain ();
629 /* We did check earlier, but check again here to be on the safe side */
630 if (!signer->valid ()) {
631 throw InvalidSignerError ();
635 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
638 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
643 Writer::check_existing_picture_asset ()
645 /* Try to open the existing asset */
646 FILE* asset_file = fopen_boost (_picture_asset->file(), "rb");
648 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file().string(), errno);
652 /* Offset of the last dcp::FrameInfo in the info file */
653 int const n = (boost::filesystem::file_size (_film->info_file ()) / _info_size) - 1;
655 FILE* info_file = fopen_boost (_film->info_file (), "rb");
657 LOG_GENERAL_NC ("Could not open film info file");
662 if (_film->three_d ()) {
663 /* Start looking at the last left frame */
664 _first_nonexistant_frame = n / 2;
666 _first_nonexistant_frame = n;
672 /* Read the data from the info file; for 3D we just check the left
673 frames until we find a good one.
675 dcp::FrameInfo info = read_frame_info (info_file, _first_nonexistant_frame, _film->three_d () ? EYES_LEFT : EYES_BOTH);
679 /* Read the data from the asset and hash it */
680 dcpomatic_fseek (asset_file, info.offset, SEEK_SET);
681 Data data (info.size);
682 size_t const read = fread (data.data().get(), 1, data.size(), asset_file);
683 if (read != static_cast<size_t> (data.size ())) {
684 LOG_GENERAL ("Existing frame %1 is incomplete", _first_nonexistant_frame);
687 MD5Digester digester;
688 digester.add (data.data().get(), data.size());
689 if (digester.get() != info.hash) {
690 LOG_GENERAL ("Existing frame %1 failed hash check", _first_nonexistant_frame);
696 --_first_nonexistant_frame;
700 if (!_film->three_d ()) {
701 /* If we are doing 3D we might have found a good L frame with no R, so only
702 do this if we're in 2D and we've just found a good B(oth) frame.
704 ++_first_nonexistant_frame;
711 /** @param frame Frame index.
712 * @return true if we can fake-write this frame.
715 Writer::can_fake_write (int frame) const
717 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
718 parameters in the asset writer.
720 return (frame != 0 && frame < _first_nonexistant_frame);
724 Writer::write (PlayerSubtitles subs)
726 if (subs.text.empty ()) {
730 if (!_subtitle_asset) {
731 string lang = _film->subtitle_language ();
735 if (_film->interop ()) {
736 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
737 s->set_movie_title (_film->name ());
738 s->set_language (lang);
739 s->set_reel_number ("1");
742 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
743 s->set_content_title_text (_film->name ());
744 s->set_language (lang);
745 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
746 s->set_reel_number (1);
747 s->set_time_code_rate (_film->video_frame_rate ());
748 s->set_start_time (dcp::Time ());
753 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
754 _subtitle_asset->add (*i);
759 Writer::write (list<shared_ptr<Font> > fonts)
761 /* Just keep a list of fonts and we'll deal with them in ::finish */
762 copy (fonts.begin (), fonts.end (), back_inserter (_fonts));
766 operator< (QueueItem const & a, QueueItem const & b)
768 if (a.frame != b.frame) {
769 return a.frame < b.frame;
772 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
776 operator== (QueueItem const & a, QueueItem const & b)
778 return a.frame == b.frame && a.eyes == b.eyes;
782 Writer::set_encoder_threads (int threads)
784 _maximum_frames_in_memory = lrint (threads * 1.1);
788 Writer::frame_info_position (int frame, Eyes eyes) const
792 return frame * _info_size;
794 return frame * _info_size * 2;
796 return frame * _info_size * 2 + _info_size;
798 DCPOMATIC_ASSERT (false);
801 DCPOMATIC_ASSERT (false);
805 Writer::read_frame_info (FILE* file, int frame, Eyes eyes) const
808 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
809 fread (&info.offset, sizeof (info.offset), 1, file);
810 fread (&info.size, sizeof (info.size), 1, file);
812 char hash_buffer[33];
813 fread (hash_buffer, 1, 32, file);
814 hash_buffer[32] = '\0';
815 info.hash = hash_buffer;