2 Copyright (C) 2012-2017 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 some 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 /* The audio we get might span a reel boundary, and if so we have to write it in bits */
242 while (offset < audio->frames ()) {
244 if (_audio_reel == _reels.end ()) {
245 /* This audio is off the end of the last reel; ignore it */
249 int32_t const this_time = min (
250 audio->frames() - offset,
251 (int32_t) (_audio_reel->period().duration().frames_floor(_film->audio_frame_rate()) - _audio_reel->total_written_audio_frames())
254 if (this_time == audio->frames()) {
255 /* Easy case: we can write all the audio to this reel */
256 _audio_reel->write (audio);
258 /* Write the part we can */
259 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), this_time));
260 part->copy_from (audio.get(), this_time, offset, 0);
261 _audio_reel->write (part);
269 /** This must be called from Writer::thread() with an appropriate lock held */
271 Writer::have_sequenced_image_at_queue_head ()
273 if (_queue.empty ()) {
279 QueueItem const & f = _queue.front();
280 ReelWriter const & reel = _reels[f.reel];
282 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
284 if (f.eyes == EYES_BOTH) {
286 return f.frame == (reel.last_written_video_frame() + 1);
291 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
295 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
308 boost::mutex::scoped_lock lock (_state_mutex);
312 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
313 /* We've got something to do: go and do it */
317 /* Nothing to do: wait until something happens which may indicate that we do */
318 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
319 _empty_condition.wait (lock);
320 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
323 if (_finish && _queue.empty()) {
327 /* We stop here if we have been asked to finish, and if either the queue
328 is empty or we do not have a sequenced image at its head (if this is the
329 case we will never terminate as no new frames will be sent once
332 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
333 /* (Hopefully temporarily) log anything that was not written */
334 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
335 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
336 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
337 if (i->type == QueueItem::FULL) {
338 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
340 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
347 /* Write any frames that we can write; i.e. those that are in sequence. */
348 while (have_sequenced_image_at_queue_head ()) {
349 QueueItem qi = _queue.front ();
351 if (qi.type == QueueItem::FULL && qi.encoded) {
352 --_queued_full_in_memory;
357 ReelWriter& reel = _reels[qi.reel];
360 case QueueItem::FULL:
361 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
363 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
365 reel.write (qi.encoded, qi.frame, qi.eyes);
368 case QueueItem::FAKE:
369 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
370 reel.fake_write (qi.frame, qi.eyes, qi.size);
373 case QueueItem::REPEAT:
374 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
375 reel.repeat_write (qi.frame, qi.eyes);
383 while (_queued_full_in_memory > _maximum_frames_in_memory) {
384 /* Too many frames in memory which can't yet be written to the stream.
385 Write some FULL frames to disk.
388 /* Find one from the back of the queue */
390 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
391 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
395 DCPOMATIC_ASSERT (i != _queue.rend());
397 /* For the log message below */
398 int const awaiting = _reels[_queue.front().reel].last_written_video_frame();
401 /* i is valid here, even though we don't hold a lock on the mutex,
402 since list iterators are unaffected by insertion and only this
403 thread could erase the last item in the list.
406 LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
408 i->encoded->write_via_temp (
409 _film->j2c_path (i->reel, i->frame, i->eyes, true),
410 _film->j2c_path (i->reel, i->frame, i->eyes, false)
415 --_queued_full_in_memory;
418 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
419 _full_condition.notify_all ();
428 Writer::terminate_thread (bool can_throw)
430 boost::mutex::scoped_lock lock (_state_mutex);
436 _empty_condition.notify_all ();
437 _full_condition.notify_all ();
440 if (_thread->joinable ()) {
459 LOG_GENERAL_NC ("Terminating writer thread");
461 terminate_thread (true);
463 LOG_GENERAL_NC ("Finishing ReelWriters");
465 BOOST_FOREACH (ReelWriter& i, _reels) {
469 LOG_GENERAL_NC ("Writing XML");
471 dcp::DCP dcp (_film->dir (_film->dcp_name()));
473 shared_ptr<dcp::CPL> cpl (
476 _film->dcp_content_type()->libdcp_kind ()
482 /* Calculate digests for each reel in parallel */
484 shared_ptr<Job> job = _job.lock ();
485 job->sub (_("Computing digests"));
487 boost::asio::io_service service;
488 boost::thread_group pool;
490 shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
492 int const threads = max (1, Config::instance()->master_encoding_threads ());
494 for (int i = 0; i < threads; ++i) {
495 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
498 BOOST_FOREACH (ReelWriter& i, _reels) {
499 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
500 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
507 /* Add reels to CPL */
509 BOOST_FOREACH (ReelWriter& i, _reels) {
510 cpl->add (i.create_reel (_reel_assets, _fonts));
513 dcp::XMLMetadata meta;
514 meta.annotation_text = cpl->annotation_text ();
515 meta.creator = Config::instance()->dcp_creator ();
516 if (meta.creator.empty ()) {
517 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
519 meta.issuer = Config::instance()->dcp_issuer ();
520 if (meta.issuer.empty ()) {
521 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
523 meta.set_issue_date_now ();
525 cpl->set_metadata (meta);
527 shared_ptr<const dcp::CertificateChain> signer;
528 if (_film->is_signed ()) {
529 signer = Config::instance()->signer_chain ();
530 /* We did check earlier, but check again here to be on the safe side */
532 if (!signer->valid (&reason)) {
533 throw InvalidSignerError (reason);
537 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
540 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
543 write_cover_sheet ();
547 Writer::write_cover_sheet ()
549 boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt");
550 FILE* f = fopen_boost (cover, "w");
552 throw OpenFileError (cover, errno, false);
555 string text = Config::instance()->cover_sheet ();
556 boost::algorithm::replace_all (text, "$CPL_NAME", _film->name());
557 boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name());
558 boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->nickname());
560 pair<int, int> ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels());
561 string description = String::compose("%1.%2", ch.first, ch.second);
563 if (description == "0.0") {
564 description = _("None");
565 } else if (description == "1.0") {
566 description = _("Mono");
567 } else if (description == "2.0") {
568 description = _("Stereo");
570 boost::algorithm::replace_all (text, "$AUDIO", description);
573 _film->length().split (_film->video_frame_rate(), h, m, s, fr);
575 if (h == 0 && m == 0) {
576 length = String::compose("%1s", s);
577 } else if (h == 0 && m > 0) {
578 length = String::compose("%1m%2s", m, s);
579 } else if (h > 0 && m > 0) {
580 length = String::compose("%1h%2m%3s", h, m, s);
583 boost::algorithm::replace_all (text, "$LENGTH", length);
585 fwrite (text.c_str(), 1, text.length(), f);
589 /** @param frame Frame index within the whole DCP.
590 * @return true if we can fake-write this frame.
593 Writer::can_fake_write (Frame frame) const
595 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
596 parameters in the asset writer.
599 ReelWriter const & reel = _reels[video_reel(frame)];
601 /* Make frame relative to the start of the reel */
602 frame -= reel.start ();
603 return (frame != 0 && frame < reel.first_nonexistant_frame());
607 Writer::write (PlayerSubtitles subs, DCPTimePeriod period)
609 if (subs.text.empty ()) {
613 if (_subtitle_reel->period().to <= period.from) {
617 _subtitle_reel->write (subs);
621 Writer::write (list<shared_ptr<Font> > fonts)
623 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
625 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
627 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
634 _fonts.push_back (i);
640 operator< (QueueItem const & a, QueueItem const & b)
642 if (a.reel != b.reel) {
643 return a.reel < b.reel;
646 if (a.frame != b.frame) {
647 return a.frame < b.frame;
650 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
654 operator== (QueueItem const & a, QueueItem const & b)
656 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
660 Writer::set_encoder_threads (int threads)
662 /* I think the scaling factor here should be the ratio of the longest frame
663 encode time to the shortest; if the thread count is T, longest time is L
664 and the shortest time S we could encode L/S frames per thread whilst waiting
665 for the L frame to encode so we might have to store LT/S frames.
667 However we don't want to use too much memory, so keep it a bit lower than we'd
668 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
669 use about 240Mb with 72 encoding threads.
671 _maximum_frames_in_memory = lrint (threads * 3);
675 Writer::write (ReferencedReelAsset asset)
677 _reel_assets.push_back (asset);
681 Writer::video_reel (int frame) const
683 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
685 while (i < _reels.size() && !_reels[i].period().contains (t)) {
689 DCPOMATIC_ASSERT (i < _reels.size ());
694 Writer::set_digest_progress (Job* job, float progress)
696 /* I believe this is thread-safe */
697 _digest_progresses[boost::this_thread::get_id()] = progress;
699 boost::mutex::scoped_lock lm (_digest_progresses_mutex);
700 float min_progress = FLT_MAX;
701 for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
702 min_progress = min (min_progress, i->second);
705 job->set_progress (min_progress);