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