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