2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "compose.hpp"
25 #include "dcp_video.h"
26 #include "dcp_content_type.h"
27 #include "audio_mapping.h"
31 #include "audio_buffers.h"
32 #include "md5_digester.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 ();
99 job->sub (_("Encoding image data"));
105 _thread = new boost::thread (boost::bind (&Writer::thread, this));
110 terminate_thread (false);
113 /** Pass a video frame to the writer for writing to disk at some point.
114 * This method can be called with frames out of order.
115 * @param encoded JPEG2000-encoded data.
116 * @param frame Frame index within the DCP.
117 * @param eyes Eyes that this frame image is for.
120 Writer::write (Data encoded, Frame frame, Eyes eyes)
122 boost::mutex::scoped_lock lock (_state_mutex);
124 while (_queued_full_in_memory > _maximum_frames_in_memory) {
125 /* The queue is too big; wait until that is sorted out */
126 _full_condition.wait (lock);
130 qi.type = QueueItem::FULL;
131 qi.encoded = encoded;
132 qi.reel = video_reel (frame);
133 qi.frame = frame - _reels[qi.reel].start ();
135 if (_film->three_d() && eyes == EYES_BOTH) {
136 /* 2D material in a 3D DCP; fake the 3D */
138 _queue.push_back (qi);
139 ++_queued_full_in_memory;
140 qi.eyes = EYES_RIGHT;
141 _queue.push_back (qi);
142 ++_queued_full_in_memory;
145 _queue.push_back (qi);
146 ++_queued_full_in_memory;
149 /* Now there's something to do: wake anything wait()ing on _empty_condition */
150 _empty_condition.notify_all ();
154 Writer::can_repeat (Frame frame) const
156 return frame > _reels[video_reel(frame)].start();
159 /** Repeat the last frame that was written to a reel as a new frame.
160 * @param frame Frame index within the DCP of the new (repeated) frame.
161 * @param eyes Eyes that this repeated frame image is for.
164 Writer::repeat (Frame frame, Eyes eyes)
166 boost::mutex::scoped_lock lock (_state_mutex);
168 while (_queued_full_in_memory > _maximum_frames_in_memory) {
169 /* The queue is too big; wait until that is sorted out */
170 _full_condition.wait (lock);
174 qi.type = QueueItem::REPEAT;
175 qi.reel = video_reel (frame);
176 qi.frame = frame - _reels[qi.reel].start ();
177 if (_film->three_d() && eyes == EYES_BOTH) {
179 _queue.push_back (qi);
180 qi.eyes = EYES_RIGHT;
181 _queue.push_back (qi);
184 _queue.push_back (qi);
187 /* Now there's something to do: wake anything wait()ing on _empty_condition */
188 _empty_condition.notify_all ();
192 Writer::fake_write (Frame frame, Eyes eyes)
194 boost::mutex::scoped_lock lock (_state_mutex);
196 while (_queued_full_in_memory > _maximum_frames_in_memory) {
197 /* The queue is too big; wait until that is sorted out */
198 _full_condition.wait (lock);
201 size_t const reel = video_reel (frame);
202 Frame const reel_frame = frame - _reels[reel].start ();
204 FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb");
206 throw ReadFileError (_film->info_file(_reels[reel].period()));
208 dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes);
212 qi.type = QueueItem::FAKE;
215 qi.frame = reel_frame;
216 if (_film->three_d() && eyes == EYES_BOTH) {
218 _queue.push_back (qi);
219 qi.eyes = EYES_RIGHT;
220 _queue.push_back (qi);
223 _queue.push_back (qi);
226 /* Now there's something to do: wake anything wait()ing on _empty_condition */
227 _empty_condition.notify_all ();
230 /** Write one video frame's worth of audio frames to the DCP.
231 * @param audio Audio data or 0 if there is no audio to be written here (i.e. it is referenced).
232 * This method is not thread safe.
235 Writer::write (shared_ptr<const AudioBuffers> audio)
237 if (_audio_reel == _reels.end ()) {
238 /* This audio is off the end of the last reel; ignore it */
242 _audio_reel->write (audio);
244 /* written is in video frames, not audio frames */
245 if (_audio_reel->total_written_audio_frames() >= _audio_reel->period().duration().frames_floor (_film->video_frame_rate())) {
250 /** This must be called from Writer::thread() with an appropriate lock held */
252 Writer::have_sequenced_image_at_queue_head ()
254 if (_queue.empty ()) {
260 QueueItem const & f = _queue.front();
261 ReelWriter const & reel = _reels[f.reel];
263 /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */
265 if (f.eyes == EYES_BOTH) {
267 return f.frame == (reel.last_written_video_frame() + 1);
272 if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) {
276 if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) {
289 boost::mutex::scoped_lock lock (_state_mutex);
293 if (_finish || _queued_full_in_memory > _maximum_frames_in_memory || have_sequenced_image_at_queue_head ()) {
294 /* We've got something to do: go and do it */
298 /* Nothing to do: wait until something happens which may indicate that we do */
299 LOG_TIMING (N_("writer-sleep queue=%1"), _queue.size());
300 _empty_condition.wait (lock);
301 LOG_TIMING (N_("writer-wake queue=%1"), _queue.size());
304 if (_finish && _queue.empty()) {
308 /* We stop here if we have been asked to finish, and if either the queue
309 is empty or we do not have a sequenced image at its head (if this is the
310 case we will never terminate as no new frames will be sent once
313 if (_finish && (!have_sequenced_image_at_queue_head() || _queue.empty())) {
314 /* (Hopefully temporarily) log anything that was not written */
315 if (!_queue.empty() && !have_sequenced_image_at_queue_head()) {
316 LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size());
317 for (list<QueueItem>::const_iterator i = _queue.begin(); i != _queue.end(); ++i) {
318 if (i->type == QueueItem::FULL) {
319 LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, i->eyes);
321 LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, i->eyes);
328 /* Write any frames that we can write; i.e. those that are in sequence. */
329 while (have_sequenced_image_at_queue_head ()) {
330 QueueItem qi = _queue.front ();
332 if (qi.type == QueueItem::FULL && qi.encoded) {
333 --_queued_full_in_memory;
338 ReelWriter& reel = _reels[qi.reel];
341 case QueueItem::FULL:
342 LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, qi.eyes);
344 qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false));
346 reel.write (qi.encoded, qi.frame, qi.eyes);
349 case QueueItem::FAKE:
350 LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame);
351 reel.fake_write (qi.frame, qi.eyes, qi.size);
354 case QueueItem::REPEAT:
355 LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame);
356 reel.repeat_write (qi.frame, qi.eyes);
363 shared_ptr<Job> job = _job.lock ();
364 DCPOMATIC_ASSERT (job);
365 int64_t total = _film->length().frames_round (_film->video_frame_rate ());
366 if (_film->three_d ()) {
367 /* _full_written and so on are incremented for each eye, so we need to double the total
368 frames to get the correct progress.
373 job->set_progress (float (_full_written + _fake_written + _repeat_written) / total);
377 while (_queued_full_in_memory > _maximum_frames_in_memory) {
378 /* Too many frames in memory which can't yet be written to the stream.
379 Write some FULL frames to disk.
382 /* Find one from the back of the queue */
384 list<QueueItem>::reverse_iterator i = _queue.rbegin ();
385 while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) {
389 DCPOMATIC_ASSERT (i != _queue.rend());
393 /* i is valid here, even though we don't hold a lock on the mutex,
394 since list iterators are unaffected by insertion and only this
395 thread could erase the last item in the list.
398 LOG_GENERAL ("Writer full; pushes %1 to disk", i->frame);
400 i->encoded->write_via_temp (
401 _film->j2c_path (i->reel, i->frame, i->eyes, true),
402 _film->j2c_path (i->reel, i->frame, i->eyes, false)
407 --_queued_full_in_memory;
410 /* The queue has probably just gone down a bit; notify anything wait()ing on _full_condition */
411 _full_condition.notify_all ();
420 Writer::terminate_thread (bool can_throw)
422 boost::mutex::scoped_lock lock (_state_mutex);
428 _empty_condition.notify_all ();
429 _full_condition.notify_all ();
432 if (_thread->joinable ()) {
451 LOG_GENERAL_NC ("Terminating writer thread");
453 terminate_thread (true);
455 LOG_GENERAL_NC ("Finishing ReelWriters");
457 BOOST_FOREACH (ReelWriter& i, _reels) {
461 LOG_GENERAL_NC ("Writing XML");
463 dcp::DCP dcp (_film->dir (_film->dcp_name()));
465 shared_ptr<dcp::CPL> cpl (
468 _film->dcp_content_type()->libdcp_kind ()
474 BOOST_FOREACH (ReelWriter& i, _reels) {
476 shared_ptr<Job> job = _job.lock ();
477 DCPOMATIC_ASSERT (job);
478 i.calculate_digests (job);
480 cpl->add (i.create_reel (_reel_assets, _fonts));
483 dcp::XMLMetadata meta;
484 meta.creator = Config::instance()->dcp_creator ();
485 if (meta.creator.empty ()) {
486 meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
488 meta.issuer = Config::instance()->dcp_issuer ();
489 if (meta.issuer.empty ()) {
490 meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit);
492 meta.set_issue_date_now ();
494 cpl->set_metadata (meta);
496 shared_ptr<const dcp::CertificateChain> signer;
497 if (_film->is_signed ()) {
498 signer = Config::instance()->signer_chain ();
499 /* We did check earlier, but check again here to be on the safe side */
500 if (!signer->valid ()) {
501 throw InvalidSignerError ();
505 dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer);
508 N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk
512 /** @param frame Frame index within the whole DCP.
513 * @return true if we can fake-write this frame.
516 Writer::can_fake_write (Frame frame) const
518 /* We have to do a proper write of the first frame so that we can set up the JPEG2000
519 parameters in the asset writer.
522 ReelWriter const & reel = _reels[video_reel(frame)];
524 /* Make frame relative to the start of the reel */
525 frame -= reel.start ();
526 return (frame != 0 && frame < reel.first_nonexistant_frame());
530 Writer::write (PlayerSubtitles subs)
532 if (subs.text.empty ()) {
536 if (_subtitle_reel->period().to <= subs.from) {
540 _subtitle_reel->write (subs);
544 Writer::write (list<shared_ptr<Font> > fonts)
546 /* Just keep a list of unique fonts and we'll deal with them in ::finish */
548 BOOST_FOREACH (shared_ptr<Font> i, fonts) {
550 BOOST_FOREACH (shared_ptr<Font> j, _fonts) {
557 _fonts.push_back (i);
563 operator< (QueueItem const & a, QueueItem const & b)
565 if (a.reel != b.reel) {
566 return a.reel < b.reel;
569 if (a.frame != b.frame) {
570 return a.frame < b.frame;
573 return static_cast<int> (a.eyes) < static_cast<int> (b.eyes);
577 operator== (QueueItem const & a, QueueItem const & b)
579 return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes;
583 Writer::set_encoder_threads (int threads)
585 /* I think the scaling factor here should be the ratio of the longest frame
586 encode time to the shortest; if the thread count is T, longest time is L
587 and the shortest time S we could encode L/S frames per thread whilst waiting
588 for the L frame to encode so we might have to store LT/S frames.
590 However we don't want to use too much memory, so keep it a bit lower than we'd
591 perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could
592 use about 240Mb with 72 encoding threads.
594 _maximum_frames_in_memory = lrint (threads * 3);
598 Writer::write (ReferencedReelAsset asset)
600 _reel_assets.push_back (asset);
604 Writer::video_reel (int frame) const
606 DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ());
608 while (i < _reels.size() && !_reels[i].period().contains (t)) {
612 DCPOMATIC_ASSERT (i < _reels.size ());