Subtitle rearrangements.
[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                         shared_ptr<SubtitleContent> s = dynamic_pointer_cast<SubtitleContent> (i);
82                         if (s) {
83                                 BOOST_FOREACH (shared_ptr<Font> j, s->fonts ()) {
84                                         for (int i = 0; i < FontFiles::VARIANTS; ++i) {
85                                                 optional<boost::filesystem::path> const p = j->file (static_cast<FontFiles::Variant> (i));
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                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (i);
110                 if (vc) {
111                         Ratio const * r = vc->scale().ratio ();
112                         if (r && r->id() == "239") {
113                                 ++scope;
114                         } else if (r && r->id() != "239" && r->id() != "full-frame") {
115                                 ++flat_or_narrower;
116                         }
117                 }
118         }
119
120         if (scope && !flat_or_narrower && film->container()->id() == "185") {
121                 hint = true;
122                 _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."));
123                 _text->Newline ();
124         }
125
126         if (!scope && flat_or_narrower && film->container()->id() == "239") {
127                 hint = true;
128                 _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."));
129                 _text->Newline ();
130         }
131
132         if (film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
133                 hint = true;
134                 _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()));
135                 _text->Newline ();
136         }
137
138         if (film->j2k_bandwidth() >= 245000000) {
139                 hint = true;
140                 _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."));
141                 _text->Newline ();
142         }
143
144         if (film->interop() && film->video_frame_rate() != 24 && film->video_frame_rate() != 48) {
145                 hint = true;
146                 _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."));
147                 _text->Newline ();
148         }
149
150         int vob = 0;
151         BOOST_FOREACH (shared_ptr<const Content> i, content) {
152                 if (boost::algorithm::starts_with (i->path(0).filename().string(), "VTS_")) {
153                         ++vob;
154                 }
155         }
156
157         if (vob > 1) {
158                 hint = true;
159                 _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));
160                 _text->Newline ();
161         }
162
163         int three_d = 0;
164         BOOST_FOREACH (shared_ptr<const Content> i, content) {
165                 shared_ptr<const VideoContent> vc = dynamic_pointer_cast<const VideoContent> (i);
166                 if (vc && vc->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         _text->EndSymbolBullet ();
178
179         if (!hint) {
180                 _text->WriteText (_("There are no hints: everything looks good!"));
181         }
182 }