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_ptr.h"
36 #include "wx/wx_signal_manager.h"
37 #include "wx/wx_util.h"
38 #include "lib/compose.hpp"
39 #include "lib/config.h"
40 #include "lib/constants.h"
41 #include "lib/cross.h"
42 #include "lib/dcp_content.h"
43 #include "lib/dcp_examiner.h"
44 #include "lib/dcpomatic_log.h"
45 #include "lib/dcpomatic_socket.h"
46 #include "lib/examine_content_job.h"
47 #include "lib/ffmpeg_content.h"
48 #include "lib/file_log.h"
50 #include "lib/font_config.h"
51 #include "lib/image.h"
52 #include "lib/image_jpeg.h"
53 #include "lib/image_png.h"
54 #include "lib/internet.h"
56 #include "lib/job_manager.h"
57 #include "lib/null_log.h"
58 #include "lib/player.h"
59 #include "lib/player_video.h"
60 #include "lib/ratio.h"
61 #include "lib/scope_guard.h"
62 #include "lib/scoped_temporary.h"
63 #include "lib/server.h"
64 #include "lib/text_content.h"
65 #include "lib/update_checker.h"
66 #include "lib/verify_dcp_job.h"
67 #include "lib/video_content.h"
70 #include <dcp/exceptions.h>
71 #include <dcp/raw_convert.h>
72 #include <dcp/search.h>
73 #include <dcp/warnings.h>
74 LIBDCP_DISABLE_WARNINGS
75 #include <wx/cmdline.h>
76 #include <wx/display.h>
78 #include <wx/preferences.h>
79 #include <wx/progdlg.h>
80 #include <wx/splash.h>
81 #include <wx/stdpaths.h>
83 LIBDCP_ENABLE_WARNINGS
87 #include <boost/algorithm/string.hpp>
88 #include <boost/bind/bind.hpp>
100 using std::dynamic_pointer_cast;
101 using std::exception;
103 using std::make_shared;
104 using std::shared_ptr;
109 using boost::optional;
110 using boost::scoped_array;
112 #if BOOST_VERSION >= 106100
113 using namespace boost::placeholders;
115 using dcp::raw_convert;
116 using namespace dcpomatic;
125 /* Allow spare IDs after _history for the recent files list */
128 /* Allow spare IDs for CPLs */
129 ID_view_full_screen = 200,
131 ID_view_closed_captions,
132 ID_view_scale_appropriate,
135 ID_view_scale_quarter,
136 ID_help_report_a_problem,
138 ID_tools_check_for_updates,
140 ID_tools_system_information,
141 /* IDs for shortcuts (with no associated menu item) */
145 ID_go_back_small_amount,
146 ID_go_forward_small_amount,
147 ID_go_back_medium_amount,
148 ID_go_forward_medium_amount,
149 ID_go_back_large_amount,
150 ID_go_forward_large_amount,
156 class DOMFrame : public wxFrame
160 class DCPDropTarget : public wxFileDropTarget
163 DCPDropTarget(DOMFrame* owner)
167 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
169 if (filenames.GetCount() == 1) {
170 /* Try to load a directory */
171 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
172 if (boost::filesystem::is_directory(path)) {
173 _frame->load_dcp(wx_to_std(filenames[0]));
178 if (filenames.GetCount() >= 1) {
179 /* Try to load the parent if we drop some files, one if which is an asset map */
180 for (size_t i = 0; i < filenames.GetCount(); ++i) {
181 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
182 if (path.filename() == "ASSETMAP" || path.filename() == "ASSETMAP.xml") {
183 _frame->load_dcp(path.parent_path());
198 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
199 , _mode (Config::instance()->player_mode())
200 /* Use a panel as the only child of the Frame so that we avoid
201 the dark-grey background on Windows.
203 , _overall_panel(new wxPanel(this, wxID_ANY))
204 , _viewer(_overall_panel)
205 , _main_sizer (new wxBoxSizer(wxVERTICAL))
207 dcpomatic_log = make_shared<NullLog>();
209 #if defined(DCPOMATIC_WINDOWS)
210 maybe_open_console ();
211 cout << "DCP-o-matic Player is starting." << "\n";
214 auto bar = new wxMenuBar;
216 set_menu_sensitivity ();
219 #ifdef DCPOMATIC_WINDOWS
220 SetIcon (wxIcon (std_to_wx ("id")));
223 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
224 update_from_config (Config::PLAYER_DEBUG_LOG);
226 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
227 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
228 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
229 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
230 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
231 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
232 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
233 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
234 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
235 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
236 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
237 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
238 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
239 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
240 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
241 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
242 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
243 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
244 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
245 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
246 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
248 Bind(wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
250 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
251 auto pc = new PlaylistControls (_overall_panel, _viewer);
253 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
255 _controls = new StandardControls (_overall_panel, _viewer, false);
257 _controls->set_film(_viewer.film());
258 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
259 _viewer.set_optimise_for_j2k(true);
260 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
261 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
262 _info = new PlayerInformation (_overall_panel, _viewer);
263 setup_main_sizer (Config::instance()->player_mode());
265 int accelerators = 12;
267 int accelerators = 11;
270 _stress.setup (this, _controls);
272 std::vector<wxAcceleratorEntry> accel(accelerators);
273 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
274 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
275 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
276 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
277 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
278 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
279 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
280 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
281 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
282 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
283 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
285 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
287 wxAcceleratorTable accel_table (accelerators, accel.data());
288 SetAcceleratorTable (accel_table);
290 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
291 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
292 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
295 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
296 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
297 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
298 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
299 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
300 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
304 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
307 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
309 SetDropTarget(new DCPDropTarget(this));
314 /* It's important that this is stopped before our frame starts destroying its children,
315 * otherwise UI elements that it depends on will disappear from under it.
320 void close(wxCloseEvent& ev)
326 void setup_main_sizer (Config::PlayerMode mode)
328 _main_sizer->Detach(_viewer.panel());
329 _main_sizer->Detach (_controls);
330 _main_sizer->Detach (_info);
331 if (mode != Config::PLAYER_MODE_DUAL) {
332 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
334 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
335 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
336 _overall_panel->SetSizer (_main_sizer);
337 _overall_panel->Layout ();
340 bool playback_permitted ()
342 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
347 for (auto i: _film->content()) {
348 auto d = dynamic_pointer_cast<DCPContent>(i);
349 if (d && !d->kdm_timing_window_valid()) {
355 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
362 void too_many_frames_dropped ()
364 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
368 NagDialog::maybe_nag (
370 Config::NAG_TOO_MANY_DROPPED_FRAMES,
371 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
372 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
373 "You may be able to improve player performance by:\n"
374 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
375 "• using a more powerful computer.\n"
380 void set_decode_reduction (optional<int> reduction)
382 _viewer.set_dcp_decode_reduction(reduction);
383 _info->triggered_update ();
384 Config::instance()->set_decode_reduction (reduction);
387 void load_dcp (boost::filesystem::path dir)
389 DCPOMATIC_ASSERT (_film);
393 _stress.set_suspended (true);
394 auto dcp = make_shared<DCPContent>(dir);
395 auto job = make_shared<ExamineContentJob>(_film, dcp);
396 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
397 JobManager::instance()->add (job);
398 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
399 if (!ok || !report_errors_from_last_job(this)) {
402 Config::instance()->add_to_player_history (dir);
403 if (dcp->video_frame_rate()) {
404 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
406 } catch (ProjectFolderError &) {
409 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
411 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
412 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to play."
415 } catch (dcp::ReadError& e) {
416 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
417 } catch (DCPError& e) {
418 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
422 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
424 auto job = weak_job.lock ();
425 if (!job || !job->finished_ok()) {
429 auto content = weak_content.lock ();
434 _film->add_content (content);
435 _stress.set_suspended (false);
438 void reset_film_weak (weak_ptr<Film> weak_film)
440 auto film = weak_film.lock ();
446 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
449 _film->set_tolerant (true);
450 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
451 _viewer.set_film(_film);
452 _controls->set_film (_film);
453 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
454 _info->triggered_update ();
457 void film_changed (ChangeType type, Film::Property property)
459 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
463 if (_viewer.playing()) {
467 /* Start off as Flat */
468 _film->set_container (Ratio::from_id("185"));
470 for (auto i: _film->content()) {
471 auto dcp = dynamic_pointer_cast<DCPContent>(i);
473 for (auto j: i->text) {
478 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
479 if (r->id() == "239") {
480 /* Any scope content means we use scope */
481 _film->set_container(r);
485 /* Any 3D content means we use 3D mode */
486 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
487 _film->set_three_d (true);
491 _viewer.seek(DCPTime(), true);
492 _info->triggered_update ();
494 set_menu_sensitivity ();
496 auto old = _cpl_menu->GetMenuItems();
497 for (auto const& i: old) {
498 _cpl_menu->Remove (i);
501 if (_film->content().size() == 1) {
502 /* Offer a CPL menu */
503 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
505 int id = ID_view_cpl;
506 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
507 auto j = _cpl_menu->AppendRadioItem(
509 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
511 j->Check(!first->cpl() || i->id() == *first->cpl());
518 void load_stress_script (boost::filesystem::path path)
520 _stress.load_script (path);
525 void examine_content ()
527 DCPOMATIC_ASSERT (_film);
528 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
529 DCPOMATIC_ASSERT (dcp);
530 dcp->examine (_film, shared_ptr<Job>());
532 /* Examining content re-creates the TextContent objects, so we must re-enable them */
533 for (auto i: dcp->text) {
538 bool report_errors_from_last_job (wxWindow* parent) const
540 auto jm = JobManager::instance ();
542 DCPOMATIC_ASSERT (!jm->get().empty());
544 auto last = jm->get().back();
545 if (last->finished_in_error()) {
546 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()));
553 void setup_menu (wxMenuBar* m)
555 _file_menu = new wxMenu;
556 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
557 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
558 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
559 _file_menu->AppendSeparator ();
560 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
562 _history_position = _file_menu->GetMenuItems().GetCount();
564 _file_menu->AppendSeparator ();
565 _file_menu->Append (ID_file_close, _("&Close"));
566 _file_menu->AppendSeparator ();
569 _file_menu->Append (wxID_EXIT, _("&Exit"));
571 _file_menu->Append (wxID_EXIT, _("&Quit"));
575 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
577 auto edit = new wxMenu;
578 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
581 prefs->Enable (Config::instance()->have_write_permission());
583 _cpl_menu = new wxMenu;
585 auto view = new wxMenu;
586 auto c = Config::instance()->decode_reduction();
587 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
588 view->AppendSeparator();
589 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
590 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
592 view->AppendSeparator();
593 view->Append(ID_view_closed_captions, _("Closed captions..."));
594 view->AppendSeparator();
595 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
596 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
597 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
598 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
600 auto tools = new wxMenu;
601 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
602 tools->AppendSeparator ();
603 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
604 tools->Append (ID_tools_timing, _("Timing..."));
605 tools->Append (ID_tools_system_information, _("System information..."));
607 auto help = new wxMenu;
609 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
611 help->Append (wxID_ABOUT, _("About"));
613 help->Append (ID_help_report_a_problem, _("Report a problem..."));
615 m->Append (_file_menu, _("&File"));
617 m->Append (edit, _("&Edit"));
619 m->Append (view, _("&View"));
620 m->Append (tools, _("&Tools"));
621 m->Append (help, _("&Help"));
626 auto d = wxStandardPaths::Get().GetDocumentsDir();
627 if (Config::instance()->last_player_load_directory()) {
628 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
631 auto c = make_wx<wxDirDialog>(this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
636 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
637 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
644 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
646 Config::instance()->set_last_player_load_directory (dcp.parent_path());
652 auto initial_dir = wxStandardPaths::Get().GetDocumentsDir();
653 if (Config::instance()->last_player_load_directory()) {
654 initial_dir = std_to_wx(Config::instance()->last_player_load_directory()->string());
657 auto c = make_wx<wxDirDialog>(
659 _("Select DCP to open as OV"),
661 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
667 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
668 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
675 DCPOMATIC_ASSERT (_film);
676 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
677 DCPOMATIC_ASSERT (dcp);
678 dcp->add_ov (wx_to_std(c->GetPath()));
679 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
680 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
681 if (!ok || !report_errors_from_last_job(this)) {
684 for (auto i: dcp->text) {
688 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
690 _film->set_container(r);
695 _info->triggered_update ();
700 auto d = make_wx<wxFileDialog>(this, _("Select KDM"));
702 if (d->ShowModal() == wxID_OK) {
703 DCPOMATIC_ASSERT (_film);
704 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
705 DCPOMATIC_ASSERT (dcp);
708 _viewer.set_coalesce_player_changes(true);
709 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
711 _viewer.set_coalesce_player_changes(false);
713 } catch (exception& e) {
714 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
719 _info->triggered_update ();
722 void file_save_frame ()
724 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg;*.jpeg)|*.jpg;*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
725 if (dialog.ShowModal() == wxID_CANCEL) {
729 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
731 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
732 player->seek(_viewer.position(), true);
735 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
736 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
738 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
739 image_as_png(image).write(path);
740 } else if (ext == ".jpg" || ext == ".jpeg") {
741 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
742 image_as_jpeg(image, 80).write(path);
744 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
750 while (!done && tries_left >= 0) {
755 DCPOMATIC_ASSERT (tries_left >= 0);
758 void file_history (wxCommandEvent& event)
760 auto history = Config::instance()->player_history ();
761 int n = event.GetId() - ID_file_history;
762 if (n >= 0 && n < static_cast<int> (history.size ())) {
764 load_dcp (history[n]);
765 } catch (exception& e) {
766 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
774 _info->triggered_update ();
775 set_menu_sensitivity ();
783 void edit_preferences ()
785 if (!Config::instance()->have_write_permission()) {
789 if (!_config_dialog) {
790 _config_dialog = create_player_config_dialog ();
792 _config_dialog->Show (this);
795 void view_cpl (wxCommandEvent& ev)
797 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
798 DCPOMATIC_ASSERT (dcp);
799 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
800 int id = ev.GetId() - ID_view_cpl;
801 DCPOMATIC_ASSERT (id >= 0);
802 DCPOMATIC_ASSERT (id < int(cpls.size()));
803 auto i = cpls.begin();
809 _viewer.set_coalesce_player_changes(true);
810 dcp->set_cpl ((*i)->id());
812 _viewer.set_coalesce_player_changes(false);
814 _info->triggered_update ();
817 void view_full_screen ()
819 if (_mode == Config::PLAYER_MODE_FULL) {
820 _mode = Config::PLAYER_MODE_WINDOW;
822 _mode = Config::PLAYER_MODE_FULL;
828 void view_dual_screen ()
830 if (_mode == Config::PLAYER_MODE_DUAL) {
831 _mode = Config::PLAYER_MODE_WINDOW;
833 _mode = Config::PLAYER_MODE_DUAL;
841 if (_view_full_screen) {
842 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
844 if (_view_dual_screen) {
845 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
851 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
852 _info->Show (_mode != Config::PLAYER_MODE_FULL);
853 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
854 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
855 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
857 if (_mode == Config::PLAYER_MODE_DUAL) {
858 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
859 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
860 _dual_screen->ShowFullScreen (true);
861 _viewer.panel()->Reparent(_dual_screen);
862 _viewer.panel()->SetFocus();
863 _dual_screen->Show ();
864 if (wxDisplay::GetCount() > 1) {
865 switch (Config::instance()->image_display()) {
867 _dual_screen->Move (0, 0);
868 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
871 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
872 // (0, 0) doesn't seem to work for some strange reason
877 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
880 _viewer.panel()->Reparent(_overall_panel);
881 _dual_screen->Destroy ();
886 setup_main_sizer (_mode);
889 void dual_screen_key_press(wxKeyEvent& ev)
891 if (ev.GetKeyCode() == WXK_F11) {
892 if (ev.ShiftDown()) {
894 } else if (!ev.HasAnyModifiers()) {
900 void view_closed_captions ()
902 _viewer.show_closed_captions();
907 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
908 DCPOMATIC_ASSERT (dcp);
910 auto job = make_shared<VerifyDCPJob>(dcp->directories());
911 VerifyDCPProgressDialog progress(this, _("DCP-o-matic Player"));
912 bool const completed = progress.run(job);
916 VerifyDCPDialog dialog(this, job);
921 void tools_check_for_updates ()
923 UpdateChecker::instance()->run ();
924 _update_news_requested = true;
929 auto d = make_wx<TimerDisplay>(this, _viewer.state_timer(), _viewer.gets());
933 void tools_system_information ()
935 if (!_system_information_dialog) {
936 _system_information_dialog = new SystemInformationDialog (this, _viewer);
939 _system_information_dialog->Show ();
944 auto d = make_wx<AboutDialog>(this);
948 void help_report_a_problem ()
950 auto d = make_wx<ReportProblemDialog>(this);
951 if (d->ShowModal () == wxID_OK) {
956 void update_checker_state_changed ()
958 auto uc = UpdateChecker::instance ();
960 bool const announce =
961 _update_news_requested ||
962 (uc->stable() && Config::instance()->check_for_updates()) ||
963 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
965 _update_news_requested = false;
971 if (uc->state() == UpdateChecker::State::YES) {
972 auto dialog = make_wx<UpdateDialog>(this, uc->stable (), uc->test ());
973 dialog->ShowModal ();
974 } else if (uc->state() == UpdateChecker::State::FAILED) {
975 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
977 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
980 _update_news_requested = false;
983 void config_changed (Config::Property prop)
985 /* Instantly save any config changes when using the player GUI */
987 Config::instance()->write_config();
988 } catch (FileError& e) {
989 if (prop != Config::HISTORY) {
993 _("Could not write to config file at %s. Your changes have not been saved."),
994 std_to_wx(e.file().string())
998 } catch (exception& e) {
1001 _("Could not write to config file. Your changes have not been saved.")
1005 update_from_config (prop);
1008 void update_from_config (Config::Property prop)
1010 for (int i = 0; i < _history_items; ++i) {
1011 delete _file_menu->Remove (ID_file_history + i);
1014 if (_history_separator) {
1015 _file_menu->Remove (_history_separator);
1017 delete _history_separator;
1018 _history_separator = nullptr;
1020 int pos = _history_position;
1022 /* Clear out non-existent history items before we re-build the menu */
1023 Config::instance()->clean_player_history ();
1024 auto history = Config::instance()->player_history ();
1026 if (!history.empty ()) {
1027 _history_separator = _file_menu->InsertSeparator (pos++);
1030 for (size_t i = 0; i < history.size(); ++i) {
1033 s = String::compose ("&%1 %2", i + 1, history[i].string());
1035 s = history[i].string();
1037 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1040 _history_items = history.size ();
1042 if (prop == Config::PLAYER_DEBUG_LOG) {
1043 auto p = Config::instance()->player_debug_log_file();
1045 dcpomatic_log = make_shared<FileLog>(*p);
1047 dcpomatic_log = make_shared<NullLog>();
1049 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1053 void set_menu_sensitivity ()
1055 _tools_verify->Enable (static_cast<bool>(_film));
1056 _file_add_ov->Enable (static_cast<bool>(_film));
1057 _file_add_kdm->Enable (static_cast<bool>(_film));
1058 _file_save_frame->Enable (static_cast<bool>(_film));
1059 _view_cpl->Enable (static_cast<bool>(_film));
1062 void start_stop_pressed ()
1064 if (_viewer.playing()) {
1071 void go_back_frame ()
1073 _viewer.seek_by(-_viewer.one_video_frame(), true);
1076 void go_forward_frame ()
1078 _viewer.seek_by(_viewer.one_video_frame(), true);
1081 void go_seconds (int s)
1083 _viewer.seek_by(DCPTime::from_seconds(s), true);
1088 _viewer.seek(DCPTime(), true);
1093 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1096 wxFrame* _dual_screen = nullptr;
1097 bool _update_news_requested = false;
1098 PlayerInformation* _info = nullptr;
1099 Config::PlayerMode _mode;
1100 wxPreferencesEditor* _config_dialog = nullptr;
1101 wxPanel* _overall_panel = nullptr;
1102 wxMenu* _file_menu = nullptr;
1103 wxMenuItem* _view_cpl = nullptr;
1104 wxMenu* _cpl_menu = nullptr;
1105 int _history_items = 0;
1106 int _history_position = 0;
1107 wxMenuItem* _history_separator = nullptr;
1109 Controls* _controls;
1110 SystemInformationDialog* _system_information_dialog = nullptr;
1111 std::shared_ptr<Film> _film;
1112 boost::signals2::scoped_connection _config_changed_connection;
1113 boost::signals2::scoped_connection _examine_job_connection;
1114 wxMenuItem* _file_add_ov = nullptr;
1115 wxMenuItem* _file_add_kdm = nullptr;
1116 wxMenuItem* _file_save_frame = nullptr;
1117 wxMenuItem* _tools_verify = nullptr;
1118 wxMenuItem* _view_full_screen = nullptr;
1119 wxMenuItem* _view_dual_screen = nullptr;
1120 wxSizer* _main_sizer = nullptr;
1121 PlayerStressTester _stress;
1124 static const wxCmdLineEntryDesc command_line_description[] = {
1125 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1126 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1127 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1128 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1131 class PlayServer : public Server
1134 explicit PlayServer (DOMFrame* frame)
1135 : Server (PLAYER_PLAY_PORT)
1139 void handle (shared_ptr<Socket> socket) override
1142 int const length = socket->read_uint32 ();
1143 scoped_array<char> buffer (new char[length]);
1144 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1145 string s (buffer.get());
1146 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1147 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1158 * @brief The magic App class for wxWidgets.
1160 class App : public wxApp
1166 #ifdef DCPOMATIC_LINUX
1173 bool OnInit () override
1175 wxSplashScreen* splash;
1177 wxInitAllImageHandlers ();
1179 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1180 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1182 splash = maybe_show_splash ();
1184 SetAppName (_("DCP-o-matic Player"));
1186 if (!wxApp::OnInit()) {
1190 #ifdef DCPOMATIC_LINUX
1191 unsetenv ("UBUNTU_MENUPROXY");
1194 #ifdef DCPOMATIC_OSX
1195 make_foreground_application ();
1198 dcpomatic_setup_path_encoding ();
1200 /* Enable i18n; this will create a Config object
1201 to look for a force-configured language. This Config
1202 object will be wrong, however, because dcpomatic_setup
1203 hasn't yet been called and there aren't any filters etc.
1206 dcpomatic_setup_i18n ();
1208 /* Set things up, including filters etc.
1209 which will now be internationalised correctly.
1213 /* Force the configuration to be re-loaded correctly next
1218 signal_manager = new wxSignalManager (this);
1220 _frame = new DOMFrame ();
1221 SetTopWindow (_frame);
1222 _frame->Maximize ();
1230 auto server = new PlayServer (_frame);
1231 new thread (boost::bind (&PlayServer::run, server));
1232 } catch (std::exception& e) {
1233 /* This is not the end of the world; probably a failure to bind the server socket
1234 * because there's already another player running.
1236 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1239 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1241 _frame->load_dcp (_dcp_to_load);
1242 } catch (exception& e) {
1243 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1249 _frame->load_stress_script (*_stress);
1250 } catch (exception& e) {
1251 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1255 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1257 if (Config::instance()->check_for_updates ()) {
1258 UpdateChecker::instance()->run ();
1261 catch (exception& e)
1266 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1272 void OnInitCmdLine (wxCmdLineParser& parser) override
1274 parser.SetDesc (command_line_description);
1275 parser.SetSwitchChars (wxT ("-"));
1278 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1280 if (parser.GetParamCount() > 0) {
1281 _dcp_to_load = wx_to_std (parser.GetParam (0));
1285 if (parser.Found("c", &config)) {
1286 Config::override_path = wx_to_std (config);
1289 if (parser.Found("s", &stress)) {
1290 _stress = wx_to_std (stress);
1296 void report_exception ()
1300 } catch (FileError& e) {
1304 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1305 std_to_wx (e.what()),
1306 std_to_wx (e.file().string().c_str ())
1309 } catch (exception& e) {
1313 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1314 std_to_wx (e.what ())
1318 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1322 /* An unhandled exception has occurred inside the main event loop */
1323 bool OnExceptionInMainLoop () override
1325 report_exception ();
1326 /* This will terminate the program */
1330 void OnUnhandledException () override
1332 report_exception ();
1337 signal_manager->ui_idle ();
1340 void config_failed_to_load ()
1342 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1345 void config_warning (string m)
1347 message_dialog (_frame, std_to_wx (m));
1350 DOMFrame* _frame = nullptr;
1351 string _dcp_to_load;
1352 boost::optional<string> _stress;