2 Copyright (C) 2012-2019 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 "dcpomatic_log.h"
27 #include "dcp_video.h"
28 #include "dcp_content_type.h"
29 #include "audio_mapping.h"
33 #include "audio_buffers.h"
37 #include "reel_writer.h"
38 #include "text_content.h"
40 #include <dcp/locale_convert.h>
41 #include <boost/foreach.hpp>
49 /* OS X strikes again */
61 using boost::shared_ptr;
62 using boost::weak_ptr;
63 using boost::dynamic_pointer_cast;
64 using boost::optional;
66 using namespace dcpomatic;
68 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
73 , _queued_full_in_memory (0)
74 /* These will be reset to sensible values when J2KEncoder is created */
75 , _maximum_frames_in_memory (8)
76 , _maximum_queue_size (8)
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, subtitle and closed caption reels easily because audio
92 and captions arrive to the Writer in sequence. This is not so for video.
94 _audio_reel = _reels.begin ();
95 _subtitle_reel = _reels.begin ();
96 BOOST_FOREACH (DCPTextTrack i, _film->closed_caption_tracks()) {
97 _caption_reels[i] = _reels.begin ();
100 /* Check that the signer is OK if we need one */
102 if (_film->is_signed() && !Config::instance()->signer_chain()->valid(&reason)) {
103 throw InvalidSignerError (reason);
110 _thread = new boost::thread (boost::bind (&Writer::thread, this));
111 #ifdef DCPOMATIC_LINUX
112 pthread_setname_np (_thread->native_handle(), "writer");
118 terminate_thread (false);
121 /** Pass a video frame to the writer for writing to disk at some point.
122 * This method can be called with frames out of order.
123 * @param encoded JPEG2000-encoded data.
124 * @param frame Frame index within the DCP.
125 * @param eyes Eyes that this frame image is for.
128 Writer::write (Data encoded, Frame frame, Eyes eyes)
130 boost::mutex::scoped_lock lock (_state_mutex);
132 while (_queued_full_in_memory > _maximum_frames_in_memory) {
133 /* There are too many full frames in memory; wake the main writer thread and
134 wait until it sorts everything out */
135 _empty_condition.notify_all ();
136 _full_condition.wait (lock);
140 qi.type = QueueItem::FULL;
141 qi.encoded = encoded;
142 qi.reel = video_reel (frame);
143 qi.frame = frame - _reels[qi.reel].start ();
145 if (_film->three_d() && eyes == EYES_BOTH) {
146 /* 2D material in a 3D DCP; fake the 3D */
148 _queue.push_back (qi);
149 ++_queued_full_in_memory;
150 qi.eyes = EYES_RIGHT;
151 _queue.push_back (qi);
152 ++_queued_full_in_memory;
155 _queue.push_back (qi);
156 ++_queued_full_in_memory;
159 /* Now there's something to do: wake anything wait()ing on _empty_condition */
160 _empty_condition.notify_all ();
164 Writer::can_repeat (Frame frame) const
166 return frame > _reels[video_reel(frame)].start();
169 /** Repeat the last frame that was written to a reel as a new frame.
170 * @param frame Frame index within the DCP of the new (repeated) frame.
171 * @param eyes Eyes that this repeated frame image is for.
174 Writer::repeat (Frame frame, Eyes eyes)
176 boost::mutex::scoped_lock lock (_state_mutex);
178 while (_queue.size() > _maximum_queue_size && have_sequenced_image_at_queue_head()) {
179 /* The queue is too big, and the main writer thread can run and fix it, so
180 wake it and wait until it has done.
182 _empty_condition.notify_all ();
183 _full_condition.wait (lock);
187 qi.type = QueueItem::REPEAT;
188 qi.reel = video_reel (frame);
189 qi.frame = frame - _reels[qi.reel].start ();
190 if (_film->three_d() && eyes == EYES_BOTH) {
192 _queue.push_back (qi);
193 qi.eyes = EYES_RIGHT;
194 _queue.push_back (qi);
197 _queue.push_back (qi);
200 /* Now there's something to do: wake anything wait()ing on _empty_condition */
201 _empty_condition.notify_all ();
205 Writer::fake_write (Frame frame, Eyes eyes)
207 boost::mutex::scoped_lock lock (_state_mutex);
209 while (_queue.size() > _maximum_queue_size && have_sequenced_image_at_queue_head()) {
210 /* The queue is too big, and the main writer thread can run and fix it, so
211 wake it and wait until it has done.
213 _empty_condition.notify_all ();
214 _full_condition.wait (lock);
217 size_t const reel = video_reel (frame);
218 Frame const reel_frame = frame - _reels[reel].start ();
220 FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
222 throw ReadFileError (_film->info_file(_reels[reel].period()));
224 dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
228 qi.type = QueueItem::FAKE;
231 qi.frame = reel_frame;
232 if (_film->three_d() && eyes == EYES_BOTH) {
234 _queue.push_back (qi);
235 qi.eyes = EYES_RIGHT;
236 _queue.push_back (qi);
239 _queue.push_back (qi);
242 /* Now there's something to do: wake anything wait()ing on _empty_condition */
243 _empty_condition.notify_all ();
246 /** Write some audio frames to the DCP.
247 * @param audio Audio data.
248 * @param time Time of this data within the DCP.
249 * This method is not thread safe.
252 Writer::write (shared_ptr<const AudioBuffers> audio, DCPTime const time)
254 DCPOMATIC_ASSERT (audio);
256 int const afr = _film->audio_frame_rate();
258 DCPTime const end = time + DCPTime::from_frames(audio->frames(), afr);
260 /* The audio we get might span a reel boundary, and if so we have to write it in bits */
265 if (_audio_reel == _reels.end ()) {
266 /* This audio is off the end of the last reel; ignore it */
270 if (end <= _audio_reel->period().to) {
271 /* Easy case: we can write all the audio to this reel */
272 _audio_reel->write (audio);
275 /* Split the audio into two and write the first part */
276 DCPTime part_lengths[2] = {
277 _audio_reel->period().to - t,
278 end - _audio_reel->period().to
281 Frame part_frames[2] = {
282 part_lengths[0].frames_ceil(afr),
283 part_lengths[1].frames_ceil(afr)
286 if (part_frames[0]) {
287 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), part_frames[0]));
288 part->copy_from (audio.get(), part_frames[0], 0, 0);
289 _audio_reel->write (part);
292 if (part_frames[1]) {
293 shared_ptr<AudioBuffers> part (new AudioBuffers (audio->channels(), part_frames[1]));
294 part->copy_from (audio.get(), part_frames[1], part_frames[0], 0);
301 t += part_lengths[0];
306 /** This must be called from Writer::thread() with an appropriate lock held */
308 Writer::have_sequenced_image_at_queue_head ()
310 if (_queue.empty ()) {
316 QueueItem const & f = _queue.front();
317 ReelWriter const & reel = _reels[f.reel];
319 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
321 if (f.eyes == EYES_BOTH) {
323 return f.frame == (reel.last_written_video_frame() + 1);
328 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
332 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
345 boost::mutex::scoped_lock lock (_state_mutex);
349 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
350 /* We've got something to do: go and do it */
354 /* Nothing to do: wait until something happens which may indicate that we do */
355 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
356 _empty_condition.wait (lock);
357 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
360 if (_finish && _queue.empty()) {
364 /* We stop here if we have been asked to finish, and if either the queue
365 is empty or we do not have a sequenced image at its head (if this is the
366 case we will never terminate as no new frames will be sent once
369 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
370 /* (Hopefully temporarily) log anything that was not written */
371 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
372 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
373 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
374 if (i->type == QueueItem::FULL) {
375 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes);
377 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes);
384 /* Write any frames that we can write; i.e. those that are in sequence. */
385 while (have_sequenced_image_at_queue_head ()) {
386 QueueItem qi = _queue.front ();
388 if (qi.type == QueueItem::FULL && qi.encoded) {
389 --_queued_full_in_memory;
394 ReelWriter& reel = _reels[qi.reel];
397 case QueueItem::FULL:
398 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes);
400 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
402 reel.write (qi.encoded, qi.frame, qi.eyes);
405 case QueueItem::FAKE:
406 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
407 reel.fake_write (qi.frame, qi.eyes, qi.size);
410 case QueueItem::REPEAT:
411 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
412 reel.repeat_write (qi.frame, qi.eyes);
418 _full_condition.notify_all ();
421 while (_queued_full_in_memory > _maximum_frames_in_memory) {
422 /* Too many frames in memory which can't yet be written to the stream.
423 Write some FULL frames to disk.
426 /* Find one from the back of the queue */
428 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
429 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
433 DCPOMATIC_ASSERT (i != _queue.rend());
435 /* For the log message below */
436 int const awaiting = _reels[_queue.front().reel].last_written_video_frame() + 1;
439 /* i is valid here, even though we don't hold a lock on the mutex,
440 since list iterators are unaffected by insertion and only this
441 thread could erase the last item in the list.
444 LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting);
446 i->encoded->write_via_temp (
447 _film->j2c_path (i->reel, i->frame, i->eyes, true),
448 _film->j2c_path (i->reel, i->frame, i->eyes, false)
453 --_queued_full_in_memory;
454 _full_condition.notify_all ();
464 Writer::terminate_thread (bool can_throw)
466 boost::mutex::scoped_lock lock (_state_mutex);
472 _empty_condition.notify_all ();
473 _full_condition.notify_all ();
476 if (_thread->joinable ()) {
495 LOG_GENERAL_NC ("Terminating writer thread");
497 terminate_thread (true);
499 LOG_GENERAL_NC ("Finishing ReelWriters");
501 BOOST_FOREACH (ReelWriter& i, _reels) {
505 LOG_GENERAL_NC ("Writing XML");
507 dcp::DCP dcp (_film->dir (_film->dcp_name()));
509 shared_ptr<dcp::CPL> cpl (
512 _film->dcp_content_type()->libdcp_kind ()
518 /* Calculate digests for each reel in parallel */
520 shared_ptr<Job> job = _job.lock ();
521 job->sub (_("Computing digests"));
523 boost::asio::io_service service;
524 boost::thread_group pool;
526 shared_ptr<boost::asio::io_service::work> work (new boost::asio::io_service::work (service));
528 int const threads = max (1, Config::instance()->master_encoding_threads ());
530 for (int i = 0; i < threads; ++i) {
531 pool.create_thread (boost::bind (&boost::asio::io_service::run, &service));
534 BOOST_FOREACH (ReelWriter& i, _reels) {
535 boost::function<void (float)> set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1);
536 service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress));
543 /* Add reels to CPL */
545 BOOST_FOREACH (ReelWriter& i, _reels) {
546 cpl->add (i.create_reel (_reel_assets, _fonts));
549 dcp::XMLMetadata meta;
550 meta.annotation_text = cpl->annotation_text ();
551 meta.creator = Config::instance()->dcp_creator ();
552 if (meta.creator.empty ()) {
553 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
555 meta.issuer = Config::instance()->dcp_issuer ();
556 if (meta.issuer.empty ()) {
557 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
559 meta.set_issue_date_now ();
561 cpl->set_metadata (meta);
562 cpl->set_ratings (vector_to_list(_film->ratings()));
564 shared_ptr<const dcp::CertificateChain> signer;
565 if (_film->is_signed ()) {
566 signer = Config::instance()->signer_chain ();
567 /* We did check earlier, but check again here to be on the safe side */
569 if (!signer->valid (&reason)) {
570 throw InvalidSignerError (reason);
574 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format());
577 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
580 write_cover_sheet ();
584 Writer::write_cover_sheet ()
586 boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt");
587 FILE* f = fopen_boost (cover, "w");
589 throw OpenFileError (cover, errno, OpenFileError::WRITE);
592 string text = Config::instance()->cover_sheet ();
593 boost::algorithm::replace_all (text, "$CPL_NAME", _film->name());
594 boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name());
595 boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->container_nickname());
596 boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _film->isdcf_metadata().audio_language);
598 optional<string> subtitle_language;
599 BOOST_FOREACH (shared_ptr<Content> i, _film->content()) {
600 BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
601 if (j->type() == TEXT_OPEN_SUBTITLE && j->use()) {
602 subtitle_language = j->language ();
606 boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", subtitle_language.get_value_or("None"));
608 boost::uintmax_t size = 0;
610 boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(_film->dir(_film->dcp_name()));
611 i != boost::filesystem::recursive_directory_iterator();
613 if (boost::filesystem::is_regular_file (i->path ())) {
614 size += boost::filesystem::file_size (i->path ());
618 if (size > (1000000000L)) {
619 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1GB", dcp::locale_convert<string> (size / 1000000000.0, 1, true)));
621 boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1MB", dcp::locale_convert<string> (size / 1000000.0, 1, true)));
624 pair<int, int> ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels());
625 string description = String::compose("%1.%2", ch.first, ch.second);
627 if (description == "0.0") {
628 description = _("None");
629 } else if (description == "1.0") {
630 description = _("Mono");
631 } else if (description == "2.0") {
632 description = _("Stereo");
634 boost::algorithm::replace_all (text, "$AUDIO", description);
637 _film->length().split (_film->video_frame_rate(), h, m, s, fr);
639 if (h == 0 && m == 0) {
640 length = String::compose("%1s", s);
641 } else if (h == 0 && m > 0) {
642 length = String::compose("%1m%2s", m, s);
643 } else if (h > 0 && m > 0) {
644 length = String::compose("%1h%2m%3s", h, m, s);
647 boost::algorithm::replace_all (text, "$LENGTH", length);
649 checked_fwrite (text.c_str(), text.length(), f, cover);
653 /** @param frame Frame index within the whole DCP.
654 * @return true if we can fake-write this frame.
657 Writer::can_fake_write (Frame frame) const
659 if (_film->encrypted()) {
660 /* We need to re-write the frame because the asset ID is embedded in the HMAC... I think... */
664 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
665 parameters in the asset writer.
668 ReelWriter const & reel = _reels[video_reel(frame)];
670 /* Make frame relative to the start of the reel */
671 frame -= reel.start ();
672 return (frame != 0 && frame < reel.first_nonexistant_frame());
675 /** @param track Closed caption track if type == TEXT_CLOSED_CAPTION */
677 Writer::write (PlayerText text, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
679 vector<ReelWriter>::iterator* reel = 0;
682 case TEXT_OPEN_SUBTITLE:
683 reel = &_subtitle_reel;
685 case TEXT_CLOSED_CAPTION:
686 DCPOMATIC_ASSERT (track);
687 DCPOMATIC_ASSERT (_caption_reels.find(*track) != _caption_reels.end());
688 reel = &_caption_reels[*track];
691 DCPOMATIC_ASSERT (false);
694 DCPOMATIC_ASSERT (*reel != _reels.end());
695 while ((*reel)->period().to <= period.from) {
697 DCPOMATIC_ASSERT (*reel != _reels.end());
700 (*reel)->write (text, type, track, period);
704 Writer::write (list<shared_ptr<Font> > fonts)
706 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
708 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
710 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
717 _fonts.push_back (i);
723 operator< (QueueItem const & a, QueueItem const & b)
725 if (a.reel != b.reel) {
726 return a.reel < b.reel;
729 if (a.frame != b.frame) {
730 return a.frame < b.frame;
733 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
737 operator== (QueueItem const & a, QueueItem const & b)
739 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
743 Writer::set_encoder_threads (int threads)
745 boost::mutex::scoped_lock lm (_state_mutex);
746 _maximum_frames_in_memory = lrint (threads * Config::instance()->frames_in_memory_multiplier());
747 _maximum_queue_size = threads * 16;
751 Writer::write (ReferencedReelAsset asset)
753 _reel_assets.push_back (asset);
757 Writer::video_reel (int frame) const
759 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
761 while (i < _reels.size() && !_reels[i].period().contains (t)) {
765 DCPOMATIC_ASSERT (i < _reels.size ());
770 Writer::set_digest_progress (Job* job, float progress)
772 /* I believe this is thread-safe */
773 _digest_progresses[boost::this_thread::get_id()] = progress;
775 boost::mutex::scoped_lock lm (_digest_progresses_mutex);
776 float min_progress = FLT_MAX;
777 for (map<boost::thread::id, float>::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) {
778 min_progress = min (min_progress, i->second);
781 job->set_progress (min_progress);