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 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
258 _viewer.set_optimise_for_j2k(true);
259 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
260 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
261 _info = new PlayerInformation (_overall_panel, _viewer);
262 setup_main_sizer (Config::instance()->player_mode());
264 int accelerators = 12;
266 int accelerators = 11;
269 _stress.setup (this, _controls);
271 std::vector<wxAcceleratorEntry> accel(accelerators);
272 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
273 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
274 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
275 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
276 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
277 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
278 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
279 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
280 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
281 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
282 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
284 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
286 wxAcceleratorTable accel_table (accelerators, accel.data());
287 SetAcceleratorTable (accel_table);
289 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
290 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
291 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
292 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
295 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
296 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
297 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
298 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
299 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
303 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
306 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
308 SetDropTarget(new DCPDropTarget(this));
313 /* It's important that this is stopped before our frame starts destroying its children,
314 * otherwise UI elements that it depends on will disappear from under it.
319 void close(wxCloseEvent& ev)
325 void setup_main_sizer (Config::PlayerMode mode)
327 _main_sizer->Detach(_viewer.panel());
328 _main_sizer->Detach (_controls);
329 _main_sizer->Detach (_info);
330 if (mode != Config::PLAYER_MODE_DUAL) {
331 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
333 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
334 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
335 _overall_panel->SetSizer (_main_sizer);
336 _overall_panel->Layout ();
339 bool playback_permitted ()
341 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
346 for (auto i: _film->content()) {
347 auto d = dynamic_pointer_cast<DCPContent>(i);
348 if (d && !d->kdm_timing_window_valid()) {
354 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
361 void too_many_frames_dropped ()
363 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
367 NagDialog::maybe_nag (
369 Config::NAG_TOO_MANY_DROPPED_FRAMES,
370 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
371 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
372 "You may be able to improve player performance by:\n"
373 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
374 "• using a more powerful computer.\n"
379 void set_decode_reduction (optional<int> reduction)
381 _viewer.set_dcp_decode_reduction(reduction);
382 _info->triggered_update ();
383 Config::instance()->set_decode_reduction (reduction);
386 void load_dcp (boost::filesystem::path dir)
388 DCPOMATIC_ASSERT (_film);
392 _stress.set_suspended (true);
393 auto dcp = make_shared<DCPContent>(dir);
394 auto job = make_shared<ExamineContentJob>(_film, dcp);
395 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
396 JobManager::instance()->add (job);
397 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
398 if (!ok || !report_errors_from_last_job(this)) {
401 Config::instance()->add_to_player_history (dir);
402 if (dcp->video_frame_rate()) {
403 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
405 } catch (ProjectFolderError &) {
408 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
410 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
411 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to play."
414 } catch (dcp::ReadError& e) {
415 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
416 } catch (DCPError& e) {
417 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
421 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
423 auto job = weak_job.lock ();
424 if (!job || !job->finished_ok()) {
428 auto content = weak_content.lock ();
433 _film->add_content (content);
434 _stress.set_suspended (false);
437 void reset_film_weak (weak_ptr<Film> weak_film)
439 auto film = weak_film.lock ();
445 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
448 _film->set_tolerant (true);
449 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
450 _viewer.set_film(_film);
451 _controls->set_film (_film);
452 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
453 _info->triggered_update ();
456 void film_changed (ChangeType type, Film::Property property)
458 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
462 if (_viewer.playing()) {
466 /* Start off as Flat */
467 _film->set_container (Ratio::from_id("185"));
469 for (auto i: _film->content()) {
470 auto dcp = dynamic_pointer_cast<DCPContent>(i);
472 for (auto j: i->text) {
477 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
478 if (r->id() == "239") {
479 /* Any scope content means we use scope */
480 _film->set_container(r);
484 /* Any 3D content means we use 3D mode */
485 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
486 _film->set_three_d (true);
490 _viewer.seek(DCPTime(), true);
491 _info->triggered_update ();
493 set_menu_sensitivity ();
495 auto old = _cpl_menu->GetMenuItems();
496 for (auto const& i: old) {
497 _cpl_menu->Remove (i);
500 if (_film->content().size() == 1) {
501 /* Offer a CPL menu */
502 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
504 int id = ID_view_cpl;
505 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
506 auto j = _cpl_menu->AppendRadioItem(
508 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
510 j->Check(!first->cpl() || i->id() == *first->cpl());
517 void load_stress_script (boost::filesystem::path path)
519 _stress.load_script (path);
524 void examine_content ()
526 DCPOMATIC_ASSERT (_film);
527 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
528 DCPOMATIC_ASSERT (dcp);
529 dcp->examine (_film, shared_ptr<Job>());
531 /* Examining content re-creates the TextContent objects, so we must re-enable them */
532 for (auto i: dcp->text) {
537 bool report_errors_from_last_job (wxWindow* parent) const
539 auto jm = JobManager::instance ();
541 DCPOMATIC_ASSERT (!jm->get().empty());
543 auto last = jm->get().back();
544 if (last->finished_in_error()) {
545 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()));
552 void setup_menu (wxMenuBar* m)
554 _file_menu = new wxMenu;
555 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
556 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
557 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
558 _file_menu->AppendSeparator ();
559 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
561 _history_position = _file_menu->GetMenuItems().GetCount();
563 _file_menu->AppendSeparator ();
564 _file_menu->Append (ID_file_close, _("&Close"));
565 _file_menu->AppendSeparator ();
568 _file_menu->Append (wxID_EXIT, _("&Exit"));
570 _file_menu->Append (wxID_EXIT, _("&Quit"));
574 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
576 auto edit = new wxMenu;
577 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
580 prefs->Enable (Config::instance()->have_write_permission());
582 _cpl_menu = new wxMenu;
584 auto view = new wxMenu;
585 auto c = Config::instance()->decode_reduction();
586 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
587 view->AppendSeparator();
588 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
589 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
591 view->AppendSeparator();
592 view->Append(ID_view_closed_captions, _("Closed captions..."));
593 view->AppendSeparator();
594 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
595 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
596 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
597 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
599 auto tools = new wxMenu;
600 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
601 tools->AppendSeparator ();
602 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
603 tools->Append (ID_tools_timing, _("Timing..."));
604 tools->Append (ID_tools_system_information, _("System information..."));
606 auto help = new wxMenu;
608 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
610 help->Append (wxID_ABOUT, _("About"));
612 help->Append (ID_help_report_a_problem, _("Report a problem..."));
614 m->Append (_file_menu, _("&File"));
616 m->Append (edit, _("&Edit"));
618 m->Append (view, _("&View"));
619 m->Append (tools, _("&Tools"));
620 m->Append (help, _("&Help"));
625 auto d = wxStandardPaths::Get().GetDocumentsDir();
626 if (Config::instance()->last_player_load_directory()) {
627 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
630 auto c = make_wx<wxDirDialog>(this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
635 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
636 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
643 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
645 Config::instance()->set_last_player_load_directory (dcp.parent_path());
651 auto initial_dir = wxStandardPaths::Get().GetDocumentsDir();
652 if (Config::instance()->last_player_load_directory()) {
653 initial_dir = std_to_wx(Config::instance()->last_player_load_directory()->string());
656 auto c = make_wx<wxDirDialog>(
658 _("Select DCP to open as OV"),
660 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
666 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
667 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
674 DCPOMATIC_ASSERT (_film);
675 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
676 DCPOMATIC_ASSERT (dcp);
677 dcp->add_ov (wx_to_std(c->GetPath()));
678 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
679 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
680 if (!ok || !report_errors_from_last_job(this)) {
683 for (auto i: dcp->text) {
687 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
689 _film->set_container(r);
694 _info->triggered_update ();
699 auto d = make_wx<wxFileDialog>(this, _("Select KDM"));
701 if (d->ShowModal() == wxID_OK) {
702 DCPOMATIC_ASSERT (_film);
703 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
704 DCPOMATIC_ASSERT (dcp);
707 _viewer.set_coalesce_player_changes(true);
708 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
710 _viewer.set_coalesce_player_changes(false);
712 } catch (exception& e) {
713 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
718 _info->triggered_update ();
721 void file_save_frame ()
723 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg;*.jpeg)|*.jpg;*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
724 if (dialog.ShowModal() == wxID_CANCEL) {
728 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
730 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
731 player->seek(_viewer.position(), true);
734 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
735 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
737 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
738 image_as_png(image).write(path);
739 } else if (ext == ".jpg" || ext == ".jpeg") {
740 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
741 image_as_jpeg(image, 80).write(path);
743 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
749 while (!done && tries_left >= 0) {
754 DCPOMATIC_ASSERT (tries_left >= 0);
757 void file_history (wxCommandEvent& event)
759 auto history = Config::instance()->player_history ();
760 int n = event.GetId() - ID_file_history;
761 if (n >= 0 && n < static_cast<int> (history.size ())) {
763 load_dcp (history[n]);
764 } catch (exception& e) {
765 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
773 _info->triggered_update ();
774 set_menu_sensitivity ();
782 void edit_preferences ()
784 if (!Config::instance()->have_write_permission()) {
788 if (!_config_dialog) {
789 _config_dialog = create_player_config_dialog ();
791 _config_dialog->Show (this);
794 void view_cpl (wxCommandEvent& ev)
796 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
797 DCPOMATIC_ASSERT (dcp);
798 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
799 int id = ev.GetId() - ID_view_cpl;
800 DCPOMATIC_ASSERT (id >= 0);
801 DCPOMATIC_ASSERT (id < int(cpls.size()));
802 auto i = cpls.begin();
808 _viewer.set_coalesce_player_changes(true);
809 dcp->set_cpl ((*i)->id());
811 _viewer.set_coalesce_player_changes(false);
813 _info->triggered_update ();
816 void view_full_screen ()
818 if (_mode == Config::PLAYER_MODE_FULL) {
819 _mode = Config::PLAYER_MODE_WINDOW;
821 _mode = Config::PLAYER_MODE_FULL;
827 void view_dual_screen ()
829 if (_mode == Config::PLAYER_MODE_DUAL) {
830 _mode = Config::PLAYER_MODE_WINDOW;
832 _mode = Config::PLAYER_MODE_DUAL;
840 if (_view_full_screen) {
841 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
843 if (_view_dual_screen) {
844 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
850 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
851 _info->Show (_mode != Config::PLAYER_MODE_FULL);
852 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
853 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
854 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
856 if (_mode == Config::PLAYER_MODE_DUAL) {
857 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
858 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
859 _dual_screen->ShowFullScreen (true);
860 _viewer.panel()->Reparent(_dual_screen);
861 _viewer.panel()->SetFocus();
862 _dual_screen->Show ();
863 if (wxDisplay::GetCount() > 1) {
864 switch (Config::instance()->image_display()) {
866 _dual_screen->Move (0, 0);
867 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
870 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
871 // (0, 0) doesn't seem to work for some strange reason
876 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
879 _viewer.panel()->Reparent(_overall_panel);
880 _dual_screen->Destroy ();
885 setup_main_sizer (_mode);
888 void dual_screen_key_press(wxKeyEvent& ev)
890 if (ev.GetKeyCode() == WXK_F11) {
891 if (ev.ShiftDown()) {
893 } else if (!ev.HasAnyModifiers()) {
899 void view_closed_captions ()
901 _viewer.show_closed_captions();
906 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
907 DCPOMATIC_ASSERT (dcp);
909 auto job = make_shared<VerifyDCPJob>(dcp->directories());
910 auto progress = make_wx<VerifyDCPProgressDialog>(this, _("DCP-o-matic Player"));
911 bool const completed = progress->run (job);
916 auto d = make_wx<VerifyDCPDialog>(this, job);
920 void tools_check_for_updates ()
922 UpdateChecker::instance()->run ();
923 _update_news_requested = true;
928 auto d = make_wx<TimerDisplay>(this, _viewer.state_timer(), _viewer.gets());
932 void tools_system_information ()
934 if (!_system_information_dialog) {
935 _system_information_dialog = new SystemInformationDialog (this, _viewer);
938 _system_information_dialog->Show ();
943 auto d = make_wx<AboutDialog>(this);
947 void help_report_a_problem ()
949 auto d = make_wx<ReportProblemDialog>(this);
950 if (d->ShowModal () == wxID_OK) {
955 void update_checker_state_changed ()
957 auto uc = UpdateChecker::instance ();
959 bool const announce =
960 _update_news_requested ||
961 (uc->stable() && Config::instance()->check_for_updates()) ||
962 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
964 _update_news_requested = false;
970 if (uc->state() == UpdateChecker::State::YES) {
971 auto dialog = make_wx<UpdateDialog>(this, uc->stable (), uc->test ());
972 dialog->ShowModal ();
973 } else if (uc->state() == UpdateChecker::State::FAILED) {
974 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
976 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
979 _update_news_requested = false;
982 void config_changed (Config::Property prop)
984 /* Instantly save any config changes when using the player GUI */
986 Config::instance()->write_config();
987 } catch (FileError& e) {
988 if (prop != Config::HISTORY) {
992 _("Could not write to config file at %s. Your changes have not been saved."),
993 std_to_wx(e.file().string())
997 } catch (exception& e) {
1000 _("Could not write to config file. Your changes have not been saved.")
1004 update_from_config (prop);
1007 void update_from_config (Config::Property prop)
1009 for (int i = 0; i < _history_items; ++i) {
1010 delete _file_menu->Remove (ID_file_history + i);
1013 if (_history_separator) {
1014 _file_menu->Remove (_history_separator);
1016 delete _history_separator;
1017 _history_separator = nullptr;
1019 int pos = _history_position;
1021 /* Clear out non-existent history items before we re-build the menu */
1022 Config::instance()->clean_player_history ();
1023 auto history = Config::instance()->player_history ();
1025 if (!history.empty ()) {
1026 _history_separator = _file_menu->InsertSeparator (pos++);
1029 for (size_t i = 0; i < history.size(); ++i) {
1032 s = String::compose ("&%1 %2", i + 1, history[i].string());
1034 s = history[i].string();
1036 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1039 _history_items = history.size ();
1041 if (prop == Config::PLAYER_DEBUG_LOG) {
1042 auto p = Config::instance()->player_debug_log_file();
1044 dcpomatic_log = make_shared<FileLog>(*p);
1046 dcpomatic_log = make_shared<NullLog>();
1048 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1052 void set_menu_sensitivity ()
1054 _tools_verify->Enable (static_cast<bool>(_film));
1055 _file_add_ov->Enable (static_cast<bool>(_film));
1056 _file_add_kdm->Enable (static_cast<bool>(_film));
1057 _file_save_frame->Enable (static_cast<bool>(_film));
1058 _view_cpl->Enable (static_cast<bool>(_film));
1061 void start_stop_pressed ()
1063 if (_viewer.playing()) {
1070 void go_back_frame ()
1072 _viewer.seek_by(-_viewer.one_video_frame(), true);
1075 void go_forward_frame ()
1077 _viewer.seek_by(_viewer.one_video_frame(), true);
1080 void go_seconds (int s)
1082 _viewer.seek_by(DCPTime::from_seconds(s), true);
1087 _viewer.seek(DCPTime(), true);
1092 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1095 wxFrame* _dual_screen = nullptr;
1096 bool _update_news_requested = false;
1097 PlayerInformation* _info = nullptr;
1098 Config::PlayerMode _mode;
1099 wxPreferencesEditor* _config_dialog = nullptr;
1100 wxPanel* _overall_panel = nullptr;
1101 wxMenu* _file_menu = nullptr;
1102 wxMenuItem* _view_cpl = nullptr;
1103 wxMenu* _cpl_menu = nullptr;
1104 int _history_items = 0;
1105 int _history_position = 0;
1106 wxMenuItem* _history_separator = nullptr;
1108 Controls* _controls;
1109 SystemInformationDialog* _system_information_dialog = nullptr;
1110 std::shared_ptr<Film> _film;
1111 boost::signals2::scoped_connection _config_changed_connection;
1112 boost::signals2::scoped_connection _examine_job_connection;
1113 wxMenuItem* _file_add_ov = nullptr;
1114 wxMenuItem* _file_add_kdm = nullptr;
1115 wxMenuItem* _file_save_frame = nullptr;
1116 wxMenuItem* _tools_verify = nullptr;
1117 wxMenuItem* _view_full_screen = nullptr;
1118 wxMenuItem* _view_dual_screen = nullptr;
1119 wxSizer* _main_sizer = nullptr;
1120 PlayerStressTester _stress;
1123 static const wxCmdLineEntryDesc command_line_description[] = {
1124 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1125 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1126 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1127 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1130 class PlayServer : public Server
1133 explicit PlayServer (DOMFrame* frame)
1134 : Server (PLAYER_PLAY_PORT)
1138 void handle (shared_ptr<Socket> socket) override
1141 int const length = socket->read_uint32 ();
1142 scoped_array<char> buffer (new char[length]);
1143 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1144 string s (buffer.get());
1145 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1146 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1157 * @brief The magic App class for wxWidgets.
1159 class App : public wxApp
1165 #ifdef DCPOMATIC_LINUX
1172 bool OnInit () override
1174 wx_ptr<wxSplashScreen> splash;
1176 wxInitAllImageHandlers ();
1178 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1179 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1181 splash = maybe_show_splash ();
1183 SetAppName (_("DCP-o-matic Player"));
1185 if (!wxApp::OnInit()) {
1189 #ifdef DCPOMATIC_LINUX
1190 unsetenv ("UBUNTU_MENUPROXY");
1193 #ifdef DCPOMATIC_OSX
1194 make_foreground_application ();
1197 dcpomatic_setup_path_encoding ();
1199 /* Enable i18n; this will create a Config object
1200 to look for a force-configured language. This Config
1201 object will be wrong, however, because dcpomatic_setup
1202 hasn't yet been called and there aren't any filters etc.
1205 dcpomatic_setup_i18n ();
1207 /* Set things up, including filters etc.
1208 which will now be internationalised correctly.
1212 /* Force the configuration to be re-loaded correctly next
1217 signal_manager = new wxSignalManager (this);
1219 _frame = new DOMFrame ();
1220 SetTopWindow (_frame);
1221 _frame->Maximize ();
1229 auto server = new PlayServer (_frame);
1230 new thread (boost::bind (&PlayServer::run, server));
1231 } catch (std::exception& e) {
1232 /* This is not the end of the world; probably a failure to bind the server socket
1233 * because there's already another player running.
1235 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1238 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1240 _frame->load_dcp (_dcp_to_load);
1241 } catch (exception& e) {
1242 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1248 _frame->load_stress_script (*_stress);
1249 } catch (exception& e) {
1250 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1254 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1256 if (Config::instance()->check_for_updates ()) {
1257 UpdateChecker::instance()->run ();
1260 catch (exception& e)
1265 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1271 void OnInitCmdLine (wxCmdLineParser& parser) override
1273 parser.SetDesc (command_line_description);
1274 parser.SetSwitchChars (wxT ("-"));
1277 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1279 if (parser.GetParamCount() > 0) {
1280 _dcp_to_load = wx_to_std (parser.GetParam (0));
1284 if (parser.Found("c", &config)) {
1285 Config::override_path = wx_to_std (config);
1288 if (parser.Found("s", &stress)) {
1289 _stress = wx_to_std (stress);
1295 void report_exception ()
1299 } catch (FileError& e) {
1303 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1304 std_to_wx (e.what()),
1305 std_to_wx (e.file().string().c_str ())
1308 } catch (exception& e) {
1312 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1313 std_to_wx (e.what ())
1317 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1321 /* An unhandled exception has occurred inside the main event loop */
1322 bool OnExceptionInMainLoop () override
1324 report_exception ();
1325 /* This will terminate the program */
1329 void OnUnhandledException () override
1331 report_exception ();
1336 signal_manager->ui_idle ();
1339 void config_failed_to_load ()
1341 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1344 void config_warning (string m)
1346 message_dialog (_frame, std_to_wx (m));
1349 DOMFrame* _frame = nullptr;
1350 string _dcp_to_load;
1351 boost::optional<string> _stress;