src/lib/hints.cc

   1 /*
   2     Copyright (C) 2016-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  21 #include "hints.h"
  22 #include "types.h"
  23 #include "film.h"
  24 #include "content.h"
  25 #include "video_content.h"
  26 #include "text_content.h"
  27 #include "audio_processor.h"
  28 #include "font.h"
  29 #include "ratio.h"
  30 #include "audio_analysis.h"
  31 #include "compose.hpp"
  32 #include "util.h"
  33 #include "cross.h"
  34 #include "player.h"
  35 #include <dcp/raw_convert.h>
  36 #include <boost/foreach.hpp>
  37 #include <boost/algorithm/string.hpp>
  38 #include <iostream>
  39
  40 #include "i18n.h"
  41
  42 using std::vector;
  43 using std::string;
  44 using std::pair;
  45 using std::min;
  46 using std::max;
  47 using std::cout;
  48 using boost::shared_ptr;
  49 using boost::weak_ptr;
  50 using boost::optional;
  51 using boost::bind;
  52
  53 Hints::Hints (weak_ptr<const Film> film)
  54         : _film (film)
  55         , _thread (0)
  56         , _long_ccap (false)
  57 {
  58
  59 }
  60
  61 void
  62 Hints::stop_thread ()
  63 {
  64         if (_thread) {
  65                 try {
  66                         _thread->interrupt ();
  67                         _thread->join ();
  68                 } catch (...) {
  69
  70                 }
  71
  72                 delete _thread;
  73                 _thread = 0;
  74         }
  75 }
  76
  77 Hints::~Hints ()
  78 {
  79         stop_thread ();
  80 }
  81
  82 void
  83 Hints::start ()
  84 {
  85         stop_thread ();
  86         _long_ccap = false;
  87         _thread = new boost::thread (bind(&Hints::thread, this));
  88 }
  89
  90 void
  91 Hints::thread ()
  92 {
  93         shared_ptr<const Film> film = _film.lock ();
  94         if (!film) {
  95                 return;
  96         }
  97
  98         ContentList content = film->content ();
  99
 100         bool big_font_files = false;
 101         if (film->interop ()) {
 102                 BOOST_FOREACH (shared_ptr<Content> i, content) {
 103                         BOOST_FOREACH (shared_ptr<TextContent> j, i->text) {
 104                                 BOOST_FOREACH (shared_ptr<Font> k, j->fonts()) {
 105                                         for (int l = 0; l < FontFiles::VARIANTS; ++l) {
 106                                                 optional<boost::filesystem::path> const p = k->file (static_cast<FontFiles::Variant>(l));
 107                                                 if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) {
 108                                                         big_font_files = true;
 109                                                 }
 110                                         }
 111                                 }
 112                         }
 113                 }
 114         }
 115
 116         if (big_font_files) {
 117                 hint (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
 118         }
 119
 120         if (film->audio_channels() < 6) {
 121                 hint (_("Your DCP has fewer than 6 audio channels.  This may cause problems on some projectors."));
 122         }
 123
 124         AudioProcessor const * ap = film->audio_processor();
 125         if (ap && (ap->id() == "stereo-5.1-upmix-a" || ap->id() == "stereo-5.1-upmix-b")) {
 126                 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."));
 127         }
 128
 129         int flat_or_narrower = 0;
 130         int scope = 0;
 131         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 132                 if (i->video) {
 133                         Ratio const * r = i->video->scale().ratio ();
 134                         if (r && r->id() == "239") {
 135                                 ++scope;
 136                         } else if (r && r->id() != "239" && r->id() != "190") {
 137                                 ++flat_or_narrower;
 138                         }
 139                 }
 140         }
 141
 142         string const film_container = film->container()->id();
 143
 144         if (scope && !flat_or_narrower && film_container == "185") {
 145                 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."));
 146         }
 147
 148         if (!scope && flat_or_narrower && film_container == "239") {
 149                 hint (_("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."));
 150         }
 151
 152         if (film_container != "185" && film_container != "239" && film_container != "190") {
 153                 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"));
 154         }
 155
 156         if (film->j2k_bandwidth() >= 245000000) {
 157                 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."));
 158         }
 159
 160         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
 161                 string base = _("You are set up for an Interop DCP at a frame rate which is not officially supported.  You are advised either to change the frame rate of your DCP or to make a SMPTE DCP instead.");
 162                 base += "  ";
 163                 pair<double, double> range24 = film->speed_up_range (24);
 164                 pair<double, double> range48 = film->speed_up_range (48);
 165                 pair<double, double> range (max (range24.first, range48.first), min (range24.second, range48.second));
 166                 string h;
 167                 if (range.second > (29.0/24)) {
 168                         h = base;
 169                         h += _("However, setting your DCP frame rate to 24 or 48 will cause a significant speed-up of your content, and SMPTE DCPs are not supported by all projectors.");
 170                 } else if (range.first < (24.0/29)) {
 171                         h = base;
 172                         h += _("However, setting your DCP frame rate to 24 or 48 will cause a significant slowdown of your content, and SMPTE DCPs are not supported by all projectors.");
 173                 } else {
 174                         h = _("You are set up for an Interop DCP at a frame rate which is not officially supported.  You are advised either to change the frame rate of your DCP or to make a SMPTE DCP instead (although SMPTE DCPs are not supported by all projectors).");
 175                 }
 176
 177                 hint (h);
 178         }
 179
 180         optional<double> lowest_speed_up;
 181         optional<double> highest_speed_up;
 182         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 183                 double spu = film->active_frame_rate_change(i->position()).speed_up;
 184                 if (!lowest_speed_up || spu < *lowest_speed_up) {
 185                         lowest_speed_up = spu;
 186                 }
 187                 if (!highest_speed_up || spu > *highest_speed_up) {
 188                         highest_speed_up = spu;
 189                 }
 190         }
 191
 192         double worst_speed_up = 1;
 193         if (highest_speed_up) {
 194                 worst_speed_up = *highest_speed_up;
 195         }
 196         if (lowest_speed_up) {
 197                 worst_speed_up = max (worst_speed_up, 1 / *lowest_speed_up);
 198         }
 199
 200         if (worst_speed_up > 25.5/24.0) {
 201                 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."));
 202         }
 203
 204         int vob = 0;
 205         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 206                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
 207                         ++vob;
 208                 }
 209         }
 210
 211         if (vob > 1) {
 212                 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));
 213         }
 214
 215         int three_d = 0;
 216         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 217                 if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) {
 218                         ++three_d;
 219                 }
 220         }
 221
 222         if (three_d > 0 && !film->three_d()) {
 223                 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.)"));
 224         }
 225
 226         boost::filesystem::path path = film->audio_analysis_path (film->playlist ());
 227         if (boost::filesystem::exists (path)) {
 228                 try {
 229                         shared_ptr<AudioAnalysis> an (new AudioAnalysis (path));
 230
 231                         string ch;
 232
 233                         vector<AudioAnalysis::PeakTime> sample_peak = an->sample_peak ();
 234                         vector<float> true_peak = an->true_peak ();
 235
 236                         for (size_t i = 0; i < sample_peak.size(); ++i) {
 237                                 float const peak = max (sample_peak[i].peak, true_peak.empty() ? 0 : true_peak[i]);
 238                                 float const peak_dB = 20 * log10 (peak) + an->gain_correction (film->playlist ());
 239                                 if (peak_dB > -3) {
 240                                         ch += dcp::raw_convert<string> (short_audio_channel_name (i)) + ", ";
 241                                 }
 242                         }
 243
 244                         ch = ch.substr (0, ch.length() - 2);
 245
 246                         if (!ch.empty ()) {
 247                                 hint (String::compose (
 248                                               _("Your audio level is very high (on %1).  You should reduce the gain of your audio content."),
 249                                               ch
 250                                               )
 251                                         );
 252                         }
 253                 } catch (OldFormatError& e) {
 254                         /* The audio analysis is too old to load in; just skip this hint as if
 255                            it had never been run.
 256                         */
 257                 }
 258         }
 259
 260         emit (bind(boost::ref(Progress), _("Examining closed captions")));
 261
 262         shared_ptr<Player> player (new Player (film, film->playlist ()));
 263         player->set_ignore_video ();
 264         player->set_ignore_audio ();
 265         player->Text.connect (bind(&Hints::text, this, _1, _2, _3));
 266         while (!player->pass ()) {
 267                 bind (boost::ref(Pulse));
 268         }
 269
 270         emit (bind(boost::ref(Finished)));
 271 }
 272
 273 void
 274 Hints::hint (string h)
 275 {
 276         emit(bind(boost::ref(Hint), h));
 277 }
 278
 279 void
 280 Hints::text (PlayerText text, TextType type, DCPTimePeriod period)
 281 {
 282         if (type != TEXT_CLOSED_CAPTION) {
 283                 return;
 284         }
 285
 286         BOOST_FOREACH (StringText i, text.text) {
 287                 if (!_long_ccap && i.text().length() > 30) {
 288                         _long_ccap = true;
 289                         hint (_("Some of your closed captions have lines longer than 30 characters, so they will probably be word-wrapped."));
 290                 }
 291         }
 292 }