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 (0, -1, _("DCP-o-matic Player"))
144 , _update_news_requested (false)
146 , _mode (Config::instance()->player_mode())
150 , _history_position (0)
151 , _history_separator (0)
152 , _system_information_dialog (0)
153 , _view_full_screen (0)
154 , _view_dual_screen (0)
155 , _main_sizer (new wxBoxSizer (wxVERTICAL))
157 dcpomatic_log = make_shared<NullLog>();
159 #if defined(DCPOMATIC_WINDOWS)
160 maybe_open_console ();
161 cout << "DCP-o-matic Player is starting." << "\n";
164 auto bar = new wxMenuBar;
166 set_menu_sensitivity ();
169 #ifdef DCPOMATIC_WINDOWS
170 SetIcon (wxIcon (std_to_wx ("id")));
173 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
174 update_from_config (Config::PLAYER_DEBUG_LOG);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
181 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
185 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
186 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
187 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
188 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
189 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
190 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
191 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
192 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
193 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
194 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
195 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
197 /* Use a panel as the only child of the Frame so that we avoid
198 the dark-grey background on Windows.
200 _overall_panel = new wxPanel (this, wxID_ANY);
202 _viewer.reset (new FilmViewer (_overall_panel));
203 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
204 auto pc = new PlaylistControls (_overall_panel, _viewer);
206 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
208 _controls = new StandardControls (_overall_panel, _viewer, false);
210 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
211 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
212 _viewer->Started.connect (bind(&DOMFrame::playback_started, this, _1));
213 _viewer->Stopped.connect (bind(&DOMFrame::playback_stopped, this, _1));
214 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
215 _info = new PlayerInformation (_overall_panel, _viewer);
216 setup_main_sizer (Config::instance()->player_mode());
218 int accelerators = 12;
220 int accelerators = 11;
223 _stress.setup (this, _controls);
225 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
226 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
227 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
228 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
229 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
230 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
231 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
232 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
233 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
234 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
235 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
236 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
238 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
240 wxAcceleratorTable accel_table (accelerators, accel);
241 SetAcceleratorTable (accel_table);
244 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
245 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
246 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
247 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
248 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
249 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
250 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
251 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
252 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
253 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
254 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
258 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
261 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
266 /* It's important that this is stopped before our frame starts destroying its children,
267 * otherwise UI elements that it depends on will disappear from under it.
272 void setup_main_sizer (Config::PlayerMode mode)
274 _main_sizer->Detach (_viewer->panel());
275 _main_sizer->Detach (_controls);
276 _main_sizer->Detach (_info);
277 if (mode != Config::PLAYER_MODE_DUAL) {
278 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
280 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
281 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
282 _overall_panel->SetSizer (_main_sizer);
283 _overall_panel->Layout ();
286 bool playback_permitted ()
288 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
293 for (auto i: _film->content()) {
294 auto d = dynamic_pointer_cast<DCPContent>(i);
295 if (d && !d->kdm_timing_window_valid()) {
301 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
307 void playback_started (DCPTime time)
309 /* XXX: this only logs the first piece of content; probably should be each piece? */
310 if (_film->content().empty()) {
314 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
316 DCPExaminer ex (dcp, true);
317 shared_ptr<dcp::CPL> playing_cpl;
318 for (auto i: ex.cpls()) {
319 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
323 DCPOMATIC_ASSERT (playing_cpl);
327 "playback-started %s %s %s",
328 time.timecode(_film->video_frame_rate()).c_str(),
329 dcp->directories().front().string().c_str(),
330 playing_cpl->annotation_text().get_value_or("").c_str()
335 auto ffmpeg = dynamic_pointer_cast<FFmpegContent>(_film->content().front());
339 "playback-started %s %s",
340 time.timecode(_film->video_frame_rate()).c_str(),
341 ffmpeg->path(0).string().c_str()
347 void playback_stopped (DCPTime time)
349 _controls->log (wxString::Format("playback-stopped %s", time.timecode(_film->video_frame_rate()).c_str()));
353 void too_many_frames_dropped ()
355 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
359 NagDialog::maybe_nag (
361 Config::NAG_TOO_MANY_DROPPED_FRAMES,
362 _("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
363 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
364 "You may be able to improve player performance by:\n"
365 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
366 "• using a more powerful computer.\n"
371 void set_decode_reduction (optional<int> reduction)
373 _viewer->set_dcp_decode_reduction (reduction);
374 _info->triggered_update ();
375 Config::instance()->set_decode_reduction (reduction);
378 void load_dcp (boost::filesystem::path dir)
380 DCPOMATIC_ASSERT (_film);
384 _stress.set_suspended (true);
386 auto dcp = make_shared<DCPContent>(dir);
387 auto job = make_shared<ExamineContentJob>(_film, dcp);
388 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
389 JobManager::instance()->add (job);
390 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
391 if (!ok || !report_errors_from_last_job(this)) {
394 Config::instance()->add_to_player_history (dir);
395 } catch (ProjectFolderError &) {
398 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
400 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
401 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
404 } catch (dcp::ReadError& e) {
405 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
406 } catch (DCPError& e) {
407 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
411 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
413 auto job = weak_job.lock ();
414 if (!job || !job->finished_ok()) {
418 auto content = weak_content.lock ();
423 _film->add_content (content);
424 _stress.set_suspended (false);
427 void reset_film_weak (weak_ptr<Film> weak_film)
429 auto film = weak_film.lock ();
435 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
438 _film->set_tolerant (true);
439 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
440 _viewer->set_film (_film);
441 _controls->set_film (_film);
442 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
443 _info->triggered_update ();
446 void film_changed (ChangeType type, Film::Property property)
448 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
452 if (_viewer->playing ()) {
456 /* Start off as Flat */
457 _film->set_container (Ratio::from_id("185"));
459 for (auto i: _film->content()) {
460 auto dcp = dynamic_pointer_cast<DCPContent>(i);
462 for (auto j: i->text) {
467 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
468 if (r->id() == "239") {
469 /* Any scope content means we use scope */
470 _film->set_container(r);
474 /* Any 3D content means we use 3D mode */
475 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
476 _film->set_three_d (true);
480 _viewer->seek (DCPTime(), true);
481 _info->triggered_update ();
483 set_menu_sensitivity ();
485 auto old = _cpl_menu->GetMenuItems();
486 for (auto const& i: old) {
487 _cpl_menu->Remove (i);
490 if (_film->content().size() == 1) {
491 /* Offer a CPL menu */
492 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
494 DCPExaminer ex (first, true);
495 int id = ID_view_cpl;
496 for (auto i: ex.cpls()) {
497 auto j = _cpl_menu->AppendRadioItem(
499 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
501 j->Check(!first->cpl() || i->id() == *first->cpl());
508 void load_stress_script (boost::filesystem::path path)
510 _stress.load_script (path);
515 void examine_content ()
517 DCPOMATIC_ASSERT (_film);
518 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
519 DCPOMATIC_ASSERT (dcp);
520 dcp->examine (_film, shared_ptr<Job>());
522 /* Examining content re-creates the TextContent objects, so we must re-enable them */
523 for (auto i: dcp->text) {
528 bool report_errors_from_last_job (wxWindow* parent) const
530 auto jm = JobManager::instance ();
532 DCPOMATIC_ASSERT (!jm->get().empty());
534 auto last = jm->get().back();
535 if (last->finished_in_error()) {
536 error_dialog(parent, wxString::Format(_("Could not load DCP.\n\n%s."), std_to_wx(last->error_summary()).data()), std_to_wx(last->error_details()));
543 void setup_menu (wxMenuBar* m)
545 _file_menu = new wxMenu;
546 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
547 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
548 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
550 _history_position = _file_menu->GetMenuItems().GetCount();
552 _file_menu->AppendSeparator ();
553 _file_menu->Append (ID_file_close, _("&Close"));
554 _file_menu->AppendSeparator ();
557 _file_menu->Append (wxID_EXIT, _("&Exit"));
559 _file_menu->Append (wxID_EXIT, _("&Quit"));
563 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
565 auto edit = new wxMenu;
566 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
569 prefs->Enable (Config::instance()->have_write_permission());
571 _cpl_menu = new wxMenu;
573 auto view = new wxMenu;
574 auto c = Config::instance()->decode_reduction();
575 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
576 view->AppendSeparator();
577 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
578 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
580 view->AppendSeparator();
581 view->Append(ID_view_closed_captions, _("Closed captions..."));
582 view->AppendSeparator();
583 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
584 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
585 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
586 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
588 auto tools = new wxMenu;
589 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
590 tools->AppendSeparator ();
591 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
592 tools->Append (ID_tools_timing, _("Timing..."));
593 tools->Append (ID_tools_system_information, _("System information..."));
595 auto help = new wxMenu;
597 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
599 help->Append (wxID_ABOUT, _("About"));
601 help->Append (ID_help_report_a_problem, _("Report a problem..."));
603 m->Append (_file_menu, _("&File"));
605 m->Append (edit, _("&Edit"));
607 m->Append (view, _("&View"));
608 m->Append (tools, _("&Tools"));
609 m->Append (help, _("&Help"));
614 auto d = wxStandardPaths::Get().GetDocumentsDir();
615 if (Config::instance()->last_player_load_directory()) {
616 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
619 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
624 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
625 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
632 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
634 Config::instance()->set_last_player_load_directory (dcp.parent_path());
642 auto c = new wxDirDialog (
644 _("Select DCP to open as OV"),
645 wxStandardPaths::Get().GetDocumentsDir(),
646 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
652 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
653 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
660 DCPOMATIC_ASSERT (_film);
661 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
662 DCPOMATIC_ASSERT (dcp);
663 dcp->add_ov (wx_to_std(c->GetPath()));
664 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
665 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
666 if (!ok || !report_errors_from_last_job(this)) {
669 for (auto i: dcp->text) {
673 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
675 _film->set_container(r);
681 _info->triggered_update ();
686 auto d = new wxFileDialog (this, _("Select KDM"));
688 if (d->ShowModal() == wxID_OK) {
689 DCPOMATIC_ASSERT (_film);
690 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
691 DCPOMATIC_ASSERT (dcp);
694 _viewer->set_coalesce_player_changes (true);
695 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
697 _viewer->set_coalesce_player_changes (false);
699 } catch (exception& e) {
700 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
707 _info->triggered_update ();
710 void file_history (wxCommandEvent& event)
712 auto history = Config::instance()->player_history ();
713 int n = event.GetId() - ID_file_history;
714 if (n >= 0 && n < static_cast<int> (history.size ())) {
716 load_dcp (history[n]);
717 } catch (exception& e) {
718 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
726 _info->triggered_update ();
727 set_menu_sensitivity ();
735 void edit_preferences ()
737 if (!Config::instance()->have_write_permission()) {
741 if (!_config_dialog) {
742 _config_dialog = create_player_config_dialog ();
744 _config_dialog->Show (this);
747 void view_cpl (wxCommandEvent& ev)
749 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
750 DCPOMATIC_ASSERT (dcp);
751 DCPExaminer ex (dcp, true);
752 int id = ev.GetId() - ID_view_cpl;
753 DCPOMATIC_ASSERT (id >= 0);
754 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
755 auto cpls = ex.cpls();
756 auto i = cpls.begin();
762 _viewer->set_coalesce_player_changes (true);
763 dcp->set_cpl ((*i)->id());
765 _viewer->set_coalesce_player_changes (false);
767 _info->triggered_update ();
770 void view_full_screen ()
772 if (_mode == Config::PLAYER_MODE_FULL) {
773 _mode = Config::PLAYER_MODE_WINDOW;
775 _mode = Config::PLAYER_MODE_FULL;
781 void view_dual_screen ()
783 if (_mode == Config::PLAYER_MODE_DUAL) {
784 _mode = Config::PLAYER_MODE_WINDOW;
786 _mode = Config::PLAYER_MODE_DUAL;
794 if (_view_full_screen) {
795 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
797 if (_view_dual_screen) {
798 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
804 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
805 _info->Show (_mode != Config::PLAYER_MODE_FULL);
806 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
807 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
808 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
810 if (_mode == Config::PLAYER_MODE_DUAL) {
811 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
812 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
813 _dual_screen->ShowFullScreen (true);
814 _viewer->panel()->Reparent (_dual_screen);
815 _dual_screen->Show ();
816 if (wxDisplay::GetCount() > 1) {
817 switch (Config::instance()->image_display()) {
819 _dual_screen->Move (0, 0);
820 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
823 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
824 // (0, 0) doesn't seem to work for some strange reason
831 _viewer->panel()->Reparent (_overall_panel);
832 _dual_screen->Destroy ();
837 setup_main_sizer (_mode);
840 void view_closed_captions ()
842 _viewer->show_closed_captions ();
847 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
848 DCPOMATIC_ASSERT (dcp);
850 auto job = make_shared<VerifyDCPJob>(dcp->directories());
851 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
852 bool const completed = progress->run (job);
853 progress->Destroy ();
858 auto d = new VerifyDCPDialog (this, job);
863 void tools_check_for_updates ()
865 UpdateChecker::instance()->run ();
866 _update_news_requested = true;
871 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
876 void tools_system_information ()
878 if (!_system_information_dialog) {
879 _system_information_dialog = new SystemInformationDialog (this, _viewer);
882 _system_information_dialog->Show ();
887 auto d = new AboutDialog (this);
892 void help_report_a_problem ()
894 auto d = new ReportProblemDialog (this);
895 if (d->ShowModal () == wxID_OK) {
901 void update_checker_state_changed ()
903 auto uc = UpdateChecker::instance ();
905 bool const announce =
906 _update_news_requested ||
907 (uc->stable() && Config::instance()->check_for_updates()) ||
908 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
910 _update_news_requested = false;
916 if (uc->state() == UpdateChecker::State::YES) {
917 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
918 dialog->ShowModal ();
920 } else if (uc->state() == UpdateChecker::State::FAILED) {
921 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
923 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
926 _update_news_requested = false;
929 void config_changed (Config::Property prop)
931 /* Instantly save any config changes when using the player GUI */
933 Config::instance()->write_config();
934 } catch (FileError& e) {
935 if (prop != Config::HISTORY) {
939 _("Could not write to config file at %s. Your changes have not been saved."),
940 std_to_wx(e.file().string())
944 } catch (exception& e) {
947 _("Could not write to config file. Your changes have not been saved.")
951 update_from_config (prop);
954 void update_from_config (Config::Property prop)
956 for (int i = 0; i < _history_items; ++i) {
957 delete _file_menu->Remove (ID_file_history + i);
960 if (_history_separator) {
961 _file_menu->Remove (_history_separator);
963 delete _history_separator;
964 _history_separator = nullptr;
966 int pos = _history_position;
968 /* Clear out non-existant history items before we re-build the menu */
969 Config::instance()->clean_player_history ();
970 auto history = Config::instance()->player_history ();
972 if (!history.empty ()) {
973 _history_separator = _file_menu->InsertSeparator (pos++);
976 for (size_t i = 0; i < history.size(); ++i) {
979 s = String::compose ("&%1 %2", i + 1, history[i].string());
981 s = history[i].string();
983 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
986 _history_items = history.size ();
988 if (prop == Config::PLAYER_DEBUG_LOG) {
989 auto p = Config::instance()->player_debug_log_file();
991 dcpomatic_log = make_shared<FileLog>(*p);
993 dcpomatic_log = make_shared<NullLog>();
995 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
999 void set_menu_sensitivity ()
1001 _tools_verify->Enable (static_cast<bool>(_film));
1002 _file_add_ov->Enable (static_cast<bool>(_film));
1003 _file_add_kdm->Enable (static_cast<bool>(_film));
1004 _view_cpl->Enable (static_cast<bool>(_film));
1007 void start_stop_pressed ()
1009 if (_viewer->playing()) {
1016 void go_back_frame ()
1018 _viewer->seek_by (-_viewer->one_video_frame(), true);
1021 void go_forward_frame ()
1023 _viewer->seek_by (_viewer->one_video_frame(), true);
1026 void go_seconds (int s)
1028 _viewer->seek_by (DCPTime::from_seconds(s), true);
1033 _viewer->seek (DCPTime(), true);
1038 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
1041 wxFrame* _dual_screen;
1042 bool _update_news_requested;
1043 PlayerInformation* _info;
1044 Config::PlayerMode _mode;
1045 wxPreferencesEditor* _config_dialog;
1046 wxPanel* _overall_panel;
1048 wxMenuItem* _view_cpl;
1051 int _history_position;
1052 wxMenuItem* _history_separator;
1053 shared_ptr<FilmViewer> _viewer;
1054 Controls* _controls;
1055 SystemInformationDialog* _system_information_dialog;
1056 std::shared_ptr<Film> _film;
1057 boost::signals2::scoped_connection _config_changed_connection;
1058 boost::signals2::scoped_connection _examine_job_connection;
1059 wxMenuItem* _file_add_ov;
1060 wxMenuItem* _file_add_kdm;
1061 wxMenuItem* _tools_verify;
1062 wxMenuItem* _view_full_screen;
1063 wxMenuItem* _view_dual_screen;
1064 wxSizer* _main_sizer;
1065 PlayerStressTester _stress;
1068 static const wxCmdLineEntryDesc command_line_description[] = {
1069 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1070 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1071 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1072 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1075 class PlayServer : public Server
1078 explicit PlayServer (DOMFrame* frame)
1079 : Server (PLAYER_PLAY_PORT)
1083 void handle (shared_ptr<Socket> socket)
1086 int const length = socket->read_uint32 ();
1087 scoped_array<char> buffer (new char[length]);
1088 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1089 string s (buffer.get());
1090 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1091 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1102 * @brief The magic App class for wxWidgets.
1104 class App : public wxApp
1111 #ifdef DCPOMATIC_LINUX
1120 wxSplashScreen* splash = 0;
1122 wxInitAllImageHandlers ();
1124 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1125 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1127 splash = maybe_show_splash ();
1129 SetAppName (_("DCP-o-matic Player"));
1131 if (!wxApp::OnInit()) {
1135 #ifdef DCPOMATIC_LINUX
1136 unsetenv ("UBUNTU_MENUPROXY");
1139 #ifdef DCPOMATIC_OSX
1140 make_foreground_application ();
1143 dcpomatic_setup_path_encoding ();
1145 /* Enable i18n; this will create a Config object
1146 to look for a force-configured language. This Config
1147 object will be wrong, however, because dcpomatic_setup
1148 hasn't yet been called and there aren't any filters etc.
1151 dcpomatic_setup_i18n ();
1153 /* Set things up, including filters etc.
1154 which will now be internationalised correctly.
1158 /* Force the configuration to be re-loaded correctly next
1163 signal_manager = new wxSignalManager (this);
1165 _frame = new DOMFrame ();
1166 SetTopWindow (_frame);
1167 _frame->Maximize ();
1175 auto server = new PlayServer (_frame);
1176 new thread (boost::bind (&PlayServer::run, server));
1177 } catch (std::exception& e) {
1178 /* This is not the end of the world; probably a failure to bind the server socket
1179 * because there's already another player running.
1181 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1184 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1186 _frame->load_dcp (_dcp_to_load);
1187 } catch (exception& e) {
1188 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1194 _frame->load_stress_script (*_stress);
1195 } catch (exception& e) {
1196 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1200 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1202 if (Config::instance()->check_for_updates ()) {
1203 UpdateChecker::instance()->run ();
1206 catch (exception& e)
1211 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1217 void OnInitCmdLine (wxCmdLineParser& parser)
1219 parser.SetDesc (command_line_description);
1220 parser.SetSwitchChars (wxT ("-"));
1223 bool OnCmdLineParsed (wxCmdLineParser& parser)
1225 if (parser.GetParamCount() > 0) {
1226 _dcp_to_load = wx_to_std (parser.GetParam (0));
1230 if (parser.Found("c", &config)) {
1231 Config::override_path = wx_to_std (config);
1234 if (parser.Found("s", &stress)) {
1235 _stress = wx_to_std (stress);
1241 void report_exception ()
1245 } catch (FileError& e) {
1249 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1250 std_to_wx (e.what()),
1251 std_to_wx (e.file().string().c_str ())
1254 } catch (exception& e) {
1258 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1259 std_to_wx (e.what ())
1263 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1267 /* An unhandled exception has occurred inside the main event loop */
1268 bool OnExceptionInMainLoop ()
1270 report_exception ();
1271 /* This will terminate the program */
1275 void OnUnhandledException ()
1277 report_exception ();
1282 signal_manager->ui_idle ();
1285 void config_failed_to_load ()
1287 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1290 void config_warning (string m)
1292 message_dialog (_frame, std_to_wx (m));
1296 string _dcp_to_load;
1297 boost::optional<string> _stress;