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"
40 #include "md5_digester.h"
44 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
45 #define LOG_TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TYPE_TIMING);
46 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, Log::TYPE_WARNING);
48 /* OS X strikes again */
56 using std::stringstream;
57 using boost::shared_ptr;
58 using boost::weak_ptr;
60 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
62 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
65 , _first_nonexistant_frame (0)
68 , _queued_full_in_memory (0)
69 , _last_written_frame (-1)
70 , _last_written_eyes (EYES_RIGHT)
76 /* Remove any old DCP */
77 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
79 shared_ptr<Job> job = _job.lock ();
82 job->sub (_("Checking existing image data"));
83 check_existing_picture_mxf ();
85 /* Create our picture asset in a subdirectory, named according to those
86 film's parameters which affect the video output. We will hard-link
87 it into the DCP later.
90 if (_film->three_d ()) {
91 _picture_asset.reset (new libdcp::StereoPictureAsset (_film->internal_video_mxf_dir (), _film->internal_video_mxf_filename ()));
93 _picture_asset.reset (new libdcp::MonoPictureAsset (_film->internal_video_mxf_dir (), _film->internal_video_mxf_filename ()));
96 _picture_asset->set_edit_rate (_film->video_frame_rate ());
97 _picture_asset->set_size (_film->frame_size ());
98 _picture_asset->set_interop (_film->interop ());
100 if (_film->encrypted ()) {
101 _picture_asset->set_key (_film->key ());
104 _picture_asset_writer = _picture_asset->start_write (_first_nonexistant_frame > 0);
106 if (_film->audio_channels ()) {
107 _sound_asset.reset (new libdcp::SoundAsset (_film->directory (), _film->audio_mxf_filename ()));
108 _sound_asset->set_edit_rate (_film->video_frame_rate ());
109 _sound_asset->set_channels (_film->audio_channels ());
110 _sound_asset->set_sampling_rate (_film->audio_frame_rate ());
111 _sound_asset->set_interop (_film->interop ());
113 if (_film->encrypted ()) {
114 _sound_asset->set_key (_film->key ());
117 /* Write the sound asset into the film directory so that we leave the creation
118 of the DCP directory until the last minute.
120 _sound_asset_writer = _sound_asset->start_write ();
123 _thread = new boost::thread (boost::bind (&Writer::thread, this));
125 job->sub (_("Encoding image data"));
130 terminate_thread (false);
134 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
136 boost::mutex::scoped_lock lock (_mutex);
138 while (_queued_full_in_memory > _maximum_frames_in_memory) {
139 _full_condition.wait (lock);
143 qi.type = QueueItem::FULL;
144 qi.encoded = encoded;
147 if (_film->three_d() && eyes == EYES_BOTH) {
148 /* 2D material in a 3D DCP; fake the 3D */
150 _queue.push_back (qi);
151 ++_queued_full_in_memory;
152 qi.eyes = EYES_RIGHT;
153 _queue.push_back (qi);
154 ++_queued_full_in_memory;
157 _queue.push_back (qi);
158 ++_queued_full_in_memory;
161 _empty_condition.notify_all ();
165 Writer::fake_write (int frame, Eyes eyes)
167 boost::mutex::scoped_lock lock (_mutex);
169 while (_queued_full_in_memory > _maximum_frames_in_memory) {
170 _full_condition.wait (lock);
173 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
174 libdcp::FrameInfo info (ifi);
178 qi.type = QueueItem::FAKE;
181 if (_film->three_d() && eyes == EYES_BOTH) {
183 _queue.push_back (qi);
184 qi.eyes = EYES_RIGHT;
185 _queue.push_back (qi);
188 _queue.push_back (qi);
191 _empty_condition.notify_all ();
194 /** This method is not thread safe */
196 Writer::write (shared_ptr<const AudioBuffers> audio)
199 _sound_asset_writer->write (audio->data(), audio->frames());
203 /** This must be called from Writer::thread() with an appropriate lock held */
205 Writer::have_sequenced_image_at_queue_head ()
207 if (_queue.empty ()) {
213 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
215 if (_queue.front().eyes == EYES_BOTH) {
217 return _queue.front().frame == (_last_written_frame + 1);
222 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
226 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
239 boost::mutex::scoped_lock lock (_mutex);
243 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
247 LOG_TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
248 _empty_condition.wait (lock);
249 LOG_TIMING (N_("writer wakes with a queue of %1"), _queue.size());
252 if (_finish && _queue.empty()) {
256 /* Write any frames that we can write; i.e. those that are in sequence. */
257 while (have_sequenced_image_at_queue_head ()) {
258 QueueItem qi = _queue.front ();
260 if (qi.type == QueueItem::FULL && qi.encoded) {
261 --_queued_full_in_memory;
266 case QueueItem::FULL:
268 LOG_GENERAL (N_("Writer FULL-writes %1 to MXF"), qi.frame);
270 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
273 libdcp::FrameInfo fin = _picture_asset_writer->write (qi.encoded->data(), qi.encoded->size());
274 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
275 _last_written[qi.eyes] = qi.encoded;
279 case QueueItem::FAKE:
280 LOG_GENERAL (N_("Writer FAKE-writes %1 to MXF"), qi.frame);
281 _picture_asset_writer->fake_write (qi.size);
282 _last_written[qi.eyes].reset ();
285 case QueueItem::REPEAT:
287 LOG_GENERAL (N_("Writer REPEAT-writes %1 to MXF"), qi.frame);
288 libdcp::FrameInfo fin = _picture_asset_writer->write (
289 _last_written[qi.eyes]->data(),
290 _last_written[qi.eyes]->size()
293 _last_written[qi.eyes]->write_info (_film, qi.frame, qi.eyes, fin);
300 _last_written_frame = qi.frame;
301 _last_written_eyes = qi.eyes;
303 if (_film->length()) {
304 shared_ptr<Job> job = _job.lock ();
306 int total = _film->time_to_video_frames (_film->length ());
307 if (_film->three_d ()) {
308 /* _full_written and so on are incremented for each eye, so we need to double the total
309 frames to get the correct progress.
313 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
317 while (_queued_full_in_memory > _maximum_frames_in_memory) {
318 /* Too many frames in memory which can't yet be written to the stream.
319 Write some FULL frames to disk.
322 /* Find one from the back of the queue */
324 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
325 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
329 assert (i != _queue.rend());
337 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
338 _last_written_frame + 1,
339 _last_written_eyes, qi.frame
342 qi.encoded->write (_film, qi.frame, qi.eyes);
345 --_queued_full_in_memory;
348 _full_condition.notify_all ();
357 Writer::terminate_thread (bool can_throw)
359 boost::mutex::scoped_lock lock (_mutex);
365 _empty_condition.notify_all ();
366 _full_condition.notify_all ();
385 terminate_thread (true);
387 _picture_asset_writer->finalize ();
388 if (_sound_asset_writer) {
389 _sound_asset_writer->finalize ();
392 int const frames = _last_written_frame + 1;
394 _picture_asset->set_duration (frames);
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 /* And update the asset */
415 _picture_asset->set_directory (_film->dir (_film->dcp_name ()));
416 _picture_asset->set_file_name (_film->video_mxf_filename ());
418 /* Move the audio MXF into the DCP */
421 boost::filesystem::path audio_to;
422 audio_to /= _film->dir (_film->dcp_name ());
423 audio_to /= _film->audio_mxf_filename ();
425 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
428 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
432 _sound_asset->set_directory (_film->dir (_film->dcp_name ()));
433 _sound_asset->set_duration (frames);
436 libdcp::DCP dcp (_film->dir (_film->dcp_name()));
438 shared_ptr<libdcp::CPL> cpl (
440 _film->dir (_film->dcp_name()),
442 _film->dcp_content_type()->libdcp_kind (),
444 _film->video_frame_rate ()
450 cpl->add_reel (shared_ptr<libdcp::Reel> (new libdcp::Reel (
453 shared_ptr<libdcp::SubtitleAsset> ()
457 shared_ptr<Job> job = _job.lock ();
460 job->sub (_("Computing image digest"));
461 _picture_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
464 job->sub (_("Computing audio digest"));
465 _sound_asset->compute_digest (boost::bind (&Job::set_progress, job.get(), _1, false));
468 libdcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
469 meta.set_issue_date_now ();
470 dcp.write_xml (_film->interop (), meta, _film->is_signed() ? make_signer () : shared_ptr<const libdcp::Signer> ());
473 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
477 /** Tell the writer that frame `f' should be a repeat of the frame before it */
479 Writer::repeat (int f, Eyes e)
481 boost::mutex::scoped_lock lock (_mutex);
483 while (_queued_full_in_memory > _maximum_frames_in_memory) {
484 _full_condition.wait (lock);
488 qi.type = QueueItem::REPEAT;
490 if (_film->three_d() && e == EYES_BOTH) {
492 _queue.push_back (qi);
493 qi.eyes = EYES_RIGHT;
494 _queue.push_back (qi);
497 _queue.push_back (qi);
500 _empty_condition.notify_all ();
504 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
506 /* Read the frame info as written */
507 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
509 LOG_GENERAL ("Existing frame %1 has no info file", f);
513 libdcp::FrameInfo info (ifi);
515 if (info.size == 0) {
516 LOG_GENERAL ("Existing frame %1 has no info file", f);
520 /* Read the data from the MXF and hash it */
521 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
522 EncodedData data (info.size);
523 size_t const read = fread (data.data(), 1, data.size(), mxf);
524 if (read != static_cast<size_t> (data.size ())) {
525 LOG_GENERAL ("Existing frame %1 is incomplete", f);
529 MD5Digester digester;
530 digester.add (data.data(), data.size());
531 if (digester.get() != info.hash) {
532 LOG_GENERAL ("Existing frame %1 failed hash check", f);
540 Writer::check_existing_picture_mxf ()
542 /* Try to open the existing MXF */
543 boost::filesystem::path p;
544 p /= _film->internal_video_mxf_dir ();
545 p /= _film->internal_video_mxf_filename ();
546 FILE* mxf = fopen_boost (p, "rb");
548 LOG_GENERAL ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno);
553 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
559 shared_ptr<Job> job = _job.lock ();
563 job->set_progress (float (_first_nonexistant_frame) / N);
566 if (_film->three_d ()) {
567 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
570 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
574 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
579 LOG_GENERAL ("Have existing frame %1", _first_nonexistant_frame);
580 ++_first_nonexistant_frame;
586 /** @param frame Frame index.
587 * @return true if we can fake-write this frame.
590 Writer::can_fake_write (int frame) const
592 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
593 parameters in the MXF writer.
595 return (frame != 0 && frame < _first_nonexistant_frame);
599 operator< (QueueItem const & a, QueueItem const & b)
601 if (a.frame != b.frame) {
602 return a.frame < b.frame;
605 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
609 operator== (QueueItem const & a, QueueItem const & b)
611 return a.frame == b.frame && a.eyes == b.eyes;