X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fwriter.cc;h=2dd46f0b2324f4516364b319ab2a1561542cba26;hp=2eec8110e3112c1a2548eb125b541c743af61c2d;hb=c103d8c1306e5fb3937b3a6c430a3fff32653fa3;hpb=54ef3f25f924a677de0d71e1f773898b56ab5852 diff --git a/src/lib/writer.cc b/src/lib/writer.cc index 2eec8110e..2dd46f0b2 100644 --- a/src/lib/writer.cc +++ b/src/lib/writer.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2017 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of DCP-o-matic. @@ -18,106 +18,117 @@ */ -#include "writer.h" -#include "compose.hpp" -#include "film.h" -#include "ratio.h" -#include "log.h" -#include "dcp_video.h" -#include "dcp_content_type.h" + +#include "audio_buffers.h" #include "audio_mapping.h" +#include "compose.hpp" #include "config.h" -#include "job.h" #include "cross.h" -#include "audio_buffers.h" -#include "version.h" -#include "font.h" -#include "util.h" +#include "dcp_content_type.h" +#include "dcp_video.h" +#include "dcpomatic_log.h" +#include "film.h" +#include "job.h" +#include "log.h" +#include "ratio.h" #include "reel_writer.h" +#include "text_content.h" +#include "util.h" +#include "version.h" +#include "writer.h" #include #include -#include -#include +#include +#include #include -#include #include +#include #include "i18n.h" -#define LOG_GENERAL(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL); -#define LOG_GENERAL_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_GENERAL); -#define LOG_DEBUG_ENCODE(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_DEBUG_ENCODE); -#define LOG_TIMING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_TIMING); -#define LOG_WARNING_NC(...) _film->log()->log (__VA_ARGS__, LogEntry::TYPE_WARNING); -#define LOG_WARNING(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_WARNING); -#define LOG_ERROR(...) _film->log()->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR); /* OS X strikes again */ #undef set_key -using std::make_pair; -using std::pair; -using std::string; -using std::list; + using std::cout; -using std::map; -using std::min; +using std::dynamic_pointer_cast; +using std::make_shared; using std::max; -using boost::shared_ptr; -using boost::weak_ptr; -using boost::dynamic_pointer_cast; +using std::min; +using std::shared_ptr; +using std::set; +using std::string; +using std::vector; +using std::weak_ptr; +using boost::optional; +#if BOOST_VERSION >= 106100 +using namespace boost::placeholders; +#endif using dcp::Data; +using dcp::ArrayData; +using namespace dcpomatic; + -Writer::Writer (shared_ptr film, weak_ptr j) - : _film (film) +/** @param j Job to report progress to, or 0. + * @param text_only true to enable only the text (subtitle/ccap) parts of the writer. + */ +Writer::Writer (weak_ptr weak_film, weak_ptr j, bool text_only) + : WeakConstFilm (weak_film) , _job (j) - , _thread (0) - , _finish (false) - , _queued_full_in_memory (0) /* These will be reset to sensible values when J2KEncoder is created */ , _maximum_frames_in_memory (8) , _maximum_queue_size (8) - , _full_written (0) - , _fake_written (0) - , _repeat_written (0) - , _pushed_to_disk (0) + , _text_only (text_only) { - shared_ptr job = _job.lock (); - DCPOMATIC_ASSERT (job); + auto job = _job.lock (); int reel_index = 0; - list const reels = _film->reels (); - BOOST_FOREACH (DCPTimePeriod p, reels) { - _reels.push_back (ReelWriter (film, p, job, reel_index++, reels.size(), _film->content_summary(p))); + auto const reels = film()->reels(); + for (auto p: reels) { + _reels.push_back (ReelWriter(weak_film, p, job, reel_index++, reels.size(), text_only)); } - /* We can keep track of the current audio and subtitle reels easily because audio - and subs arrive to the Writer in sequence. This is not so for video. + _last_written.resize (reels.size()); + + /* We can keep track of the current audio, subtitle and closed caption reels easily because audio + and captions arrive to the Writer in sequence. This is not so for video. */ _audio_reel = _reels.begin (); _subtitle_reel = _reels.begin (); + for (auto i: film()->closed_caption_tracks()) { + _caption_reels[i] = _reels.begin (); + } + _atmos_reel = _reels.begin (); - /* Check that the signer is OK if we need one */ + /* Check that the signer is OK */ string reason; - if (_film->is_signed() && !Config::instance()->signer_chain()->valid(&reason)) { + if (!Config::instance()->signer_chain()->valid(&reason)) { throw InvalidSignerError (reason); } } + void Writer::start () { - _thread = new boost::thread (boost::bind (&Writer::thread, this)); + if (!_text_only) { + _thread = boost::thread (boost::bind(&Writer::thread, this)); #ifdef DCPOMATIC_LINUX - pthread_setname_np (_thread->native_handle(), "writer"); + pthread_setname_np (_thread.native_handle(), "writer"); #endif + } } + Writer::~Writer () { - terminate_thread (false); + if (!_text_only) { + terminate_thread (false); + } } + /** Pass a video frame to the writer for writing to disk at some point. * This method can be called with frames out of order. * @param encoded JPEG2000-encoded data. @@ -125,7 +136,7 @@ Writer::~Writer () * @param eyes Eyes that this frame image is for. */ void -Writer::write (Data encoded, Frame frame, Eyes eyes) +Writer::write (shared_ptr encoded, Frame frame, Eyes eyes) { boost::mutex::scoped_lock lock (_state_mutex); @@ -137,17 +148,17 @@ Writer::write (Data encoded, Frame frame, Eyes eyes) } QueueItem qi; - qi.type = QueueItem::FULL; + qi.type = QueueItem::Type::FULL; qi.encoded = encoded; qi.reel = video_reel (frame); qi.frame = frame - _reels[qi.reel].start (); - if (_film->three_d() && eyes == EYES_BOTH) { + if (film()->three_d() && eyes == Eyes::BOTH) { /* 2D material in a 3D DCP; fake the 3D */ - qi.eyes = EYES_LEFT; + qi.eyes = Eyes::LEFT; _queue.push_back (qi); ++_queued_full_in_memory; - qi.eyes = EYES_RIGHT; + qi.eyes = Eyes::RIGHT; _queue.push_back (qi); ++_queued_full_in_memory; } else { @@ -160,12 +171,14 @@ Writer::write (Data encoded, Frame frame, Eyes eyes) _empty_condition.notify_all (); } + bool Writer::can_repeat (Frame frame) const { return frame > _reels[video_reel(frame)].start(); } + /** Repeat the last frame that was written to a reel as a new frame. * @param frame Frame index within the DCP of the new (repeated) frame. * @param eyes Eyes that this repeated frame image is for. @@ -184,13 +197,13 @@ Writer::repeat (Frame frame, Eyes eyes) } QueueItem qi; - qi.type = QueueItem::REPEAT; + qi.type = QueueItem::Type::REPEAT; qi.reel = video_reel (frame); qi.frame = frame - _reels[qi.reel].start (); - if (_film->three_d() && eyes == EYES_BOTH) { - qi.eyes = EYES_LEFT; + if (film()->three_d() && eyes == Eyes::BOTH) { + qi.eyes = Eyes::LEFT; _queue.push_back (qi); - qi.eyes = EYES_RIGHT; + qi.eyes = Eyes::RIGHT; _queue.push_back (qi); } else { qi.eyes = eyes; @@ -201,6 +214,7 @@ Writer::repeat (Frame frame, Eyes eyes) _empty_condition.notify_all (); } + void Writer::fake_write (Frame frame, Eyes eyes) { @@ -215,24 +229,22 @@ Writer::fake_write (Frame frame, Eyes eyes) } size_t const reel = video_reel (frame); - Frame const reel_frame = frame - _reels[reel].start (); + Frame const frame_in_reel = frame - _reels[reel].start (); - FILE* file = fopen_boost (_film->info_file(_reels[reel].period()), "rb"); - if (!file) { - throw ReadFileError (_film->info_file(_reels[reel].period())); + QueueItem qi; + qi.type = QueueItem::Type::FAKE; + + { + shared_ptr info_file = film()->info_file_handle(_reels[reel].period(), true); + qi.size = _reels[reel].read_frame_info(info_file, frame_in_reel, eyes).size; } - dcp::FrameInfo info = _reels[reel].read_frame_info (file, reel_frame, eyes); - fclose (file); - QueueItem qi; - qi.type = QueueItem::FAKE; - qi.size = info.size; qi.reel = reel; - qi.frame = reel_frame; - if (_film->three_d() && eyes == EYES_BOTH) { - qi.eyes = EYES_LEFT; + qi.frame = frame_in_reel; + if (film()->three_d() && eyes == Eyes::BOTH) { + qi.eyes = Eyes::LEFT; _queue.push_back (qi); - qi.eyes = EYES_RIGHT; + qi.eyes = Eyes::RIGHT; _queue.push_back (qi); } else { qi.eyes = eyes; @@ -243,6 +255,7 @@ Writer::fake_write (Frame frame, Eyes eyes) _empty_condition.notify_all (); } + /** Write some audio frames to the DCP. * @param audio Audio data. * @param time Time of this data within the DCP. @@ -253,7 +266,7 @@ Writer::write (shared_ptr audio, DCPTime const time) { DCPOMATIC_ASSERT (audio); - int const afr = _film->audio_frame_rate(); + int const afr = film()->audio_frame_rate(); DCPTime const end = time + DCPTime::from_frames(audio->frames(), afr); @@ -271,28 +284,31 @@ Writer::write (shared_ptr audio, DCPTime const time) /* Easy case: we can write all the audio to this reel */ _audio_reel->write (audio); t = end; + } else if (_audio_reel->period().to <= t) { + /* This reel is entirely before the start of our audio; just skip the reel */ + ++_audio_reel; } else { - /* Split the audio into two and write the first part */ + /* This audio is over a reel boundary; split the audio into two and write the first part */ DCPTime part_lengths[2] = { _audio_reel->period().to - t, end - _audio_reel->period().to }; + /* Be careful that part_lengths[0] + part_lengths[1] can't be bigger than audio->frames() */ Frame part_frames[2] = { part_lengths[0].frames_ceil(afr), - part_lengths[1].frames_ceil(afr) + part_lengths[1].frames_floor(afr) }; + DCPOMATIC_ASSERT ((part_frames[0] + part_frames[1]) <= audio->frames()); + if (part_frames[0]) { - shared_ptr part (new AudioBuffers (audio->channels(), part_frames[0])); - part->copy_from (audio.get(), part_frames[0], 0, 0); + auto part = make_shared(audio, part_frames[0], 0); _audio_reel->write (part); } if (part_frames[1]) { - shared_ptr part (new AudioBuffers (audio->channels(), part_frames[1])); - part->copy_from (audio.get(), part_frames[1], part_frames[0], 0); - audio = part; + audio = make_shared(audio, part_frames[1], part_frames[0]); } else { audio.reset (); } @@ -303,7 +319,21 @@ Writer::write (shared_ptr audio, DCPTime const time) } } -/** This must be called from Writer::thread() with an appropriate lock held */ + +void +Writer::write (shared_ptr atmos, DCPTime time, AtmosMetadata metadata) +{ + if (_atmos_reel->period().to == time) { + ++_atmos_reel; + DCPOMATIC_ASSERT (_atmos_reel != _reels.end()); + } + + /* We assume that we get a video frame's worth of data here */ + _atmos_reel->write (atmos, metadata); +} + + +/** Caller must hold a lock on _state_mutex */ bool Writer::have_sequenced_image_at_queue_head () { @@ -312,34 +342,47 @@ Writer::have_sequenced_image_at_queue_head () } _queue.sort (); + auto const & f = _queue.front(); + return _last_written[f.reel].next(f); +} - QueueItem const & f = _queue.front(); - ReelWriter const & reel = _reels[f.reel]; - - /* The queue should contain only EYES_LEFT/EYES_RIGHT pairs or EYES_BOTH */ - if (f.eyes == EYES_BOTH) { +bool +Writer::LastWritten::next (QueueItem qi) const +{ + if (qi.eyes == Eyes::BOTH) { /* 2D */ - return f.frame == (reel.last_written_video_frame() + 1); + return qi.frame == (_frame + 1); } /* 3D */ - if (reel.last_written_eyes() == EYES_LEFT && f.frame == reel.last_written_video_frame() && f.eyes == EYES_RIGHT) { + if (_eyes == Eyes::LEFT && qi.frame == _frame && qi.eyes == Eyes::RIGHT) { return true; } - if (reel.last_written_eyes() == EYES_RIGHT && f.frame == (reel.last_written_video_frame() + 1) && f.eyes == EYES_LEFT) { + if (_eyes == Eyes::RIGHT && qi.frame == (_frame + 1) && qi.eyes == Eyes::LEFT) { return true; } return false; } + +void +Writer::LastWritten::update (QueueItem qi) +{ + _frame = qi.frame; + _eyes = qi.eyes; +} + + void Writer::thread () try { + start_of_thread ("Writer"); + while (true) { boost::mutex::scoped_lock lock (_state_mutex); @@ -357,10 +400,6 @@ try LOG_TIMING (N_("writer-wake queue=%1"), _queue.size()); } - if (_finish && _queue.empty()) { - return; - } - /* We stop here if we have been asked to finish, and if either the queue is empty or we do not have a sequenced image at its head (if this is the case we will never terminate as no new frames will be sent once @@ -370,11 +409,11 @@ try /* (Hopefully temporarily) log anything that was not written */ if (!_queue.empty() && !have_sequenced_image_at_queue_head()) { LOG_WARNING (N_("Finishing writer with a left-over queue of %1:"), _queue.size()); - for (list::const_iterator i = _queue.begin(); i != _queue.end(); ++i) { - if (i->type == QueueItem::FULL) { - LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i->frame, (int) i->eyes); + for (auto const& i: _queue) { + if (i.type == QueueItem::Type::FULL) { + LOG_WARNING (N_("- type FULL, frame %1, eyes %2"), i.frame, (int) i.eyes); } else { - LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i->size, i->frame, (int) i->eyes); + LOG_WARNING (N_("- type FAKE, size %1, frame %2, eyes %3"), i.size, i.frame, (int) i.eyes); } } } @@ -383,31 +422,32 @@ try /* Write any frames that we can write; i.e. those that are in sequence. */ while (have_sequenced_image_at_queue_head ()) { - QueueItem qi = _queue.front (); + auto qi = _queue.front (); + _last_written[qi.reel].update (qi); _queue.pop_front (); - if (qi.type == QueueItem::FULL && qi.encoded) { + if (qi.type == QueueItem::Type::FULL && qi.encoded) { --_queued_full_in_memory; } lock.unlock (); - ReelWriter& reel = _reels[qi.reel]; + auto& reel = _reels[qi.reel]; switch (qi.type) { - case QueueItem::FULL: + case QueueItem::Type::FULL: LOG_DEBUG_ENCODE (N_("Writer FULL-writes %1 (%2)"), qi.frame, (int) qi.eyes); if (!qi.encoded) { - qi.encoded = Data (_film->j2c_path (qi.reel, qi.frame, qi.eyes, false)); + qi.encoded.reset (new ArrayData(film()->j2c_path(qi.reel, qi.frame, qi.eyes, false))); } reel.write (qi.encoded, qi.frame, qi.eyes); ++_full_written; break; - case QueueItem::FAKE: + case QueueItem::Type::FAKE: LOG_DEBUG_ENCODE (N_("Writer FAKE-writes %1"), qi.frame); - reel.fake_write (qi.frame, qi.eyes, qi.size); + reel.fake_write (qi.size); ++_fake_written; break; - case QueueItem::REPEAT: + case QueueItem::Type::REPEAT: LOG_DEBUG_ENCODE (N_("Writer REPEAT-writes %1"), qi.frame); reel.repeat_write (qi.frame, qi.eyes); ++_repeat_written; @@ -425,15 +465,15 @@ try /* Find one from the back of the queue */ _queue.sort (); - list::reverse_iterator i = _queue.rbegin (); - while (i != _queue.rend() && (i->type != QueueItem::FULL || !i->encoded)) { + auto i = _queue.rbegin (); + while (i != _queue.rend() && (i->type != QueueItem::Type::FULL || !i->encoded)) { ++i; } DCPOMATIC_ASSERT (i != _queue.rend()); ++_pushed_to_disk; /* For the log message below */ - int const awaiting = _reels[_queue.front().reel].last_written_video_frame(); + int const awaiting = _last_written[_queue.front().reel].frame() + 1; lock.unlock (); /* i is valid here, even though we don't hold a lock on the mutex, @@ -444,8 +484,8 @@ try LOG_GENERAL ("Writer full; pushes %1 to disk while awaiting %2", i->frame, awaiting); i->encoded->write_via_temp ( - _film->j2c_path (i->reel, i->frame, i->eyes, true), - _film->j2c_path (i->reel, i->frame, i->eyes, false) + film()->j2c_path(i->reel, i->frame, i->eyes, true), + film()->j2c_path(i->reel, i->frame, i->eyes, false) ); lock.lock (); @@ -460,159 +500,262 @@ catch (...) store_current (); } + void Writer::terminate_thread (bool can_throw) { + boost::this_thread::disable_interruption dis; + boost::mutex::scoped_lock lock (_state_mutex); - if (_thread == 0) { - return; - } _finish = true; _empty_condition.notify_all (); _full_condition.notify_all (); lock.unlock (); - if (_thread->joinable ()) { - _thread->join (); - } + try { + _thread.join (); + } catch (...) {} if (can_throw) { rethrow (); } - - delete _thread; - _thread = 0; } + void -Writer::finish () +Writer::calculate_digests () { - if (!_thread) { - return; + auto job = _job.lock (); + if (job) { + job->sub (_("Computing digests")); + } + + boost::asio::io_service service; + boost::thread_group pool; + + auto work = make_shared(service); + + int const threads = max (1, Config::instance()->master_encoding_threads()); + + for (int i = 0; i < threads; ++i) { + pool.create_thread (boost::bind (&boost::asio::io_service::run, &service)); + } + + std::function set_progress; + if (job) { + set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1); + } else { + set_progress = [](float) { + boost::this_thread::interruption_point(); + }; + } + + for (auto& i: _reels) { + service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress)); + } + service.post (boost::bind (&Writer::calculate_referenced_digests, this, set_progress)); + + work.reset (); + + try { + pool.join_all (); + } catch (boost::thread_interrupted) { + /* join_all was interrupted, so we need to interrupt the threads + * in our pool then try again to join them. + */ + pool.interrupt_all (); + pool.join_all (); } - LOG_GENERAL_NC ("Terminating writer thread"); + service.stop (); +} + - terminate_thread (true); +/** @param output_dcp Path to DCP folder to write */ +void +Writer::finish (boost::filesystem::path output_dcp) +{ + if (_thread.joinable()) { + LOG_GENERAL_NC ("Terminating writer thread"); + terminate_thread (true); + } LOG_GENERAL_NC ("Finishing ReelWriters"); - BOOST_FOREACH (ReelWriter& i, _reels) { - i.finish (); + for (auto& i: _reels) { + write_hanging_text (i); + i.finish (output_dcp); } LOG_GENERAL_NC ("Writing XML"); - dcp::DCP dcp (_film->dir (_film->dcp_name())); + dcp::DCP dcp (output_dcp); - shared_ptr cpl ( - new dcp::CPL ( - _film->dcp_name(), - _film->dcp_content_type()->libdcp_kind () - ) + auto cpl = make_shared( + film()->dcp_name(), + film()->dcp_content_type()->libdcp_kind(), + film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE ); dcp.add (cpl); - /* Calculate digests for each reel in parallel */ + calculate_digests (); - shared_ptr job = _job.lock (); - job->sub (_("Computing digests")); - - boost::asio::io_service service; - boost::thread_group pool; + /* Add reels */ - shared_ptr work (new boost::asio::io_service::work (service)); + for (auto& i: _reels) { + cpl->add (i.create_reel(_reel_assets, _fonts, _chosen_interop_font, output_dcp, _have_subtitles, _have_closed_captions)); + } - int const threads = max (1, Config::instance()->master_encoding_threads ()); + /* Add metadata */ - for (int i = 0; i < threads; ++i) { - pool.create_thread (boost::bind (&boost::asio::io_service::run, &service)); + auto creator = Config::instance()->dcp_creator(); + if (creator.empty()) { + creator = String::compose("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit); } - BOOST_FOREACH (ReelWriter& i, _reels) { - boost::function set_progress = boost::bind (&Writer::set_digest_progress, this, job.get(), _1); - service.post (boost::bind (&ReelWriter::calculate_digests, &i, set_progress)); + auto issuer = Config::instance()->dcp_issuer(); + if (issuer.empty()) { + issuer = String::compose("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit); } - work.reset (); - pool.join_all (); - service.stop (); + cpl->set_creator (creator); + cpl->set_issuer (issuer); - /* Add reels to CPL */ + cpl->set_ratings (film()->ratings()); - BOOST_FOREACH (ReelWriter& i, _reels) { - cpl->add (i.create_reel (_reel_assets, _fonts)); + vector cv; + for (auto i: film()->content_versions()) { + cv.push_back (dcp::ContentVersion(i)); } + if (cv.empty()) { + cv = { dcp::ContentVersion("1") }; + } + cpl->set_content_versions (cv); - dcp::XMLMetadata meta; - meta.annotation_text = cpl->annotation_text (); - meta.creator = Config::instance()->dcp_creator (); - if (meta.creator.empty ()) { - meta.creator = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit); + cpl->set_full_content_title_text (film()->name()); + cpl->set_full_content_title_text_language (film()->name_language()); + if (film()->release_territory()) { + cpl->set_release_territory (*film()->release_territory()); + } + cpl->set_version_number (film()->version_number()); + cpl->set_status (film()->status()); + if (film()->chain()) { + cpl->set_chain (*film()->chain()); + } + if (film()->distributor()) { + cpl->set_distributor (*film()->distributor()); } - meta.issuer = Config::instance()->dcp_issuer (); - if (meta.issuer.empty ()) { - meta.issuer = String::compose ("DCP-o-matic %1 %2", dcpomatic_version, dcpomatic_git_commit); + if (film()->facility()) { + cpl->set_facility (*film()->facility()); + } + if (film()->luminance()) { + cpl->set_luminance (*film()->luminance()); + } + if (film()->sign_language_video_language()) { + cpl->set_sign_language_video_language (*film()->sign_language_video_language()); } - meta.set_issue_date_now (); - cpl->set_metadata (meta); + auto ac = film()->mapped_audio_channels(); + dcp::MCASoundField field = ( + find(ac.begin(), ac.end(), static_cast(dcp::Channel::BSL)) != ac.end() || + find(ac.begin(), ac.end(), static_cast(dcp::Channel::BSR)) != ac.end() + ) ? dcp::MCASoundField::SEVEN_POINT_ONE : dcp::MCASoundField::FIVE_POINT_ONE; - shared_ptr signer; - if (_film->is_signed ()) { - signer = Config::instance()->signer_chain (); - /* We did check earlier, but check again here to be on the safe side */ - string reason; - if (!signer->valid (&reason)) { - throw InvalidSignerError (reason); + dcp::MainSoundConfiguration msc (field, film()->audio_channels()); + for (auto i: ac) { + if (static_cast(i) < film()->audio_channels()) { + msc.set_mapping (i, static_cast(i)); } } - dcp.write_xml (_film->interop () ? dcp::INTEROP : dcp::SMPTE, meta, signer, Config::instance()->dcp_metadata_filename_format()); + cpl->set_main_sound_configuration (msc.to_string()); + cpl->set_main_sound_sample_rate (film()->audio_frame_rate()); + cpl->set_main_picture_stored_area (film()->frame_size()); + + auto active_area = film()->active_area(); + if (active_area.width > 0 && active_area.height > 0) { + /* It's not allowed to have a zero active area width or height */ + cpl->set_main_picture_active_area (active_area); + } + + auto sl = film()->subtitle_languages().second; + if (!sl.empty()) { + cpl->set_additional_subtitle_languages(sl); + } + + auto signer = Config::instance()->signer_chain(); + /* We did check earlier, but check again here to be on the safe side */ + string reason; + if (!signer->valid (&reason)) { + throw InvalidSignerError (reason); + } + + dcp.set_issuer(issuer); + dcp.set_creator(creator); + dcp.set_annotation_text(film()->dcp_name()); + + dcp.write_xml (signer, Config::instance()->dcp_metadata_filename_format()); LOG_GENERAL ( N_("Wrote %1 FULL, %2 FAKE, %3 REPEAT, %4 pushed to disk"), _full_written, _fake_written, _repeat_written, _pushed_to_disk ); - write_cover_sheet (); + write_cover_sheet (output_dcp); } + void -Writer::write_cover_sheet () +Writer::write_cover_sheet (boost::filesystem::path output_dcp) { - boost::filesystem::path const cover = _film->file ("COVER_SHEET.txt"); - FILE* f = fopen_boost (cover, "w"); + auto const cover = film()->file("COVER_SHEET.txt"); + dcp::File f(cover, "w"); if (!f) { - throw OpenFileError (cover, errno, false); + throw OpenFileError (cover, errno, OpenFileError::WRITE); } - string text = Config::instance()->cover_sheet (); - boost::algorithm::replace_all (text, "$CPL_NAME", _film->name()); - boost::algorithm::replace_all (text, "$TYPE", _film->dcp_content_type()->pretty_name()); - boost::algorithm::replace_all (text, "$CONTAINER", _film->container()->container_nickname()); - boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _film->isdcf_metadata().audio_language); - boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", _film->isdcf_metadata().subtitle_language); + auto text = Config::instance()->cover_sheet (); + boost::algorithm::replace_all (text, "$CPL_NAME", film()->name()); + auto cpls = film()->cpls(); + if (!cpls.empty()) { + boost::algorithm::replace_all (text, "$CPL_FILENAME", cpls[0].cpl_file.filename().string()); + } + boost::algorithm::replace_all (text, "$TYPE", film()->dcp_content_type()->pretty_name()); + boost::algorithm::replace_all (text, "$CONTAINER", film()->container()->container_nickname()); + + auto audio_language = film()->audio_language(); + if (audio_language) { + boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", audio_language->description()); + } else { + boost::algorithm::replace_all (text, "$AUDIO_LANGUAGE", _("None")); + } + + auto subtitle_languages = film()->subtitle_languages(); + if (subtitle_languages.first) { + boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", subtitle_languages.first->description()); + } else { + boost::algorithm::replace_all (text, "$SUBTITLE_LANGUAGE", _("None")); + } boost::uintmax_t size = 0; for ( - boost::filesystem::recursive_directory_iterator i = boost::filesystem::recursive_directory_iterator(_film->dir(_film->dcp_name())); + auto i = boost::filesystem::recursive_directory_iterator(output_dcp); i != boost::filesystem::recursive_directory_iterator(); ++i) { - if (boost::filesystem::is_regular_file (i->path ())) { - size += boost::filesystem::file_size (i->path ()); + if (boost::filesystem::is_regular_file (i->path())) { + size += boost::filesystem::file_size (i->path()); } } if (size > (1000000000L)) { - boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1GB", dcp::locale_convert (size / 1000000000.0, 1, true))); + boost::algorithm::replace_all (text, "$SIZE", String::compose("%1GB", dcp::locale_convert(size / 1000000000.0, 1, true))); } else { - boost::algorithm::replace_all (text, "$SIZE", String::compose ("%1MB", dcp::locale_convert (size / 1000000.0, 1, true))); + boost::algorithm::replace_all (text, "$SIZE", String::compose("%1MB", dcp::locale_convert(size / 1000000.0, 1, true))); } - pair ch = audio_channel_types (_film->mapped_audio_channels(), _film->audio_channels()); - string description = String::compose("%1.%2", ch.first, ch.second); + auto ch = audio_channel_types (film()->mapped_audio_channels(), film()->audio_channels()); + auto description = String::compose("%1.%2", ch.first, ch.second); if (description == "0.0") { description = _("None"); @@ -623,30 +766,29 @@ Writer::write_cover_sheet () } boost::algorithm::replace_all (text, "$AUDIO", description); - int h, m, s, fr; - _film->length().split (_film->video_frame_rate(), h, m, s, fr); + auto const hmsf = film()->length().split(film()->video_frame_rate()); string length; - if (h == 0 && m == 0) { - length = String::compose("%1s", s); - } else if (h == 0 && m > 0) { - length = String::compose("%1m%2s", m, s); - } else if (h > 0 && m > 0) { - length = String::compose("%1h%2m%3s", h, m, s); + if (hmsf.h == 0 && hmsf.m == 0) { + length = String::compose("%1s", hmsf.s); + } else if (hmsf.h == 0 && hmsf.m > 0) { + length = String::compose("%1m%2s", hmsf.m, hmsf.s); + } else if (hmsf.h > 0 && hmsf.m > 0) { + length = String::compose("%1h%2m%3s", hmsf.h, hmsf.m, hmsf.s); } boost::algorithm::replace_all (text, "$LENGTH", length); - fwrite (text.c_str(), 1, text.length(), f); - fclose (f); + f.checked_write(text.c_str(), text.length()); } + /** @param frame Frame index within the whole DCP. * @return true if we can fake-write this frame. */ bool Writer::can_fake_write (Frame frame) const { - if (_film->encrypted()) { + if (film()->encrypted()) { /* We need to re-write the frame because the asset ID is embedded in the HMAC... I think... */ return false; } @@ -655,45 +797,141 @@ Writer::can_fake_write (Frame frame) const parameters in the asset writer. */ - ReelWriter const & reel = _reels[video_reel(frame)]; + auto const & reel = _reels[video_reel(frame)]; /* Make frame relative to the start of the reel */ frame -= reel.start (); - return (frame != 0 && frame < reel.first_nonexistant_frame()); + return (frame != 0 && frame < reel.first_nonexistent_frame()); } + +/** @param track Closed caption track if type == TextType::CLOSED_CAPTION */ void -Writer::write (PlayerSubtitles subs, DCPTimePeriod period) +Writer::write (PlayerText text, TextType type, optional track, DCPTimePeriod period) { - while (_subtitle_reel->period().to <= period.from) { - ++_subtitle_reel; - DCPOMATIC_ASSERT (_subtitle_reel != _reels.end()); + vector::iterator* reel = nullptr; + + switch (type) { + case TextType::OPEN_SUBTITLE: + reel = &_subtitle_reel; + _have_subtitles = true; + break; + case TextType::CLOSED_CAPTION: + DCPOMATIC_ASSERT (track); + DCPOMATIC_ASSERT (_caption_reels.find(*track) != _caption_reels.end()); + reel = &_caption_reels[*track]; + _have_closed_captions.insert (*track); + break; + default: + DCPOMATIC_ASSERT (false); + } + + DCPOMATIC_ASSERT (*reel != _reels.end()); + while ((*reel)->period().to <= period.from) { + ++(*reel); + DCPOMATIC_ASSERT (*reel != _reels.end()); + write_hanging_text (**reel); } - DCPOMATIC_ASSERT (_subtitle_reel != _reels.end()); + auto back_off = [this](DCPTimePeriod period) { + period.to -= DCPTime::from_frames(2, film()->video_frame_rate()); + return period; + }; + + if (period.to > (*reel)->period().to) { + /* This text goes off the end of the reel. Store parts of it that should go into + * other reels. + */ + for (auto i = std::next(*reel); i != _reels.end(); ++i) { + auto overlap = i->period().overlap(period); + if (overlap) { + _hanging_texts.push_back (HangingText{text, type, track, back_off(*overlap)}); + } + } + /* Back off from the reel boundary by a couple of frames to avoid tripping checks + * for subtitles being too close together. + */ + period.to = (*reel)->period().to; + period = back_off(period); + } - _subtitle_reel->write (subs, period); + (*reel)->write(text, type, track, period, _fonts); } + void -Writer::write (list > fonts) +Writer::write (vector> fonts) { - /* Just keep a list of unique fonts and we'll deal with them in ::finish */ + if (fonts.empty()) { + return; + } - BOOST_FOREACH (shared_ptr i, fonts) { - bool got = false; - BOOST_FOREACH (shared_ptr j, _fonts) { - if (*i == *j) { - got = true; - } + /* Fonts may come in with empty IDs but we don't want to put those in the DCP */ + auto fix_id = [](string id) { + return id.empty() ? "font" : id; + }; + + if (film()->interop()) { + /* Interop will ignore second and subsequent s so we don't want to + * even write them as they upset some validators. Set up _fonts so that every + * font used by any subtitle will be written with the same ID. + */ + for (size_t i = 0; i < fonts.size(); ++i) { + _fonts.put(fonts[i], fix_id(fonts[0]->id())); } + _chosen_interop_font = fonts[0]; + } else { + set used_ids; + + /* Return the index of a _N at the end of a string, or string::npos */ + auto underscore_number_position = [](string s) { + auto last_underscore = s.find_last_of("_"); + if (last_underscore == string::npos) { + return string::npos; + } + + for (auto i = last_underscore + 1; i < s.size(); ++i) { + if (!isdigit(s[i])) { + return string::npos; + } + } + + return last_underscore; + }; - if (!got) { - _fonts.push_back (i); + /* Write fonts to _fonts, changing any duplicate IDs so that they are unique */ + for (auto font: fonts) { + auto id = fix_id(font->id()); + if (used_ids.find(id) == used_ids.end()) { + /* This ID is unique so we can just use it as-is */ + _fonts.put(font, id); + used_ids.insert(id); + } else { + auto end = underscore_number_position(id); + if (end == string::npos) { + /* This string has no _N suffix, so add one */ + id += "_0"; + end = underscore_number_position(id); + } + + ++end; + + /* Increment the suffix until we find a unique one */ + auto number = dcp::raw_convert(id.substr(end)); + while (used_ids.find(id) != used_ids.end()) { + ++number; + id = String::compose("%1_%2", id.substr(0, end - 1), number); + } + used_ids.insert(id); + } + _fonts.put(font, id); } + + DCPOMATIC_ASSERT(_fonts.map().size() == used_ids.size()); } } + bool operator< (QueueItem const & a, QueueItem const & b) { @@ -708,12 +946,14 @@ operator< (QueueItem const & a, QueueItem const & b) return static_cast (a.eyes) < static_cast (b.eyes); } + bool operator== (QueueItem const & a, QueueItem const & b) { return a.reel == b.reel && a.frame == b.frame && a.eyes == b.eyes; } + void Writer::set_encoder_threads (int threads) { @@ -722,16 +962,18 @@ Writer::set_encoder_threads (int threads) _maximum_queue_size = threads * 16; } + void Writer::write (ReferencedReelAsset asset) { _reel_assets.push_back (asset); } + size_t Writer::video_reel (int frame) const { - DCPTime t = DCPTime::from_frames (frame, _film->video_frame_rate ()); + auto t = DCPTime::from_frames (frame, film()->video_frame_rate()); size_t i = 0; while (i < _reels.size() && !_reels[i].period().contains (t)) { ++i; @@ -741,17 +983,56 @@ Writer::video_reel (int frame) const return i; } + void Writer::set_digest_progress (Job* job, float progress) { - /* I believe this is thread-safe */ - _digest_progresses[boost::this_thread::get_id()] = progress; - boost::mutex::scoped_lock lm (_digest_progresses_mutex); + + _digest_progresses[boost::this_thread::get_id()] = progress; float min_progress = FLT_MAX; - for (map::const_iterator i = _digest_progresses.begin(); i != _digest_progresses.end(); ++i) { - min_progress = min (min_progress, i->second); + for (auto const& i: _digest_progresses) { + min_progress = min (min_progress, i.second); } job->set_progress (min_progress); + + Waker waker; + waker.nudge (); + + boost::this_thread::interruption_point(); +} + + +/** Calculate hashes for any referenced MXF assets which do not already have one */ +void +Writer::calculate_referenced_digests (std::function set_progress) +try +{ + for (auto const& i: _reel_assets) { + auto file = dynamic_pointer_cast(i.asset); + if (file && !file->hash()) { + file->asset_ref().asset()->hash (set_progress); + file->set_hash (file->asset_ref().asset()->hash()); + } + } +} catch (boost::thread_interrupted) { + /* set_progress contains an interruption_point, so any of these methods + * may throw thread_interrupted, at which point we just give up. + */ +} + + +void +Writer::write_hanging_text (ReelWriter& reel) +{ + vector new_hanging_texts; + for (auto i: _hanging_texts) { + if (i.period.from == reel.period().from) { + reel.write (i.text, i.type, i.track, i.period, _fonts); + } else { + new_hanging_texts.push_back (i); + } + } + _hanging_texts = new_hanging_texts; }