2 Copyright (C) 2016-2022 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 #include "audio_analysis.h"
23 #include "audio_content.h"
24 #include "audio_processor.h"
25 #include "compose.hpp"
27 #include "constants.h"
30 #include "dcp_content_type.h"
34 #include "maths_util.h"
37 #include "text_content.h"
38 #include "video_content.h"
41 #include <dcp/filesystem.h>
42 #include <dcp/raw_convert.h>
44 #include <dcp/reel_closed_caption_asset.h>
45 #include <dcp/reel_subtitle_asset.h>
46 #include <boost/algorithm/string.hpp>
53 using std::make_shared;
55 using std::shared_ptr;
58 using boost::optional;
60 using namespace dcpomatic;
61 #if BOOST_VERSION >= 106100
62 using namespace boost::placeholders;
66 /* When checking to see if things are too big, we'll say they are if they
67 * are more than the target size minus this "slack."
69 #define SIZE_SLACK 4096
72 /* When writing hints:
73 * - put quotation marks around the name of a GUI tab that you are referring to (e.g. "DCP" or "DCP→Video" tab)
77 Hints::Hints (weak_ptr<const Film> weak_film)
78 : WeakConstFilm (weak_film)
79 , _writer (new Writer(weak_film, weak_ptr<Job>(), true))
80 , _analyser (film(), film()->playlist(), true, [](float) {})
90 _thread = boost::thread (bind(&Hints::thread, this));
96 boost::this_thread::disable_interruption dis;
100 _thread.interrupt ();
107 Hints::check_few_audio_channels ()
109 if (film()->audio_channels() < 6) {
110 hint (_("Your DCP has fewer than 6 audio channels. This may cause problems on some projectors. You may want to set the DCP to have 6 channels. It does not matter if your content has fewer channels, as DCP-o-matic will fill the extras with silence."));
116 Hints::check_upmixers ()
118 auto ap = film()->audio_processor();
119 if (ap && (ap->id() == "stereo-5.1-upmix-a" || ap->id() == "stereo-5.1-upmix-b")) {
120 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."));
126 Hints::check_incorrect_container ()
128 int narrower_than_scope = 0;
130 for (auto i: film()->content()) {
132 auto const r = Ratio::nearest_from_ratio(i->video->scaled_size(film()->frame_size()).ratio());
133 if (r && r->id() == "239") {
135 } else if (r && r->id() != "239" && r->id() != "235" && r->id() != "190") {
136 ++narrower_than_scope;
141 string const film_container = film()->container()->id();
143 if (scope && !narrower_than_scope && film_container == "185") {
144 hint (_("All of your content is in Scope (2.39:1) but your DCP's container is Flat (1.85:1). This will letter-box your content inside a Flat (1.85:1) frame. You may prefer to set your DCP's container to Scope (2.39:1) in the \"DCP\" tab."));
147 if (!scope && narrower_than_scope && film_container == "239") {
148 hint (_("All of your content narrower than 1.90:1 but your DCP's container is Scope (2.39:1). This will pillar-box your content. You may prefer to set your DCP's container to have the same ratio as your content."));
154 Hints::check_unusual_container ()
156 auto const film_container = film()->container()->id();
157 if (film_container != "185" && film_container != "239") {
158 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."));
164 Hints::check_high_j2k_bandwidth ()
166 if (film()->j2k_bandwidth() >= 245000000) {
167 hint (_("A few projectors have problems playing back very high bit-rate DCPs. It is a good idea to drop the JPEG2000 bandwidth down to about 200Mbit/s; this is unlikely to have any visible effect on the image."));
173 Hints::check_frame_rate ()
176 switch (f->video_frame_rate()) {
182 /* You might want to go to 24 */
183 string base = 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 may want to consider changing your frame rate to %2 fps."), 25, 24);
186 base += _("If you do use 25fps you should change your DCP standard to SMPTE.");
192 /* 30fps: we can't really offer any decent solutions */
193 hint (_("You are set up for a DCP frame rate of 30fps, which is not supported by all projectors. Be aware that you may have compatibility problems."));
198 /* You almost certainly want to go to half frame rate */
199 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));
206 Hints::check_4k_3d ()
209 if (f->resolution() == Resolution::FOUR_K && f->three_d()) {
210 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."));
216 Hints::check_speed_up ()
218 optional<double> lowest_speed_up;
219 optional<double> highest_speed_up;
220 for (auto i: film()->content()) {
221 double spu = film()->active_frame_rate_change(i->position()).speed_up;
222 if (!lowest_speed_up || spu < *lowest_speed_up) {
223 lowest_speed_up = spu;
225 if (!highest_speed_up || spu > *highest_speed_up) {
226 highest_speed_up = spu;
230 double worst_speed_up = 1;
231 if (highest_speed_up) {
232 worst_speed_up = *highest_speed_up;
234 if (lowest_speed_up) {
235 worst_speed_up = max (worst_speed_up, 1 / *lowest_speed_up);
238 if (worst_speed_up > 25.5/24.0) {
239 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."));
246 Hints::check_interop ()
248 if (film()->interop()) {
249 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."));
255 Hints::check_big_font_files ()
257 bool big_font_files = false;
258 if (film()->interop ()) {
259 for (auto i: film()->content()) {
260 for (auto j: i->text) {
261 for (auto k: j->fonts()) {
262 auto const p = k->file ();
263 if (p && dcp::filesystem::file_size(p.get()) >= (MAX_FONT_FILE_SIZE - SIZE_SLACK)) {
264 big_font_files = true;
271 if (big_font_files) {
272 hint (_("You have specified a font file which is larger than 640kB. This is very likely to cause problems on playback."));
281 for (auto i: film()->content()) {
282 if (boost::algorithm::starts_with(i->path(0).filename().string(), "VTS_")) {
288 hint (String::compose (_("You have %1 files that look like they are VOB files from DVD. You should join them to ensure smooth joins between the files."), vob));
294 Hints::check_3d_in_2d ()
297 for (auto i: film()->content()) {
298 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
303 if (three_d > 0 && !film()->three_d()) {
304 hint (_("You are using 3D content but your DCP is set to 2D. Set the DCP to 3D if you want to play it back on a 3D system (e.g. Real-D, MasterImage etc.)"));
309 /** @return true if the loudness could be checked, false if it could not because no analysis was available */
311 Hints::check_loudness ()
313 auto path = film()->audio_analysis_path(film()->playlist());
314 if (!dcp::filesystem::exists(path)) {
319 auto an = make_shared<AudioAnalysis>(path);
323 auto sample_peak = an->sample_peak ();
324 auto true_peak = an->true_peak ();
326 for (size_t i = 0; i < sample_peak.size(); ++i) {
327 float const peak = max (sample_peak[i].peak, true_peak.empty() ? 0 : true_peak[i]);
328 float const peak_dB = linear_to_db(peak) + an->gain_correction(film()->playlist());
330 ch += dcp::raw_convert<string>(short_audio_channel_name(i)) + ", ";
334 ch = ch.substr (0, ch.length() - 2);
337 hint(String::compose(
338 _("Your audio level is very high (on %1). You should reduce the gain of your audio content."),
343 } catch (OldFormatError& e) {
344 /* The audio analysis is too old to load in */
354 subtitle_mxf_too_big (shared_ptr<dcp::SubtitleAsset> asset)
356 return asset && asset->file() && dcp::filesystem::file_size(*asset->file()) >= (MAX_TEXT_MXF_SIZE - SIZE_SLACK);
361 Hints::check_out_of_range_markers ()
363 auto const length = film()->length();
364 for (auto const& i: film()->markers()) {
365 if (i.second >= length) {
366 hint (_("At least one marker comes after the end of the project and will be ignored."));
376 start_of_thread ("Hints");
378 auto film = _film.lock ();
383 auto content = film->content ();
385 check_certificates ();
387 check_big_font_files ();
388 check_few_audio_channels ();
390 check_incorrect_container ();
391 check_unusual_container ();
392 check_high_j2k_bandwidth ();
398 auto const check_loudness_done = check_loudness ();
399 check_ffec_and_ffmc_in_smpte_feature ();
400 check_out_of_range_markers ();
401 check_subtitle_languages();
402 check_audio_language ();
403 check_8_or_16_audio_channels();
405 if (check_loudness_done) {
406 emit (bind(boost::ref(Progress), _("Examining subtitles and closed captions")));
408 emit (bind(boost::ref(Progress), _("Examining audio, subtitles and closed captions")));
411 auto player = make_shared<Player>(film, Image::Alignment::COMPACT);
412 player->set_ignore_video ();
413 if (check_loudness_done || _disable_audio_analysis) {
414 /* We don't need to analyse audio because we already loaded a suitable analysis */
415 player->set_ignore_audio ();
417 player->Audio.connect (bind(&Hints::audio, this, _1, _2));
418 player->Text.connect (bind(&Hints::text, this, _1, _2, _3, _4));
420 struct timeval last_pulse;
421 gettimeofday (&last_pulse, 0);
423 _writer->write (player->get_subtitle_fonts());
425 while (!player->pass()) {
428 gettimeofday (&now, 0);
429 if ((seconds(now) - seconds(last_pulse)) > 1) {
433 emit (bind (boost::ref(Pulse)));
438 if (!check_loudness_done) {
440 _analyser.get().write(film->audio_analysis_path(film->playlist()));
445 if (_long_subtitle && !_very_long_subtitle) {
446 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."));
447 } else if (_very_long_subtitle) {
448 hint (_("At least one of your subtitle lines has more than 79 characters. You should make each line 79 characters at most in length."));
451 bool ccap_xml_too_big = false;
452 bool ccap_mxf_too_big = false;
453 bool subs_mxf_too_big = false;
455 auto dcp_dir = film->dir("hints") / dcpomatic::get_process_id();
456 dcp::filesystem::remove_all(dcp_dir);
458 _writer->finish (film->dir("hints") / dcpomatic::get_process_id());
460 dcp::DCP dcp (dcp_dir);
462 DCPOMATIC_ASSERT (dcp.cpls().size() == 1);
463 for (auto reel: dcp.cpls()[0]->reels()) {
464 for (auto ccap: reel->closed_captions()) {
465 if (ccap->asset() && ccap->asset()->xml_as_string().length() > static_cast<size_t>(MAX_CLOSED_CAPTION_XML_SIZE - SIZE_SLACK) && !ccap_xml_too_big) {
467 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT
468 ". You should divide the DCP into shorter reels."
470 ccap_xml_too_big = true;
472 if (subtitle_mxf_too_big(ccap->asset()) && !ccap_mxf_too_big) {
474 "At least one of your closed caption files is larger than " MAX_TEXT_MXF_SIZE_TEXT
475 " in total. You should divide the DCP into shorter reels."
477 ccap_mxf_too_big = true;
480 if (reel->main_subtitle() && subtitle_mxf_too_big(reel->main_subtitle()->asset()) && !subs_mxf_too_big) {
482 "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total. "
483 "You should divide the DCP into shorter reels."
485 subs_mxf_too_big = true;
488 dcp::filesystem::remove_all(dcp_dir);
490 emit (bind(boost::ref(Finished)));
492 catch (boost::thread_interrupted)
494 /* The Hints object is being destroyed before it has finished, so just give up */
503 Hints::hint (string h)
505 emit(bind(boost::ref(Hint), h));
510 Hints::audio (shared_ptr<AudioBuffers> audio, DCPTime time)
512 _analyser.analyse (audio, time);
517 Hints::text (PlayerText text, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
519 _writer->write (text, type, track, period);
522 case TextType::CLOSED_CAPTION:
523 closed_caption (text, period);
525 case TextType::OPEN_SUBTITLE:
526 open_subtitle (text, period);
535 Hints::closed_caption (PlayerText text, DCPTimePeriod period)
537 int lines = text.string.size();
538 for (auto i: text.string) {
539 if (utf8_strlen(i.text()) > MAX_CLOSED_CAPTION_LENGTH) {
545 "At least one of your closed caption lines has more than %1 characters. "
546 "It is advisable to make each line %1 characters at most in length.",
547 MAX_CLOSED_CAPTION_LENGTH,
548 MAX_CLOSED_CAPTION_LENGTH)
554 if (!_too_many_ccap_lines && lines > MAX_CLOSED_CAPTION_LINES) {
555 hint (String::compose(_("Some of your closed captions span more than %1 lines, so they will be truncated."), MAX_CLOSED_CAPTION_LINES));
556 _too_many_ccap_lines = true;
559 /* XXX: maybe overlapping closed captions (i.e. different languages) are OK with Interop? */
560 if (film()->interop() && !_overlap_ccap && _last_ccap && _last_ccap->overlap(period)) {
561 _overlap_ccap = true;
562 hint (_("You have overlapping closed captions, which are not allowed in Interop DCPs. Change your DCP standard to SMPTE."));
570 Hints::open_subtitle (PlayerText text, DCPTimePeriod period)
572 if (period.from < DCPTime::from_seconds(4) && !_early_subtitle) {
573 _early_subtitle = true;
574 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."));
577 int const vfr = film()->video_frame_rate ();
579 if (period.duration().frames_round(vfr) < 15 && !_short_subtitle) {
580 _short_subtitle = true;
581 hint (_("At least one of your subtitles lasts less than 15 frames. It is advisable to make each subtitle at least 15 frames long."));
584 if (_last_subtitle && DCPTime(period.from - _last_subtitle->to).frames_round(vfr) < 2 && !_subtitles_too_close) {
585 _subtitles_too_close = true;
586 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."));
595 bool operator<(VPos const& other) const {
596 if (static_cast<int>(align) != static_cast<int>(other.align)) {
597 return static_cast<int>(align) < static_cast<int>(other.align);
599 return position < other.position;
603 /* This is rather an approximate way to count distinct lines, but I guess it will do;
604 * to make it better we need to take into account font metrics, and the SMPTE alignment
605 * debacle, and so on.
607 std::set<VPos> lines;
608 for (auto const& line: text.string) {
609 lines.insert({ line.v_align(), line.v_position() });
612 if (lines.size() > 3 && !_too_many_subtitle_lines) {
613 _too_many_subtitle_lines = true;
614 hint (_("At least one of your subtitles has more than 3 lines. It is advisable to use no more than 3 lines."));
617 size_t longest_line = 0;
618 for (auto const& i: text.string) {
619 longest_line = max (longest_line, i.text().length());
622 if (longest_line > 52) {
623 _long_subtitle = true;
626 if (longest_line > 79) {
627 _very_long_subtitle = true;
630 _last_subtitle = period;
635 Hints::check_ffec_and_ffmc_in_smpte_feature ()
638 if (!f->interop() && f->dcp_content_type()->libdcp_kind() == dcp::ContentKind::FEATURE && (!f->marker(dcp::Marker::FFEC) || !f->marker(dcp::Marker::FFMC))) {
639 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."));
652 Hints::check_subtitle_languages()
654 for (auto i: film()->content()) {
655 for (auto j: i->text) {
656 if (j->use() && j->type() == TextType::OPEN_SUBTITLE && !j->language()) {
657 hint (_("At least one piece of subtitle content has no specified language. "
658 "It is advisable to set the language for each piece of subtitle content "
659 "in the \"Content→Timed text\" or \"Content→Open subtitles\" tab."));
668 Hints::check_audio_language ()
670 auto content = film()->content();
672 std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> c) {
673 return c->audio && !c->audio->mapping().mapped_output_channels().empty();
676 if (mapped_audio != content.end() && !film()->audio_language()) {
677 hint (_("Some of your content has audio but you have not set the audio language. It is advisable to set the audio language "
678 "in the \"DCP\" tab unless your audio has no spoken parts."));
684 Hints::check_certificates ()
686 auto bad = Config::instance()->check_certificates();
692 case Config::BAD_SIGNER_UTF8_STRINGS:
693 hint(_("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error "
694 "which will prevent DCPs from being validated correctly on some systems. It is advisable to "
695 "re-create the signing certificate chain by clicking the \"Re-make certificates and key...\" "
696 "button in the Keys page of Preferences."));
698 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
699 hint(_("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period "
700 "that is too long. This will cause problems playing back DCPs on some systems. "
701 "It is advisable to re-create the signing certificate chain by clicking the "
702 "\"Re-make certificates and key...\" button in the Keys page of Preferences."));
705 /* Some bad situations can't happen here as DCP-o-matic would have refused to start until they are fixed */
712 Hints::check_8_or_16_audio_channels()
714 auto const channels = film()->audio_channels();
715 if (channels != 8 && channels != 16) {
716 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));