From 09d5906f44907aab5afb41ce2da887550c0011a8 Mon Sep 17 00:00:00 2001 From: Carl Hetherington Date: Thu, 7 Jul 2016 23:01:12 +0100 Subject: [PATCH] Factor out hints code into its own method. --- src/lib/hints.cc | 143 +++++++++++++++++++++++++++++++++++++++++ src/lib/hints.h | 27 ++++++++ src/lib/wscript | 1 + src/wx/hints_dialog.cc | 141 ++++------------------------------------ 4 files changed, 184 insertions(+), 128 deletions(-) create mode 100644 src/lib/hints.cc create mode 100644 src/lib/hints.h diff --git a/src/lib/hints.cc b/src/lib/hints.cc new file mode 100644 index 000000000..bf0f44096 --- /dev/null +++ b/src/lib/hints.cc @@ -0,0 +1,143 @@ +/* + Copyright (C) 2016 Carl Hetherington + + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + DCP-o-matic is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with DCP-o-matic. If not, see . + +*/ + +#include "hints.h" +#include "types.h" +#include "film.h" +#include "content.h" +#include "video_content.h" +#include "subtitle_content.h" +#include "font.h" +#include "ratio.h" +#include "audio_analysis.h" +#include "compose.hpp" +#include +#include + +#include "i18n.h" + +using std::vector; +using std::string; +using std::max; +using boost::shared_ptr; +using boost::optional; + +vector +get_hints (shared_ptr film) +{ + vector hints; + + ContentList content = film->content (); + + bool big_font_files = false; + if (film->interop ()) { + BOOST_FOREACH (shared_ptr i, content) { + if (i->subtitle) { + BOOST_FOREACH (shared_ptr j, i->subtitle->fonts ()) { + for (int k = 0; k < FontFiles::VARIANTS; ++k) { + optional const p = j->file (static_cast (k)); + if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) { + big_font_files = true; + } + } + } + } + } + } + + if (big_font_files) { + hints.push_back (_("You have specified a font file which is larger than 640kB. This is very likely to cause problems on playback.")); + } + + if (film->audio_channels() < 6) { + hints.push_back (_("Your DCP has fewer than 6 audio channels. This may cause problems on some projectors.")); + } + + int flat_or_narrower = 0; + int scope = 0; + BOOST_FOREACH (shared_ptr i, content) { + if (i->video) { + Ratio const * r = i->video->scale().ratio (); + if (r && r->id() == "239") { + ++scope; + } else if (r && r->id() != "239" && r->id() != "full-frame") { + ++flat_or_narrower; + } + } + } + + if (scope && !flat_or_narrower && film->container()->id() == "185") { + hints.push_back (_("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.")); + } + + if (!scope && flat_or_narrower && film->container()->id() == "239") { + hints.push_back (_("All of your content is at 1.85:1 or narrower but your DCP's container is Scope (2.39:1). This will pillar-box your content inside a Flat (1.85:1) frame. You may prefer to set your DCP's container to Flat (1.85:1) in the \"DCP\" tab.")); + } + + if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) { + hints.push_back (String::compose (_("Your DCP frame rate (%1 fps) may cause problems in a few (mostly older) projectors. Use 24 or 48 frames per second to be on the safe side."), film->video_frame_rate())); + } + + if (film->j2k_bandwidth() >= 245000000) { + hints.push_back (_("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.")); + } + + if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) { + hints.push_back (_("You are set up for an Interop DCP at a frame rate which is not officially supported. You are advised to make a SMPTE DCP instead.")); + } + + int vob = 0; + BOOST_FOREACH (shared_ptr i, content) { + if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) { + ++vob; + } + } + + if (vob > 1) { + hints.push_back (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)); + } + + int three_d = 0; + BOOST_FOREACH (shared_ptr i, content) { + if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) { + ++three_d; + } + } + + if (three_d > 0 && !film->three_d()) { + hints.push_back (_("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.)")); + } + + boost::filesystem::path path = film->audio_analysis_path (film->playlist ()); + if (boost::filesystem::exists (path)) { + shared_ptr an (new AudioAnalysis (path)); + if (an->sample_peak() || an->true_peak()) { + float const peak = max (an->sample_peak().get_value_or(0), an->true_peak().get_value_or(0)); + float const peak_dB = 20 * log10 (peak) + an->gain_correction (film->playlist ()); + if (peak_dB > -3 && peak_dB < -0.5) { + hints.push_back (_("Your audio level is very high. You should reduce the gain of your audio content.")); + } else if (peak_dB > -0.5) { + hints.push_back (_("Your audio level is very close to clipping. You should reduce the gain of your audio content.")); + } + } + } + + return hints; +} diff --git a/src/lib/hints.h b/src/lib/hints.h new file mode 100644 index 000000000..3a6850860 --- /dev/null +++ b/src/lib/hints.h @@ -0,0 +1,27 @@ +/* + Copyright (C) 2016 Carl Hetherington + + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + DCP-o-matic is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with DCP-o-matic. If not, see . + +*/ + +#include +#include +#include + +class Film; + +std::vector get_hints (boost::shared_ptr film); diff --git a/src/lib/wscript b/src/lib/wscript index f5fc6f539..f5de27bf4 100644 --- a/src/lib/wscript +++ b/src/lib/wscript @@ -81,6 +81,7 @@ sources = """ font.cc font_files.cc frame_rate_change.cc + hints.cc internet.cc image.cc image_content.cc diff --git a/src/wx/hints_dialog.cc b/src/wx/hints_dialog.cc index 72ab0eef4..f45eda0f7 100644 --- a/src/wx/hints_dialog.cc +++ b/src/wx/hints_dialog.cc @@ -19,18 +19,15 @@ */ #include "hints_dialog.h" +#include "wx_util.h" #include "lib/film.h" -#include "lib/ratio.h" -#include "lib/video_content.h" -#include "lib/subtitle_content.h" -#include "lib/font.h" -#include "lib/content.h" -#include "lib/audio_analysis.h" +#include "lib/hints.h" #include -#include #include using std::max; +using std::vector; +using std::string; using boost::shared_ptr; using boost::optional; using boost::dynamic_pointer_cast; @@ -67,134 +64,22 @@ void HintsDialog::film_changed () { _text->Clear (); - bool hint = false; boost::shared_ptr film = _film.lock (); if (!film) { return; } - ContentList content = film->content (); - - _text->BeginStandardBullet (N_("standard/circle"), 1, 50); - - bool big_font_files = false; - if (film->interop ()) { - BOOST_FOREACH (shared_ptr i, content) { - if (i->subtitle) { - BOOST_FOREACH (shared_ptr j, i->subtitle->fonts ()) { - for (int k = 0; k < FontFiles::VARIANTS; ++k) { - optional const p = j->file (static_cast (k)); - if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) { - big_font_files = true; - } - } - } - } - } - } - - if (big_font_files) { - hint = true; - _text->WriteText (_("You have specified a font file which is larger than 640kB. This is very likely to cause problems on playback.")); - } - - if (film->audio_channels() < 6) { - hint = true; - _text->WriteText (_("Your DCP has fewer than 6 audio channels. This may cause problems on some projectors.")); - _text->Newline (); - } - - int flat_or_narrower = 0; - int scope = 0; - BOOST_FOREACH (shared_ptr i, content) { - if (i->video) { - Ratio const * r = i->video->scale().ratio (); - if (r && r->id() == "239") { - ++scope; - } else if (r && r->id() != "239" && r->id() != "full-frame") { - ++flat_or_narrower; - } - } - } - - if (scope && !flat_or_narrower && film->container()->id() == "185") { - hint = true; - _text->WriteText (_("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.")); - _text->Newline (); - } - - if (!scope && flat_or_narrower && film->container()->id() == "239") { - hint = true; - _text->WriteText (_("All of your content is at 1.85:1 or narrower but your DCP's container is Scope (2.39:1). This will pillar-box your content inside a Flat (1.85:1) frame. You may prefer to set your DCP's container to Flat (1.85:1) in the \"DCP\" tab.")); - _text->Newline (); - } - - if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) { - hint = true; - _text->WriteText (wxString::Format (_("Your DCP frame rate (%d fps) may cause problems in a few (mostly older) projectors. Use 24 or 48 frames per second to be on the safe side."), film->video_frame_rate())); - _text->Newline (); - } - - if (film->j2k_bandwidth() >= 245000000) { - hint = true; - _text->WriteText (_("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.")); - _text->Newline (); - } + vector hints = get_hints (film); - if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) { - hint = true; - _text->WriteText (_("You are set up for an Interop DCP at a frame rate which is not officially supported. You are advised to make a SMPTE DCP instead.")); - _text->Newline (); - } - - int vob = 0; - BOOST_FOREACH (shared_ptr i, content) { - if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) { - ++vob; - } - } - - if (vob > 1) { - hint = true; - _text->WriteText (wxString::Format (_("You have %d files that look like they are VOB files from DVD. You should join them to ensure smooth joins between the files."), vob)); - _text->Newline (); - } - - int three_d = 0; - BOOST_FOREACH (shared_ptr i, content) { - if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) { - ++three_d; - } - } - - if (three_d > 0 && !film->three_d()) { - hint = true; - _text->WriteText (_("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.)")); - _text->Newline (); - } - - boost::filesystem::path path = film->audio_analysis_path (film->playlist ()); - if (boost::filesystem::exists (path)) { - shared_ptr an (new AudioAnalysis (path)); - if (an->sample_peak() || an->true_peak()) { - float const peak = max (an->sample_peak().get_value_or(0), an->true_peak().get_value_or(0)); - float const peak_dB = 20 * log10 (peak) + an->gain_correction (film->playlist ()); - if (peak_dB > -3 && peak_dB < -0.5) { - hint = true; - _text->WriteText (_("Your audio level is very high. You should reduce the gain of your audio content.")); - _text->Newline (); - } else if (peak_dB > -0.5) { - hint = true; - _text->WriteText (_("Your audio level is very close to clipping. You should reduce the gain of your audio content.")); - _text->Newline (); - } - } - } - - _text->EndSymbolBullet (); - - if (!hint) { + if (hints.empty ()) { _text->WriteText (_("There are no hints: everything looks good!")); + } else { + _text->BeginStandardBullet (N_("standard/circle"), 1, 50); + BOOST_FOREACH (string i, hints) { + _text->WriteText (std_to_wx (i)); + _text->Newline (); + } + _text->EndSymbolBullet (); } } -- 2.30.2