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 <dcp/locale_convert.h>
39 #include <boost/foreach.hpp>
47 #define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
48 #define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
49 #define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE);
50 #define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING);
51 #define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING);
52 #define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING);
53 #define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
55 /* OS X strikes again */
66 using boost::shared_ptr;
67 using boost::weak_ptr;
68 using boost::dynamic_pointer_cast;
71 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
76 , _queued_full_in_memory (0)
77 , _maximum_frames_in_memory (0)
83 shared_ptr<Job> job = _job.lock ();
84 DCPOMATIC_ASSERT (job);
87 list<DCPTimePeriod> const reels = _film->reels ();
88 BOOST_FOREACH (DCPTimePeriod p, reels) {
89 _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p)));
92 /* We can keep track of the current audio and subtitle reels easily because audio
93 and subs arrive to the Writer in sequence. This is not so for video.
95 _audio_reel = _reels.begin ();
96 _subtitle_reel = _reels.begin ();
98 /* Check that the signer is OK if we need one */
100 if (_film->is_signed() && !Config::instance()->signer_chain()->valid(&reason)) {
101 throw InvalidSignerError (reason);
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 some 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 /* The audio we get might span a reel boundary, and if so we have to write it in bits */
243 while (offset < audio->frames ()) {
245 if (_audio_reel == _reels.end ()) {
246 /* This audio is off the end of the last reel; ignore it */
250 int32_t const remaining = audio->frames() - offset;
251 int32_t const reel_space = _audio_reel->period().duration().frames_floor(_film->audio_frame_rate()) - _audio_reel->total_written_audio_frames();
253 if (remaining <= reel_space) {
254 /* Easy case: we can write all the audio to this reel */
255 _audio_reel->write (audio);
258 /* Write the part we can */
259 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), reel_space));
260 part->copy_from (audio.get(), reel_space, offset, 0);
261 _audio_reel->write (part);
263 offset += reel_space;
268 /** This must be called from Writer::thread() with an appropriate lock held */
270 Writer::have_sequenced_image_at_queue_head ()
272 if (_queue.empty ()) {
278 QueueItem const & f = _queue.front();
279 ReelWriter const & reel = _reels[f.reel];
281 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
283 if (f.eyes == EYES_BOTH) {
285 return f.frame == (reel.last_written_video_frame() + 1);
290 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
294 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
307 boost::mutex::scoped_lock lock (_state_mutex);
311 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
312 /* We've got something to do: go and do it */
316 /* Nothing to do: wait until something happens which may indicate that we do */
317 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
318 _empty_condition.wait (lock);
319 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
322 if (_finish && _queue.empty()) {
326 /* We stop here if we have been asked to finish, and if either the queue
327 is empty or we do not have a sequenced image at its head (if this is the
328 case we will never terminate as no new frames will be sent once
331 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
332 /* (Hopefully temporarily) log anything that was not written */
333 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
334 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
335 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
336 if (i->type == QueueItem::FULL) {
337 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
339 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
346 /* Write any frames that we can write; i.e. those that are in sequence. */
347 while (have_sequenced_image_at_queue_head ()) {
348 QueueItem qi = _queue.front ();
350 if (qi.type == QueueItem::FULL && qi.encoded) {
351 --_queued_full_in_memory;
356 ReelWriter& reel = _reels[qi.reel];
359 case QueueItem::FULL:
360 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
362 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
364 reel.write (qi.encoded, qi.frame, qi.eyes);
367 case QueueItem::FAKE:
368 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
369 reel.fake_write (qi.frame, qi.eyes, qi.size);
372 case QueueItem::REPEAT:
373 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
374 reel.repeat_write (qi.frame, qi.eyes);
382 while (_queued_full_in_memory > _maximum_frames_in_memory) {
383 /* Too many frames in memory which can't yet be written to the stream.
384 Write some FULL frames to disk.
387 /* Find one from the back of the queue */
389 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
390 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
394 DCPOMATIC_ASSERT (i != _queue.rend());
396 /* For the log message below */
397 int const awaiting = _reels[_queue.front().reel].last_written_video_frame();
400 /* i is valid here, even though we don't hold a lock on the mutex,
401 since list iterators are unaffected by insertion and only this
402 thread could erase the last item in the list.
405 LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
407 i->encoded->write_via_temp (
408 _film->j2c_path (i->reel, i->frame, i->eyes, true),
409 _film->j2c_path (i->reel, i->frame, i->eyes, false)
414 --_queued_full_in_memory;
417 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
418 _full_condition.notify_all ();
427 Writer::terminate_thread (bool can_throw)
429 boost::mutex::scoped_lock lock (_state_mutex);
435 _empty_condition.notify_all ();
436 _full_condition.notify_all ();
439 if (_thread->joinable ()) {
458 LOG_GENERAL_NC ("Terminating writer thread");
460 terminate_thread (true);
462 LOG_GENERAL_NC ("Finishing ReelWriters");
464 BOOST_FOREACH (ReelWriter& i, _reels) {
468 LOG_GENERAL_NC ("Writing XML");
470 dcp::DCP dcp (_film->dir (_film->dcp_name()));
472 shared_ptr<dcp::CPL> cpl (
475 _film->dcp_content_type()->libdcp_kind ()
481 /* Calculate digests for each reel in parallel */
483 shared_ptr<Job> job = _job.lock ();
484 job->sub (_("Computing digests"));
486 boost::asio::io_service service;
487 boost::thread_group pool;
489 shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
491 int const threads = max (1, Config::instance()->master_encoding_threads ());
493 for (int i = 0; i < threads; ++i) {
494 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
497 BOOST_FOREACH (ReelWriter& i, _reels) {
498 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
499 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
506 /* Add reels to CPL */
508 BOOST_FOREACH (ReelWriter& i, _reels) {
509 cpl->add (i.create_reel (_reel_assets, _fonts));
512 dcp::XMLMetadata meta;
513 meta.annotation_text = cpl->annotation_text ();
514 meta.creator = Config::instance()->dcp_creator ();
515 if (meta.creator.empty ()) {
516 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
518 meta.issuer = Config::instance()->dcp_issuer ();
519 if (meta.issuer.empty ()) {
520 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
522 meta.set_issue_date_now ();
524 cpl->set_metadata (meta);
526 shared_ptr<const dcp::CertificateChain> signer;
527 if (_film->is_signed ()) {
528 signer = Config::instance()->signer_chain ();
529 /* We did check earlier, but check again here to be on the safe side */
531 if (!signer->valid (&reason)) {
532 throw InvalidSignerError (reason);
536 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
539 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
542 write_cover_sheet ();
546 Writer::write_cover_sheet ()
548 boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt");
549 FILE* f = fopen_boost (cover, "w");
551 throw OpenFileError (cover, errno, false);
554 string text = Config::instance()->cover_sheet ();
555 boost::algorithm::replace_all (text, "$CPL_NAME", _film->name());
556 boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name());
557 boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->container_nickname());
558 boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _film->isdcf_metadata().audio_language);
559 boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", _film->isdcf_metadata().subtitle_language);
561 boost::uintmax_t size = 0;
563 boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(_film->dir(_film->dcp_name()));
564 i != boost::filesystem::recursive_directory_iterator();
566 if (boost::filesystem::is_regular_file (i->path ())) {
567 size += boost::filesystem::file_size (i->path ());
571 if (size > (1000000000L)) {
572 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1GB", dcp::locale_convert<string> (size / 1000000000.0, 1, true)));
574 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1MB", dcp::locale_convert<string> (size / 1000000.0, 1, true)));
577 pair<int, int> ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels());
578 string description = String::compose("%1.%2", ch.first, ch.second);
580 if (description == "0.0") {
581 description = _("None");
582 } else if (description == "1.0") {
583 description = _("Mono");
584 } else if (description == "2.0") {
585 description = _("Stereo");
587 boost::algorithm::replace_all (text, "$AUDIO", description);
590 _film->length().split (_film->video_frame_rate(), h, m, s, fr);
592 if (h == 0 && m == 0) {
593 length = String::compose("%1s", s);
594 } else if (h == 0 && m > 0) {
595 length = String::compose("%1m%2s", m, s);
596 } else if (h > 0 && m > 0) {
597 length = String::compose("%1h%2m%3s", h, m, s);
600 boost::algorithm::replace_all (text, "$LENGTH", length);
602 fwrite (text.c_str(), 1, text.length(), f);
606 /** @param frame Frame index within the whole DCP.
607 * @return true if we can fake-write this frame.
610 Writer::can_fake_write (Frame frame) const
612 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
613 parameters in the asset writer.
616 ReelWriter const & reel = _reels[video_reel(frame)];
618 /* Make frame relative to the start of the reel */
619 frame -= reel.start ();
620 return (frame != 0 && frame < reel.first_nonexistant_frame());
624 Writer::write (PlayerSubtitles subs, DCPTimePeriod period)
626 if (subs.text.empty ()) {
630 if (_subtitle_reel->period().to <= period.from) {
634 _subtitle_reel->write (subs);
638 Writer::write (list<shared_ptr<Font> > fonts)
640 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
642 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
644 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
651 _fonts.push_back (i);
657 operator< (QueueItem const & a, QueueItem const & b)
659 if (a.reel != b.reel) {
660 return a.reel < b.reel;
663 if (a.frame != b.frame) {
664 return a.frame < b.frame;
667 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
671 operator== (QueueItem const & a, QueueItem const & b)
673 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
677 Writer::set_encoder_threads (int threads)
679 _maximum_frames_in_memory = lrint (threads * Config::instance()->frames_in_memory_multiplier());
683 Writer::write (ReferencedReelAsset asset)
685 _reel_assets.push_back (asset);
689 Writer::video_reel (int frame) const
691 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
693 while (i < _reels.size() && !_reels[i].period().contains (t)) {
697 DCPOMATIC_ASSERT (i < _reels.size ());
702 Writer::set_digest_progress (Job* job, float progress)
704 /* I believe this is thread-safe */
705 _digest_progresses[boost::this_thread::get_id()] = progress;
707 boost::mutex::scoped_lock lm (_digest_progresses_mutex);
708 float min_progress = FLT_MAX;
709 for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
710 min_progress = min (min_progress, i->second);
713 job->set_progress (min_progress);