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