X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Freel_writer.cc;h=a247349d5a08c0f75e89dfcff5ec7ed05e5a3341;hp=f6313773ef914828885bee909b416e1f4178856f;hb=c103d8c1306e5fb3937b3a6c430a3fff32653fa3;hpb=1580bdc52a257870c908f32d2abe6fed84d83c50 diff --git a/src/lib/reel_writer.cc b/src/lib/reel_writer.cc index f6313773e..a247349d5 100644 --- a/src/lib/reel_writer.cc +++ b/src/lib/reel_writer.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2019 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington This file is part of DCP-o-matic. @@ -18,154 +18,228 @@ */ -#include "reel_writer.h" -#include "film.h" + +#include "audio_buffers.h" +#include "compose.hpp" +#include "config.h" #include "cross.h" -#include "job.h" -#include "log.h" #include "dcpomatic_log.h" #include "digester.h" -#include "font.h" -#include "compose.hpp" -#include "audio_buffers.h" +#include "film.h" #include "image.h" +#include "image_png.h" +#include "job.h" +#include "log.h" +#include "reel_writer.h" +#include +#include +#include +#include +#include +#include #include -#include -#include -#include +#include #include +#include +#include +#include +#include #include -#include +#include +#include #include -#include -#include -#include -#include -#include -#include -#include +#include #include -#include +#include +#include +#include #include -#include #include "i18n.h" + +using std::dynamic_pointer_cast; +using std::exception; using std::list; -using std::string; -using std::cout; +using std::make_shared; using std::map; -using boost::shared_ptr; +using std::set; +using std::shared_ptr; +using std::string; +using std::vector; +using std::weak_ptr; using boost::optional; -using boost::dynamic_pointer_cast; +#if BOOST_VERSION >= 106100 +using namespace boost::placeholders; +#endif +using dcp::ArrayData; using dcp::Data; using dcp::raw_convert; using namespace dcpomatic; + int const ReelWriter::_info_size = 48; -/** @param job Related job, or 0 */ + +static dcp::MXFMetadata +mxf_metadata () +{ + dcp::MXFMetadata meta; + auto config = Config::instance(); + if (!config->dcp_company_name().empty()) { + meta.company_name = config->dcp_company_name (); + } + if (!config->dcp_product_name().empty()) { + meta.product_name = config->dcp_product_name (); + } + if (!config->dcp_product_version().empty()) { + meta.product_version = config->dcp_product_version (); + } + return meta; +} + + +/** @param job Related job, or 0. + * @param text_only true to enable a special mode where the writer will expect only subtitles and closed captions to be written + * (no picture nor sound) and not give errors in that case. This is used by the hints system to check the potential sizes of + * subtitle / closed caption files. + */ ReelWriter::ReelWriter ( - shared_ptr film, DCPTimePeriod period, shared_ptr job, int reel_index, int reel_count, optional content_summary + weak_ptr weak_film, DCPTimePeriod period, shared_ptr job, int reel_index, int reel_count, bool text_only ) - : _film (film) + : WeakConstFilm (weak_film) , _period (period) - , _last_written_video_frame (-1) - , _last_written_eyes (EYES_RIGHT) , _reel_index (reel_index) , _reel_count (reel_count) - , _content_summary (content_summary) + , _content_summary (film()->content_summary(period)) + , _job (job) + , _text_only (text_only) { - /* Create our picture asset in a subdirectory, named according to those - film's parameters which affect the video output. We will hard-link - it into the DCP later. + /* Create or find our picture asset in a subdirectory, named + according to those film's parameters which affect the video + output. We will hard-link it into the DCP later. */ - dcp::Standard const standard = _film->interop() ? dcp::INTEROP : dcp::SMPTE; + auto const standard = film()->interop() ? dcp::Standard::INTEROP : dcp::Standard::SMPTE; - if (_film->three_d ()) { - _picture_asset.reset (new dcp::StereoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard)); - } else { - _picture_asset.reset (new dcp::MonoPictureAsset (dcp::Fraction (_film->video_frame_rate(), 1), standard)); - } + boost::filesystem::path const asset = + film()->internal_video_asset_dir() / film()->internal_video_asset_filename(_period); - _picture_asset->set_size (_film->frame_size ()); + _first_nonexistent_frame = check_existing_picture_asset (asset); - if (_film->encrypted ()) { - _picture_asset->set_key (_film->key ()); - _picture_asset->set_context_id (_film->context_id ()); - } + if (_first_nonexistent_frame < period.duration().frames_round(film()->video_frame_rate())) { + /* We do not have a complete picture asset. If there is an + existing asset, break any hard links to it as we are about + to change its contents (if only by changing the IDs); see + #1126. + */ + if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) { + if (job) { + job->sub (_("Copying old video file")); + copy_in_bits (asset, asset.string() + ".tmp", bind(&Job::set_progress, job.get(), _1, false)); + } else { + boost::filesystem::copy_file (asset, asset.string() + ".tmp"); + } + boost::filesystem::remove (asset); + boost::filesystem::rename (asset.string() + ".tmp", asset); + } - _picture_asset->set_file ( - _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period) - ); - if (job) { - job->sub (_("Checking existing image data")); - } - _first_nonexistant_frame = check_existing_picture_asset (); + if (film()->three_d()) { + _picture_asset.reset (new dcp::StereoPictureAsset(dcp::Fraction(film()->video_frame_rate(), 1), standard)); + } else { + _picture_asset.reset (new dcp::MonoPictureAsset(dcp::Fraction(film()->video_frame_rate(), 1), standard)); + } - _picture_asset_writer = _picture_asset->start_write ( - _film->internal_video_asset_dir() / _film->internal_video_asset_filename(_period), - _first_nonexistant_frame > 0 - ); + _picture_asset->set_size (film()->frame_size()); + _picture_asset->set_metadata (mxf_metadata()); + + if (film()->encrypted()) { + _picture_asset->set_key (film()->key()); + _picture_asset->set_context_id (film()->context_id()); + } - if (_film->audio_channels ()) { - _sound_asset.reset ( - new dcp::SoundAsset (dcp::Fraction (_film->video_frame_rate(), 1), _film->audio_frame_rate (), _film->audio_channels (), standard) + _picture_asset->set_file (asset); + _picture_asset_writer = _picture_asset->start_write (asset, _first_nonexistent_frame > 0); + } else if (!text_only) { + /* We already have a complete picture asset that we can just re-use */ + /* XXX: what about if the encryption key changes? */ + if (film()->three_d()) { + _picture_asset = make_shared(asset); + } else { + _picture_asset = make_shared(asset); + } + } + + if (film()->audio_channels()) { + auto lang = film()->audio_language(); + _sound_asset = make_shared ( + dcp::Fraction(film()->video_frame_rate(), 1), + film()->audio_frame_rate(), + film()->audio_channels(), + lang ? *lang : dcp::LanguageTag("en-US"), + standard ); - if (_film->encrypted ()) { - _sound_asset->set_key (_film->key ()); + _sound_asset->set_metadata (mxf_metadata()); + + if (film()->encrypted()) { + _sound_asset->set_key (film()->key()); } - DCPOMATIC_ASSERT (_film->directory()); + DCPOMATIC_ASSERT (film()->directory()); /* Write the sound asset into the film directory so that we leave the creation of the DCP directory until the last minute. */ _sound_asset_writer = _sound_asset->start_write ( - _film->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary) + film()->directory().get() / audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary), + film()->contains_atmos_content() ); } + + _default_font = dcp::ArrayData(default_font_file()); } + /** @param frame reel-relative frame */ void ReelWriter::write_frame_info (Frame frame, Eyes eyes, dcp::FrameInfo info) const { - shared_ptr handle = _film->info_file_handle(_period, false); - dcpomatic_fseek (handle->get(), frame_info_position(frame, eyes), SEEK_SET); - checked_fwrite (&info.offset, sizeof(info.offset), handle->get(), handle->file()); - checked_fwrite (&info.size, sizeof (info.size), handle->get(), handle->file()); - checked_fwrite (info.hash.c_str(), info.hash.size(), handle->get(), handle->file()); + auto handle = film()->info_file_handle(_period, false); + handle->get().seek(frame_info_position(frame, eyes), SEEK_SET); + handle->get().checked_write(&info.offset, sizeof(info.offset)); + handle->get().checked_write(&info.size, sizeof(info.size)); + handle->get().checked_write(info.hash.c_str(), info.hash.size()); } + dcp::FrameInfo ReelWriter::read_frame_info (shared_ptr info, Frame frame, Eyes eyes) const { dcp::FrameInfo frame_info; - dcpomatic_fseek (info->get(), frame_info_position(frame, eyes), SEEK_SET); - checked_fread (&frame_info.offset, sizeof(frame_info.offset), info->get(), info->file()); - checked_fread (&frame_info.size, sizeof(frame_info.size), info->get(), info->file()); + info->get().seek(frame_info_position(frame, eyes), SEEK_SET); + info->get().checked_read(&frame_info.offset, sizeof(frame_info.offset)); + info->get().checked_read(&frame_info.size, sizeof(frame_info.size)); char hash_buffer[33]; - checked_fread (hash_buffer, 32, info->get(), info->file()); + info->get().checked_read(hash_buffer, 32); hash_buffer[32] = '\0'; frame_info.hash = hash_buffer; return frame_info; } + long ReelWriter::frame_info_position (Frame frame, Eyes eyes) const { switch (eyes) { - case EYES_BOTH: + case Eyes::BOTH: return frame * _info_size; - case EYES_LEFT: + case Eyes::LEFT: return frame * _info_size * 2; - case EYES_RIGHT: + case Eyes::RIGHT: return frame * _info_size * 2 + _info_size; default: DCPOMATIC_ASSERT (false); @@ -174,24 +248,18 @@ ReelWriter::frame_info_position (Frame frame, Eyes eyes) const DCPOMATIC_ASSERT (false); } + Frame -ReelWriter::check_existing_picture_asset () +ReelWriter::check_existing_picture_asset (boost::filesystem::path asset) { - DCPOMATIC_ASSERT (_picture_asset->file()); - boost::filesystem::path asset = _picture_asset->file().get(); + auto job = _job.lock (); - /* If there is an existing asset, break any hard links to it as we are about to change its contents - (if only by changing the IDs); see #1126. - */ - - if (boost::filesystem::exists(asset) && boost::filesystem::hard_link_count(asset) > 1) { - boost::filesystem::copy_file (asset, asset.string() + ".tmp"); - boost::filesystem::remove (asset); - boost::filesystem::rename (asset.string() + ".tmp", asset); + if (job) { + job->sub (_("Checking existing image data")); } /* Try to open the existing asset */ - FILE* asset_file = fopen_boost (asset, "rb"); + dcp::File asset_file(asset, "rb"); if (!asset_file) { LOG_GENERAL ("Could not open existing asset at %1 (errno=%2)", asset.string(), errno); return 0; @@ -202,77 +270,103 @@ ReelWriter::check_existing_picture_asset () shared_ptr info_file; try { - info_file = _film->info_file_handle (_period, true); - } catch (OpenFileError) { + info_file = film()->info_file_handle (_period, true); + } catch (OpenFileError &) { LOG_GENERAL_NC ("Could not open film info file"); - fclose (asset_file); return 0; } /* Offset of the last dcp::FrameInfo in the info file */ - int const n = (boost::filesystem::file_size(info_file->file()) / _info_size) - 1; - LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->file()), _info_size); + int const n = (boost::filesystem::file_size(info_file->get().path()) / _info_size) - 1; + LOG_GENERAL ("The last FI is %1; info file is %2, info size %3", n, boost::filesystem::file_size(info_file->get().path()), _info_size); - Frame first_nonexistant_frame; - if (_film->three_d ()) { + Frame first_nonexistent_frame; + if (film()->three_d()) { /* Start looking at the last left frame */ - first_nonexistant_frame = n / 2; + first_nonexistent_frame = n / 2; } else { - first_nonexistant_frame = n; + first_nonexistent_frame = n; } - while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistant_frame) && first_nonexistant_frame > 0) { - --first_nonexistant_frame; + while (!existing_picture_frame_ok(asset_file, info_file, first_nonexistent_frame) && first_nonexistent_frame > 0) { + --first_nonexistent_frame; } - if (!_film->three_d() && first_nonexistant_frame > 0) { + if (!film()->three_d() && first_nonexistent_frame > 0) { /* If we are doing 3D we might have found a good L frame with no R, so only do this if we're in 2D and we've just found a good B(oth) frame. */ - ++first_nonexistant_frame; + ++first_nonexistent_frame; } - LOG_GENERAL ("Proceeding with first nonexistant frame %1", first_nonexistant_frame); + LOG_GENERAL ("Proceeding with first nonexistent frame %1", first_nonexistent_frame); - fclose (asset_file); - - return first_nonexistant_frame; + return first_nonexistent_frame; } + void -ReelWriter::write (optional encoded, Frame frame, Eyes eyes) +ReelWriter::write (shared_ptr encoded, Frame frame, Eyes eyes) { - dcp::FrameInfo fin = _picture_asset_writer->write (encoded->data().get (), encoded->size()); + if (!_picture_asset_writer) { + /* We're not writing any data */ + return; + } + + auto fin = _picture_asset_writer->write (encoded->data(), encoded->size()); write_frame_info (frame, eyes, fin); - _last_written[eyes] = encoded; - _last_written_video_frame = frame; - _last_written_eyes = eyes; + _last_written[static_cast(eyes)] = encoded; } + void -ReelWriter::fake_write (Frame frame, Eyes eyes, int size) +ReelWriter::write (shared_ptr atmos, AtmosMetadata metadata) { + if (!_atmos_asset) { + _atmos_asset = metadata.create (dcp::Fraction(film()->video_frame_rate(), 1)); + if (film()->encrypted()) { + _atmos_asset->set_key(film()->key()); + } + _atmos_asset_writer = _atmos_asset->start_write ( + film()->directory().get() / atmos_asset_filename (_atmos_asset, _reel_index, _reel_count, _content_summary) + ); + } + _atmos_asset_writer->write (atmos); +} + + +void +ReelWriter::fake_write (int size) +{ + if (!_picture_asset_writer) { + /* We're not writing any data */ + return; + } + _picture_asset_writer->fake_write (size); - _last_written_video_frame = frame; - _last_written_eyes = eyes; } + void ReelWriter::repeat_write (Frame frame, Eyes eyes) { - dcp::FrameInfo fin = _picture_asset_writer->write ( - _last_written[eyes]->data().get(), - _last_written[eyes]->size() + if (!_picture_asset_writer) { + /* We're not writing any data */ + return; + } + + auto fin = _picture_asset_writer->write ( + _last_written[static_cast(eyes)]->data(), + _last_written[static_cast(eyes)]->size() ); write_frame_info (frame, eyes, fin); - _last_written_video_frame = frame; - _last_written_eyes = eyes; } + void -ReelWriter::finish () +ReelWriter::finish (boost::filesystem::path output_dcp) { - if (!_picture_asset_writer->finalize ()) { + if (_picture_asset_writer && !_picture_asset_writer->finalize ()) { /* Nothing was written to the picture asset */ LOG_GENERAL ("Nothing was written to reel %1 of %2", _reel_index, _reel_count); _picture_asset.reset (); @@ -287,18 +381,32 @@ ReelWriter::finish () if (_picture_asset) { DCPOMATIC_ASSERT (_picture_asset->file()); boost::filesystem::path video_from = _picture_asset->file().get(); - boost::filesystem::path video_to; - video_to /= _film->dir (_film->dcp_name()); + boost::filesystem::path video_to = output_dcp; video_to /= video_asset_filename (_picture_asset, _reel_index, _reel_count, _content_summary); - + /* There may be an existing "to" file if we are recreating a DCP in the same place without + changing any video. + */ boost::system::error_code ec; + boost::filesystem::remove (video_to, ec); + boost::filesystem::create_hard_link (video_from, video_to, ec); if (ec) { - LOG_WARNING_NC ("Hard-link failed; copying instead"); - boost::filesystem::copy_file (video_from, video_to, ec); - if (ec) { - LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), ec.message ()); - throw FileError (ec.message(), video_from); + LOG_WARNING("Hard-link failed (%1); copying instead", error_details(ec)); + auto job = _job.lock (); + if (job) { + job->sub (_("Copying video file into DCP")); + try { + copy_in_bits (video_from, video_to, bind(&Job::set_progress, job.get(), _1, false)); + } catch (exception& e) { + LOG_ERROR ("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), e.what()); + throw FileError (e.what(), video_from); + } + } else { + boost::filesystem::copy_file (video_from, video_to, ec); + if (ec) { + LOG_ERROR("Failed to copy video file from %1 to %2 (%3)", video_from.string(), video_to.string(), error_details(ec)); + throw FileError (ec.message(), video_from); + } } } @@ -307,89 +415,112 @@ ReelWriter::finish () /* Move the audio asset into the DCP */ if (_sound_asset) { - boost::filesystem::path audio_to; - audio_to /= _film->dir (_film->dcp_name ()); - string const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary); + boost::filesystem::path audio_to = output_dcp; + auto const aaf = audio_asset_filename (_sound_asset, _reel_index, _reel_count, _content_summary); audio_to /= aaf; boost::system::error_code ec; - boost::filesystem::rename (_film->file (aaf), audio_to, ec); + boost::filesystem::rename (film()->file(aaf), audio_to, ec); if (ec) { throw FileError ( - String::compose (_("could not move audio asset into the DCP (%1)"), ec.value ()), aaf + String::compose(_("could not move audio asset into the DCP (%1)"), error_details(ec)), aaf ); } _sound_asset->set_file (audio_to); } + + if (_atmos_asset) { + _atmos_asset_writer->finalize (); + boost::filesystem::path atmos_to = output_dcp; + auto const aaf = atmos_asset_filename (_atmos_asset, _reel_index, _reel_count, _content_summary); + atmos_to /= aaf; + + boost::system::error_code ec; + boost::filesystem::rename (film()->file(aaf), atmos_to, ec); + if (ec) { + throw FileError ( + String::compose(_("could not move atmos asset into the DCP (%1)"), error_details(ec)), aaf + ); + } + + _atmos_asset->set_file (atmos_to); + } } -template -shared_ptr + +/** Try to make a ReelAsset for a subtitles or closed captions in a given period in the DCP. + * A SubtitleAsset can be provided, or we will use one from @ref refs if not. + */ +template +shared_ptr maybe_add_text ( shared_ptr asset, int64_t picture_duration, shared_ptr reel, + int reel_index, + int reel_count, + optional content_summary, list const & refs, - list > const & fonts, + FontIdMap const& fonts, + shared_ptr chosen_interop_font, + dcp::ArrayData default_font, shared_ptr film, - DCPTimePeriod period + DCPTimePeriod period, + boost::filesystem::path output_dcp, + bool text_only ) { Frame const period_duration = period.duration().frames_round(film->video_frame_rate()); - shared_ptr reel_asset; + shared_ptr reel_asset; if (asset) { - boost::filesystem::path liberation_normal; - try { - liberation_normal = shared_path() / "LiberationSans-Regular.ttf"; - if (!boost::filesystem::exists (liberation_normal)) { - /* Hack for unit tests */ - liberation_normal = shared_path() / "fonts" / "LiberationSans-Regular.ttf"; + if (film->interop()) { + if (chosen_interop_font) { + /* We only add one font, as Interop will ignore subsequent ones (and some validators will + * complain if they are even present) + */ + asset->add_font(fonts.get(chosen_interop_font), chosen_interop_font->data().get_value_or(default_font)); + } + } else { + for (auto const& font: fonts.map()) { + asset->add_font(font.second, font.first->data().get_value_or(default_font)); } - } catch (boost::filesystem::filesystem_error& e) { - - } - - if (!boost::filesystem::exists(liberation_normal)) { - liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf"; - } - - /* Add the font to the subtitle content */ - BOOST_FOREACH (shared_ptr j, fonts) { - asset->add_font (j->id(), j->file().get_value_or(liberation_normal)); } - if (dynamic_pointer_cast (asset)) { - boost::filesystem::path directory = film->dir (film->dcp_name ()) / asset->id (); + if (auto interop = dynamic_pointer_cast(asset)) { + auto directory = output_dcp / interop->id (); boost::filesystem::create_directories (directory); - asset->write (directory / ("sub_" + asset->id() + ".xml")); - } else { + interop->write (directory / subtitle_asset_filename(asset, reel_index, reel_count, content_summary, ".xml")); + reel_asset = make_shared ( + interop, + dcp::Fraction(film->video_frame_rate(), 1), + picture_duration, + 0 + ); + } else if (auto smpte = dynamic_pointer_cast(asset)) { /* All our assets should be the same length; use the picture asset length here as a reference to set the subtitle one. We'll use the duration rather than the intrinsic duration; we don't care if the picture asset has been trimmed, we're just interested in its presentation length. */ - dynamic_pointer_cast(asset)->set_intrinsic_duration (picture_duration); - - asset->write ( - film->dir(film->dcp_name()) / ("sub_" + asset->id() + ".mxf") + smpte->set_intrinsic_duration(picture_duration); + smpte->write ( + output_dcp / subtitle_asset_filename(asset, reel_index, reel_count, content_summary, ".mxf") ); - } - - reel_asset.reset ( - new T ( - asset, - dcp::Fraction (film->video_frame_rate(), 1), + reel_asset = make_shared ( + smpte, + dcp::Fraction(film->video_frame_rate(), 1), picture_duration, 0 - ) - ); + ); + } + } else { /* We don't have a subtitle asset of our own; hopefully we have one to reference */ - BOOST_FOREACH (ReferencedReelAsset j, refs) { - shared_ptr k = dynamic_pointer_cast (j.asset); + for (auto j: refs) { + auto k = dynamic_pointer_cast (j.asset); if (k && j.period == period) { reel_asset = k; /* If we have a hash for this asset in the CPL, assume that it is correct */ @@ -401,7 +532,7 @@ maybe_add_text ( } if (reel_asset) { - if (reel_asset->actual_duration() != period_duration) { + if (!text_only && reel_asset->actual_duration() != period_duration) { throw ProgrammingError ( __FILE__, __LINE__, String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration) @@ -413,67 +544,75 @@ maybe_add_text ( return reel_asset; } -shared_ptr -ReelWriter::create_reel (list const & refs, list > const & fonts) -{ - shared_ptr reel (new dcp::Reel ()); - shared_ptr reel_picture_asset; +shared_ptr +ReelWriter::create_reel_picture (shared_ptr reel, list const & refs) const +{ + shared_ptr reel_asset; if (_picture_asset) { /* We have made a picture asset of our own. Put it into the reel */ - shared_ptr mono = dynamic_pointer_cast (_picture_asset); + auto mono = dynamic_pointer_cast (_picture_asset); if (mono) { - reel_picture_asset.reset (new dcp::ReelMonoPictureAsset (mono, 0)); + reel_asset = make_shared(mono, 0); } - shared_ptr stereo = dynamic_pointer_cast (_picture_asset); + auto stereo = dynamic_pointer_cast (_picture_asset); if (stereo) { - reel_picture_asset.reset (new dcp::ReelStereoPictureAsset (stereo, 0)); + reel_asset = make_shared(stereo, 0); } } else { LOG_GENERAL ("no picture asset of our own; look through %1", refs.size()); /* We don't have a picture asset of our own; hopefully we have one to reference */ - BOOST_FOREACH (ReferencedReelAsset j, refs) { - shared_ptr k = dynamic_pointer_cast (j.asset); + for (auto j: refs) { + auto k = dynamic_pointer_cast (j.asset); if (k) { LOG_GENERAL ("candidate picture asset period is %1-%2", j.period.from.get(), j.period.to.get()); } if (k && j.period == _period) { - reel_picture_asset = k; + reel_asset = k; } } } - LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count); + Frame const period_duration = _period.duration().frames_round(film()->video_frame_rate()); - Frame const period_duration = _period.duration().frames_round(_film->video_frame_rate()); - - DCPOMATIC_ASSERT (reel_picture_asset); - if (reel_picture_asset->duration() != period_duration) { + DCPOMATIC_ASSERT (reel_asset); + if (reel_asset->duration() != period_duration) { throw ProgrammingError ( __FILE__, __LINE__, - String::compose ("%1 vs %2", reel_picture_asset->actual_duration(), period_duration) + String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration) ); } - reel->add (reel_picture_asset); + reel->add (reel_asset); /* If we have a hash for this asset in the CPL, assume that it is correct */ - if (reel_picture_asset->hash()) { - reel_picture_asset->asset_ref()->set_hash (reel_picture_asset->hash().get()); + if (reel_asset->hash()) { + reel_asset->asset_ref()->set_hash (reel_asset->hash().get()); } - shared_ptr reel_sound_asset; + return reel_asset; +} + + +void +ReelWriter::create_reel_sound (shared_ptr reel, list const & refs) const +{ + shared_ptr reel_asset; if (_sound_asset) { /* We have made a sound asset of our own. Put it into the reel */ - reel_sound_asset.reset (new dcp::ReelSoundAsset (_sound_asset, 0)); + reel_asset = make_shared(_sound_asset, 0); } else { + LOG_GENERAL ("no sound asset of our own; look through %1", refs.size()); /* We don't have a sound asset of our own; hopefully we have one to reference */ - BOOST_FOREACH (ReferencedReelAsset j, refs) { - shared_ptr k = dynamic_pointer_cast (j.asset); + for (auto j: refs) { + auto k = dynamic_pointer_cast (j.asset); + if (k) { + LOG_GENERAL ("candidate sound asset period is %1-%2", j.period.from.get(), j.period.to.get()); + } if (k && j.period == _period) { - reel_sound_asset = k; + reel_asset = k; /* If we have a hash for this asset in the CPL, assume that it is correct */ if (k->hash()) { k->asset_ref()->set_hash (k->hash().get()); @@ -482,56 +621,173 @@ ReelWriter::create_reel (list const & refs, listactual_duration() != period_duration) { + auto const period_duration = _period.duration().frames_round(film()->video_frame_rate()); + + DCPOMATIC_ASSERT (reel_asset); + if (reel_asset->actual_duration() != period_duration) { LOG_ERROR ( "Reel sound asset has length %1 but reel period is %2", - reel_sound_asset->actual_duration(), + reel_asset->actual_duration(), period_duration ); - if (reel_sound_asset->actual_duration() != period_duration) { + if (reel_asset->actual_duration() != period_duration) { throw ProgrammingError ( __FILE__, __LINE__, - String::compose ("%1 vs %2", reel_sound_asset->actual_duration(), period_duration) + String::compose ("%1 vs %2", reel_asset->actual_duration(), period_duration) ); } } - reel->add (reel_sound_asset); + reel->add (reel_asset); +} - maybe_add_text (_subtitle_asset, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period); - for (map >::const_iterator i = _closed_caption_assets.begin(); i != _closed_caption_assets.end(); ++i) { - shared_ptr a = maybe_add_text ( - i->second, reel_picture_asset->actual_duration(), reel, refs, fonts, _film, _period + +void +ReelWriter::create_reel_text ( + shared_ptr reel, + list const & refs, + FontIdMap const& fonts, + shared_ptr chosen_interop_font, + int64_t duration, + boost::filesystem::path output_dcp, + bool ensure_subtitles, + set ensure_closed_captions + ) const +{ + auto subtitle = maybe_add_text ( + _subtitle_asset, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only + ); + + if (subtitle) { + /* We have a subtitle asset that we either made or are referencing */ + if (auto main_language = film()->subtitle_languages().first) { + subtitle->set_language (*main_language); + } + } else if (ensure_subtitles) { + /* We had no subtitle asset, but we've been asked to make sure there is one */ + subtitle = maybe_add_text ( + empty_text_asset(TextType::OPEN_SUBTITLE, optional(), true), + duration, + reel, + _reel_index, + _reel_count, + _content_summary, + refs, + fonts, + chosen_interop_font, + _default_font, + film(), + _period, + output_dcp, + _text_only ); - a->set_annotation_text (i->first.name); - a->set_language (i->first.language); } - map markers = _film->markers (); - map reel_markers; - for (map::const_iterator i = markers.begin(); i != markers.end(); ++i) { - if (_period.contains(i->second)) { - reel_markers[i->first] = i->second; + for (auto const& i: _closed_caption_assets) { + auto a = maybe_add_text ( + i.second, duration, reel, _reel_index, _reel_count, _content_summary, refs, fonts, chosen_interop_font, _default_font, film(), _period, output_dcp, _text_only + ); + DCPOMATIC_ASSERT (a); + a->set_annotation_text (i.first.name); + if (i.first.language) { + a->set_language (i.first.language.get()); + } + + ensure_closed_captions.erase (i.first); + } + + /* Make empty tracks for anything we've been asked to ensure but that we haven't added */ + for (auto i: ensure_closed_captions) { + auto a = maybe_add_text ( + empty_text_asset(TextType::CLOSED_CAPTION, i, true), + duration, + reel, + _reel_index, + _reel_count, + _content_summary, + refs, + fonts, + chosen_interop_font, + _default_font, + film(), + _period, + output_dcp, + _text_only + ); + DCPOMATIC_ASSERT (a); + a->set_annotation_text (i.name); + if (i.language) { + a->set_language (i.language.get()); + } + } +} + + +void +ReelWriter::create_reel_markers (shared_ptr reel) const +{ + auto markers = film()->markers(); + film()->add_ffoc_lfoc(markers); + Film::Markers reel_markers; + for (auto const& i: markers) { + if (_period.contains(i.second)) { + reel_markers[i.first] = i.second; } } if (!reel_markers.empty ()) { - shared_ptr ma (new dcp::ReelMarkersAsset(dcp::Fraction(_film->video_frame_rate(), 1), 0)); - for (map::const_iterator i = reel_markers.begin(); i != reel_markers.end(); ++i) { - int h, m, s, f; - DCPTime relative = i->second - _period.from; - relative.split (_film->video_frame_rate(), h, m, s, f); - ma->set (i->first, dcp::Time(h, m, s, f, _film->video_frame_rate())); + auto ma = make_shared(dcp::Fraction(film()->video_frame_rate(), 1), reel->duration()); + for (auto const& i: reel_markers) { + DCPTime relative = i.second - _period.from; + auto hmsf = relative.split (film()->video_frame_rate()); + ma->set (i.first, dcp::Time(hmsf.h, hmsf.m, hmsf.s, hmsf.f, film()->video_frame_rate())); } reel->add (ma); } +} + + +/** @param ensure_subtitles true to make sure the reel has a subtitle asset. + * @param ensure_closed_captions make sure the reel has these closed caption tracks. + */ +shared_ptr +ReelWriter::create_reel ( + list const & refs, + FontIdMap const & fonts, + shared_ptr chosen_interop_font, + boost::filesystem::path output_dcp, + bool ensure_subtitles, + set ensure_closed_captions + ) +{ + LOG_GENERAL ("create_reel for %1-%2; %3 of %4", _period.from.get(), _period.to.get(), _reel_index, _reel_count); + + auto reel = make_shared(); + + /* This is a bit of a hack; in the strange `_text_only' mode we have no picture, so we don't know + * how long the subtitle / CCAP assets should be. However, since we're only writing them to see + * how big they are, we don't care about that. + */ + int64_t duration = 0; + if (!_text_only) { + auto reel_picture_asset = create_reel_picture (reel, refs); + duration = reel_picture_asset->actual_duration (); + create_reel_sound (reel, refs); + create_reel_markers (reel); + } + + create_reel_text (reel, refs, fonts, chosen_interop_font, duration, output_dcp, ensure_subtitles, ensure_closed_captions); + + if (_atmos_asset) { + reel->add (make_shared(_atmos_asset, 0)); + } return reel; } void -ReelWriter::calculate_digests (boost::function set_progress) +ReelWriter::calculate_digests (std::function set_progress) +try { if (_picture_asset) { _picture_asset->hash (set_progress); @@ -540,12 +796,21 @@ ReelWriter::calculate_digests (boost::function set_progress) if (_sound_asset) { _sound_asset->hash (set_progress); } + + if (_atmos_asset) { + _atmos_asset->hash (set_progress); + } +} 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. + */ } + Frame ReelWriter::start () const { - return _period.from.frames_floor (_film->video_frame_rate()); + return _period.from.frames_floor (film()->video_frame_rate()); } @@ -560,16 +825,82 @@ ReelWriter::write (shared_ptr audio) _sound_asset_writer->write (audio->data(), audio->frames()); } + +shared_ptr +ReelWriter::empty_text_asset (TextType type, optional track, bool with_dummy) const +{ + shared_ptr asset; + + auto lang = film()->subtitle_languages(); + if (film()->interop()) { + auto s = make_shared(); + s->set_movie_title (film()->name()); + if (type == TextType::OPEN_SUBTITLE) { + s->set_language (lang.first ? lang.first->to_string() : "Unknown"); + } else if (track->language) { + s->set_language (track->language->to_string()); + } + s->set_reel_number (raw_convert (_reel_index + 1)); + asset = s; + } else { + auto s = make_shared(); + s->set_content_title_text (film()->name()); + s->set_metadata (mxf_metadata()); + if (type == TextType::OPEN_SUBTITLE && lang.first) { + s->set_language (*lang.first); + } else if (track && track->language) { + s->set_language (dcp::LanguageTag(track->language->to_string())); + } + s->set_edit_rate (dcp::Fraction (film()->video_frame_rate(), 1)); + s->set_reel_number (_reel_index + 1); + s->set_time_code_rate (film()->video_frame_rate()); + s->set_start_time (dcp::Time ()); + if (film()->encrypted()) { + s->set_key (film()->key()); + } + if (with_dummy) { + s->add ( + std::make_shared( + optional(), + false, + false, + false, + dcp::Colour(), + 42, + 1.0, + dcp::Time(0, 0, 0, 0, 24), + dcp::Time(0, 0, 1, 0, 24), + 0.5, + dcp::HAlign::CENTER, + 0.5, + dcp::VAlign::CENTER, + dcp::Direction::LTR, + " ", + dcp::Effect::NONE, + dcp::Colour(), + dcp::Time(), + dcp::Time(), + 0 + ) + ); + } + asset = s; + } + + return asset; +} + + void -ReelWriter::write (PlayerText subs, TextType type, optional track, DCPTimePeriod period) +ReelWriter::write (PlayerText subs, TextType type, optional track, DCPTimePeriod period, FontIdMap const& fonts) { shared_ptr asset; switch (type) { - case TEXT_OPEN_SUBTITLE: + case TextType::OPEN_SUBTITLE: asset = _subtitle_asset; break; - case TEXT_CLOSED_CAPTION: + case TextType::CLOSED_CAPTION: DCPOMATIC_ASSERT (track); asset = _closed_caption_assets[*track]; break; @@ -578,41 +909,14 @@ ReelWriter::write (PlayerText subs, TextType type, optional track, } if (!asset) { - string lang = _film->subtitle_language (); - if (_film->interop ()) { - shared_ptr s (new dcp::InteropSubtitleAsset ()); - s->set_movie_title (_film->name ()); - if (type == TEXT_OPEN_SUBTITLE) { - s->set_language (lang.empty() ? "Unknown" : lang); - } else { - s->set_language (track->language); - } - s->set_reel_number (raw_convert (_reel_index + 1)); - asset = s; - } else { - shared_ptr s (new dcp::SMPTESubtitleAsset ()); - s->set_content_title_text (_film->name ()); - if (type == TEXT_OPEN_SUBTITLE && !lang.empty()) { - s->set_language (lang); - } else { - s->set_language (track->language); - } - s->set_edit_rate (dcp::Fraction (_film->video_frame_rate (), 1)); - s->set_reel_number (_reel_index + 1); - s->set_time_code_rate (_film->video_frame_rate ()); - s->set_start_time (dcp::Time ()); - if (_film->encrypted ()) { - s->set_key (_film->key ()); - } - asset = s; - } + asset = empty_text_asset (type, track, false); } switch (type) { - case TEXT_OPEN_SUBTITLE: + case TextType::OPEN_SUBTITLE: _subtitle_asset = asset; break; - case TEXT_CLOSED_CAPTION: + case TextType::CLOSED_CAPTION: DCPOMATIC_ASSERT (track); _closed_caption_assets[*track] = asset; break; @@ -620,51 +924,56 @@ ReelWriter::write (PlayerText subs, TextType type, optional track, DCPOMATIC_ASSERT (false); } - BOOST_FOREACH (StringText i, subs.string) { - /* XXX: couldn't / shouldn't we use period here rather than getting time from the subtitle? */ - i.set_in (i.in() - dcp::Time (_period.from.seconds(), i.in().tcr)); - i.set_out (i.out() - dcp::Time (_period.from.seconds(), i.out().tcr)); - asset->add (shared_ptr(new dcp::SubtitleString(i))); + /* timecode rate for subtitles we emit; we might as well stick to ms accuracy here, I think */ + auto const tcr = 1000; + + for (auto i: subs.string) { + i.set_in (dcp::Time(period.from.seconds() - _period.from.seconds(), tcr)); + i.set_out (dcp::Time(period.to.seconds() - _period.from.seconds(), tcr)); + auto sub = make_shared(i); + if (type == TextType::OPEN_SUBTITLE) { + sub->set_font(fonts.get(i.font)); + } + asset->add(sub); } - BOOST_FOREACH (BitmapText i, subs.bitmap) { + for (auto i: subs.bitmap) { asset->add ( - shared_ptr( - new dcp::SubtitleImage( - i.image->as_png(), - dcp::Time(period.from.seconds() - _period.from.seconds(), _film->video_frame_rate()), - dcp::Time(period.to.seconds() - _period.from.seconds(), _film->video_frame_rate()), - i.rectangle.x, dcp::HALIGN_LEFT, i.rectangle.y, dcp::VALIGN_TOP, - dcp::Time(), dcp::Time() - ) + make_shared( + image_as_png(i.image), + dcp::Time(period.from.seconds() - _period.from.seconds(), tcr), + dcp::Time(period.to.seconds() - _period.from.seconds(), tcr), + i.rectangle.x, dcp::HAlign::LEFT, i.rectangle.y, dcp::VAlign::TOP, + dcp::Time(), dcp::Time() ) ); } } + bool -ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr info_file, Frame frame) const +ReelWriter::existing_picture_frame_ok (dcp::File& asset_file, shared_ptr info_file, Frame frame) const { LOG_GENERAL ("Checking existing picture frame %1", frame); /* Read the data from the info file; for 3D we just check the left frames until we find a good one. */ - dcp::FrameInfo const info = read_frame_info (info_file, frame, _film->three_d () ? EYES_LEFT : EYES_BOTH); + auto const info = read_frame_info (info_file, frame, film()->three_d() ? Eyes::LEFT : Eyes::BOTH); bool ok = true; /* Read the data from the asset and hash it */ - dcpomatic_fseek (asset_file, info.offset, SEEK_SET); - Data data (info.size); - size_t const read = fread (data.data().get(), 1, data.size(), asset_file); + asset_file.seek(info.offset, SEEK_SET); + ArrayData data (info.size); + size_t const read = asset_file.read(data.data(), 1, data.size()); LOG_GENERAL ("Read %1 bytes of asset data; wanted %2", read, info.size); if (read != static_cast (data.size ())) { LOG_GENERAL ("Existing frame %1 is incomplete", frame); ok = false; } else { Digester digester; - digester.add (data.data().get(), data.size()); + digester.add (data.data(), data.size()); LOG_GENERAL ("Hash %1 vs %2", digester.get(), info.hash); if (digester.get() != info.hash) { LOG_GENERAL ("Existing frame %1 failed hash check", frame);