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