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"
33 #include "encoded_data.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>
52 #include <boost/foreach.hpp>
58 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
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);
63 #define LOG_DEBUG(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_DEBUG);
64 #define LOG_DEBUG_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_DEBUG);
66 /* OS X strikes again */
74 using boost::shared_ptr;
75 using boost::weak_ptr;
76 using boost::dynamic_pointer_cast;
78 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
81 , _first_nonexistant_frame (0)
84 , _queued_full_in_memory (0)
85 , _last_written_frame (-1)
86 , _last_written_eyes (EYES_RIGHT)
87 , _maximum_frames_in_memory (0)
92 /* Remove any old DCP */
93 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
95 shared_ptr<Job> job = _job.lock ();
96 DCPOMATIC_ASSERT (job);
98 /* Create our picture asset in a subdirectory, named according to those
99 film's parameters which affect the video output. We will hard-link
100 it into the DCP later.
103 if (_film->three_d ()) {
104 _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
106 _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate (), 1)));
109 _picture_asset->set_size (_film->frame_size ());
111 if (_film->encrypted ()) {
112 _picture_asset->set_key (_film->key ());
115 _picture_asset->set_file (
116 _film->internal_video_asset_dir() / _film->internal_video_asset_filename()
119 job->sub (_("Checking existing image data"));
120 check_existing_picture_asset ();
122 _picture_asset_writer = _picture_asset->start_write (
123 _film->internal_video_asset_dir() / _film->internal_video_asset_filename(),
124 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
125 _first_nonexistant_frame > 0
128 if (_film->audio_channels ()) {
130 new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ())
133 if (_film->encrypted ()) {
134 _sound_asset->set_key (_film->key ());
137 /* Write the sound asset into the film directory so that we leave the creation
138 of the DCP directory until the last minute.
140 _sound_asset_writer = _sound_asset->start_write (
141 _film->directory() / audio_asset_filename (_sound_asset),
142 _film->interop() ? dcp::INTEROP : dcp::SMPTE
146 /* Check that the signer is OK if we need one */
147 if (_film->is_signed() && !Config::instance()->signer()->valid ()) {
148 throw InvalidSignerError ();
151 _thread = new boost::thread (boost::bind (&Writer::thread, this));
153 job->sub (_("Encoding image data"));
158 terminate_thread (false);
162 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
164 boost::mutex::scoped_lock lock (_mutex);
166 while (_queued_full_in_memory > _maximum_frames_in_memory) {
167 /* The queue is too big; wait until that is sorted out */
168 _full_condition.wait (lock);
172 qi.type = QueueItem::FULL;
173 qi.encoded = encoded;
176 if (_film->three_d() && eyes == EYES_BOTH) {
177 /* 2D material in a 3D DCP; fake the 3D */
179 _queue.push_back (qi);
180 ++_queued_full_in_memory;
181 qi.eyes = EYES_RIGHT;
182 _queue.push_back (qi);
183 ++_queued_full_in_memory;
186 _queue.push_back (qi);
187 ++_queued_full_in_memory;
190 /* Now there's something to do: wake anything wait()ing on _empty_condition */
191 _empty_condition.notify_all ();
195 Writer::fake_write (int frame, Eyes eyes)
197 boost::mutex::scoped_lock lock (_mutex);
199 while (_queued_full_in_memory > _maximum_frames_in_memory) {
200 /* The queue is too big; wait until that is sorted out */
201 _full_condition.wait (lock);
204 FILE* file = fopen_boost (_film->info_file (), "rb");
206 throw ReadFileError (_film->info_file ());
208 dcp::FrameInfo info = read_frame_info (file, frame, eyes);
212 qi.type = QueueItem::FAKE;
215 if (_film->three_d() && eyes == EYES_BOTH) {
217 _queue.push_back (qi);
218 qi.eyes = EYES_RIGHT;
219 _queue.push_back (qi);
222 _queue.push_back (qi);
225 /* Now there's something to do: wake anything wait()ing on _empty_condition */
226 _empty_condition.notify_all ();
229 /** This method is not thread safe */
231 Writer::write (shared_ptr<const AudioBuffers> audio)
233 if (_sound_asset_writer) {
234 _sound_asset_writer->write (audio->data(), audio->frames());
238 /** This must be called from Writer::thread() with an appropriate lock held */
240 Writer::have_sequenced_image_at_queue_head ()
242 if (_queue.empty ()) {
248 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
250 if (_queue.front().eyes == EYES_BOTH) {
252 return _queue.front().frame == (_last_written_frame + 1);
257 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
261 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
274 boost::mutex::scoped_lock lock (_mutex);
276 /* This is for debugging only */
277 bool done_something = false;
281 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
282 /* We've got something to do: go and do it */
286 /* Nothing to do: wait until something happens which may indicate that we do */
287 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
288 _empty_condition.wait (lock);
289 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
292 if (_finish && _queue.empty()) {
296 /* We stop here if we have been asked to finish, and if either the queue
297 is empty or we do not have a sequenced image at its head (if this is the
298 case we will never terminate as no new frames will be sent once
301 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
302 done_something = true;
303 /* (Hopefully temporarily) log anything that was not written */
304 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
305 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
306 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
307 if (i->type == QueueItem::FULL) {
308 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
310 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
313 LOG_WARNING (N_("Last written frame %1, last written eyes %2"), _last_written_frame, _last_written_eyes);
317 /* Write any frames that we can write; i.e. those that are in sequence. */
318 while (have_sequenced_image_at_queue_head ()) {
319 done_something = true;
320 QueueItem qi = _queue.front ();
322 if (qi.type == QueueItem::FULL && qi.encoded) {
323 --_queued_full_in_memory;
328 case QueueItem::FULL:
330 LOG_GENERAL (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
332 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
335 dcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
336 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
337 _last_written[qi.eyes] = qi.encoded;
341 case QueueItem::FAKE:
342 LOG_GENERAL (N_("Writer FAKE-writes %1"), qi.frame);
343 _picture_asset_writer->fake_write (qi.size);
344 _last_written[qi.eyes].reset ();
350 _last_written_frame = qi.frame;
351 _last_written_eyes = qi.eyes;
353 shared_ptr<Job> job = _job.lock ();
354 DCPOMATIC_ASSERT (job);
355 int64_t total = _film->length().frames (_film->video_frame_rate ());
356 if (_film->three_d ()) {
357 /* _full_written and so on are incremented for each eye, so we need to double the total
358 frames to get the correct progress.
363 job->set_progress (float (_full_written + _fake_written) / total);
367 while (_queued_full_in_memory > _maximum_frames_in_memory) {
368 done_something = true;
369 /* Too many frames in memory which can't yet be written to the stream.
370 Write some FULL frames to disk.
373 /* Find one from the back of the queue */
375 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
376 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
380 DCPOMATIC_ASSERT (i != _queue.rend());
384 /* i is valid here, even though we don't hold a lock on the mutex,
385 since list iterators are unaffected by insertion and only this
386 thread could erase the last item in the list.
390 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
391 _last_written_frame + 1,
392 _last_written_eyes, i->frame
395 i->encoded->write (_film, i->frame, i->eyes);
399 --_queued_full_in_memory;
402 if (!done_something) {
403 LOG_DEBUG_NC ("Writer loop ran without doing anything");
404 LOG_DEBUG ("_queued_full_in_memory=%1", _queued_full_in_memory);
405 LOG_DEBUG ("_queue_size=%1", _queue.size ());
406 LOG_DEBUG ("_finish=%1", _finish);
407 LOG_DEBUG ("_last_written_frame=%1", _last_written_frame);
410 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
411 _full_condition.notify_all ();
420 Writer::terminate_thread (bool can_throw)
422 boost::mutex::scoped_lock lock (_mutex);
428 _empty_condition.notify_all ();
429 _full_condition.notify_all ();
448 terminate_thread (true);
450 _picture_asset_writer->finalize ();
451 if (_sound_asset_writer) {
452 _sound_asset_writer->finalize ();
455 /* Hard-link the video asset into the DCP */
456 boost::filesystem::path video_from = _picture_asset->file ();
458 boost::filesystem::path video_to;
459 video_to /= _film->dir (_film->dcp_name());
460 video_to /= video_asset_filename (_picture_asset);
462 boost::system::error_code ec;
463 boost::filesystem::create_hard_link (video_from, video_to, ec);
465 LOG_WARNING_NC ("Hard-link failed; copying instead");
466 boost::filesystem::copy_file (video_from, video_to, ec);
468 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
469 throw FileError (ec.message(), video_from);
473 _picture_asset->set_file (video_to);
475 /* Move the audio asset into the DCP */
478 boost::filesystem::path audio_to;
479 audio_to /= _film->dir (_film->dcp_name ());
480 audio_to /= audio_asset_filename (_sound_asset);
482 boost::filesystem::rename (_film->file (audio_asset_filename (_sound_asset)), audio_to, ec);
485 String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), audio_asset_filename (_sound_asset)
489 _sound_asset->set_file (audio_to);
492 dcp::DCP dcp (_film->dir (_film->dcp_name()));
494 shared_ptr<dcp::CPL> cpl (
497 _film->dcp_content_type()->libdcp_kind ()
503 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
505 shared_ptr<dcp::MonoPictureAsset> mono = dynamic_pointer_cast<dcp::MonoPictureAsset> (_picture_asset);
507 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
510 shared_ptr<dcp::StereoPictureAsset> stereo = dynamic_pointer_cast<dcp::StereoPictureAsset> (_picture_asset);
512 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
516 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_asset, 0)));
519 if (_subtitle_asset) {
520 boost::filesystem::path const liberation = shared_path () / "LiberationSans-Regular.ttf";
522 /* Add all the fonts to the subtitle content */
523 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
524 _subtitle_asset->add_font (i->id, i->file.get_value_or (liberation));
527 _subtitle_asset->write (
528 _film->dir (_film->dcp_name ()) / _subtitle_asset->id () / subtitle_content_filename (_subtitle_asset)
531 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
532 new dcp::ReelSubtitleAsset (
534 dcp::Fraction (_film->video_frame_rate(), 1),
535 _picture_asset->intrinsic_duration (),
543 shared_ptr<Job> job = _job.lock ();
544 DCPOMATIC_ASSERT (job);
546 job->sub (_("Computing image digest"));
547 _picture_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
550 job->sub (_("Computing audio digest"));
551 _sound_asset->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
554 dcp::XMLMetadata meta;
555 meta.issuer = Config::instance()->dcp_issuer ();
556 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
557 meta.set_issue_date_now ();
559 shared_ptr<const dcp::Signer> signer;
560 if (_film->is_signed ()) {
561 signer = Config::instance()->signer ();
562 /* We did check earlier, but check again here to be on the safe side */
563 if (!signer->valid ()) {
564 throw InvalidSignerError ();
568 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
571 N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk
576 Writer::check_existing_picture_asset_frame (FILE* asset, int f, Eyes eyes)
578 /* Read the frame info as written */
579 FILE* file = fopen_boost (_film->info_file (), "rb");
581 LOG_GENERAL ("Existing frame %1 has no info file", f);
585 dcp::FrameInfo info = read_frame_info (file, f, eyes);
587 if (info.size == 0) {
588 LOG_GENERAL ("Existing frame %1 has no info file", f);
592 /* Read the data from the asset and hash it */
593 dcpomatic_fseek (asset, info.offset, SEEK_SET);
594 EncodedData data (info.size);
595 size_t const read = fread (data.data(), 1, data.size(), asset);
596 if (read != static_cast<size_t> (data.size ())) {
597 LOG_GENERAL ("Existing frame %1 is incomplete", f);
601 MD5Digester digester;
602 digester.add (data.data(), data.size());
603 if (digester.get() != info.hash) {
604 LOG_GENERAL ("Existing frame %1 failed hash check", f);
612 Writer::check_existing_picture_asset ()
614 /* Try to open the existing asset */
615 FILE* asset = fopen_boost (_picture_asset->file(), "rb");
617 LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", _picture_asset->file().string(), errno);
623 shared_ptr<Job> job = _job.lock ();
624 DCPOMATIC_ASSERT (job);
626 job->set_progress_unknown ();
628 if (_film->three_d ()) {
629 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_LEFT)) {
632 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_RIGHT)) {
636 if (!check_existing_picture_asset_frame (asset, _first_nonexistant_frame, EYES_BOTH)) {
641 LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
642 ++_first_nonexistant_frame;
648 /** @param frame Frame index.
649 * @return true if we can fake-write this frame.
652 Writer::can_fake_write (int frame) const
654 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
655 parameters in the asset writer.
657 return (frame != 0 && frame < _first_nonexistant_frame);
661 Writer::write (PlayerSubtitles subs)
663 if (subs.text.empty ()) {
667 if (!_subtitle_asset) {
668 string lang = _film->subtitle_language ();
672 if (_film->interop ()) {
673 shared_ptr<dcp::InteropSubtitleAsset> s (new dcp::InteropSubtitleAsset ());
674 s->set_movie_title (_film->name ());
675 s->set_language (lang);
676 s->set_reel_number ("1");
679 shared_ptr<dcp::SMPTESubtitleAsset> s (new dcp::SMPTESubtitleAsset ());
680 s->set_content_title_text (_film->name ());
681 s->set_language (lang);
682 s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1));
683 s->set_time_code_rate (_film->video_frame_rate ());
688 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
689 _subtitle_asset->add (*i);
694 Writer::write (list<shared_ptr<Font> > fonts)
696 /* Just keep a list of fonts and we'll deal with them in ::finish */
697 copy (fonts.begin (), fonts.end (), back_inserter (_fonts));
701 operator< (QueueItem const & a, QueueItem const & b)
703 if (a.frame != b.frame) {
704 return a.frame < b.frame;
707 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
711 operator== (QueueItem const & a, QueueItem const & b)
713 return a.frame == b.frame && a.eyes == b.eyes;
717 Writer::set_encoder_threads (int threads)
719 _maximum_frames_in_memory = rint (threads * 1.1);