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/file_dialog.h"
23 #include "wx/film_viewer.h"
24 #include "wx/nag_dialog.h"
25 #include "wx/player_config_dialog.h"
26 #include "wx/player_information.h"
27 #include "wx/player_stress_tester.h"
28 #include "wx/playlist_controls.h"
29 #include "wx/report_problem_dialog.h"
30 #include "wx/standard_controls.h"
31 #include "wx/system_information_dialog.h"
32 #include "wx/timer_display.h"
33 #include "wx/update_dialog.h"
34 #include "wx/verify_dcp_dialog.h"
35 #include "wx/verify_dcp_progress_dialog.h"
36 #include "wx/wx_ptr.h"
37 #include "wx/wx_signal_manager.h"
38 #include "wx/wx_util.h"
39 #include "lib/compose.hpp"
40 #include "lib/config.h"
41 #include "lib/constants.h"
42 #include "lib/cross.h"
43 #include "lib/dcp_content.h"
44 #include "lib/dcp_examiner.h"
45 #include "lib/dcpomatic_log.h"
46 #include "lib/dcpomatic_socket.h"
47 #include "lib/examine_content_job.h"
48 #include "lib/ffmpeg_content.h"
49 #include "lib/file_log.h"
51 #include "lib/font_config.h"
52 #include "lib/image.h"
53 #include "lib/image_jpeg.h"
54 #include "lib/image_png.h"
55 #include "lib/internet.h"
57 #include "lib/job_manager.h"
58 #include "lib/null_log.h"
59 #include "lib/player.h"
60 #include "lib/player_video.h"
61 #include "lib/ratio.h"
62 #include "lib/scope_guard.h"
63 #include "lib/scoped_temporary.h"
64 #include "lib/server.h"
65 #include "lib/text_content.h"
66 #include "lib/update_checker.h"
67 #include "lib/verify_dcp_job.h"
68 #include "lib/video_content.h"
71 #include <dcp/exceptions.h>
72 #include <dcp/filesystem.h>
73 #include <dcp/raw_convert.h>
74 #include <dcp/search.h>
75 #include <dcp/warnings.h>
76 LIBDCP_DISABLE_WARNINGS
77 #include <wx/cmdline.h>
78 #include <wx/display.h>
80 #include <wx/preferences.h>
81 #include <wx/progdlg.h>
82 #include <wx/splash.h>
83 #include <wx/stdpaths.h>
85 LIBDCP_ENABLE_WARNINGS
89 #include <boost/algorithm/string.hpp>
90 #include <boost/bind/bind.hpp>
102 using std::dynamic_pointer_cast;
103 using std::exception;
105 using std::make_shared;
106 using std::shared_ptr;
111 using boost::optional;
112 using boost::scoped_array;
114 #if BOOST_VERSION >= 106100
115 using namespace boost::placeholders;
117 using dcp::raw_convert;
118 using namespace dcpomatic;
127 /* Allow spare IDs after _history for the recent files list */
130 /* Allow spare IDs for CPLs */
131 ID_view_full_screen = 200,
133 ID_view_closed_captions,
134 ID_view_scale_appropriate,
137 ID_view_scale_quarter,
138 ID_help_report_a_problem,
140 ID_tools_check_for_updates,
142 ID_tools_system_information,
143 /* IDs for shortcuts (with no associated menu item) */
147 ID_go_back_small_amount,
148 ID_go_forward_small_amount,
149 ID_go_back_medium_amount,
150 ID_go_forward_medium_amount,
151 ID_go_back_large_amount,
152 ID_go_forward_large_amount,
158 class DOMFrame : public wxFrame
162 class DCPDropTarget : public wxFileDropTarget
165 DCPDropTarget(DOMFrame* owner)
169 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
171 if (filenames.GetCount() == 1) {
172 /* Try to load a directory */
173 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
174 if (dcp::filesystem::is_directory(path)) {
175 _frame->load_dcp(wx_to_std(filenames[0]));
180 if (filenames.GetCount() >= 1) {
181 /* Try to load the parent if we drop some files, one if which is an asset map */
182 for (size_t i = 0; i < filenames.GetCount(); ++i) {
183 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
184 if (path.filename() == "ASSETMAP" || path.filename() == "ASSETMAP.xml") {
185 _frame->load_dcp(path.parent_path());
200 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
201 , _mode (Config::instance()->player_mode())
202 /* Use a panel as the only child of the Frame so that we avoid
203 the dark-grey background on Windows.
205 , _overall_panel(new wxPanel(this, wxID_ANY))
206 , _viewer(_overall_panel)
207 , _main_sizer (new wxBoxSizer(wxVERTICAL))
209 dcpomatic_log = make_shared<NullLog>();
211 #if defined(DCPOMATIC_WINDOWS)
212 maybe_open_console ();
213 cout << "DCP-o-matic Player is starting." << "\n";
216 auto bar = new wxMenuBar;
218 set_menu_sensitivity ();
221 #ifdef DCPOMATIC_WINDOWS
222 SetIcon (wxIcon (std_to_wx ("id")));
225 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
226 update_from_config (Config::PLAYER_DEBUG_LOG);
228 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
229 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
230 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
231 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
232 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
233 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
234 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
235 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
236 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
237 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
238 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
239 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
240 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
241 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
242 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
243 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
244 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
245 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
246 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
247 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
248 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
250 Bind(wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
252 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
253 auto pc = new PlaylistControls (_overall_panel, _viewer);
255 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
257 _controls = new StandardControls (_overall_panel, _viewer, false);
259 _controls->set_film(_viewer.film());
260 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
261 _viewer.set_optimise_for_j2k(true);
262 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
263 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
264 _info = new PlayerInformation (_overall_panel, _viewer);
265 setup_main_sizer (Config::instance()->player_mode());
267 int accelerators = 12;
269 int accelerators = 11;
272 _stress.setup (this, _controls);
274 std::vector<wxAcceleratorEntry> accel(accelerators);
275 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
276 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
277 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
278 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
279 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
280 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
281 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
282 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
283 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
284 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
285 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
287 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
289 wxAcceleratorTable accel_table (accelerators, accel.data());
290 SetAcceleratorTable (accel_table);
292 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
295 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
296 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
297 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
298 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
299 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
300 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
301 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
302 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
306 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
309 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
311 SetDropTarget(new DCPDropTarget(this));
316 /* It's important that this is stopped before our frame starts destroying its children,
317 * otherwise UI elements that it depends on will disappear from under it.
322 void close(wxCloseEvent& ev)
328 void setup_main_sizer (Config::PlayerMode mode)
330 _main_sizer->Detach(_viewer.panel());
331 _main_sizer->Detach (_controls);
332 _main_sizer->Detach (_info);
333 if (mode != Config::PLAYER_MODE_DUAL) {
334 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
336 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
337 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
338 _overall_panel->SetSizer (_main_sizer);
339 _overall_panel->Layout ();
342 bool playback_permitted ()
344 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
349 for (auto i: _film->content()) {
350 auto d = dynamic_pointer_cast<DCPContent>(i);
351 if (d && !d->kdm_timing_window_valid()) {
357 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
364 void too_many_frames_dropped ()
366 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
370 NagDialog::maybe_nag (
372 Config::NAG_TOO_MANY_DROPPED_FRAMES,
373 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
374 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
375 "You may be able to improve player performance by:\n"
376 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
377 "• using a more powerful computer.\n"
382 void set_decode_reduction (optional<int> reduction)
384 _viewer.set_dcp_decode_reduction(reduction);
385 _info->triggered_update ();
386 Config::instance()->set_decode_reduction (reduction);
389 void load_dcp (boost::filesystem::path dir)
391 DCPOMATIC_ASSERT (_film);
395 _stress.set_suspended (true);
396 auto dcp = make_shared<DCPContent>(dir);
397 auto job = make_shared<ExamineContentJob>(_film, dcp);
398 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
399 JobManager::instance()->add (job);
400 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
401 if (!ok || !report_errors_from_last_job(this)) {
404 Config::instance()->add_to_player_history (dir);
405 if (dcp->video_frame_rate()) {
406 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
408 } catch (ProjectFolderError &) {
411 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
413 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
414 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to play."
417 } catch (dcp::ReadError& e) {
418 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
419 } catch (DCPError& e) {
420 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
424 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
426 auto job = weak_job.lock ();
427 if (!job || !job->finished_ok()) {
431 auto content = weak_content.lock ();
436 _film->add_content (content);
437 _stress.set_suspended (false);
440 void reset_film_weak (weak_ptr<Film> weak_film)
442 auto film = weak_film.lock ();
448 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
451 _film->set_tolerant (true);
452 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
453 _viewer.set_film(_film);
454 _controls->set_film (_film);
455 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
456 _info->triggered_update ();
459 void film_changed (ChangeType type, FilmProperty property)
461 if (type != ChangeType::DONE || property != FilmProperty::CONTENT) {
465 if (_viewer.playing()) {
469 /* Start off as Flat */
470 _film->set_container (Ratio::from_id("185"));
472 for (auto i: _film->content()) {
473 auto dcp = dynamic_pointer_cast<DCPContent>(i);
475 for (auto j: i->text) {
480 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
481 if (r->id() == "239") {
482 /* Any scope content means we use scope */
483 _film->set_container(r);
487 /* Any 3D content means we use 3D mode */
488 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
489 _film->set_three_d (true);
493 _viewer.seek(DCPTime(), true);
494 _info->triggered_update ();
496 set_menu_sensitivity ();
498 auto old = _cpl_menu->GetMenuItems();
499 for (auto const& i: old) {
500 _cpl_menu->Remove (i);
503 if (_film->content().size() == 1) {
504 /* Offer a CPL menu */
505 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
507 int id = ID_view_cpl;
508 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
509 auto j = _cpl_menu->AppendRadioItem(
511 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
513 j->Check(!first->cpl() || i->id() == *first->cpl());
520 void load_stress_script (boost::filesystem::path path)
522 _stress.load_script (path);
527 void examine_content ()
529 DCPOMATIC_ASSERT (_film);
530 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
531 DCPOMATIC_ASSERT (dcp);
532 dcp->examine (_film, shared_ptr<Job>());
534 /* Examining content re-creates the TextContent objects, so we must re-enable them */
535 for (auto i: dcp->text) {
540 bool report_errors_from_last_job (wxWindow* parent) const
542 auto jm = JobManager::instance ();
544 DCPOMATIC_ASSERT (!jm->get().empty());
546 auto last = jm->get().back();
547 if (last->finished_in_error()) {
548 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()));
555 void setup_menu (wxMenuBar* m)
557 _file_menu = new wxMenu;
558 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
559 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
560 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
561 _file_menu->AppendSeparator ();
562 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
564 _history_position = _file_menu->GetMenuItems().GetCount();
566 _file_menu->AppendSeparator ();
567 _file_menu->Append (ID_file_close, _("&Close"));
568 _file_menu->AppendSeparator ();
571 _file_menu->Append (wxID_EXIT, _("&Exit"));
573 _file_menu->Append (wxID_EXIT, _("&Quit"));
577 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
579 auto edit = new wxMenu;
580 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
583 prefs->Enable (Config::instance()->have_write_permission());
585 _cpl_menu = new wxMenu;
587 auto view = new wxMenu;
588 auto c = Config::instance()->decode_reduction();
589 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
590 view->AppendSeparator();
591 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
592 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
594 view->AppendSeparator();
595 view->Append(ID_view_closed_captions, _("Closed captions..."));
596 view->AppendSeparator();
597 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
598 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
599 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
600 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
602 auto tools = new wxMenu;
603 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
604 tools->AppendSeparator ();
605 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
606 tools->Append (ID_tools_timing, _("Timing..."));
607 tools->Append (ID_tools_system_information, _("System information..."));
609 auto help = new wxMenu;
611 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
613 help->Append (wxID_ABOUT, _("About"));
615 help->Append (ID_help_report_a_problem, _("Report a problem..."));
617 m->Append (_file_menu, _("&File"));
619 m->Append (edit, _("&Edit"));
621 m->Append (view, _("&View"));
622 m->Append (tools, _("&Tools"));
623 m->Append (help, _("&Help"));
628 auto d = wxStandardPaths::Get().GetDocumentsDir();
629 if (Config::instance()->last_player_load_directory()) {
630 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
633 auto c = make_wx<wxDirDialog>(this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
638 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
639 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
646 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
648 Config::instance()->set_last_player_load_directory (dcp.parent_path());
654 auto initial_dir = wxStandardPaths::Get().GetDocumentsDir();
655 if (Config::instance()->last_player_load_directory()) {
656 initial_dir = std_to_wx(Config::instance()->last_player_load_directory()->string());
659 auto c = make_wx<wxDirDialog>(
661 _("Select DCP to open as OV"),
663 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
669 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
670 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
677 DCPOMATIC_ASSERT (_film);
678 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
679 DCPOMATIC_ASSERT (dcp);
680 dcp->add_ov (wx_to_std(c->GetPath()));
681 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
682 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
683 if (!ok || !report_errors_from_last_job(this)) {
686 for (auto i: dcp->text) {
690 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
692 _film->set_container(r);
697 _info->triggered_update ();
702 FileDialog dialog(this, _("Select KDM"), wxT("XML files|*.xml|All files|*.*"), wxFD_MULTIPLE, "AddKDMPath");
705 DCPOMATIC_ASSERT (_film);
706 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
707 DCPOMATIC_ASSERT (dcp);
710 ScopeGuard sg([this]() {
711 _viewer.set_coalesce_player_changes(false);
713 _viewer.set_coalesce_player_changes(true);
714 for (auto path: dialog.paths()) {
715 dcp->add_kdm(dcp::EncryptedKDM(dcp::file_to_string(path)));
716 _kdms.push_back(path);
720 } catch (exception& e) {
721 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
726 _info->triggered_update ();
729 void file_save_frame ()
731 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg;*.jpeg)|*.jpg;*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
732 if (dialog.ShowModal() == wxID_CANCEL) {
736 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
738 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
739 player->seek(_viewer.position(), true);
742 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
743 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
745 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
746 image_as_png(image).write(path);
747 } else if (ext == ".jpg" || ext == ".jpeg") {
748 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
749 image_as_jpeg(image, 80).write(path);
751 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
757 while (!done && tries_left >= 0) {
762 DCPOMATIC_ASSERT (tries_left >= 0);
765 void file_history (wxCommandEvent& event)
767 auto history = Config::instance()->player_history ();
768 int n = event.GetId() - ID_file_history;
769 if (n >= 0 && n < static_cast<int> (history.size ())) {
771 load_dcp (history[n]);
772 } catch (exception& e) {
773 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
781 _info->triggered_update ();
782 set_menu_sensitivity ();
790 void edit_preferences ()
792 if (!Config::instance()->have_write_permission()) {
796 if (!_config_dialog) {
797 _config_dialog = create_player_config_dialog ();
799 _config_dialog->Show (this);
802 void view_cpl (wxCommandEvent& ev)
804 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
805 DCPOMATIC_ASSERT (dcp);
806 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
807 int id = ev.GetId() - ID_view_cpl;
808 DCPOMATIC_ASSERT (id >= 0);
809 DCPOMATIC_ASSERT (id < int(cpls.size()));
810 auto i = cpls.begin();
816 _viewer.set_coalesce_player_changes(true);
817 dcp->set_cpl ((*i)->id());
819 _viewer.set_coalesce_player_changes(false);
821 _info->triggered_update ();
824 void view_full_screen ()
826 if (_mode == Config::PLAYER_MODE_FULL) {
827 _mode = Config::PLAYER_MODE_WINDOW;
829 _mode = Config::PLAYER_MODE_FULL;
835 void view_dual_screen ()
837 if (_mode == Config::PLAYER_MODE_DUAL) {
838 _mode = Config::PLAYER_MODE_WINDOW;
840 _mode = Config::PLAYER_MODE_DUAL;
848 if (_view_full_screen) {
849 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
851 if (_view_dual_screen) {
852 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
858 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
859 _info->Show (_mode != Config::PLAYER_MODE_FULL);
860 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
861 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
862 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
864 if (_mode == Config::PLAYER_MODE_DUAL) {
865 std::cout << "Set up dual screen mode: " << wxDisplay::GetCount() << " displays.\n";
866 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
867 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
868 _dual_screen->ShowFullScreen (true);
869 _viewer.panel()->Reparent(_dual_screen);
870 _viewer.panel()->SetFocus();
871 _dual_screen->Show ();
872 for (auto index = 0U; index < wxDisplay::GetCount(); ++index) {
873 auto client = wxDisplay(index).GetClientArea();
874 auto mode = wxDisplay(index).GetCurrentMode();
875 auto geometry = wxDisplay(index).GetGeometry();
876 std::cout << "Display " << index << "\n";
877 std::cout << " ClientArea (" << client.GetX() << ", " << client.GetY() << ") (" << client.GetWidth() << ", " << client.GetHeight() << ")\n";
878 std::cout << " Geometry (" << geometry.GetX() << ", " << geometry.GetY() << ") (" << geometry.GetWidth() << ", " << geometry.GetHeight() << ")\n";
879 std::cout << " Mode (" << mode.GetWidth() << ", " << mode.GetHeight() << ")\n";
880 std::cout << " Primary? " << wxDisplay(index).IsPrimary() << "\n";
882 if (wxDisplay::GetCount() > 1) {
883 wxRect geometry[2] = {
884 wxDisplay(0U).GetGeometry(),
885 wxDisplay(1U).GetGeometry()
887 auto const image_display = Config::instance()->image_display();
888 _dual_screen->Move(geometry[image_display].GetX(), geometry[image_display].GetY());
889 _viewer.panel()->SetSize(geometry[image_display].GetWidth(), geometry[image_display].GetHeight());
890 Move(geometry[1 - image_display].GetX(), geometry[1 - image_display].GetY());
892 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
895 _viewer.panel()->Reparent(_overall_panel);
896 _dual_screen->Destroy ();
901 setup_main_sizer (_mode);
904 void dual_screen_key_press(wxKeyEvent& ev)
906 if (ev.GetKeyCode() == WXK_F11) {
907 if (ev.ShiftDown()) {
909 } else if (!ev.HasAnyModifiers()) {
915 void view_closed_captions ()
917 _viewer.show_closed_captions();
922 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
923 DCPOMATIC_ASSERT (dcp);
925 auto job = make_shared<VerifyDCPJob>(dcp->directories(), _kdms);
926 VerifyDCPProgressDialog progress(this, _("DCP-o-matic Player"));
927 bool const completed = progress.run(job);
931 VerifyDCPDialog dialog(this, job);
936 void tools_check_for_updates ()
938 UpdateChecker::instance()->run ();
939 _update_news_requested = true;
944 auto d = make_wx<TimerDisplay>(this, _viewer.state_timer(), _viewer.gets());
948 void tools_system_information ()
950 if (!_system_information_dialog) {
951 _system_information_dialog = new SystemInformationDialog (this, _viewer);
954 _system_information_dialog->Show ();
959 auto d = make_wx<AboutDialog>(this);
963 void help_report_a_problem ()
965 auto d = make_wx<ReportProblemDialog>(this);
966 if (d->ShowModal () == wxID_OK) {
971 void update_checker_state_changed ()
973 auto uc = UpdateChecker::instance ();
975 bool const announce =
976 _update_news_requested ||
977 (uc->stable() && Config::instance()->check_for_updates()) ||
978 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
980 _update_news_requested = false;
986 if (uc->state() == UpdateChecker::State::YES) {
987 auto dialog = make_wx<UpdateDialog>(this, uc->stable (), uc->test ());
988 dialog->ShowModal ();
989 } else if (uc->state() == UpdateChecker::State::FAILED) {
990 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
992 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
995 _update_news_requested = false;
998 void config_changed (Config::Property prop)
1000 /* Instantly save any config changes when using the player GUI */
1002 Config::instance()->write_config();
1003 } catch (FileError& e) {
1004 if (prop != Config::HISTORY) {
1008 _("Could not write to config file at %s. Your changes have not been saved."),
1009 std_to_wx(e.file().string())
1013 } catch (exception& e) {
1016 _("Could not write to config file. Your changes have not been saved.")
1020 update_from_config (prop);
1023 void update_from_config (Config::Property prop)
1025 for (int i = 0; i < _history_items; ++i) {
1026 delete _file_menu->Remove (ID_file_history + i);
1029 if (_history_separator) {
1030 _file_menu->Remove (_history_separator);
1032 delete _history_separator;
1033 _history_separator = nullptr;
1035 int pos = _history_position;
1037 /* Clear out non-existent history items before we re-build the menu */
1038 Config::instance()->clean_player_history ();
1039 auto history = Config::instance()->player_history ();
1041 if (!history.empty ()) {
1042 _history_separator = _file_menu->InsertSeparator (pos++);
1045 for (size_t i = 0; i < history.size(); ++i) {
1048 s = String::compose ("&%1 %2", i + 1, history[i].string());
1050 s = history[i].string();
1052 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1055 _history_items = history.size ();
1057 if (prop == Config::PLAYER_DEBUG_LOG) {
1058 auto p = Config::instance()->player_debug_log_file();
1060 dcpomatic_log = make_shared<FileLog>(*p);
1062 dcpomatic_log = make_shared<NullLog>();
1064 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1068 void set_menu_sensitivity ()
1070 _tools_verify->Enable (static_cast<bool>(_film));
1071 _file_add_ov->Enable (static_cast<bool>(_film));
1072 _file_add_kdm->Enable (static_cast<bool>(_film));
1073 _file_save_frame->Enable (static_cast<bool>(_film));
1074 _view_cpl->Enable (static_cast<bool>(_film));
1077 void start_stop_pressed ()
1079 if (_viewer.playing()) {
1086 void go_back_frame ()
1088 _viewer.seek_by(-_viewer.one_video_frame(), true);
1091 void go_forward_frame ()
1093 _viewer.seek_by(_viewer.one_video_frame(), true);
1096 void go_seconds (int s)
1098 _viewer.seek_by(DCPTime::from_seconds(s), true);
1103 _viewer.seek(DCPTime(), true);
1108 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1111 wxFrame* _dual_screen = nullptr;
1112 bool _update_news_requested = false;
1113 PlayerInformation* _info = nullptr;
1114 Config::PlayerMode _mode;
1115 wxPreferencesEditor* _config_dialog = nullptr;
1116 wxPanel* _overall_panel = nullptr;
1117 wxMenu* _file_menu = nullptr;
1118 wxMenuItem* _view_cpl = nullptr;
1119 wxMenu* _cpl_menu = nullptr;
1120 int _history_items = 0;
1121 int _history_position = 0;
1122 wxMenuItem* _history_separator = nullptr;
1124 Controls* _controls;
1125 SystemInformationDialog* _system_information_dialog = nullptr;
1126 std::shared_ptr<Film> _film;
1127 boost::signals2::scoped_connection _config_changed_connection;
1128 boost::signals2::scoped_connection _examine_job_connection;
1129 wxMenuItem* _file_add_ov = nullptr;
1130 wxMenuItem* _file_add_kdm = nullptr;
1131 wxMenuItem* _file_save_frame = nullptr;
1132 wxMenuItem* _tools_verify = nullptr;
1133 wxMenuItem* _view_full_screen = nullptr;
1134 wxMenuItem* _view_dual_screen = nullptr;
1135 wxSizer* _main_sizer = nullptr;
1136 PlayerStressTester _stress;
1137 /** KDMs that have been loaded, so that we can pass them to the verifier */
1138 std::vector<boost::filesystem::path> _kdms;
1141 static const wxCmdLineEntryDesc command_line_description[] = {
1142 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1143 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1144 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1145 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1148 class PlayServer : public Server
1151 explicit PlayServer (DOMFrame* frame)
1152 : Server (PLAYER_PLAY_PORT)
1156 void handle (shared_ptr<Socket> socket) override
1159 uint32_t const length = socket->read_uint32 ();
1160 if (length > 65536) {
1163 scoped_array<char> buffer (new char[length]);
1164 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1165 string s (buffer.get());
1166 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1167 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1178 * @brief The magic App class for wxWidgets.
1180 class App : public wxApp
1186 #ifdef DCPOMATIC_LINUX
1193 bool OnInit () override
1195 wxSplashScreen* splash;
1197 wxInitAllImageHandlers ();
1199 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1200 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1202 splash = maybe_show_splash ();
1204 SetAppName (_("DCP-o-matic Player"));
1206 if (!wxApp::OnInit()) {
1210 #ifdef DCPOMATIC_LINUX
1211 unsetenv ("UBUNTU_MENUPROXY");
1214 #ifdef DCPOMATIC_OSX
1215 make_foreground_application ();
1218 dcpomatic_setup_path_encoding ();
1220 /* Enable i18n; this will create a Config object
1221 to look for a force-configured language. This Config
1222 object will be wrong, however, because dcpomatic_setup
1223 hasn't yet been called and there aren't any filters etc.
1226 dcpomatic_setup_i18n ();
1228 /* Set things up, including filters etc.
1229 which will now be internationalised correctly.
1233 /* Force the configuration to be re-loaded correctly next
1238 signal_manager = new wxSignalManager (this);
1240 _frame = new DOMFrame ();
1241 SetTopWindow (_frame);
1242 _frame->Maximize ();
1250 auto server = new PlayServer (_frame);
1251 new thread (boost::bind (&PlayServer::run, server));
1252 } catch (std::exception& e) {
1253 /* This is not the end of the world; probably a failure to bind the server socket
1254 * because there's already another player running.
1256 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1259 if (!_dcp_to_load.empty() && dcp::filesystem::is_directory(_dcp_to_load)) {
1261 _frame->load_dcp (_dcp_to_load);
1262 } catch (exception& e) {
1263 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1269 _frame->load_stress_script (*_stress);
1270 } catch (exception& e) {
1271 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1275 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1277 if (Config::instance()->check_for_updates ()) {
1278 UpdateChecker::instance()->run ();
1281 catch (exception& e)
1286 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1292 void OnInitCmdLine (wxCmdLineParser& parser) override
1294 parser.SetDesc (command_line_description);
1295 parser.SetSwitchChars (wxT ("-"));
1298 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1300 if (parser.GetParamCount() > 0) {
1301 _dcp_to_load = wx_to_std (parser.GetParam (0));
1305 if (parser.Found("c", &config)) {
1306 Config::override_path = wx_to_std (config);
1309 if (parser.Found("s", &stress)) {
1310 _stress = wx_to_std (stress);
1316 void report_exception ()
1320 } catch (FileError& e) {
1324 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1325 std_to_wx (e.what()),
1326 std_to_wx (e.file().string().c_str ())
1329 } catch (exception& e) {
1333 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1334 std_to_wx (e.what ())
1338 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1342 /* An unhandled exception has occurred inside the main event loop */
1343 bool OnExceptionInMainLoop () override
1345 report_exception ();
1346 /* This will terminate the program */
1350 void OnUnhandledException () override
1352 report_exception ();
1357 signal_manager->ui_idle ();
1360 void config_failed_to_load ()
1362 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1365 void config_warning (string m)
1367 message_dialog (_frame, std_to_wx (m));
1370 DOMFrame* _frame = nullptr;
1371 string _dcp_to_load;
1372 boost::optional<string> _stress;