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