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