X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Freel_writer.cc;h=a247349d5a08c0f75e89dfcff5ec7ed05e5a3341;hp=294c0b7b64c85ecc214e1f0e8974c738d2134c2d;hb=c103d8c1306e5fb3937b3a6c430a3fff32653fa3;hpb=ef31a94cd00dcc88fc83093cbc709b5b79acc4b6 diff --git a/src/lib/reel_writer.cc b/src/lib/reel_writer.cc index 294c0b7b6..a247349d5 100644 --- a/src/lib/reel_writer.cc +++ b/src/lib/reel_writer.cc @@ -18,64 +18,69 @@ */ -#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_data.h" -#include "compose.hpp" -#include "config.h" -#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 "i18n.h" -using std::list; -using std::string; -using std::cout; + +using std::dynamic_pointer_cast; using std::exception; +using std::list; +using std::make_shared; using std::map; using std::set; -using std::vector; using std::shared_ptr; -using std::make_shared; +using std::string; +using std::vector; +using std::weak_ptr; using boost::optional; -using std::dynamic_pointer_cast; #if BOOST_VERSION >= 106100 using namespace boost::placeholders; #endif -using std::weak_ptr; using dcp::ArrayData; using dcp::Data; using dcp::raw_convert; using namespace dcpomatic; + int const ReelWriter::_info_size = 48; + static dcp::MXFMetadata mxf_metadata () { @@ -93,6 +98,7 @@ mxf_metadata () 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 @@ -119,9 +125,9 @@ ReelWriter::ReelWriter ( boost::filesystem::path const asset = film()->internal_video_asset_dir() / film()->internal_video_asset_filename(_period); - _first_nonexistant_frame = check_existing_picture_asset (asset); + _first_nonexistent_frame = check_existing_picture_asset (asset); - if (_first_nonexistant_frame < period.duration().frames_round(film()->video_frame_rate())) { + 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 @@ -154,7 +160,7 @@ ReelWriter::ReelWriter ( } _picture_asset->set_file (asset); - _picture_asset_writer = _picture_asset->start_write (asset, _first_nonexistant_frame > 0); + _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? */ @@ -166,8 +172,13 @@ ReelWriter::ReelWriter ( } 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(), film()->audio_language(), standard + dcp::Fraction(film()->video_frame_rate(), 1), + film()->audio_frame_rate(), + film()->audio_channels(), + lang ? *lang : dcp::LanguageTag("en-US"), + standard ); _sound_asset->set_metadata (mxf_metadata()); @@ -178,17 +189,11 @@ ReelWriter::ReelWriter ( DCPOMATIC_ASSERT (film()->directory()); - vector active; - for (auto i: film()->mapped_audio_channels()) { - active.push_back (static_cast(i)); - } - /* 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), - active, film()->contains_atmos_content() ); } @@ -196,33 +201,36 @@ ReelWriter::ReelWriter ( _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 { auto 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()); + 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 { @@ -240,6 +248,7 @@ ReelWriter::frame_info_position (Frame frame, Eyes eyes) const DCPOMATIC_ASSERT (false); } + Frame ReelWriter::check_existing_picture_asset (boost::filesystem::path asset) { @@ -250,7 +259,7 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset) } /* Try to open the existing asset */ - auto 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; @@ -264,40 +273,38 @@ ReelWriter::check_existing_picture_asset (boost::filesystem::path asset) 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; + 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); - - fclose (asset_file); + LOG_GENERAL ("Proceeding with first nonexistent frame %1", first_nonexistent_frame); - return first_nonexistant_frame; + return first_nonexistent_frame; } + void ReelWriter::write (shared_ptr encoded, Frame frame, Eyes eyes) { @@ -339,6 +346,7 @@ ReelWriter::fake_write (int size) _picture_asset_writer->fake_write (size); } + void ReelWriter::repeat_write (Frame frame, Eyes eyes) { @@ -354,6 +362,7 @@ ReelWriter::repeat_write (Frame frame, Eyes eyes) write_frame_info (frame, eyes, fin); } + void ReelWriter::finish (boost::filesystem::path output_dcp) { @@ -382,7 +391,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp) boost::filesystem::create_hard_link (video_from, video_to, ec); if (ec) { - LOG_WARNING_NC ("Hard-link failed; copying instead"); + LOG_WARNING("Hard-link failed (%1); copying instead", error_details(ec)); auto job = _job.lock (); if (job) { job->sub (_("Copying video file into DCP")); @@ -395,7 +404,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp) } 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(), ec.message()); + 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); } } @@ -414,7 +423,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp) 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 ); } @@ -431,7 +440,7 @@ ReelWriter::finish (boost::filesystem::path output_dcp) boost::filesystem::rename (film()->file(aaf), atmos_to, ec); if (ec) { throw FileError ( - String::compose (_("could not move atmos asset into the DCP (%1)"), ec.value ()), aaf + String::compose(_("could not move atmos asset into the DCP (%1)"), error_details(ec)), aaf ); } @@ -439,14 +448,22 @@ ReelWriter::finish (boost::filesystem::path output_dcp) } } -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, - vector const & fonts, + FontIdMap const& fonts, + shared_ptr chosen_interop_font, dcp::ArrayData default_font, shared_ptr film, DCPTimePeriod period, @@ -456,41 +473,54 @@ maybe_add_text ( { Frame const period_duration = period.duration().frames_round(film->video_frame_rate()); - shared_ptr reel_asset; + shared_ptr reel_asset; if (asset) { - /* Add the font to the subtitle content */ - for (auto const& j: fonts) { - asset->add_font (j.id, j.data.get_value_or(default_font)); + 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)); + } } - if (dynamic_pointer_cast (asset)) { - auto directory = output_dcp / 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 ( - output_dcp / ("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 = make_shared ( + smpte, + dcp::Fraction(film->video_frame_rate(), 1), + picture_duration, + 0 ); } - reel_asset = make_shared ( - asset, - 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 */ for (auto j: refs) { - auto k = dynamic_pointer_cast (j.asset); + 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 */ @@ -616,30 +646,35 @@ void ReelWriter::create_reel_text ( shared_ptr reel, list const & refs, - vector const& fonts, + 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, refs, fonts, _default_font, film(), _period, output_dcp, _text_only + 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 (!film()->subtitle_languages().empty()) { - subtitle->set_language (film()->subtitle_languages().front()); + 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()), + 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, @@ -649,13 +684,13 @@ ReelWriter::create_reel_text ( } for (auto const& i: _closed_caption_assets) { - auto a = maybe_add_text ( - i.second, duration, reel, refs, fonts, _default_font, film(), _period, output_dcp, _text_only + 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.empty()) { - a->set_language (dcp::LanguageTag(i.first.language)); + if (i.first.language) { + a->set_language (i.first.language.get()); } ensure_closed_captions.erase (i.first); @@ -663,19 +698,31 @@ ReelWriter::create_reel_text ( /* 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), duration, reel, refs, fonts, _default_font, film(), _period, output_dcp, _text_only + 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.empty()) { - a->set_language (dcp::LanguageTag(i.language)); + if (i.language) { + a->set_language (i.language.get()); } } } - void ReelWriter::create_reel_markers (shared_ptr reel) const { @@ -689,7 +736,7 @@ ReelWriter::create_reel_markers (shared_ptr reel) const } if (!reel_markers.empty ()) { - auto ma = make_shared(dcp::Fraction(film()->video_frame_rate(), 1), reel->duration(), 0); + 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()); @@ -706,7 +753,8 @@ ReelWriter::create_reel_markers (shared_ptr reel) const shared_ptr ReelWriter::create_reel ( list const & refs, - vector const & fonts, + FontIdMap const & fonts, + shared_ptr chosen_interop_font, boost::filesystem::path output_dcp, bool ensure_subtitles, set ensure_closed_captions @@ -728,7 +776,7 @@ ReelWriter::create_reel ( create_reel_markers (reel); } - create_reel_text (reel, refs, fonts, duration, output_dcp, ensure_subtitles, ensure_closed_captions); + 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)); @@ -738,7 +786,8 @@ ReelWriter::create_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); @@ -751,8 +800,13 @@ ReelWriter::calculate_digests (boost::function 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 { @@ -773,7 +827,7 @@ ReelWriter::write (shared_ptr audio) shared_ptr -ReelWriter::empty_text_asset (TextType type, optional track) const +ReelWriter::empty_text_asset (TextType type, optional track, bool with_dummy) const { shared_ptr asset; @@ -782,9 +836,9 @@ ReelWriter::empty_text_asset (TextType type, optional track) const auto s = make_shared(); s->set_movie_title (film()->name()); if (type == TextType::OPEN_SUBTITLE) { - s->set_language (lang.empty() ? "Unknown" : lang.front().to_string()); - } else if (!track->language.empty()) { - s->set_language (track->language); + 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; @@ -792,10 +846,10 @@ ReelWriter::empty_text_asset (TextType type, optional track) const auto s = make_shared(); s->set_content_title_text (film()->name()); s->set_metadata (mxf_metadata()); - if (type == TextType::OPEN_SUBTITLE && !lang.empty()) { - s->set_language (lang.front()); - } else if (track && !track->language.empty()) { - s->set_language (dcp::LanguageTag(track->language)); + 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); @@ -804,29 +858,32 @@ ReelWriter::empty_text_asset (TextType type, optional track) const if (film()->encrypted()) { s->set_key (film()->key()); } - 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() - ) - ); + 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; } @@ -835,7 +892,7 @@ ReelWriter::empty_text_asset (TextType type, optional track) const 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; @@ -852,7 +909,7 @@ ReelWriter::write (PlayerText subs, TextType type, optional track, } if (!asset) { - asset = empty_text_asset (type, track); + asset = empty_text_asset (type, track, false); } switch (type) { @@ -873,13 +930,17 @@ ReelWriter::write (PlayerText subs, TextType type, optional track, 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)); - asset->add (make_shared(i)); + auto sub = make_shared(i); + if (type == TextType::OPEN_SUBTITLE) { + sub->set_font(fonts.get(i.font)); + } + asset->add(sub); } for (auto i: subs.bitmap) { asset->add ( make_shared( - i.image->as_png(), + 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, @@ -889,8 +950,9 @@ ReelWriter::write (PlayerText subs, TextType type, optional track, } } + 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); @@ -902,9 +964,9 @@ ReelWriter::existing_picture_frame_ok (FILE* asset_file, shared_ptr (data.size ())) { LOG_GENERAL ("Existing frame %1 is incomplete", frame);