src/wx/hints_dialog.cc

   1 /*
   2     Copyright (C) 2012-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_dialog.h"
  22 #include "lib/film.h"
  23 #include "lib/ratio.h"
  24 #include "lib/video_content.h"
  25 #include "lib/subtitle_content.h"
  26 #include "lib/font.h"
  27 #include "lib/content.h"
  28 #include "lib/audio_analysis.h"
  29 #include <wx/richtext/richtextctrl.h>
  30 #include <boost/algorithm/string.hpp>
  31 #include <boost/foreach.hpp>
  32
  33 using std::max;
  34 using boost::shared_ptr;
  35 using boost::optional;
  36 using boost::dynamic_pointer_cast;
  37
  38 HintsDialog::HintsDialog (wxWindow* parent, boost::weak_ptr<Film> film)
  39         : wxDialog (parent, wxID_ANY, _("Hints"))
  40         , _film (film)
  41 {
  42         wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
  43         _text = new wxRichTextCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (400, 300), wxRE_READONLY);
  44         sizer->Add (_text, 1, wxEXPAND | wxALL, 6);
  45
  46         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
  47         if (buttons) {
  48                 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
  49         }
  50
  51         SetSizer (sizer);
  52         sizer->Layout ();
  53         sizer->SetSizeHints (this);
  54
  55         _text->GetCaret()->Hide ();
  56
  57         boost::shared_ptr<Film> locked_film = _film.lock ();
  58         if (locked_film) {
  59                 _film_changed_connection = locked_film->Changed.connect (boost::bind (&HintsDialog::film_changed, this));
  60                 _film_content_changed_connection = locked_film->ContentChanged.connect (boost::bind (&HintsDialog::film_changed, this));
  61         }
  62
  63         film_changed ();
  64 }
  65
  66 void
  67 HintsDialog::film_changed ()
  68 {
  69         _text->Clear ();
  70         bool hint = false;
  71
  72         boost::shared_ptr<Film> film = _film.lock ();
  73         if (!film) {
  74                 return;
  75         }
  76
  77         ContentList content = film->content ();
  78
  79         _text->BeginStandardBullet (N_("standard/circle"), 1, 50);
  80
  81         bool big_font_files = false;
  82         if (film->interop ()) {
  83                 BOOST_FOREACH (shared_ptr<Content> i, content) {
  84                         if (i->subtitle) {
  85                                 BOOST_FOREACH (shared_ptr<Font> j, i->subtitle->fonts ()) {
  86                                         for (int k = 0; k < FontFiles::VARIANTS; ++k) {
  87                                                 optional<boost::filesystem::path> const p = j->file (static_cast<FontFiles::Variant> (k));
  88                                                 if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) {
  89                                                         big_font_files = true;
  90                                                 }
  91                                         }
  92                                 }
  93                         }
  94                 }
  95         }
  96
  97         if (big_font_files) {
  98                 hint = true;
  99                 _text->WriteText (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
 100         }
 101
 102         if (film->audio_channels() < 6) {
 103                 hint = true;
 104                 _text->WriteText (_("Your DCP has fewer than 6 audio channels.  This may cause problems on some projectors."));
 105                 _text->Newline ();
 106         }
 107
 108         int flat_or_narrower = 0;
 109         int scope = 0;
 110         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 111                 if (i->video) {
 112                         Ratio const * r = i->video->scale().ratio ();
 113                         if (r && r->id() == "239") {
 114                                 ++scope;
 115                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
 116                                 ++flat_or_narrower;
 117                         }
 118                 }
 119         }
 120
 121         if (scope && !flat_or_narrower && film->container()->id() == "185") {
 122                 hint = true;
 123                 _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."));
 124                 _text->Newline ();
 125         }
 126
 127         if (!scope && flat_or_narrower && film->container()->id() == "239") {
 128                 hint = true;
 129                 _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."));
 130                 _text->Newline ();
 131         }
 132
 133         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
 134                 hint = true;
 135                 _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()));
 136                 _text->Newline ();
 137         }
 138
 139         if (film->j2k_bandwidth() >= 245000000) {
 140                 hint = true;
 141                 _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."));
 142                 _text->Newline ();
 143         }
 144
 145         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
 146                 hint = true;
 147                 _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."));
 148                 _text->Newline ();
 149         }
 150
 151         int vob = 0;
 152         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 153                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
 154                         ++vob;
 155                 }
 156         }
 157
 158         if (vob > 1) {
 159                 hint = true;
 160                 _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));
 161                 _text->Newline ();
 162         }
 163
 164         int three_d = 0;
 165         BOOST_FOREACH (shared_ptr<const Content> i, content) {
 166                 if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) {
 167                         ++three_d;
 168                 }
 169         }
 170
 171         if (three_d > 0 && !film->three_d()) {
 172                 hint = true;
 173                 _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.)"));
 174                 _text->Newline ();
 175         }
 176
 177         boost::filesystem::path path = film->audio_analysis_path (film->playlist ());
 178         if (boost::filesystem::exists (path)) {
 179                 shared_ptr<AudioAnalysis> an (new AudioAnalysis (path));
 180                 if (an->sample_peak() || an->true_peak()) {
 181                         float const peak = max (an->sample_peak().get_value_or(0), an->true_peak().get_value_or(0));
 182                         float const peak_dB = 20 * log10 (peak) + an->gain_correction (film->playlist ());
 183                         if (peak_dB > -3 && peak_dB < -0.5) {
 184                                 hint = true;
 185                                 _text->WriteText (_("Your audio level is very high.  You should reduce the gain of your audio content."));
 186                                 _text->Newline ();
 187                         } else if (peak_dB > -0.5) {
 188                                 hint = true;
 189                                 _text->WriteText (_("Your audio level is very close to clipping.  You should reduce the gain of your audio content."));
 190                                 _text->Newline ();
 191                         }
 192                 }
 193         }
 194
 195         _text->EndSymbolBullet ();
 196
 197         if (!hint) {
 198                 _text->WriteText (_("There are no hints: everything looks good!"));
 199         }
 200 }