src/lib/hints.cc

   1 /*
   2     Copyright (C) 2016 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 "subtitle_content.h"
  27 #include "font.h"
  28 #include "ratio.h"
  29 #include "audio_analysis.h"
  30 #include "compose.hpp"
  31 #include <boost/foreach.hpp>
  32 #include <boost/algorithm/string.hpp>
  33
  34 #include "i18n.h"
  35
  36 using std::vector;
  37 using std::string;
  38 using std::max;
  39 using boost::shared_ptr;
  40 using boost::optional;
  41
  42 vector<string>
  43 get_hints (shared_ptr<const Film> film)
  44 {
  45         vector<string> hints;
  46
  47         ContentList content = film->content ();
  48
  49         bool big_font_files = false;
  50         if (film->interop ()) {
  51                 BOOST_FOREACH (shared_ptr<Content> i, content) {
  52                         if (i->subtitle) {
  53                                 BOOST_FOREACH (shared_ptr<Font> j, i->subtitle->fonts ()) {
  54                                         for (int k = 0; k < FontFiles::VARIANTS; ++k) {
  55                                                 optional<boost::filesystem::path> const p = j->file (static_cast<FontFiles::Variant> (k));
  56                                                 if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) {
  57                                                         big_font_files = true;
  58                                                 }
  59                                         }
  60                                 }
  61                         }
  62                 }
  63         }
  64
  65         if (big_font_files) {
  66                 hints.push_back (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
  67         }
  68
  69         if (film->audio_channels() < 6) {
  70                 hints.push_back (_("Your DCP has fewer than 6 audio channels.  This may cause problems on some projectors."));
  71         }
  72
  73         int flat_or_narrower = 0;
  74         int scope = 0;
  75         BOOST_FOREACH (shared_ptr<const Content> i, content) {
  76                 if (i->video) {
  77                         Ratio const * r = i->video->scale().ratio ();
  78                         if (r && r->id() == "239") {
  79                                 ++scope;
  80                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
  81                                 ++flat_or_narrower;
  82                         }
  83                 }
  84         }
  85
  86         if (scope && !flat_or_narrower && film->container()->id() == "185") {
  87                 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."));
  88         }
  89
  90         if (!scope && flat_or_narrower && film->container()->id() == "239") {
  91                 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."));
  92         }
  93
  94         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
  95                 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()));
  96         }
  97
  98         if (film->j2k_bandwidth() >= 245000000) {
  99                 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."));
 100         }
 101
 102         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
 103                 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."));
 104         }
 105
 106         int vob = 0;
 107         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 108                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
 109                         ++vob;
 110                 }
 111         }
 112
 113         if (vob > 1) {
 114                 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));
 115         }
 116
 117         int three_d = 0;
 118         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 119                 if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) {
 120                         ++three_d;
 121                 }
 122         }
 123
 124         if (three_d > 0 && !film->three_d()) {
 125                 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.)"));
 126         }
 127
 128         boost::filesystem::path path = film->audio_analysis_path (film->playlist ());
 129         if (boost::filesystem::exists (path)) {
 130                 shared_ptr<AudioAnalysis> an (new AudioAnalysis (path));
 131                 if (an->sample_peak() || an->true_peak()) {
 132                         float const peak = max (an->sample_peak().get_value_or(0), an->true_peak().get_value_or(0));
 133                         float const peak_dB = 20 * log10 (peak) + an->gain_correction (film->playlist ());
 134                         if (peak_dB > -3 && peak_dB < -0.5) {
 135                                 hints.push_back (_("Your audio level is very high.  You should reduce the gain of your audio content."));
 136                         } else if (peak_dB > -0.5) {
 137                                 hints.push_back (_("Your audio level is very close to clipping.  You should reduce the gain of your audio content."));
 138                         }
 139                 }
 140         }
 141
 142         return hints;
 143 }