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/wx_signal_manager.h"
22 #include "wx/wx_util.h"
23 #include "wx/about_dialog.h"
24 #include "wx/report_problem_dialog.h"
25 #include "wx/film_viewer.h"
26 #include "wx/player_information.h"
27 #include "wx/update_dialog.h"
28 #include "wx/player_config_dialog.h"
29 #include "wx/verify_dcp_dialog.h"
30 #include "wx/standard_controls.h"
31 #include "wx/playlist_controls.h"
32 #include "wx/timer_display.h"
33 #include "wx/system_information_dialog.h"
34 #include "wx/player_stress_tester.h"
35 #include "wx/verify_dcp_progress_dialog.h"
36 #include "wx/nag_dialog.h"
37 #include "lib/cross.h"
38 #include "lib/config.h"
40 #include "lib/internet.h"
41 #include "lib/update_checker.h"
42 #include "lib/compose.hpp"
43 #include "lib/dcp_content.h"
44 #include "lib/job_manager.h"
47 #include "lib/null_log.h"
48 #include "lib/video_content.h"
49 #include "lib/text_content.h"
50 #include "lib/ratio.h"
51 #include "lib/verify_dcp_job.h"
52 #include "lib/dcp_examiner.h"
53 #include "lib/examine_content_job.h"
54 #include "lib/server.h"
55 #include "lib/dcpomatic_socket.h"
56 #include "lib/scoped_temporary.h"
57 #include "lib/ffmpeg_content.h"
58 #include "lib/dcpomatic_log.h"
59 #include "lib/file_log.h"
62 #include <dcp/raw_convert.h>
63 #include <dcp/exceptions.h>
65 #include <wx/stdpaths.h>
66 #include <wx/splash.h>
67 #include <wx/cmdline.h>
68 #include <wx/preferences.h>
69 #include <wx/progdlg.h>
70 #include <wx/display.h>
74 #include <boost/bind/bind.hpp>
75 #include <boost/algorithm/string.hpp>
85 using std::dynamic_pointer_cast;
88 using std::make_shared;
89 using std::shared_ptr;
93 using boost::scoped_array;
94 using boost::optional;
97 #if BOOST_VERSION >= 106100
98 using namespace boost::placeholders;
100 using dcp::raw_convert;
101 using namespace dcpomatic;
108 /* Allow spare IDs after _history for the recent files list */
111 /* Allow spare IDs for CPLs */
112 ID_view_full_screen = 200,
114 ID_view_closed_captions,
115 ID_view_scale_appropriate,
118 ID_view_scale_quarter,
119 ID_help_report_a_problem,
121 ID_tools_check_for_updates,
123 ID_tools_system_information,
124 /* IDs for shortcuts (with no associated menu item) */
128 ID_go_back_small_amount,
129 ID_go_forward_small_amount,
130 ID_go_back_medium_amount,
131 ID_go_forward_medium_amount,
132 ID_go_back_large_amount,
133 ID_go_forward_large_amount,
138 class DOMFrame : public wxFrame
142 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
143 , _mode (Config::instance()->player_mode())
144 , _main_sizer (new wxBoxSizer(wxVERTICAL))
146 dcpomatic_log = make_shared<NullLog>();
148 #if defined(DCPOMATIC_WINDOWS)
149 maybe_open_console ();
150 cout << "DCP-o-matic Player is starting." << "\n";
153 auto bar = new wxMenuBar;
155 set_menu_sensitivity ();
158 #ifdef DCPOMATIC_WINDOWS
159 SetIcon (wxIcon (std_to_wx ("id")));
162 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
163 update_from_config (Config::PLAYER_DEBUG_LOG);
165 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
166 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
167 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
168 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
169 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
170 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
171 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
172 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
173 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
174 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
175 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
181 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
186 /* Use a panel as the only child of the Frame so that we avoid
187 the dark-grey background on Windows.
189 _overall_panel = new wxPanel (this, wxID_ANY);
191 _viewer = make_shared<FilmViewer>(_overall_panel);
192 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
193 auto pc = new PlaylistControls (_overall_panel, _viewer);
195 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
197 _controls = new StandardControls (_overall_panel, _viewer, false);
199 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
200 _viewer->set_optimise_for_j2k (true);
201 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
202 _viewer->Started.connect (bind(&DOMFrame::playback_started, this, _1));
203 _viewer->Stopped.connect (bind(&DOMFrame::playback_stopped, this, _1));
204 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
205 _info = new PlayerInformation (_overall_panel, _viewer);
206 setup_main_sizer (Config::instance()->player_mode());
208 int accelerators = 12;
210 int accelerators = 11;
213 _stress.setup (this, _controls);
215 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
216 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
217 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
218 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
219 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
220 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
221 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
222 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
223 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
224 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
225 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
226 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
228 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
230 wxAcceleratorTable accel_table (accelerators, accel);
231 SetAcceleratorTable (accel_table);
234 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
235 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
236 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
237 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
238 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
239 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
240 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
241 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
242 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
243 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
244 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
248 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
251 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
256 /* It's important that this is stopped before our frame starts destroying its children,
257 * otherwise UI elements that it depends on will disappear from under it.
262 void setup_main_sizer (Config::PlayerMode mode)
264 _main_sizer->Detach (_viewer->panel());
265 _main_sizer->Detach (_controls);
266 _main_sizer->Detach (_info);
267 if (mode != Config::PLAYER_MODE_DUAL) {
268 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
270 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
271 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
272 _overall_panel->SetSizer (_main_sizer);
273 _overall_panel->Layout ();
276 bool playback_permitted ()
278 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
283 for (auto i: _film->content()) {
284 auto d = dynamic_pointer_cast<DCPContent>(i);
285 if (d && !d->kdm_timing_window_valid()) {
291 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
297 void playback_started (DCPTime time)
299 /* XXX: this only logs the first piece of content; probably should be each piece? */
300 if (_film->content().empty()) {
304 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
306 DCPExaminer ex (dcp, true);
307 shared_ptr<dcp::CPL> playing_cpl;
308 for (auto i: ex.cpls()) {
309 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
313 DCPOMATIC_ASSERT (playing_cpl);
317 "playback-started %s %s %s",
318 time.timecode(_film->video_frame_rate()).c_str(),
319 dcp->directories().front().string().c_str(),
320 playing_cpl->annotation_text().get_value_or("").c_str()
325 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(_film->content().front());
329 "playback-started %s %s",
330 time.timecode(_film->video_frame_rate()).c_str(),
331 ffmpeg->path(0).string().c_str()
337 void playback_stopped (DCPTime time)
339 _controls->log (wxString::Format("playback-stopped %s", time.timecode(_film->video_frame_rate()).c_str()));
343 void too_many_frames_dropped ()
345 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
349 NagDialog::maybe_nag (
351 Config::NAG_TOO_MANY_DROPPED_FRAMES,
352 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
353 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
354 "You may be able to improve player performance by:\n"
355 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
356 "• using a more powerful computer.\n"
361 void set_decode_reduction (optional<int> reduction)
363 _viewer->set_dcp_decode_reduction (reduction);
364 _info->triggered_update ();
365 Config::instance()->set_decode_reduction (reduction);
368 void load_dcp (boost::filesystem::path dir)
370 DCPOMATIC_ASSERT (_film);
374 _stress.set_suspended (true);
376 auto dcp = make_shared<DCPContent>(dir);
377 auto job = make_shared<ExamineContentJob>(_film, dcp);
378 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
379 JobManager::instance()->add (job);
380 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
381 if (!ok || !report_errors_from_last_job(this)) {
384 Config::instance()->add_to_player_history (dir);
385 } catch (ProjectFolderError &) {
388 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
390 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
391 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
394 } catch (dcp::ReadError& e) {
395 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
396 } catch (DCPError& e) {
397 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
401 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
403 auto job = weak_job.lock ();
404 if (!job || !job->finished_ok()) {
408 auto content = weak_content.lock ();
413 _film->add_content (content);
414 _stress.set_suspended (false);
417 void reset_film_weak (weak_ptr<Film> weak_film)
419 auto film = weak_film.lock ();
425 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
428 _film->set_tolerant (true);
429 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
430 _viewer->set_film (_film);
431 _controls->set_film (_film);
432 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
433 _info->triggered_update ();
436 void film_changed (ChangeType type, Film::Property property)
438 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
442 if (_viewer->playing ()) {
446 /* Start off as Flat */
447 _film->set_container (Ratio::from_id("185"));
449 for (auto i: _film->content()) {
450 auto dcp = dynamic_pointer_cast<DCPContent>(i);
452 for (auto j: i->text) {
457 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
458 if (r->id() == "239") {
459 /* Any scope content means we use scope */
460 _film->set_container(r);
464 /* Any 3D content means we use 3D mode */
465 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
466 _film->set_three_d (true);
470 _viewer->seek (DCPTime(), true);
471 _info->triggered_update ();
473 set_menu_sensitivity ();
475 auto old = _cpl_menu->GetMenuItems();
476 for (auto const& i: old) {
477 _cpl_menu->Remove (i);
480 if (_film->content().size() == 1) {
481 /* Offer a CPL menu */
482 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
484 DCPExaminer ex (first, true);
485 int id = ID_view_cpl;
486 for (auto i: ex.cpls()) {
487 auto j = _cpl_menu->AppendRadioItem(
489 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
491 j->Check(!first->cpl() || i->id() == *first->cpl());
498 void load_stress_script (boost::filesystem::path path)
500 _stress.load_script (path);
505 void examine_content ()
507 DCPOMATIC_ASSERT (_film);
508 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
509 DCPOMATIC_ASSERT (dcp);
510 dcp->examine (_film, shared_ptr<Job>());
512 /* Examining content re-creates the TextContent objects, so we must re-enable them */
513 for (auto i: dcp->text) {
518 bool report_errors_from_last_job (wxWindow* parent) const
520 auto jm = JobManager::instance ();
522 DCPOMATIC_ASSERT (!jm->get().empty());
524 auto last = jm->get().back();
525 if (last->finished_in_error()) {
526 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()));
533 void setup_menu (wxMenuBar* m)
535 _file_menu = new wxMenu;
536 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
537 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
538 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
540 _history_position = _file_menu->GetMenuItems().GetCount();
542 _file_menu->AppendSeparator ();
543 _file_menu->Append (ID_file_close, _("&Close"));
544 _file_menu->AppendSeparator ();
547 _file_menu->Append (wxID_EXIT, _("&Exit"));
549 _file_menu->Append (wxID_EXIT, _("&Quit"));
553 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
555 auto edit = new wxMenu;
556 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
559 prefs->Enable (Config::instance()->have_write_permission());
561 _cpl_menu = new wxMenu;
563 auto view = new wxMenu;
564 auto c = Config::instance()->decode_reduction();
565 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
566 view->AppendSeparator();
567 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
568 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
570 view->AppendSeparator();
571 view->Append(ID_view_closed_captions, _("Closed captions..."));
572 view->AppendSeparator();
573 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
574 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
575 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
576 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
578 auto tools = new wxMenu;
579 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
580 tools->AppendSeparator ();
581 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
582 tools->Append (ID_tools_timing, _("Timing..."));
583 tools->Append (ID_tools_system_information, _("System information..."));
585 auto help = new wxMenu;
587 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
589 help->Append (wxID_ABOUT, _("About"));
591 help->Append (ID_help_report_a_problem, _("Report a problem..."));
593 m->Append (_file_menu, _("&File"));
595 m->Append (edit, _("&Edit"));
597 m->Append (view, _("&View"));
598 m->Append (tools, _("&Tools"));
599 m->Append (help, _("&Help"));
604 auto d = wxStandardPaths::Get().GetDocumentsDir();
605 if (Config::instance()->last_player_load_directory()) {
606 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
609 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
614 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
615 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
622 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
624 Config::instance()->set_last_player_load_directory (dcp.parent_path());
632 auto c = new wxDirDialog (
634 _("Select DCP to open as OV"),
635 wxStandardPaths::Get().GetDocumentsDir(),
636 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
642 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
643 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
650 DCPOMATIC_ASSERT (_film);
651 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
652 DCPOMATIC_ASSERT (dcp);
653 dcp->add_ov (wx_to_std(c->GetPath()));
654 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
655 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
656 if (!ok || !report_errors_from_last_job(this)) {
659 for (auto i: dcp->text) {
663 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
665 _film->set_container(r);
671 _info->triggered_update ();
676 auto d = new wxFileDialog (this, _("Select KDM"));
678 if (d->ShowModal() == wxID_OK) {
679 DCPOMATIC_ASSERT (_film);
680 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
681 DCPOMATIC_ASSERT (dcp);
684 _viewer->set_coalesce_player_changes (true);
685 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
687 _viewer->set_coalesce_player_changes (false);
689 } catch (exception& e) {
690 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
697 _info->triggered_update ();
700 void file_history (wxCommandEvent& event)
702 auto history = Config::instance()->player_history ();
703 int n = event.GetId() - ID_file_history;
704 if (n >= 0 && n < static_cast<int> (history.size ())) {
706 load_dcp (history[n]);
707 } catch (exception& e) {
708 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
716 _info->triggered_update ();
717 set_menu_sensitivity ();
725 void edit_preferences ()
727 if (!Config::instance()->have_write_permission()) {
731 if (!_config_dialog) {
732 _config_dialog = create_player_config_dialog ();
734 _config_dialog->Show (this);
737 void view_cpl (wxCommandEvent& ev)
739 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
740 DCPOMATIC_ASSERT (dcp);
741 DCPExaminer ex (dcp, true);
742 int id = ev.GetId() - ID_view_cpl;
743 DCPOMATIC_ASSERT (id >= 0);
744 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
745 auto cpls = ex.cpls();
746 auto i = cpls.begin();
752 _viewer->set_coalesce_player_changes (true);
753 dcp->set_cpl ((*i)->id());
755 _viewer->set_coalesce_player_changes (false);
757 _info->triggered_update ();
760 void view_full_screen ()
762 if (_mode == Config::PLAYER_MODE_FULL) {
763 _mode = Config::PLAYER_MODE_WINDOW;
765 _mode = Config::PLAYER_MODE_FULL;
771 void view_dual_screen ()
773 if (_mode == Config::PLAYER_MODE_DUAL) {
774 _mode = Config::PLAYER_MODE_WINDOW;
776 _mode = Config::PLAYER_MODE_DUAL;
784 if (_view_full_screen) {
785 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
787 if (_view_dual_screen) {
788 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
794 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
795 _info->Show (_mode != Config::PLAYER_MODE_FULL);
796 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
797 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
798 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
800 if (_mode == Config::PLAYER_MODE_DUAL) {
801 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
802 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
803 _dual_screen->ShowFullScreen (true);
804 _viewer->panel()->Reparent (_dual_screen);
805 _dual_screen->Show ();
806 if (wxDisplay::GetCount() > 1) {
807 switch (Config::instance()->image_display()) {
809 _dual_screen->Move (0, 0);
810 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
813 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
814 // (0, 0) doesn't seem to work for some strange reason
821 _viewer->panel()->Reparent (_overall_panel);
822 _dual_screen->Destroy ();
827 setup_main_sizer (_mode);
830 void view_closed_captions ()
832 _viewer->show_closed_captions ();
837 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
838 DCPOMATIC_ASSERT (dcp);
840 auto job = make_shared<VerifyDCPJob>(dcp->directories());
841 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
842 bool const completed = progress->run (job);
843 progress->Destroy ();
848 auto d = new VerifyDCPDialog (this, job);
853 void tools_check_for_updates ()
855 UpdateChecker::instance()->run ();
856 _update_news_requested = true;
861 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
866 void tools_system_information ()
868 if (!_system_information_dialog) {
869 _system_information_dialog = new SystemInformationDialog (this, _viewer);
872 _system_information_dialog->Show ();
877 auto d = new AboutDialog (this);
882 void help_report_a_problem ()
884 auto d = new ReportProblemDialog (this);
885 if (d->ShowModal () == wxID_OK) {
891 void update_checker_state_changed ()
893 auto uc = UpdateChecker::instance ();
895 bool const announce =
896 _update_news_requested ||
897 (uc->stable() && Config::instance()->check_for_updates()) ||
898 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
900 _update_news_requested = false;
906 if (uc->state() == UpdateChecker::State::YES) {
907 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
908 dialog->ShowModal ();
910 } else if (uc->state() == UpdateChecker::State::FAILED) {
911 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
913 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
916 _update_news_requested = false;
919 void config_changed (Config::Property prop)
921 /* Instantly save any config changes when using the player GUI */
923 Config::instance()->write_config();
924 } catch (FileError& e) {
925 if (prop != Config::HISTORY) {
929 _("Could not write to config file at %s. Your changes have not been saved."),
930 std_to_wx(e.file().string())
934 } catch (exception& e) {
937 _("Could not write to config file. Your changes have not been saved.")
941 update_from_config (prop);
944 void update_from_config (Config::Property prop)
946 for (int i = 0; i < _history_items; ++i) {
947 delete _file_menu->Remove (ID_file_history + i);
950 if (_history_separator) {
951 _file_menu->Remove (_history_separator);
953 delete _history_separator;
954 _history_separator = nullptr;
956 int pos = _history_position;
958 /* Clear out non-existant history items before we re-build the menu */
959 Config::instance()->clean_player_history ();
960 auto history = Config::instance()->player_history ();
962 if (!history.empty ()) {
963 _history_separator = _file_menu->InsertSeparator (pos++);
966 for (size_t i = 0; i < history.size(); ++i) {
969 s = String::compose ("&%1 %2", i + 1, history[i].string());
971 s = history[i].string();
973 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
976 _history_items = history.size ();
978 if (prop == Config::PLAYER_DEBUG_LOG) {
979 auto p = Config::instance()->player_debug_log_file();
981 dcpomatic_log = make_shared<FileLog>(*p);
983 dcpomatic_log = make_shared<NullLog>();
985 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
989 void set_menu_sensitivity ()
991 _tools_verify->Enable (static_cast<bool>(_film));
992 _file_add_ov->Enable (static_cast<bool>(_film));
993 _file_add_kdm->Enable (static_cast<bool>(_film));
994 _view_cpl->Enable (static_cast<bool>(_film));
997 void start_stop_pressed ()
999 if (_viewer->playing()) {
1006 void go_back_frame ()
1008 _viewer->seek_by (-_viewer->one_video_frame(), true);
1011 void go_forward_frame ()
1013 _viewer->seek_by (_viewer->one_video_frame(), true);
1016 void go_seconds (int s)
1018 _viewer->seek_by (DCPTime::from_seconds(s), true);
1023 _viewer->seek (DCPTime(), true);
1028 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
1031 wxFrame* _dual_screen = nullptr;
1032 bool _update_news_requested = false;
1033 PlayerInformation* _info = nullptr;
1034 Config::PlayerMode _mode;
1035 wxPreferencesEditor* _config_dialog = nullptr;
1036 wxPanel* _overall_panel = nullptr;
1037 wxMenu* _file_menu = nullptr;
1038 wxMenuItem* _view_cpl = nullptr;
1039 wxMenu* _cpl_menu = nullptr;
1040 int _history_items = 0;
1041 int _history_position = 0;
1042 wxMenuItem* _history_separator = nullptr;
1043 shared_ptr<FilmViewer> _viewer;
1044 Controls* _controls;
1045 SystemInformationDialog* _system_information_dialog = nullptr;
1046 std::shared_ptr<Film> _film;
1047 boost::signals2::scoped_connection _config_changed_connection;
1048 boost::signals2::scoped_connection _examine_job_connection;
1049 wxMenuItem* _file_add_ov = nullptr;
1050 wxMenuItem* _file_add_kdm = nullptr;
1051 wxMenuItem* _tools_verify = nullptr;
1052 wxMenuItem* _view_full_screen = nullptr;
1053 wxMenuItem* _view_dual_screen = nullptr;
1054 wxSizer* _main_sizer = nullptr;
1055 PlayerStressTester _stress;
1058 static const wxCmdLineEntryDesc command_line_description[] = {
1059 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1060 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1061 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1062 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1065 class PlayServer : public Server
1068 explicit PlayServer (DOMFrame* frame)
1069 : Server (PLAYER_PLAY_PORT)
1073 void handle (shared_ptr<Socket> socket)
1076 int const length = socket->read_uint32 ();
1077 scoped_array<char> buffer (new char[length]);
1078 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1079 string s (buffer.get());
1080 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1081 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1092 * @brief The magic App class for wxWidgets.
1094 class App : public wxApp
1100 #ifdef DCPOMATIC_LINUX
1109 wxSplashScreen* splash = nullptr;
1111 wxInitAllImageHandlers ();
1113 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1114 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1116 splash = maybe_show_splash ();
1118 SetAppName (_("DCP-o-matic Player"));
1120 if (!wxApp::OnInit()) {
1124 #ifdef DCPOMATIC_LINUX
1125 unsetenv ("UBUNTU_MENUPROXY");
1128 #ifdef DCPOMATIC_OSX
1129 make_foreground_application ();
1132 dcpomatic_setup_path_encoding ();
1134 /* Enable i18n; this will create a Config object
1135 to look for a force-configured language. This Config
1136 object will be wrong, however, because dcpomatic_setup
1137 hasn't yet been called and there aren't any filters etc.
1140 dcpomatic_setup_i18n ();
1142 /* Set things up, including filters etc.
1143 which will now be internationalised correctly.
1147 /* Force the configuration to be re-loaded correctly next
1152 signal_manager = new wxSignalManager (this);
1154 _frame = new DOMFrame ();
1155 SetTopWindow (_frame);
1156 _frame->Maximize ();
1164 auto server = new PlayServer (_frame);
1165 new thread (boost::bind (&PlayServer::run, server));
1166 } catch (std::exception& e) {
1167 /* This is not the end of the world; probably a failure to bind the server socket
1168 * because there's already another player running.
1170 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1173 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1175 _frame->load_dcp (_dcp_to_load);
1176 } catch (exception& e) {
1177 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1183 _frame->load_stress_script (*_stress);
1184 } catch (exception& e) {
1185 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1189 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1191 if (Config::instance()->check_for_updates ()) {
1192 UpdateChecker::instance()->run ();
1195 catch (exception& e)
1200 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1206 void OnInitCmdLine (wxCmdLineParser& parser)
1208 parser.SetDesc (command_line_description);
1209 parser.SetSwitchChars (wxT ("-"));
1212 bool OnCmdLineParsed (wxCmdLineParser& parser)
1214 if (parser.GetParamCount() > 0) {
1215 _dcp_to_load = wx_to_std (parser.GetParam (0));
1219 if (parser.Found("c", &config)) {
1220 Config::override_path = wx_to_std (config);
1223 if (parser.Found("s", &stress)) {
1224 _stress = wx_to_std (stress);
1230 void report_exception ()
1234 } catch (FileError& e) {
1238 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1239 std_to_wx (e.what()),
1240 std_to_wx (e.file().string().c_str ())
1243 } catch (exception& e) {
1247 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1248 std_to_wx (e.what ())
1252 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1256 /* An unhandled exception has occurred inside the main event loop */
1257 bool OnExceptionInMainLoop ()
1259 report_exception ();
1260 /* This will terminate the program */
1264 void OnUnhandledException ()
1266 report_exception ();
1271 signal_manager->ui_idle ();
1274 void config_failed_to_load ()
1276 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1279 void config_warning (string m)
1281 message_dialog (_frame, std_to_wx (m));
1284 DOMFrame* _frame = nullptr;
1285 string _dcp_to_load;
1286 boost::optional<string> _stress;