2 Copyright (C) 2017-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
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.
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.
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/>.
21 #include "wx/about_dialog.h"
22 #include "wx/film_viewer.h"
23 #include "wx/nag_dialog.h"
24 #include "wx/player_config_dialog.h"
25 #include "wx/player_information.h"
26 #include "wx/player_stress_tester.h"
27 #include "wx/playlist_controls.h"
28 #include "wx/report_problem_dialog.h"
29 #include "wx/standard_controls.h"
30 #include "wx/system_information_dialog.h"
31 #include "wx/timer_display.h"
32 #include "wx/update_dialog.h"
33 #include "wx/verify_dcp_dialog.h"
34 #include "wx/verify_dcp_progress_dialog.h"
35 #include "wx/wx_signal_manager.h"
36 #include "wx/wx_util.h"
37 #include "lib/compose.hpp"
38 #include "lib/config.h"
39 #include "lib/cross.h"
40 #include "lib/dcp_content.h"
41 #include "lib/dcp_examiner.h"
42 #include "lib/dcpomatic_log.h"
43 #include "lib/dcpomatic_socket.h"
44 #include "lib/examine_content_job.h"
45 #include "lib/ffmpeg_content.h"
46 #include "lib/file_log.h"
48 #include "lib/internet.h"
50 #include "lib/job_manager.h"
51 #include "lib/null_log.h"
52 #include "lib/ratio.h"
53 #include "lib/scoped_temporary.h"
54 #include "lib/server.h"
55 #include "lib/text_content.h"
56 #include "lib/update_checker.h"
58 #include "lib/verify_dcp_job.h"
59 #include "lib/video_content.h"
62 #include <dcp/raw_convert.h>
63 #include <dcp/exceptions.h>
64 #include <wx/cmdline.h>
65 #include <wx/display.h>
66 #include <wx/preferences.h>
67 #include <wx/progdlg.h>
68 #include <wx/splash.h>
69 #include <wx/stdpaths.h>
74 #include <boost/algorithm/string.hpp>
75 #include <boost/bind/bind.hpp>
87 using std::dynamic_pointer_cast;
90 using std::make_shared;
91 using std::shared_ptr;
96 using boost::optional;
97 using boost::scoped_array;
99 #if BOOST_VERSION >= 106100
100 using namespace boost::placeholders;
102 using dcp::raw_convert;
103 using namespace dcpomatic;
111 /* Allow spare IDs after _history for the recent files list */
114 /* Allow spare IDs for CPLs */
115 ID_view_full_screen = 200,
117 ID_view_closed_captions,
118 ID_view_scale_appropriate,
121 ID_view_scale_quarter,
122 ID_help_report_a_problem,
124 ID_tools_check_for_updates,
126 ID_tools_system_information,
127 /* IDs for shortcuts (with no associated menu item) */
131 ID_go_back_small_amount,
132 ID_go_forward_small_amount,
133 ID_go_back_medium_amount,
134 ID_go_forward_medium_amount,
135 ID_go_back_large_amount,
136 ID_go_forward_large_amount,
141 class DOMFrame : public wxFrame
145 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
146 , _mode (Config::instance()->player_mode())
147 , _main_sizer (new wxBoxSizer(wxVERTICAL))
149 dcpomatic_log = make_shared<NullLog>();
151 #if defined(DCPOMATIC_WINDOWS)
152 maybe_open_console ();
153 cout << "DCP-o-matic Player is starting." << "\n";
156 auto bar = new wxMenuBar;
158 set_menu_sensitivity ();
161 #ifdef DCPOMATIC_WINDOWS
162 SetIcon (wxIcon (std_to_wx ("id")));
165 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
166 update_from_config (Config::PLAYER_DEBUG_LOG);
168 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
169 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
170 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
171 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
172 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
173 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
174 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
175 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
181 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
185 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
186 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
187 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
189 /* Use a panel as the only child of the Frame so that we avoid
190 the dark-grey background on Windows.
192 _overall_panel = new wxPanel (this, wxID_ANY);
194 _viewer = make_shared<FilmViewer>(_overall_panel);
195 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
196 auto pc = new PlaylistControls (_overall_panel, _viewer);
198 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
200 _controls = new StandardControls (_overall_panel, _viewer, false);
202 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
203 _viewer->set_optimise_for_j2k (true);
204 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
205 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
206 _info = new PlayerInformation (_overall_panel, _viewer);
207 setup_main_sizer (Config::instance()->player_mode());
209 int accelerators = 12;
211 int accelerators = 11;
214 _stress.setup (this, _controls);
216 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
217 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
218 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
219 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
220 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
221 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
222 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
223 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
224 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
225 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
226 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
227 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
229 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
231 wxAcceleratorTable accel_table (accelerators, accel);
232 SetAcceleratorTable (accel_table);
235 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
236 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
237 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
238 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
239 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
240 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
241 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
242 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
243 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
244 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
245 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
249 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
252 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
257 /* It's important that this is stopped before our frame starts destroying its children,
258 * otherwise UI elements that it depends on will disappear from under it.
263 void setup_main_sizer (Config::PlayerMode mode)
265 _main_sizer->Detach (_viewer->panel());
266 _main_sizer->Detach (_controls);
267 _main_sizer->Detach (_info);
268 if (mode != Config::PLAYER_MODE_DUAL) {
269 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
271 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
272 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
273 _overall_panel->SetSizer (_main_sizer);
274 _overall_panel->Layout ();
277 bool playback_permitted ()
279 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
284 for (auto i: _film->content()) {
285 auto d = dynamic_pointer_cast<DCPContent>(i);
286 if (d && !d->kdm_timing_window_valid()) {
292 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
299 void too_many_frames_dropped ()
301 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
305 NagDialog::maybe_nag (
307 Config::NAG_TOO_MANY_DROPPED_FRAMES,
308 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
309 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
310 "You may be able to improve player performance by:\n"
311 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
312 "• using a more powerful computer.\n"
317 void set_decode_reduction (optional<int> reduction)
319 _viewer->set_dcp_decode_reduction (reduction);
320 _info->triggered_update ();
321 Config::instance()->set_decode_reduction (reduction);
324 void load_dcp (boost::filesystem::path dir)
326 DCPOMATIC_ASSERT (_film);
330 _stress.set_suspended (true);
332 auto dcp = make_shared<DCPContent>(dir);
333 auto job = make_shared<ExamineContentJob>(_film, dcp);
334 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
335 JobManager::instance()->add (job);
336 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
337 if (!ok || !report_errors_from_last_job(this)) {
340 Config::instance()->add_to_player_history (dir);
341 } catch (ProjectFolderError &) {
344 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
346 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
347 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
350 } catch (dcp::ReadError& e) {
351 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
352 } catch (DCPError& e) {
353 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
357 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
359 auto job = weak_job.lock ();
360 if (!job || !job->finished_ok()) {
364 auto content = weak_content.lock ();
369 _film->add_content (content);
370 _stress.set_suspended (false);
373 void reset_film_weak (weak_ptr<Film> weak_film)
375 auto film = weak_film.lock ();
381 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
384 _film->set_tolerant (true);
385 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
386 _viewer->set_film (_film);
387 _controls->set_film (_film);
388 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
389 _info->triggered_update ();
392 void film_changed (ChangeType type, Film::Property property)
394 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
398 if (_viewer->playing ()) {
402 /* Start off as Flat */
403 _film->set_container (Ratio::from_id("185"));
405 for (auto i: _film->content()) {
406 auto dcp = dynamic_pointer_cast<DCPContent>(i);
408 for (auto j: i->text) {
413 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
414 if (r->id() == "239") {
415 /* Any scope content means we use scope */
416 _film->set_container(r);
420 /* Any 3D content means we use 3D mode */
421 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
422 _film->set_three_d (true);
426 _viewer->seek (DCPTime(), true);
427 _info->triggered_update ();
429 set_menu_sensitivity ();
431 auto old = _cpl_menu->GetMenuItems();
432 for (auto const& i: old) {
433 _cpl_menu->Remove (i);
436 if (_film->content().size() == 1) {
437 /* Offer a CPL menu */
438 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
440 DCPExaminer ex (first, true);
441 int id = ID_view_cpl;
442 for (auto i: ex.cpls()) {
443 auto j = _cpl_menu->AppendRadioItem(
445 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
447 j->Check(!first->cpl() || i->id() == *first->cpl());
454 void load_stress_script (boost::filesystem::path path)
456 _stress.load_script (path);
461 void examine_content ()
463 DCPOMATIC_ASSERT (_film);
464 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
465 DCPOMATIC_ASSERT (dcp);
466 dcp->examine (_film, shared_ptr<Job>());
468 /* Examining content re-creates the TextContent objects, so we must re-enable them */
469 for (auto i: dcp->text) {
474 bool report_errors_from_last_job (wxWindow* parent) const
476 auto jm = JobManager::instance ();
478 DCPOMATIC_ASSERT (!jm->get().empty());
480 auto last = jm->get().back();
481 if (last->finished_in_error()) {
482 error_dialog(parent, wxString::Format(_("Could not load DCP.\n\n%s."), std_to_wx(last->error_summary()).data()), std_to_wx(last->error_details()));
489 void setup_menu (wxMenuBar* m)
491 _file_menu = new wxMenu;
492 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
493 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
494 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
496 _history_position = _file_menu->GetMenuItems().GetCount();
498 _file_menu->AppendSeparator ();
499 _file_menu->Append (ID_file_close, _("&Close"));
500 _file_menu->AppendSeparator ();
503 _file_menu->Append (wxID_EXIT, _("&Exit"));
505 _file_menu->Append (wxID_EXIT, _("&Quit"));
509 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
511 auto edit = new wxMenu;
512 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
515 prefs->Enable (Config::instance()->have_write_permission());
517 _cpl_menu = new wxMenu;
519 auto view = new wxMenu;
520 auto c = Config::instance()->decode_reduction();
521 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
522 view->AppendSeparator();
523 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
524 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
526 view->AppendSeparator();
527 view->Append(ID_view_closed_captions, _("Closed captions..."));
528 view->AppendSeparator();
529 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
530 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
531 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
532 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
534 auto tools = new wxMenu;
535 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
536 tools->AppendSeparator ();
537 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
538 tools->Append (ID_tools_timing, _("Timing..."));
539 tools->Append (ID_tools_system_information, _("System information..."));
541 auto help = new wxMenu;
543 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
545 help->Append (wxID_ABOUT, _("About"));
547 help->Append (ID_help_report_a_problem, _("Report a problem..."));
549 m->Append (_file_menu, _("&File"));
551 m->Append (edit, _("&Edit"));
553 m->Append (view, _("&View"));
554 m->Append (tools, _("&Tools"));
555 m->Append (help, _("&Help"));
560 auto d = wxStandardPaths::Get().GetDocumentsDir();
561 if (Config::instance()->last_player_load_directory()) {
562 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
565 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
570 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
571 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
578 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
580 Config::instance()->set_last_player_load_directory (dcp.parent_path());
588 auto c = new wxDirDialog (
590 _("Select DCP to open as OV"),
591 wxStandardPaths::Get().GetDocumentsDir(),
592 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
598 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
599 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
606 DCPOMATIC_ASSERT (_film);
607 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
608 DCPOMATIC_ASSERT (dcp);
609 dcp->add_ov (wx_to_std(c->GetPath()));
610 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
611 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
612 if (!ok || !report_errors_from_last_job(this)) {
615 for (auto i: dcp->text) {
619 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
621 _film->set_container(r);
627 _info->triggered_update ();
632 auto d = new wxFileDialog (this, _("Select KDM"));
634 if (d->ShowModal() == wxID_OK) {
635 DCPOMATIC_ASSERT (_film);
636 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
637 DCPOMATIC_ASSERT (dcp);
640 _viewer->set_coalesce_player_changes (true);
641 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
643 _viewer->set_coalesce_player_changes (false);
645 } catch (exception& e) {
646 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
653 _info->triggered_update ();
656 void file_history (wxCommandEvent& event)
658 auto history = Config::instance()->player_history ();
659 int n = event.GetId() - ID_file_history;
660 if (n >= 0 && n < static_cast<int> (history.size ())) {
662 load_dcp (history[n]);
663 } catch (exception& e) {
664 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
672 _info->triggered_update ();
673 set_menu_sensitivity ();
681 void edit_preferences ()
683 if (!Config::instance()->have_write_permission()) {
687 if (!_config_dialog) {
688 _config_dialog = create_player_config_dialog ();
690 _config_dialog->Show (this);
693 void view_cpl (wxCommandEvent& ev)
695 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
696 DCPOMATIC_ASSERT (dcp);
697 DCPExaminer ex (dcp, true);
698 int id = ev.GetId() - ID_view_cpl;
699 DCPOMATIC_ASSERT (id >= 0);
700 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
701 auto cpls = ex.cpls();
702 auto i = cpls.begin();
708 _viewer->set_coalesce_player_changes (true);
709 dcp->set_cpl ((*i)->id());
711 _viewer->set_coalesce_player_changes (false);
713 _info->triggered_update ();
716 void view_full_screen ()
718 if (_mode == Config::PLAYER_MODE_FULL) {
719 _mode = Config::PLAYER_MODE_WINDOW;
721 _mode = Config::PLAYER_MODE_FULL;
727 void view_dual_screen ()
729 if (_mode == Config::PLAYER_MODE_DUAL) {
730 _mode = Config::PLAYER_MODE_WINDOW;
732 _mode = Config::PLAYER_MODE_DUAL;
740 if (_view_full_screen) {
741 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
743 if (_view_dual_screen) {
744 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
750 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
751 _info->Show (_mode != Config::PLAYER_MODE_FULL);
752 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
753 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
754 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
756 if (_mode == Config::PLAYER_MODE_DUAL) {
757 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
758 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
759 _dual_screen->ShowFullScreen (true);
760 _viewer->panel()->Reparent (_dual_screen);
761 _dual_screen->Show ();
762 if (wxDisplay::GetCount() > 1) {
763 switch (Config::instance()->image_display()) {
765 _dual_screen->Move (0, 0);
766 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
769 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
770 // (0, 0) doesn't seem to work for some strange reason
777 _viewer->panel()->Reparent (_overall_panel);
778 _dual_screen->Destroy ();
783 setup_main_sizer (_mode);
786 void view_closed_captions ()
788 _viewer->show_closed_captions ();
793 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
794 DCPOMATIC_ASSERT (dcp);
796 auto job = make_shared<VerifyDCPJob>(dcp->directories());
797 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
798 bool const completed = progress->run (job);
799 progress->Destroy ();
804 auto d = new VerifyDCPDialog (this, job);
809 void tools_check_for_updates ()
811 UpdateChecker::instance()->run ();
812 _update_news_requested = true;
817 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
822 void tools_system_information ()
824 if (!_system_information_dialog) {
825 _system_information_dialog = new SystemInformationDialog (this, _viewer);
828 _system_information_dialog->Show ();
833 auto d = new AboutDialog (this);
838 void help_report_a_problem ()
840 auto d = new ReportProblemDialog (this);
841 if (d->ShowModal () == wxID_OK) {
847 void update_checker_state_changed ()
849 auto uc = UpdateChecker::instance ();
851 bool const announce =
852 _update_news_requested ||
853 (uc->stable() && Config::instance()->check_for_updates()) ||
854 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
856 _update_news_requested = false;
862 if (uc->state() == UpdateChecker::State::YES) {
863 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
864 dialog->ShowModal ();
866 } else if (uc->state() == UpdateChecker::State::FAILED) {
867 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
869 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
872 _update_news_requested = false;
875 void config_changed (Config::Property prop)
877 /* Instantly save any config changes when using the player GUI */
879 Config::instance()->write_config();
880 } catch (FileError& e) {
881 if (prop != Config::HISTORY) {
885 _("Could not write to config file at %s. Your changes have not been saved."),
886 std_to_wx(e.file().string())
890 } catch (exception& e) {
893 _("Could not write to config file. Your changes have not been saved.")
897 update_from_config (prop);
900 void update_from_config (Config::Property prop)
902 for (int i = 0; i < _history_items; ++i) {
903 delete _file_menu->Remove (ID_file_history + i);
906 if (_history_separator) {
907 _file_menu->Remove (_history_separator);
909 delete _history_separator;
910 _history_separator = nullptr;
912 int pos = _history_position;
914 /* Clear out non-existant history items before we re-build the menu */
915 Config::instance()->clean_player_history ();
916 auto history = Config::instance()->player_history ();
918 if (!history.empty ()) {
919 _history_separator = _file_menu->InsertSeparator (pos++);
922 for (size_t i = 0; i < history.size(); ++i) {
925 s = String::compose ("&%1 %2", i + 1, history[i].string());
927 s = history[i].string();
929 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
932 _history_items = history.size ();
934 if (prop == Config::PLAYER_DEBUG_LOG) {
935 auto p = Config::instance()->player_debug_log_file();
937 dcpomatic_log = make_shared<FileLog>(*p);
939 dcpomatic_log = make_shared<NullLog>();
941 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
945 void set_menu_sensitivity ()
947 _tools_verify->Enable (static_cast<bool>(_film));
948 _file_add_ov->Enable (static_cast<bool>(_film));
949 _file_add_kdm->Enable (static_cast<bool>(_film));
950 _view_cpl->Enable (static_cast<bool>(_film));
953 void start_stop_pressed ()
955 if (_viewer->playing()) {
962 void go_back_frame ()
964 _viewer->seek_by (-_viewer->one_video_frame(), true);
967 void go_forward_frame ()
969 _viewer->seek_by (_viewer->one_video_frame(), true);
972 void go_seconds (int s)
974 _viewer->seek_by (DCPTime::from_seconds(s), true);
979 _viewer->seek (DCPTime(), true);
984 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
987 wxFrame* _dual_screen = nullptr;
988 bool _update_news_requested = false;
989 PlayerInformation* _info = nullptr;
990 Config::PlayerMode _mode;
991 wxPreferencesEditor* _config_dialog = nullptr;
992 wxPanel* _overall_panel = nullptr;
993 wxMenu* _file_menu = nullptr;
994 wxMenuItem* _view_cpl = nullptr;
995 wxMenu* _cpl_menu = nullptr;
996 int _history_items = 0;
997 int _history_position = 0;
998 wxMenuItem* _history_separator = nullptr;
999 shared_ptr<FilmViewer> _viewer;
1000 Controls* _controls;
1001 SystemInformationDialog* _system_information_dialog = nullptr;
1002 std::shared_ptr<Film> _film;
1003 boost::signals2::scoped_connection _config_changed_connection;
1004 boost::signals2::scoped_connection _examine_job_connection;
1005 wxMenuItem* _file_add_ov = nullptr;
1006 wxMenuItem* _file_add_kdm = nullptr;
1007 wxMenuItem* _tools_verify = nullptr;
1008 wxMenuItem* _view_full_screen = nullptr;
1009 wxMenuItem* _view_dual_screen = nullptr;
1010 wxSizer* _main_sizer = nullptr;
1011 PlayerStressTester _stress;
1014 static const wxCmdLineEntryDesc command_line_description[] = {
1015 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1016 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1017 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1018 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1021 class PlayServer : public Server
1024 explicit PlayServer (DOMFrame* frame)
1025 : Server (PLAYER_PLAY_PORT)
1029 void handle (shared_ptr<Socket> socket) override
1032 int const length = socket->read_uint32 ();
1033 scoped_array<char> buffer (new char[length]);
1034 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1035 string s (buffer.get());
1036 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1037 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1048 * @brief The magic App class for wxWidgets.
1050 class App : public wxApp
1056 #ifdef DCPOMATIC_LINUX
1063 bool OnInit () override
1065 wxSplashScreen* splash = nullptr;
1067 wxInitAllImageHandlers ();
1069 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1070 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1072 splash = maybe_show_splash ();
1074 SetAppName (_("DCP-o-matic Player"));
1076 if (!wxApp::OnInit()) {
1080 #ifdef DCPOMATIC_LINUX
1081 unsetenv ("UBUNTU_MENUPROXY");
1084 #ifdef DCPOMATIC_OSX
1085 make_foreground_application ();
1088 dcpomatic_setup_path_encoding ();
1090 /* Enable i18n; this will create a Config object
1091 to look for a force-configured language. This Config
1092 object will be wrong, however, because dcpomatic_setup
1093 hasn't yet been called and there aren't any filters etc.
1096 dcpomatic_setup_i18n ();
1098 /* Set things up, including filters etc.
1099 which will now be internationalised correctly.
1103 /* Force the configuration to be re-loaded correctly next
1108 signal_manager = new wxSignalManager (this);
1110 _frame = new DOMFrame ();
1111 SetTopWindow (_frame);
1112 _frame->Maximize ();
1120 auto server = new PlayServer (_frame);
1121 new thread (boost::bind (&PlayServer::run, server));
1122 } catch (std::exception& e) {
1123 /* This is not the end of the world; probably a failure to bind the server socket
1124 * because there's already another player running.
1126 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1129 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1131 _frame->load_dcp (_dcp_to_load);
1132 } catch (exception& e) {
1133 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1139 _frame->load_stress_script (*_stress);
1140 } catch (exception& e) {
1141 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1145 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1147 if (Config::instance()->check_for_updates ()) {
1148 UpdateChecker::instance()->run ();
1151 catch (exception& e)
1156 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1162 void OnInitCmdLine (wxCmdLineParser& parser) override
1164 parser.SetDesc (command_line_description);
1165 parser.SetSwitchChars (wxT ("-"));
1168 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1170 if (parser.GetParamCount() > 0) {
1171 _dcp_to_load = wx_to_std (parser.GetParam (0));
1175 if (parser.Found("c", &config)) {
1176 Config::override_path = wx_to_std (config);
1179 if (parser.Found("s", &stress)) {
1180 _stress = wx_to_std (stress);
1186 void report_exception ()
1190 } catch (FileError& e) {
1194 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1195 std_to_wx (e.what()),
1196 std_to_wx (e.file().string().c_str ())
1199 } catch (exception& e) {
1203 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1204 std_to_wx (e.what ())
1208 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1212 /* An unhandled exception has occurred inside the main event loop */
1213 bool OnExceptionInMainLoop () override
1215 report_exception ();
1216 /* This will terminate the program */
1220 void OnUnhandledException () override
1222 report_exception ();
1227 signal_manager->ui_idle ();
1230 void config_failed_to_load ()
1232 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1235 void config_warning (string m)
1237 message_dialog (_frame, std_to_wx (m));
1240 DOMFrame* _frame = nullptr;
1241 string _dcp_to_load;
1242 boost::optional<string> _stress;