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/signer.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_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_DEBUG_ENCODE);
59 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
60 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
61 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_WARNING);
62 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
64 /* OS X strikes again */
72 using boost::shared_ptr;
73 using boost::weak_ptr;
74 using boost::dynamic_pointer_cast;
76 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
79 , _first_nonexistant_frame (0)
82 , _queued_full_in_memory (0)
83 , _last_written_frame (-1)
84 , _last_written_eyes (EYES_RIGHT)
85 , _maximum_frames_in_memory (0)
91 /* Remove any old DCP */
92 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
94 shared_ptr<Job> job = _job.lock ();
95 DCPOMATIC_ASSERT (job);
97 /* Create our picture asset in a subdirectory, named according to those
98 film's parameters which affect the video output. We will hard-link
99 it into the DCP later.
102 if (_film->three_d ()) {
103 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
105 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
108 _picture_asset->set_size (_film->frame_size ());
110 if (_film->encrypted ()) {
111 _picture_asset->set_key (_film->key ());
114 _picture_asset->set_file (
115 _film->internal_video_asset_dir() / _film->internal_video_asset_filename()
118 job->sub (_("Checking existing image data"));
119 check_existing_picture_asset ();
121 _picture_asset_writer = _picture_asset->start_write (
122 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(),
123 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
124 _first_nonexistant_frame > 0
127 if (_film->audio_channels ()) {
129 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
132 if (_film->encrypted ()) {
133 _sound_asset->set_key (_film->key ());
136 /* Write the sound asset into the film directory so that we leave the creation
137 of the DCP directory until the last minute.
139 _sound_asset_writer = _sound_asset->start_write (
140 _film->directory() / audio_asset_filename (_sound_asset),
141 _film->interop() ? dcp::INTEROP : dcp::SMPTE
145 /* Check that the signer is OK if we need one */
146 if (_film->is_signed() && !Config::instance()->signer()->valid ()) {
147 throw InvalidSignerError ();
150 _thread = new boost::thread (boost::bind (&Writer::thread, this));
152 job->sub (_("Encoding image data"));
157 terminate_thread (false);
161 Writer::write (Data encoded, int frame, Eyes eyes)
163 boost::mutex::scoped_lock lock (_mutex);
165 while (_queued_full_in_memory > _maximum_frames_in_memory) {
166 /* The queue is too big; wait until that is sorted out */
167 _full_condition.wait (lock);
171 qi.type = QueueItem::FULL;
172 qi.encoded = encoded;
175 if (_film->three_d() && eyes == EYES_BOTH) {
176 /* 2D material in a 3D DCP; fake the 3D */
178 _queue.push_back (qi);
179 ++_queued_full_in_memory;
180 qi.eyes = EYES_RIGHT;
181 _queue.push_back (qi);
182 ++_queued_full_in_memory;
185 _queue.push_back (qi);
186 ++_queued_full_in_memory;
189 /* Now there's something to do: wake anything wait()ing on _empty_condition */
190 _empty_condition.notify_all ();
194 Writer::repeat (int frame, Eyes eyes)
196 boost::mutex::scoped_lock lock (_mutex);
198 while (_queued_full_in_memory > _maximum_frames_in_memory) {
199 /* The queue is too big; wait until that is sorted out */
200 _full_condition.wait (lock);
204 qi.type = QueueItem::REPEAT;
206 if (_film->three_d() && eyes == EYES_BOTH) {
208 _queue.push_back (qi);
209 qi.eyes = EYES_RIGHT;
210 _queue.push_back (qi);
213 _queue.push_back (qi);
216 /* Now there's something to do: wake anything wait()ing on _empty_condition */
217 _empty_condition.notify_all ();
221 Writer::fake_write (int frame, Eyes eyes)
223 boost::mutex::scoped_lock lock (_mutex);
225 while (_queued_full_in_memory > _maximum_frames_in_memory) {
226 /* The queue is too big; wait until that is sorted out */
227 _full_condition.wait (lock);
230 FILE* file = fopen_boost (_film->info_file (), "rb");
232 throw ReadFileError (_film->info_file ());
234 dcp::FrameInfo info = read_frame_info (file, frame, eyes);
238 qi.type = QueueItem::FAKE;
241 if (_film->three_d() && eyes == EYES_BOTH) {
243 _queue.push_back (qi);
244 qi.eyes = EYES_RIGHT;
245 _queue.push_back (qi);
248 _queue.push_back (qi);
251 /* Now there's something to do: wake anything wait()ing on _empty_condition */
252 _empty_condition.notify_all ();
255 /** This method is not thread safe */
257 Writer::write (shared_ptr<const AudioBuffers> audio)
259 if (_sound_asset_writer) {
260 _sound_asset_writer->write (audio->data(), audio->frames());
264 /** This must be called from Writer::thread() with an appropriate lock held */
266 Writer::have_sequenced_image_at_queue_head ()
268 if (_queue.empty ()) {
274 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
276 if (_queue.front().eyes == EYES_BOTH) {
278 return _queue.front().frame == (_last_written_frame + 1);
283 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
287 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
295 Writer::write_frame_info (int frame, Eyes eyes, dcp::FrameInfo info) const
297 FILE* file = fopen_boost (_film->info_file(), "ab");
299 throw OpenFileError (_film->info_file ());
301 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
302 fwrite (&info.offset, sizeof (info.offset), 1, file);
303 fwrite (&info.size, sizeof (info.size), 1, file);
304 fwrite (info.hash.c_str(), 1, info.hash.size(), file);
314 boost::mutex::scoped_lock lock (_mutex);
318 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
319 /* We've got something to do: go and do it */
323 /* Nothing to do: wait until something happens which may indicate that we do */
324 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
325 _empty_condition.wait (lock);
326 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
329 if (_finish && _queue.empty()) {
333 /* We stop here if we have been asked to finish, and if either the queue
334 is empty or we do not have a sequenced image at its head (if this is the
335 case we will never terminate as no new frames will be sent once
338 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
339 /* (Hopefully temporarily) log anything that was not written */
340 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
341 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
342 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
343 if (i->type == QueueItem::FULL) {
344 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
346 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
349 LOG_WARNING (N_("Last written frame %1, last written eyes %2"), _last_written_frame, _last_written_eyes);
353 /* Write any frames that we can write; i.e. those that are in sequence. */
354 while (have_sequenced_image_at_queue_head ()) {
355 QueueItem qi = _queue.front ();
357 if (qi.type == QueueItem::FULL && qi.encoded) {
358 --_queued_full_in_memory;
363 case QueueItem::FULL:
365 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
367 qi.encoded = Data (_film->j2c_path (qi.frame, qi.eyes, false));
370 dcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data().get (), qi.encoded->size());
371 write_frame_info (qi.frame, qi.eyes, fin);
372 _last_written[qi.eyes] = qi.encoded;
376 case QueueItem::FAKE:
377 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
378 _picture_asset_writer->fake_write (qi.size);
379 _last_written[qi.eyes].reset ();
382 case QueueItem::REPEAT:
383 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
384 dcp::FrameInfo fin = _picture_asset_writer->write (
385 _last_written[qi.eyes]->data().get(),
386 _last_written[qi.eyes]->size()
388 write_frame_info (qi.frame, qi.eyes, fin);
394 _last_written_frame = qi.frame;
395 _last_written_eyes = qi.eyes;
397 shared_ptr<Job> job = _job.lock ();
398 DCPOMATIC_ASSERT (job);
399 int64_t total = _film->length().frames (_film->video_frame_rate ());
400 if (_film->three_d ()) {
401 /* _full_written and so on are incremented for each eye, so we need to double the total
402 frames to get the correct progress.
407 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
411 while (_queued_full_in_memory > _maximum_frames_in_memory) {
412 /* Too many frames in memory which can't yet be written to the stream.
413 Write some FULL frames to disk.
416 /* Find one from the back of the queue */
418 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
419 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
423 DCPOMATIC_ASSERT (i != _queue.rend());
427 /* i is valid here, even though we don't hold a lock on the mutex,
428 since list iterators are unaffected by insertion and only this
429 thread could erase the last item in the list.
433 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
434 _last_written_frame + 1,
435 _last_written_eyes, i->frame
438 i->encoded->write_via_temp (_film->j2c_path (i->frame, i->eyes, true), _film->j2c_path (i->frame, i->eyes, false));
442 --_queued_full_in_memory;
445 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
446 _full_condition.notify_all ();
455 Writer::terminate_thread (bool can_throw)
457 boost::mutex::scoped_lock lock (_mutex);
463 _empty_condition.notify_all ();
464 _full_condition.notify_all ();
483 terminate_thread (true);
485 _picture_asset_writer->finalize ();
486 if (_sound_asset_writer) {
487 _sound_asset_writer->finalize ();
490 /* Hard-link the video asset into the DCP */
491 boost::filesystem::path video_from = _picture_asset->file ();
493 boost::filesystem::path video_to;
494 video_to /= _film->dir (_film->dcp_name());
495 video_to /= video_asset_filename (_picture_asset);
497 boost::system::error_code ec;
498 boost::filesystem::create_hard_link (video_from, video_to, ec);
500 LOG_WARNING_NC ("Hard-link failed; copying instead");
501 boost::filesystem::copy_file (video_from, video_to, ec);
503 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
504 throw FileError (ec.message(), video_from);
508 _picture_asset->set_file (video_to);
510 /* Move the audio asset into the DCP */
513 boost::filesystem::path audio_to;
514 audio_to /= _film->dir (_film->dcp_name ());
515 audio_to /= audio_asset_filename (_sound_asset);
517 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
520 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
524 _sound_asset->set_file (audio_to);
527 dcp::DCP dcp (_film->dir (_film->dcp_name()));
529 shared_ptr<dcp::CPL> cpl (
532 _film->dcp_content_type()->libdcp_kind ()
538 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
540 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
542 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
545 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
547 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
551 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
554 if (_subtitle_asset) {
555 boost::filesystem::path const liberation = shared_path () / "LiberationSans-Regular.ttf";
557 /* Add all the fonts to the subtitle content */
558 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
559 _subtitle_asset->add_font (i->id(), i->file().get_value_or (liberation));
562 if (dynamic_pointer_cast<dcp::InteropSubtitleAsset> (_subtitle_asset)) {
563 boost::filesystem::path directory = _film->dir (_film->dcp_name ()) / _subtitle_asset->id ();
564 boost::filesystem::create_directories (directory);
565 _subtitle_asset->write (directory / ("sub_" + _subtitle_asset->id() + ".xml"));
567 _subtitle_asset->write (
568 _film->dir (_film->dcp_name ()) / ("sub_" + _subtitle_asset->id() + ".mxf")
572 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
573 new dcp::ReelSubtitleAsset (
575 dcp::Fraction (_film->video_frame_rate(), 1),
576 _picture_asset->intrinsic_duration (),
584 shared_ptr<Job> job = _job.lock ();
585 DCPOMATIC_ASSERT (job);
587 job->sub (_("Computing image digest"));
588 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
591 job->sub (_("Computing audio digest"));
592 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
595 dcp::XMLMetadata meta;
596 meta.issuer = Config::instance()->dcp_issuer ();
597 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
598 meta.set_issue_date_now ();
600 shared_ptr<const dcp::Signer> signer;
601 if (_film->is_signed ()) {
602 signer = Config::instance()->signer ();
603 /* We did check earlier, but check again here to be on the safe side */
604 if (!signer->valid ()) {
605 throw InvalidSignerError ();
609 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
612 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
617 Writer::check_existing_picture_asset_frame (FILE* asset, int f, Eyes eyes)
619 /* Read the frame info as written */
620 FILE* file = fopen_boost (_film->info_file (), "rb");
622 LOG_GENERAL ("Existing frame %1 has no info file", f);
626 dcp::FrameInfo info = read_frame_info (file, f, eyes);
628 if (info.size == 0) {
629 LOG_GENERAL ("Existing frame %1 has no info file", f);
633 /* Read the data from the asset and hash it */
634 dcpomatic_fseek (asset, info.offset, SEEK_SET);
635 Data data (info.size);
636 size_t const read = fread (data.data().get(), 1, data.size(), asset);
637 if (read != static_cast<size_t> (data.size ())) {
638 LOG_GENERAL ("Existing frame %1 is incomplete", f);
642 MD5Digester digester;
643 digester.add (data.data().get(), data.size());
644 if (digester.get() != info.hash) {
645 LOG_GENERAL ("Existing frame %1 failed hash check", f);
653 Writer::check_existing_picture_asset ()
655 /* Try to open the existing asset */
656 FILE* asset = fopen_boost (_picture_asset->file(), "rb");
658 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file().string(), errno);
664 shared_ptr<Job> job = _job.lock ();
665 DCPOMATIC_ASSERT (job);
667 job->set_progress_unknown ();
669 if (_film->three_d ()) {
670 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_LEFT)) {
673 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_RIGHT)) {
677 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_BOTH)) {
682 LOG_DEBUG_ENCODE ("Have existing frame %1", _first_nonexistant_frame);
683 ++_first_nonexistant_frame;
689 /** @param frame Frame index.
690 * @return true if we can fake-write this frame.
693 Writer::can_fake_write (int frame) const
695 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
696 parameters in the asset writer.
698 return (frame != 0 && frame < _first_nonexistant_frame);
702 Writer::write (PlayerSubtitles subs)
704 if (subs.text.empty ()) {
708 if (!_subtitle_asset) {
709 string lang = _film->subtitle_language ();
713 if (_film->interop ()) {
714 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
715 s->set_movie_title (_film->name ());
716 s->set_language (lang);
717 s->set_reel_number ("1");
720 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
721 s->set_content_title_text (_film->name ());
722 s->set_language (lang);
723 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
724 s->set_time_code_rate (_film->video_frame_rate ());
729 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
730 _subtitle_asset->add (*i);
735 Writer::write (list<shared_ptr<Font> > fonts)
737 /* Just keep a list of fonts and we'll deal with them in ::finish */
738 copy (fonts.begin (), fonts.end (), back_inserter (_fonts));
742 operator< (QueueItem const & a, QueueItem const & b)
744 if (a.frame != b.frame) {
745 return a.frame < b.frame;
748 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
752 operator== (QueueItem const & a, QueueItem const & b)
754 return a.frame == b.frame && a.eyes == b.eyes;
758 Writer::set_encoder_threads (int threads)
760 _maximum_frames_in_memory = rint (threads * 1.1);
764 Writer::frame_info_position (int frame, Eyes eyes) const
766 static int const info_size = 48;
770 return frame * info_size;
772 return frame * info_size * 2;
774 return frame * info_size * 2 + info_size;
776 DCPOMATIC_ASSERT (false);
780 DCPOMATIC_ASSERT (false);
784 Writer::read_frame_info (FILE* file, int frame, Eyes eyes) const
787 dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
788 fread (&info.offset, sizeof (info.offset), 1, file);
789 fread (&info.size, sizeof (info.size), 1, file);
791 char hash_buffer[33];
792 fread (hash_buffer, 1, 32, file);
793 hash_buffer[32] = '\0';
794 info.hash = hash_buffer;