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 */
61 using boost::shared_ptr;
62 using boost::weak_ptr;
63 using boost::dynamic_pointer_cast;
66 Writer::Writer (shared_ptr<const Film> film, weak_ptr<Job> j)
71 , _queued_full_in_memory (0)
72 , _maximum_frames_in_memory (0)
78 /* Remove any old DCP */
79 boost::filesystem::remove_all (_film->dir (_film->dcp_name ()));
81 shared_ptr<Job> job = _job.lock ();
82 DCPOMATIC_ASSERT (job);
84 BOOST_FOREACH (DCPTimePeriod p, _film->reels ()) {
85 _reels.push_back (ReelWriter (film, p, job));
88 /* We can keep track of the current audio and subtitle reels easily because audio
89 and subs arrive to the Writer in sequence. This is not so for video.
91 _audio_reel = _reels.begin ();
92 _subtitle_reel = _reels.begin ();
94 /* Check that the signer is OK if we need one */
95 if (_film->is_signed() && !Config::instance()->signer_chain()->valid ()) {
96 throw InvalidSignerError ();
103 _thread = new boost::thread (boost::bind (&Writer::thread, this));
108 terminate_thread (false);
111 /** Pass a video frame to the writer for writing to disk at some point.
112 * This method can be called with frames out of order.
113 * @param encoded JPEG2000-encoded data.
114 * @param frame Frame index within the DCP.
115 * @param eyes Eyes that this frame image is for.
118 Writer::write (Data encoded, Frame frame, Eyes eyes)
120 boost::mutex::scoped_lock lock (_state_mutex);
122 while (_queued_full_in_memory > _maximum_frames_in_memory) {
123 /* The queue is too big; wait until that is sorted out */
124 _full_condition.wait (lock);
128 qi.type = QueueItem::FULL;
129 qi.encoded = encoded;
130 qi.reel = video_reel (frame);
131 qi.frame = frame - _reels[qi.reel].start ();
133 if (_film->three_d() && eyes == EYES_BOTH) {
134 /* 2D material in a 3D DCP; fake the 3D */
136 _queue.push_back (qi);
137 ++_queued_full_in_memory;
138 qi.eyes = EYES_RIGHT;
139 _queue.push_back (qi);
140 ++_queued_full_in_memory;
143 _queue.push_back (qi);
144 ++_queued_full_in_memory;
147 /* Now there's something to do: wake anything wait()ing on _empty_condition */
148 _empty_condition.notify_all ();
152 Writer::can_repeat (Frame frame) const
154 return frame > _reels[video_reel(frame)].start();
157 /** Repeat the last frame that was written to a reel as a new frame.
158 * @param frame Frame index within the DCP of the new (repeated) frame.
159 * @param eyes Eyes that this repeated frame image is for.
162 Writer::repeat (Frame frame, Eyes eyes)
164 boost::mutex::scoped_lock lock (_state_mutex);
166 while (_queued_full_in_memory > _maximum_frames_in_memory) {
167 /* The queue is too big; wait until that is sorted out */
168 _full_condition.wait (lock);
172 qi.type = QueueItem::REPEAT;
173 qi.reel = video_reel (frame);
174 qi.frame = frame - _reels[qi.reel].start ();
175 if (_film->three_d() && eyes == EYES_BOTH) {
177 _queue.push_back (qi);
178 qi.eyes = EYES_RIGHT;
179 _queue.push_back (qi);
182 _queue.push_back (qi);
185 /* Now there's something to do: wake anything wait()ing on _empty_condition */
186 _empty_condition.notify_all ();
190 Writer::fake_write (Frame frame, Eyes eyes)
192 boost::mutex::scoped_lock lock (_state_mutex);
194 while (_queued_full_in_memory > _maximum_frames_in_memory) {
195 /* The queue is too big; wait until that is sorted out */
196 _full_condition.wait (lock);
199 size_t const reel = video_reel (frame);
200 Frame const reel_frame = frame - _reels[reel].start ();
202 FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
204 throw ReadFileError (_film->info_file(_reels[reel].period()));
206 dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
210 qi.type = QueueItem::FAKE;
213 qi.frame = reel_frame;
214 if (_film->three_d() && eyes == EYES_BOTH) {
216 _queue.push_back (qi);
217 qi.eyes = EYES_RIGHT;
218 _queue.push_back (qi);
221 _queue.push_back (qi);
224 /* Now there's something to do: wake anything wait()ing on _empty_condition */
225 _empty_condition.notify_all ();
228 /** Write one video frame's worth of audio frames to the DCP.
229 * @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
230 * This method is not thread safe.
233 Writer::write (shared_ptr<const AudioBuffers> audio)
235 if (_audio_reel == _reels.end ()) {
236 /* This audio is off the end of the last reel; ignore it */
240 _audio_reel->write (audio);
242 /* written is in video frames, not audio frames */
243 if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
248 /** This must be called from Writer::thread() with an appropriate lock held */
250 Writer::have_sequenced_image_at_queue_head ()
252 if (_queue.empty ()) {
258 QueueItem const & f = _queue.front();
259 ReelWriter const & reel = _reels[f.reel];
261 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
263 if (f.eyes == EYES_BOTH) {
265 return f.frame == (reel.last_written_video_frame() + 1);
270 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
274 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
287 boost::mutex::scoped_lock lock (_state_mutex);
291 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
292 /* We've got something to do: go and do it */
296 /* Nothing to do: wait until something happens which may indicate that we do */
297 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
298 _empty_condition.wait (lock);
299 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
302 if (_finish && _queue.empty()) {
306 /* We stop here if we have been asked to finish, and if either the queue
307 is empty or we do not have a sequenced image at its head (if this is the
308 case we will never terminate as no new frames will be sent once
311 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
312 /* (Hopefully temporarily) log anything that was not written */
313 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
314 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
315 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
316 if (i->type == QueueItem::FULL) {
317 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
319 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
326 /* Write any frames that we can write; i.e. those that are in sequence. */
327 while (have_sequenced_image_at_queue_head ()) {
328 QueueItem qi = _queue.front ();
330 if (qi.type == QueueItem::FULL && qi.encoded) {
331 --_queued_full_in_memory;
336 ReelWriter& reel = _reels[qi.reel];
339 case QueueItem::FULL:
340 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
342 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
344 reel.write (qi.encoded, qi.frame, qi.eyes);
347 case QueueItem::FAKE:
348 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
349 reel.fake_write (qi.frame, qi.eyes, qi.size);
352 case QueueItem::REPEAT:
353 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
354 reel.repeat_write (qi.frame, qi.eyes);
362 while (_queued_full_in_memory > _maximum_frames_in_memory) {
363 /* Too many frames in memory which can't yet be written to the stream.
364 Write some FULL frames to disk.
367 /* Find one from the back of the queue */
369 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
370 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
374 DCPOMATIC_ASSERT (i != _queue.rend());
378 /* i is valid here, even though we don't hold a lock on the mutex,
379 since list iterators are unaffected by insertion and only this
380 thread could erase the last item in the list.
383 LOG_GENERAL ("Writer full; pushes %1 to disk", i->frame);
385 i->encoded->write_via_temp (
386 _film->j2c_path (i->reel, i->frame, i->eyes, true),
387 _film->j2c_path (i->reel, i->frame, i->eyes, false)
392 --_queued_full_in_memory;
395 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
396 _full_condition.notify_all ();
405 Writer::terminate_thread (bool can_throw)
407 boost::mutex::scoped_lock lock (_state_mutex);
413 _empty_condition.notify_all ();
414 _full_condition.notify_all ();
417 if (_thread->joinable ()) {
436 LOG_GENERAL_NC ("Terminating writer thread");
438 terminate_thread (true);
440 LOG_GENERAL_NC ("Finishing ReelWriters");
442 BOOST_FOREACH (ReelWriter& i, _reels) {
446 LOG_GENERAL_NC ("Writing XML");
448 dcp::DCP dcp (_film->dir (_film->dcp_name()));
450 shared_ptr<dcp::CPL> cpl (
453 _film->dcp_content_type()->libdcp_kind ()
459 BOOST_FOREACH (ReelWriter& i, _reels) {
461 shared_ptr<Job> job = _job.lock ();
462 DCPOMATIC_ASSERT (job);
463 i.calculate_digests (job);
465 cpl->add (i.create_reel (_reel_assets, _fonts));
468 dcp::XMLMetadata meta;
469 meta.creator = Config::instance()->dcp_creator ();
470 if (meta.creator.empty ()) {
471 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
473 meta.issuer = Config::instance()->dcp_issuer ();
474 if (meta.issuer.empty ()) {
475 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
477 meta.set_issue_date_now ();
479 cpl->set_metadata (meta);
481 shared_ptr<const dcp::CertificateChain> signer;
482 if (_film->is_signed ()) {
483 signer = Config::instance()->signer_chain ();
484 /* We did check earlier, but check again here to be on the safe side */
485 if (!signer->valid ()) {
486 throw InvalidSignerError ();
490 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
493 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
497 /** @param frame Frame index within the whole DCP.
498 * @return true if we can fake-write this frame.
501 Writer::can_fake_write (Frame frame) const
503 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
504 parameters in the asset writer.
507 ReelWriter const & reel = _reels[video_reel(frame)];
509 /* Make frame relative to the start of the reel */
510 frame -= reel.start ();
511 return (frame != 0 && frame < reel.first_nonexistant_frame());
515 Writer::write (PlayerSubtitles subs)
517 if (subs.text.empty ()) {
521 if (_subtitle_reel->period().to <= subs.from) {
525 _subtitle_reel->write (subs);
529 Writer::write (list<shared_ptr<Font> > fonts)
531 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
533 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
535 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
542 _fonts.push_back (i);
548 operator< (QueueItem const & a, QueueItem const & b)
550 if (a.reel != b.reel) {
551 return a.reel < b.reel;
554 if (a.frame != b.frame) {
555 return a.frame < b.frame;
558 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
562 operator== (QueueItem const & a, QueueItem const & b)
564 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
568 Writer::set_encoder_threads (int threads)
570 /* I think the scaling factor here should be the ratio of the longest frame
571 encode time to the shortest; if the thread count is T, longest time is L
572 and the shortest time S we could encode L/S frames per thread whilst waiting
573 for the L frame to encode so we might have to store LT/S frames.
575 However we don't want to use too much memory, so keep it a bit lower than we'd
576 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
577 use about 240Mb with 72 encoding threads.
579 _maximum_frames_in_memory = lrint (threads * 3);
583 Writer::write (ReferencedReelAsset asset)
585 _reel_assets.push_back (asset);
589 Writer::video_reel (int frame) const
591 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
593 while (i < _reels.size() && !_reels[i].period().contains (t)) {
597 DCPOMATIC_ASSERT (i < _reels.size ());