2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "compose.hpp"
26 #include "dcp_video.h"
27 #include "dcp_content_type.h"
28 #include "audio_mapping.h"
32 #include "audio_buffers.h"
36 #include "reel_writer.h"
38 #include <boost/foreach.hpp>
46 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
47 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
48 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
49 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
50 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
51 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
52 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
54 /* OS X strikes again */
65 using boost::shared_ptr;
66 using boost::weak_ptr;
67 using boost::dynamic_pointer_cast;
70 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
75 , _queued_full_in_memory (0)
76 , _maximum_frames_in_memory (0)
82 shared_ptr<Job> job = _job.lock ();
83 DCPOMATIC_ASSERT (job);
86 list<DCPTimePeriod> const reels = _film->reels ();
87 BOOST_FOREACH (DCPTimePeriod p, reels) {
88 _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p)));
91 /* We can keep track of the current audio and subtitle reels easily because audio
92 and subs arrive to the Writer in sequence. This is not so for video.
94 _audio_reel = _reels.begin ();
95 _subtitle_reel = _reels.begin ();
97 /* Check that the signer is OK if we need one */
99 if (_film->is_signed() && !Config::instance()->signer_chain()->valid(&reason)) {
100 throw InvalidSignerError (reason);
107 _thread = new boost::thread (boost::bind (&Writer::thread, this));
112 terminate_thread (false);
115 /** Pass a video frame to the writer for writing to disk at some point.
116 * This method can be called with frames out of order.
117 * @param encoded JPEG2000-encoded data.
118 * @param frame Frame index within the DCP.
119 * @param eyes Eyes that this frame image is for.
122 Writer::write (Data encoded, Frame frame, Eyes eyes)
124 boost::mutex::scoped_lock lock (_state_mutex);
126 while (_queued_full_in_memory > _maximum_frames_in_memory) {
127 /* The queue is too big; wait until that is sorted out */
128 _full_condition.wait (lock);
132 qi.type = QueueItem::FULL;
133 qi.encoded = encoded;
134 qi.reel = video_reel (frame);
135 qi.frame = frame - _reels[qi.reel].start ();
137 if (_film->three_d() && eyes == EYES_BOTH) {
138 /* 2D material in a 3D DCP; fake the 3D */
140 _queue.push_back (qi);
141 ++_queued_full_in_memory;
142 qi.eyes = EYES_RIGHT;
143 _queue.push_back (qi);
144 ++_queued_full_in_memory;
147 _queue.push_back (qi);
148 ++_queued_full_in_memory;
151 /* Now there's something to do: wake anything wait()ing on _empty_condition */
152 _empty_condition.notify_all ();
156 Writer::can_repeat (Frame frame) const
158 return frame > _reels[video_reel(frame)].start();
161 /** Repeat the last frame that was written to a reel as a new frame.
162 * @param frame Frame index within the DCP of the new (repeated) frame.
163 * @param eyes Eyes that this repeated frame image is for.
166 Writer::repeat (Frame frame, Eyes eyes)
168 boost::mutex::scoped_lock lock (_state_mutex);
170 while (_queued_full_in_memory > _maximum_frames_in_memory) {
171 /* The queue is too big; wait until that is sorted out */
172 _full_condition.wait (lock);
176 qi.type = QueueItem::REPEAT;
177 qi.reel = video_reel (frame);
178 qi.frame = frame - _reels[qi.reel].start ();
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 /* Now there's something to do: wake anything wait()ing on _empty_condition */
190 _empty_condition.notify_all ();
194 Writer::fake_write (Frame frame, Eyes eyes)
196 boost::mutex::scoped_lock lock (_state_mutex);
198 while (_queued_full_in_memory > _maximum_frames_in_memory) {
199 /* The queue is too big; wait until that is sorted out */
200 _full_condition.wait (lock);
203 size_t const reel = video_reel (frame);
204 Frame const reel_frame = frame - _reels[reel].start ();
206 FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
208 throw ReadFileError (_film->info_file(_reels[reel].period()));
210 dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
214 qi.type = QueueItem::FAKE;
217 qi.frame = reel_frame;
218 if (_film->three_d() && eyes == EYES_BOTH) {
220 _queue.push_back (qi);
221 qi.eyes = EYES_RIGHT;
222 _queue.push_back (qi);
225 _queue.push_back (qi);
228 /* Now there's something to do: wake anything wait()ing on _empty_condition */
229 _empty_condition.notify_all ();
232 /** Write one video frame's worth of audio frames to the DCP.
233 * @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
234 * This method is not thread safe.
237 Writer::write (shared_ptr<const AudioBuffers> audio)
239 if (_audio_reel == _reels.end ()) {
240 /* This audio is off the end of the last reel; ignore it */
244 _audio_reel->write (audio);
246 /* written is in video frames, not audio frames */
247 if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
252 /** This must be called from Writer::thread() with an appropriate lock held */
254 Writer::have_sequenced_image_at_queue_head ()
256 if (_queue.empty ()) {
262 QueueItem const & f = _queue.front();
263 ReelWriter const & reel = _reels[f.reel];
265 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
267 if (f.eyes == EYES_BOTH) {
269 return f.frame == (reel.last_written_video_frame() + 1);
274 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
278 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
291 boost::mutex::scoped_lock lock (_state_mutex);
295 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
296 /* We've got something to do: go and do it */
300 /* Nothing to do: wait until something happens which may indicate that we do */
301 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
302 _empty_condition.wait (lock);
303 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
306 if (_finish && _queue.empty()) {
310 /* We stop here if we have been asked to finish, and if either the queue
311 is empty or we do not have a sequenced image at its head (if this is the
312 case we will never terminate as no new frames will be sent once
315 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
316 /* (Hopefully temporarily) log anything that was not written */
317 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
318 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
319 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
320 if (i->type == QueueItem::FULL) {
321 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
323 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
330 /* Write any frames that we can write; i.e. those that are in sequence. */
331 while (have_sequenced_image_at_queue_head ()) {
332 QueueItem qi = _queue.front ();
334 if (qi.type == QueueItem::FULL && qi.encoded) {
335 --_queued_full_in_memory;
340 ReelWriter& reel = _reels[qi.reel];
343 case QueueItem::FULL:
344 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
346 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
348 reel.write (qi.encoded, qi.frame, qi.eyes);
351 case QueueItem::FAKE:
352 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
353 reel.fake_write (qi.frame, qi.eyes, qi.size);
356 case QueueItem::REPEAT:
357 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
358 reel.repeat_write (qi.frame, qi.eyes);
366 while (_queued_full_in_memory > _maximum_frames_in_memory) {
367 /* Too many frames in memory which can't yet be written to the stream.
368 Write some FULL frames to disk.
371 /* Find one from the back of the queue */
373 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
374 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
378 DCPOMATIC_ASSERT (i != _queue.rend());
380 /* For the log message below */
381 int const awaiting = _reels[_queue.front().reel].last_written_video_frame();
384 /* i is valid here, even though we don't hold a lock on the mutex,
385 since list iterators are unaffected by insertion and only this
386 thread could erase the last item in the list.
389 LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
391 i->encoded->write_via_temp (
392 _film->j2c_path (i->reel, i->frame, i->eyes, true),
393 _film->j2c_path (i->reel, i->frame, i->eyes, false)
398 --_queued_full_in_memory;
401 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
402 _full_condition.notify_all ();
411 Writer::terminate_thread (bool can_throw)
413 boost::mutex::scoped_lock lock (_state_mutex);
419 _empty_condition.notify_all ();
420 _full_condition.notify_all ();
423 if (_thread->joinable ()) {
442 LOG_GENERAL_NC ("Terminating writer thread");
444 terminate_thread (true);
446 LOG_GENERAL_NC ("Finishing ReelWriters");
448 BOOST_FOREACH (ReelWriter& i, _reels) {
452 LOG_GENERAL_NC ("Writing XML");
454 dcp::DCP dcp (_film->dir (_film->dcp_name()));
456 shared_ptr<dcp::CPL> cpl (
459 _film->dcp_content_type()->libdcp_kind ()
465 /* Calculate digests for each reel in parallel */
467 shared_ptr<Job> job = _job.lock ();
468 job->sub (_("Computing digests"));
470 boost::asio::io_service service;
471 boost::thread_group pool;
473 shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
475 int const threads = max (1, Config::instance()->num_local_encoding_threads ());
477 for (int i = 0; i < threads; ++i) {
478 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
481 BOOST_FOREACH (ReelWriter& i, _reels) {
482 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
483 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
490 /* Add reels to CPL */
492 BOOST_FOREACH (ReelWriter& i, _reels) {
493 cpl->add (i.create_reel (_reel_assets, _fonts));
496 dcp::XMLMetadata meta;
497 meta.annotation_text = cpl->annotation_text ();
498 meta.creator = Config::instance()->dcp_creator ();
499 if (meta.creator.empty ()) {
500 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
502 meta.issuer = Config::instance()->dcp_issuer ();
503 if (meta.issuer.empty ()) {
504 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
506 meta.set_issue_date_now ();
508 cpl->set_metadata (meta);
510 shared_ptr<const dcp::CertificateChain> signer;
511 if (_film->is_signed ()) {
512 signer = Config::instance()->signer_chain ();
513 /* We did check earlier, but check again here to be on the safe side */
515 if (!signer->valid (&reason)) {
516 throw InvalidSignerError (reason);
520 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
523 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
527 /** @param frame Frame index within the whole DCP.
528 * @return true if we can fake-write this frame.
531 Writer::can_fake_write (Frame frame) const
533 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
534 parameters in the asset writer.
537 ReelWriter const & reel = _reels[video_reel(frame)];
539 /* Make frame relative to the start of the reel */
540 frame -= reel.start ();
541 return (frame != 0 && frame < reel.first_nonexistant_frame());
545 Writer::write (PlayerSubtitles subs)
547 if (subs.text.empty ()) {
551 if (_subtitle_reel->period().to <= subs.period.from) {
555 _subtitle_reel->write (subs);
559 Writer::write (list<shared_ptr<Font> > fonts)
561 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
563 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
565 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
572 _fonts.push_back (i);
578 operator< (QueueItem const & a, QueueItem const & b)
580 if (a.reel != b.reel) {
581 return a.reel < b.reel;
584 if (a.frame != b.frame) {
585 return a.frame < b.frame;
588 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
592 operator== (QueueItem const & a, QueueItem const & b)
594 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
598 Writer::set_encoder_threads (int threads)
600 /* I think the scaling factor here should be the ratio of the longest frame
601 encode time to the shortest; if the thread count is T, longest time is L
602 and the shortest time S we could encode L/S frames per thread whilst waiting
603 for the L frame to encode so we might have to store LT/S frames.
605 However we don't want to use too much memory, so keep it a bit lower than we'd
606 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
607 use about 240Mb with 72 encoding threads.
609 _maximum_frames_in_memory = lrint (threads * 3);
613 Writer::write (ReferencedReelAsset asset)
615 _reel_assets.push_back (asset);
619 Writer::video_reel (int frame) const
621 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
623 while (i < _reels.size() && !_reels[i].period().contains (t)) {
627 DCPOMATIC_ASSERT (i < _reels.size ());
632 Writer::set_digest_progress (Job* job, float progress)
634 /* I believe this is thread-safe */
635 _digest_progresses[boost::this_thread::get_id()] = progress;
637 boost::mutex::scoped_lock lm (_digest_progresses_mutex);
638 float min_progress = FLT_MAX;
639 for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
640 min_progress = min (min_progress, i->second);
643 job->set_progress (min_progress);