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>
45 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
46 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
47 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
48 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
49 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
50 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
51 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
53 /* OS X strikes again */
64 using boost::shared_ptr;
65 using boost::weak_ptr;
66 using boost::dynamic_pointer_cast;
69 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
74 , _queued_full_in_memory (0)
75 , _maximum_frames_in_memory (0)
81 /* Remove any old DCP */
82 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
84 shared_ptr<Job> job = _job.lock ();
85 DCPOMATIC_ASSERT (job);
88 list<DCPTimePeriod> const reels = _film->reels ();
89 BOOST_FOREACH (DCPTimePeriod p, reels) {
90 _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p)));
93 /* We can keep track of the current audio and subtitle reels easily because audio
94 and subs arrive to the Writer in sequence. This is not so for video.
96 _audio_reel = _reels.begin ();
97 _subtitle_reel = _reels.begin ();
99 /* Check that the signer is OK if we need one */
100 if (_film->is_signed() && !Config::instance()->signer_chain()->valid ()) {
101 throw InvalidSignerError ();
108 _thread = new boost::thread (boost::bind (&Writer::thread, this));
113 terminate_thread (false);
116 /** Pass a video frame to the writer for writing to disk at some point.
117 * This method can be called with frames out of order.
118 * @param encoded JPEG2000-encoded data.
119 * @param frame Frame index within the DCP.
120 * @param eyes Eyes that this frame image is for.
123 Writer::write (Data encoded, Frame frame, Eyes eyes)
125 boost::mutex::scoped_lock lock (_state_mutex);
127 while (_queued_full_in_memory > _maximum_frames_in_memory) {
128 /* The queue is too big; wait until that is sorted out */
129 _full_condition.wait (lock);
133 qi.type = QueueItem::FULL;
134 qi.encoded = encoded;
135 qi.reel = video_reel (frame);
136 qi.frame = frame - _reels[qi.reel].start ();
138 if (_film->three_d() && eyes == EYES_BOTH) {
139 /* 2D material in a 3D DCP; fake the 3D */
141 _queue.push_back (qi);
142 ++_queued_full_in_memory;
143 qi.eyes = EYES_RIGHT;
144 _queue.push_back (qi);
145 ++_queued_full_in_memory;
148 _queue.push_back (qi);
149 ++_queued_full_in_memory;
152 /* Now there's something to do: wake anything wait()ing on _empty_condition */
153 _empty_condition.notify_all ();
157 Writer::can_repeat (Frame frame) const
159 return frame > _reels[video_reel(frame)].start();
162 /** Repeat the last frame that was written to a reel as a new frame.
163 * @param frame Frame index within the DCP of the new (repeated) frame.
164 * @param eyes Eyes that this repeated frame image is for.
167 Writer::repeat (Frame frame, Eyes eyes)
169 boost::mutex::scoped_lock lock (_state_mutex);
171 while (_queued_full_in_memory > _maximum_frames_in_memory) {
172 /* The queue is too big; wait until that is sorted out */
173 _full_condition.wait (lock);
177 qi.type = QueueItem::REPEAT;
178 qi.reel = video_reel (frame);
179 qi.frame = frame - _reels[qi.reel].start ();
180 if (_film->three_d() && eyes == EYES_BOTH) {
182 _queue.push_back (qi);
183 qi.eyes = EYES_RIGHT;
184 _queue.push_back (qi);
187 _queue.push_back (qi);
190 /* Now there's something to do: wake anything wait()ing on _empty_condition */
191 _empty_condition.notify_all ();
195 Writer::fake_write (Frame frame, Eyes eyes)
197 boost::mutex::scoped_lock lock (_state_mutex);
199 while (_queued_full_in_memory > _maximum_frames_in_memory) {
200 /* The queue is too big; wait until that is sorted out */
201 _full_condition.wait (lock);
204 size_t const reel = video_reel (frame);
205 Frame const reel_frame = frame - _reels[reel].start ();
207 FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
209 throw ReadFileError (_film->info_file(_reels[reel].period()));
211 dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
215 qi.type = QueueItem::FAKE;
218 qi.frame = reel_frame;
219 if (_film->three_d() && eyes == EYES_BOTH) {
221 _queue.push_back (qi);
222 qi.eyes = EYES_RIGHT;
223 _queue.push_back (qi);
226 _queue.push_back (qi);
229 /* Now there's something to do: wake anything wait()ing on _empty_condition */
230 _empty_condition.notify_all ();
233 /** Write one video frame's worth of audio frames to the DCP.
234 * @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
235 * This method is not thread safe.
238 Writer::write (shared_ptr<const AudioBuffers> audio)
240 if (_audio_reel == _reels.end ()) {
241 /* This audio is off the end of the last reel; ignore it */
245 _audio_reel->write (audio);
247 /* written is in video frames, not audio frames */
248 if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
253 /** This must be called from Writer::thread() with an appropriate lock held */
255 Writer::have_sequenced_image_at_queue_head ()
257 if (_queue.empty ()) {
263 QueueItem const & f = _queue.front();
264 ReelWriter const & reel = _reels[f.reel];
266 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
268 if (f.eyes == EYES_BOTH) {
270 return f.frame == (reel.last_written_video_frame() + 1);
275 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
279 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
292 boost::mutex::scoped_lock lock (_state_mutex);
296 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
297 /* We've got something to do: go and do it */
301 /* Nothing to do: wait until something happens which may indicate that we do */
302 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
303 _empty_condition.wait (lock);
304 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
307 if (_finish && _queue.empty()) {
311 /* We stop here if we have been asked to finish, and if either the queue
312 is empty or we do not have a sequenced image at its head (if this is the
313 case we will never terminate as no new frames will be sent once
316 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
317 /* (Hopefully temporarily) log anything that was not written */
318 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
319 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
320 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
321 if (i->type == QueueItem::FULL) {
322 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
324 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
331 /* Write any frames that we can write; i.e. those that are in sequence. */
332 while (have_sequenced_image_at_queue_head ()) {
333 QueueItem qi = _queue.front ();
335 if (qi.type == QueueItem::FULL && qi.encoded) {
336 --_queued_full_in_memory;
341 ReelWriter& reel = _reels[qi.reel];
344 case QueueItem::FULL:
345 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
347 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
349 reel.write (qi.encoded, qi.frame, qi.eyes);
352 case QueueItem::FAKE:
353 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
354 reel.fake_write (qi.frame, qi.eyes, qi.size);
357 case QueueItem::REPEAT:
358 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
359 reel.repeat_write (qi.frame, qi.eyes);
367 while (_queued_full_in_memory > _maximum_frames_in_memory) {
368 /* Too many frames in memory which can't yet be written to the stream.
369 Write some FULL frames to disk.
372 /* Find one from the back of the queue */
374 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
375 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
379 DCPOMATIC_ASSERT (i != _queue.rend());
383 /* i is valid here, even though we don't hold a lock on the mutex,
384 since list iterators are unaffected by insertion and only this
385 thread could erase the last item in the list.
388 LOG_GENERAL ("Writer full; pushes %1 to disk", i->frame);
390 i->encoded->write_via_temp (
391 _film->j2c_path (i->reel, i->frame, i->eyes, true),
392 _film->j2c_path (i->reel, i->frame, i->eyes, false)
397 --_queued_full_in_memory;
400 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
401 _full_condition.notify_all ();
410 Writer::terminate_thread (bool can_throw)
412 boost::mutex::scoped_lock lock (_state_mutex);
418 _empty_condition.notify_all ();
419 _full_condition.notify_all ();
422 if (_thread->joinable ()) {
441 LOG_GENERAL_NC ("Terminating writer thread");
443 terminate_thread (true);
445 LOG_GENERAL_NC ("Finishing ReelWriters");
447 BOOST_FOREACH (ReelWriter& i, _reels) {
451 LOG_GENERAL_NC ("Writing XML");
453 dcp::DCP dcp (_film->dir (_film->dcp_name()));
455 shared_ptr<dcp::CPL> cpl (
458 _film->dcp_content_type()->libdcp_kind ()
464 /* Calculate digests for each reel in parallel */
466 shared_ptr<Job> job = _job.lock ();
467 job->sub (_("Computing digests"));
469 boost::asio::io_service service;
470 boost::thread_group pool;
472 shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
474 int const threads = max (1, Config::instance()->num_local_encoding_threads ());
476 for (int i = 0; i < threads; ++i) {
477 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
480 BOOST_FOREACH (ReelWriter& i, _reels) {
481 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
482 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
489 /* Add reels to CPL */
491 BOOST_FOREACH (ReelWriter& i, _reels) {
492 cpl->add (i.create_reel (_reel_assets, _fonts));
495 dcp::XMLMetadata meta;
496 meta.creator = Config::instance()->dcp_creator ();
497 if (meta.creator.empty ()) {
498 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
500 meta.issuer = Config::instance()->dcp_issuer ();
501 if (meta.issuer.empty ()) {
502 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
504 meta.set_issue_date_now ();
506 cpl->set_metadata (meta);
508 shared_ptr<const dcp::CertificateChain> signer;
509 if (_film->is_signed ()) {
510 signer = Config::instance()->signer_chain ();
511 /* We did check earlier, but check again here to be on the safe side */
512 if (!signer->valid ()) {
513 throw InvalidSignerError ();
517 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
520 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
524 /** @param frame Frame index within the whole DCP.
525 * @return true if we can fake-write this frame.
528 Writer::can_fake_write (Frame frame) const
530 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
531 parameters in the asset writer.
534 ReelWriter const & reel = _reels[video_reel(frame)];
536 /* Make frame relative to the start of the reel */
537 frame -= reel.start ();
538 return (frame != 0 && frame < reel.first_nonexistant_frame());
542 Writer::write (PlayerSubtitles subs)
544 if (subs.text.empty ()) {
548 if (_subtitle_reel->period().to <= subs.from) {
552 _subtitle_reel->write (subs);
556 Writer::write (list<shared_ptr<Font> > fonts)
558 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
560 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
562 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
569 _fonts.push_back (i);
575 operator< (QueueItem const & a, QueueItem const & b)
577 if (a.reel != b.reel) {
578 return a.reel < b.reel;
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.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
595 Writer::set_encoder_threads (int threads)
597 /* I think the scaling factor here should be the ratio of the longest frame
598 encode time to the shortest; if the thread count is T, longest time is L
599 and the shortest time S we could encode L/S frames per thread whilst waiting
600 for the L frame to encode so we might have to store LT/S frames.
602 However we don't want to use too much memory, so keep it a bit lower than we'd
603 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
604 use about 240Mb with 72 encoding threads.
606 _maximum_frames_in_memory = lrint (threads * 3);
610 Writer::write (ReferencedReelAsset asset)
612 _reel_assets.push_back (asset);
616 Writer::video_reel (int frame) const
618 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
620 while (i < _reels.size() && !_reels[i].period().contains (t)) {
624 DCPOMATIC_ASSERT (i < _reels.size ());
629 Writer::set_digest_progress (Job* job, float progress)
631 /* I believe this is thread-safe */
632 _digest_progresses[boost::this_thread::get_id()] = progress;
634 boost::mutex::scoped_lock lm (_digest_progresses_mutex);
635 float min_progress = 0;
636 for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
637 min_progress = min (min_progress, i->second);
640 job->set_progress (min_progress);