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"
52 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
53 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
54 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
55 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
57 /* OS X strikes again */
65 using boost::shared_ptr;
66 using boost::weak_ptr;
67 using boost::dynamic_pointer_cast;
69 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
71 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
74 , _first_nonexistant_frame (0)
77 , _queued_full_in_memory (0)
78 , _last_written_frame (-1)
79 , _last_written_eyes (EYES_RIGHT)
84 /* Remove any old DCP */
85 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
87 shared_ptr<Job> job = _job.lock ();
90 job->sub (_("Checking existing image data"));
91 check_existing_picture_mxf ();
93 /* Create our picture asset in a subdirectory, named according to those
94 film's parameters which affect the video output. We will hard-link
95 it into the DCP later.
98 if (_film->three_d ()) {
99 _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
101 _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
104 _picture_mxf->set_size (_film->frame_size ());
106 if (_film->encrypted ()) {
107 _picture_mxf->set_key (_film->key ());
110 _picture_mxf_writer = _picture_mxf->start_write (
111 _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
112 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
113 _first_nonexistant_frame > 0
116 if (_film->audio_channels ()) {
117 _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
119 if (_film->encrypted ()) {
120 _sound_mxf->set_key (_film->key ());
123 /* Write the sound MXF into the film directory so that we leave the creation
124 of the DCP directory until the last minute.
126 _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / _film->audio_mxf_filename(), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
129 /* Check that the signer is OK if we need one */
130 if (_film->is_signed() && !Config::instance()->signer()->valid ()) {
131 throw InvalidSignerError ();
134 _thread = new boost::thread (boost::bind (&Writer::thread, this));
136 job->sub (_("Encoding image data"));
141 terminate_thread (false);
145 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
147 boost::mutex::scoped_lock lock (_mutex);
149 while (_queued_full_in_memory > _maximum_frames_in_memory) {
150 /* The queue is too big; wait until that is sorted out */
151 _full_condition.wait (lock);
155 qi.type = QueueItem::FULL;
156 qi.encoded = encoded;
159 if (_film->three_d() && eyes == EYES_BOTH) {
160 /* 2D material in a 3D DCP; fake the 3D */
162 _queue.push_back (qi);
163 ++_queued_full_in_memory;
164 qi.eyes = EYES_RIGHT;
165 _queue.push_back (qi);
166 ++_queued_full_in_memory;
169 _queue.push_back (qi);
170 ++_queued_full_in_memory;
173 /* Now there's something to do: wake anything wait()ing on _empty_condition */
174 _empty_condition.notify_all ();
178 Writer::fake_write (int frame, Eyes eyes)
180 boost::mutex::scoped_lock lock (_mutex);
182 while (_queued_full_in_memory > _maximum_frames_in_memory) {
183 /* The queue is too big; wait until that is sorted out */
184 _full_condition.wait (lock);
187 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
188 dcp::FrameInfo info (ifi);
192 qi.type = QueueItem::FAKE;
195 if (_film->three_d() && eyes == EYES_BOTH) {
197 _queue.push_back (qi);
198 qi.eyes = EYES_RIGHT;
199 _queue.push_back (qi);
202 _queue.push_back (qi);
205 /* Now there's something to do: wake anything wait()ing on _empty_condition */
206 _empty_condition.notify_all ();
209 /** This method is not thread safe */
211 Writer::write (shared_ptr<const AudioBuffers> audio)
213 if (_sound_mxf_writer) {
214 _sound_mxf_writer->write (audio->data(), audio->frames());
218 /** This must be called from Writer::thread() with an appropriate lock held */
220 Writer::have_sequenced_image_at_queue_head ()
222 if (_queue.empty ()) {
228 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
230 if (_queue.front().eyes == EYES_BOTH) {
232 return _queue.front().frame == (_last_written_frame + 1);
237 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
241 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
254 boost::mutex::scoped_lock lock (_mutex);
258 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
259 /* We've got something to do: go and do it */
263 /* Nothing to do: wait until something happens which may indicate that we do */
264 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
265 _empty_condition.wait (lock);
266 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
269 if (_finish && _queue.empty()) {
273 /* Write any frames that we can write; i.e. those that are in sequence. */
274 while (have_sequenced_image_at_queue_head ()) {
275 QueueItem qi = _queue.front ();
277 if (qi.type == QueueItem::FULL && qi.encoded) {
278 --_queued_full_in_memory;
283 case QueueItem::FULL:
285 LOG_GENERAL (N_("Writer FULL-writes %1 to MXF"), qi.frame);
287 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
290 dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
291 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
292 _last_written[qi.eyes] = qi.encoded;
296 case QueueItem::FAKE:
297 LOG_GENERAL (N_("Writer FAKE-writes %1 to MXF"), qi.frame);
298 _picture_mxf_writer->fake_write (qi.size);
299 _last_written[qi.eyes].reset ();
305 _last_written_frame = qi.frame;
306 _last_written_eyes = qi.eyes;
308 shared_ptr<Job> job = _job.lock ();
310 int64_t total = _film->length().frames (_film->video_frame_rate ());
311 if (_film->three_d ()) {
312 /* _full_written and so on are incremented for each eye, so we need to double the total
313 frames to get the correct progress.
318 job->set_progress (float (_full_written + _fake_written) / total);
322 while (_queued_full_in_memory > _maximum_frames_in_memory) {
323 /* Too many frames in memory which can't yet be written to the stream.
324 Write some FULL frames to disk.
327 /* Find one from the back of the queue */
329 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
330 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
334 assert (i != _queue.rend());
342 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
343 _last_written_frame + 1,
344 _last_written_eyes, qi.frame
347 qi.encoded->write (_film, qi.frame, qi.eyes);
350 --_queued_full_in_memory;
353 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
354 _full_condition.notify_all ();
363 Writer::terminate_thread (bool can_throw)
365 boost::mutex::scoped_lock lock (_mutex);
371 _empty_condition.notify_all ();
372 _full_condition.notify_all ();
391 terminate_thread (true);
393 _picture_mxf_writer->finalize ();
394 if (_sound_mxf_writer) {
395 _sound_mxf_writer->finalize ();
398 /* Hard-link the video MXF into the DCP */
399 boost::filesystem::path video_from;
400 video_from /= _film->internal_video_mxf_dir();
401 video_from /= _film->internal_video_mxf_filename();
403 boost::filesystem::path video_to;
404 video_to /= _film->dir (_film->dcp_name());
405 video_to /= _film->video_mxf_filename ();
407 boost::system::error_code ec;
408 boost::filesystem::create_hard_link (video_from, video_to, ec);
410 LOG_WARNING_NC ("Hard-link failed; copying instead");
411 boost::filesystem::copy_file (video_from, video_to, ec);
413 LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ());
414 throw FileError (ec.message(), video_from);
418 _picture_mxf->set_file (video_to);
420 /* Move the audio MXF into the DCP */
423 boost::filesystem::path audio_to;
424 audio_to /= _film->dir (_film->dcp_name ());
425 audio_to /= _film->audio_mxf_filename ();
427 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
430 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
434 _sound_mxf->set_file (audio_to);
437 dcp::DCP dcp (_film->dir (_film->dcp_name()));
439 shared_ptr<dcp::CPL> cpl (
442 _film->dcp_content_type()->libdcp_kind ()
448 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
450 shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
452 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
456 shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
458 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
463 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
464 dcp.add (_sound_mxf);
467 if (_subtitle_content) {
468 _subtitle_content->write_xml (_film->dir (_film->dcp_name ()) / _film->subtitle_xml_filename ());
469 reel->add (shared_ptr<dcp::ReelSubtitleAsset> (
470 new dcp::ReelSubtitleAsset (
472 dcp::Fraction (_film->video_frame_rate(), 1),
473 _picture_mxf->intrinsic_duration (),
478 dcp.add (_subtitle_content);
483 shared_ptr<Job> job = _job.lock ();
486 job->sub (_("Computing image digest"));
487 _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
490 job->sub (_("Computing audio digest"));
491 _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
494 dcp::XMLMetadata meta;
495 meta.issuer = Config::instance()->dcp_issuer ();
496 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
497 meta.set_issue_date_now ();
499 shared_ptr<const dcp::Signer> signer;
500 if (_film->is_signed ()) {
501 signer = Config::instance()->signer ();
502 /* We did check earlier, but check again here to be on the safe side */
503 if (!signer->valid ()) {
504 throw InvalidSignerError ();
508 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
511 N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk
516 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
518 /* Read the frame info as written */
519 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
521 LOG_GENERAL ("Existing frame %1 has no info file", f);
525 dcp::FrameInfo info (ifi);
527 if (info.size == 0) {
528 LOG_GENERAL ("Existing frame %1 has no info file", f);
532 /* Read the data from the MXF and hash it */
533 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
534 EncodedData data (info.size);
535 size_t const read = fread (data.data(), 1, data.size(), mxf);
536 if (read != static_cast<size_t> (data.size ())) {
537 LOG_GENERAL ("Existing frame %1 is incomplete", f);
541 MD5Digester digester;
542 digester.add (data.data(), data.size());
543 if (digester.get() != info.hash) {
544 LOG_GENERAL ("Existing frame %1 failed hash check", f);
552 Writer::check_existing_picture_mxf ()
554 /* Try to open the existing MXF */
555 boost::filesystem::path p;
556 p /= _film->internal_video_mxf_dir ();
557 p /= _film->internal_video_mxf_filename ();
558 FILE* mxf = fopen_boost (p, "rb");
560 LOG_GENERAL ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno);
565 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
571 shared_ptr<Job> job = _job.lock ();
575 job->set_progress (float (_first_nonexistant_frame) / N);
578 if (_film->three_d ()) {
579 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
582 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
586 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
591 LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
592 ++_first_nonexistant_frame;
598 /** @param frame Frame index.
599 * @return true if we can fake-write this frame.
602 Writer::can_fake_write (int frame) const
604 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
605 parameters in the MXF writer.
607 return (frame != 0 && frame < _first_nonexistant_frame);
611 Writer::write (PlayerSubtitles subs)
613 if (subs.text.empty ()) {
617 if (!_subtitle_content) {
618 _subtitle_content.reset (
619 new dcp::SubtitleContent (_film->name(), _film->isdcf_metadata().subtitle_language)
623 for (list<dcp::SubtitleString>::const_iterator i = subs.text.begin(); i != subs.text.end(); ++i) {
624 _subtitle_content->add (*i);
629 operator< (QueueItem const & a, QueueItem const & b)
631 if (a.frame != b.frame) {
632 return a.frame < b.frame;
635 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
639 operator== (QueueItem const & a, QueueItem const & b)
641 return a.frame == b.frame && a.eyes == b.eyes;