src/lib/hints.cc

   1 /*
   2     Copyright (C) 2016-2021 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 "dcp_content_type.h"
  22 #include "hints.h"
  23 #include "types.h"
  24 #include "film.h"
  25 #include "content.h"
  26 #include "video_content.h"
  27 #include "text_content.h"
  28 #include "audio_processor.h"
  29 #include "font.h"
  30 #include "font_data.h"
  31 #include "ratio.h"
  32 #include "audio_analysis.h"
  33 #include "compose.hpp"
  34 #include "util.h"
  35 #include "cross.h"
  36 #include "player.h"
  37 #include "writer.h"
  38 #include <dcp/cpl.h>
  39 #include <dcp/raw_convert.h>
  40 #include <dcp/reel.h>
  41 #include <dcp/reel_closed_caption_asset.h>
  42 #include <dcp/reel_subtitle_asset.h>
  43 #include <boost/algorithm/string.hpp>
  44 #include <iostream>
  45
  46 #include "i18n.h"
  47
  48 using std::cout;
  49 using std::make_shared;
  50 using std::max;
  51 using std::min;
  52 using std::pair;
  53 using std::shared_ptr;
  54 using std::string;
  55 using std::vector;
  56 using std::weak_ptr;
  57 using boost::optional;
  58 using boost::bind;
  59 using namespace dcpomatic;
  60 #if BOOST_VERSION >= 106100
  61 using namespace boost::placeholders;
  62 #endif
  63
  64
  65 /* When checking to see if things are too big, we'll say they are if they
  66  * are more than the target size minus this "slack."
  67  */
  68 #define SIZE_SLACK 4096
  69
  70
  71 Hints::Hints (weak_ptr<const Film> film)
  72         : WeakConstFilm (film)
  73         , _writer (new Writer(film, weak_ptr<Job>(), true))
  74         , _long_ccap (false)
  75         , _overlap_ccap (false)
  76         , _too_many_ccap_lines (false)
  77         , _early_subtitle (false)
  78         , _short_subtitle (false)
  79         , _subtitles_too_close (false)
  80         , _too_many_subtitle_lines (false)
  81         , _long_subtitle (false)
  82         , _stop (false)
  83 {
  84
  85 }
  86
  87 void
  88 Hints::start ()
  89 {
  90         _thread = boost::thread (bind(&Hints::thread, this));
  91 }
  92
  93 Hints::~Hints ()
  94 {
  95         boost::this_thread::disable_interruption dis;
  96
  97         try {
  98                 _stop = true;
  99                 _thread.interrupt ();
 100                 _thread.join ();
 101         } catch (...) {}
 102 }
 103
 104
 105 void
 106 Hints::check_few_audio_channels ()
 107 {
 108         if (film()->audio_channels() < 6) {
 109                 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."));
 110         }
 111 }
 112
 113
 114 void
 115 Hints::check_upmixers ()
 116 {
 117         auto ap = film()->audio_processor();
 118         if (ap && (ap->id() == "stereo-5.1-upmix-a" || ap->id() == "stereo-5.1-upmix-b")) {
 119                 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."));
 120         }
 121 }
 122
 123
 124 void
 125 Hints::check_incorrect_container ()
 126 {
 127         int narrower_than_scope = 0;
 128         int scope = 0;
 129         for (auto i: film()->content()) {
 130                 if (i->video) {
 131                         Ratio const * r = Ratio::nearest_from_ratio(i->video->scaled_size(film()->frame_size()).ratio());
 132                         if (r && r->id() == "239") {
 133                                 ++scope;
 134                         } else if (r && r->id() != "239" && r->id() != "235" && r->id() != "190") {
 135                                 ++narrower_than_scope;
 136                         }
 137                 }
 138         }
 139
 140         string const film_container = film()->container()->id();
 141
 142         if (scope && !narrower_than_scope && film_container == "185") {
 143                 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."));
 144         }
 145
 146         if (!scope && narrower_than_scope && film_container == "239") {
 147                 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."));
 148         }
 149 }
 150
 151
 152 void
 153 Hints::check_unusual_container ()
 154 {
 155         auto const film_container = film()->container()->id();
 156         if (film_container != "185" && film_container != "239" && film_container != "190") {
 157                 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"));
 158         }
 159 }
 160
 161
 162 void
 163 Hints::check_high_j2k_bandwidth ()
 164 {
 165         if (film()->j2k_bandwidth() >= 245000000) {
 166                 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."));
 167         }
 168 }
 169
 170
 171 void
 172 Hints::check_frame_rate ()
 173 {
 174         auto f = film ();
 175         switch (f->video_frame_rate()) {
 176         case 24:
 177                 /* Fine */
 178                 break;
 179         case 25:
 180         {
 181                 /* You might want to go to 24 */
 182                 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);
 183                 if (f->interop()) {
 184                         base += "  ";
 185                         base += _("If you do use 25fps you should change your DCP standard to SMPTE.");
 186                 }
 187                 hint (base);
 188                 break;
 189         }
 190         case 30:
 191                 /* 30fps: we can't really offer any decent solutions */
 192                 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."));
 193                 break;
 194         case 48:
 195         case 50:
 196         case 60:
 197                 /* You almost certainly want to go to half frame rate */
 198                 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));
 199                 break;
 200         }
 201 }
 202
 203
 204 void
 205 Hints::check_speed_up ()
 206 {
 207         optional<double> lowest_speed_up;
 208         optional<double> highest_speed_up;
 209         for (auto i: film()->content()) {
 210                 double spu = film()->active_frame_rate_change(i->position()).speed_up;
 211                 if (!lowest_speed_up || spu < *lowest_speed_up) {
 212                         lowest_speed_up = spu;
 213                 }
 214                 if (!highest_speed_up || spu > *highest_speed_up) {
 215                         highest_speed_up = spu;
 216                 }
 217         }
 218
 219         double worst_speed_up = 1;
 220         if (highest_speed_up) {
 221                 worst_speed_up = *highest_speed_up;
 222         }
 223         if (lowest_speed_up) {
 224                 worst_speed_up = max (worst_speed_up, 1 / *lowest_speed_up);
 225         }
 226
 227         if (worst_speed_up > 25.5/24.0) {
 228                 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."));
 229         }
 230
 231 }
 232
 233
 234 void
 235 Hints::check_big_font_files ()
 236 {
 237         bool big_font_files = false;
 238         if (film()->interop ()) {
 239                 for (auto i: film()->content()) {
 240                         for (auto j: i->text) {
 241                                 for (auto k: j->fonts()) {
 242                                         optional<boost::filesystem::path> const p = k->file ();
 243                                         if (p && boost::filesystem::file_size(p.get()) >= (MAX_FONT_FILE_SIZE - SIZE_SLACK)) {
 244                                                 big_font_files = true;
 245                                         }
 246                                 }
 247                         }
 248                 }
 249         }
 250
 251         if (big_font_files) {
 252                 hint (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
 253         }
 254 }
 255
 256
 257 void
 258 Hints::check_vob ()
 259 {
 260         int vob = 0;
 261         for (auto i: film()->content()) {
 262                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
 263                         ++vob;
 264                 }
 265         }
 266
 267         if (vob > 1) {
 268                 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));
 269         }
 270 }
 271
 272
 273 void
 274 Hints::check_3d_in_2d ()
 275 {
 276         int three_d = 0;
 277         for (auto i: film()->content()) {
 278                 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
 279                         ++three_d;
 280                 }
 281         }
 282
 283         if (three_d > 0 && !film()->three_d()) {
 284                 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.)"));
 285         }
 286 }
 287
 288
 289 void
 290 Hints::check_loudness ()
 291 {
 292         auto path = film()->audio_analysis_path(film()->playlist());
 293         if (boost::filesystem::exists (path)) {
 294                 try {
 295                         auto an = make_shared<AudioAnalysis>(path);
 296
 297                         string ch;
 298
 299                         auto sample_peak = an->sample_peak ();
 300                         auto true_peak = an->true_peak ();
 301
 302                         for (size_t i = 0; i < sample_peak.size(); ++i) {
 303                                 float const peak = max (sample_peak[i].peak, true_peak.empty() ? 0 : true_peak[i]);
 304                                 float const peak_dB = linear_to_db(peak) + an->gain_correction(film()->playlist());
 305                                 if (peak_dB > -3) {
 306                                         ch += dcp::raw_convert<string> (short_audio_channel_name (i)) + ", ";
 307                                 }
 308                         }
 309
 310                         ch = ch.substr (0, ch.length() - 2);
 311
 312                         if (!ch.empty ()) {
 313                                 hint (String::compose (
 314                                               _("Your audio level is very high (on %1).  You should reduce the gain of your audio content."),
 315                                               ch
 316                                               )
 317                                         );
 318                         }
 319                 } catch (OldFormatError& e) {
 320                         /* The audio analysis is too old to load in; just skip this hint as if
 321                            it had never been run.
 322                         */
 323                 }
 324         }
 325 }
 326
 327
 328 static
 329 bool
 330 subtitle_mxf_too_big (shared_ptr<dcp::SubtitleAsset> asset)
 331 {
 332         return asset && asset->file() && boost::filesystem::file_size(*asset->file()) >= (MAX_TEXT_MXF_SIZE - SIZE_SLACK);
 333 }
 334
 335
 336 void
 337 Hints::check_out_of_range_markers ()
 338 {
 339         auto const length = film()->length();
 340         for (auto const& i: film()->markers()) {
 341                 if (i.second >= length) {
 342                         hint (_("At least one marker comes after the end of the project and will be ignored."));
 343                 }
 344         }
 345 }
 346
 347
 348 void
 349 Hints::thread ()
 350 {
 351         auto film = _film.lock ();
 352         if (!film) {
 353                 return;
 354         }
 355
 356         auto content = film->content ();
 357
 358         check_big_font_files ();
 359         check_few_audio_channels ();
 360         check_upmixers ();
 361         check_incorrect_container ();
 362         check_unusual_container ();
 363         check_high_j2k_bandwidth ();
 364         check_frame_rate ();
 365         check_speed_up ();
 366         check_vob ();
 367         check_3d_in_2d ();
 368         check_loudness ();
 369         check_ffec_and_ffmc_in_smpte_feature ();
 370         check_out_of_range_markers ();
 371
 372         emit (bind(boost::ref(Progress), _("Examining closed captions")));
 373
 374         auto player = make_shared<Player>(film);
 375         player->set_ignore_video ();
 376         player->set_ignore_audio ();
 377         player->Text.connect (bind(&Hints::text, this, _1, _2, _3, _4));
 378
 379         struct timeval last_pulse;
 380         gettimeofday (&last_pulse, 0);
 381
 382         try {
 383                 while (!player->pass()) {
 384
 385                         struct timeval now;
 386                         gettimeofday (&now, 0);
 387                         if ((seconds(now) - seconds(last_pulse)) > 1) {
 388                                 if (_stop) {
 389                                         break;
 390                                 }
 391                                 emit (bind (boost::ref(Pulse)));
 392                                 last_pulse = now;
 393                         }
 394                 }
 395         } catch (...) {
 396                 store_current ();
 397         }
 398
 399         _writer->write (player->get_subtitle_fonts());
 400
 401         bool ccap_xml_too_big = false;
 402         bool ccap_mxf_too_big = false;
 403         bool subs_mxf_too_big = false;
 404
 405         boost::filesystem::path dcp_dir = film->dir("hints") / dcpomatic::get_process_id();
 406         boost::filesystem::remove_all (dcp_dir);
 407
 408         try {
 409                 _writer->finish (film->dir("hints") / dcpomatic::get_process_id());
 410         } catch (...) {
 411                 store_current ();
 412                 emit (bind(boost::ref(Finished)));
 413                 return;
 414         }
 415
 416         dcp::DCP dcp (dcp_dir);
 417         dcp.read ();
 418         DCPOMATIC_ASSERT (dcp.cpls().size() == 1);
 419         for (auto reel: dcp.cpls()[0]->reels()) {
 420                 for (auto ccap: reel->closed_captions()) {
 421                         if (ccap->asset() && ccap->asset()->xml_as_string().length() > static_cast<size_t>(MAX_CLOSED_CAPTION_XML_SIZE - SIZE_SLACK) && !ccap_xml_too_big) {
 422                                 hint (_(
 423                                                 "At least one of your closed caption files' XML part is larger than " MAX_CLOSED_CAPTION_XML_SIZE_TEXT
 424                                                 ".  You should divide the DCP into shorter reels."
 425                                        ));
 426                                 ccap_xml_too_big = true;
 427                         }
 428                         if (subtitle_mxf_too_big(ccap->asset()) && !ccap_mxf_too_big) {
 429                                 hint (_(
 430                                                 "At least one of your closed caption files is larger than " MAX_TEXT_MXF_SIZE_TEXT
 431                                                 " in total.  You should divide the DCP into shorter reels."
 432                                        ));
 433                                 ccap_mxf_too_big = true;
 434                         }
 435                 }
 436                 if (reel->main_subtitle() && subtitle_mxf_too_big(reel->main_subtitle()->asset()) && !subs_mxf_too_big) {
 437                         hint (_(
 438                                         "At least one of your subtitle files is larger than " MAX_TEXT_MXF_SIZE_TEXT " in total.  "
 439                                         "You should divide the DCP into shorter reels."
 440                                ));
 441                         subs_mxf_too_big = true;
 442                 }
 443         }
 444         boost::filesystem::remove_all (dcp_dir);
 445
 446         emit (bind(boost::ref(Finished)));
 447 }
 448
 449 void
 450 Hints::hint (string h)
 451 {
 452         emit(bind(boost::ref(Hint), h));
 453 }
 454
 455 void
 456 Hints::text (PlayerText text, TextType type, optional<DCPTextTrack> track, DCPTimePeriod period)
 457 {
 458         _writer->write (text, type, track, period);
 459
 460         switch (type) {
 461         case TextType::CLOSED_CAPTION:
 462                 closed_caption (text, period);
 463                 break;
 464         case TextType::OPEN_SUBTITLE:
 465                 open_subtitle (text, period);
 466                 break;
 467         default:
 468                 break;
 469         }
 470 }
 471
 472
 473 void
 474 Hints::closed_caption (PlayerText text, DCPTimePeriod period)
 475 {
 476         int lines = text.string.size();
 477         for (auto i: text.string) {
 478                 if (utf8_strlen(i.text()) > MAX_CLOSED_CAPTION_LENGTH) {
 479                         ++lines;
 480                         if (!_long_ccap) {
 481                                 _long_ccap = true;
 482                                 hint (
 483                                         String::compose(
 484                                                 "At least one of your closed caption lines has more than %1 characters.  "
 485                                                 "It is advisable to make each line %1 characters at most in length.",
 486                                                 MAX_CLOSED_CAPTION_LENGTH,
 487                                                 MAX_CLOSED_CAPTION_LENGTH)
 488                                      );
 489                         }
 490                 }
 491         }
 492
 493         if (!_too_many_ccap_lines && lines > MAX_CLOSED_CAPTION_LINES) {
 494                 hint (String::compose(_("Some of your closed captions span more than %1 lines, so they will be truncated."), MAX_CLOSED_CAPTION_LINES));
 495                 _too_many_ccap_lines = true;
 496         }
 497
 498         /* XXX: maybe overlapping closed captions (i.e. different languages) are OK with Interop? */
 499         if (film()->interop() && !_overlap_ccap && _last_ccap && _last_ccap->overlap(period)) {
 500                 _overlap_ccap = true;
 501                 hint (_("You have overlapping closed captions, which are not allowed in Interop DCPs.  Change your DCP standard to SMPTE."));
 502         }
 503
 504         _last_ccap = period;
 505 }
 506
 507
 508 void
 509 Hints::open_subtitle (PlayerText text, DCPTimePeriod period)
 510 {
 511         if (period.from < DCPTime::from_seconds(4) && !_early_subtitle) {
 512                 _early_subtitle = true;
 513                 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."));
 514         }
 515
 516         int const vfr = film()->video_frame_rate ();
 517
 518         if (period.duration().frames_round(vfr) < 15 && !_short_subtitle) {
 519                 _short_subtitle = true;
 520                 hint (_("At least one of your subtitles lasts less than 15 frames.  It is advisable to make each subtitle at least 15 frames long."));
 521         }
 522
 523         if (_last_subtitle && DCPTime(period.from - _last_subtitle->to).frames_round(vfr) < 2 && !_subtitles_too_close) {
 524                 _subtitles_too_close = true;
 525                 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."));
 526         }
 527
 528         if (text.string.size() > 3 && !_too_many_subtitle_lines) {
 529                 _too_many_subtitle_lines = true;
 530                 hint (_("At least one of your subtitles has more than 3 lines.  It is advisable to use no more than 3 lines."));
 531         }
 532
 533         size_t longest_line = 0;
 534         for (auto const& i: text.string) {
 535                 longest_line = max (longest_line, i.text().length());
 536         }
 537
 538         if (longest_line > 52 && !_long_subtitle) {
 539                 _long_subtitle = true;
 540                 hint (_("At least one of your subtitle lines has more than 52 characters.  It is advisable to make each line 52 characters at most in length."));
 541         }
 542
 543         _last_subtitle = period;
 544 }
 545
 546
 547 void
 548 Hints::check_ffec_and_ffmc_in_smpte_feature ()
 549 {
 550         auto f = film();
 551         if (!f->interop() && f->dcp_content_type()->libdcp_kind() == dcp::ContentKind::FEATURE && (!f->marker(dcp::Marker::FFEC) || !f->marker(dcp::Marker::FFMC))) {
 552                 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."));
 553         }
 554 }
 555
 556
 557 void
 558 Hints::join ()
 559 {
 560         _thread.join ();
 561 }