2 Copyright (C) 2017-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 #include "wx/about_dialog.h"
22 #include "wx/film_viewer.h"
23 #include "wx/nag_dialog.h"
24 #include "wx/player_config_dialog.h"
25 #include "wx/player_information.h"
26 #include "wx/player_stress_tester.h"
27 #include "wx/playlist_controls.h"
28 #include "wx/report_problem_dialog.h"
29 #include "wx/standard_controls.h"
30 #include "wx/system_information_dialog.h"
31 #include "wx/timer_display.h"
32 #include "wx/update_dialog.h"
33 #include "wx/verify_dcp_dialog.h"
34 #include "wx/verify_dcp_progress_dialog.h"
35 #include "wx/wx_signal_manager.h"
36 #include "wx/wx_util.h"
37 #include "lib/compose.hpp"
38 #include "lib/config.h"
39 #include "lib/cross.h"
40 #include "lib/dcp_content.h"
41 #include "lib/dcp_examiner.h"
42 #include "lib/dcpomatic_log.h"
43 #include "lib/dcpomatic_socket.h"
44 #include "lib/examine_content_job.h"
45 #include "lib/ffmpeg_content.h"
46 #include "lib/file_log.h"
48 #include "lib/image.h"
49 #include "lib/image_jpeg.h"
50 #include "lib/image_png.h"
51 #include "lib/internet.h"
53 #include "lib/job_manager.h"
54 #include "lib/null_log.h"
55 #include "lib/player.h"
56 #include "lib/player_video.h"
57 #include "lib/ratio.h"
58 #include "lib/scoped_temporary.h"
59 #include "lib/server.h"
60 #include "lib/text_content.h"
61 #include "lib/update_checker.h"
63 #include "lib/verify_dcp_job.h"
64 #include "lib/video_content.h"
67 #include <dcp/exceptions.h>
68 #include <dcp/raw_convert.h>
69 #include <dcp/search.h>
70 #include <dcp/warnings.h>
71 LIBDCP_DISABLE_WARNINGS
72 #include <wx/cmdline.h>
73 #include <wx/display.h>
75 #include <wx/preferences.h>
76 #include <wx/progdlg.h>
77 #include <wx/splash.h>
78 #include <wx/stdpaths.h>
80 LIBDCP_ENABLE_WARNINGS
84 #include <boost/algorithm/string.hpp>
85 #include <boost/bind/bind.hpp>
97 using std::dynamic_pointer_cast;
100 using std::make_shared;
101 using std::shared_ptr;
106 using boost::optional;
107 using boost::scoped_array;
109 #if BOOST_VERSION >= 106100
110 using namespace boost::placeholders;
112 using dcp::raw_convert;
113 using namespace dcpomatic;
122 /* Allow spare IDs after _history for the recent files list */
125 /* Allow spare IDs for CPLs */
126 ID_view_full_screen = 200,
128 ID_view_closed_captions,
129 ID_view_scale_appropriate,
132 ID_view_scale_quarter,
133 ID_help_report_a_problem,
135 ID_tools_check_for_updates,
137 ID_tools_system_information,
138 /* IDs for shortcuts (with no associated menu item) */
142 ID_go_back_small_amount,
143 ID_go_forward_small_amount,
144 ID_go_back_medium_amount,
145 ID_go_forward_medium_amount,
146 ID_go_back_large_amount,
147 ID_go_forward_large_amount,
153 class DOMFrame : public wxFrame
157 class DCPDropTarget : public wxFileDropTarget
160 DCPDropTarget(DOMFrame* owner)
164 bool OnDropFiles(wxCoord, wxCoord, wxArrayString const& filenames) override
166 if (filenames.GetCount() == 1) {
167 /* Try to load a directory */
168 auto path = boost::filesystem::path(wx_to_std(filenames[0]));
169 if (boost::filesystem::is_directory(path)) {
170 _frame->load_dcp(wx_to_std(filenames[0]));
175 if (filenames.GetCount() >= 1) {
176 /* Try to load the parent if we drop some files, one if which is an asset map */
177 for (size_t i = 0; i < filenames.GetCount(); ++i) {
178 auto path = boost::filesystem::path(wx_to_std(filenames[i]));
179 if (path.filename() == "ASSETMAP" || path.filename() == "ASSETMAP.xml") {
180 _frame->load_dcp(path.parent_path());
195 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
196 , _mode (Config::instance()->player_mode())
197 /* Use a panel as the only child of the Frame so that we avoid
198 the dark-grey background on Windows.
200 , _overall_panel(new wxPanel(this, wxID_ANY))
201 , _viewer(_overall_panel)
202 , _main_sizer (new wxBoxSizer(wxVERTICAL))
204 dcpomatic_log = make_shared<NullLog>();
206 #if defined(DCPOMATIC_WINDOWS)
207 maybe_open_console ();
208 cout << "DCP-o-matic Player is starting." << "\n";
211 auto bar = new wxMenuBar;
213 set_menu_sensitivity ();
216 #ifdef DCPOMATIC_WINDOWS
217 SetIcon (wxIcon (std_to_wx ("id")));
220 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
221 update_from_config (Config::PLAYER_DEBUG_LOG);
223 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
224 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
225 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
226 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
227 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
228 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
229 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
230 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
231 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
232 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
233 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
234 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
235 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
236 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
237 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
238 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
239 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
240 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
241 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
242 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
243 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
245 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
246 auto pc = new PlaylistControls (_overall_panel, _viewer);
248 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
250 _controls = new StandardControls (_overall_panel, _viewer, false);
252 _viewer.set_dcp_decode_reduction(Config::instance()->decode_reduction());
253 _viewer.set_optimise_for_j2k(true);
254 _viewer.PlaybackPermitted.connect(bind(&DOMFrame::playback_permitted, this));
255 _viewer.TooManyDropped.connect(bind(&DOMFrame::too_many_frames_dropped, this));
256 _info = new PlayerInformation (_overall_panel, _viewer);
257 setup_main_sizer (Config::instance()->player_mode());
259 int accelerators = 12;
261 int accelerators = 11;
264 _stress.setup (this, _controls);
266 std::vector<wxAcceleratorEntry> accel(accelerators);
267 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
268 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
269 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
270 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
271 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
272 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
273 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
274 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
275 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
276 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
277 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
279 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
281 wxAcceleratorTable accel_table (accelerators, accel.data());
282 SetAcceleratorTable (accel_table);
284 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
285 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
286 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
287 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
288 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
289 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
290 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
291 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
292 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
293 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
294 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
298 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
301 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
303 SetDropTarget(new DCPDropTarget(this));
308 /* It's important that this is stopped before our frame starts destroying its children,
309 * otherwise UI elements that it depends on will disappear from under it.
314 void setup_main_sizer (Config::PlayerMode mode)
316 _main_sizer->Detach(_viewer.panel());
317 _main_sizer->Detach (_controls);
318 _main_sizer->Detach (_info);
319 if (mode != Config::PLAYER_MODE_DUAL) {
320 _main_sizer->Add(_viewer.panel(), 1, wxEXPAND);
322 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
323 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
324 _overall_panel->SetSizer (_main_sizer);
325 _overall_panel->Layout ();
328 bool playback_permitted ()
330 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
335 for (auto i: _film->content()) {
336 auto d = dynamic_pointer_cast<DCPContent>(i);
337 if (d && !d->kdm_timing_window_valid()) {
343 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
350 void too_many_frames_dropped ()
352 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
356 NagDialog::maybe_nag (
358 Config::NAG_TOO_MANY_DROPPED_FRAMES,
359 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
360 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
361 "You may be able to improve player performance by:\n"
362 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
363 "• using a more powerful computer.\n"
368 void set_decode_reduction (optional<int> reduction)
370 _viewer.set_dcp_decode_reduction(reduction);
371 _info->triggered_update ();
372 Config::instance()->set_decode_reduction (reduction);
375 void load_dcp (boost::filesystem::path dir)
377 DCPOMATIC_ASSERT (_film);
381 _stress.set_suspended (true);
382 auto dcp = make_shared<DCPContent>(dir);
383 auto job = make_shared<ExamineContentJob>(_film, dcp);
384 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
385 JobManager::instance()->add (job);
386 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
387 if (!ok || !report_errors_from_last_job(this)) {
390 Config::instance()->add_to_player_history (dir);
391 if (dcp->video_frame_rate()) {
392 _film->set_video_frame_rate(dcp->video_frame_rate().get(), true);
394 } catch (ProjectFolderError &) {
397 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
399 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
400 "Choose the DCP folder inside the DCP-o-matic project folder if that's what you want to play."
403 } catch (dcp::ReadError& e) {
404 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
405 } catch (DCPError& e) {
406 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
410 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
412 auto job = weak_job.lock ();
413 if (!job || !job->finished_ok()) {
417 auto content = weak_content.lock ();
422 _film->add_content (content);
423 _stress.set_suspended (false);
426 void reset_film_weak (weak_ptr<Film> weak_film)
428 auto film = weak_film.lock ();
434 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
437 _film->set_tolerant (true);
438 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
439 _viewer.set_film(_film);
440 _controls->set_film (_film);
441 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
442 _info->triggered_update ();
445 void film_changed (ChangeType type, Film::Property property)
447 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
451 if (_viewer.playing()) {
455 /* Start off as Flat */
456 _film->set_container (Ratio::from_id("185"));
458 for (auto i: _film->content()) {
459 auto dcp = dynamic_pointer_cast<DCPContent>(i);
461 for (auto j: i->text) {
466 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
467 if (r->id() == "239") {
468 /* Any scope content means we use scope */
469 _film->set_container(r);
473 /* Any 3D content means we use 3D mode */
474 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
475 _film->set_three_d (true);
479 _viewer.seek(DCPTime(), true);
480 _info->triggered_update ();
482 set_menu_sensitivity ();
484 auto old = _cpl_menu->GetMenuItems();
485 for (auto const& i: old) {
486 _cpl_menu->Remove (i);
489 if (_film->content().size() == 1) {
490 /* Offer a CPL menu */
491 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
493 int id = ID_view_cpl;
494 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
495 auto j = _cpl_menu->AppendRadioItem(
497 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
499 j->Check(!first->cpl() || i->id() == *first->cpl());
506 void load_stress_script (boost::filesystem::path path)
508 _stress.load_script (path);
513 void examine_content ()
515 DCPOMATIC_ASSERT (_film);
516 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
517 DCPOMATIC_ASSERT (dcp);
518 dcp->examine (_film, shared_ptr<Job>());
520 /* Examining content re-creates the TextContent objects, so we must re-enable them */
521 for (auto i: dcp->text) {
526 bool report_errors_from_last_job (wxWindow* parent) const
528 auto jm = JobManager::instance ();
530 DCPOMATIC_ASSERT (!jm->get().empty());
532 auto last = jm->get().back();
533 if (last->finished_in_error()) {
534 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()));
541 void setup_menu (wxMenuBar* m)
543 _file_menu = new wxMenu;
544 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
545 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
546 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
547 _file_menu->AppendSeparator ();
548 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
550 _history_position = _file_menu->GetMenuItems().GetCount();
552 _file_menu->AppendSeparator ();
553 _file_menu->Append (ID_file_close, _("&Close"));
554 _file_menu->AppendSeparator ();
557 _file_menu->Append (wxID_EXIT, _("&Exit"));
559 _file_menu->Append (wxID_EXIT, _("&Quit"));
563 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
565 auto edit = new wxMenu;
566 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
569 prefs->Enable (Config::instance()->have_write_permission());
571 _cpl_menu = new wxMenu;
573 auto view = new wxMenu;
574 auto c = Config::instance()->decode_reduction();
575 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
576 view->AppendSeparator();
577 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
578 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
580 view->AppendSeparator();
581 view->Append(ID_view_closed_captions, _("Closed captions..."));
582 view->AppendSeparator();
583 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
584 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
585 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
586 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
588 auto tools = new wxMenu;
589 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
590 tools->AppendSeparator ();
591 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
592 tools->Append (ID_tools_timing, _("Timing..."));
593 tools->Append (ID_tools_system_information, _("System information..."));
595 auto help = new wxMenu;
597 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
599 help->Append (wxID_ABOUT, _("About"));
601 help->Append (ID_help_report_a_problem, _("Report a problem..."));
603 m->Append (_file_menu, _("&File"));
605 m->Append (edit, _("&Edit"));
607 m->Append (view, _("&View"));
608 m->Append (tools, _("&Tools"));
609 m->Append (help, _("&Help"));
614 auto d = wxStandardPaths::Get().GetDocumentsDir();
615 if (Config::instance()->last_player_load_directory()) {
616 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
619 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
624 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
625 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
632 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
634 Config::instance()->set_last_player_load_directory (dcp.parent_path());
642 auto c = new wxDirDialog (
644 _("Select DCP to open as OV"),
645 wxStandardPaths::Get().GetDocumentsDir(),
646 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
652 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
653 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
660 DCPOMATIC_ASSERT (_film);
661 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
662 DCPOMATIC_ASSERT (dcp);
663 dcp->add_ov (wx_to_std(c->GetPath()));
664 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
665 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
666 if (!ok || !report_errors_from_last_job(this)) {
669 for (auto i: dcp->text) {
673 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
675 _film->set_container(r);
681 _info->triggered_update ();
686 auto d = new wxFileDialog (this, _("Select KDM"));
688 if (d->ShowModal() == wxID_OK) {
689 DCPOMATIC_ASSERT (_film);
690 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
691 DCPOMATIC_ASSERT (dcp);
694 _viewer.set_coalesce_player_changes(true);
695 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
697 _viewer.set_coalesce_player_changes(false);
699 } catch (exception& e) {
700 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
707 _info->triggered_update ();
710 void file_save_frame ()
712 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg,*.jpeg)|*.jpg,*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
713 if (dialog.ShowModal() == wxID_CANCEL) {
717 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
719 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
720 player->seek(_viewer.position(), true);
723 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
724 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
726 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
727 image_as_png(image).write(path);
728 } else if (ext == ".jpg" || ext == ".jpeg") {
729 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
730 image_as_jpeg(image, 80).write(path);
732 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
738 while (!done && tries_left >= 0) {
743 DCPOMATIC_ASSERT (tries_left >= 0);
746 void file_history (wxCommandEvent& event)
748 auto history = Config::instance()->player_history ();
749 int n = event.GetId() - ID_file_history;
750 if (n >= 0 && n < static_cast<int> (history.size ())) {
752 load_dcp (history[n]);
753 } catch (exception& e) {
754 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
762 _info->triggered_update ();
763 set_menu_sensitivity ();
771 void edit_preferences ()
773 if (!Config::instance()->have_write_permission()) {
777 if (!_config_dialog) {
778 _config_dialog = create_player_config_dialog ();
780 _config_dialog->Show (this);
783 void view_cpl (wxCommandEvent& ev)
785 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
786 DCPOMATIC_ASSERT (dcp);
787 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
788 int id = ev.GetId() - ID_view_cpl;
789 DCPOMATIC_ASSERT (id >= 0);
790 DCPOMATIC_ASSERT (id < int(cpls.size()));
791 auto i = cpls.begin();
797 _viewer.set_coalesce_player_changes(true);
798 dcp->set_cpl ((*i)->id());
800 _viewer.set_coalesce_player_changes(false);
802 _info->triggered_update ();
805 void view_full_screen ()
807 if (_mode == Config::PLAYER_MODE_FULL) {
808 _mode = Config::PLAYER_MODE_WINDOW;
810 _mode = Config::PLAYER_MODE_FULL;
816 void view_dual_screen ()
818 if (_mode == Config::PLAYER_MODE_DUAL) {
819 _mode = Config::PLAYER_MODE_WINDOW;
821 _mode = Config::PLAYER_MODE_DUAL;
829 if (_view_full_screen) {
830 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
832 if (_view_dual_screen) {
833 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
839 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
840 _info->Show (_mode != Config::PLAYER_MODE_FULL);
841 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
842 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
843 _viewer.set_pad_black(_mode != Config::PLAYER_MODE_WINDOW);
845 if (_mode == Config::PLAYER_MODE_DUAL) {
846 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
847 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
848 _dual_screen->ShowFullScreen (true);
849 _viewer.panel()->Reparent(_dual_screen);
850 _viewer.panel()->SetFocus();
851 _dual_screen->Show ();
852 if (wxDisplay::GetCount() > 1) {
853 switch (Config::instance()->image_display()) {
855 _dual_screen->Move (0, 0);
856 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
859 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
860 // (0, 0) doesn't seem to work for some strange reason
865 _dual_screen->Bind(wxEVT_CHAR_HOOK, boost::bind(&DOMFrame::dual_screen_key_press, this, _1));
868 _viewer.panel()->Reparent(_overall_panel);
869 _dual_screen->Destroy ();
874 setup_main_sizer (_mode);
877 void dual_screen_key_press(wxKeyEvent& ev)
879 if (ev.GetKeyCode() == WXK_F11) {
880 if (ev.ShiftDown()) {
882 } else if (!ev.HasAnyModifiers()) {
888 void view_closed_captions ()
890 _viewer.show_closed_captions();
895 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
896 DCPOMATIC_ASSERT (dcp);
898 auto job = make_shared<VerifyDCPJob>(dcp->directories());
899 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
900 bool const completed = progress->run (job);
901 progress->Destroy ();
906 auto d = new VerifyDCPDialog (this, job);
911 void tools_check_for_updates ()
913 UpdateChecker::instance()->run ();
914 _update_news_requested = true;
919 auto d = new TimerDisplay(this, _viewer.state_timer(), _viewer.gets());
924 void tools_system_information ()
926 if (!_system_information_dialog) {
927 _system_information_dialog = new SystemInformationDialog (this, _viewer);
930 _system_information_dialog->Show ();
935 auto d = new AboutDialog (this);
940 void help_report_a_problem ()
942 auto d = new ReportProblemDialog (this);
943 if (d->ShowModal () == wxID_OK) {
949 void update_checker_state_changed ()
951 auto uc = UpdateChecker::instance ();
953 bool const announce =
954 _update_news_requested ||
955 (uc->stable() && Config::instance()->check_for_updates()) ||
956 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
958 _update_news_requested = false;
964 if (uc->state() == UpdateChecker::State::YES) {
965 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
966 dialog->ShowModal ();
968 } else if (uc->state() == UpdateChecker::State::FAILED) {
969 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
971 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
974 _update_news_requested = false;
977 void config_changed (Config::Property prop)
979 /* Instantly save any config changes when using the player GUI */
981 Config::instance()->write_config();
982 } catch (FileError& e) {
983 if (prop != Config::HISTORY) {
987 _("Could not write to config file at %s. Your changes have not been saved."),
988 std_to_wx(e.file().string())
992 } catch (exception& e) {
995 _("Could not write to config file. Your changes have not been saved.")
999 update_from_config (prop);
1002 void update_from_config (Config::Property prop)
1004 for (int i = 0; i < _history_items; ++i) {
1005 delete _file_menu->Remove (ID_file_history + i);
1008 if (_history_separator) {
1009 _file_menu->Remove (_history_separator);
1011 delete _history_separator;
1012 _history_separator = nullptr;
1014 int pos = _history_position;
1016 /* Clear out non-existent history items before we re-build the menu */
1017 Config::instance()->clean_player_history ();
1018 auto history = Config::instance()->player_history ();
1020 if (!history.empty ()) {
1021 _history_separator = _file_menu->InsertSeparator (pos++);
1024 for (size_t i = 0; i < history.size(); ++i) {
1027 s = String::compose ("&%1 %2", i + 1, history[i].string());
1029 s = history[i].string();
1031 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1034 _history_items = history.size ();
1036 if (prop == Config::PLAYER_DEBUG_LOG) {
1037 auto p = Config::instance()->player_debug_log_file();
1039 dcpomatic_log = make_shared<FileLog>(*p);
1041 dcpomatic_log = make_shared<NullLog>();
1043 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
1047 void set_menu_sensitivity ()
1049 _tools_verify->Enable (static_cast<bool>(_film));
1050 _file_add_ov->Enable (static_cast<bool>(_film));
1051 _file_add_kdm->Enable (static_cast<bool>(_film));
1052 _file_save_frame->Enable (static_cast<bool>(_film));
1053 _view_cpl->Enable (static_cast<bool>(_film));
1056 void start_stop_pressed ()
1058 if (_viewer.playing()) {
1065 void go_back_frame ()
1067 _viewer.seek_by(-_viewer.one_video_frame(), true);
1070 void go_forward_frame ()
1072 _viewer.seek_by(_viewer.one_video_frame(), true);
1075 void go_seconds (int s)
1077 _viewer.seek_by(DCPTime::from_seconds(s), true);
1082 _viewer.seek(DCPTime(), true);
1087 _viewer.seek(_film->length() - _viewer.one_video_frame(), true);
1090 wxFrame* _dual_screen = nullptr;
1091 bool _update_news_requested = false;
1092 PlayerInformation* _info = nullptr;
1093 Config::PlayerMode _mode;
1094 wxPreferencesEditor* _config_dialog = nullptr;
1095 wxPanel* _overall_panel = nullptr;
1096 wxMenu* _file_menu = nullptr;
1097 wxMenuItem* _view_cpl = nullptr;
1098 wxMenu* _cpl_menu = nullptr;
1099 int _history_items = 0;
1100 int _history_position = 0;
1101 wxMenuItem* _history_separator = nullptr;
1103 Controls* _controls;
1104 SystemInformationDialog* _system_information_dialog = nullptr;
1105 std::shared_ptr<Film> _film;
1106 boost::signals2::scoped_connection _config_changed_connection;
1107 boost::signals2::scoped_connection _examine_job_connection;
1108 wxMenuItem* _file_add_ov = nullptr;
1109 wxMenuItem* _file_add_kdm = nullptr;
1110 wxMenuItem* _file_save_frame = nullptr;
1111 wxMenuItem* _tools_verify = nullptr;
1112 wxMenuItem* _view_full_screen = nullptr;
1113 wxMenuItem* _view_dual_screen = nullptr;
1114 wxSizer* _main_sizer = nullptr;
1115 PlayerStressTester _stress;
1118 static const wxCmdLineEntryDesc command_line_description[] = {
1119 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1120 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1121 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1122 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1125 class PlayServer : public Server
1128 explicit PlayServer (DOMFrame* frame)
1129 : Server (PLAYER_PLAY_PORT)
1133 void handle (shared_ptr<Socket> socket) override
1136 int const length = socket->read_uint32 ();
1137 scoped_array<char> buffer (new char[length]);
1138 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1139 string s (buffer.get());
1140 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1141 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1152 * @brief The magic App class for wxWidgets.
1154 class App : public wxApp
1160 #ifdef DCPOMATIC_LINUX
1167 bool OnInit () override
1169 wxSplashScreen* splash = nullptr;
1171 wxInitAllImageHandlers ();
1173 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1174 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1176 splash = maybe_show_splash ();
1178 SetAppName (_("DCP-o-matic Player"));
1180 if (!wxApp::OnInit()) {
1184 #ifdef DCPOMATIC_LINUX
1185 unsetenv ("UBUNTU_MENUPROXY");
1188 #ifdef DCPOMATIC_OSX
1189 make_foreground_application ();
1192 dcpomatic_setup_path_encoding ();
1194 /* Enable i18n; this will create a Config object
1195 to look for a force-configured language. This Config
1196 object will be wrong, however, because dcpomatic_setup
1197 hasn't yet been called and there aren't any filters etc.
1200 dcpomatic_setup_i18n ();
1202 /* Set things up, including filters etc.
1203 which will now be internationalised correctly.
1207 /* Force the configuration to be re-loaded correctly next
1212 signal_manager = new wxSignalManager (this);
1214 _frame = new DOMFrame ();
1215 SetTopWindow (_frame);
1216 _frame->Maximize ();
1224 auto server = new PlayServer (_frame);
1225 new thread (boost::bind (&PlayServer::run, server));
1226 } catch (std::exception& e) {
1227 /* This is not the end of the world; probably a failure to bind the server socket
1228 * because there's already another player running.
1230 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1233 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1235 _frame->load_dcp (_dcp_to_load);
1236 } catch (exception& e) {
1237 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1243 _frame->load_stress_script (*_stress);
1244 } catch (exception& e) {
1245 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1249 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1251 if (Config::instance()->check_for_updates ()) {
1252 UpdateChecker::instance()->run ();
1255 catch (exception& e)
1260 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1266 void OnInitCmdLine (wxCmdLineParser& parser) override
1268 parser.SetDesc (command_line_description);
1269 parser.SetSwitchChars (wxT ("-"));
1272 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1274 if (parser.GetParamCount() > 0) {
1275 _dcp_to_load = wx_to_std (parser.GetParam (0));
1279 if (parser.Found("c", &config)) {
1280 Config::override_path = wx_to_std (config);
1283 if (parser.Found("s", &stress)) {
1284 _stress = wx_to_std (stress);
1290 void report_exception ()
1294 } catch (FileError& e) {
1298 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1299 std_to_wx (e.what()),
1300 std_to_wx (e.file().string().c_str ())
1303 } catch (exception& e) {
1307 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1308 std_to_wx (e.what ())
1312 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1316 /* An unhandled exception has occurred inside the main event loop */
1317 bool OnExceptionInMainLoop () override
1319 report_exception ();
1320 /* This will terminate the program */
1324 void OnUnhandledException () override
1326 report_exception ();
1331 signal_manager->ui_idle ();
1334 void config_failed_to_load ()
1336 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1339 void config_warning (string m)
1341 message_dialog (_frame, std_to_wx (m));
1344 DOMFrame* _frame = nullptr;
1345 string _dcp_to_load;
1346 boost::optional<string> _stress;