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 <libdcp/mono_picture_asset.h>
23 #include <libdcp/stereo_picture_asset.h>
24 #include <libdcp/sound_asset.h>
25 #include <libdcp/reel.h>
26 #include <libdcp/dcp.h>
27 #include <libdcp/cpl.h>
29 #include "compose.hpp"
33 #include "dcp_video_frame.h"
34 #include "dcp_content_type.h"
36 #include "audio_mapping.h"
43 /* OS X strikes again */
51 using std::stringstream;
52 using boost::shared_ptr;
53 using boost::weak_ptr;
55 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
57 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
60 , _first_nonexistant_frame (0)
63 , _queued_full_in_memory (0)
64 , _last_written_frame (-1)
65 , _last_written_eyes (EYES_RIGHT)
71 /* Remove any old DCP */
72 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
74 shared_ptr<Job> job = _job.lock ();
77 job->sub (_("Checking existing image data"));
78 check_existing_picture_mxf ();
80 /* Create our picture asset in a subdirectory, named according to those
81 film's parameters which affect the video output. We will hard-link
82 it into the DCP later.
85 if (_film->three_d ()) {
86 _picture_asset.reset (new libdcp::StereoPictureAsset (_film->internal_video_mxf_dir (), _film->internal_video_mxf_filename ()));
88 _picture_asset.reset (new libdcp::MonoPictureAsset (_film->internal_video_mxf_dir (), _film->internal_video_mxf_filename ()));
91 _picture_asset->set_edit_rate (_film->video_frame_rate ());
92 _picture_asset->set_size (_film->frame_size ());
93 _picture_asset->set_interop (_film->interop ());
95 if (_film->encrypted ()) {
96 _picture_asset->set_key (_film->key ());
99 _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0);
101 if (_film->audio_channels ()) {
102 _sound_asset.reset (new libdcp::SoundAsset (_film->directory (), _film->audio_mxf_filename ()));
103 _sound_asset->set_edit_rate (_film->video_frame_rate ());
104 _sound_asset->set_channels (_film->audio_channels ());
105 _sound_asset->set_sampling_rate (_film->audio_frame_rate ());
106 _sound_asset->set_interop (_film->interop ());
108 if (_film->encrypted ()) {
109 _sound_asset->set_key (_film->key ());
112 /* Write the sound asset into the film directory so that we leave the creation
113 of the DCP directory until the last minute.
115 _sound_asset_writer = _sound_asset->start_write ();
118 _thread = new boost::thread (boost::bind (&Writer::thread, this));
120 job->sub (_("Encoding image data"));
125 terminate_thread (false);
129 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
131 boost::mutex::scoped_lock lock (_mutex);
133 while (_queued_full_in_memory > _maximum_frames_in_memory) {
134 _full_condition.wait (lock);
138 qi.type = QueueItem::FULL;
139 qi.encoded = encoded;
142 if (_film->three_d() && eyes == EYES_BOTH) {
143 /* 2D material in a 3D DCP; fake the 3D */
145 _queue.push_back (qi);
146 ++_queued_full_in_memory;
147 qi.eyes = EYES_RIGHT;
148 _queue.push_back (qi);
149 ++_queued_full_in_memory;
152 _queue.push_back (qi);
153 ++_queued_full_in_memory;
156 _empty_condition.notify_all ();
160 Writer::fake_write (int frame, Eyes eyes)
162 boost::mutex::scoped_lock lock (_mutex);
164 while (_queued_full_in_memory > _maximum_frames_in_memory) {
165 _full_condition.wait (lock);
168 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
169 libdcp::FrameInfo info (ifi);
173 qi.type = QueueItem::FAKE;
176 if (_film->three_d() && eyes == EYES_BOTH) {
178 _queue.push_back (qi);
179 qi.eyes = EYES_RIGHT;
180 _queue.push_back (qi);
183 _queue.push_back (qi);
186 _empty_condition.notify_all ();
189 /** This method is not thread safe */
191 Writer::write (shared_ptr<const AudioBuffers> audio)
194 _sound_asset_writer->write (audio->data(), audio->frames());
198 /** This must be called from Writer::thread() with an appropriate lock held */
200 Writer::have_sequenced_image_at_queue_head ()
202 if (_queue.empty ()) {
208 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
210 if (_queue.front().eyes == EYES_BOTH) {
212 return _queue.front().frame == (_last_written_frame + 1);
217 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
221 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
234 boost::mutex::scoped_lock lock (_mutex);
238 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
242 TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
243 _empty_condition.wait (lock);
244 TIMING (N_("writer wakes with a queue of %1"), _queue.size());
247 if (_finish && _queue.empty()) {
251 /* Write any frames that we can write; i.e. those that are in sequence. */
252 while (have_sequenced_image_at_queue_head ()) {
253 QueueItem qi = _queue.front ();
255 if (qi.type == QueueItem::FULL && qi.encoded) {
256 --_queued_full_in_memory;
261 case QueueItem::FULL:
263 _film->log()->log (String::compose (N_("Writer FULL-writes %1 to MXF"), qi.frame));
265 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
268 libdcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
269 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
270 _last_written[qi.eyes] = qi.encoded;
274 case QueueItem::FAKE:
275 _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
276 _picture_asset_writer->fake_write (qi.size);
277 _last_written[qi.eyes].reset ();
280 case QueueItem::REPEAT:
282 _film->log()->log (String::compose (N_("Writer REPEAT-writes %1 to MXF"), qi.frame));
283 libdcp::FrameInfo fin = _picture_asset_writer->write (
284 _last_written[qi.eyes]->data(),
285 _last_written[qi.eyes]->size()
288 _last_written[qi.eyes]->write_info (_film, qi.frame, qi.eyes, fin);
295 _last_written_frame = qi.frame;
296 _last_written_eyes = qi.eyes;
298 if (_film->length()) {
299 shared_ptr<Job> job = _job.lock ();
301 int total = _film->time_to_video_frames (_film->length ());
302 if (_film->three_d ()) {
303 /* _full_written and so on are incremented for each eye, so we need to double the total
304 frames to get the correct progress.
308 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
312 while (_queued_full_in_memory > _maximum_frames_in_memory) {
313 /* Too many frames in memory which can't yet be written to the stream.
314 Write some FULL frames to disk.
317 /* Find one from the back of the queue */
319 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
320 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
324 assert (i != _queue.rend());
333 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
334 _last_written_frame + 1,
335 _last_written_eyes, qi.frame)
338 qi.encoded->write (_film, qi.frame, qi.eyes);
341 --_queued_full_in_memory;
344 _full_condition.notify_all ();
353 Writer::terminate_thread (bool can_throw)
355 boost::mutex::scoped_lock lock (_mutex);
361 _empty_condition.notify_all ();
362 _full_condition.notify_all ();
381 terminate_thread (true);
383 _picture_asset_writer->finalize ();
384 if (_sound_asset_writer) {
385 _sound_asset_writer->finalize ();
388 int const frames = _last_written_frame + 1;
390 _picture_asset->set_duration (frames);
392 /* Hard-link the video MXF into the DCP */
393 boost::filesystem::path video_from;
394 video_from /= _film->internal_video_mxf_dir();
395 video_from /= _film->internal_video_mxf_filename();
397 boost::filesystem::path video_to;
398 video_to /= _film->dir (_film->dcp_name());
399 video_to /= _film->video_mxf_filename ();
401 boost::system::error_code ec;
402 boost::filesystem::create_hard_link (video_from, video_to, ec);
404 /* hard link failed; copy instead */
405 boost::filesystem::copy_file (video_from, video_to);
406 _film->log()->log ("Hard-link failed; fell back to copying");
409 /* And update the asset */
411 _picture_asset->set_directory (_film->dir (_film->dcp_name ()));
412 _picture_asset->set_file_name (_film->video_mxf_filename ());
414 /* Move the audio MXF into the DCP */
417 boost::filesystem::path audio_to;
418 audio_to /= _film->dir (_film->dcp_name ());
419 audio_to /= _film->audio_mxf_filename ();
421 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
424 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
428 _sound_asset->set_directory (_film->dir (_film->dcp_name ()));
429 _sound_asset->set_duration (frames);
432 libdcp::DCP dcp (_film->dir (_film->dcp_name()));
434 shared_ptr<libdcp::CPL> cpl (
436 _film->dir (_film->dcp_name()),
438 _film->dcp_content_type()->libdcp_kind (),
440 _film->video_frame_rate ()
446 cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
449 shared_ptr<libdcp::SubtitleAsset> ()
453 shared_ptr<Job> job = _job.lock ();
456 job->sub (_("Computing image digest"));
457 _picture_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
460 job->sub (_("Computing audio digest"));
461 _sound_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
464 libdcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
465 meta.set_issue_date_now ();
466 dcp.write_xml (_film->interop (), meta, _film->is_signed() ? make_signer () : shared_ptr<const libdcp::Signer> ());
469 String::compose (N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk)
473 /** Tell the writer that frame `f' should be a repeat of the frame before it */
475 Writer::repeat (int f, Eyes e)
477 boost::mutex::scoped_lock lock (_mutex);
479 while (_queued_full_in_memory > _maximum_frames_in_memory) {
480 _full_condition.wait (lock);
484 qi.type = QueueItem::REPEAT;
486 if (_film->three_d() && e == EYES_BOTH) {
488 _queue.push_back (qi);
489 qi.eyes = EYES_RIGHT;
490 _queue.push_back (qi);
493 _queue.push_back (qi);
496 _empty_condition.notify_all ();
500 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
502 /* Read the frame info as written */
503 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
505 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
509 libdcp::FrameInfo info (ifi);
511 if (info.size == 0) {
512 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
516 /* Read the data from the MXF and hash it */
517 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
518 EncodedData data (info.size);
519 size_t const read = fread (data.data(), 1, data.size(), mxf);
520 if (read != static_cast<size_t> (data.size ())) {
521 _film->log()->log (String::compose ("Existing frame %1 is incomplete", f));
525 string const existing_hash = md5_digest (data.data(), data.size());
526 if (existing_hash != info.hash) {
527 _film->log()->log (String::compose ("Existing frame %1 failed hash check", f));
535 Writer::check_existing_picture_mxf ()
537 /* Try to open the existing MXF */
538 boost::filesystem::path p;
539 p /= _film->internal_video_mxf_dir ();
540 p /= _film->internal_video_mxf_filename ();
541 FILE* mxf = fopen_boost (p, "rb");
543 _film->log()->log (String::compose ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno));
548 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
554 shared_ptr<Job> job = _job.lock ();
558 job->set_progress (float (_first_nonexistant_frame) / N);
561 if (_film->three_d ()) {
562 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
565 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
569 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
574 _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
575 ++_first_nonexistant_frame;
581 /** @param frame Frame index.
582 * @return true if we can fake-write this frame.
585 Writer::can_fake_write (int frame) const
587 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
588 parameters in the MXF writer.
590 return (frame != 0 && frame < _first_nonexistant_frame);
594 operator< (QueueItem const & a, QueueItem const & b)
596 if (a.frame != b.frame) {
597 return a.frame < b.frame;
600 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
604 operator== (QueueItem const & a, QueueItem const & b)
606 return a.frame == b.frame && a.eyes == b.eyes;