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