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_mxf.h>
38 #include <dcp/stereo_picture_mxf.h>
39 #include <dcp/sound_mxf.h>
40 #include <dcp/sound_mxf_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_content.h>
51 #include <boost/foreach.hpp>
57 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
58 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
59 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
60 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_WARNING);
61 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
62 #define LOG_DEBUG(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_DEBUG);
63 #define LOG_DEBUG_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_DEBUG);
65 /* OS X strikes again */
73 using boost::shared_ptr;
74 using boost::weak_ptr;
75 using boost::dynamic_pointer_cast;
77 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
80 , _first_nonexistant_frame (0)
83 , _queued_full_in_memory (0)
84 , _last_written_frame (-1)
85 , _last_written_eyes (EYES_RIGHT)
90 /* Remove any old DCP */
91 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
93 shared_ptr<Job> job = _job.lock ();
94 DCPOMATIC_ASSERT (job);
96 /* Create our picture asset in a subdirectory, named according to those
97 film's parameters which affect the video output. We will hard-link
98 it into the DCP later.
101 if (_film->three_d ()) {
102 _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
104 _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
107 _picture_mxf->set_size (_film->frame_size ());
109 if (_film->encrypted ()) {
110 _picture_mxf->set_key (_film->key ());
113 _picture_mxf_writer = _picture_mxf->start_write (
114 _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
115 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
116 _first_nonexistant_frame > 0
119 if (_film->audio_channels ()) {
120 _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
122 if (_film->encrypted ()) {
123 _sound_mxf->set_key (_film->key ());
126 /* Write the sound MXF into the film directory so that we leave the creation
127 of the DCP directory until the last minute.
129 _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / audio_mxf_filename (_sound_mxf), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
132 /* Check that the signer is OK if we need one */
133 if (_film->is_signed() && !Config::instance()->signer()->valid ()) {
134 throw InvalidSignerError ();
137 job->sub (_("Checking existing image data"));
138 check_existing_picture_mxf ();
140 _thread = new boost::thread (boost::bind (&Writer::thread, this));
142 job->sub (_("Encoding image data"));
147 terminate_thread (false);
151 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
153 boost::mutex::scoped_lock lock (_mutex);
155 while (_queued_full_in_memory > maximum_frames_in_memory ()) {
156 /* The queue is too big; wait until that is sorted out */
157 _full_condition.wait (lock);
161 qi.type = QueueItem::FULL;
162 qi.encoded = encoded;
165 if (_film->three_d() && eyes == EYES_BOTH) {
166 /* 2D material in a 3D DCP; fake the 3D */
168 _queue.push_back (qi);
169 ++_queued_full_in_memory;
170 qi.eyes = EYES_RIGHT;
171 _queue.push_back (qi);
172 ++_queued_full_in_memory;
175 _queue.push_back (qi);
176 ++_queued_full_in_memory;
179 /* Now there's something to do: wake anything wait()ing on _empty_condition */
180 _empty_condition.notify_all ();
184 Writer::fake_write (int frame, Eyes eyes)
186 boost::mutex::scoped_lock lock (_mutex);
188 while (_queued_full_in_memory > maximum_frames_in_memory ()) {
189 /* The queue is too big; wait until that is sorted out */
190 _full_condition.wait (lock);
193 FILE* file = fopen_boost (_film->info_file (), "rb");
195 throw ReadFileError (_film->info_file ());
197 dcp::FrameInfo info = read_frame_info (file, frame, eyes);
201 qi.type = QueueItem::FAKE;
204 if (_film->three_d() && eyes == EYES_BOTH) {
206 _queue.push_back (qi);
207 qi.eyes = EYES_RIGHT;
208 _queue.push_back (qi);
211 _queue.push_back (qi);
214 /* Now there's something to do: wake anything wait()ing on _empty_condition */
215 _empty_condition.notify_all ();
218 /** This method is not thread safe */
220 Writer::write (shared_ptr<const AudioBuffers> audio)
222 if (_sound_mxf_writer) {
223 _sound_mxf_writer->write (audio->data(), audio->frames());
227 /** This must be called from Writer::thread() with an appropriate lock held */
229 Writer::have_sequenced_image_at_queue_head ()
231 if (_queue.empty ()) {
237 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
239 if (_queue.front().eyes == EYES_BOTH) {
241 return _queue.front().frame == (_last_written_frame + 1);
246 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
250 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
263 boost::mutex::scoped_lock lock (_mutex);
265 /* This is for debugging only */
266 bool done_something = false;
270 if (_finish || _queued_full_in_memory > maximum_frames_in_memory () || have_sequenced_image_at_queue_head ()) {
271 /* We've got something to do: go and do it */
275 /* Nothing to do: wait until something happens which may indicate that we do */
276 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
277 _empty_condition.wait (lock);
278 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
281 if (_finish && _queue.empty()) {
285 /* We stop here if we have been asked to finish, and if either the queue
286 is empty or we do not have a sequenced image at its head (if this is the
287 case we will never terminate as no new frames will be sent once
290 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
291 done_something = true;
292 /* (Hopefully temporarily) log anything that was not written */
293 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
294 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
295 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
296 if (i->type == QueueItem::FULL) {
297 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
299 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
302 LOG_WARNING (N_("Last written frame %1, last written eyes %2"), _last_written_frame, _last_written_eyes);
306 /* Write any frames that we can write; i.e. those that are in sequence. */
307 while (have_sequenced_image_at_queue_head ()) {
308 done_something = true;
309 QueueItem qi = _queue.front ();
311 if (qi.type == QueueItem::FULL && qi.encoded) {
312 --_queued_full_in_memory;
317 case QueueItem::FULL:
319 LOG_GENERAL (N_("Writer FULL-writes %1 to MXF"), qi.frame);
321 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
324 dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
325 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
326 _last_written[qi.eyes] = qi.encoded;
330 case QueueItem::FAKE:
331 LOG_GENERAL (N_("Writer FAKE-writes %1 to MXF"), qi.frame);
332 _picture_mxf_writer->fake_write (qi.size);
333 _last_written[qi.eyes].reset ();
339 _last_written_frame = qi.frame;
340 _last_written_eyes = qi.eyes;
342 shared_ptr<Job> job = _job.lock ();
343 DCPOMATIC_ASSERT (job);
344 int64_t total = _film->length().frames (_film->video_frame_rate ());
345 if (_film->three_d ()) {
346 /* _full_written and so on are incremented for each eye, so we need to double the total
347 frames to get the correct progress.
352 job->set_progress (float (_full_written + _fake_written) / total);
356 while (_queued_full_in_memory > maximum_frames_in_memory ()) {
357 done_something = true;
358 /* Too many frames in memory which can't yet be written to the stream.
359 Write some FULL frames to disk.
362 /* Find one from the back of the queue */
364 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
365 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
369 DCPOMATIC_ASSERT (i != _queue.rend());
373 /* i is valid here, even though we don't hold a lock on the mutex,
374 since list iterators are unaffected by insertion and only this
375 thread could erase the last item in the list.
379 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
380 _last_written_frame + 1,
381 _last_written_eyes, i->frame
384 i->encoded->write (_film, i->frame, i->eyes);
388 --_queued_full_in_memory;
391 if (!done_something) {
392 LOG_DEBUG_NC ("Writer loop ran without doing anything");
393 LOG_DEBUG ("_queued_full_in_memory=%1", _queued_full_in_memory);
394 LOG_DEBUG ("_queue_size=%1", _queue.size ());
395 LOG_DEBUG ("_finish=%1", _finish);
396 LOG_DEBUG ("_last_written_frame=%1", _last_written_frame);
399 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
400 _full_condition.notify_all ();
409 Writer::terminate_thread (bool can_throw)
411 boost::mutex::scoped_lock lock (_mutex);
417 _empty_condition.notify_all ();
418 _full_condition.notify_all ();
437 terminate_thread (true);
439 _picture_mxf_writer->finalize ();
440 if (_sound_mxf_writer) {
441 _sound_mxf_writer->finalize ();
444 /* Hard-link the video MXF into the DCP */
445 boost::filesystem::path video_from = _picture_mxf->file ();
447 boost::filesystem::path video_to;
448 video_to /= _film->dir (_film->dcp_name());
449 video_to /= video_mxf_filename (_picture_mxf);
451 boost::system::error_code ec;
452 boost::filesystem::create_hard_link (video_from, video_to, ec);
454 LOG_WARNING_NC ("Hard-link failed; copying instead");
455 boost::filesystem::copy_file (video_from, video_to, ec);
457 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
458 throw FileError (ec.message(), video_from);
462 _picture_mxf->set_file (video_to);
464 /* Move the audio MXF into the DCP */
467 boost::filesystem::path audio_to;
468 audio_to /= _film->dir (_film->dcp_name ());
469 audio_to /= audio_mxf_filename (_sound_mxf);
471 boost::filesystem::rename (_film->file (audio_mxf_filename (_sound_mxf)), audio_to, ec);
474 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), audio_mxf_filename (_sound_mxf)
478 _sound_mxf->set_file (audio_to);
481 dcp::DCP dcp (_film->dir (_film->dcp_name()));
483 shared_ptr<dcp::CPL> cpl (
486 _film->dcp_content_type()->libdcp_kind ()
492 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
494 shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
496 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
500 shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
502 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
507 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
508 dcp.add (_sound_mxf);
511 if (_subtitle_content) {
512 boost::filesystem::path const liberation = shared_path () / "LiberationSans-Regular.ttf";
514 /* Add all the fonts to the subtitle content and as assets to the DCP */
515 BOOST_FOREACH (shared_ptr<Font> i, _fonts) {
516 boost::filesystem::path const from = i->file.get_value_or (liberation);
517 _subtitle_content->add_font (i->id, from.leaf().string ());
519 boost::filesystem::path to = _film->dir (_film->dcp_name ()) / _subtitle_content->id ();
520 boost::filesystem::create_directories (to, ec);
522 throw FileError (_("Could not create directory"), to);
527 boost::system::error_code ec;
528 boost::filesystem::copy_file (from, to, ec);
530 throw FileError ("Could not copy font to DCP", from);
533 dcp.add (shared_ptr<dcp::Font> (new dcp::Font (to)));
536 _subtitle_content->write_xml (_film->dir (_film->dcp_name ()) / _subtitle_content->id () / subtitle_content_filename (_subtitle_content));
537 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
538 new dcp::ReelSubtitleAsset (
540 dcp::Fraction (_film->video_frame_rate(), 1),
541 _picture_mxf->intrinsic_duration (),
546 dcp.add (_subtitle_content);
551 shared_ptr<Job> job = _job.lock ();
552 DCPOMATIC_ASSERT (job);
554 job->sub (_("Computing image digest"));
555 _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
558 job->sub (_("Computing audio digest"));
559 _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
562 dcp::XMLMetadata meta;
563 meta.issuer = Config::instance()->dcp_issuer ();
564 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
565 meta.set_issue_date_now ();
567 shared_ptr<const dcp::Signer> signer;
568 if (_film->is_signed ()) {
569 signer = Config::instance()->signer ();
570 /* We did check earlier, but check again here to be on the safe side */
571 if (!signer->valid ()) {
572 throw InvalidSignerError ();
576 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
579 N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk
584 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
586 /* Read the frame info as written */
587 FILE* file = fopen_boost (_film->info_file (), "rb");
589 LOG_GENERAL ("Existing frame %1 has no info file", f);
593 dcp::FrameInfo info = read_frame_info (file, f, eyes);
595 if (info.size == 0) {
596 LOG_GENERAL ("Existing frame %1 has no info file", f);
600 /* Read the data from the MXF and hash it */
601 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
602 EncodedData data (info.size);
603 size_t const read = fread (data.data(), 1, data.size(), mxf);
604 if (read != static_cast<size_t> (data.size ())) {
605 LOG_GENERAL ("Existing frame %1 is incomplete", f);
609 MD5Digester digester;
610 digester.add (data.data(), data.size());
611 if (digester.get() != info.hash) {
612 LOG_GENERAL ("Existing frame %1 failed hash check", f);
620 Writer::check_existing_picture_mxf ()
622 /* Try to open the existing MXF */
623 FILE* mxf = fopen_boost (_picture_mxf->file(), "rb");
625 LOG_GENERAL ("Could not open existing MXF at %1 (errno=%2)", _picture_mxf->file().string(), errno);
631 shared_ptr<Job> job = _job.lock ();
632 DCPOMATIC_ASSERT (job);
634 job->set_progress_unknown ();
636 if (_film->three_d ()) {
637 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
640 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
644 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
649 LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
650 ++_first_nonexistant_frame;
656 /** @param frame Frame index.
657 * @return true if we can fake-write this frame.
660 Writer::can_fake_write (int frame) const
662 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
663 parameters in the MXF writer.
665 return (frame != 0 && frame < _first_nonexistant_frame);
669 Writer::write (PlayerSubtitles subs)
671 if (subs.text.empty ()) {
675 if (!_subtitle_content) {
676 string lang = _film->subtitle_language ();
680 _subtitle_content.reset (new dcp::InteropSubtitleContent (_film->name(), lang));
683 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
684 _subtitle_content->add (*i);
689 Writer::write (list<shared_ptr<Font> > fonts)
691 /* Just keep a list of fonts and we'll deal with them in ::finish */
692 copy (fonts.begin (), fonts.end (), back_inserter (_fonts));
696 operator< (QueueItem const & a, QueueItem const & b)
698 if (a.frame != b.frame) {
699 return a.frame < b.frame;
702 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
706 operator== (QueueItem const & a, QueueItem const & b)
708 return a.frame == b.frame && a.eyes == b.eyes;
712 Writer::maximum_frames_in_memory () const
714 return Config::instance()->num_local_encoding_threads() + 4;