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->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
201 _viewer->Started.connect (bind(&DOMFrame::playback_started, this, _1));
202 _viewer->Stopped.connect (bind(&DOMFrame::playback_stopped, this, _1));
203 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
204 _info = new PlayerInformation (_overall_panel, _viewer);
205 setup_main_sizer (Config::instance()->player_mode());
207 int accelerators = 12;
209 int accelerators = 11;
212 _stress.setup (this, _controls);
214 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
215 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
216 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
217 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
218 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
219 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
220 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
221 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
222 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
223 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
224 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
225 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
227 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
229 wxAcceleratorTable accel_table (accelerators, accel);
230 SetAcceleratorTable (accel_table);
233 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
234 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
235 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
236 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
237 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
238 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
239 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
240 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
241 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
242 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
243 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
247 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
250 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
255 /* It's important that this is stopped before our frame starts destroying its children,
256 * otherwise UI elements that it depends on will disappear from under it.
261 void setup_main_sizer (Config::PlayerMode mode)
263 _main_sizer->Detach (_viewer->panel());
264 _main_sizer->Detach (_controls);
265 _main_sizer->Detach (_info);
266 if (mode != Config::PLAYER_MODE_DUAL) {
267 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
269 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
270 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
271 _overall_panel->SetSizer (_main_sizer);
272 _overall_panel->Layout ();
275 bool playback_permitted ()
277 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
282 for (auto i: _film->content()) {
283 auto d = dynamic_pointer_cast<DCPContent>(i);
284 if (d && !d->kdm_timing_window_valid()) {
290 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
296 void playback_started (DCPTime time)
298 /* XXX: this only logs the first piece of content; probably should be each piece? */
299 if (_film->content().empty()) {
303 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
305 DCPExaminer ex (dcp, true);
306 shared_ptr<dcp::CPL> playing_cpl;
307 for (auto i: ex.cpls()) {
308 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
312 DCPOMATIC_ASSERT (playing_cpl);
316 "playback-started %s %s %s",
317 time.timecode(_film->video_frame_rate()).c_str(),
318 dcp->directories().front().string().c_str(),
319 playing_cpl->annotation_text().get_value_or("").c_str()
324 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(_film->content().front());
328 "playback-started %s %s",
329 time.timecode(_film->video_frame_rate()).c_str(),
330 ffmpeg->path(0).string().c_str()
336 void playback_stopped (DCPTime time)
338 _controls->log (wxString::Format("playback-stopped %s", time.timecode(_film->video_frame_rate()).c_str()));
342 void too_many_frames_dropped ()
344 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
348 NagDialog::maybe_nag (
350 Config::NAG_TOO_MANY_DROPPED_FRAMES,
351 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
352 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
353 "You may be able to improve player performance by:\n"
354 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
355 "• using a more powerful computer.\n"
360 void set_decode_reduction (optional<int> reduction)
362 _viewer->set_dcp_decode_reduction (reduction);
363 _info->triggered_update ();
364 Config::instance()->set_decode_reduction (reduction);
367 void load_dcp (boost::filesystem::path dir)
369 DCPOMATIC_ASSERT (_film);
373 _stress.set_suspended (true);
375 auto dcp = make_shared<DCPContent>(dir);
376 auto job = make_shared<ExamineContentJob>(_film, dcp);
377 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
378 JobManager::instance()->add (job);
379 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
380 if (!ok || !report_errors_from_last_job(this)) {
383 Config::instance()->add_to_player_history (dir);
384 } catch (ProjectFolderError &) {
387 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
389 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
390 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
393 } catch (dcp::ReadError& e) {
394 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
395 } catch (DCPError& e) {
396 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
400 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
402 auto job = weak_job.lock ();
403 if (!job || !job->finished_ok()) {
407 auto content = weak_content.lock ();
412 _film->add_content (content);
413 _stress.set_suspended (false);
416 void reset_film_weak (weak_ptr<Film> weak_film)
418 auto film = weak_film.lock ();
424 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
427 _film->set_tolerant (true);
428 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
429 _viewer->set_film (_film);
430 _controls->set_film (_film);
431 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
432 _info->triggered_update ();
435 void film_changed (ChangeType type, Film::Property property)
437 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
441 if (_viewer->playing ()) {
445 /* Start off as Flat */
446 _film->set_container (Ratio::from_id("185"));
448 for (auto i: _film->content()) {
449 auto dcp = dynamic_pointer_cast<DCPContent>(i);
451 for (auto j: i->text) {
456 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
457 if (r->id() == "239") {
458 /* Any scope content means we use scope */
459 _film->set_container(r);
463 /* Any 3D content means we use 3D mode */
464 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
465 _film->set_three_d (true);
469 _viewer->seek (DCPTime(), true);
470 _info->triggered_update ();
472 set_menu_sensitivity ();
474 auto old = _cpl_menu->GetMenuItems();
475 for (auto const& i: old) {
476 _cpl_menu->Remove (i);
479 if (_film->content().size() == 1) {
480 /* Offer a CPL menu */
481 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
483 DCPExaminer ex (first, true);
484 int id = ID_view_cpl;
485 for (auto i: ex.cpls()) {
486 auto j = _cpl_menu->AppendRadioItem(
488 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
490 j->Check(!first->cpl() || i->id() == *first->cpl());
497 void load_stress_script (boost::filesystem::path path)
499 _stress.load_script (path);
504 void examine_content ()
506 DCPOMATIC_ASSERT (_film);
507 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
508 DCPOMATIC_ASSERT (dcp);
509 dcp->examine (_film, shared_ptr<Job>());
511 /* Examining content re-creates the TextContent objects, so we must re-enable them */
512 for (auto i: dcp->text) {
517 bool report_errors_from_last_job (wxWindow* parent) const
519 auto jm = JobManager::instance ();
521 DCPOMATIC_ASSERT (!jm->get().empty());
523 auto last = jm->get().back();
524 if (last->finished_in_error()) {
525 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()));
532 void setup_menu (wxMenuBar* m)
534 _file_menu = new wxMenu;
535 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
536 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
537 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
539 _history_position = _file_menu->GetMenuItems().GetCount();
541 _file_menu->AppendSeparator ();
542 _file_menu->Append (ID_file_close, _("&Close"));
543 _file_menu->AppendSeparator ();
546 _file_menu->Append (wxID_EXIT, _("&Exit"));
548 _file_menu->Append (wxID_EXIT, _("&Quit"));
552 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
554 auto edit = new wxMenu;
555 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
558 prefs->Enable (Config::instance()->have_write_permission());
560 _cpl_menu = new wxMenu;
562 auto view = new wxMenu;
563 auto c = Config::instance()->decode_reduction();
564 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
565 view->AppendSeparator();
566 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
567 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
569 view->AppendSeparator();
570 view->Append(ID_view_closed_captions, _("Closed captions..."));
571 view->AppendSeparator();
572 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
573 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
574 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
575 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
577 auto tools = new wxMenu;
578 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
579 tools->AppendSeparator ();
580 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
581 tools->Append (ID_tools_timing, _("Timing..."));
582 tools->Append (ID_tools_system_information, _("System information..."));
584 auto help = new wxMenu;
586 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
588 help->Append (wxID_ABOUT, _("About"));
590 help->Append (ID_help_report_a_problem, _("Report a problem..."));
592 m->Append (_file_menu, _("&File"));
594 m->Append (edit, _("&Edit"));
596 m->Append (view, _("&View"));
597 m->Append (tools, _("&Tools"));
598 m->Append (help, _("&Help"));
603 auto d = wxStandardPaths::Get().GetDocumentsDir();
604 if (Config::instance()->last_player_load_directory()) {
605 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
608 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
613 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
614 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
621 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
623 Config::instance()->set_last_player_load_directory (dcp.parent_path());
631 auto c = new wxDirDialog (
633 _("Select DCP to open as OV"),
634 wxStandardPaths::Get().GetDocumentsDir(),
635 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
641 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
642 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
649 DCPOMATIC_ASSERT (_film);
650 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
651 DCPOMATIC_ASSERT (dcp);
652 dcp->add_ov (wx_to_std(c->GetPath()));
653 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
654 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
655 if (!ok || !report_errors_from_last_job(this)) {
658 for (auto i: dcp->text) {
662 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
664 _film->set_container(r);
670 _info->triggered_update ();
675 auto d = new wxFileDialog (this, _("Select KDM"));
677 if (d->ShowModal() == wxID_OK) {
678 DCPOMATIC_ASSERT (_film);
679 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
680 DCPOMATIC_ASSERT (dcp);
683 _viewer->set_coalesce_player_changes (true);
684 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
686 _viewer->set_coalesce_player_changes (false);
688 } catch (exception& e) {
689 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
696 _info->triggered_update ();
699 void file_history (wxCommandEvent& event)
701 auto history = Config::instance()->player_history ();
702 int n = event.GetId() - ID_file_history;
703 if (n >= 0 && n < static_cast<int> (history.size ())) {
705 load_dcp (history[n]);
706 } catch (exception& e) {
707 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
715 _info->triggered_update ();
716 set_menu_sensitivity ();
724 void edit_preferences ()
726 if (!Config::instance()->have_write_permission()) {
730 if (!_config_dialog) {
731 _config_dialog = create_player_config_dialog ();
733 _config_dialog->Show (this);
736 void view_cpl (wxCommandEvent& ev)
738 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
739 DCPOMATIC_ASSERT (dcp);
740 DCPExaminer ex (dcp, true);
741 int id = ev.GetId() - ID_view_cpl;
742 DCPOMATIC_ASSERT (id >= 0);
743 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
744 auto cpls = ex.cpls();
745 auto i = cpls.begin();
751 _viewer->set_coalesce_player_changes (true);
752 dcp->set_cpl ((*i)->id());
754 _viewer->set_coalesce_player_changes (false);
756 _info->triggered_update ();
759 void view_full_screen ()
761 if (_mode == Config::PLAYER_MODE_FULL) {
762 _mode = Config::PLAYER_MODE_WINDOW;
764 _mode = Config::PLAYER_MODE_FULL;
770 void view_dual_screen ()
772 if (_mode == Config::PLAYER_MODE_DUAL) {
773 _mode = Config::PLAYER_MODE_WINDOW;
775 _mode = Config::PLAYER_MODE_DUAL;
783 if (_view_full_screen) {
784 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
786 if (_view_dual_screen) {
787 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
793 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
794 _info->Show (_mode != Config::PLAYER_MODE_FULL);
795 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
796 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
797 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
799 if (_mode == Config::PLAYER_MODE_DUAL) {
800 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
801 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
802 _dual_screen->ShowFullScreen (true);
803 _viewer->panel()->Reparent (_dual_screen);
804 _dual_screen->Show ();
805 if (wxDisplay::GetCount() > 1) {
806 switch (Config::instance()->image_display()) {
808 _dual_screen->Move (0, 0);
809 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
812 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
813 // (0, 0) doesn't seem to work for some strange reason
820 _viewer->panel()->Reparent (_overall_panel);
821 _dual_screen->Destroy ();
826 setup_main_sizer (_mode);
829 void view_closed_captions ()
831 _viewer->show_closed_captions ();
836 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
837 DCPOMATIC_ASSERT (dcp);
839 auto job = make_shared<VerifyDCPJob>(dcp->directories());
840 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
841 bool const completed = progress->run (job);
842 progress->Destroy ();
847 auto d = new VerifyDCPDialog (this, job);
852 void tools_check_for_updates ()
854 UpdateChecker::instance()->run ();
855 _update_news_requested = true;
860 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
865 void tools_system_information ()
867 if (!_system_information_dialog) {
868 _system_information_dialog = new SystemInformationDialog (this, _viewer);
871 _system_information_dialog->Show ();
876 auto d = new AboutDialog (this);
881 void help_report_a_problem ()
883 auto d = new ReportProblemDialog (this);
884 if (d->ShowModal () == wxID_OK) {
890 void update_checker_state_changed ()
892 auto uc = UpdateChecker::instance ();
894 bool const announce =
895 _update_news_requested ||
896 (uc->stable() && Config::instance()->check_for_updates()) ||
897 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
899 _update_news_requested = false;
905 if (uc->state() == UpdateChecker::State::YES) {
906 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
907 dialog->ShowModal ();
909 } else if (uc->state() == UpdateChecker::State::FAILED) {
910 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
912 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
915 _update_news_requested = false;
918 void config_changed (Config::Property prop)
920 /* Instantly save any config changes when using the player GUI */
922 Config::instance()->write_config();
923 } catch (FileError& e) {
924 if (prop != Config::HISTORY) {
928 _("Could not write to config file at %s. Your changes have not been saved."),
929 std_to_wx(e.file().string())
933 } catch (exception& e) {
936 _("Could not write to config file. Your changes have not been saved.")
940 update_from_config (prop);
943 void update_from_config (Config::Property prop)
945 for (int i = 0; i < _history_items; ++i) {
946 delete _file_menu->Remove (ID_file_history + i);
949 if (_history_separator) {
950 _file_menu->Remove (_history_separator);
952 delete _history_separator;
953 _history_separator = nullptr;
955 int pos = _history_position;
957 /* Clear out non-existant history items before we re-build the menu */
958 Config::instance()->clean_player_history ();
959 auto history = Config::instance()->player_history ();
961 if (!history.empty ()) {
962 _history_separator = _file_menu->InsertSeparator (pos++);
965 for (size_t i = 0; i < history.size(); ++i) {
968 s = String::compose ("&%1 %2", i + 1, history[i].string());
970 s = history[i].string();
972 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
975 _history_items = history.size ();
977 if (prop == Config::PLAYER_DEBUG_LOG) {
978 auto p = Config::instance()->player_debug_log_file();
980 dcpomatic_log = make_shared<FileLog>(*p);
982 dcpomatic_log = make_shared<NullLog>();
984 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
988 void set_menu_sensitivity ()
990 _tools_verify->Enable (static_cast<bool>(_film));
991 _file_add_ov->Enable (static_cast<bool>(_film));
992 _file_add_kdm->Enable (static_cast<bool>(_film));
993 _view_cpl->Enable (static_cast<bool>(_film));
996 void start_stop_pressed ()
998 if (_viewer->playing()) {
1005 void go_back_frame ()
1007 _viewer->seek_by (-_viewer->one_video_frame(), true);
1010 void go_forward_frame ()
1012 _viewer->seek_by (_viewer->one_video_frame(), true);
1015 void go_seconds (int s)
1017 _viewer->seek_by (DCPTime::from_seconds(s), true);
1022 _viewer->seek (DCPTime(), true);
1027 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
1030 wxFrame* _dual_screen = nullptr;
1031 bool _update_news_requested = false;
1032 PlayerInformation* _info = nullptr;
1033 Config::PlayerMode _mode;
1034 wxPreferencesEditor* _config_dialog = nullptr;
1035 wxPanel* _overall_panel = nullptr;
1036 wxMenu* _file_menu = nullptr;
1037 wxMenuItem* _view_cpl = nullptr;
1038 wxMenu* _cpl_menu = nullptr;
1039 int _history_items = 0;
1040 int _history_position = 0;
1041 wxMenuItem* _history_separator = nullptr;
1042 shared_ptr<FilmViewer> _viewer;
1043 Controls* _controls;
1044 SystemInformationDialog* _system_information_dialog = nullptr;
1045 std::shared_ptr<Film> _film;
1046 boost::signals2::scoped_connection _config_changed_connection;
1047 boost::signals2::scoped_connection _examine_job_connection;
1048 wxMenuItem* _file_add_ov = nullptr;
1049 wxMenuItem* _file_add_kdm = nullptr;
1050 wxMenuItem* _tools_verify = nullptr;
1051 wxMenuItem* _view_full_screen = nullptr;
1052 wxMenuItem* _view_dual_screen = nullptr;
1053 wxSizer* _main_sizer = nullptr;
1054 PlayerStressTester _stress;
1057 static const wxCmdLineEntryDesc command_line_description[] = {
1058 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1059 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1060 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1061 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1064 class PlayServer : public Server
1067 explicit PlayServer (DOMFrame* frame)
1068 : Server (PLAYER_PLAY_PORT)
1072 void handle (shared_ptr<Socket> socket)
1075 int const length = socket->read_uint32 ();
1076 scoped_array<char> buffer (new char[length]);
1077 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1078 string s (buffer.get());
1079 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1080 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1091 * @brief The magic App class for wxWidgets.
1093 class App : public wxApp
1099 #ifdef DCPOMATIC_LINUX
1108 wxSplashScreen* splash = nullptr;
1110 wxInitAllImageHandlers ();
1112 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1113 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1115 splash = maybe_show_splash ();
1117 SetAppName (_("DCP-o-matic Player"));
1119 if (!wxApp::OnInit()) {
1123 #ifdef DCPOMATIC_LINUX
1124 unsetenv ("UBUNTU_MENUPROXY");
1127 #ifdef DCPOMATIC_OSX
1128 make_foreground_application ();
1131 dcpomatic_setup_path_encoding ();
1133 /* Enable i18n; this will create a Config object
1134 to look for a force-configured language. This Config
1135 object will be wrong, however, because dcpomatic_setup
1136 hasn't yet been called and there aren't any filters etc.
1139 dcpomatic_setup_i18n ();
1141 /* Set things up, including filters etc.
1142 which will now be internationalised correctly.
1146 /* Force the configuration to be re-loaded correctly next
1151 signal_manager = new wxSignalManager (this);
1153 _frame = new DOMFrame ();
1154 SetTopWindow (_frame);
1155 _frame->Maximize ();
1163 auto server = new PlayServer (_frame);
1164 new thread (boost::bind (&PlayServer::run, server));
1165 } catch (std::exception& e) {
1166 /* This is not the end of the world; probably a failure to bind the server socket
1167 * because there's already another player running.
1169 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1172 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1174 _frame->load_dcp (_dcp_to_load);
1175 } catch (exception& e) {
1176 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1182 _frame->load_stress_script (*_stress);
1183 } catch (exception& e) {
1184 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1188 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1190 if (Config::instance()->check_for_updates ()) {
1191 UpdateChecker::instance()->run ();
1194 catch (exception& e)
1199 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1205 void OnInitCmdLine (wxCmdLineParser& parser)
1207 parser.SetDesc (command_line_description);
1208 parser.SetSwitchChars (wxT ("-"));
1211 bool OnCmdLineParsed (wxCmdLineParser& parser)
1213 if (parser.GetParamCount() > 0) {
1214 _dcp_to_load = wx_to_std (parser.GetParam (0));
1218 if (parser.Found("c", &config)) {
1219 Config::override_path = wx_to_std (config);
1222 if (parser.Found("s", &stress)) {
1223 _stress = wx_to_std (stress);
1229 void report_exception ()
1233 } catch (FileError& e) {
1237 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1238 std_to_wx (e.what()),
1239 std_to_wx (e.file().string().c_str ())
1242 } catch (exception& e) {
1246 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1247 std_to_wx (e.what ())
1251 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1255 /* An unhandled exception has occurred inside the main event loop */
1256 bool OnExceptionInMainLoop ()
1258 report_exception ();
1259 /* This will terminate the program */
1263 void OnUnhandledException ()
1265 report_exception ();
1270 signal_manager->ui_idle ();
1273 void config_failed_to_load ()
1275 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1278 void config_warning (string m)
1280 message_dialog (_frame, std_to_wx (m));
1283 DOMFrame* _frame = nullptr;
1284 string _dcp_to_load;
1285 boost::optional<string> _stress;