2 Copyright (C) 2017-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "wx/about_dialog.h"
22 #include "wx/film_viewer.h"
23 #include "wx/nag_dialog.h"
24 #include "wx/player_config_dialog.h"
25 #include "wx/player_information.h"
26 #include "wx/player_stress_tester.h"
27 #include "wx/playlist_controls.h"
28 #include "wx/report_problem_dialog.h"
29 #include "wx/standard_controls.h"
30 #include "wx/system_information_dialog.h"
31 #include "wx/timer_display.h"
32 #include "wx/update_dialog.h"
33 #include "wx/verify_dcp_dialog.h"
34 #include "wx/verify_dcp_progress_dialog.h"
35 #include "wx/wx_signal_manager.h"
36 #include "wx/wx_util.h"
37 #include "lib/compose.hpp"
38 #include "lib/config.h"
39 #include "lib/cross.h"
40 #include "lib/dcp_content.h"
41 #include "lib/dcp_examiner.h"
42 #include "lib/dcpomatic_log.h"
43 #include "lib/dcpomatic_socket.h"
44 #include "lib/examine_content_job.h"
45 #include "lib/ffmpeg_content.h"
46 #include "lib/file_log.h"
48 #include "lib/image.h"
49 #include "lib/image_png.h"
50 #include "lib/internet.h"
52 #include "lib/job_manager.h"
53 #include "lib/null_log.h"
54 #include "lib/ratio.h"
55 #include "lib/scoped_temporary.h"
56 #include "lib/server.h"
57 #include "lib/text_content.h"
58 #include "lib/update_checker.h"
60 #include "lib/verify_dcp_job.h"
61 #include "lib/video_content.h"
64 #include <dcp/exceptions.h>
65 #include <dcp/raw_convert.h>
66 #include <dcp/search.h>
67 #include <dcp/warnings.h>
68 LIBDCP_DISABLE_WARNINGS
69 #include <wx/cmdline.h>
70 #include <wx/display.h>
71 #include <wx/preferences.h>
72 #include <wx/progdlg.h>
73 #include <wx/splash.h>
74 #include <wx/stdpaths.h>
76 LIBDCP_ENABLE_WARNINGS
80 #include <boost/algorithm/string.hpp>
81 #include <boost/bind/bind.hpp>
93 using std::dynamic_pointer_cast;
96 using std::make_shared;
97 using std::shared_ptr;
102 using boost::optional;
103 using boost::scoped_array;
105 #if BOOST_VERSION >= 106100
106 using namespace boost::placeholders;
108 using dcp::raw_convert;
109 using namespace dcpomatic;
117 /* Allow spare IDs after _history for the recent files list */
120 /* Allow spare IDs for CPLs */
121 ID_view_full_screen = 200,
123 ID_view_closed_captions,
124 ID_view_scale_appropriate,
127 ID_view_scale_quarter,
128 ID_help_report_a_problem,
130 ID_tools_check_for_updates,
132 ID_tools_system_information,
133 /* IDs for shortcuts (with no associated menu item) */
137 ID_go_back_small_amount,
138 ID_go_forward_small_amount,
139 ID_go_back_medium_amount,
140 ID_go_forward_medium_amount,
141 ID_go_back_large_amount,
142 ID_go_forward_large_amount,
147 class DOMFrame : public wxFrame
151 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
152 , _mode (Config::instance()->player_mode())
153 , _main_sizer (new wxBoxSizer(wxVERTICAL))
155 dcpomatic_log = make_shared<NullLog>();
157 #if defined(DCPOMATIC_WINDOWS)
158 maybe_open_console ();
159 cout << "DCP-o-matic Player is starting." << "\n";
162 auto bar = new wxMenuBar;
164 set_menu_sensitivity ();
167 #ifdef DCPOMATIC_WINDOWS
168 SetIcon (wxIcon (std_to_wx ("id")));
171 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
172 update_from_config (Config::PLAYER_DEBUG_LOG);
174 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
175 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
181 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
185 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
186 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
187 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
188 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
189 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
190 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
191 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
192 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
193 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
195 /* Use a panel as the only child of the Frame so that we avoid
196 the dark-grey background on Windows.
198 _overall_panel = new wxPanel (this, wxID_ANY);
200 _viewer = make_shared<FilmViewer>(_overall_panel);
201 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
202 auto pc = new PlaylistControls (_overall_panel, _viewer);
204 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
206 _controls = new StandardControls (_overall_panel, _viewer, false);
208 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
209 _viewer->set_optimise_for_j2k (true);
210 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
211 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
212 _info = new PlayerInformation (_overall_panel, _viewer);
213 setup_main_sizer (Config::instance()->player_mode());
215 int accelerators = 12;
217 int accelerators = 11;
220 _stress.setup (this, _controls);
222 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
223 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
224 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
225 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
226 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
227 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
228 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
229 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
230 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
231 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
232 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
233 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
235 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
237 wxAcceleratorTable accel_table (accelerators, accel);
238 SetAcceleratorTable (accel_table);
241 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
242 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
243 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
244 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
245 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
246 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
247 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
248 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
249 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
250 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
251 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
255 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
258 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
263 /* It's important that this is stopped before our frame starts destroying its children,
264 * otherwise UI elements that it depends on will disappear from under it.
269 void setup_main_sizer (Config::PlayerMode mode)
271 _main_sizer->Detach (_viewer->panel());
272 _main_sizer->Detach (_controls);
273 _main_sizer->Detach (_info);
274 if (mode != Config::PLAYER_MODE_DUAL) {
275 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
277 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
278 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
279 _overall_panel->SetSizer (_main_sizer);
280 _overall_panel->Layout ();
283 bool playback_permitted ()
285 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
290 for (auto i: _film->content()) {
291 auto d = dynamic_pointer_cast<DCPContent>(i);
292 if (d && !d->kdm_timing_window_valid()) {
298 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
305 void too_many_frames_dropped ()
307 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
311 NagDialog::maybe_nag (
313 Config::NAG_TOO_MANY_DROPPED_FRAMES,
314 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
315 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
316 "You may be able to improve player performance by:\n"
317 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
318 "• using a more powerful computer.\n"
323 void set_decode_reduction (optional<int> reduction)
325 _viewer->set_dcp_decode_reduction (reduction);
326 _info->triggered_update ();
327 Config::instance()->set_decode_reduction (reduction);
330 void load_dcp (boost::filesystem::path dir)
332 DCPOMATIC_ASSERT (_film);
336 _stress.set_suspended (true);
338 auto dcp = make_shared<DCPContent>(dir);
339 auto job = make_shared<ExamineContentJob>(_film, dcp);
340 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
341 JobManager::instance()->add (job);
342 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
343 if (!ok || !report_errors_from_last_job(this)) {
346 Config::instance()->add_to_player_history (dir);
347 } catch (ProjectFolderError &) {
350 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
352 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
353 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
356 } catch (dcp::ReadError& e) {
357 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
358 } catch (DCPError& e) {
359 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
363 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
365 auto job = weak_job.lock ();
366 if (!job || !job->finished_ok()) {
370 auto content = weak_content.lock ();
375 _film->add_content (content);
376 _stress.set_suspended (false);
379 void reset_film_weak (weak_ptr<Film> weak_film)
381 auto film = weak_film.lock ();
387 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
390 _film->set_tolerant (true);
391 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
392 _viewer->set_film (_film);
393 _controls->set_film (_film);
394 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
395 _info->triggered_update ();
398 void film_changed (ChangeType type, Film::Property property)
400 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
404 if (_viewer->playing ()) {
408 /* Start off as Flat */
409 _film->set_container (Ratio::from_id("185"));
411 for (auto i: _film->content()) {
412 auto dcp = dynamic_pointer_cast<DCPContent>(i);
414 for (auto j: i->text) {
419 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
420 if (r->id() == "239") {
421 /* Any scope content means we use scope */
422 _film->set_container(r);
426 /* Any 3D content means we use 3D mode */
427 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
428 _film->set_three_d (true);
432 _viewer->seek (DCPTime(), true);
433 _info->triggered_update ();
435 set_menu_sensitivity ();
437 auto old = _cpl_menu->GetMenuItems();
438 for (auto const& i: old) {
439 _cpl_menu->Remove (i);
442 if (_film->content().size() == 1) {
443 /* Offer a CPL menu */
444 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
446 int id = ID_view_cpl;
447 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
448 auto j = _cpl_menu->AppendRadioItem(
450 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
452 j->Check(!first->cpl() || i->id() == *first->cpl());
459 void load_stress_script (boost::filesystem::path path)
461 _stress.load_script (path);
466 void examine_content ()
468 DCPOMATIC_ASSERT (_film);
469 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
470 DCPOMATIC_ASSERT (dcp);
471 dcp->examine (_film, shared_ptr<Job>());
473 /* Examining content re-creates the TextContent objects, so we must re-enable them */
474 for (auto i: dcp->text) {
479 bool report_errors_from_last_job (wxWindow* parent) const
481 auto jm = JobManager::instance ();
483 DCPOMATIC_ASSERT (!jm->get().empty());
485 auto last = jm->get().back();
486 if (last->finished_in_error()) {
487 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()));
494 void setup_menu (wxMenuBar* m)
496 _file_menu = new wxMenu;
497 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
498 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
499 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
501 _history_position = _file_menu->GetMenuItems().GetCount();
503 _file_menu->AppendSeparator ();
504 _file_menu->Append (ID_file_close, _("&Close"));
505 _file_menu->AppendSeparator ();
508 _file_menu->Append (wxID_EXIT, _("&Exit"));
510 _file_menu->Append (wxID_EXIT, _("&Quit"));
514 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
516 auto edit = new wxMenu;
517 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
520 prefs->Enable (Config::instance()->have_write_permission());
522 _cpl_menu = new wxMenu;
524 auto view = new wxMenu;
525 auto c = Config::instance()->decode_reduction();
526 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
527 view->AppendSeparator();
528 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
529 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
531 view->AppendSeparator();
532 view->Append(ID_view_closed_captions, _("Closed captions..."));
533 view->AppendSeparator();
534 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
535 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
536 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
537 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
539 auto tools = new wxMenu;
540 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
541 tools->AppendSeparator ();
542 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
543 tools->Append (ID_tools_timing, _("Timing..."));
544 tools->Append (ID_tools_system_information, _("System information..."));
546 auto help = new wxMenu;
548 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
550 help->Append (wxID_ABOUT, _("About"));
552 help->Append (ID_help_report_a_problem, _("Report a problem..."));
554 m->Append (_file_menu, _("&File"));
556 m->Append (edit, _("&Edit"));
558 m->Append (view, _("&View"));
559 m->Append (tools, _("&Tools"));
560 m->Append (help, _("&Help"));
565 auto d = wxStandardPaths::Get().GetDocumentsDir();
566 if (Config::instance()->last_player_load_directory()) {
567 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
570 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
575 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
576 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
583 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
585 Config::instance()->set_last_player_load_directory (dcp.parent_path());
593 auto c = new wxDirDialog (
595 _("Select DCP to open as OV"),
596 wxStandardPaths::Get().GetDocumentsDir(),
597 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
603 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
604 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
611 DCPOMATIC_ASSERT (_film);
612 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
613 DCPOMATIC_ASSERT (dcp);
614 dcp->add_ov (wx_to_std(c->GetPath()));
615 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
616 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
617 if (!ok || !report_errors_from_last_job(this)) {
620 for (auto i: dcp->text) {
624 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
626 _film->set_container(r);
632 _info->triggered_update ();
637 auto d = new wxFileDialog (this, _("Select KDM"));
639 if (d->ShowModal() == wxID_OK) {
640 DCPOMATIC_ASSERT (_film);
641 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
642 DCPOMATIC_ASSERT (dcp);
645 _viewer->set_coalesce_player_changes (true);
646 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
648 _viewer->set_coalesce_player_changes (false);
650 } catch (exception& e) {
651 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
658 _info->triggered_update ();
661 void file_history (wxCommandEvent& event)
663 auto history = Config::instance()->player_history ();
664 int n = event.GetId() - ID_file_history;
665 if (n >= 0 && n < static_cast<int> (history.size ())) {
667 load_dcp (history[n]);
668 } catch (exception& e) {
669 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
677 _info->triggered_update ();
678 set_menu_sensitivity ();
686 void edit_preferences ()
688 if (!Config::instance()->have_write_permission()) {
692 if (!_config_dialog) {
693 _config_dialog = create_player_config_dialog ();
695 _config_dialog->Show (this);
698 void view_cpl (wxCommandEvent& ev)
700 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
701 DCPOMATIC_ASSERT (dcp);
702 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
703 int id = ev.GetId() - ID_view_cpl;
704 DCPOMATIC_ASSERT (id >= 0);
705 DCPOMATIC_ASSERT (id < int(cpls.size()));
706 auto i = cpls.begin();
712 _viewer->set_coalesce_player_changes (true);
713 dcp->set_cpl ((*i)->id());
715 _viewer->set_coalesce_player_changes (false);
717 _info->triggered_update ();
720 void view_full_screen ()
722 if (_mode == Config::PLAYER_MODE_FULL) {
723 _mode = Config::PLAYER_MODE_WINDOW;
725 _mode = Config::PLAYER_MODE_FULL;
731 void view_dual_screen ()
733 if (_mode == Config::PLAYER_MODE_DUAL) {
734 _mode = Config::PLAYER_MODE_WINDOW;
736 _mode = Config::PLAYER_MODE_DUAL;
744 if (_view_full_screen) {
745 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
747 if (_view_dual_screen) {
748 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
754 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
755 _info->Show (_mode != Config::PLAYER_MODE_FULL);
756 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
757 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
758 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
760 if (_mode == Config::PLAYER_MODE_DUAL) {
761 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
762 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
763 _dual_screen->ShowFullScreen (true);
764 _viewer->panel()->Reparent (_dual_screen);
765 _dual_screen->Show ();
766 if (wxDisplay::GetCount() > 1) {
767 switch (Config::instance()->image_display()) {
769 _dual_screen->Move (0, 0);
770 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
773 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
774 // (0, 0) doesn't seem to work for some strange reason
781 _viewer->panel()->Reparent (_overall_panel);
782 _dual_screen->Destroy ();
787 setup_main_sizer (_mode);
790 void view_closed_captions ()
792 _viewer->show_closed_captions ();
797 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
798 DCPOMATIC_ASSERT (dcp);
800 auto job = make_shared<VerifyDCPJob>(dcp->directories());
801 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
802 bool const completed = progress->run (job);
803 progress->Destroy ();
808 auto d = new VerifyDCPDialog (this, job);
813 void tools_check_for_updates ()
815 UpdateChecker::instance()->run ();
816 _update_news_requested = true;
821 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
826 void tools_system_information ()
828 if (!_system_information_dialog) {
829 _system_information_dialog = new SystemInformationDialog (this, _viewer);
832 _system_information_dialog->Show ();
837 auto d = new AboutDialog (this);
842 void help_report_a_problem ()
844 auto d = new ReportProblemDialog (this);
845 if (d->ShowModal () == wxID_OK) {
851 void update_checker_state_changed ()
853 auto uc = UpdateChecker::instance ();
855 bool const announce =
856 _update_news_requested ||
857 (uc->stable() && Config::instance()->check_for_updates()) ||
858 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
860 _update_news_requested = false;
866 if (uc->state() == UpdateChecker::State::YES) {
867 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
868 dialog->ShowModal ();
870 } else if (uc->state() == UpdateChecker::State::FAILED) {
871 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
873 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
876 _update_news_requested = false;
879 void config_changed (Config::Property prop)
881 /* Instantly save any config changes when using the player GUI */
883 Config::instance()->write_config();
884 } catch (FileError& e) {
885 if (prop != Config::HISTORY) {
889 _("Could not write to config file at %s. Your changes have not been saved."),
890 std_to_wx(e.file().string())
894 } catch (exception& e) {
897 _("Could not write to config file. Your changes have not been saved.")
901 update_from_config (prop);
904 void update_from_config (Config::Property prop)
906 for (int i = 0; i < _history_items; ++i) {
907 delete _file_menu->Remove (ID_file_history + i);
910 if (_history_separator) {
911 _file_menu->Remove (_history_separator);
913 delete _history_separator;
914 _history_separator = nullptr;
916 int pos = _history_position;
918 /* Clear out non-existant history items before we re-build the menu */
919 Config::instance()->clean_player_history ();
920 auto history = Config::instance()->player_history ();
922 if (!history.empty ()) {
923 _history_separator = _file_menu->InsertSeparator (pos++);
926 for (size_t i = 0; i < history.size(); ++i) {
929 s = String::compose ("&%1 %2", i + 1, history[i].string());
931 s = history[i].string();
933 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
936 _history_items = history.size ();
938 if (prop == Config::PLAYER_DEBUG_LOG) {
939 auto p = Config::instance()->player_debug_log_file();
941 dcpomatic_log = make_shared<FileLog>(*p);
943 dcpomatic_log = make_shared<NullLog>();
945 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
949 void set_menu_sensitivity ()
951 _tools_verify->Enable (static_cast<bool>(_film));
952 _file_add_ov->Enable (static_cast<bool>(_film));
953 _file_add_kdm->Enable (static_cast<bool>(_film));
954 _view_cpl->Enable (static_cast<bool>(_film));
957 void start_stop_pressed ()
959 if (_viewer->playing()) {
966 void go_back_frame ()
968 _viewer->seek_by (-_viewer->one_video_frame(), true);
971 void go_forward_frame ()
973 _viewer->seek_by (_viewer->one_video_frame(), true);
976 void go_seconds (int s)
978 _viewer->seek_by (DCPTime::from_seconds(s), true);
983 _viewer->seek (DCPTime(), true);
988 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
991 wxFrame* _dual_screen = nullptr;
992 bool _update_news_requested = false;
993 PlayerInformation* _info = nullptr;
994 Config::PlayerMode _mode;
995 wxPreferencesEditor* _config_dialog = nullptr;
996 wxPanel* _overall_panel = nullptr;
997 wxMenu* _file_menu = nullptr;
998 wxMenuItem* _view_cpl = nullptr;
999 wxMenu* _cpl_menu = nullptr;
1000 int _history_items = 0;
1001 int _history_position = 0;
1002 wxMenuItem* _history_separator = nullptr;
1003 shared_ptr<FilmViewer> _viewer;
1004 Controls* _controls;
1005 SystemInformationDialog* _system_information_dialog = nullptr;
1006 std::shared_ptr<Film> _film;
1007 boost::signals2::scoped_connection _config_changed_connection;
1008 boost::signals2::scoped_connection _examine_job_connection;
1009 wxMenuItem* _file_add_ov = nullptr;
1010 wxMenuItem* _file_add_kdm = nullptr;
1011 wxMenuItem* _tools_verify = nullptr;
1012 wxMenuItem* _view_full_screen = nullptr;
1013 wxMenuItem* _view_dual_screen = nullptr;
1014 wxSizer* _main_sizer = nullptr;
1015 PlayerStressTester _stress;
1018 static const wxCmdLineEntryDesc command_line_description[] = {
1019 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1020 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1021 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1022 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1025 class PlayServer : public Server
1028 explicit PlayServer (DOMFrame* frame)
1029 : Server (PLAYER_PLAY_PORT)
1033 void handle (shared_ptr<Socket> socket) override
1036 int const length = socket->read_uint32 ();
1037 scoped_array<char> buffer (new char[length]);
1038 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1039 string s (buffer.get());
1040 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1041 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1052 * @brief The magic App class for wxWidgets.
1054 class App : public wxApp
1060 #ifdef DCPOMATIC_LINUX
1067 bool OnInit () override
1069 wxSplashScreen* splash = nullptr;
1071 wxInitAllImageHandlers ();
1073 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1074 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1076 splash = maybe_show_splash ();
1078 SetAppName (_("DCP-o-matic Player"));
1080 if (!wxApp::OnInit()) {
1084 #ifdef DCPOMATIC_LINUX
1085 unsetenv ("UBUNTU_MENUPROXY");
1088 #ifdef DCPOMATIC_OSX
1089 make_foreground_application ();
1092 dcpomatic_setup_path_encoding ();
1094 /* Enable i18n; this will create a Config object
1095 to look for a force-configured language. This Config
1096 object will be wrong, however, because dcpomatic_setup
1097 hasn't yet been called and there aren't any filters etc.
1100 dcpomatic_setup_i18n ();
1102 /* Set things up, including filters etc.
1103 which will now be internationalised correctly.
1107 /* Force the configuration to be re-loaded correctly next
1112 signal_manager = new wxSignalManager (this);
1114 _frame = new DOMFrame ();
1115 SetTopWindow (_frame);
1116 _frame->Maximize ();
1124 auto server = new PlayServer (_frame);
1125 new thread (boost::bind (&PlayServer::run, server));
1126 } catch (std::exception& e) {
1127 /* This is not the end of the world; probably a failure to bind the server socket
1128 * because there's already another player running.
1130 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1133 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1135 _frame->load_dcp (_dcp_to_load);
1136 } catch (exception& e) {
1137 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1143 _frame->load_stress_script (*_stress);
1144 } catch (exception& e) {
1145 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1149 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1151 if (Config::instance()->check_for_updates ()) {
1152 UpdateChecker::instance()->run ();
1155 catch (exception& e)
1160 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1166 void OnInitCmdLine (wxCmdLineParser& parser) override
1168 parser.SetDesc (command_line_description);
1169 parser.SetSwitchChars (wxT ("-"));
1172 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1174 if (parser.GetParamCount() > 0) {
1175 _dcp_to_load = wx_to_std (parser.GetParam (0));
1179 if (parser.Found("c", &config)) {
1180 Config::override_path = wx_to_std (config);
1183 if (parser.Found("s", &stress)) {
1184 _stress = wx_to_std (stress);
1190 void report_exception ()
1194 } catch (FileError& e) {
1198 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1199 std_to_wx (e.what()),
1200 std_to_wx (e.file().string().c_str ())
1203 } catch (exception& e) {
1207 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1208 std_to_wx (e.what ())
1212 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1216 /* An unhandled exception has occurred inside the main event loop */
1217 bool OnExceptionInMainLoop () override
1219 report_exception ();
1220 /* This will terminate the program */
1224 void OnUnhandledException () override
1226 report_exception ();
1231 signal_manager->ui_idle ();
1234 void config_failed_to_load ()
1236 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1239 void config_warning (string m)
1241 message_dialog (_frame, std_to_wx (m));
1244 DOMFrame* _frame = nullptr;
1245 string _dcp_to_load;
1246 boost::optional<string> _stress;