Add hint about > 640kB font files (#588).
[dcpomatic.git] / src / wx / hints_dialog.cc
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "lib/film.h"
21 #include "lib/ratio.h"
22 #include "lib/video_content.h"
23 #include "lib/subtitle_content.h"
24 #include "lib/font.h"
25 #include "hints_dialog.h"
26 #include <wx/richtext/richtextctrl.h>
27 #include <boost/algorithm/string.hpp>
28 #include <boost/foreach.hpp>
29
30 using boost::shared_ptr;
31 using boost::dynamic_pointer_cast;
32
33 HintsDialog::HintsDialog (wxWindow* parent, boost::weak_ptr<Film> f)
34         : wxDialog (parent, wxID_ANY, _("Hints"))
35         , _film (f)
36 {
37         wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
38         _text = new wxRichTextCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (400, 300), wxRE_READONLY);
39         sizer->Add (_text, 1, wxEXPAND | wxALL, 6);
40
41         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
42         if (buttons) {
43                 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
44         }
45
46         SetSizer (sizer);
47         sizer->Layout ();
48         sizer->SetSizeHints (this);
49
50         _text->GetCaret()->Hide ();
51
52         boost::shared_ptr<Film> film = _film.lock ();
53         if (film) {
54                 _film_changed_connection = film->Changed.connect (boost::bind (&HintsDialog::film_changed, this));
55                 _film_content_changed_connection = film->ContentChanged.connect (boost::bind (&HintsDialog::film_changed, this));
56         }
57
58         film_changed ();
59 }
60
61 void
62 HintsDialog::film_changed ()
63 {
64         _text->Clear ();
65         bool hint = false;
66         
67         boost::shared_ptr<Film> film = _film.lock ();
68         if (!film) {
69                 return;
70         }
71
72         ContentList content = film->content ();
73         
74         _text->BeginStandardBullet (N_("standard/circle"), 1, 50);
75
76         bool big_font_files = false;
77         if (film->interop ()) {
78                 BOOST_FOREACH (shared_ptr<Content> i, content) {
79                         shared_ptr<SubtitleContent> s = dynamic_pointer_cast<SubtitleContent> (i);
80                         if (s) {
81                                 BOOST_FOREACH (shared_ptr<Font> j, s->fonts ()) {
82                                         if (j->file && boost::filesystem::file_size (j->file.get ()) >= (640 * 1024)) {
83                                                 big_font_files = true;
84                                         }
85                                 }
86                         }
87                 }
88         }
89
90         if (big_font_files) {
91                 hint = true;
92                 _text->WriteText (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
93         }
94
95         if (film->audio_channels() % 2) {
96                 hint = true;
97                 _text->WriteText (_("Your DCP has an odd number of audio channels.  This is very likely to cause problems on playback."));
98                 _text->Newline ();
99         } else if (film->audio_channels() < 6) {
100                 hint = true;
101                 _text->WriteText (_("Your DCP has fewer than 6 audio channels.  This may cause problems on some projectors."));
102                 _text->Newline ();
103         } else if (film->audio_channels() == 0) {
104                 /* Carsten Kurz reckons having no audio can be a problem */
105                 hint = true;
106                 _text->WriteText (_("Your DCP has no audio channels.  This is likely to cause problems on playback."));
107                 _text->Newline ();
108         }
109
110         int flat_or_narrower = 0;
111         int scope = 0;
112         for (ContentList::const_iterator i = content.begin(); i != content.end(); ++i) {
113                 shared_ptr<VideoContent> vc = dynamic_pointer_cast<VideoContent> (*i);
114                 if (vc) {
115                         Ratio const * r = vc->scale().ratio ();
116                         if (r && r->id() == "239") {
117                                 ++scope;
118                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
119                                 ++flat_or_narrower;
120                         }
121                 }
122         }
123
124         if (scope && !flat_or_narrower && film->container()->id() == "185") {
125                 hint = true;
126                 _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."));
127                 _text->Newline ();
128         }
129
130         if (!scope && flat_or_narrower && film->container()->id() == "239") {
131                 hint = true;
132                 _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."));
133                 _text->Newline ();
134         }
135         
136         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
137                 hint = true;
138                 _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()));
139                 _text->Newline ();
140         }
141
142         if (film->j2k_bandwidth() >= 245000000) {
143                 hint = true;
144                 _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."));
145                 _text->Newline ();
146         }
147
148         int vob = 0;
149         for (ContentList::const_iterator i = content.begin(); i != content.end(); ++i) {
150                 if (boost::algorithm::starts_with ((*i)->path(0).filename().string(), "VTS_")) {
151                         ++vob;
152                 }
153         }
154
155         if (vob > 1) {
156                 hint = true;
157                 _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));
158                 _text->Newline ();
159         }
160
161         int three_d = 0;
162         for (ContentList::const_iterator i = content.begin(); i != content.end(); ++i) {
163                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (*i);
164                 if (vc && vc->video_frame_type() != VIDEO_FRAME_TYPE_2D) {
165                         ++three_d;
166                 }
167         }
168
169         if (three_d > 0) {
170                 hint = true;
171                 _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.)"));
172                 _text->Newline ();
173         }
174
175         _text->EndSymbolBullet ();
176
177         if (!hint) {
178                 _text->WriteText (_("There are no hints: everything looks good!"));
179         }
180 }