Fix confusing error on trying to load a DoM project into the player (#1948).
[dcpomatic.git] / src / tools / dcpomatic_player.cc
1 /*
2     Copyright (C) 2017-2021 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 "wx/wx_signal_manager.h"
22 #include "wx/wx_util.h"
23 #include "wx/about_dialog.h"
24 #include "wx/report_problem_dialog.h"
25 #include "wx/film_viewer.h"
26 #include "wx/player_information.h"
27 #include "wx/update_dialog.h"
28 #include "wx/player_config_dialog.h"
29 #include "wx/verify_dcp_dialog.h"
30 #include "wx/standard_controls.h"
31 #include "wx/playlist_controls.h"
32 #include "wx/timer_display.h"
33 #include "wx/system_information_dialog.h"
34 #include "wx/player_stress_tester.h"
35 #include "wx/verify_dcp_progress_dialog.h"
36 #include "lib/cross.h"
37 #include "lib/config.h"
38 #include "lib/util.h"
39 #include "lib/internet.h"
40 #include "lib/update_checker.h"
41 #include "lib/compose.hpp"
42 #include "lib/dcp_content.h"
43 #include "lib/job_manager.h"
44 #include "lib/job.h"
45 #include "lib/film.h"
46 #include "lib/null_log.h"
47 #include "lib/video_content.h"
48 #include "lib/text_content.h"
49 #include "lib/ratio.h"
50 #include "lib/verify_dcp_job.h"
51 #include "lib/dcp_examiner.h"
52 #include "lib/examine_content_job.h"
53 #include "lib/server.h"
54 #include "lib/dcpomatic_socket.h"
55 #include "lib/scoped_temporary.h"
56 #include "lib/ffmpeg_content.h"
57 #include "lib/dcpomatic_log.h"
58 #include "lib/file_log.h"
59 #include <dcp/dcp.h>
60 #include <dcp/raw_convert.h>
61 #include <dcp/exceptions.h>
62 #include <wx/wx.h>
63 #include <wx/stdpaths.h>
64 #include <wx/splash.h>
65 #include <wx/cmdline.h>
66 #include <wx/preferences.h>
67 #include <wx/progdlg.h>
68 #include <wx/display.h>
69 #ifdef __WXGTK__
70 #include <X11/Xlib.h>
71 #endif
72 #include <boost/bind/bind.hpp>
73 #include <boost/algorithm/string.hpp>
74 #include <iostream>
75
76 #ifdef check
77 #undef check
78 #endif
79
80 #define MAX_CPLS 32
81
82 using std::cout;
83 using std::dynamic_pointer_cast;
84 using std::exception;
85 using std::list;
86 using std::make_shared;
87 using std::shared_ptr;
88 using std::string;
89 using std::vector;
90 using std::weak_ptr;
91 using boost::scoped_array;
92 using boost::optional;
93 using boost::thread;
94 using boost::bind;
95 #if BOOST_VERSION >= 106100
96 using namespace boost::placeholders;
97 #endif
98 using dcp::raw_convert;
99 using namespace dcpomatic;
100
101 enum {
102         ID_file_open = 1,
103         ID_file_add_ov,
104         ID_file_add_kdm,
105         ID_file_history,
106         /* Allow spare IDs after _history for the recent files list */
107         ID_file_close = 100,
108         ID_view_cpl,
109         /* Allow spare IDs for CPLs */
110         ID_view_full_screen = 200,
111         ID_view_dual_screen,
112         ID_view_closed_captions,
113         ID_view_scale_appropriate,
114         ID_view_scale_full,
115         ID_view_scale_half,
116         ID_view_scale_quarter,
117         ID_help_report_a_problem,
118         ID_tools_verify,
119         ID_tools_check_for_updates,
120         ID_tools_timing,
121         ID_tools_system_information,
122         /* IDs for shortcuts (with no associated menu item) */
123         ID_start_stop,
124         ID_go_back_frame,
125         ID_go_forward_frame,
126         ID_go_back_small_amount,
127         ID_go_forward_small_amount,
128         ID_go_back_medium_amount,
129         ID_go_forward_medium_amount,
130         ID_go_back_large_amount,
131         ID_go_forward_large_amount,
132         ID_go_to_start,
133         ID_go_to_end
134 };
135
136 class DOMFrame : public wxFrame
137 {
138 public:
139         DOMFrame ()
140                 : wxFrame (0, -1, _("DCP-o-matic Player"))
141                 , _dual_screen (0)
142                 , _update_news_requested (false)
143                 , _info (0)
144                 , _mode (Config::instance()->player_mode())
145                 , _config_dialog (0)
146                 , _file_menu (0)
147                 , _history_items (0)
148                 , _history_position (0)
149                 , _history_separator (0)
150                 , _system_information_dialog (0)
151                 , _view_full_screen (0)
152                 , _view_dual_screen (0)
153                 , _main_sizer (new wxBoxSizer (wxVERTICAL))
154         {
155                 dcpomatic_log = make_shared<NullLog>();
156
157 #if defined(DCPOMATIC_WINDOWS)
158                 maybe_open_console ();
159                 cout << "DCP-o-matic Player is starting." << "\n";
160 #endif
161
162                 auto bar = new wxMenuBar;
163                 setup_menu (bar);
164                 set_menu_sensitivity ();
165                 SetMenuBar (bar);
166
167 #ifdef DCPOMATIC_WINDOWS
168                 SetIcon (wxIcon (std_to_wx ("id")));
169 #endif
170
171                 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
172                 update_from_config (Config::PLAYER_DEBUG_LOG);
173
174                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
175                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
176                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
177                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
178                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
179                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
180                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
181                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
182                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
183                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
184                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
185                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
186                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
187                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
188                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
189                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
190                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
191                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
192                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
193                 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
194
195                 /* Use a panel as the only child of the Frame so that we avoid
196                    the dark-grey background on Windows.
197                 */
198                 _overall_panel = new wxPanel (this, wxID_ANY);
199
200                 _viewer.reset (new FilmViewer (_overall_panel));
201                 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
202                         auto pc = new PlaylistControls (_overall_panel, _viewer);
203                         _controls = pc;
204                         pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
205                 } else {
206                         _controls = new StandardControls (_overall_panel, _viewer, false);
207                 }
208                 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
209                 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
210                 _viewer->Started.connect (bind(&DOMFrame::playback_started, this, _1));
211                 _viewer->Stopped.connect (bind(&DOMFrame::playback_stopped, this, _1));
212                 _info = new PlayerInformation (_overall_panel, _viewer);
213                 setup_main_sizer (Config::instance()->player_mode());
214 #ifdef __WXOSX__
215                 int accelerators = 12;
216 #else
217                 int accelerators = 11;
218 #endif
219
220                 _stress.setup (this, _controls);
221
222                 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
223                 accel[0].Set(wxACCEL_NORMAL,                WXK_SPACE, ID_start_stop);
224                 accel[1].Set(wxACCEL_NORMAL,                WXK_LEFT,  ID_go_back_frame);
225                 accel[2].Set(wxACCEL_NORMAL,                WXK_RIGHT, ID_go_forward_frame);
226                 accel[3].Set(wxACCEL_SHIFT,                 WXK_LEFT,  ID_go_back_small_amount);
227                 accel[4].Set(wxACCEL_SHIFT,                 WXK_RIGHT, ID_go_forward_small_amount);
228                 accel[5].Set(wxACCEL_CTRL,                  WXK_LEFT,  ID_go_back_medium_amount);
229                 accel[6].Set(wxACCEL_CTRL,                  WXK_RIGHT, ID_go_forward_medium_amount);
230                 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL,  WXK_LEFT,  ID_go_back_large_amount);
231                 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL,  WXK_RIGHT, ID_go_forward_large_amount);
232                 accel[9].Set(wxACCEL_NORMAL,                WXK_HOME,  ID_go_to_start);
233                 accel[10].Set(wxACCEL_NORMAL,               WXK_END,   ID_go_to_end);
234 #ifdef __WXOSX__
235                 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
236 #endif
237                 wxAcceleratorTable accel_table (accelerators, accel);
238                 SetAcceleratorTable (accel_table);
239                 delete[] accel;
240
241                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
242                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this),      ID_go_back_frame);
243                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this),   ID_go_forward_frame);
244                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this,   -60), ID_go_back_small_amount);
245                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this,    60), ID_go_forward_small_amount);
246                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this,  -600), ID_go_back_medium_amount);
247                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this,   600), ID_go_forward_medium_amount);
248                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this, -3600), ID_go_back_large_amount);
249                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds,  this,  3600), ID_go_forward_large_amount);
250                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
251                 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end,   this), ID_go_to_end);
252
253                 reset_film ();
254
255                 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
256                 setup_screen ();
257
258                 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
259         }
260
261         void setup_main_sizer (Config::PlayerMode mode)
262         {
263                 _main_sizer->Detach (_viewer->panel());
264                 _main_sizer->Detach (_controls);
265                 _main_sizer->Detach (_info);
266                 if (mode != Config::PLAYER_MODE_DUAL) {
267                         _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
268                 }
269                 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
270                 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
271                 _overall_panel->SetSizer (_main_sizer);
272                 _overall_panel->Layout ();
273         }
274
275         bool playback_permitted ()
276         {
277                 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
278                         return true;
279                 }
280
281                 bool ok = true;
282                 for (auto i: _film->content()) {
283                         auto d = dynamic_pointer_cast<DCPContent>(i);
284                         if (d && !d->kdm_timing_window_valid()) {
285                                 ok = false;
286                         }
287                 }
288
289                 if (!ok) {
290                         error_dialog (this, _("The KDM does not allow playback of this content at this time."));
291                 }
292
293                 return ok;
294         }
295
296         void playback_started (DCPTime time)
297         {
298                 /* XXX: this only logs the first piece of content; probably should be each piece? */
299                 if (_film->content().empty()) {
300                         return;
301                 }
302
303                 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
304                 if (dcp) {
305                         DCPExaminer ex (dcp, true);
306                         shared_ptr<dcp::CPL> playing_cpl;
307                         for (auto i: ex.cpls()) {
308                                 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
309                                         playing_cpl = i;
310                                 }
311                         }
312                         DCPOMATIC_ASSERT (playing_cpl);
313
314                         _controls->log (
315                                 wxString::Format(
316                                         "playback-started %s %s %s",
317                                         time.timecode(_film->video_frame_rate()).c_str(),
318                                         dcp->directories().front().string().c_str(),
319                                         playing_cpl->annotation_text().get_value_or("").c_str()
320                                         )
321                                 );
322                 }
323
324                 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(_film->content().front());
325                 if (ffmpeg) {
326                         _controls->log (
327                                 wxString::Format(
328                                         "playback-started %s %s",
329                                         time.timecode(_film->video_frame_rate()).c_str(),
330                                         ffmpeg->path(0).string().c_str()
331                                         )
332                                 );
333                 }
334         }
335
336         void playback_stopped (DCPTime time)
337         {
338                 _controls->log (wxString::Format("playback-stopped %s", time.timecode(_film->video_frame_rate()).c_str()));
339         }
340
341         void set_decode_reduction (optional<int> reduction)
342         {
343                 _viewer->set_dcp_decode_reduction (reduction);
344                 _info->triggered_update ();
345                 Config::instance()->set_decode_reduction (reduction);
346         }
347
348         void load_dcp (boost::filesystem::path dir)
349         {
350                 DCPOMATIC_ASSERT (_film);
351
352                 reset_film ();
353                 try {
354                         _stress.set_suspended (true);
355                         // here
356                         auto dcp = make_shared<DCPContent>(dir);
357                         auto job = make_shared<ExamineContentJob>(_film, dcp);
358                         _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
359                         JobManager::instance()->add (job);
360                         bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
361                         if (!ok || !report_errors_from_last_job(this)) {
362                                 return;
363                         }
364                         Config::instance()->add_to_player_history (dir);
365                 } catch (ProjectFolderError &) {
366                         error_dialog (
367                                 this,
368                                 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
369                                 _(
370                                         "This looks like a DCP-o-matic project folder, which cannot be loaded into the player.  "
371                                         "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
372                                  )
373                                 );
374                 } catch (dcp::ReadError& e) {
375                         error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
376                 } catch (DCPError& e) {
377                         error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
378                 }
379         }
380
381         void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
382         {
383                 auto job = weak_job.lock ();
384                 if (!job || !job->finished_ok()) {
385                         return;
386                 }
387
388                 auto content = weak_content.lock ();
389                 if (!content) {
390                         return;
391                 }
392
393                 _film->add_content (content);
394                 _stress.set_suspended (false);
395         }
396
397         void reset_film_weak (weak_ptr<Film> weak_film)
398         {
399                 auto film = weak_film.lock ();
400                 if (film) {
401                         reset_film (film);
402                 }
403         }
404
405         void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
406         {
407                 _film = film;
408                 _film->set_tolerant (true);
409                 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
410                 _viewer->set_film (_film);
411                 _controls->set_film (_film);
412                 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
413                 _info->triggered_update ();
414         }
415
416         void film_changed (ChangeType type, Film::Property property)
417         {
418                 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
419                         return;
420                 }
421
422                 if (_viewer->playing ()) {
423                         _viewer->stop ();
424                 }
425
426                 /* Start off as Flat */
427                 _film->set_container (Ratio::from_id("185"));
428
429                 for (auto i: _film->content()) {
430                         auto dcp = dynamic_pointer_cast<DCPContent>(i);
431
432                         for (auto j: i->text) {
433                                 j->set_use (true);
434                         }
435
436                         if (i->video) {
437                                 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
438                                 if (r->id() == "239") {
439                                         /* Any scope content means we use scope */
440                                         _film->set_container(r);
441                                 }
442                         }
443
444                         /* Any 3D content means we use 3D mode */
445                         if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
446                                 _film->set_three_d (true);
447                         }
448                 }
449
450                 _viewer->seek (DCPTime(), true);
451                 _info->triggered_update ();
452
453                 set_menu_sensitivity ();
454
455                 auto old = _cpl_menu->GetMenuItems();
456                 for (auto const& i: old) {
457                         _cpl_menu->Remove (i);
458                 }
459
460                 if (_film->content().size() == 1) {
461                         /* Offer a CPL menu */
462                         auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
463                         if (first) {
464                                 DCPExaminer ex (first, true);
465                                 int id = ID_view_cpl;
466                                 for (auto i: ex.cpls()) {
467                                         auto j = _cpl_menu->AppendRadioItem(
468                                                 id,
469                                                 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
470                                                 );
471                                         j->Check(!first->cpl() || i->id() == *first->cpl());
472                                         ++id;
473                                 }
474                         }
475                 }
476         }
477
478         void load_stress_script (boost::filesystem::path path)
479         {
480                 _stress.load_script (path);
481         }
482
483 private:
484
485         void examine_content ()
486         {
487                 DCPOMATIC_ASSERT (_film);
488                 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
489                 DCPOMATIC_ASSERT (dcp);
490                 dcp->examine (_film, shared_ptr<Job>());
491
492                 /* Examining content re-creates the TextContent objects, so we must re-enable them */
493                 for (auto i: dcp->text) {
494                         i->set_use (true);
495                 }
496         }
497
498         bool report_errors_from_last_job (wxWindow* parent) const
499         {
500                 auto jm = JobManager::instance ();
501
502                 DCPOMATIC_ASSERT (!jm->get().empty());
503
504                 auto last = jm->get().back();
505                 if (last->finished_in_error()) {
506                         error_dialog(parent, wxString::Format(_("Could not load DCP.\n\n%s."), std_to_wx(last->error_summary()).data()), std_to_wx(last->error_details()));
507                         return false;
508                 }
509
510                 return true;
511         }
512
513         void setup_menu (wxMenuBar* m)
514         {
515                 _file_menu = new wxMenu;
516                 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
517                 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
518                 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
519
520                 _history_position = _file_menu->GetMenuItems().GetCount();
521
522                 _file_menu->AppendSeparator ();
523                 _file_menu->Append (ID_file_close, _("&Close"));
524                 _file_menu->AppendSeparator ();
525
526 #ifdef __WXOSX__
527                 _file_menu->Append (wxID_EXIT, _("&Exit"));
528 #else
529                 _file_menu->Append (wxID_EXIT, _("&Quit"));
530 #endif
531
532 #ifdef __WXOSX__
533                 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
534 #else
535                 auto edit = new wxMenu;
536                 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
537 #endif
538
539                 prefs->Enable (Config::instance()->have_write_permission());
540
541                 _cpl_menu = new wxMenu;
542
543                 auto view = new wxMenu;
544                 auto c = Config::instance()->decode_reduction();
545                 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
546                 view->AppendSeparator();
547                 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
548                 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
549                 setup_menu ();
550                 view->AppendSeparator();
551                 view->Append(ID_view_closed_captions, _("Closed captions..."));
552                 view->AppendSeparator();
553                 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
554                 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
555                 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
556                 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
557
558                 auto tools = new wxMenu;
559                 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
560                 tools->AppendSeparator ();
561                 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
562                 tools->Append (ID_tools_timing, _("Timing..."));
563                 tools->Append (ID_tools_system_information, _("System information..."));
564
565                 auto help = new wxMenu;
566 #ifdef __WXOSX__
567                 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
568 #else
569                 help->Append (wxID_ABOUT, _("About"));
570 #endif
571                 help->Append (ID_help_report_a_problem, _("Report a problem..."));
572
573                 m->Append (_file_menu, _("&File"));
574 #ifndef __WXOSX__
575                 m->Append (edit, _("&Edit"));
576 #endif
577                 m->Append (view, _("&View"));
578                 m->Append (tools, _("&Tools"));
579                 m->Append (help, _("&Help"));
580         }
581
582         void file_open ()
583         {
584                 auto d = wxStandardPaths::Get().GetDocumentsDir();
585                 if (Config::instance()->last_player_load_directory()) {
586                         d = std_to_wx (Config::instance()->last_player_load_directory()->string());
587                 }
588
589                 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
590
591                 int r;
592                 while (true) {
593                         r = c->ShowModal ();
594                         if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
595                                 error_dialog (this, _("You did not select a folder.  Make sure that you select a folder before clicking Open."));
596                         } else {
597                                 break;
598                         }
599                 }
600
601                 if (r == wxID_OK) {
602                         boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
603                         load_dcp (dcp);
604                         Config::instance()->set_last_player_load_directory (dcp.parent_path());
605                 }
606
607                 c->Destroy ();
608         }
609
610         void file_add_ov ()
611         {
612                 auto c = new wxDirDialog (
613                         this,
614                         _("Select DCP to open as OV"),
615                         wxStandardPaths::Get().GetDocumentsDir(),
616                         wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
617                         );
618
619                 int r;
620                 while (true) {
621                         r = c->ShowModal ();
622                         if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
623                                 error_dialog (this, _("You did not select a folder.  Make sure that you select a folder before clicking Open."));
624                         } else {
625                                 break;
626                         }
627                 }
628
629                 if (r == wxID_OK) {
630                         DCPOMATIC_ASSERT (_film);
631                         auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
632                         DCPOMATIC_ASSERT (dcp);
633                         dcp->add_ov (wx_to_std(c->GetPath()));
634                         JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
635                         bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
636                         if (!ok || !report_errors_from_last_job(this)) {
637                                 return;
638                         }
639                         for (auto i: dcp->text) {
640                                 i->set_use (true);
641                         }
642                         if (dcp->video) {
643                                 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
644                                 if (r) {
645                                         _film->set_container(r);
646                                 }
647                         }
648                 }
649
650                 c->Destroy ();
651                 _info->triggered_update ();
652         }
653
654         void file_add_kdm ()
655         {
656                 auto d = new wxFileDialog (this, _("Select KDM"));
657
658                 if (d->ShowModal() == wxID_OK) {
659                         DCPOMATIC_ASSERT (_film);
660                         auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
661                         DCPOMATIC_ASSERT (dcp);
662                         try {
663                                 if (dcp) {
664                                         _viewer->set_coalesce_player_changes (true);
665                                         dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
666                                         examine_content();
667                                         _viewer->set_coalesce_player_changes (false);
668                                 }
669                         } catch (exception& e) {
670                                 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
671                                 d->Destroy ();
672                                 return;
673                         }
674                 }
675
676                 d->Destroy ();
677                 _info->triggered_update ();
678         }
679
680         void file_history (wxCommandEvent& event)
681         {
682                 auto history = Config::instance()->player_history ();
683                 int n = event.GetId() - ID_file_history;
684                 if (n >= 0 && n < static_cast<int> (history.size ())) {
685                         try {
686                                 load_dcp (history[n]);
687                         } catch (exception& e) {
688                                 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
689                         }
690                 }
691         }
692
693         void file_close ()
694         {
695                 reset_film ();
696                 _info->triggered_update ();
697                 set_menu_sensitivity ();
698         }
699
700         void file_exit ()
701         {
702                 Close ();
703         }
704
705         void edit_preferences ()
706         {
707                 if (!Config::instance()->have_write_permission()) {
708                         return;
709                 }
710
711                 if (!_config_dialog) {
712                         _config_dialog = create_player_config_dialog ();
713                 }
714                 _config_dialog->Show (this);
715         }
716
717         void view_cpl (wxCommandEvent& ev)
718         {
719                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
720                 DCPOMATIC_ASSERT (dcp);
721                 DCPExaminer ex (dcp, true);
722                 int id = ev.GetId() - ID_view_cpl;
723                 DCPOMATIC_ASSERT (id >= 0);
724                 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
725                 auto cpls = ex.cpls();
726                 auto i = cpls.begin();
727                 while (id > 0) {
728                         ++i;
729                         --id;
730                 }
731
732                 _viewer->set_coalesce_player_changes (true);
733                 dcp->set_cpl ((*i)->id());
734                 examine_content ();
735                 _viewer->set_coalesce_player_changes (false);
736
737                 _info->triggered_update ();
738         }
739
740         void view_full_screen ()
741         {
742                 if (_mode == Config::PLAYER_MODE_FULL) {
743                         _mode = Config::PLAYER_MODE_WINDOW;
744                 } else {
745                         _mode = Config::PLAYER_MODE_FULL;
746                 }
747                 setup_screen ();
748                 setup_menu ();
749         }
750
751         void view_dual_screen ()
752         {
753                 if (_mode == Config::PLAYER_MODE_DUAL) {
754                         _mode = Config::PLAYER_MODE_WINDOW;
755                 } else {
756                         _mode = Config::PLAYER_MODE_DUAL;
757                 }
758                 setup_screen ();
759                 setup_menu ();
760         }
761
762         void setup_menu ()
763         {
764                 if (_view_full_screen) {
765                         _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
766                 }
767                 if (_view_dual_screen) {
768                         _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
769                 }
770         }
771
772         void setup_screen ()
773         {
774                 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
775                 _info->Show (_mode != Config::PLAYER_MODE_FULL);
776                 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
777                 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
778                 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
779
780                 if (_mode == Config::PLAYER_MODE_DUAL) {
781                         _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
782                         _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
783                         _dual_screen->ShowFullScreen (true);
784                         _viewer->panel()->Reparent (_dual_screen);
785                         _dual_screen->Show ();
786                         if (wxDisplay::GetCount() > 1) {
787                                 switch (Config::instance()->image_display()) {
788                                 case 0:
789                                         _dual_screen->Move (0, 0);
790                                         Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
791                                         break;
792                                 case 1:
793                                         _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
794                                         // (0, 0) doesn't seem to work for some strange reason
795                                         Move (8, 8);
796                                         break;
797                                 }
798                         }
799                 } else {
800                         if (_dual_screen) {
801                                 _viewer->panel()->Reparent (_overall_panel);
802                                 _dual_screen->Destroy ();
803                                 _dual_screen = 0;
804                         }
805                 }
806
807                 setup_main_sizer (_mode);
808         }
809
810         void view_closed_captions ()
811         {
812                 _viewer->show_closed_captions ();
813         }
814
815         void tools_verify ()
816         {
817                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
818                 DCPOMATIC_ASSERT (dcp);
819
820                 auto job = make_shared<VerifyDCPJob>(dcp->directories());
821                 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
822                 bool const completed = progress->run (job);
823                 progress->Destroy ();
824                 if (!completed) {
825                         return;
826                 }
827
828                 auto d = new VerifyDCPDialog (this, job);
829                 d->ShowModal ();
830                 d->Destroy ();
831         }
832
833         void tools_check_for_updates ()
834         {
835                 UpdateChecker::instance()->run ();
836                 _update_news_requested = true;
837         }
838
839         void tools_timing ()
840         {
841                 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
842                 d->ShowModal ();
843                 d->Destroy ();
844         }
845
846         void tools_system_information ()
847         {
848                 if (!_system_information_dialog) {
849                         _system_information_dialog = new SystemInformationDialog (this, _viewer);
850                 }
851
852                 _system_information_dialog->Show ();
853         }
854
855         void help_about ()
856         {
857                 auto d = new AboutDialog (this);
858                 d->ShowModal ();
859                 d->Destroy ();
860         }
861
862         void help_report_a_problem ()
863         {
864                 auto d = new ReportProblemDialog (this);
865                 if (d->ShowModal () == wxID_OK) {
866                         d->report ();
867                 }
868                 d->Destroy ();
869         }
870
871         void update_checker_state_changed ()
872         {
873                 auto uc = UpdateChecker::instance ();
874
875                 bool const announce =
876                         _update_news_requested ||
877                         (uc->stable() && Config::instance()->check_for_updates()) ||
878                         (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
879
880                 _update_news_requested = false;
881
882                 if (!announce) {
883                         return;
884                 }
885
886                 if (uc->state() == UpdateChecker::State::YES) {
887                         auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
888                         dialog->ShowModal ();
889                         dialog->Destroy ();
890                 } else if (uc->state() == UpdateChecker::State::FAILED) {
891                         error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
892                 } else {
893                         error_dialog (this, _("There are no new versions of DCP-o-matic available."));
894                 }
895
896                 _update_news_requested = false;
897         }
898
899         void config_changed (Config::Property prop)
900         {
901                 /* Instantly save any config changes when using the player GUI */
902                 try {
903                         Config::instance()->write_config();
904                 } catch (FileError& e) {
905                         if (prop != Config::HISTORY) {
906                                 error_dialog (
907                                         this,
908                                         wxString::Format(
909                                                 _("Could not write to config file at %s.  Your changes have not been saved."),
910                                                 std_to_wx(e.file().string())
911                                                 )
912                                         );
913                         }
914                 } catch (exception& e) {
915                         error_dialog (
916                                 this,
917                                 _("Could not write to config file.  Your changes have not been saved.")
918                                 );
919                 }
920
921                 update_from_config (prop);
922         }
923
924         void update_from_config (Config::Property prop)
925         {
926                 for (int i = 0; i < _history_items; ++i) {
927                         delete _file_menu->Remove (ID_file_history + i);
928                 }
929
930                 if (_history_separator) {
931                         _file_menu->Remove (_history_separator);
932                 }
933                 delete _history_separator;
934                 _history_separator = nullptr;
935
936                 int pos = _history_position;
937
938                 /* Clear out non-existant history items before we re-build the menu */
939                 Config::instance()->clean_player_history ();
940                 auto history = Config::instance()->player_history ();
941
942                 if (!history.empty ()) {
943                         _history_separator = _file_menu->InsertSeparator (pos++);
944                 }
945
946                 for (size_t i = 0; i < history.size(); ++i) {
947                         string s;
948                         if (i < 9) {
949                                 s = String::compose ("&%1 %2", i + 1, history[i].string());
950                         } else {
951                                 s = history[i].string();
952                         }
953                         _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
954                 }
955
956                 _history_items = history.size ();
957
958                 if (prop == Config::PLAYER_DEBUG_LOG) {
959                         auto p = Config::instance()->player_debug_log_file();
960                         if (p) {
961                                 dcpomatic_log = make_shared<FileLog>(*p);
962                         } else {
963                                 dcpomatic_log = make_shared<NullLog>();
964                         }
965                         dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
966                 }
967         }
968
969         void set_menu_sensitivity ()
970         {
971                 _tools_verify->Enable (static_cast<bool>(_film));
972                 _file_add_ov->Enable (static_cast<bool>(_film));
973                 _file_add_kdm->Enable (static_cast<bool>(_film));
974                 _view_cpl->Enable (static_cast<bool>(_film));
975         }
976
977         void start_stop_pressed ()
978         {
979                 if (_viewer->playing()) {
980                         _viewer->stop();
981                 } else {
982                         _viewer->start();
983                 }
984         }
985
986         void go_back_frame ()
987         {
988                 _viewer->seek_by (-_viewer->one_video_frame(), true);
989         }
990
991         void go_forward_frame ()
992         {
993                 _viewer->seek_by (_viewer->one_video_frame(), true);
994         }
995
996         void go_seconds (int s)
997         {
998                 _viewer->seek_by (DCPTime::from_seconds(s), true);
999         }
1000
1001         void go_to_start ()
1002         {
1003                 _viewer->seek (DCPTime(), true);
1004         }
1005
1006         void go_to_end ()
1007         {
1008                 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
1009         }
1010
1011         wxFrame* _dual_screen;
1012         bool _update_news_requested;
1013         PlayerInformation* _info;
1014         Config::PlayerMode _mode;
1015         wxPreferencesEditor* _config_dialog;
1016         wxPanel* _overall_panel;
1017         wxMenu* _file_menu;
1018         wxMenuItem* _view_cpl;
1019         wxMenu* _cpl_menu;
1020         int _history_items;
1021         int _history_position;
1022         wxMenuItem* _history_separator;
1023         shared_ptr<FilmViewer> _viewer;
1024         Controls* _controls;
1025         SystemInformationDialog* _system_information_dialog;
1026         std::shared_ptr<Film> _film;
1027         boost::signals2::scoped_connection _config_changed_connection;
1028         boost::signals2::scoped_connection _examine_job_connection;
1029         wxMenuItem* _file_add_ov;
1030         wxMenuItem* _file_add_kdm;
1031         wxMenuItem* _tools_verify;
1032         wxMenuItem* _view_full_screen;
1033         wxMenuItem* _view_dual_screen;
1034         wxSizer* _main_sizer;
1035         PlayerStressTester _stress;
1036 };
1037
1038 static const wxCmdLineEntryDesc command_line_description[] = {
1039         { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1040         { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1041         { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1042         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1043 };
1044
1045 class PlayServer : public Server
1046 {
1047 public:
1048         explicit PlayServer (DOMFrame* frame)
1049                 : Server (PLAYER_PLAY_PORT)
1050                 , _frame (frame)
1051         {}
1052
1053         void handle (shared_ptr<Socket> socket)
1054         {
1055                 try {
1056                         int const length = socket->read_uint32 ();
1057                         scoped_array<char> buffer (new char[length]);
1058                         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1059                         string s (buffer.get());
1060                         signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1061                         socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1062                 } catch (...) {
1063
1064                 }
1065         }
1066
1067 private:
1068         DOMFrame* _frame;
1069 };
1070
1071 /** @class App
1072  *  @brief The magic App class for wxWidgets.
1073  */
1074 class App : public wxApp
1075 {
1076 public:
1077         App ()
1078                 : wxApp ()
1079                 , _frame (0)
1080         {
1081 #ifdef DCPOMATIC_LINUX
1082                 XInitThreads ();
1083 #endif
1084         }
1085
1086 private:
1087
1088         bool OnInit ()
1089         {
1090                 wxSplashScreen* splash = 0;
1091                 try {
1092                         wxInitAllImageHandlers ();
1093
1094                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1095                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1096
1097                         splash = maybe_show_splash ();
1098
1099                         SetAppName (_("DCP-o-matic Player"));
1100
1101                         if (!wxApp::OnInit()) {
1102                                 return false;
1103                         }
1104
1105 #ifdef DCPOMATIC_LINUX
1106                         unsetenv ("UBUNTU_MENUPROXY");
1107 #endif
1108
1109 #ifdef DCPOMATIC_OSX
1110                         make_foreground_application ();
1111 #endif
1112
1113                         dcpomatic_setup_path_encoding ();
1114
1115                         /* Enable i18n; this will create a Config object
1116                            to look for a force-configured language.  This Config
1117                            object will be wrong, however, because dcpomatic_setup
1118                            hasn't yet been called and there aren't any filters etc.
1119                            set up yet.
1120                         */
1121                         dcpomatic_setup_i18n ();
1122
1123                         /* Set things up, including filters etc.
1124                            which will now be internationalised correctly.
1125                         */
1126                         dcpomatic_setup ();
1127
1128                         /* Force the configuration to be re-loaded correctly next
1129                            time it is needed.
1130                         */
1131                         Config::drop ();
1132
1133                         signal_manager = new wxSignalManager (this);
1134
1135                         _frame = new DOMFrame ();
1136                         SetTopWindow (_frame);
1137                         _frame->Maximize ();
1138                         if (splash) {
1139                                 splash->Destroy ();
1140                                 splash = 0;
1141                         }
1142                         _frame->Show ();
1143
1144                         PlayServer* server = new PlayServer (_frame);
1145                         new thread (boost::bind (&PlayServer::run, server));
1146
1147                         if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1148                                 try {
1149                                         _frame->load_dcp (_dcp_to_load);
1150                                 } catch (exception& e) {
1151                                         error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1152                                 }
1153                         }
1154
1155                         if (_stress) {
1156                                 try {
1157                                         _frame->load_stress_script (*_stress);
1158                                 } catch (exception& e) {
1159                                         error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1160                                 }
1161                         }
1162
1163                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1164
1165                         if (Config::instance()->check_for_updates ()) {
1166                                 UpdateChecker::instance()->run ();
1167                         }
1168                 }
1169                 catch (exception& e)
1170                 {
1171                         if (splash) {
1172                                 splash->Destroy ();
1173                         }
1174                         error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1175                 }
1176
1177                 return true;
1178         }
1179
1180         void OnInitCmdLine (wxCmdLineParser& parser)
1181         {
1182                 parser.SetDesc (command_line_description);
1183                 parser.SetSwitchChars (wxT ("-"));
1184         }
1185
1186         bool OnCmdLineParsed (wxCmdLineParser& parser)
1187         {
1188                 if (parser.GetParamCount() > 0) {
1189                         _dcp_to_load = wx_to_std (parser.GetParam (0));
1190                 }
1191
1192                 wxString config;
1193                 if (parser.Found("c", &config)) {
1194                         Config::override_path = wx_to_std (config);
1195                 }
1196                 wxString stress;
1197                 if (parser.Found("s", &stress)) {
1198                         _stress = wx_to_std (stress);
1199                 }
1200
1201                 return true;
1202         }
1203
1204         void report_exception ()
1205         {
1206                 try {
1207                         throw;
1208                 } catch (FileError& e) {
1209                         error_dialog (
1210                                 0,
1211                                 wxString::Format (
1212                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1213                                         std_to_wx (e.what()),
1214                                         std_to_wx (e.file().string().c_str ())
1215                                         )
1216                                 );
1217                 } catch (exception& e) {
1218                         error_dialog (
1219                                 0,
1220                                 wxString::Format (
1221                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1222                                         std_to_wx (e.what ())
1223                                         )
1224                                 );
1225                 } catch (...) {
1226                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
1227                 }
1228         }
1229
1230         /* An unhandled exception has occurred inside the main event loop */
1231         bool OnExceptionInMainLoop ()
1232         {
1233                 report_exception ();
1234                 /* This will terminate the program */
1235                 return false;
1236         }
1237
1238         void OnUnhandledException ()
1239         {
1240                 report_exception ();
1241         }
1242
1243         void idle ()
1244         {
1245                 signal_manager->ui_idle ();
1246         }
1247
1248         void config_failed_to_load ()
1249         {
1250                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
1251         }
1252
1253         void config_warning (string m)
1254         {
1255                 message_dialog (_frame, std_to_wx (m));
1256         }
1257
1258         DOMFrame* _frame;
1259         string _dcp_to_load;
1260         boost::optional<string> _stress;
1261 };
1262
1263 IMPLEMENT_APP (App)