No-op; fix GPL address and use the explicit-program-name version.
[dcpomatic.git] / 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 <wx/richtext/richtextctrl.h>
29 #include <boost/algorithm/string.hpp>
30 #include <boost/foreach.hpp>
31
32 using boost::shared_ptr;
33 using boost::optional;
34 using boost::dynamic_pointer_cast;
35
36 HintsDialog::HintsDialog (wxWindow* parent, boost::weak_ptr<Film> film)
37         : wxDialog (parent, wxID_ANY, _("Hints"))
38         , _film (film)
39 {
40         wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
41         _text = new wxRichTextCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (400, 300), wxRE_READONLY);
42         sizer->Add (_text, 1, wxEXPAND | wxALL, 6);
43
44         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
45         if (buttons) {
46                 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
47         }
48
49         SetSizer (sizer);
50         sizer->Layout ();
51         sizer->SetSizeHints (this);
52
53         _text->GetCaret()->Hide ();
54
55         boost::shared_ptr<Film> locked_film = _film.lock ();
56         if (locked_film) {
57                 _film_changed_connection = locked_film->Changed.connect (boost::bind (&HintsDialog::film_changed, this));
58                 _film_content_changed_connection = locked_film->ContentChanged.connect (boost::bind (&HintsDialog::film_changed, this));
59         }
60
61         film_changed ();
62 }
63
64 void
65 HintsDialog::film_changed ()
66 {
67         _text->Clear ();
68         bool hint = false;
69
70         boost::shared_ptr<Film> film = _film.lock ();
71         if (!film) {
72                 return;
73         }
74
75         ContentList content = film->content ();
76
77         _text->BeginStandardBullet (N_("standard/circle"), 1, 50);
78
79         bool big_font_files = false;
80         if (film->interop ()) {
81                 BOOST_FOREACH (shared_ptr<Content> i, content) {
82                         if (i->subtitle) {
83                                 BOOST_FOREACH (shared_ptr<Font> j, i->subtitle->fonts ()) {
84                                         for (int k = 0; k < FontFiles::VARIANTS; ++k) {
85                                                 optional<boost::filesystem::path> const p = j->file (static_cast<FontFiles::Variant> (k));
86                                                 if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) {
87                                                         big_font_files = true;
88                                                 }
89                                         }
90                                 }
91                         }
92                 }
93         }
94
95         if (big_font_files) {
96                 hint = true;
97                 _text->WriteText (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
98         }
99
100         if (film->audio_channels() < 6) {
101                 hint = true;
102                 _text->WriteText (_("Your DCP has fewer than 6 audio channels.  This may cause problems on some projectors."));
103                 _text->Newline ();
104         }
105
106         int flat_or_narrower = 0;
107         int scope = 0;
108         BOOST_FOREACH (shared_ptr<const Content> i, content) {
109                 if (i->video) {
110                         Ratio const * r = i->video->scale().ratio ();
111                         if (r && r->id() == "239") {
112                                 ++scope;
113                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
114                                 ++flat_or_narrower;
115                         }
116                 }
117         }
118
119         if (scope && !flat_or_narrower && film->container()->id() == "185") {
120                 hint = true;
121                 _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."));
122                 _text->Newline ();
123         }
124
125         if (!scope && flat_or_narrower && film->container()->id() == "239") {
126                 hint = true;
127                 _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."));
128                 _text->Newline ();
129         }
130
131         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
132                 hint = true;
133                 _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()));
134                 _text->Newline ();
135         }
136
137         if (film->j2k_bandwidth() >= 245000000) {
138                 hint = true;
139                 _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."));
140                 _text->Newline ();
141         }
142
143         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
144                 hint = true;
145                 _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."));
146                 _text->Newline ();
147         }
148
149         int vob = 0;
150         BOOST_FOREACH (shared_ptr<const Content> i, content) {
151                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
152                         ++vob;
153                 }
154         }
155
156         if (vob > 1) {
157                 hint = true;
158                 _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));
159                 _text->Newline ();
160         }
161
162         int three_d = 0;
163         BOOST_FOREACH (shared_ptr<const Content> i, content) {
164                 if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) {
165                         ++three_d;
166                 }
167         }
168
169         if (three_d > 0 && !film->three_d()) {
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 }