Assorted C++11 tidying.
[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                         auto dcp = make_shared<DCPContent>(dir);
356                         auto job = make_shared<ExamineContentJob>(_film, dcp);
357                         _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
358                         JobManager::instance()->add (job);
359                         bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
360                         if (!ok || !report_errors_from_last_job(this)) {
361                                 return;
362                         }
363                         Config::instance()->add_to_player_history (dir);
364                 } catch (dcp::ReadError& e) {
365                         error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
366                 } catch (DCPError& e) {
367                         error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
368                 }
369         }
370
371         void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
372         {
373                 auto job = weak_job.lock ();
374                 if (!job || !job->finished_ok()) {
375                         return;
376                 }
377
378                 auto content = weak_content.lock ();
379                 if (!content) {
380                         return;
381                 }
382
383                 _film->add_content (content);
384                 _stress.set_suspended (false);
385         }
386
387         void reset_film_weak (weak_ptr<Film> weak_film)
388         {
389                 auto film = weak_film.lock ();
390                 if (film) {
391                         reset_film (film);
392                 }
393         }
394
395         void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
396         {
397                 _film = film;
398                 _film->set_tolerant (true);
399                 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
400                 _viewer->set_film (_film);
401                 _controls->set_film (_film);
402                 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
403                 _info->triggered_update ();
404         }
405
406         void film_changed (ChangeType type, Film::Property property)
407         {
408                 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
409                         return;
410                 }
411
412                 if (_viewer->playing ()) {
413                         _viewer->stop ();
414                 }
415
416                 /* Start off as Flat */
417                 _film->set_container (Ratio::from_id("185"));
418
419                 for (auto i: _film->content()) {
420                         auto dcp = dynamic_pointer_cast<DCPContent>(i);
421
422                         for (auto j: i->text) {
423                                 j->set_use (true);
424                         }
425
426                         if (i->video) {
427                                 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
428                                 if (r->id() == "239") {
429                                         /* Any scope content means we use scope */
430                                         _film->set_container(r);
431                                 }
432                         }
433
434                         /* Any 3D content means we use 3D mode */
435                         if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
436                                 _film->set_three_d (true);
437                         }
438                 }
439
440                 _viewer->seek (DCPTime(), true);
441                 _info->triggered_update ();
442
443                 set_menu_sensitivity ();
444
445                 auto old = _cpl_menu->GetMenuItems();
446                 for (auto const& i: old) {
447                         _cpl_menu->Remove (i);
448                 }
449
450                 if (_film->content().size() == 1) {
451                         /* Offer a CPL menu */
452                         auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
453                         if (first) {
454                                 DCPExaminer ex (first, true);
455                                 int id = ID_view_cpl;
456                                 for (auto i: ex.cpls()) {
457                                         auto j = _cpl_menu->AppendRadioItem(
458                                                 id,
459                                                 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
460                                                 );
461                                         j->Check(!first->cpl() || i->id() == *first->cpl());
462                                         ++id;
463                                 }
464                         }
465                 }
466         }
467
468         void load_stress_script (boost::filesystem::path path)
469         {
470                 _stress.load_script (path);
471         }
472
473 private:
474
475         void examine_content ()
476         {
477                 DCPOMATIC_ASSERT (_film);
478                 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
479                 DCPOMATIC_ASSERT (dcp);
480                 dcp->examine (_film, shared_ptr<Job>());
481
482                 /* Examining content re-creates the TextContent objects, so we must re-enable them */
483                 for (auto i: dcp->text) {
484                         i->set_use (true);
485                 }
486         }
487
488         bool report_errors_from_last_job (wxWindow* parent) const
489         {
490                 auto jm = JobManager::instance ();
491
492                 DCPOMATIC_ASSERT (!jm->get().empty());
493
494                 auto last = jm->get().back();
495                 if (last->finished_in_error()) {
496                         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()));
497                         return false;
498                 }
499
500                 return true;
501         }
502
503         void setup_menu (wxMenuBar* m)
504         {
505                 _file_menu = new wxMenu;
506                 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
507                 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
508                 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
509
510                 _history_position = _file_menu->GetMenuItems().GetCount();
511
512                 _file_menu->AppendSeparator ();
513                 _file_menu->Append (ID_file_close, _("&Close"));
514                 _file_menu->AppendSeparator ();
515
516 #ifdef __WXOSX__
517                 _file_menu->Append (wxID_EXIT, _("&Exit"));
518 #else
519                 _file_menu->Append (wxID_EXIT, _("&Quit"));
520 #endif
521
522 #ifdef __WXOSX__
523                 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
524 #else
525                 auto edit = new wxMenu;
526                 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
527 #endif
528
529                 prefs->Enable (Config::instance()->have_write_permission());
530
531                 _cpl_menu = new wxMenu;
532
533                 auto view = new wxMenu;
534                 auto c = Config::instance()->decode_reduction();
535                 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
536                 view->AppendSeparator();
537                 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
538                 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
539                 setup_menu ();
540                 view->AppendSeparator();
541                 view->Append(ID_view_closed_captions, _("Closed captions..."));
542                 view->AppendSeparator();
543                 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
544                 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
545                 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
546                 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
547
548                 auto tools = new wxMenu;
549                 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
550                 tools->AppendSeparator ();
551                 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
552                 tools->Append (ID_tools_timing, _("Timing..."));
553                 tools->Append (ID_tools_system_information, _("System information..."));
554
555                 auto help = new wxMenu;
556 #ifdef __WXOSX__
557                 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
558 #else
559                 help->Append (wxID_ABOUT, _("About"));
560 #endif
561                 help->Append (ID_help_report_a_problem, _("Report a problem..."));
562
563                 m->Append (_file_menu, _("&File"));
564 #ifndef __WXOSX__
565                 m->Append (edit, _("&Edit"));
566 #endif
567                 m->Append (view, _("&View"));
568                 m->Append (tools, _("&Tools"));
569                 m->Append (help, _("&Help"));
570         }
571
572         void file_open ()
573         {
574                 auto d = wxStandardPaths::Get().GetDocumentsDir();
575                 if (Config::instance()->last_player_load_directory()) {
576                         d = std_to_wx (Config::instance()->last_player_load_directory()->string());
577                 }
578
579                 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
580
581                 int r;
582                 while (true) {
583                         r = c->ShowModal ();
584                         if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
585                                 error_dialog (this, _("You did not select a folder.  Make sure that you select a folder before clicking Open."));
586                         } else {
587                                 break;
588                         }
589                 }
590
591                 if (r == wxID_OK) {
592                         boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
593                         load_dcp (dcp);
594                         Config::instance()->set_last_player_load_directory (dcp.parent_path());
595                 }
596
597                 c->Destroy ();
598         }
599
600         void file_add_ov ()
601         {
602                 auto c = new wxDirDialog (
603                         this,
604                         _("Select DCP to open as OV"),
605                         wxStandardPaths::Get().GetDocumentsDir(),
606                         wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
607                         );
608
609                 int r;
610                 while (true) {
611                         r = c->ShowModal ();
612                         if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
613                                 error_dialog (this, _("You did not select a folder.  Make sure that you select a folder before clicking Open."));
614                         } else {
615                                 break;
616                         }
617                 }
618
619                 if (r == wxID_OK) {
620                         DCPOMATIC_ASSERT (_film);
621                         auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
622                         DCPOMATIC_ASSERT (dcp);
623                         dcp->add_ov (wx_to_std(c->GetPath()));
624                         JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
625                         bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
626                         if (!ok || !report_errors_from_last_job(this)) {
627                                 return;
628                         }
629                         for (auto i: dcp->text) {
630                                 i->set_use (true);
631                         }
632                         if (dcp->video) {
633                                 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
634                                 if (r) {
635                                         _film->set_container(r);
636                                 }
637                         }
638                 }
639
640                 c->Destroy ();
641                 _info->triggered_update ();
642         }
643
644         void file_add_kdm ()
645         {
646                 auto d = new wxFileDialog (this, _("Select KDM"));
647
648                 if (d->ShowModal() == wxID_OK) {
649                         DCPOMATIC_ASSERT (_film);
650                         auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
651                         DCPOMATIC_ASSERT (dcp);
652                         try {
653                                 if (dcp) {
654                                         _viewer->set_coalesce_player_changes (true);
655                                         dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
656                                         examine_content();
657                                         _viewer->set_coalesce_player_changes (false);
658                                 }
659                         } catch (exception& e) {
660                                 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
661                                 d->Destroy ();
662                                 return;
663                         }
664                 }
665
666                 d->Destroy ();
667                 _info->triggered_update ();
668         }
669
670         void file_history (wxCommandEvent& event)
671         {
672                 auto history = Config::instance()->player_history ();
673                 int n = event.GetId() - ID_file_history;
674                 if (n >= 0 && n < static_cast<int> (history.size ())) {
675                         try {
676                                 load_dcp (history[n]);
677                         } catch (exception& e) {
678                                 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
679                         }
680                 }
681         }
682
683         void file_close ()
684         {
685                 reset_film ();
686                 _info->triggered_update ();
687                 set_menu_sensitivity ();
688         }
689
690         void file_exit ()
691         {
692                 Close ();
693         }
694
695         void edit_preferences ()
696         {
697                 if (!Config::instance()->have_write_permission()) {
698                         return;
699                 }
700
701                 if (!_config_dialog) {
702                         _config_dialog = create_player_config_dialog ();
703                 }
704                 _config_dialog->Show (this);
705         }
706
707         void view_cpl (wxCommandEvent& ev)
708         {
709                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
710                 DCPOMATIC_ASSERT (dcp);
711                 DCPExaminer ex (dcp, true);
712                 int id = ev.GetId() - ID_view_cpl;
713                 DCPOMATIC_ASSERT (id >= 0);
714                 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
715                 auto cpls = ex.cpls();
716                 auto i = cpls.begin();
717                 while (id > 0) {
718                         ++i;
719                         --id;
720                 }
721
722                 _viewer->set_coalesce_player_changes (true);
723                 dcp->set_cpl ((*i)->id());
724                 examine_content ();
725                 _viewer->set_coalesce_player_changes (false);
726
727                 _info->triggered_update ();
728         }
729
730         void view_full_screen ()
731         {
732                 if (_mode == Config::PLAYER_MODE_FULL) {
733                         _mode = Config::PLAYER_MODE_WINDOW;
734                 } else {
735                         _mode = Config::PLAYER_MODE_FULL;
736                 }
737                 setup_screen ();
738                 setup_menu ();
739         }
740
741         void view_dual_screen ()
742         {
743                 if (_mode == Config::PLAYER_MODE_DUAL) {
744                         _mode = Config::PLAYER_MODE_WINDOW;
745                 } else {
746                         _mode = Config::PLAYER_MODE_DUAL;
747                 }
748                 setup_screen ();
749                 setup_menu ();
750         }
751
752         void setup_menu ()
753         {
754                 if (_view_full_screen) {
755                         _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
756                 }
757                 if (_view_dual_screen) {
758                         _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
759                 }
760         }
761
762         void setup_screen ()
763         {
764                 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
765                 _info->Show (_mode != Config::PLAYER_MODE_FULL);
766                 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
767                 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
768                 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
769
770                 if (_mode == Config::PLAYER_MODE_DUAL) {
771                         _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
772                         _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
773                         _dual_screen->ShowFullScreen (true);
774                         _viewer->panel()->Reparent (_dual_screen);
775                         _dual_screen->Show ();
776                         if (wxDisplay::GetCount() > 1) {
777                                 switch (Config::instance()->image_display()) {
778                                 case 0:
779                                         _dual_screen->Move (0, 0);
780                                         Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
781                                         break;
782                                 case 1:
783                                         _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
784                                         // (0, 0) doesn't seem to work for some strange reason
785                                         Move (8, 8);
786                                         break;
787                                 }
788                         }
789                 } else {
790                         if (_dual_screen) {
791                                 _viewer->panel()->Reparent (_overall_panel);
792                                 _dual_screen->Destroy ();
793                                 _dual_screen = 0;
794                         }
795                 }
796
797                 setup_main_sizer (_mode);
798         }
799
800         void view_closed_captions ()
801         {
802                 _viewer->show_closed_captions ();
803         }
804
805         void tools_verify ()
806         {
807                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
808                 DCPOMATIC_ASSERT (dcp);
809
810                 auto job = make_shared<VerifyDCPJob>(dcp->directories());
811                 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
812                 bool const completed = progress->run (job);
813                 progress->Destroy ();
814                 if (!completed) {
815                         return;
816                 }
817
818                 auto d = new VerifyDCPDialog (this, job);
819                 d->ShowModal ();
820                 d->Destroy ();
821         }
822
823         void tools_check_for_updates ()
824         {
825                 UpdateChecker::instance()->run ();
826                 _update_news_requested = true;
827         }
828
829         void tools_timing ()
830         {
831                 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
832                 d->ShowModal ();
833                 d->Destroy ();
834         }
835
836         void tools_system_information ()
837         {
838                 if (!_system_information_dialog) {
839                         _system_information_dialog = new SystemInformationDialog (this, _viewer);
840                 }
841
842                 _system_information_dialog->Show ();
843         }
844
845         void help_about ()
846         {
847                 auto d = new AboutDialog (this);
848                 d->ShowModal ();
849                 d->Destroy ();
850         }
851
852         void help_report_a_problem ()
853         {
854                 auto d = new ReportProblemDialog (this);
855                 if (d->ShowModal () == wxID_OK) {
856                         d->report ();
857                 }
858                 d->Destroy ();
859         }
860
861         void update_checker_state_changed ()
862         {
863                 auto uc = UpdateChecker::instance ();
864
865                 bool const announce =
866                         _update_news_requested ||
867                         (uc->stable() && Config::instance()->check_for_updates()) ||
868                         (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
869
870                 _update_news_requested = false;
871
872                 if (!announce) {
873                         return;
874                 }
875
876                 if (uc->state() == UpdateChecker::State::YES) {
877                         auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
878                         dialog->ShowModal ();
879                         dialog->Destroy ();
880                 } else if (uc->state() == UpdateChecker::State::FAILED) {
881                         error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
882                 } else {
883                         error_dialog (this, _("There are no new versions of DCP-o-matic available."));
884                 }
885
886                 _update_news_requested = false;
887         }
888
889         void config_changed (Config::Property prop)
890         {
891                 /* Instantly save any config changes when using the player GUI */
892                 try {
893                         Config::instance()->write_config();
894                 } catch (FileError& e) {
895                         if (prop != Config::HISTORY) {
896                                 error_dialog (
897                                         this,
898                                         wxString::Format(
899                                                 _("Could not write to config file at %s.  Your changes have not been saved."),
900                                                 std_to_wx(e.file().string())
901                                                 )
902                                         );
903                         }
904                 } catch (exception& e) {
905                         error_dialog (
906                                 this,
907                                 _("Could not write to config file.  Your changes have not been saved.")
908                                 );
909                 }
910
911                 update_from_config (prop);
912         }
913
914         void update_from_config (Config::Property prop)
915         {
916                 for (int i = 0; i < _history_items; ++i) {
917                         delete _file_menu->Remove (ID_file_history + i);
918                 }
919
920                 if (_history_separator) {
921                         _file_menu->Remove (_history_separator);
922                 }
923                 delete _history_separator;
924                 _history_separator = nullptr;
925
926                 int pos = _history_position;
927
928                 /* Clear out non-existant history items before we re-build the menu */
929                 Config::instance()->clean_player_history ();
930                 auto history = Config::instance()->player_history ();
931
932                 if (!history.empty ()) {
933                         _history_separator = _file_menu->InsertSeparator (pos++);
934                 }
935
936                 for (size_t i = 0; i < history.size(); ++i) {
937                         string s;
938                         if (i < 9) {
939                                 s = String::compose ("&%1 %2", i + 1, history[i].string());
940                         } else {
941                                 s = history[i].string();
942                         }
943                         _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
944                 }
945
946                 _history_items = history.size ();
947
948                 if (prop == Config::PLAYER_DEBUG_LOG) {
949                         auto p = Config::instance()->player_debug_log_file();
950                         if (p) {
951                                 dcpomatic_log = make_shared<FileLog>(*p);
952                         } else {
953                                 dcpomatic_log = make_shared<NullLog>();
954                         }
955                         dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
956                 }
957         }
958
959         void set_menu_sensitivity ()
960         {
961                 _tools_verify->Enable (static_cast<bool>(_film));
962                 _file_add_ov->Enable (static_cast<bool>(_film));
963                 _file_add_kdm->Enable (static_cast<bool>(_film));
964                 _view_cpl->Enable (static_cast<bool>(_film));
965         }
966
967         void start_stop_pressed ()
968         {
969                 if (_viewer->playing()) {
970                         _viewer->stop();
971                 } else {
972                         _viewer->start();
973                 }
974         }
975
976         void go_back_frame ()
977         {
978                 _viewer->seek_by (-_viewer->one_video_frame(), true);
979         }
980
981         void go_forward_frame ()
982         {
983                 _viewer->seek_by (_viewer->one_video_frame(), true);
984         }
985
986         void go_seconds (int s)
987         {
988                 _viewer->seek_by (DCPTime::from_seconds(s), true);
989         }
990
991         void go_to_start ()
992         {
993                 _viewer->seek (DCPTime(), true);
994         }
995
996         void go_to_end ()
997         {
998                 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
999         }
1000
1001         wxFrame* _dual_screen;
1002         bool _update_news_requested;
1003         PlayerInformation* _info;
1004         Config::PlayerMode _mode;
1005         wxPreferencesEditor* _config_dialog;
1006         wxPanel* _overall_panel;
1007         wxMenu* _file_menu;
1008         wxMenuItem* _view_cpl;
1009         wxMenu* _cpl_menu;
1010         int _history_items;
1011         int _history_position;
1012         wxMenuItem* _history_separator;
1013         shared_ptr<FilmViewer> _viewer;
1014         Controls* _controls;
1015         SystemInformationDialog* _system_information_dialog;
1016         std::shared_ptr<Film> _film;
1017         boost::signals2::scoped_connection _config_changed_connection;
1018         boost::signals2::scoped_connection _examine_job_connection;
1019         wxMenuItem* _file_add_ov;
1020         wxMenuItem* _file_add_kdm;
1021         wxMenuItem* _tools_verify;
1022         wxMenuItem* _view_full_screen;
1023         wxMenuItem* _view_dual_screen;
1024         wxSizer* _main_sizer;
1025         PlayerStressTester _stress;
1026 };
1027
1028 static const wxCmdLineEntryDesc command_line_description[] = {
1029         { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1030         { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1031         { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1032         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1033 };
1034
1035 class PlayServer : public Server
1036 {
1037 public:
1038         explicit PlayServer (DOMFrame* frame)
1039                 : Server (PLAYER_PLAY_PORT)
1040                 , _frame (frame)
1041         {}
1042
1043         void handle (shared_ptr<Socket> socket)
1044         {
1045                 try {
1046                         int const length = socket->read_uint32 ();
1047                         scoped_array<char> buffer (new char[length]);
1048                         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1049                         string s (buffer.get());
1050                         signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1051                         socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1052                 } catch (...) {
1053
1054                 }
1055         }
1056
1057 private:
1058         DOMFrame* _frame;
1059 };
1060
1061 /** @class App
1062  *  @brief The magic App class for wxWidgets.
1063  */
1064 class App : public wxApp
1065 {
1066 public:
1067         App ()
1068                 : wxApp ()
1069                 , _frame (0)
1070         {
1071 #ifdef DCPOMATIC_LINUX
1072                 XInitThreads ();
1073 #endif
1074         }
1075
1076 private:
1077
1078         bool OnInit ()
1079         {
1080                 wxSplashScreen* splash = 0;
1081                 try {
1082                         wxInitAllImageHandlers ();
1083
1084                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1085                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1086
1087                         splash = maybe_show_splash ();
1088
1089                         SetAppName (_("DCP-o-matic Player"));
1090
1091                         if (!wxApp::OnInit()) {
1092                                 return false;
1093                         }
1094
1095 #ifdef DCPOMATIC_LINUX
1096                         unsetenv ("UBUNTU_MENUPROXY");
1097 #endif
1098
1099 #ifdef DCPOMATIC_OSX
1100                         make_foreground_application ();
1101 #endif
1102
1103                         dcpomatic_setup_path_encoding ();
1104
1105                         /* Enable i18n; this will create a Config object
1106                            to look for a force-configured language.  This Config
1107                            object will be wrong, however, because dcpomatic_setup
1108                            hasn't yet been called and there aren't any filters etc.
1109                            set up yet.
1110                         */
1111                         dcpomatic_setup_i18n ();
1112
1113                         /* Set things up, including filters etc.
1114                            which will now be internationalised correctly.
1115                         */
1116                         dcpomatic_setup ();
1117
1118                         /* Force the configuration to be re-loaded correctly next
1119                            time it is needed.
1120                         */
1121                         Config::drop ();
1122
1123                         signal_manager = new wxSignalManager (this);
1124
1125                         _frame = new DOMFrame ();
1126                         SetTopWindow (_frame);
1127                         _frame->Maximize ();
1128                         if (splash) {
1129                                 splash->Destroy ();
1130                                 splash = 0;
1131                         }
1132                         _frame->Show ();
1133
1134                         PlayServer* server = new PlayServer (_frame);
1135                         new thread (boost::bind (&PlayServer::run, server));
1136
1137                         if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1138                                 try {
1139                                         _frame->load_dcp (_dcp_to_load);
1140                                 } catch (exception& e) {
1141                                         error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1142                                 }
1143                         }
1144
1145                         if (_stress) {
1146                                 try {
1147                                         _frame->load_stress_script (*_stress);
1148                                 } catch (exception& e) {
1149                                         error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1150                                 }
1151                         }
1152
1153                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1154
1155                         if (Config::instance()->check_for_updates ()) {
1156                                 UpdateChecker::instance()->run ();
1157                         }
1158                 }
1159                 catch (exception& e)
1160                 {
1161                         if (splash) {
1162                                 splash->Destroy ();
1163                         }
1164                         error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1165                 }
1166
1167                 return true;
1168         }
1169
1170         void OnInitCmdLine (wxCmdLineParser& parser)
1171         {
1172                 parser.SetDesc (command_line_description);
1173                 parser.SetSwitchChars (wxT ("-"));
1174         }
1175
1176         bool OnCmdLineParsed (wxCmdLineParser& parser)
1177         {
1178                 if (parser.GetParamCount() > 0) {
1179                         _dcp_to_load = wx_to_std (parser.GetParam (0));
1180                 }
1181
1182                 wxString config;
1183                 if (parser.Found("c", &config)) {
1184                         Config::override_path = wx_to_std (config);
1185                 }
1186                 wxString stress;
1187                 if (parser.Found("s", &stress)) {
1188                         _stress = wx_to_std (stress);
1189                 }
1190
1191                 return true;
1192         }
1193
1194         void report_exception ()
1195         {
1196                 try {
1197                         throw;
1198                 } catch (FileError& e) {
1199                         error_dialog (
1200                                 0,
1201                                 wxString::Format (
1202                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1203                                         std_to_wx (e.what()),
1204                                         std_to_wx (e.file().string().c_str ())
1205                                         )
1206                                 );
1207                 } catch (exception& e) {
1208                         error_dialog (
1209                                 0,
1210                                 wxString::Format (
1211                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1212                                         std_to_wx (e.what ())
1213                                         )
1214                                 );
1215                 } catch (...) {
1216                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
1217                 }
1218         }
1219
1220         /* An unhandled exception has occurred inside the main event loop */
1221         bool OnExceptionInMainLoop ()
1222         {
1223                 report_exception ();
1224                 /* This will terminate the program */
1225                 return false;
1226         }
1227
1228         void OnUnhandledException ()
1229         {
1230                 report_exception ();
1231         }
1232
1233         void idle ()
1234         {
1235                 signal_manager->ui_idle ();
1236         }
1237
1238         void config_failed_to_load ()
1239         {
1240                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
1241         }
1242
1243         void config_warning (string m)
1244         {
1245                 message_dialog (_frame, std_to_wx (m));
1246         }
1247
1248         DOMFrame* _frame;
1249         string _dcp_to_load;
1250         boost::optional<string> _stress;
1251 };
1252
1253 IMPLEMENT_APP (App)