src/tools/dcpomatic_player.cc

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