Fix no subtitles/captions in the player after changing the CPL.
[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                                         dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
655                                         examine_content();
656                                 }
657                         } catch (exception& e) {
658                                 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
659                                 d->Destroy ();
660                                 return;
661                         }
662                 }
663
664                 d->Destroy ();
665                 _info->triggered_update ();
666         }
667
668         void file_history (wxCommandEvent& event)
669         {
670                 auto history = Config::instance()->player_history ();
671                 int n = event.GetId() - ID_file_history;
672                 if (n >= 0 && n < static_cast<int> (history.size ())) {
673                         try {
674                                 load_dcp (history[n]);
675                         } catch (exception& e) {
676                                 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
677                         }
678                 }
679         }
680
681         void file_close ()
682         {
683                 reset_film ();
684                 _info->triggered_update ();
685                 set_menu_sensitivity ();
686         }
687
688         void file_exit ()
689         {
690                 Close ();
691         }
692
693         void edit_preferences ()
694         {
695                 if (!Config::instance()->have_write_permission()) {
696                         return;
697                 }
698
699                 if (!_config_dialog) {
700                         _config_dialog = create_player_config_dialog ();
701                 }
702                 _config_dialog->Show (this);
703         }
704
705         void view_cpl (wxCommandEvent& ev)
706         {
707                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
708                 DCPOMATIC_ASSERT (dcp);
709                 DCPExaminer ex (dcp, true);
710                 int id = ev.GetId() - ID_view_cpl;
711                 DCPOMATIC_ASSERT (id >= 0);
712                 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
713                 auto cpls = ex.cpls();
714                 auto i = cpls.begin();
715                 while (id > 0) {
716                         ++i;
717                         --id;
718                 }
719
720                 dcp->set_cpl ((*i)->id());
721                 examine_content ();
722                 _info->triggered_update ();
723         }
724
725         void view_full_screen ()
726         {
727                 if (_mode == Config::PLAYER_MODE_FULL) {
728                         _mode = Config::PLAYER_MODE_WINDOW;
729                 } else {
730                         _mode = Config::PLAYER_MODE_FULL;
731                 }
732                 setup_screen ();
733                 setup_menu ();
734         }
735
736         void view_dual_screen ()
737         {
738                 if (_mode == Config::PLAYER_MODE_DUAL) {
739                         _mode = Config::PLAYER_MODE_WINDOW;
740                 } else {
741                         _mode = Config::PLAYER_MODE_DUAL;
742                 }
743                 setup_screen ();
744                 setup_menu ();
745         }
746
747         void setup_menu ()
748         {
749                 if (_view_full_screen) {
750                         _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
751                 }
752                 if (_view_dual_screen) {
753                         _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
754                 }
755         }
756
757         void setup_screen ()
758         {
759                 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
760                 _info->Show (_mode != Config::PLAYER_MODE_FULL);
761                 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
762                 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
763                 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
764
765                 if (_mode == Config::PLAYER_MODE_DUAL) {
766                         _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
767                         _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
768                         _dual_screen->ShowFullScreen (true);
769                         _viewer->panel()->Reparent (_dual_screen);
770                         _dual_screen->Show ();
771                         if (wxDisplay::GetCount() > 1) {
772                                 switch (Config::instance()->image_display()) {
773                                 case 0:
774                                         _dual_screen->Move (0, 0);
775                                         Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
776                                         break;
777                                 case 1:
778                                         _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
779                                         // (0, 0) doesn't seem to work for some strange reason
780                                         Move (8, 8);
781                                         break;
782                                 }
783                         }
784                 } else {
785                         if (_dual_screen) {
786                                 _viewer->panel()->Reparent (_overall_panel);
787                                 _dual_screen->Destroy ();
788                                 _dual_screen = 0;
789                         }
790                 }
791
792                 setup_main_sizer (_mode);
793         }
794
795         void view_closed_captions ()
796         {
797                 _viewer->show_closed_captions ();
798         }
799
800         void tools_verify ()
801         {
802                 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
803                 DCPOMATIC_ASSERT (dcp);
804
805                 auto job = make_shared<VerifyDCPJob>(dcp->directories());
806                 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
807                 bool const completed = progress->run (job);
808                 progress->Destroy ();
809                 if (!completed) {
810                         return;
811                 }
812
813                 auto d = new VerifyDCPDialog (this, job);
814                 d->ShowModal ();
815                 d->Destroy ();
816         }
817
818         void tools_check_for_updates ()
819         {
820                 UpdateChecker::instance()->run ();
821                 _update_news_requested = true;
822         }
823
824         void tools_timing ()
825         {
826                 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
827                 d->ShowModal ();
828                 d->Destroy ();
829         }
830
831         void tools_system_information ()
832         {
833                 if (!_system_information_dialog) {
834                         _system_information_dialog = new SystemInformationDialog (this, _viewer);
835                 }
836
837                 _system_information_dialog->Show ();
838         }
839
840         void help_about ()
841         {
842                 auto d = new AboutDialog (this);
843                 d->ShowModal ();
844                 d->Destroy ();
845         }
846
847         void help_report_a_problem ()
848         {
849                 auto d = new ReportProblemDialog (this);
850                 if (d->ShowModal () == wxID_OK) {
851                         d->report ();
852                 }
853                 d->Destroy ();
854         }
855
856         void update_checker_state_changed ()
857         {
858                 auto uc = UpdateChecker::instance ();
859
860                 bool const announce =
861                         _update_news_requested ||
862                         (uc->stable() && Config::instance()->check_for_updates()) ||
863                         (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
864
865                 _update_news_requested = false;
866
867                 if (!announce) {
868                         return;
869                 }
870
871                 if (uc->state() == UpdateChecker::YES) {
872                         auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
873                         dialog->ShowModal ();
874                         dialog->Destroy ();
875                 } else if (uc->state() == UpdateChecker::FAILED) {
876                         error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
877                 } else {
878                         error_dialog (this, _("There are no new versions of DCP-o-matic available."));
879                 }
880
881                 _update_news_requested = false;
882         }
883
884         void config_changed (Config::Property prop)
885         {
886                 /* Instantly save any config changes when using the player GUI */
887                 try {
888                         Config::instance()->write_config();
889                 } catch (FileError& e) {
890                         if (prop != Config::HISTORY) {
891                                 error_dialog (
892                                         this,
893                                         wxString::Format(
894                                                 _("Could not write to config file at %s.  Your changes have not been saved."),
895                                                 std_to_wx(e.file().string())
896                                                 )
897                                         );
898                         }
899                 } catch (exception& e) {
900                         error_dialog (
901                                 this,
902                                 _("Could not write to config file.  Your changes have not been saved.")
903                                 );
904                 }
905
906                 update_from_config (prop);
907         }
908
909         void update_from_config (Config::Property prop)
910         {
911                 for (int i = 0; i < _history_items; ++i) {
912                         delete _file_menu->Remove (ID_file_history + i);
913                 }
914
915                 if (_history_separator) {
916                         _file_menu->Remove (_history_separator);
917                 }
918                 delete _history_separator;
919                 _history_separator = nullptr;
920
921                 int pos = _history_position;
922
923                 /* Clear out non-existant history items before we re-build the menu */
924                 Config::instance()->clean_player_history ();
925                 auto history = Config::instance()->player_history ();
926
927                 if (!history.empty ()) {
928                         _history_separator = _file_menu->InsertSeparator (pos++);
929                 }
930
931                 for (size_t i = 0; i < history.size(); ++i) {
932                         string s;
933                         if (i < 9) {
934                                 s = String::compose ("&%1 %2", i + 1, history[i].string());
935                         } else {
936                                 s = history[i].string();
937                         }
938                         _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
939                 }
940
941                 _history_items = history.size ();
942
943                 if (prop == Config::PLAYER_DEBUG_LOG) {
944                         auto p = Config::instance()->player_debug_log_file();
945                         if (p) {
946                                 dcpomatic_log = make_shared<FileLog>(*p);
947                         } else {
948                                 dcpomatic_log = make_shared<NullLog>();
949                         }
950                         dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
951                 }
952         }
953
954         void set_menu_sensitivity ()
955         {
956                 _tools_verify->Enable (static_cast<bool>(_film));
957                 _file_add_ov->Enable (static_cast<bool>(_film));
958                 _file_add_kdm->Enable (static_cast<bool>(_film));
959                 _view_cpl->Enable (static_cast<bool>(_film));
960         }
961
962         void start_stop_pressed ()
963         {
964                 if (_viewer->playing()) {
965                         _viewer->stop();
966                 } else {
967                         _viewer->start();
968                 }
969         }
970
971         void go_back_frame ()
972         {
973                 _viewer->seek_by (-_viewer->one_video_frame(), true);
974         }
975
976         void go_forward_frame ()
977         {
978                 _viewer->seek_by (_viewer->one_video_frame(), true);
979         }
980
981         void go_seconds (int s)
982         {
983                 _viewer->seek_by (DCPTime::from_seconds(s), true);
984         }
985
986         void go_to_start ()
987         {
988                 _viewer->seek (DCPTime(), true);
989         }
990
991         void go_to_end ()
992         {
993                 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
994         }
995
996         wxFrame* _dual_screen;
997         bool _update_news_requested;
998         PlayerInformation* _info;
999         Config::PlayerMode _mode;
1000         wxPreferencesEditor* _config_dialog;
1001         wxPanel* _overall_panel;
1002         wxMenu* _file_menu;
1003         wxMenuItem* _view_cpl;
1004         wxMenu* _cpl_menu;
1005         int _history_items;
1006         int _history_position;
1007         wxMenuItem* _history_separator;
1008         shared_ptr<FilmViewer> _viewer;
1009         Controls* _controls;
1010         SystemInformationDialog* _system_information_dialog;
1011         std::shared_ptr<Film> _film;
1012         boost::signals2::scoped_connection _config_changed_connection;
1013         boost::signals2::scoped_connection _examine_job_connection;
1014         wxMenuItem* _file_add_ov;
1015         wxMenuItem* _file_add_kdm;
1016         wxMenuItem* _tools_verify;
1017         wxMenuItem* _view_full_screen;
1018         wxMenuItem* _view_dual_screen;
1019         wxSizer* _main_sizer;
1020         PlayerStressTester _stress;
1021 };
1022
1023 static const wxCmdLineEntryDesc command_line_description[] = {
1024         { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1025         { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1026         { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1027         { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1028 };
1029
1030 class PlayServer : public Server
1031 {
1032 public:
1033         explicit PlayServer (DOMFrame* frame)
1034                 : Server (PLAYER_PLAY_PORT)
1035                 , _frame (frame)
1036         {}
1037
1038         void handle (shared_ptr<Socket> socket)
1039         {
1040                 try {
1041                         int const length = socket->read_uint32 ();
1042                         scoped_array<char> buffer (new char[length]);
1043                         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1044                         string s (buffer.get());
1045                         signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1046                         socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1047                 } catch (...) {
1048
1049                 }
1050         }
1051
1052 private:
1053         DOMFrame* _frame;
1054 };
1055
1056 /** @class App
1057  *  @brief The magic App class for wxWidgets.
1058  */
1059 class App : public wxApp
1060 {
1061 public:
1062         App ()
1063                 : wxApp ()
1064                 , _frame (0)
1065         {
1066 #ifdef DCPOMATIC_LINUX
1067                 XInitThreads ();
1068 #endif
1069         }
1070
1071 private:
1072
1073         bool OnInit ()
1074         {
1075                 wxSplashScreen* splash = 0;
1076                 try {
1077                         wxInitAllImageHandlers ();
1078
1079                         Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1080                         Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1081
1082                         splash = maybe_show_splash ();
1083
1084                         SetAppName (_("DCP-o-matic Player"));
1085
1086                         if (!wxApp::OnInit()) {
1087                                 return false;
1088                         }
1089
1090 #ifdef DCPOMATIC_LINUX
1091                         unsetenv ("UBUNTU_MENUPROXY");
1092 #endif
1093
1094 #ifdef DCPOMATIC_OSX
1095                         make_foreground_application ();
1096 #endif
1097
1098                         dcpomatic_setup_path_encoding ();
1099
1100                         /* Enable i18n; this will create a Config object
1101                            to look for a force-configured language.  This Config
1102                            object will be wrong, however, because dcpomatic_setup
1103                            hasn't yet been called and there aren't any filters etc.
1104                            set up yet.
1105                         */
1106                         dcpomatic_setup_i18n ();
1107
1108                         /* Set things up, including filters etc.
1109                            which will now be internationalised correctly.
1110                         */
1111                         dcpomatic_setup ();
1112
1113                         /* Force the configuration to be re-loaded correctly next
1114                            time it is needed.
1115                         */
1116                         Config::drop ();
1117
1118                         signal_manager = new wxSignalManager (this);
1119
1120                         _frame = new DOMFrame ();
1121                         SetTopWindow (_frame);
1122                         _frame->Maximize ();
1123                         if (splash) {
1124                                 splash->Destroy ();
1125                                 splash = 0;
1126                         }
1127                         _frame->Show ();
1128
1129                         PlayServer* server = new PlayServer (_frame);
1130                         new thread (boost::bind (&PlayServer::run, server));
1131
1132                         if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1133                                 try {
1134                                         _frame->load_dcp (_dcp_to_load);
1135                                 } catch (exception& e) {
1136                                         error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1137                                 }
1138                         }
1139
1140                         if (_stress) {
1141                                 try {
1142                                         _frame->load_stress_script (*_stress);
1143                                 } catch (exception& e) {
1144                                         error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1145                                 }
1146                         }
1147
1148                         Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1149
1150                         if (Config::instance()->check_for_updates ()) {
1151                                 UpdateChecker::instance()->run ();
1152                         }
1153                 }
1154                 catch (exception& e)
1155                 {
1156                         if (splash) {
1157                                 splash->Destroy ();
1158                         }
1159                         error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1160                 }
1161
1162                 return true;
1163         }
1164
1165         void OnInitCmdLine (wxCmdLineParser& parser)
1166         {
1167                 parser.SetDesc (command_line_description);
1168                 parser.SetSwitchChars (wxT ("-"));
1169         }
1170
1171         bool OnCmdLineParsed (wxCmdLineParser& parser)
1172         {
1173                 if (parser.GetParamCount() > 0) {
1174                         _dcp_to_load = wx_to_std (parser.GetParam (0));
1175                 }
1176
1177                 wxString config;
1178                 if (parser.Found("c", &config)) {
1179                         Config::override_path = wx_to_std (config);
1180                 }
1181                 wxString stress;
1182                 if (parser.Found("s", &stress)) {
1183                         _stress = wx_to_std (stress);
1184                 }
1185
1186                 return true;
1187         }
1188
1189         void report_exception ()
1190         {
1191                 try {
1192                         throw;
1193                 } catch (FileError& e) {
1194                         error_dialog (
1195                                 0,
1196                                 wxString::Format (
1197                                         _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1198                                         std_to_wx (e.what()),
1199                                         std_to_wx (e.file().string().c_str ())
1200                                         )
1201                                 );
1202                 } catch (exception& e) {
1203                         error_dialog (
1204                                 0,
1205                                 wxString::Format (
1206                                         _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1207                                         std_to_wx (e.what ())
1208                                         )
1209                                 );
1210                 } catch (...) {
1211                         error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
1212                 }
1213         }
1214
1215         /* An unhandled exception has occurred inside the main event loop */
1216         bool OnExceptionInMainLoop ()
1217         {
1218                 report_exception ();
1219                 /* This will terminate the program */
1220                 return false;
1221         }
1222
1223         void OnUnhandledException ()
1224         {
1225                 report_exception ();
1226         }
1227
1228         void idle ()
1229         {
1230                 signal_manager->ui_idle ();
1231         }
1232
1233         void config_failed_to_load ()
1234         {
1235                 message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
1236         }
1237
1238         void config_warning (string m)
1239         {
1240                 message_dialog (_frame, std_to_wx (m));
1241         }
1242
1243         DOMFrame* _frame;
1244         string _dcp_to_load;
1245         boost::optional<string> _stress;
1246 };
1247
1248 IMPLEMENT_APP (App)