e328661c65f7ac4ecac66e0a47289be1e50e0a64
[dcpomatic.git] / src / wx / hints_dialog.cc
1 /*
2     Copyright (C) 2012-2016 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 "hints_dialog.h"
21 #include "lib/film.h"
22 #include "lib/ratio.h"
23 #include "lib/video_content.h"
24 #include "lib/subtitle_content.h"
25 #include "lib/font.h"
26 #include "lib/content.h"
27 #include <wx/richtext/richtextctrl.h>
28 #include <boost/algorithm/string.hpp>
29 #include <boost/foreach.hpp>
30
31 using boost::shared_ptr;
32 using boost::optional;
33 using boost::dynamic_pointer_cast;
34
35 HintsDialog::HintsDialog (wxWindow* parent, boost::weak_ptr<Film> film)
36         : wxDialog (parent, wxID_ANY, _("Hints"))
37         , _film (film)
38 {
39         wxBoxSizer* sizer = new wxBoxSizer (wxVERTICAL);
40         _text = new wxRichTextCtrl (this, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize (400, 300), wxRE_READONLY);
41         sizer->Add (_text, 1, wxEXPAND | wxALL, 6);
42
43         wxSizer* buttons = CreateSeparatedButtonSizer (wxOK);
44         if (buttons) {
45                 sizer->Add (buttons, wxSizerFlags().Expand().DoubleBorder());
46         }
47
48         SetSizer (sizer);
49         sizer->Layout ();
50         sizer->SetSizeHints (this);
51
52         _text->GetCaret()->Hide ();
53
54         boost::shared_ptr<Film> locked_film = _film.lock ();
55         if (locked_film) {
56                 _film_changed_connection = locked_film->Changed.connect (boost::bind (&HintsDialog::film_changed, this));
57                 _film_content_changed_connection = locked_film->ContentChanged.connect (boost::bind (&HintsDialog::film_changed, this));
58         }
59
60         film_changed ();
61 }
62
63 void
64 HintsDialog::film_changed ()
65 {
66         _text->Clear ();
67         bool hint = false;
68
69         boost::shared_ptr<Film> film = _film.lock ();
70         if (!film) {
71                 return;
72         }
73
74         ContentList content = film->content ();
75
76         _text->BeginStandardBullet (N_("standard/circle"), 1, 50);
77
78         bool big_font_files = false;
79         if (film->interop ()) {
80                 BOOST_FOREACH (shared_ptr<Content> i, content) {
81                         if (i->subtitle) {
82                                 BOOST_FOREACH (shared_ptr<Font> j, i->subtitle->fonts ()) {
83                                         for (int k = 0; k < FontFiles::VARIANTS; ++k) {
84                                                 optional<boost::filesystem::path> const p = j->file (static_cast<FontFiles::Variant> (k));
85                                                 if (p && boost::filesystem::file_size (p.get()) >= (640 * 1024)) {
86                                                         big_font_files = true;
87                                                 }
88                                         }
89                                 }
90                         }
91                 }
92         }
93
94         if (big_font_files) {
95                 hint = true;
96                 _text->WriteText (_("You have specified a font file which is larger than 640kB.  This is very likely to cause problems on playback."));
97         }
98
99         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         }
104
105         int flat_or_narrower = 0;
106         int scope = 0;
107         BOOST_FOREACH (shared_ptr<const Content> i, content) {
108                 if (i->video) {
109                         Ratio const * r = i->video->scale().ratio ();
110                         if (r && r->id() == "239") {
111                                 ++scope;
112                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
113                                 ++flat_or_narrower;
114                         }
115                 }
116         }
117
118         if (scope && !flat_or_narrower && film->container()->id() == "185") {
119                 hint = true;
120                 _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."));
121                 _text->Newline ();
122         }
123
124         if (!scope && flat_or_narrower && film->container()->id() == "239") {
125                 hint = true;
126                 _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."));
127                 _text->Newline ();
128         }
129
130         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
131                 hint = true;
132                 _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()));
133                 _text->Newline ();
134         }
135
136         if (film->j2k_bandwidth() >= 245000000) {
137                 hint = true;
138                 _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."));
139                 _text->Newline ();
140         }
141
142         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
143                 hint = true;
144                 _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."));
145                 _text->Newline ();
146         }
147
148         int vob = 0;
149         BOOST_FOREACH (shared_ptr<const Content> i, content) {
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         BOOST_FOREACH (shared_ptr<const Content> i, content) {
163                 if (i->video && i->video->frame_type() != VIDEO_FRAME_TYPE_2D) {
164                         ++three_d;
165                 }
166         }
167
168         if (three_d > 0 && !film->three_d()) {
169                 hint = true;
170                 _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.)"));
171                 _text->Newline ();
172         }
173
174         _text->EndSymbolBullet ();
175
176         if (!hint) {
177                 _text->WriteText (_("There are no hints: everything looks good!"));
178         }
179 }