2 Copyright (C) 2012-2014 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.
22 #include <dcp/mono_picture_mxf.h>
23 #include <dcp/stereo_picture_mxf.h>
24 #include <dcp/sound_mxf.h>
25 #include <dcp/sound_mxf_writer.h>
27 #include <dcp/reel_mono_picture_asset.h>
28 #include <dcp/reel_stereo_picture_asset.h>
29 #include <dcp/reel_sound_asset.h>
30 #include <dcp/reel_subtitle_asset.h>
33 #include <dcp/signer.h>
35 #include "compose.hpp"
39 #include "dcp_video.h"
40 #include "dcp_content_type.h"
41 #include "audio_mapping.h"
45 #include "audio_buffers.h"
46 #include "md5_digester.h"
47 #include "encoded_data.h"
51 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
52 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
53 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
55 /* OS X strikes again */
63 using boost::shared_ptr;
64 using boost::weak_ptr;
65 using boost::dynamic_pointer_cast;
67 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
69 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
72 , _first_nonexistant_frame (0)
75 , _queued_full_in_memory (0)
76 , _last_written_frame (-1)
77 , _last_written_eyes (EYES_RIGHT)
82 /* Remove any old DCP */
83 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
85 shared_ptr<Job> job = _job.lock ();
88 job->sub (_("Checking existing image data"));
89 check_existing_picture_mxf ();
91 /* Create our picture asset in a subdirectory, named according to those
92 film's parameters which affect the video output. We will hard-link
93 it into the DCP later.
96 if (_film->three_d ()) {
97 _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
99 _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
102 _picture_mxf->set_size (_film->frame_size ());
104 if (_film->encrypted ()) {
105 _picture_mxf->set_key (_film->key ());
108 _picture_mxf_writer = _picture_mxf->start_write (
109 _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
110 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
111 _first_nonexistant_frame > 0
114 if (_film->audio_channels ()) {
115 _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
117 if (_film->encrypted ()) {
118 _sound_mxf->set_key (_film->key ());
121 /* Write the sound MXF into the film directory so that we leave the creation
122 of the DCP directory until the last minute.
124 _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / _film->audio_mxf_filename(), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
127 /* Check that the signer is OK if we need one */
128 if (_film->is_signed() && !Config::instance()->signer()->valid ()) {
129 throw InvalidSignerError ();
132 _thread = new boost::thread (boost::bind (&Writer::thread, this));
134 job->sub (_("Encoding image data"));
139 terminate_thread (false);
143 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
145 boost::mutex::scoped_lock lock (_mutex);
147 while (_queued_full_in_memory > _maximum_frames_in_memory) {
148 /* The queue is too big; wait until that is sorted out */
149 _full_condition.wait (lock);
153 qi.type = QueueItem::FULL;
154 qi.encoded = encoded;
157 if (_film->three_d() && eyes == EYES_BOTH) {
158 /* 2D material in a 3D DCP; fake the 3D */
160 _queue.push_back (qi);
161 ++_queued_full_in_memory;
162 qi.eyes = EYES_RIGHT;
163 _queue.push_back (qi);
164 ++_queued_full_in_memory;
167 _queue.push_back (qi);
168 ++_queued_full_in_memory;
171 /* Now there's something to do: wake anything wait()ing on _empty_condition */
172 _empty_condition.notify_all ();
176 Writer::fake_write (int frame, Eyes eyes)
178 boost::mutex::scoped_lock lock (_mutex);
180 while (_queued_full_in_memory > _maximum_frames_in_memory) {
181 /* The queue is too big; wait until that is sorted out */
182 _full_condition.wait (lock);
185 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
186 dcp::FrameInfo info (ifi);
190 qi.type = QueueItem::FAKE;
193 if (_film->three_d() && eyes == EYES_BOTH) {
195 _queue.push_back (qi);
196 qi.eyes = EYES_RIGHT;
197 _queue.push_back (qi);
200 _queue.push_back (qi);
203 /* Now there's something to do: wake anything wait()ing on _empty_condition */
204 _empty_condition.notify_all ();
207 /** This method is not thread safe */
209 Writer::write (shared_ptr<const AudioBuffers> audio)
211 if (_sound_mxf_writer) {
212 _sound_mxf_writer->write (audio->data(), audio->frames());
216 /** This must be called from Writer::thread() with an appropriate lock held */
218 Writer::have_sequenced_image_at_queue_head ()
220 if (_queue.empty ()) {
226 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
228 if (_queue.front().eyes == EYES_BOTH) {
230 return _queue.front().frame == (_last_written_frame + 1);
235 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
239 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
252 boost::mutex::scoped_lock lock (_mutex);
256 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
257 /* We've got something to do: go and do it */
261 /* Nothing to do: wait until something happens which may indicate that we do */
262 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
263 _empty_condition.wait (lock);
264 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
267 if (_finish && _queue.empty()) {
271 /* Write any frames that we can write; i.e. those that are in sequence. */
272 while (have_sequenced_image_at_queue_head ()) {
273 QueueItem qi = _queue.front ();
275 if (qi.type == QueueItem::FULL && qi.encoded) {
276 --_queued_full_in_memory;
281 case QueueItem::FULL:
283 LOG_GENERAL (N_("Writer FULL-writes %1 to MXF"), qi.frame);
285 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
288 dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
289 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
290 _last_written[qi.eyes] = qi.encoded;
294 case QueueItem::FAKE:
295 LOG_GENERAL (N_("Writer FAKE-writes %1 to MXF"), qi.frame);
296 _picture_mxf_writer->fake_write (qi.size);
297 _last_written[qi.eyes].reset ();
303 _last_written_frame = qi.frame;
304 _last_written_eyes = qi.eyes;
306 shared_ptr<Job> job = _job.lock ();
308 int64_t total = _film->length().frames (_film->video_frame_rate ());
309 if (_film->three_d ()) {
310 /* _full_written and so on are incremented for each eye, so we need to double the total
311 frames to get the correct progress.
316 job->set_progress (float (_full_written + _fake_written) / total);
320 while (_queued_full_in_memory > _maximum_frames_in_memory) {
321 /* Too many frames in memory which can't yet be written to the stream.
322 Write some FULL frames to disk.
325 /* Find one from the back of the queue */
327 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
328 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
332 assert (i != _queue.rend());
340 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
341 _last_written_frame + 1,
342 _last_written_eyes, qi.frame
345 qi.encoded->write (_film, qi.frame, qi.eyes);
348 --_queued_full_in_memory;
351 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
352 _full_condition.notify_all ();
361 Writer::terminate_thread (bool can_throw)
363 boost::mutex::scoped_lock lock (_mutex);
369 _empty_condition.notify_all ();
370 _full_condition.notify_all ();
389 terminate_thread (true);
391 _picture_mxf_writer->finalize ();
392 if (_sound_mxf_writer) {
393 _sound_mxf_writer->finalize ();
396 /* Hard-link the video MXF into the DCP */
397 boost::filesystem::path video_from;
398 video_from /= _film->internal_video_mxf_dir();
399 video_from /= _film->internal_video_mxf_filename();
401 boost::filesystem::path video_to;
402 video_to /= _film->dir (_film->dcp_name());
403 video_to /= _film->video_mxf_filename ();
405 boost::system::error_code ec;
406 boost::filesystem::create_hard_link (video_from, video_to, ec);
408 /* hard link failed; copy instead */
409 boost::filesystem::copy_file (video_from, video_to);
410 LOG_WARNING_NC ("Hard-link failed; fell back to copying");
413 _picture_mxf->set_file (video_to);
415 /* Move the audio MXF into the DCP */
418 boost::filesystem::path audio_to;
419 audio_to /= _film->dir (_film->dcp_name ());
420 audio_to /= _film->audio_mxf_filename ();
422 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
425 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
429 _sound_mxf->set_file (audio_to);
432 dcp::DCP dcp (_film->dir (_film->dcp_name()));
434 shared_ptr<dcp::CPL> cpl (
437 _film->dcp_content_type()->libdcp_kind ()
443 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
445 shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
447 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
451 shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
453 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
458 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
459 dcp.add (_sound_mxf);
462 if (_subtitle_content) {
463 _subtitle_content->write_xml (_film->dir (_film->dcp_name ()) / _film->subtitle_xml_filename ());
464 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
465 new dcp::ReelSubtitleAsset (
467 dcp::Fraction (_film->video_frame_rate(), 1),
468 _picture_mxf->intrinsic_duration (),
473 dcp.add (_subtitle_content);
478 shared_ptr<Job> job = _job.lock ();
481 job->sub (_("Computing image digest"));
482 _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
485 job->sub (_("Computing audio digest"));
486 _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
489 dcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
490 meta.set_issue_date_now ();
492 shared_ptr<const dcp::Signer> signer;
493 if (_film->is_signed ()) {
494 signer = Config::instance()->signer ();
495 /* We did check earlier, but check again here to be on the safe side */
496 if (!signer->valid ()) {
497 throw InvalidSignerError ();
501 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
504 N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk
509 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
511 /* Read the frame info as written */
512 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
514 LOG_GENERAL ("Existing frame %1 has no info file", f);
518 dcp::FrameInfo info (ifi);
520 if (info.size == 0) {
521 LOG_GENERAL ("Existing frame %1 has no info file", f);
525 /* Read the data from the MXF and hash it */
526 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
527 EncodedData data (info.size);
528 size_t const read = fread (data.data(), 1, data.size(), mxf);
529 if (read != static_cast<size_t> (data.size ())) {
530 LOG_GENERAL ("Existing frame %1 is incomplete", f);
534 MD5Digester digester;
535 digester.add (data.data(), data.size());
536 if (digester.get() != info.hash) {
537 LOG_GENERAL ("Existing frame %1 failed hash check", f);
545 Writer::check_existing_picture_mxf ()
547 /* Try to open the existing MXF */
548 boost::filesystem::path p;
549 p /= _film->internal_video_mxf_dir ();
550 p /= _film->internal_video_mxf_filename ();
551 FILE* mxf = fopen_boost (p, "rb");
553 LOG_GENERAL ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno);
558 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
564 shared_ptr<Job> job = _job.lock ();
568 job->set_progress (float (_first_nonexistant_frame) / N);
571 if (_film->three_d ()) {
572 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
575 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
579 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
584 LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
585 ++_first_nonexistant_frame;
591 /** @param frame Frame index.
592 * @return true if we can fake-write this frame.
595 Writer::can_fake_write (int frame) const
597 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
598 parameters in the MXF writer.
600 return (frame != 0 && frame < _first_nonexistant_frame);
604 Writer::write (PlayerSubtitles subs)
606 if (subs.text.empty ()) {
610 if (!_subtitle_content) {
611 _subtitle_content.reset (
612 new dcp::SubtitleContent (_film->name(), _film->isdcf_metadata().subtitle_language)
616 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
617 _subtitle_content->add (*i);
622 operator< (QueueItem const & a, QueueItem const & b)
624 if (a.frame != b.frame) {
625 return a.frame < b.frame;
628 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
632 operator== (QueueItem const & a, QueueItem const & b)
634 return a.frame == b.frame && a.eyes == b.eyes;