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>
33 #include "compose.hpp"
37 #include "dcp_video_frame.h"
38 #include "dcp_content_type.h"
40 #include "audio_mapping.h"
44 #include "audio_buffers.h"
48 /* OS X strikes again */
56 using std::stringstream;
57 using boost::shared_ptr;
58 using boost::weak_ptr;
59 using boost::dynamic_pointer_cast;
61 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
63 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
66 , _first_nonexistant_frame (0)
69 , _queued_full_in_memory (0)
70 , _last_written_frame (-1)
71 , _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_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
93 _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
96 _picture_mxf->set_size (_film->frame_size ());
98 if (_film->encrypted ()) {
99 _picture_mxf->set_key (_film->key ());
102 _picture_mxf_writer = _picture_mxf->start_write (
103 _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
104 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
105 _first_nonexistant_frame > 0
108 if (_film->audio_channels ()) {
109 _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
111 if (_film->encrypted ()) {
112 _sound_mxf->set_key (_film->key ());
115 /* Write the sound MXF into the film directory so that we leave the creation
116 of the DCP directory until the last minute.
118 _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / _film->audio_mxf_filename(), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
121 _thread = new boost::thread (boost::bind (&Writer::thread, this));
123 job->sub (_("Encoding image data"));
128 terminate_thread (false);
132 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
134 boost::mutex::scoped_lock lock (_mutex);
136 while (_queued_full_in_memory > _maximum_frames_in_memory) {
137 _full_condition.wait (lock);
141 qi.type = QueueItem::FULL;
142 qi.encoded = encoded;
145 if (_film->three_d() && eyes == EYES_BOTH) {
146 /* 2D material in a 3D DCP; fake the 3D */
148 _queue.push_back (qi);
149 ++_queued_full_in_memory;
150 qi.eyes = EYES_RIGHT;
151 _queue.push_back (qi);
152 ++_queued_full_in_memory;
155 _queue.push_back (qi);
156 ++_queued_full_in_memory;
159 _empty_condition.notify_all ();
163 Writer::fake_write (int frame, Eyes eyes)
165 boost::mutex::scoped_lock lock (_mutex);
167 while (_queued_full_in_memory > _maximum_frames_in_memory) {
168 _full_condition.wait (lock);
171 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
172 dcp::FrameInfo info (ifi);
176 qi.type = QueueItem::FAKE;
179 if (_film->three_d() && eyes == EYES_BOTH) {
181 _queue.push_back (qi);
182 qi.eyes = EYES_RIGHT;
183 _queue.push_back (qi);
186 _queue.push_back (qi);
189 _empty_condition.notify_all ();
192 /** This method is not thread safe */
194 Writer::write (shared_ptr<const AudioBuffers> audio)
196 if (_sound_mxf_writer) {
197 _sound_mxf_writer->write (audio->data(), audio->frames());
201 /** This must be called from Writer::thread() with an appropriate lock held */
203 Writer::have_sequenced_image_at_queue_head ()
205 if (_queue.empty ()) {
211 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
213 if (_queue.front().eyes == EYES_BOTH) {
215 return _queue.front().frame == (_last_written_frame + 1);
220 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
224 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
237 boost::mutex::scoped_lock lock (_mutex);
241 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
245 TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
246 _empty_condition.wait (lock);
247 TIMING (N_("writer wakes with a queue of %1"), _queue.size());
250 if (_finish && _queue.empty()) {
254 /* Write any frames that we can write; i.e. those that are in sequence. */
255 while (have_sequenced_image_at_queue_head ()) {
256 QueueItem qi = _queue.front ();
258 if (qi.type == QueueItem::FULL && qi.encoded) {
259 --_queued_full_in_memory;
264 case QueueItem::FULL:
266 _film->log()->log (String::compose (N_("Writer FULL-writes %1 to MXF"), qi.frame));
268 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
271 dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
272 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
273 _last_written[qi.eyes] = qi.encoded;
277 case QueueItem::FAKE:
278 _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
279 _picture_mxf_writer->fake_write (qi.size);
280 _last_written[qi.eyes].reset ();
286 _last_written_frame = qi.frame;
287 _last_written_eyes = qi.eyes;
289 shared_ptr<Job> job = _job.lock ();
291 int64_t total = _film->length().frames (_film->video_frame_rate ());
292 if (_film->three_d ()) {
293 /* _full_written and so on are incremented for each eye, so we need to double the total
294 frames to get the correct progress.
299 job->set_progress (float (_full_written + _fake_written) / total);
303 while (_queued_full_in_memory > _maximum_frames_in_memory) {
304 /* Too many frames in memory which can't yet be written to the stream.
305 Write some FULL frames to disk.
308 /* Find one from the back of the queue */
310 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
311 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
315 assert (i != _queue.rend());
324 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
325 _last_written_frame + 1,
326 _last_written_eyes, qi.frame)
329 qi.encoded->write (_film, qi.frame, qi.eyes);
332 --_queued_full_in_memory;
335 _full_condition.notify_all ();
344 Writer::terminate_thread (bool can_throw)
346 boost::mutex::scoped_lock lock (_mutex);
352 _empty_condition.notify_all ();
353 _full_condition.notify_all ();
372 terminate_thread (true);
374 _picture_mxf_writer->finalize ();
375 if (_sound_mxf_writer) {
376 _sound_mxf_writer->finalize ();
379 /* Hard-link the video MXF into the DCP */
380 boost::filesystem::path video_from;
381 video_from /= _film->internal_video_mxf_dir();
382 video_from /= _film->internal_video_mxf_filename();
384 boost::filesystem::path video_to;
385 video_to /= _film->dir (_film->dcp_name());
386 video_to /= _film->video_mxf_filename ();
388 boost::system::error_code ec;
389 boost::filesystem::create_hard_link (video_from, video_to, ec);
391 /* hard link failed; copy instead */
392 boost::filesystem::copy_file (video_from, video_to);
393 _film->log()->log ("Hard-link failed; fell back to copying");
396 _picture_mxf->set_file (video_to);
398 /* Move the audio MXF into the DCP */
401 boost::filesystem::path audio_to;
402 audio_to /= _film->dir (_film->dcp_name ());
403 audio_to /= _film->audio_mxf_filename ();
405 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
408 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
412 _sound_mxf->set_file (audio_to);
415 dcp::DCP dcp (_film->dir (_film->dcp_name()));
417 shared_ptr<dcp::CPL> cpl (
420 _film->dcp_content_type()->libdcp_kind ()
426 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
428 shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
430 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
434 shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
436 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
441 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
442 dcp.add (_sound_mxf);
447 shared_ptr<Job> job = _job.lock ();
450 job->sub (_("Computing image digest"));
451 _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
454 job->sub (_("Computing audio digest"));
455 _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
458 dcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
459 meta.set_issue_date_now ();
461 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, _film->is_signed() ? make_signer () : shared_ptr<const dcp::Signer> ());
464 String::compose (N_("Wrote %1 FULL, %2 FAKE, %3 pushed to disk"), _full_written, _fake_written, _pushed_to_disk)
469 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
471 /* Read the frame info as written */
472 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
474 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
478 dcp::FrameInfo info (ifi);
480 if (info.size == 0) {
481 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
485 /* Read the data from the MXF and hash it */
486 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
487 EncodedData data (info.size);
488 size_t const read = fread (data.data(), 1, data.size(), mxf);
489 if (read != static_cast<size_t> (data.size ())) {
490 _film->log()->log (String::compose ("Existing frame %1 is incomplete", f));
494 string const existing_hash = md5_digest (data.data(), data.size());
495 if (existing_hash != info.hash) {
496 _film->log()->log (String::compose ("Existing frame %1 failed hash check", f));
504 Writer::check_existing_picture_mxf ()
506 /* Try to open the existing MXF */
507 boost::filesystem::path p;
508 p /= _film->internal_video_mxf_dir ();
509 p /= _film->internal_video_mxf_filename ();
510 FILE* mxf = fopen_boost (p, "rb");
512 _film->log()->log (String::compose ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno));
517 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
523 shared_ptr<Job> job = _job.lock ();
527 job->set_progress (float (_first_nonexistant_frame) / N);
530 if (_film->three_d ()) {
531 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
534 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
538 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
543 _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
544 ++_first_nonexistant_frame;
550 /** @param frame Frame index.
551 * @return true if we can fake-write this frame.
554 Writer::can_fake_write (int frame) const
556 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
557 parameters in the MXF writer.
559 return (frame != 0 && frame < _first_nonexistant_frame);
563 operator< (QueueItem const & a, QueueItem const & b)
565 if (a.frame != b.frame) {
566 return a.frame < b.frame;
569 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
573 operator== (QueueItem const & a, QueueItem const & b)
575 return a.frame == b.frame && a.eyes == b.eyes;