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"
25 #include "wx/nag_dialog.h"
26 #include "wx/player_config_dialog.h"
27 #include "wx/player_information.h"
28 #include "wx/player_stress_tester.h"
29 #include "wx/playlist_controls.h"
30 #include "wx/report_problem_dialog.h"
31 #include "wx/standard_controls.h"
32 #include "wx/system_information_dialog.h"
33 #include "wx/timer_display.h"
34 #include "wx/update_dialog.h"
35 #include "wx/verify_dcp_dialog.h"
36 #include "wx/verify_dcp_progress_dialog.h"
37 #include "wx/wx_ptr.h"
38 #include "wx/wx_signal_manager.h"
39 #include "wx/wx_util.h"
40 #include "lib/compose.hpp"
41 #include "lib/config.h"
42 #include "lib/constants.h"
43 #include "lib/cross.h"
44 #include "lib/dcp_content.h"
45 #include "lib/dcp_examiner.h"
46 #include "lib/dcpomatic_log.h"
47 #include "lib/dcpomatic_socket.h"
48 #include "lib/examine_content_job.h"
49 #include "lib/ffmpeg_content.h"
50 #include "lib/file_log.h"
52 #include "lib/font_config.h"
53 #include "lib/image.h"
54 #include "lib/image_jpeg.h"
55 #include "lib/image_png.h"
56 #include "lib/internet.h"
58 #include "lib/job_manager.h"
59 #include "lib/null_log.h"
60 #include "lib/player.h"
61 #include "lib/player_video.h"
62 #include "lib/ratio.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/scope_guard.h>
75 #include <dcp/search.h>
76 #include <dcp/warnings.h>
77 LIBDCP_DISABLE_WARNINGS
78 #include <wx/cmdline.h>
79 #include <wx/display.h>
81 #include <wx/preferences.h>
82 #include <wx/progdlg.h>
83 #include <wx/splash.h>
84 #include <wx/stdpaths.h>
86 LIBDCP_ENABLE_WARNINGS
90 #include <boost/algorithm/string.hpp>
91 #include <boost/bind/bind.hpp>
103 using std::dynamic_pointer_cast;
104 using std::exception;
106 using std::make_shared;
107 using std::shared_ptr;
112 using boost::optional;
113 using boost::scoped_array;
115 #if BOOST_VERSION >= 106100
116 using namespace boost::placeholders;
118 using dcp::raw_convert;
119 using namespace dcpomatic;
123 ID_file_open = DCPOMATIC_MAIN_MENU,
128 /* Allow spare IDs after _history for the recent files list */
129 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
131 /* Allow spare IDs for CPLs */
132 ID_view_full_screen = DCPOMATIC_MAIN_MENU + 200,
134 ID_view_closed_captions,
135 ID_view_scale_appropriate,
138 ID_view_scale_quarter,
139 ID_help_report_a_problem,
141 ID_tools_check_for_updates,
143 ID_tools_system_information,
144 /* IDs for shortcuts (with no associated menu item) */
148 ID_go_back_small_amount,
149 ID_go_forward_small_amount,
150 ID_go_back_medium_amount,
151 ID_go_forward_medium_amount,
152 ID_go_back_large_amount,
153 ID_go_forward_large_amount,
159 class DOMFrame : public wxFrame
163 class DCPDropTarget : public wxFileDropTarget
166 DCPDropTarget(DOMFrame* owner)
170 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
172 if (filenames.GetCount() == 1) {
173 /* Try to load a directory */
174 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
175 if (dcp::filesystem::is_directory(path)) {
176 _frame->load_dcp(wx_to_std(filenames[0]));
181 if (filenames.GetCount() >= 1) {
182 /* Try to load the parent if we drop some files, one if which is an asset map */
183 for (size_t i = 0; i < filenames.GetCount(); ++i) {
184 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
185 if (path.filename() == "ASSETMAP" || path.filename() == "ASSETMAP.xml") {
186 _frame->load_dcp(path.parent_path());
201 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
202 , _mode (Config::instance()->player_mode())
203 /* Use a panel as the only child of the Frame so that we avoid
204 the dark-grey background on Windows.
206 , _overall_panel(new wxPanel(this, wxID_ANY))
207 , _viewer(_overall_panel)
208 , _main_sizer (new wxBoxSizer(wxVERTICAL))
210 dcpomatic_log = make_shared<NullLog>();
212 #if defined(DCPOMATIC_WINDOWS)
213 maybe_open_console ();
214 cout << "DCP-o-matic Player is starting." << "\n";
217 auto bar = new wxMenuBar;
219 set_menu_sensitivity ();
222 #ifdef DCPOMATIC_WINDOWS
223 SetIcon (wxIcon (std_to_wx ("id")));
226 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
227 update_from_config (Config::PLAYER_DEBUG_LOG);
229 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
230 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
231 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
232 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
233 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
234 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
235 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
236 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
237 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
238 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
239 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
240 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
241 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
242 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
243 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
244 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
245 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
246 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
247 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
248 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
249 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
251 Bind(wxEVT_CLOSE_WINDOW, boost::bind(&DOMFrame::close, this, _1));
253 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
254 auto pc = new PlaylistControls (_overall_panel, _viewer);
256 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
258 _controls = new StandardControls (_overall_panel, _viewer, false);
260 _controls->set_film(_viewer.film());
261 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
262 _viewer.set_optimise_for_j2k(true);
263 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
264 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
265 _info = new PlayerInformation (_overall_panel, _viewer);
266 setup_main_sizer (Config::instance()->player_mode());
268 int accelerators = 12;
270 int accelerators = 11;
273 _stress.setup (this, _controls);
275 std::vector<wxAcceleratorEntry> accel(accelerators);
276 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
277 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
278 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
279 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
280 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
281 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
282 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
283 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
284 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
285 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
286 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
288 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
290 wxAcceleratorTable accel_table (accelerators, accel.data());
291 SetAcceleratorTable (accel_table);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
295 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
296 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
297 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
298 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
299 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
300 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
301 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
302 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
303 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
307 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
310 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
312 SetDropTarget(new DCPDropTarget(this));
317 /* It's important that this is stopped before our frame starts destroying its children,
318 * otherwise UI elements that it depends on will disappear from under it.
323 void close(wxCloseEvent& ev)
329 void setup_main_sizer (Config::PlayerMode mode)
331 _main_sizer->Detach(_viewer.panel());
332 _main_sizer->Detach (_controls);
333 _main_sizer->Detach (_info);
334 if (mode != Config::PLAYER_MODE_DUAL) {
335 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
337 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
338 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
339 _overall_panel->SetSizer (_main_sizer);
340 _overall_panel->Layout ();
343 bool playback_permitted ()
345 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
350 for (auto i: _film->content()) {
351 auto d = dynamic_pointer_cast<DCPContent>(i);
352 if (d && !d->kdm_timing_window_valid()) {
358 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
365 void too_many_frames_dropped ()
367 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
371 NagDialog::maybe_nag (
373 Config::NAG_TOO_MANY_DROPPED_FRAMES,
374 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
375 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
376 "You may be able to improve player performance by:\n"
377 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
378 "• using a more powerful computer.\n"
383 void set_decode_reduction (optional<int> reduction)
385 _viewer.set_dcp_decode_reduction(reduction);
386 _info->triggered_update ();
387 Config::instance()->set_decode_reduction (reduction);
390 void load_dcp (boost::filesystem::path dir)
392 DCPOMATIC_ASSERT (_film);
396 _stress.set_suspended (true);
397 auto dcp = make_shared<DCPContent>(dir);
398 auto job = make_shared<ExamineContentJob>(_film, dcp);
399 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
400 JobManager::instance()->add (job);
401 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
402 if (!ok || !report_errors_from_last_job(this)) {
405 Config::instance()->add_to_player_history (dir);
406 if (dcp->video_frame_rate()) {
407 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
409 } catch (ProjectFolderError &) {
412 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
414 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
415 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to play."
418 } catch (dcp::ReadError& e) {
419 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
420 } catch (DCPError& e) {
421 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
425 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
427 auto job = weak_job.lock ();
428 if (!job || !job->finished_ok()) {
432 auto content = weak_content.lock ();
437 _film->add_content (content);
438 _stress.set_suspended (false);
441 void reset_film_weak (weak_ptr<Film> weak_film)
443 auto film = weak_film.lock ();
449 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
452 _film->set_tolerant (true);
453 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
454 _viewer.set_film(_film);
455 _controls->set_film (_film);
456 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
457 _info->triggered_update ();
460 void film_changed (ChangeType type, FilmProperty property)
462 if (type != ChangeType::DONE || property != FilmProperty::CONTENT) {
466 if (_viewer.playing()) {
470 /* Start off as Flat */
471 _film->set_container (Ratio::from_id("185"));
473 for (auto i: _film->content()) {
474 auto dcp = dynamic_pointer_cast<DCPContent>(i);
476 for (auto j: i->text) {
481 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
482 if (r->id() == "239") {
483 /* Any scope content means we use scope */
484 _film->set_container(r);
488 /* Any 3D content means we use 3D mode */
489 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
490 _film->set_three_d (true);
494 _viewer.seek(DCPTime(), true);
495 _info->triggered_update ();
497 set_menu_sensitivity ();
499 auto old = _cpl_menu->GetMenuItems();
500 for (auto const& i: old) {
501 _cpl_menu->Remove (i);
504 if (_film->content().size() == 1) {
505 /* Offer a CPL menu */
506 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
508 int id = ID_view_cpl;
509 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
510 auto j = _cpl_menu->AppendRadioItem(
512 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
514 j->Check(!first->cpl() || i->id() == *first->cpl());
521 void load_stress_script (boost::filesystem::path path)
523 _stress.load_script (path);
528 void examine_content ()
530 DCPOMATIC_ASSERT (_film);
531 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
532 DCPOMATIC_ASSERT (dcp);
533 dcp->examine (_film, shared_ptr<Job>());
535 /* Examining content re-creates the TextContent objects, so we must re-enable them */
536 for (auto i: dcp->text) {
541 bool report_errors_from_last_job (wxWindow* parent) const
543 auto jm = JobManager::instance ();
545 DCPOMATIC_ASSERT (!jm->get().empty());
547 auto last = jm->get().back();
548 if (last->finished_in_error()) {
549 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()));
556 void setup_menu (wxMenuBar* m)
558 _file_menu = new wxMenu;
559 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
560 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
561 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
562 _file_menu->AppendSeparator ();
563 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
565 _history_position = _file_menu->GetMenuItems().GetCount();
567 _file_menu->AppendSeparator ();
568 _file_menu->Append (ID_file_close, _("&Close"));
569 _file_menu->AppendSeparator ();
572 _file_menu->Append (wxID_EXIT, _("&Exit"));
574 _file_menu->Append (wxID_EXIT, _("&Quit"));
578 auto prefs = _file_menu->Append(wxID_PREFERENCES, _("&Preferences...\tCtrl-,"));
580 auto edit = new wxMenu;
581 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
584 prefs->Enable (Config::instance()->have_write_permission());
586 _cpl_menu = new wxMenu;
588 auto view = new wxMenu;
589 auto c = Config::instance()->decode_reduction();
590 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
591 view->AppendSeparator();
592 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
593 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
595 view->AppendSeparator();
596 view->Append(ID_view_closed_captions, _("Closed captions..."));
597 view->AppendSeparator();
598 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
599 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
600 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
601 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
603 auto tools = new wxMenu;
604 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
605 tools->AppendSeparator ();
606 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
607 tools->Append (ID_tools_timing, _("Timing..."));
608 tools->Append (ID_tools_system_information, _("System information..."));
610 auto help = new wxMenu;
612 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
614 help->Append (wxID_ABOUT, _("About"));
616 help->Append (ID_help_report_a_problem, _("Report a problem..."));
618 m->Append (_file_menu, _("&File"));
620 m->Append (edit, _("&Edit"));
622 m->Append (view, _("&View"));
623 m->Append (tools, _("&Tools"));
624 m->Append (help, _("&Help"));
629 auto d = wxStandardPaths::Get().GetDocumentsDir();
630 if (Config::instance()->last_player_load_directory()) {
631 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
634 auto c = make_wx<wxDirDialog>(this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
639 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
640 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
647 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
649 Config::instance()->set_last_player_load_directory (dcp.parent_path());
655 auto initial_dir = wxStandardPaths::Get().GetDocumentsDir();
656 if (Config::instance()->last_player_load_directory()) {
657 initial_dir = std_to_wx(Config::instance()->last_player_load_directory()->string());
660 auto c = make_wx<wxDirDialog>(
662 _("Select DCP to open as OV"),
664 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
670 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
671 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
678 DCPOMATIC_ASSERT (_film);
679 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
680 DCPOMATIC_ASSERT (dcp);
681 dcp->add_ov (wx_to_std(c->GetPath()));
682 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
683 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
684 if (!ok || !report_errors_from_last_job(this)) {
687 for (auto i: dcp->text) {
691 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
693 _film->set_container(r);
698 _info->triggered_update ();
703 FileDialog dialog(this, _("Select KDM"), wxT("XML files|*.xml|All files|*.*"), wxFD_MULTIPLE, "AddKDMPath");
706 DCPOMATIC_ASSERT (_film);
707 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
708 DCPOMATIC_ASSERT (dcp);
711 dcp::ScopeGuard sg([this]() {
712 _viewer.set_coalesce_player_changes(false);
714 _viewer.set_coalesce_player_changes(true);
715 for (auto path: dialog.paths()) {
716 dcp->add_kdm(dcp::EncryptedKDM(dcp::file_to_string(path)));
717 _kdms.push_back(path);
721 } catch (exception& e) {
722 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
727 _info->triggered_update ();
730 void file_save_frame ()
732 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg;*.jpeg)|*.jpg;*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
733 if (dialog.ShowModal() == wxID_CANCEL) {
737 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
739 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
740 player->seek(_viewer.position(), true);
743 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
744 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
746 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
747 image_as_png(image).write(path);
748 } else if (ext == ".jpg" || ext == ".jpeg") {
749 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
750 image_as_jpeg(image, 80).write(path);
752 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
758 while (!done && tries_left >= 0) {
763 DCPOMATIC_ASSERT (tries_left >= 0);
766 void file_history (wxCommandEvent& event)
768 auto history = Config::instance()->player_history ();
769 int n = event.GetId() - ID_file_history;
770 if (n >= 0 && n < static_cast<int> (history.size ())) {
772 load_dcp (history[n]);
773 } catch (exception& e) {
774 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
782 _info->triggered_update ();
783 set_menu_sensitivity ();
791 void edit_preferences ()
793 if (!Config::instance()->have_write_permission()) {
797 if (!_config_dialog) {
798 _config_dialog = create_player_config_dialog ();
800 _config_dialog->Show (this);
803 void view_cpl (wxCommandEvent& ev)
805 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
806 DCPOMATIC_ASSERT (dcp);
807 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
808 int id = ev.GetId() - ID_view_cpl;
809 DCPOMATIC_ASSERT (id >= 0);
810 DCPOMATIC_ASSERT (id < int(cpls.size()));
811 auto i = cpls.begin();
817 _viewer.set_coalesce_player_changes(true);
818 dcp->set_cpl ((*i)->id());
820 _viewer.set_coalesce_player_changes(false);
822 _info->triggered_update ();
825 void view_full_screen ()
827 if (_mode == Config::PLAYER_MODE_FULL) {
828 _mode = Config::PLAYER_MODE_WINDOW;
830 _mode = Config::PLAYER_MODE_FULL;
836 void view_dual_screen ()
838 if (_mode == Config::PLAYER_MODE_DUAL) {
839 _mode = Config::PLAYER_MODE_WINDOW;
841 _mode = Config::PLAYER_MODE_DUAL;
849 if (_view_full_screen) {
850 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
852 if (_view_dual_screen) {
853 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
859 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
860 _info->Show (_mode != Config::PLAYER_MODE_FULL);
861 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
862 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
863 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
865 if (_mode == Config::PLAYER_MODE_DUAL) {
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 LOG_DEBUG_PLAYER("Setting up dual screen mode with %1 displays", wxDisplay::GetCount());
873 for (auto index = 0U; index < wxDisplay::GetCount(); ++index) {
874 wxDisplay display(index);
875 auto client = display.GetClientArea();
876 auto mode = display.GetCurrentMode();
877 auto geometry = display.GetGeometry();
878 LOG_DEBUG_PLAYER("Display %1", index);
879 LOG_DEBUG_PLAYER(" ClientArea position=(%1, %2) size=(%3, %4)", client.GetX(), client.GetY(), client.GetWidth(), client.GetHeight());
880 LOG_DEBUG_PLAYER(" Geometry position=(%1, %2) size=(%3, %4)", geometry.GetX(), geometry.GetY(), geometry.GetWidth(), geometry.GetHeight());
881 LOG_DEBUG_PLAYER(" Mode size=(%1, %2)", mode.GetWidth(), mode.GetHeight());
882 LOG_DEBUG_PLAYER(" Primary? %1", static_cast<int>(display.IsPrimary()));
884 if (wxDisplay::GetCount() > 1) {
885 wxRect geometry[2] = {
886 wxDisplay(0U).GetGeometry(),
887 wxDisplay(1U).GetGeometry()
889 auto const image_display = Config::instance()->image_display();
890 _dual_screen->Move(geometry[image_display].GetX(), geometry[image_display].GetY());
891 _viewer.panel()->SetSize(geometry[image_display].GetWidth(), geometry[image_display].GetHeight());
892 Move(geometry[1 - image_display].GetX(), geometry[1 - image_display].GetY());
894 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
897 _viewer.panel()->Reparent(_overall_panel);
898 _dual_screen->Destroy ();
903 setup_main_sizer (_mode);
906 void dual_screen_key_press(wxKeyEvent& ev)
908 if (ev.GetKeyCode() == WXK_F11) {
909 if (ev.ShiftDown()) {
911 } else if (!ev.HasAnyModifiers()) {
917 void view_closed_captions ()
919 _viewer.show_closed_captions();
924 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
925 DCPOMATIC_ASSERT (dcp);
927 auto job = make_shared<VerifyDCPJob>(dcp->directories(), _kdms);
928 VerifyDCPProgressDialog progress(this, _("DCP-o-matic Player"));
929 bool const completed = progress.run(job);
933 VerifyDCPDialog dialog(this, job);
938 void tools_check_for_updates ()
940 UpdateChecker::instance()->run ();
941 _update_news_requested = true;
946 auto d = make_wx<TimerDisplay>(this, _viewer.state_timer(), _viewer.gets());
950 void tools_system_information ()
952 if (!_system_information_dialog) {
953 _system_information_dialog = new SystemInformationDialog (this, _viewer);
956 _system_information_dialog->Show ();
961 auto d = make_wx<AboutDialog>(this);
965 void help_report_a_problem ()
967 auto d = make_wx<ReportProblemDialog>(this);
968 if (d->ShowModal () == wxID_OK) {
973 void update_checker_state_changed ()
975 auto uc = UpdateChecker::instance ();
977 bool const announce =
978 _update_news_requested ||
979 (uc->stable() && Config::instance()->check_for_updates()) ||
980 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
982 _update_news_requested = false;
988 if (uc->state() == UpdateChecker::State::YES) {
989 auto dialog = make_wx<UpdateDialog>(this, uc->stable (), uc->test ());
990 dialog->ShowModal ();
991 } else if (uc->state() == UpdateChecker::State::FAILED) {
992 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
994 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
997 _update_news_requested = false;
1000 void config_changed (Config::Property prop)
1002 /* Instantly save any config changes when using the player GUI */
1004 Config::instance()->write_config();
1005 } catch (FileError& e) {
1006 if (prop != Config::HISTORY) {
1010 _("Could not write to config file at %s. Your changes have not been saved."),
1011 std_to_wx(e.file().string())
1015 } catch (exception& e) {
1018 _("Could not write to config file. Your changes have not been saved.")
1022 update_from_config (prop);
1025 void update_from_config (Config::Property prop)
1027 for (int i = 0; i < _history_items; ++i) {
1028 delete _file_menu->Remove (ID_file_history + i);
1031 if (_history_separator) {
1032 _file_menu->Remove (_history_separator);
1034 delete _history_separator;
1035 _history_separator = nullptr;
1037 int pos = _history_position;
1039 /* Clear out non-existent history items before we re-build the menu */
1040 Config::instance()->clean_player_history ();
1041 auto history = Config::instance()->player_history ();
1043 if (!history.empty ()) {
1044 _history_separator = _file_menu->InsertSeparator (pos++);
1047 for (size_t i = 0; i < history.size(); ++i) {
1050 s = String::compose ("&%1 %2", i + 1, history[i].string());
1052 s = history[i].string();
1054 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1057 _history_items = history.size ();
1059 if (prop == Config::PLAYER_DEBUG_LOG) {
1060 auto p = Config::instance()->player_debug_log_file();
1062 dcpomatic_log = make_shared<FileLog>(*p);
1064 dcpomatic_log = make_shared<NullLog>();
1066 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1070 void set_menu_sensitivity ()
1072 _tools_verify->Enable (static_cast<bool>(_film));
1073 _file_add_ov->Enable (static_cast<bool>(_film));
1074 _file_add_kdm->Enable (static_cast<bool>(_film));
1075 _file_save_frame->Enable (static_cast<bool>(_film));
1076 _view_cpl->Enable (static_cast<bool>(_film));
1079 void start_stop_pressed ()
1081 if (_viewer.playing()) {
1088 void go_back_frame ()
1090 _viewer.seek_by(-_viewer.one_video_frame(), true);
1093 void go_forward_frame ()
1095 _viewer.seek_by(_viewer.one_video_frame(), true);
1098 void go_seconds (int s)
1100 _viewer.seek_by(DCPTime::from_seconds(s), true);
1105 _viewer.seek(DCPTime(), true);
1110 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1113 wxFrame* _dual_screen = nullptr;
1114 bool _update_news_requested = false;
1115 PlayerInformation* _info = nullptr;
1116 Config::PlayerMode _mode;
1117 wxPreferencesEditor* _config_dialog = nullptr;
1118 wxPanel* _overall_panel = nullptr;
1119 wxMenu* _file_menu = nullptr;
1120 wxMenuItem* _view_cpl = nullptr;
1121 wxMenu* _cpl_menu = nullptr;
1122 int _history_items = 0;
1123 int _history_position = 0;
1124 wxMenuItem* _history_separator = nullptr;
1126 Controls* _controls;
1127 SystemInformationDialog* _system_information_dialog = nullptr;
1128 std::shared_ptr<Film> _film;
1129 boost::signals2::scoped_connection _config_changed_connection;
1130 boost::signals2::scoped_connection _examine_job_connection;
1131 wxMenuItem* _file_add_ov = nullptr;
1132 wxMenuItem* _file_add_kdm = nullptr;
1133 wxMenuItem* _file_save_frame = nullptr;
1134 wxMenuItem* _tools_verify = nullptr;
1135 wxMenuItem* _view_full_screen = nullptr;
1136 wxMenuItem* _view_dual_screen = nullptr;
1137 wxSizer* _main_sizer = nullptr;
1138 PlayerStressTester _stress;
1139 /** KDMs that have been loaded, so that we can pass them to the verifier */
1140 std::vector<boost::filesystem::path> _kdms;
1143 static const wxCmdLineEntryDesc command_line_description[] = {
1144 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1145 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1146 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1147 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1150 class PlayServer : public Server
1153 explicit PlayServer (DOMFrame* frame)
1154 : Server (PLAYER_PLAY_PORT)
1158 void handle (shared_ptr<Socket> socket) override
1161 uint32_t const length = socket->read_uint32 ();
1162 if (length > 65536) {
1165 scoped_array<char> buffer (new char[length]);
1166 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1167 string s (buffer.get());
1168 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1169 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1180 * @brief The magic App class for wxWidgets.
1182 class App : public wxApp
1188 #ifdef DCPOMATIC_LINUX
1195 bool OnInit () override
1197 wxSplashScreen* splash;
1199 wxInitAllImageHandlers ();
1201 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1202 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1204 splash = maybe_show_splash ();
1206 SetAppName (_("DCP-o-matic Player"));
1208 if (!wxApp::OnInit()) {
1212 #ifdef DCPOMATIC_LINUX
1213 unsetenv ("UBUNTU_MENUPROXY");
1216 #ifdef DCPOMATIC_OSX
1217 make_foreground_application ();
1220 dcpomatic_setup_path_encoding ();
1222 /* Enable i18n; this will create a Config object
1223 to look for a force-configured language. This Config
1224 object will be wrong, however, because dcpomatic_setup
1225 hasn't yet been called and there aren't any filters etc.
1228 dcpomatic_setup_i18n ();
1230 /* Set things up, including filters etc.
1231 which will now be internationalised correctly.
1235 /* Force the configuration to be re-loaded correctly next
1240 signal_manager = new wxSignalManager (this);
1242 _frame = new DOMFrame ();
1243 SetTopWindow (_frame);
1244 _frame->Maximize ();
1252 auto server = new PlayServer (_frame);
1253 new thread (boost::bind (&PlayServer::run, server));
1254 } catch (std::exception& e) {
1255 /* This is not the end of the world; probably a failure to bind the server socket
1256 * because there's already another player running.
1258 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1261 if (!_dcp_to_load.empty() && dcp::filesystem::is_directory(_dcp_to_load)) {
1263 _frame->load_dcp (_dcp_to_load);
1264 } catch (exception& e) {
1265 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1271 _frame->load_stress_script (*_stress);
1272 } catch (exception& e) {
1273 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1277 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1279 if (Config::instance()->check_for_updates ()) {
1280 UpdateChecker::instance()->run ();
1283 catch (exception& e)
1288 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1294 void OnInitCmdLine (wxCmdLineParser& parser) override
1296 parser.SetDesc (command_line_description);
1297 parser.SetSwitchChars (wxT ("-"));
1300 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1302 if (parser.GetParamCount() > 0) {
1303 _dcp_to_load = wx_to_std (parser.GetParam (0));
1307 if (parser.Found("c", &config)) {
1308 Config::override_path = wx_to_std (config);
1311 if (parser.Found("s", &stress)) {
1312 _stress = wx_to_std (stress);
1318 void report_exception ()
1322 } catch (FileError& e) {
1326 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1327 std_to_wx (e.what()),
1328 std_to_wx (e.file().string().c_str ())
1331 } catch (exception& e) {
1335 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1336 std_to_wx (e.what ())
1340 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1344 /* An unhandled exception has occurred inside the main event loop */
1345 bool OnExceptionInMainLoop () override
1347 report_exception ();
1348 /* This will terminate the program */
1352 void OnUnhandledException () override
1354 report_exception ();
1359 signal_manager->ui_idle ();
1362 void config_failed_to_load ()
1364 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1367 void config_warning (string m)
1369 message_dialog (_frame, std_to_wx (m));
1372 DOMFrame* _frame = nullptr;
1373 string _dcp_to_load;
1374 boost::optional<string> _stress;