2 Copyright (C) 2012 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"
53 using std::stringstream;
54 using boost::shared_ptr;
55 using boost::weak_ptr;
56 using boost::dynamic_pointer_cast;
58 int const Writer::_maximum_frames_in_memory = Config::instance()->num_local_encoding_threads() + 4;
60 Writer::Writer (shared_ptr<const Film> f, weak_ptr<Job> j)
63 , _first_nonexistant_frame (0)
66 , _queued_full_in_memory (0)
67 , _last_written_frame (-1)
68 , _last_written_eyes (EYES_RIGHT)
74 /* Remove any old DCP */
75 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
77 shared_ptr<Job> job = _job.lock ();
80 job->sub (_("Checking existing image data"));
81 check_existing_picture_mxf ();
83 /* Create our picture asset in a subdirectory, named according to those
84 film's parameters which affect the video output. We will hard-link
85 it into the DCP later.
88 if (_film->three_d ()) {
89 _picture_mxf.reset (new dcp::StereoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
91 _picture_mxf.reset (new dcp::MonoPictureMXF (dcp::Fraction (_film->video_frame_rate (), 1)));
94 _picture_mxf->set_size (fit_ratio_within (_film->container()->ratio(), _film->full_frame ()));
96 if (_film->encrypted ()) {
97 _picture_mxf->set_key (_film->key ());
100 _picture_mxf_writer = _picture_mxf->start_write (
101 _film->internal_video_mxf_dir() / _film->internal_video_mxf_filename(),
102 _film->interop() ? dcp::INTEROP : dcp::SMPTE,
103 _first_nonexistant_frame > 0
106 _sound_mxf.reset (new dcp::SoundMXF (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels ()));
108 if (_film->encrypted ()) {
109 _sound_mxf->set_key (_film->key ());
112 /* Write the sound MXF into the film directory so that we leave the creation
113 of the DCP directory until the last minute.
115 _sound_mxf_writer = _sound_mxf->start_write (_film->directory() / _film->audio_mxf_filename(), _film->interop() ? dcp::INTEROP : dcp::SMPTE);
117 _thread = new boost::thread (boost::bind (&Writer::thread, this));
119 job->sub (_("Encoding image data"));
124 terminate_thread (false);
128 Writer::write (shared_ptr<const EncodedData> encoded, int frame, Eyes eyes)
130 boost::mutex::scoped_lock lock (_mutex);
132 while (_queued_full_in_memory > _maximum_frames_in_memory) {
133 _full_condition.wait (lock);
137 qi.type = QueueItem::FULL;
138 qi.encoded = encoded;
141 if (_film->three_d() && eyes == EYES_BOTH) {
142 /* 2D material in a 3D DCP; fake the 3D */
144 _queue.push_back (qi);
145 ++_queued_full_in_memory;
146 qi.eyes = EYES_RIGHT;
147 _queue.push_back (qi);
148 ++_queued_full_in_memory;
151 _queue.push_back (qi);
152 ++_queued_full_in_memory;
155 _empty_condition.notify_all ();
159 Writer::fake_write (int frame, Eyes eyes)
161 boost::mutex::scoped_lock lock (_mutex);
163 while (_queued_full_in_memory > _maximum_frames_in_memory) {
164 _full_condition.wait (lock);
167 FILE* ifi = fopen_boost (_film->info_path (frame, eyes), "r");
168 dcp::FrameInfo info (ifi);
172 qi.type = QueueItem::FAKE;
175 if (_film->three_d() && eyes == EYES_BOTH) {
177 _queue.push_back (qi);
178 qi.eyes = EYES_RIGHT;
179 _queue.push_back (qi);
182 _queue.push_back (qi);
185 _empty_condition.notify_all ();
188 /** This method is not thread safe */
190 Writer::write (shared_ptr<const AudioBuffers> audio)
192 _sound_mxf_writer->write (audio->data(), audio->frames());
195 /** This must be called from Writer::thread() with an appropriate lock held */
197 Writer::have_sequenced_image_at_queue_head ()
199 if (_queue.empty ()) {
205 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
207 if (_queue.front().eyes == EYES_BOTH) {
209 return _queue.front().frame == (_last_written_frame + 1);
214 if (_last_written_eyes == EYES_LEFT && _queue.front().frame == _last_written_frame && _queue.front().eyes == EYES_RIGHT) {
218 if (_last_written_eyes == EYES_RIGHT && _queue.front().frame == (_last_written_frame + 1) && _queue.front().eyes == EYES_LEFT) {
231 boost::mutex::scoped_lock lock (_mutex);
235 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
239 TIMING (N_("writer sleeps with a queue of %1"), _queue.size());
240 _empty_condition.wait (lock);
241 TIMING (N_("writer wakes with a queue of %1"), _queue.size());
244 if (_finish && _queue.empty()) {
248 /* Write any frames that we can write; i.e. those that are in sequence. */
249 while (have_sequenced_image_at_queue_head ()) {
250 QueueItem qi = _queue.front ();
252 if (qi.type == QueueItem::FULL && qi.encoded) {
253 --_queued_full_in_memory;
258 case QueueItem::FULL:
260 _film->log()->log (String::compose (N_("Writer FULL-writes %1 to MXF"), qi.frame));
262 qi.encoded.reset (new EncodedData (_film->j2c_path (qi.frame, qi.eyes, false)));
265 dcp::FrameInfo fin = _picture_mxf_writer->write (qi.encoded->data(), qi.encoded->size());
266 qi.encoded->write_info (_film, qi.frame, qi.eyes, fin);
267 _last_written[qi.eyes] = qi.encoded;
271 case QueueItem::FAKE:
272 _film->log()->log (String::compose (N_("Writer FAKE-writes %1 to MXF"), qi.frame));
273 _picture_mxf_writer->fake_write (qi.size);
274 _last_written[qi.eyes].reset ();
277 case QueueItem::REPEAT:
279 _film->log()->log (String::compose (N_("Writer REPEAT-writes %1 to MXF"), qi.frame));
280 dcp::FrameInfo fin = _picture_mxf_writer->write (
281 _last_written[qi.eyes]->data(),
282 _last_written[qi.eyes]->size()
285 _last_written[qi.eyes]->write_info (_film, qi.frame, qi.eyes, fin);
292 _last_written_frame = qi.frame;
293 _last_written_eyes = qi.eyes;
295 shared_ptr<Job> job = _job.lock ();
297 int64_t total = _film->length().frames (_film->video_frame_rate ());
298 if (_film->three_d ()) {
299 /* _full_written and so on are incremented for each eye, so we need to double the total
300 frames to get the correct progress.
305 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
309 while (_queued_full_in_memory > _maximum_frames_in_memory) {
310 /* Too many frames in memory which can't yet be written to the stream.
311 Write some FULL frames to disk.
314 /* Find one from the back of the queue */
316 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
317 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
321 assert (i != _queue.rend());
330 "Writer full (awaiting %1 [last eye was %2]); pushes %3 to disk",
331 _last_written_frame + 1,
332 _last_written_eyes, qi.frame)
335 qi.encoded->write (_film, qi.frame, qi.eyes);
338 --_queued_full_in_memory;
341 _full_condition.notify_all ();
350 Writer::terminate_thread (bool can_throw)
352 boost::mutex::scoped_lock lock (_mutex);
358 _empty_condition.notify_all ();
359 _full_condition.notify_all ();
378 terminate_thread (true);
380 _picture_mxf_writer->finalize ();
381 _sound_mxf_writer->finalize ();
383 /* Hard-link the video MXF into the DCP */
384 boost::filesystem::path video_from;
385 video_from /= _film->internal_video_mxf_dir();
386 video_from /= _film->internal_video_mxf_filename();
388 boost::filesystem::path video_to;
389 video_to /= _film->dir (_film->dcp_name());
390 video_to /= _film->video_mxf_filename ();
392 boost::system::error_code ec;
393 boost::filesystem::create_hard_link (video_from, video_to, ec);
395 /* hard link failed; copy instead */
396 boost::filesystem::copy_file (video_from, video_to);
397 _film->log()->log ("Hard-link failed; fell back to copying");
400 /* Move the audio MXF into the DCP */
402 boost::filesystem::path audio_to;
403 audio_to /= _film->dir (_film->dcp_name ());
404 audio_to /= _film->audio_mxf_filename ();
406 boost::filesystem::rename (_film->file (_film->audio_mxf_filename ()), audio_to, ec);
409 String::compose (_("could not move audio MXF into the DCP (%1)"), ec.value ()), _film->file (_film->audio_mxf_filename ())
413 dcp::DCP dcp (_film->dir (_film->dcp_name()));
415 shared_ptr<dcp::CPL> cpl (
418 _film->dcp_content_type()->libdcp_kind ()
424 shared_ptr<dcp::Reel> reel (new dcp::Reel ());
426 shared_ptr<dcp::MonoPictureMXF> mono = dynamic_pointer_cast<dcp::MonoPictureMXF> (_picture_mxf);
428 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelMonoPictureAsset (mono, 0)));
431 shared_ptr<dcp::StereoPictureMXF> stereo = dynamic_pointer_cast<dcp::StereoPictureMXF> (_picture_mxf);
433 reel->add (shared_ptr<dcp::ReelPictureAsset> (new dcp::ReelStereoPictureAsset (stereo, 0)));
436 reel->add (shared_ptr<dcp::ReelSoundAsset> (new dcp::ReelSoundAsset (_sound_mxf, 0)));
440 shared_ptr<Job> job = _job.lock ();
443 job->sub (_("Computing image digest"));
444 _picture_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
446 job->sub (_("Computing audio digest"));
447 _sound_mxf->hash (boost::bind (&Job::set_progress, job.get(), _1, false));
449 dcp::XMLMetadata meta = Config::instance()->dcp_metadata ();
450 meta.set_issue_date_now ();
451 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, _film->is_signed() ? make_signer () : shared_ptr<const dcp::Signer> ());
454 String::compose (N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT; %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk)
458 /** Tell the writer that frame `f' should be a repeat of the frame before it */
460 Writer::repeat (int f, Eyes e)
462 boost::mutex::scoped_lock lock (_mutex);
464 while (_queued_full_in_memory > _maximum_frames_in_memory) {
465 _full_condition.wait (lock);
469 qi.type = QueueItem::REPEAT;
471 if (_film->three_d() && e == EYES_BOTH) {
473 _queue.push_back (qi);
474 qi.eyes = EYES_RIGHT;
475 _queue.push_back (qi);
478 _queue.push_back (qi);
481 _empty_condition.notify_all ();
485 Writer::check_existing_picture_mxf_frame (FILE* mxf, int f, Eyes eyes)
487 /* Read the frame info as written */
488 FILE* ifi = fopen_boost (_film->info_path (f, eyes), "r");
490 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
494 dcp::FrameInfo info (ifi);
496 if (info.size == 0) {
497 _film->log()->log (String::compose ("Existing frame %1 has no info file", f));
501 /* Read the data from the MXF and hash it */
502 dcpomatic_fseek (mxf, info.offset, SEEK_SET);
503 EncodedData data (info.size);
504 size_t const read = fread (data.data(), 1, data.size(), mxf);
505 if (read != static_cast<size_t> (data.size ())) {
506 _film->log()->log (String::compose ("Existing frame %1 is incomplete", f));
510 string const existing_hash = md5_digest (data.data(), data.size());
511 if (existing_hash != info.hash) {
512 _film->log()->log (String::compose ("Existing frame %1 failed hash check", f));
520 Writer::check_existing_picture_mxf ()
522 /* Try to open the existing MXF */
523 boost::filesystem::path p;
524 p /= _film->internal_video_mxf_dir ();
525 p /= _film->internal_video_mxf_filename ();
526 FILE* mxf = fopen_boost (p, "rb");
528 _film->log()->log (String::compose ("Could not open existing MXF at %1 (errno=%2)", p.string(), errno));
533 for (boost::filesystem::directory_iterator i (_film->info_dir ()); i != boost::filesystem::directory_iterator (); ++i) {
539 shared_ptr<Job> job = _job.lock ();
543 job->set_progress (float (_first_nonexistant_frame) / N);
546 if (_film->three_d ()) {
547 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_LEFT)) {
550 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_RIGHT)) {
554 if (!check_existing_picture_mxf_frame (mxf, _first_nonexistant_frame, EYES_BOTH)) {
559 _film->log()->log (String::compose ("Have existing frame %1", _first_nonexistant_frame));
560 ++_first_nonexistant_frame;
566 /** @param frame Frame index.
567 * @return true if we can fake-write this frame.
570 Writer::can_fake_write (int frame) const
572 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
573 parameters in the MXF writer.
575 return (frame != 0 && frame < _first_nonexistant_frame);
579 operator< (QueueItem const & a, QueueItem const & b)
581 if (a.frame != b.frame) {
582 return a.frame < b.frame;
585 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
589 operator== (QueueItem const & a, QueueItem const & b)
591 return a.frame == b.frame && a.eyes == b.eyes;