X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fhints.cc;h=bbd5ae5d594e5a3b1b81ac4f3ad1ab7bb4ba10ae;hb=HEAD;hp=6228f0a48a7df0e6e2ebce0d5988b7b8a3bf061e;hpb=b78068f34be9adfa7a9018643d46e3917f132070;p=dcpomatic.git diff --git a/src/lib/hints.cc b/src/lib/hints.cc index 6228f0a48..2e2a8fd7b 100644 --- a/src/lib/hints.cc +++ b/src/lib/hints.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2016-2019 Carl Hetherington + Copyright (C) 2016-2022 Carl Hetherington This file is part of DCP-o-matic. @@ -18,35 +18,43 @@ */ -#include "hints.h" -#include "types.h" -#include "film.h" -#include "content.h" -#include "video_content.h" -#include "text_content.h" -#include "audio_processor.h" -#include "font.h" -#include "ratio.h" + #include "audio_analysis.h" +#include "audio_content.h" +#include "audio_processor.h" #include "compose.hpp" -#include "util.h" +#include "config.h" +#include "constants.h" +#include "content.h" #include "cross.h" +#include "dcp_content_type.h" +#include "film.h" +#include "font.h" +#include "hints.h" +#include "maths_util.h" #include "player.h" +#include "ratio.h" +#include "text_content.h" +#include "video_content.h" +#include "writer.h" +#include +#include #include -#include +#include +#include +#include #include #include #include "i18n.h" -using std::vector; -using std::string; -using std::pair; -using std::min; -using std::max; + using std::cout; -using boost::shared_ptr; -using boost::weak_ptr; +using std::make_shared; +using std::max; +using std::shared_ptr; +using std::string; +using std::weak_ptr; using boost::optional; using boost::bind; using namespace dcpomatic; @@ -54,22 +62,35 @@ using namespace dcpomatic; using namespace boost::placeholders; #endif -Hints::Hints (weak_ptr film) - : _film (film) - , _long_ccap (false) - , _overlap_ccap (false) - , _too_many_ccap_lines (false) + +/* When checking to see if things are too big, we'll say they are if they + * are more than the target size minus this "slack." + */ +#define SIZE_SLACK 4096 + + +/* When writing hints: + * - put quotation marks around the name of a GUI tab that you are referring to (e.g. "DCP" or "DCP→Video" tab) + */ + + +Hints::Hints (weak_ptr weak_film) + : WeakConstFilm (weak_film) + , _writer (new Writer(weak_film, weak_ptr(), true)) + , _analyser (film(), film()->playlist(), true, [](float) {}) , _stop (false) { } + void Hints::start () { _thread = boost::thread (bind(&Hints::thread, this)); } + Hints::~Hints () { boost::this_thread::disable_interruption dis; @@ -94,7 +115,7 @@ Hints::check_few_audio_channels () void Hints::check_upmixers () { - AudioProcessor const * ap = film()->audio_processor(); + auto ap = film()->audio_processor(); if (ap && (ap->id() == "stereo-5.1-upmix-a" || ap->id() == "stereo-5.1-upmix-b")) { hint (_("You are using DCP-o-matic's stereo-to-5.1 upmixer. This is experimental and may result in poor-quality audio. If you continue, you should listen to the resulting DCP in a cinema to make sure that it sounds good.")); } @@ -106,9 +127,9 @@ Hints::check_incorrect_container () { int narrower_than_scope = 0; int scope = 0; - BOOST_FOREACH (shared_ptr i, film()->content()) { - if (i->video) { - Ratio const * r = Ratio::nearest_from_ratio(i->video->scaled_size(film()->frame_size()).ratio()); + for (auto i: film()->content()) { + if (i->video && i->video->size()) { + auto const r = Ratio::nearest_from_ratio(i->video->scaled_size(film()->frame_size())->ratio()); if (r && r->id() == "239") { ++scope; } else if (r && r->id() != "239" && r->id() != "235" && r->id() != "190") { @@ -132,9 +153,9 @@ Hints::check_incorrect_container () void Hints::check_unusual_container () { - string const film_container = film()->container()->id(); - if (film_container != "185" && film_container != "239" && film_container != "190") { - hint (_("Your DCP uses an unusual container ratio. This may cause problems on some projectors. If possible, use Flat or Scope for the DCP container ratio")); + auto const film_container = film()->container()->id(); + if (film_container != "185" && film_container != "239") { + hint (_("Your DCP uses an unusual container ratio. This may cause problems on some projectors. If possible, use Flat or Scope for the DCP container ratio.")); } } @@ -151,7 +172,7 @@ Hints::check_high_j2k_bandwidth () void Hints::check_frame_rate () { - shared_ptr f = film (); + auto f = film (); switch (f->video_frame_rate()) { case 24: /* Fine */ @@ -175,18 +196,28 @@ Hints::check_frame_rate () case 50: case 60: /* You almost certainly want to go to half frame rate */ - hint (String::compose(_("You are set up for a DCP at a frame rate of %1 fps. This frame rate is not supported by all projectors. You are advised to change the DCP frame rate to %2 fps."), f->video_frame_rate(), f->video_frame_rate() / 2)); + hint (String::compose(_("You are set up for a DCP at a frame rate of %1 fps. This frame rate is not supported by all projectors. It is advisable to change the DCP frame rate to %2 fps."), f->video_frame_rate(), f->video_frame_rate() / 2)); break; } } +void +Hints::check_4k_3d () +{ + auto f = film(); + if (f->resolution() == Resolution::FOUR_K && f->three_d()) { + hint (_("4K 3D is only supported by a very limited number of projectors. Unless you know that you will play this DCP back on a capable projector, it is advisable to set the DCP to be 2K in the \"DCP→Video\" tab.")); + } +} + + void Hints::check_speed_up () { optional lowest_speed_up; optional highest_speed_up; - BOOST_FOREACH (shared_ptr i, film()->content()) { + for (auto i: film()->content()) { double spu = film()->active_frame_rate_change(i->position()).speed_up; if (!lowest_speed_up || spu < *lowest_speed_up) { lowest_speed_up = spu; @@ -205,22 +236,31 @@ Hints::check_speed_up () } if (worst_speed_up > 25.5/24.0) { - hint (_("There is a large difference between the frame rate of your DCP and that of some of your content. This will cause your audio to play back at a much lower or higher pitch than it should. You are advised to set your DCP frame rate to one closer to your content, provided that your target projection systems support your chosen DCP rate.")); + hint (_("There is a large difference between the frame rate of your DCP and that of some of your content. This will cause your audio to play back at a much lower or higher pitch than it should. It is advisable to set your DCP frame rate to one closer to your content, provided that your target projection systems support your chosen DCP rate.")); } } +void +Hints::check_interop () +{ + if (film()->interop()) { + hint (_("In general it is now advisable to make SMPTE DCPs unless you have a particular reason to use Interop. It is advisable to set your DCP to use the SMPTE standard in the \"DCP\" tab.")); + } +} + + void Hints::check_big_font_files () { bool big_font_files = false; if (film()->interop ()) { - BOOST_FOREACH (shared_ptr i, film()->content()) { - BOOST_FOREACH (shared_ptr j, i->text) { - BOOST_FOREACH (shared_ptr k, j->fonts()) { - optional const p = k->file (); - if (p && boost::filesystem::file_size(p.get()) >= (640 * 1024)) { + for (auto i: film()->content()) { + for (auto j: i->text) { + for (auto k: j->fonts()) { + auto const p = k->file (); + if (p && dcp::filesystem::file_size(p.get()) >= (MAX_FONT_FILE_SIZE - SIZE_SLACK)) { big_font_files = true; } } @@ -238,8 +278,8 @@ void Hints::check_vob () { int vob = 0; - BOOST_FOREACH (shared_ptr i, film()->content()) { - if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) { + for (auto i: film()->content()) { + if (boost::algorithm::starts_with(i->path(0).filename().string(), "VTS_")) { ++vob; } } @@ -254,8 +294,8 @@ void Hints::check_3d_in_2d () { int three_d = 0; - BOOST_FOREACH (shared_ptr i, film()->content()) { - if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) { + for (auto i: film()->content()) { + if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) { ++three_d; } } @@ -266,55 +306,151 @@ Hints::check_3d_in_2d () } -void +/** @return true if the loudness could be checked, false if it could not because no analysis was available */ +bool Hints::check_loudness () { - boost::filesystem::path path = film()->audio_analysis_path(film()->playlist()); - if (boost::filesystem::exists (path)) { - try { - shared_ptr an (new AudioAnalysis (path)); + auto path = film()->audio_analysis_path(film()->playlist()); + if (!dcp::filesystem::exists(path)) { + return false; + } - string ch; + try { + auto an = make_shared(path); - vector sample_peak = an->sample_peak (); - vector true_peak = an->true_peak (); + string ch; - for (size_t i = 0; i < sample_peak.size(); ++i) { - float const peak = max (sample_peak[i].peak, true_peak.empty() ? 0 : true_peak[i]); - float const peak_dB = linear_to_db(peak) + an->gain_correction(film()->playlist()); - if (peak_dB > -3) { - ch += dcp::raw_convert (short_audio_channel_name (i)) + ", "; - } + auto sample_peak = an->sample_peak (); + auto true_peak = an->true_peak (); + + for (size_t i = 0; i < sample_peak.size(); ++i) { + float const peak = max (sample_peak[i].peak, true_peak.empty() ? 0 : true_peak[i]); + float const peak_dB = linear_to_db(peak) + an->gain_correction(film()->playlist()); + if (peak_dB > -3) { + ch += dcp::raw_convert(short_audio_channel_name(i)) + ", "; } + } + + ch = ch.substr (0, ch.length() - 2); + + if (!ch.empty()) { + hint(String::compose( + _("Your audio level is very high (on %1). You should reduce the gain of your audio content."), + ch + ) + ); + } + } catch (OldFormatError& e) { + /* The audio analysis is too old to load in */ + return false; + } + + return true; +} + + +static +bool +subtitle_mxf_too_big (shared_ptr asset) +{ + return asset && asset->file() && dcp::filesystem::file_size(*asset->file()) >= (MAX_TEXT_MXF_SIZE - SIZE_SLACK); +} + + +void +Hints::check_out_of_range_markers () +{ + auto const length = film()->length(); + for (auto const& i: film()->markers()) { + if (i.second >= length) { + hint (_("At least one marker comes after the end of the project and will be ignored.")); + } + } +} + + +void +Hints::scan_content(shared_ptr film) +{ + auto const check_loudness_done = check_loudness(); + + auto content = film->playlist()->content(); + auto iter = std::find_if(content.begin(), content.end(), [](shared_ptr content) { + auto text_iter = std::find_if(content->text.begin(), content->text.end(), [](shared_ptr text) { + return text->use(); + }); + return text_iter != content->text.end(); + }); + + auto const have_text = iter != content.end(); + + if (check_loudness_done && !have_text) { + /* We don't need to check loudness, and we don't have any active text to check, + * so a scan of the content is pointless. + */ + return; + } + + if (check_loudness_done && have_text) { + emit (bind(boost::ref(Progress), _("Examining subtitles and closed captions"))); + } else if (!check_loudness_done && !have_text) { + emit (bind(boost::ref(Progress), _("Examining audio"))); + } else { + emit (bind(boost::ref(Progress), _("Examining audio, subtitles and closed captions"))); + } + + auto player = make_shared(film, Image::Alignment::COMPACT); + player->set_ignore_video(); + if (check_loudness_done || _disable_audio_analysis) { + /* We don't need to analyse audio because we already loaded a suitable analysis */ + player->set_ignore_audio(); + } else { + /* Send auto to the analyser to check loudness */ + player->Audio.connect(bind(&Hints::audio, this, _1, _2)); + } + player->Text.connect(bind(&Hints::text, this, _1, _2, _3, _4)); + + struct timeval last_pulse; + gettimeofday(&last_pulse, 0); + + _writer->write(player->get_subtitle_fonts()); - ch = ch.substr (0, ch.length() - 2); + while (!player->pass()) { - if (!ch.empty ()) { - hint (String::compose ( - _("Your audio level is very high (on %1). You should reduce the gain of your audio content."), - ch - ) - ); + struct timeval now; + gettimeofday(&now, 0); + if ((seconds(now) - seconds(last_pulse)) > 1) { + if (_stop) { + return; } - } catch (OldFormatError& e) { - /* The audio analysis is too old to load in; just skip this hint as if - it had never been run. - */ + emit(bind(boost::ref(Pulse))); + last_pulse = now; } } + + if (!check_loudness_done) { + _analyser.finish(); + _analyser.get().write(film->audio_analysis_path(film->playlist())); + check_loudness(); + } } void Hints::thread () +try { - shared_ptr film = _film.lock (); + start_of_thread ("Hints"); + + auto film = _film.lock (); if (!film) { return; } - ContentList content = film->content (); + auto content = film->content (); + check_certificates (); + check_interop (); check_big_font_files (); check_few_audio_channels (); check_upmixers (); @@ -322,40 +458,74 @@ Hints::thread () check_unusual_container (); check_high_j2k_bandwidth (); check_frame_rate (); + check_4k_3d (); check_speed_up (); check_vob (); check_3d_in_2d (); - check_loudness (); - - emit (bind(boost::ref(Progress), _("Examining closed captions"))); - - shared_ptr player (new Player(film)); - player->set_ignore_video (); - player->set_ignore_audio (); - player->Text.connect (bind(&Hints::text, this, _1, _2, _4)); - - struct timeval last_pulse; - gettimeofday (&last_pulse, 0); - - try { - while (!player->pass()) { + check_ffec_and_ffmc_in_smpte_feature (); + check_out_of_range_markers (); + check_subtitle_languages(); + check_audio_language (); + check_8_or_16_audio_channels(); + + scan_content(film); + + if (_long_subtitle && !_very_long_subtitle) { + hint (_("At least one of your subtitle lines has more than 52 characters. It is recommended to make each line 52 characters at most in length.")); + } else if (_very_long_subtitle) { + hint (_("At least one of your subtitle lines has more than 79 characters. You should make each line 79 characters at most in length.")); + } - struct timeval now; - gettimeofday (&now, 0); - if ((seconds(now) - seconds(last_pulse)) > 1) { - if (_stop) { - break; - } - emit (bind (boost::ref(Pulse))); - last_pulse = now; + bool ccap_xml_too_big = false; + bool ccap_mxf_too_big = false; + bool subs_mxf_too_big = false; + + auto dcp_dir = film->dir("hints") / dcpomatic::get_process_id(); + dcp::filesystem::remove_all(dcp_dir); + + _writer->finish (film->dir("hints") / dcpomatic::get_process_id()); + + dcp::DCP dcp (dcp_dir); + dcp.read (); + DCPOMATIC_ASSERT (dcp.cpls().size() == 1); + for (auto reel: dcp.cpls()[0]->reels()) { + for (auto ccap: reel->closed_captions()) { + if (ccap->asset() && ccap->asset()->xml_as_string().length() > static_cast(MAX_CLOSED_CAPTION_XML_SIZE - SIZE_SLACK) && !ccap_xml_too_big) { + hint (_( + "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT + ". You should divide the DCP into shorter reels." + )); + ccap_xml_too_big = true; } + if (subtitle_mxf_too_big(ccap->asset()) && !ccap_mxf_too_big) { + hint (_( + "At least one of your closed caption files is larger than " MAX_TEXT_MXF_SIZE_TEXT + " in total. You should divide the DCP into shorter reels." + )); + ccap_mxf_too_big = true; + } + } + if (reel->main_subtitle() && subtitle_mxf_too_big(reel->main_subtitle()->asset()) && !subs_mxf_too_big) { + hint (_( + "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total. " + "You should divide the DCP into shorter reels." + )); + subs_mxf_too_big = true; } - } catch (...) { - store_current (); } + dcp::filesystem::remove_all(dcp_dir); emit (bind(boost::ref(Finished))); } +catch (boost::thread_interrupted) +{ + /* The Hints object is being destroyed before it has finished, so just give up */ +} +catch (...) +{ + store_current (); +} + void Hints::hint (string h) @@ -363,43 +533,215 @@ Hints::hint (string h) emit(bind(boost::ref(Hint), h)); } + void -Hints::text (PlayerText text, TextType type, DCPTimePeriod period) +Hints::audio (shared_ptr audio, DCPTime time) { - if (type != TEXT_CLOSED_CAPTION) { - return; + _analyser.analyse (audio, time); +} + + +void +Hints::text (PlayerText text, TextType type, optional track, DCPTimePeriod period) +{ + _writer->write (text, type, track, period); + + switch (type) { + case TextType::CLOSED_CAPTION: + closed_caption (text, period); + break; + case TextType::OPEN_SUBTITLE: + open_subtitle (text, period); + break; + default: + break; } +} + +void +Hints::closed_caption (PlayerText text, DCPTimePeriod period) +{ int lines = text.string.size(); - BOOST_FOREACH (StringText i, text.string) { - if (utf8_strlen(i.text()) > CLOSED_CAPTION_LENGTH) { + for (auto i: text.string) { + if (utf8_strlen(i.text()) > MAX_CLOSED_CAPTION_LENGTH) { ++lines; if (!_long_ccap) { _long_ccap = true; - hint (String::compose(_("Some of your closed captions have lines longer than %1 characters, so they will probably be word-wrapped."), CLOSED_CAPTION_LENGTH)); + hint ( + String::compose( + "At least one of your closed caption lines has more than %1 characters. " + "It is advisable to make each line %1 characters at most in length.", + MAX_CLOSED_CAPTION_LENGTH, + MAX_CLOSED_CAPTION_LENGTH) + ); } } } - if (!_too_many_ccap_lines && lines > CLOSED_CAPTION_LINES) { - hint (String::compose(_("Some of your closed captions span more than %1 lines, so they will be truncated."), CLOSED_CAPTION_LINES)); + if (!_too_many_ccap_lines && lines > MAX_CLOSED_CAPTION_LINES) { + hint (String::compose(_("Some of your closed captions span more than %1 lines, so they will be truncated."), MAX_CLOSED_CAPTION_LINES)); _too_many_ccap_lines = true; } /* XXX: maybe overlapping closed captions (i.e. different languages) are OK with Interop? */ - if (film()->interop() && !_overlap_ccap && _last && _last->overlap(period)) { + if (film()->interop() && !_overlap_ccap && _last_ccap && _last_ccap->overlap(period)) { _overlap_ccap = true; hint (_("You have overlapping closed captions, which are not allowed in Interop DCPs. Change your DCP standard to SMPTE.")); } - _last = period; + _last_ccap = period; +} + + +void +Hints::open_subtitle (PlayerText text, DCPTimePeriod period) +{ + if (period.from < DCPTime::from_seconds(4) && !_early_subtitle) { + _early_subtitle = true; + hint (_("It is advisable to put your first subtitle at least 4 seconds after the start of the DCP to make sure it is seen.")); + } + + int const vfr = film()->video_frame_rate (); + + if (period.duration().frames_round(vfr) < 15 && !_short_subtitle) { + _short_subtitle = true; + hint (_("At least one of your subtitles lasts less than 15 frames. It is advisable to make each subtitle at least 15 frames long.")); + } + + if (_last_subtitle && DCPTime(period.from - _last_subtitle->to).frames_round(vfr) < 2 && !_subtitles_too_close) { + _subtitles_too_close = true; + hint (_("At least one of your subtitles starts less than 2 frames after the previous one. It is advisable to make the gap between subtitles at least 2 frames.")); + } + + struct VPos + { + public: + dcp::VAlign align; + float position; + + bool operator<(VPos const& other) const { + if (static_cast(align) != static_cast(other.align)) { + return static_cast(align) < static_cast(other.align); + } + return position < other.position; + } + }; + + /* This is rather an approximate way to count distinct lines, but I guess it will do; + * to make it better we need to take into account font metrics, and the SMPTE alignment + * debacle, and so on. + */ + std::set lines; + for (auto const& line: text.string) { + lines.insert({ line.v_align(), line.v_position() }); + } + + if (lines.size() > 3 && !_too_many_subtitle_lines) { + _too_many_subtitle_lines = true; + hint (_("At least one of your subtitles has more than 3 lines. It is advisable to use no more than 3 lines.")); + } + + size_t longest_line = 0; + for (auto const& i: text.string) { + longest_line = max (longest_line, i.text().length()); + } + + if (longest_line > 52) { + _long_subtitle = true; + } + + if (longest_line > 79) { + _very_long_subtitle = true; + } + + _last_subtitle = period; +} + + +void +Hints::check_ffec_and_ffmc_in_smpte_feature () +{ + auto f = film(); + if (!f->interop() && f->dcp_content_type()->libdcp_kind() == dcp::ContentKind::FEATURE && (!f->marker(dcp::Marker::FFEC) || !f->marker(dcp::Marker::FFMC))) { + hint (_("SMPTE DCPs with the type FTR (feature) should have markers for the first frame of end credits (FFEC) and the first frame of moving credits (FFMC). You should add these markers using the 'Markers' button in the \"DCP\" tab.")); + } +} + + +void +Hints::join () +{ + _thread.join (); +} + + +void +Hints::check_subtitle_languages() +{ + for (auto i: film()->content()) { + for (auto j: i->text) { + if (j->use() && j->type() == TextType::OPEN_SUBTITLE && !j->language()) { + hint (_("At least one piece of subtitle content has no specified language. " + "It is advisable to set the language for each piece of subtitle content " + "in the \"Content→Timed text\" or \"Content→Open subtitles\" tab.")); + return; + } + } + } +} + + +void +Hints::check_audio_language () +{ + auto content = film()->content(); + auto mapped_audio = + std::find_if(content.begin(), content.end(), [](shared_ptr c) { + return c->has_mapped_audio(); + }); + + if (mapped_audio != content.end() && !film()->audio_language()) { + hint (_("Some of your content has audio but you have not set the audio language. It is advisable to set the audio language " + "in the \"DCP\" tab unless your audio has no spoken parts.")); + } +} + + +void +Hints::check_certificates () +{ + auto bad = Config::instance()->check_certificates(); + if (!bad) { + return; + } + + switch (*bad) { + case Config::BAD_SIGNER_UTF8_STRINGS: + hint(_("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error " + "which will prevent DCPs from being validated correctly on some systems. It is advisable to " + "re-create the signing certificate chain by clicking the \"Re-make certificates and key...\" " + "button in the Keys page of Preferences.")); + break; + case Config::BAD_SIGNER_VALIDITY_TOO_LONG: + hint(_("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period " + "that is too long. This will cause problems playing back DCPs on some systems. " + "It is advisable to re-create the signing certificate chain by clicking the " + "\"Re-make certificates and key...\" button in the Keys page of Preferences.")); + break; + default: + /* Some bad situations can't happen here as DCP-o-matic would have refused to start until they are fixed */ + break; + } } -shared_ptr -Hints::film () const +void +Hints::check_8_or_16_audio_channels() { - shared_ptr film = _film.lock (); - DCPOMATIC_ASSERT (film); - return film; + auto const channels = film()->audio_channels(); + if (channels != 8 && channels != 16) { + hint(String::compose(_("Your DCP has %1 audio channels, rather than 8 or 16. This may cause some distributors to raise QC errors when they check your DCP. To avoid this, set the DCP audio channels to 8 or 16."), channels)); + } } +