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