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/constants.h"
40 #include "lib/cross.h"
41 #include "lib/dcp_content.h"
42 #include "lib/dcp_examiner.h"
43 #include "lib/dcpomatic_log.h"
44 #include "lib/dcpomatic_socket.h"
45 #include "lib/examine_content_job.h"
46 #include "lib/ffmpeg_content.h"
47 #include "lib/file_log.h"
49 #include "lib/image.h"
50 #include "lib/image_jpeg.h"
51 #include "lib/image_png.h"
52 #include "lib/internet.h"
54 #include "lib/job_manager.h"
55 #include "lib/null_log.h"
56 #include "lib/player.h"
57 #include "lib/player_video.h"
58 #include "lib/ratio.h"
59 #include "lib/scope_guard.h"
60 #include "lib/scoped_temporary.h"
61 #include "lib/server.h"
62 #include "lib/text_content.h"
63 #include "lib/update_checker.h"
64 #include "lib/verify_dcp_job.h"
65 #include "lib/video_content.h"
68 #include <dcp/exceptions.h>
69 #include <dcp/raw_convert.h>
70 #include <dcp/search.h>
71 #include <dcp/warnings.h>
72 LIBDCP_DISABLE_WARNINGS
73 #include <wx/cmdline.h>
74 #include <wx/display.h>
76 #include <wx/preferences.h>
77 #include <wx/progdlg.h>
78 #include <wx/splash.h>
79 #include <wx/stdpaths.h>
81 LIBDCP_ENABLE_WARNINGS
85 #include <boost/algorithm/string.hpp>
86 #include <boost/bind/bind.hpp>
98 using std::dynamic_pointer_cast;
101 using std::make_shared;
102 using std::shared_ptr;
107 using boost::optional;
108 using boost::scoped_array;
110 #if BOOST_VERSION >= 106100
111 using namespace boost::placeholders;
113 using dcp::raw_convert;
114 using namespace dcpomatic;
123 /* Allow spare IDs after _history for the recent files list */
126 /* Allow spare IDs for CPLs */
127 ID_view_full_screen = 200,
129 ID_view_closed_captions,
130 ID_view_scale_appropriate,
133 ID_view_scale_quarter,
134 ID_help_report_a_problem,
136 ID_tools_check_for_updates,
138 ID_tools_system_information,
139 /* IDs for shortcuts (with no associated menu item) */
143 ID_go_back_small_amount,
144 ID_go_forward_small_amount,
145 ID_go_back_medium_amount,
146 ID_go_forward_medium_amount,
147 ID_go_back_large_amount,
148 ID_go_forward_large_amount,
154 class DOMFrame : public wxFrame
158 class DCPDropTarget : public wxFileDropTarget
161 DCPDropTarget(DOMFrame* owner)
165 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
167 if (filenames.GetCount() == 1) {
168 /* Try to load a directory */
169 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
170 if (boost::filesystem::is_directory(path)) {
171 _frame->load_dcp(wx_to_std(filenames[0]));
176 if (filenames.GetCount() >= 1) {
177 /* Try to load the parent if we drop some files, one if which is an asset map */
178 for (size_t i = 0; i < filenames.GetCount(); ++i) {
179 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
180 if (path.filename() == "ASSETMAP" || path.filename() == "ASSETMAP.xml") {
181 _frame->load_dcp(path.parent_path());
196 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
197 , _mode (Config::instance()->player_mode())
198 /* Use a panel as the only child of the Frame so that we avoid
199 the dark-grey background on Windows.
201 , _overall_panel(new wxPanel(this, wxID_ANY))
202 , _viewer(_overall_panel)
203 , _main_sizer (new wxBoxSizer(wxVERTICAL))
205 dcpomatic_log = make_shared<NullLog>();
207 #if defined(DCPOMATIC_WINDOWS)
208 maybe_open_console ();
209 cout << "DCP-o-matic Player is starting." << "\n";
212 auto bar = new wxMenuBar;
214 set_menu_sensitivity ();
217 #ifdef DCPOMATIC_WINDOWS
218 SetIcon (wxIcon (std_to_wx ("id")));
221 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
222 update_from_config (Config::PLAYER_DEBUG_LOG);
224 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
225 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
226 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
227 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
228 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
229 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
230 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
231 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
232 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
233 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
234 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
235 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
236 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
237 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
238 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
239 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
240 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
241 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
242 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
243 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
244 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
246 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
247 auto pc = new PlaylistControls (_overall_panel, _viewer);
249 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
251 _controls = new StandardControls (_overall_panel, _viewer, false);
253 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
254 _viewer.set_optimise_for_j2k(true);
255 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
256 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
257 _info = new PlayerInformation (_overall_panel, _viewer);
258 setup_main_sizer (Config::instance()->player_mode());
260 int accelerators = 12;
262 int accelerators = 11;
265 _stress.setup (this, _controls);
267 std::vector<wxAcceleratorEntry> accel(accelerators);
268 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
269 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
270 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
271 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
272 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
273 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
274 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
275 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
276 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
277 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
278 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
280 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
282 wxAcceleratorTable accel_table (accelerators, accel.data());
283 SetAcceleratorTable (accel_table);
285 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
286 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
287 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
288 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
289 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
290 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
291 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
292 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
295 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
299 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
302 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
304 SetDropTarget(new DCPDropTarget(this));
309 /* It's important that this is stopped before our frame starts destroying its children,
310 * otherwise UI elements that it depends on will disappear from under it.
315 void setup_main_sizer (Config::PlayerMode mode)
317 _main_sizer->Detach(_viewer.panel());
318 _main_sizer->Detach (_controls);
319 _main_sizer->Detach (_info);
320 if (mode != Config::PLAYER_MODE_DUAL) {
321 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
323 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
324 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
325 _overall_panel->SetSizer (_main_sizer);
326 _overall_panel->Layout ();
329 bool playback_permitted ()
331 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
336 for (auto i: _film->content()) {
337 auto d = dynamic_pointer_cast<DCPContent>(i);
338 if (d && !d->kdm_timing_window_valid()) {
344 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
351 void too_many_frames_dropped ()
353 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
357 NagDialog::maybe_nag (
359 Config::NAG_TOO_MANY_DROPPED_FRAMES,
360 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
361 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
362 "You may be able to improve player performance by:\n"
363 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
364 "• using a more powerful computer.\n"
369 void set_decode_reduction (optional<int> reduction)
371 _viewer.set_dcp_decode_reduction(reduction);
372 _info->triggered_update ();
373 Config::instance()->set_decode_reduction (reduction);
376 void load_dcp (boost::filesystem::path dir)
378 DCPOMATIC_ASSERT (_film);
382 _stress.set_suspended (true);
383 auto dcp = make_shared<DCPContent>(dir);
384 auto job = make_shared<ExamineContentJob>(_film, dcp);
385 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
386 JobManager::instance()->add (job);
387 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
388 if (!ok || !report_errors_from_last_job(this)) {
391 Config::instance()->add_to_player_history (dir);
392 if (dcp->video_frame_rate()) {
393 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
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 folder 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 int id = ID_view_cpl;
495 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
496 auto j = _cpl_menu->AppendRadioItem(
498 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
500 j->Check(!first->cpl() || i->id() == *first->cpl());
507 void load_stress_script (boost::filesystem::path path)
509 _stress.load_script (path);
514 void examine_content ()
516 DCPOMATIC_ASSERT (_film);
517 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
518 DCPOMATIC_ASSERT (dcp);
519 dcp->examine (_film, shared_ptr<Job>());
521 /* Examining content re-creates the TextContent objects, so we must re-enable them */
522 for (auto i: dcp->text) {
527 bool report_errors_from_last_job (wxWindow* parent) const
529 auto jm = JobManager::instance ();
531 DCPOMATIC_ASSERT (!jm->get().empty());
533 auto last = jm->get().back();
534 if (last->finished_in_error()) {
535 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()));
542 void setup_menu (wxMenuBar* m)
544 _file_menu = new wxMenu;
545 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
546 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
547 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
548 _file_menu->AppendSeparator ();
549 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
551 _history_position = _file_menu->GetMenuItems().GetCount();
553 _file_menu->AppendSeparator ();
554 _file_menu->Append (ID_file_close, _("&Close"));
555 _file_menu->AppendSeparator ();
558 _file_menu->Append (wxID_EXIT, _("&Exit"));
560 _file_menu->Append (wxID_EXIT, _("&Quit"));
564 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
566 auto edit = new wxMenu;
567 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
570 prefs->Enable (Config::instance()->have_write_permission());
572 _cpl_menu = new wxMenu;
574 auto view = new wxMenu;
575 auto c = Config::instance()->decode_reduction();
576 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
577 view->AppendSeparator();
578 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
579 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
581 view->AppendSeparator();
582 view->Append(ID_view_closed_captions, _("Closed captions..."));
583 view->AppendSeparator();
584 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
585 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
586 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
587 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
589 auto tools = new wxMenu;
590 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
591 tools->AppendSeparator ();
592 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
593 tools->Append (ID_tools_timing, _("Timing..."));
594 tools->Append (ID_tools_system_information, _("System information..."));
596 auto help = new wxMenu;
598 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
600 help->Append (wxID_ABOUT, _("About"));
602 help->Append (ID_help_report_a_problem, _("Report a problem..."));
604 m->Append (_file_menu, _("&File"));
606 m->Append (edit, _("&Edit"));
608 m->Append (view, _("&View"));
609 m->Append (tools, _("&Tools"));
610 m->Append (help, _("&Help"));
615 auto d = wxStandardPaths::Get().GetDocumentsDir();
616 if (Config::instance()->last_player_load_directory()) {
617 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
620 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
621 ScopeGuard sg = [c]() { c->Destroy(); };
626 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
627 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
634 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
636 Config::instance()->set_last_player_load_directory (dcp.parent_path());
642 auto initial_dir = wxStandardPaths::Get().GetDocumentsDir();
643 if (Config::instance()->last_player_load_directory()) {
644 initial_dir = std_to_wx(Config::instance()->last_player_load_directory()->string());
647 auto c = new wxDirDialog (
649 _("Select DCP to open as OV"),
651 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
653 ScopeGuard sg = [c]() { c->Destroy(); };
658 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
659 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
666 DCPOMATIC_ASSERT (_film);
667 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
668 DCPOMATIC_ASSERT (dcp);
669 dcp->add_ov (wx_to_std(c->GetPath()));
670 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
671 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
672 if (!ok || !report_errors_from_last_job(this)) {
675 for (auto i: dcp->text) {
679 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
681 _film->set_container(r);
686 _info->triggered_update ();
691 auto d = new wxFileDialog (this, _("Select KDM"));
692 ScopeGuard sg = [d]() { d->Destroy(); };
694 if (d->ShowModal() == wxID_OK) {
695 DCPOMATIC_ASSERT (_film);
696 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
697 DCPOMATIC_ASSERT (dcp);
700 _viewer.set_coalesce_player_changes(true);
701 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
703 _viewer.set_coalesce_player_changes(false);
705 } catch (exception& e) {
706 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
711 _info->triggered_update ();
714 void file_save_frame ()
716 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg,*.jpeg)|*.jpg,*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
717 if (dialog.ShowModal() == wxID_CANCEL) {
721 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
723 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
724 player->seek(_viewer.position(), true);
727 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
728 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
730 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
731 image_as_png(image).write(path);
732 } else if (ext == ".jpg" || ext == ".jpeg") {
733 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
734 image_as_jpeg(image, 80).write(path);
736 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
742 while (!done && tries_left >= 0) {
747 DCPOMATIC_ASSERT (tries_left >= 0);
750 void file_history (wxCommandEvent& event)
752 auto history = Config::instance()->player_history ();
753 int n = event.GetId() - ID_file_history;
754 if (n >= 0 && n < static_cast<int> (history.size ())) {
756 load_dcp (history[n]);
757 } catch (exception& e) {
758 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
766 _info->triggered_update ();
767 set_menu_sensitivity ();
775 void edit_preferences ()
777 if (!Config::instance()->have_write_permission()) {
781 if (!_config_dialog) {
782 _config_dialog = create_player_config_dialog ();
784 _config_dialog->Show (this);
787 void view_cpl (wxCommandEvent& ev)
789 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
790 DCPOMATIC_ASSERT (dcp);
791 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
792 int id = ev.GetId() - ID_view_cpl;
793 DCPOMATIC_ASSERT (id >= 0);
794 DCPOMATIC_ASSERT (id < int(cpls.size()));
795 auto i = cpls.begin();
801 _viewer.set_coalesce_player_changes(true);
802 dcp->set_cpl ((*i)->id());
804 _viewer.set_coalesce_player_changes(false);
806 _info->triggered_update ();
809 void view_full_screen ()
811 if (_mode == Config::PLAYER_MODE_FULL) {
812 _mode = Config::PLAYER_MODE_WINDOW;
814 _mode = Config::PLAYER_MODE_FULL;
820 void view_dual_screen ()
822 if (_mode == Config::PLAYER_MODE_DUAL) {
823 _mode = Config::PLAYER_MODE_WINDOW;
825 _mode = Config::PLAYER_MODE_DUAL;
833 if (_view_full_screen) {
834 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
836 if (_view_dual_screen) {
837 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
843 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
844 _info->Show (_mode != Config::PLAYER_MODE_FULL);
845 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
846 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
847 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
849 if (_mode == Config::PLAYER_MODE_DUAL) {
850 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
851 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
852 _dual_screen->ShowFullScreen (true);
853 _viewer.panel()->Reparent(_dual_screen);
854 _viewer.panel()->SetFocus();
855 _dual_screen->Show ();
856 if (wxDisplay::GetCount() > 1) {
857 switch (Config::instance()->image_display()) {
859 _dual_screen->Move (0, 0);
860 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
863 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
864 // (0, 0) doesn't seem to work for some strange reason
869 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
872 _viewer.panel()->Reparent(_overall_panel);
873 _dual_screen->Destroy ();
878 setup_main_sizer (_mode);
881 void dual_screen_key_press(wxKeyEvent& ev)
883 if (ev.GetKeyCode() == WXK_F11) {
884 if (ev.ShiftDown()) {
886 } else if (!ev.HasAnyModifiers()) {
892 void view_closed_captions ()
894 _viewer.show_closed_captions();
899 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
900 DCPOMATIC_ASSERT (dcp);
902 auto job = make_shared<VerifyDCPJob>(dcp->directories());
903 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
904 bool const completed = progress->run (job);
905 progress->Destroy ();
910 auto d = new VerifyDCPDialog (this, job);
915 void tools_check_for_updates ()
917 UpdateChecker::instance()->run ();
918 _update_news_requested = true;
923 auto d = new TimerDisplay(this, _viewer.state_timer(), _viewer.gets());
928 void tools_system_information ()
930 if (!_system_information_dialog) {
931 _system_information_dialog = new SystemInformationDialog (this, _viewer);
934 _system_information_dialog->Show ();
939 auto d = new AboutDialog (this);
944 void help_report_a_problem ()
946 auto d = new ReportProblemDialog (this);
947 if (d->ShowModal () == wxID_OK) {
953 void update_checker_state_changed ()
955 auto uc = UpdateChecker::instance ();
957 bool const announce =
958 _update_news_requested ||
959 (uc->stable() && Config::instance()->check_for_updates()) ||
960 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
962 _update_news_requested = false;
968 if (uc->state() == UpdateChecker::State::YES) {
969 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
970 dialog->ShowModal ();
972 } else if (uc->state() == UpdateChecker::State::FAILED) {
973 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
975 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
978 _update_news_requested = false;
981 void config_changed (Config::Property prop)
983 /* Instantly save any config changes when using the player GUI */
985 Config::instance()->write_config();
986 } catch (FileError& e) {
987 if (prop != Config::HISTORY) {
991 _("Could not write to config file at %s. Your changes have not been saved."),
992 std_to_wx(e.file().string())
996 } catch (exception& e) {
999 _("Could not write to config file. Your changes have not been saved.")
1003 update_from_config (prop);
1006 void update_from_config (Config::Property prop)
1008 for (int i = 0; i < _history_items; ++i) {
1009 delete _file_menu->Remove (ID_file_history + i);
1012 if (_history_separator) {
1013 _file_menu->Remove (_history_separator);
1015 delete _history_separator;
1016 _history_separator = nullptr;
1018 int pos = _history_position;
1020 /* Clear out non-existent history items before we re-build the menu */
1021 Config::instance()->clean_player_history ();
1022 auto history = Config::instance()->player_history ();
1024 if (!history.empty ()) {
1025 _history_separator = _file_menu->InsertSeparator (pos++);
1028 for (size_t i = 0; i < history.size(); ++i) {
1031 s = String::compose ("&%1 %2", i + 1, history[i].string());
1033 s = history[i].string();
1035 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1038 _history_items = history.size ();
1040 if (prop == Config::PLAYER_DEBUG_LOG) {
1041 auto p = Config::instance()->player_debug_log_file();
1043 dcpomatic_log = make_shared<FileLog>(*p);
1045 dcpomatic_log = make_shared<NullLog>();
1047 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1051 void set_menu_sensitivity ()
1053 _tools_verify->Enable (static_cast<bool>(_film));
1054 _file_add_ov->Enable (static_cast<bool>(_film));
1055 _file_add_kdm->Enable (static_cast<bool>(_film));
1056 _file_save_frame->Enable (static_cast<bool>(_film));
1057 _view_cpl->Enable (static_cast<bool>(_film));
1060 void start_stop_pressed ()
1062 if (_viewer.playing()) {
1069 void go_back_frame ()
1071 _viewer.seek_by(-_viewer.one_video_frame(), true);
1074 void go_forward_frame ()
1076 _viewer.seek_by(_viewer.one_video_frame(), true);
1079 void go_seconds (int s)
1081 _viewer.seek_by(DCPTime::from_seconds(s), true);
1086 _viewer.seek(DCPTime(), true);
1091 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1094 wxFrame* _dual_screen = nullptr;
1095 bool _update_news_requested = false;
1096 PlayerInformation* _info = nullptr;
1097 Config::PlayerMode _mode;
1098 wxPreferencesEditor* _config_dialog = nullptr;
1099 wxPanel* _overall_panel = nullptr;
1100 wxMenu* _file_menu = nullptr;
1101 wxMenuItem* _view_cpl = nullptr;
1102 wxMenu* _cpl_menu = nullptr;
1103 int _history_items = 0;
1104 int _history_position = 0;
1105 wxMenuItem* _history_separator = nullptr;
1107 Controls* _controls;
1108 SystemInformationDialog* _system_information_dialog = nullptr;
1109 std::shared_ptr<Film> _film;
1110 boost::signals2::scoped_connection _config_changed_connection;
1111 boost::signals2::scoped_connection _examine_job_connection;
1112 wxMenuItem* _file_add_ov = nullptr;
1113 wxMenuItem* _file_add_kdm = nullptr;
1114 wxMenuItem* _file_save_frame = nullptr;
1115 wxMenuItem* _tools_verify = nullptr;
1116 wxMenuItem* _view_full_screen = nullptr;
1117 wxMenuItem* _view_dual_screen = nullptr;
1118 wxSizer* _main_sizer = nullptr;
1119 PlayerStressTester _stress;
1122 static const wxCmdLineEntryDesc command_line_description[] = {
1123 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1124 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1125 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1126 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1129 class PlayServer : public Server
1132 explicit PlayServer (DOMFrame* frame)
1133 : Server (PLAYER_PLAY_PORT)
1137 void handle (shared_ptr<Socket> socket) override
1140 int const length = socket->read_uint32 ();
1141 scoped_array<char> buffer (new char[length]);
1142 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1143 string s (buffer.get());
1144 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1145 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1156 * @brief The magic App class for wxWidgets.
1158 class App : public wxApp
1164 #ifdef DCPOMATIC_LINUX
1171 bool OnInit () override
1173 wxSplashScreen* splash = nullptr;
1175 wxInitAllImageHandlers ();
1177 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1178 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1180 splash = maybe_show_splash ();
1182 SetAppName (_("DCP-o-matic Player"));
1184 if (!wxApp::OnInit()) {
1188 #ifdef DCPOMATIC_LINUX
1189 unsetenv ("UBUNTU_MENUPROXY");
1192 #ifdef DCPOMATIC_OSX
1193 make_foreground_application ();
1196 dcpomatic_setup_path_encoding ();
1198 /* Enable i18n; this will create a Config object
1199 to look for a force-configured language. This Config
1200 object will be wrong, however, because dcpomatic_setup
1201 hasn't yet been called and there aren't any filters etc.
1204 dcpomatic_setup_i18n ();
1206 /* Set things up, including filters etc.
1207 which will now be internationalised correctly.
1211 /* Force the configuration to be re-loaded correctly next
1216 signal_manager = new wxSignalManager (this);
1218 _frame = new DOMFrame ();
1219 SetTopWindow (_frame);
1220 _frame->Maximize ();
1228 auto server = new PlayServer (_frame);
1229 new thread (boost::bind (&PlayServer::run, server));
1230 } catch (std::exception& e) {
1231 /* This is not the end of the world; probably a failure to bind the server socket
1232 * because there's already another player running.
1234 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1237 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1239 _frame->load_dcp (_dcp_to_load);
1240 } catch (exception& e) {
1241 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1247 _frame->load_stress_script (*_stress);
1248 } catch (exception& e) {
1249 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1253 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1255 if (Config::instance()->check_for_updates ()) {
1256 UpdateChecker::instance()->run ();
1259 catch (exception& e)
1264 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1270 void OnInitCmdLine (wxCmdLineParser& parser) override
1272 parser.SetDesc (command_line_description);
1273 parser.SetSwitchChars (wxT ("-"));
1276 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1278 if (parser.GetParamCount() > 0) {
1279 _dcp_to_load = wx_to_std (parser.GetParam (0));
1283 if (parser.Found("c", &config)) {
1284 Config::override_path = wx_to_std (config);
1287 if (parser.Found("s", &stress)) {
1288 _stress = wx_to_std (stress);
1294 void report_exception ()
1298 } catch (FileError& e) {
1302 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1303 std_to_wx (e.what()),
1304 std_to_wx (e.file().string().c_str ())
1307 } catch (exception& e) {
1311 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1312 std_to_wx (e.what ())
1316 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1320 /* An unhandled exception has occurred inside the main event loop */
1321 bool OnExceptionInMainLoop () override
1323 report_exception ();
1324 /* This will terminate the program */
1328 void OnUnhandledException () override
1330 report_exception ();
1335 signal_manager->ui_idle ();
1338 void config_failed_to_load ()
1340 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1343 void config_warning (string m)
1345 message_dialog (_frame, std_to_wx (m));
1348 DOMFrame* _frame = nullptr;
1349 string _dcp_to_load;
1350 boost::optional<string> _stress;