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>
74 #include <wx/preferences.h>
75 #include <wx/progdlg.h>
76 #include <wx/splash.h>
77 #include <wx/stdpaths.h>
79 LIBDCP_ENABLE_WARNINGS
83 #include <boost/algorithm/string.hpp>
84 #include <boost/bind/bind.hpp>
96 using std::dynamic_pointer_cast;
99 using std::make_shared;
100 using std::shared_ptr;
105 using boost::optional;
106 using boost::scoped_array;
108 #if BOOST_VERSION >= 106100
109 using namespace boost::placeholders;
111 using dcp::raw_convert;
112 using namespace dcpomatic;
121 /* Allow spare IDs after _history for the recent files list */
124 /* Allow spare IDs for CPLs */
125 ID_view_full_screen = 200,
127 ID_view_closed_captions,
128 ID_view_scale_appropriate,
131 ID_view_scale_quarter,
132 ID_help_report_a_problem,
134 ID_tools_check_for_updates,
136 ID_tools_system_information,
137 /* IDs for shortcuts (with no associated menu item) */
141 ID_go_back_small_amount,
142 ID_go_forward_small_amount,
143 ID_go_back_medium_amount,
144 ID_go_forward_medium_amount,
145 ID_go_back_large_amount,
146 ID_go_forward_large_amount,
151 class DOMFrame : public wxFrame
155 : wxFrame (nullptr, -1, _("DCP-o-matic Player"))
156 , _mode (Config::instance()->player_mode())
157 , _main_sizer (new wxBoxSizer(wxVERTICAL))
159 dcpomatic_log = make_shared<NullLog>();
161 #if defined(DCPOMATIC_WINDOWS)
162 maybe_open_console ();
163 cout << "DCP-o-matic Player is starting." << "\n";
166 auto bar = new wxMenuBar;
168 set_menu_sensitivity ();
171 #ifdef DCPOMATIC_WINDOWS
172 SetIcon (wxIcon (std_to_wx ("id")));
175 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
176 update_from_config (Config::PLAYER_DEBUG_LOG);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
181 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_frame, this), ID_file_save_frame);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
185 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
186 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_full_screen, this), ID_view_full_screen);
187 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_dual_screen, this), ID_view_dual_screen);
188 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
189 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
190 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
191 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
192 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
193 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
194 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
195 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
196 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
197 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_timing, this), ID_tools_timing);
198 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this), ID_tools_system_information);
200 /* Use a panel as the only child of the Frame so that we avoid
201 the dark-grey background on Windows.
203 _overall_panel = new wxPanel (this, wxID_ANY);
205 _viewer = make_shared<FilmViewer>(_overall_panel);
206 if (Config::instance()->player_mode() == Config::PLAYER_MODE_DUAL) {
207 auto pc = new PlaylistControls (_overall_panel, _viewer);
209 pc->ResetFilm.connect (bind(&DOMFrame::reset_film_weak, this, _1));
211 _controls = new StandardControls (_overall_panel, _viewer, false);
213 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
214 _viewer->set_optimise_for_j2k (true);
215 _viewer->PlaybackPermitted.connect (bind(&DOMFrame::playback_permitted, this));
216 _viewer->TooManyDropped.connect (bind(&DOMFrame::too_many_frames_dropped, this));
217 _info = new PlayerInformation (_overall_panel, _viewer);
218 setup_main_sizer (Config::instance()->player_mode());
220 int accelerators = 12;
222 int accelerators = 11;
225 _stress.setup (this, _controls);
227 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
228 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
229 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_go_back_frame);
230 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_go_forward_frame);
231 accel[3].Set(wxACCEL_SHIFT, WXK_LEFT, ID_go_back_small_amount);
232 accel[4].Set(wxACCEL_SHIFT, WXK_RIGHT, ID_go_forward_small_amount);
233 accel[5].Set(wxACCEL_CTRL, WXK_LEFT, ID_go_back_medium_amount);
234 accel[6].Set(wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_medium_amount);
235 accel[7].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_LEFT, ID_go_back_large_amount);
236 accel[8].Set(wxACCEL_SHIFT | wxACCEL_CTRL, WXK_RIGHT, ID_go_forward_large_amount);
237 accel[9].Set(wxACCEL_NORMAL, WXK_HOME, ID_go_to_start);
238 accel[10].Set(wxACCEL_NORMAL, WXK_END, ID_go_to_end);
240 accel[11].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
242 wxAcceleratorTable accel_table (accelerators, accel);
243 SetAcceleratorTable (accel_table);
246 Bind (wxEVT_MENU, boost::bind(&DOMFrame::start_stop_pressed, this), ID_start_stop);
247 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_back_frame, this), ID_go_back_frame);
248 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_forward_frame, this), ID_go_forward_frame);
249 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -60), ID_go_back_small_amount);
250 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 60), ID_go_forward_small_amount);
251 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -600), ID_go_back_medium_amount);
252 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 600), ID_go_forward_medium_amount);
253 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, -3600), ID_go_back_large_amount);
254 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_seconds, this, 3600), ID_go_forward_large_amount);
255 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_start, this), ID_go_to_start);
256 Bind (wxEVT_MENU, boost::bind(&DOMFrame::go_to_end, this), ID_go_to_end);
260 UpdateChecker::instance()->StateChanged.connect (boost::bind(&DOMFrame::update_checker_state_changed, this));
263 _stress.LoadDCP.connect (boost::bind(&DOMFrame::load_dcp, this, _1));
268 /* It's important that this is stopped before our frame starts destroying its children,
269 * otherwise UI elements that it depends on will disappear from under it.
274 void setup_main_sizer (Config::PlayerMode mode)
276 _main_sizer->Detach (_viewer->panel());
277 _main_sizer->Detach (_controls);
278 _main_sizer->Detach (_info);
279 if (mode != Config::PLAYER_MODE_DUAL) {
280 _main_sizer->Add (_viewer->panel(), 1, wxEXPAND);
282 _main_sizer->Add (_controls, mode == Config::PLAYER_MODE_DUAL ? 1 : 0, wxEXPAND | wxALL, 6);
283 _main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
284 _overall_panel->SetSizer (_main_sizer);
285 _overall_panel->Layout ();
288 bool playback_permitted ()
290 if (!_film || !Config::instance()->respect_kdm_validity_periods()) {
295 for (auto i: _film->content()) {
296 auto d = dynamic_pointer_cast<DCPContent>(i);
297 if (d && !d->kdm_timing_window_valid()) {
303 error_dialog (this, _("The KDM does not allow playback of this content at this time."));
310 void too_many_frames_dropped ()
312 if (!Config::instance()->nagged(Config::NAG_TOO_MANY_DROPPED_FRAMES)) {
316 NagDialog::maybe_nag (
318 Config::NAG_TOO_MANY_DROPPED_FRAMES,
319 _(wxS("The player is dropping a lot of frames, so playback may not be accurate.\n\n"
320 "<b>This does not necessarily mean that the DCP you are playing is defective!</b>\n\n"
321 "You may be able to improve player performance by:\n"
322 "• choosing 'decode at half resolution' or 'decode at quarter resolution' from the View menu\n"
323 "• using a more powerful computer.\n"
328 void set_decode_reduction (optional<int> reduction)
330 _viewer->set_dcp_decode_reduction (reduction);
331 _info->triggered_update ();
332 Config::instance()->set_decode_reduction (reduction);
335 void load_dcp (boost::filesystem::path dir)
337 DCPOMATIC_ASSERT (_film);
341 _stress.set_suspended (true);
343 auto dcp = make_shared<DCPContent>(dir);
344 auto job = make_shared<ExamineContentJob>(_film, dcp);
345 _examine_job_connection = job->Finished.connect(bind(&DOMFrame::add_dcp_to_film, this, weak_ptr<Job>(job), weak_ptr<Content>(dcp)));
346 JobManager::instance()->add (job);
347 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
348 if (!ok || !report_errors_from_last_job(this)) {
351 Config::instance()->add_to_player_history (dir);
352 } catch (ProjectFolderError &) {
355 wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())),
357 "This looks like a DCP-o-matic project folder, which cannot be loaded into the player. "
358 "Choose the DCP directory inside the DCP-o-matic project folder if that's what you want to play."
361 } catch (dcp::ReadError& e) {
362 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
363 } catch (DCPError& e) {
364 error_dialog (this, wxString::Format(_("Could not load a DCP from %s"), std_to_wx(dir.string())), std_to_wx(e.what()));
368 void add_dcp_to_film (weak_ptr<Job> weak_job, weak_ptr<Content> weak_content)
370 auto job = weak_job.lock ();
371 if (!job || !job->finished_ok()) {
375 auto content = weak_content.lock ();
380 _film->add_content (content);
381 _stress.set_suspended (false);
384 void reset_film_weak (weak_ptr<Film> weak_film)
386 auto film = weak_film.lock ();
392 void reset_film (shared_ptr<Film> film = shared_ptr<Film>(new Film(optional<boost::filesystem::path>())))
395 _film->set_tolerant (true);
396 _film->set_audio_channels (MAX_DCP_AUDIO_CHANNELS);
397 _viewer->set_film (_film);
398 _controls->set_film (_film);
399 _film->Change.connect (bind(&DOMFrame::film_changed, this, _1, _2));
400 _info->triggered_update ();
403 void film_changed (ChangeType type, Film::Property property)
405 if (type != ChangeType::DONE || property != Film::Property::CONTENT) {
409 if (_viewer->playing ()) {
413 /* Start off as Flat */
414 _film->set_container (Ratio::from_id("185"));
416 for (auto i: _film->content()) {
417 auto dcp = dynamic_pointer_cast<DCPContent>(i);
419 for (auto j: i->text) {
424 auto const r = Ratio::nearest_from_ratio(i->video->size().ratio());
425 if (r->id() == "239") {
426 /* Any scope content means we use scope */
427 _film->set_container(r);
431 /* Any 3D content means we use 3D mode */
432 if (i->video && i->video->frame_type() != VideoFrameType::TWO_D) {
433 _film->set_three_d (true);
437 _viewer->seek (DCPTime(), true);
438 _info->triggered_update ();
440 set_menu_sensitivity ();
442 auto old = _cpl_menu->GetMenuItems();
443 for (auto const& i: old) {
444 _cpl_menu->Remove (i);
447 if (_film->content().size() == 1) {
448 /* Offer a CPL menu */
449 auto first = dynamic_pointer_cast<DCPContent>(_film->content().front());
451 int id = ID_view_cpl;
452 for (auto i: dcp::find_and_resolve_cpls(first->directories(), true)) {
453 auto j = _cpl_menu->AppendRadioItem(
455 wxString::Format("%s (%s)", std_to_wx(i->annotation_text().get_value_or("")).data(), std_to_wx(i->id()).data())
457 j->Check(!first->cpl() || i->id() == *first->cpl());
464 void load_stress_script (boost::filesystem::path path)
466 _stress.load_script (path);
471 void examine_content ()
473 DCPOMATIC_ASSERT (_film);
474 auto dcp = dynamic_pointer_cast<DCPContent>(_film->content().front());
475 DCPOMATIC_ASSERT (dcp);
476 dcp->examine (_film, shared_ptr<Job>());
478 /* Examining content re-creates the TextContent objects, so we must re-enable them */
479 for (auto i: dcp->text) {
484 bool report_errors_from_last_job (wxWindow* parent) const
486 auto jm = JobManager::instance ();
488 DCPOMATIC_ASSERT (!jm->get().empty());
490 auto last = jm->get().back();
491 if (last->finished_in_error()) {
492 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()));
499 void setup_menu (wxMenuBar* m)
501 _file_menu = new wxMenu;
502 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
503 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
504 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("Add &KDM..."));
505 _file_menu->AppendSeparator ();
506 _file_save_frame = _file_menu->Append (ID_file_save_frame, _("&Save frame to file...\tCtrl-S"));
508 _history_position = _file_menu->GetMenuItems().GetCount();
510 _file_menu->AppendSeparator ();
511 _file_menu->Append (ID_file_close, _("&Close"));
512 _file_menu->AppendSeparator ();
515 _file_menu->Append (wxID_EXIT, _("&Exit"));
517 _file_menu->Append (wxID_EXIT, _("&Quit"));
521 auto prefs = _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
523 auto edit = new wxMenu;
524 auto prefs = edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
527 prefs->Enable (Config::instance()->have_write_permission());
529 _cpl_menu = new wxMenu;
531 auto view = new wxMenu;
532 auto c = Config::instance()->decode_reduction();
533 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
534 view->AppendSeparator();
535 _view_full_screen = view->AppendCheckItem(ID_view_full_screen, _("Full screen\tF11"));
536 _view_dual_screen = view->AppendCheckItem(ID_view_dual_screen, _("Dual screen\tShift+F11"));
538 view->AppendSeparator();
539 view->Append(ID_view_closed_captions, _("Closed captions..."));
540 view->AppendSeparator();
541 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
542 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
543 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
544 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
546 auto tools = new wxMenu;
547 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP..."));
548 tools->AppendSeparator ();
549 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
550 tools->Append (ID_tools_timing, _("Timing..."));
551 tools->Append (ID_tools_system_information, _("System information..."));
553 auto help = new wxMenu;
555 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
557 help->Append (wxID_ABOUT, _("About"));
559 help->Append (ID_help_report_a_problem, _("Report a problem..."));
561 m->Append (_file_menu, _("&File"));
563 m->Append (edit, _("&Edit"));
565 m->Append (view, _("&View"));
566 m->Append (tools, _("&Tools"));
567 m->Append (help, _("&Help"));
572 auto d = wxStandardPaths::Get().GetDocumentsDir();
573 if (Config::instance()->last_player_load_directory()) {
574 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
577 auto c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
582 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
583 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
590 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
592 Config::instance()->set_last_player_load_directory (dcp.parent_path());
600 auto c = new wxDirDialog (
602 _("Select DCP to open as OV"),
603 wxStandardPaths::Get().GetDocumentsDir(),
604 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
610 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
611 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
618 DCPOMATIC_ASSERT (_film);
619 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
620 DCPOMATIC_ASSERT (dcp);
621 dcp->add_ov (wx_to_std(c->GetPath()));
622 JobManager::instance()->add(make_shared<ExamineContentJob>(_film, dcp));
623 bool const ok = display_progress (_("DCP-o-matic Player"), _("Loading content"));
624 if (!ok || !report_errors_from_last_job(this)) {
627 for (auto i: dcp->text) {
631 auto const r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
633 _film->set_container(r);
639 _info->triggered_update ();
644 auto d = new wxFileDialog (this, _("Select KDM"));
646 if (d->ShowModal() == wxID_OK) {
647 DCPOMATIC_ASSERT (_film);
648 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
649 DCPOMATIC_ASSERT (dcp);
652 _viewer->set_coalesce_player_changes (true);
653 dcp->add_kdm (dcp::EncryptedKDM(dcp::file_to_string(wx_to_std(d->GetPath()), MAX_KDM_SIZE)));
655 _viewer->set_coalesce_player_changes (false);
657 } catch (exception& e) {
658 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
665 _info->triggered_update ();
668 void file_save_frame ()
670 wxFileDialog dialog (this, _("Save frame to file"), "", "", "PNG files (*.png)|*.png|JPEG files (*.jpg,*.jpeg)|*.jpg,*.jpeg", wxFD_SAVE | wxFD_OVERWRITE_PROMPT);
671 if (dialog.ShowModal() == wxID_CANCEL) {
675 auto path = boost::filesystem::path (wx_to_std(dialog.GetPath()));
677 auto player = make_shared<Player>(_film, Image::Alignment::PADDED);
678 player->seek (_viewer->position(), true);
681 player->Video.connect ([path, &done, this](shared_ptr<PlayerVideo> video, DCPTime) {
682 auto ext = boost::algorithm::to_lower_copy(path.extension().string());
684 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGBA), VideoRange::FULL, false);
685 image_as_png(image).write(path);
686 } else if (ext == ".jpg" || ext == ".jpeg") {
687 auto image = video->image(boost::bind(PlayerVideo::force, AV_PIX_FMT_RGB24), VideoRange::FULL, false);
688 image_as_jpeg(image, 80).write(path);
690 error_dialog (this, _(wxString::Format("Unrecognised file extension %s (use .jpg, .jpeg or .png)", std_to_wx(ext))));
696 while (!done && tries_left >= 0) {
701 DCPOMATIC_ASSERT (tries_left >= 0);
704 void file_history (wxCommandEvent& event)
706 auto history = Config::instance()->player_history ();
707 int n = event.GetId() - ID_file_history;
708 if (n >= 0 && n < static_cast<int> (history.size ())) {
710 load_dcp (history[n]);
711 } catch (exception& e) {
712 error_dialog (0, std_to_wx(String::compose(wx_to_std(_("Could not load DCP %1.")), history[n])), std_to_wx(e.what()));
720 _info->triggered_update ();
721 set_menu_sensitivity ();
729 void edit_preferences ()
731 if (!Config::instance()->have_write_permission()) {
735 if (!_config_dialog) {
736 _config_dialog = create_player_config_dialog ();
738 _config_dialog->Show (this);
741 void view_cpl (wxCommandEvent& ev)
743 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
744 DCPOMATIC_ASSERT (dcp);
745 auto cpls = dcp::find_and_resolve_cpls (dcp->directories(), true);
746 int id = ev.GetId() - ID_view_cpl;
747 DCPOMATIC_ASSERT (id >= 0);
748 DCPOMATIC_ASSERT (id < int(cpls.size()));
749 auto i = cpls.begin();
755 _viewer->set_coalesce_player_changes (true);
756 dcp->set_cpl ((*i)->id());
758 _viewer->set_coalesce_player_changes (false);
760 _info->triggered_update ();
763 void view_full_screen ()
765 if (_mode == Config::PLAYER_MODE_FULL) {
766 _mode = Config::PLAYER_MODE_WINDOW;
768 _mode = Config::PLAYER_MODE_FULL;
774 void view_dual_screen ()
776 if (_mode == Config::PLAYER_MODE_DUAL) {
777 _mode = Config::PLAYER_MODE_WINDOW;
779 _mode = Config::PLAYER_MODE_DUAL;
787 if (_view_full_screen) {
788 _view_full_screen->Check (_mode == Config::PLAYER_MODE_FULL);
790 if (_view_dual_screen) {
791 _view_dual_screen->Check (_mode == Config::PLAYER_MODE_DUAL);
797 _controls->Show (_mode != Config::PLAYER_MODE_FULL);
798 _info->Show (_mode != Config::PLAYER_MODE_FULL);
799 _overall_panel->SetBackgroundColour (_mode == Config::PLAYER_MODE_FULL ? wxColour(0, 0, 0) : wxNullColour);
800 ShowFullScreen (_mode == Config::PLAYER_MODE_FULL);
801 _viewer->set_pad_black (_mode != Config::PLAYER_MODE_WINDOW);
803 if (_mode == Config::PLAYER_MODE_DUAL) {
804 _dual_screen = new wxFrame (this, wxID_ANY, wxT(""));
805 _dual_screen->SetBackgroundColour (wxColour(0, 0, 0));
806 _dual_screen->ShowFullScreen (true);
807 _viewer->panel()->Reparent (_dual_screen);
808 _dual_screen->Show ();
809 if (wxDisplay::GetCount() > 1) {
810 switch (Config::instance()->image_display()) {
812 _dual_screen->Move (0, 0);
813 Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
816 _dual_screen->Move (wxDisplay(0U).GetClientArea().GetWidth(), 0);
817 // (0, 0) doesn't seem to work for some strange reason
824 _viewer->panel()->Reparent (_overall_panel);
825 _dual_screen->Destroy ();
830 setup_main_sizer (_mode);
833 void view_closed_captions ()
835 _viewer->show_closed_captions ();
840 auto dcp = std::dynamic_pointer_cast<DCPContent>(_film->content().front());
841 DCPOMATIC_ASSERT (dcp);
843 auto job = make_shared<VerifyDCPJob>(dcp->directories());
844 auto progress = new VerifyDCPProgressDialog(this, _("DCP-o-matic Player"));
845 bool const completed = progress->run (job);
846 progress->Destroy ();
851 auto d = new VerifyDCPDialog (this, job);
856 void tools_check_for_updates ()
858 UpdateChecker::instance()->run ();
859 _update_news_requested = true;
864 auto d = new TimerDisplay (this, _viewer->state_timer(), _viewer->gets());
869 void tools_system_information ()
871 if (!_system_information_dialog) {
872 _system_information_dialog = new SystemInformationDialog (this, _viewer);
875 _system_information_dialog->Show ();
880 auto d = new AboutDialog (this);
885 void help_report_a_problem ()
887 auto d = new ReportProblemDialog (this);
888 if (d->ShowModal () == wxID_OK) {
894 void update_checker_state_changed ()
896 auto uc = UpdateChecker::instance ();
898 bool const announce =
899 _update_news_requested ||
900 (uc->stable() && Config::instance()->check_for_updates()) ||
901 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
903 _update_news_requested = false;
909 if (uc->state() == UpdateChecker::State::YES) {
910 auto dialog = new UpdateDialog (this, uc->stable (), uc->test ());
911 dialog->ShowModal ();
913 } else if (uc->state() == UpdateChecker::State::FAILED) {
914 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
916 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
919 _update_news_requested = false;
922 void config_changed (Config::Property prop)
924 /* Instantly save any config changes when using the player GUI */
926 Config::instance()->write_config();
927 } catch (FileError& e) {
928 if (prop != Config::HISTORY) {
932 _("Could not write to config file at %s. Your changes have not been saved."),
933 std_to_wx(e.file().string())
937 } catch (exception& e) {
940 _("Could not write to config file. Your changes have not been saved.")
944 update_from_config (prop);
947 void update_from_config (Config::Property prop)
949 for (int i = 0; i < _history_items; ++i) {
950 delete _file_menu->Remove (ID_file_history + i);
953 if (_history_separator) {
954 _file_menu->Remove (_history_separator);
956 delete _history_separator;
957 _history_separator = nullptr;
959 int pos = _history_position;
961 /* Clear out non-existant history items before we re-build the menu */
962 Config::instance()->clean_player_history ();
963 auto history = Config::instance()->player_history ();
965 if (!history.empty ()) {
966 _history_separator = _file_menu->InsertSeparator (pos++);
969 for (size_t i = 0; i < history.size(); ++i) {
972 s = String::compose ("&%1 %2", i + 1, history[i].string());
974 s = history[i].string();
976 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
979 _history_items = history.size ();
981 if (prop == Config::PLAYER_DEBUG_LOG) {
982 auto p = Config::instance()->player_debug_log_file();
984 dcpomatic_log = make_shared<FileLog>(*p);
986 dcpomatic_log = make_shared<NullLog>();
988 dcpomatic_log->set_types (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR | LogEntry::TYPE_DEBUG_VIDEO_VIEW);
992 void set_menu_sensitivity ()
994 _tools_verify->Enable (static_cast<bool>(_film));
995 _file_add_ov->Enable (static_cast<bool>(_film));
996 _file_add_kdm->Enable (static_cast<bool>(_film));
997 _file_save_frame->Enable (static_cast<bool>(_film));
998 _view_cpl->Enable (static_cast<bool>(_film));
1001 void start_stop_pressed ()
1003 if (_viewer->playing()) {
1010 void go_back_frame ()
1012 _viewer->seek_by (-_viewer->one_video_frame(), true);
1015 void go_forward_frame ()
1017 _viewer->seek_by (_viewer->one_video_frame(), true);
1020 void go_seconds (int s)
1022 _viewer->seek_by (DCPTime::from_seconds(s), true);
1027 _viewer->seek (DCPTime(), true);
1032 _viewer->seek (_film->length() - _viewer->one_video_frame(), true);
1035 wxFrame* _dual_screen = nullptr;
1036 bool _update_news_requested = false;
1037 PlayerInformation* _info = nullptr;
1038 Config::PlayerMode _mode;
1039 wxPreferencesEditor* _config_dialog = nullptr;
1040 wxPanel* _overall_panel = nullptr;
1041 wxMenu* _file_menu = nullptr;
1042 wxMenuItem* _view_cpl = nullptr;
1043 wxMenu* _cpl_menu = nullptr;
1044 int _history_items = 0;
1045 int _history_position = 0;
1046 wxMenuItem* _history_separator = nullptr;
1047 shared_ptr<FilmViewer> _viewer;
1048 Controls* _controls;
1049 SystemInformationDialog* _system_information_dialog = nullptr;
1050 std::shared_ptr<Film> _film;
1051 boost::signals2::scoped_connection _config_changed_connection;
1052 boost::signals2::scoped_connection _examine_job_connection;
1053 wxMenuItem* _file_add_ov = nullptr;
1054 wxMenuItem* _file_add_kdm = nullptr;
1055 wxMenuItem* _file_save_frame = nullptr;
1056 wxMenuItem* _tools_verify = nullptr;
1057 wxMenuItem* _view_full_screen = nullptr;
1058 wxMenuItem* _view_dual_screen = nullptr;
1059 wxSizer* _main_sizer = nullptr;
1060 PlayerStressTester _stress;
1063 static const wxCmdLineEntryDesc command_line_description[] = {
1064 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1065 { wxCMD_LINE_OPTION, "c", "config", "Directory containing config.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1066 { wxCMD_LINE_OPTION, "s", "stress", "File containing description of stress test", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1067 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1070 class PlayServer : public Server
1073 explicit PlayServer (DOMFrame* frame)
1074 : Server (PLAYER_PLAY_PORT)
1078 void handle (shared_ptr<Socket> socket) override
1081 int const length = socket->read_uint32 ();
1082 scoped_array<char> buffer (new char[length]);
1083 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
1084 string s (buffer.get());
1085 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
1086 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
1097 * @brief The magic App class for wxWidgets.
1099 class App : public wxApp
1105 #ifdef DCPOMATIC_LINUX
1112 bool OnInit () override
1114 wxSplashScreen* splash = nullptr;
1116 wxInitAllImageHandlers ();
1118 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1119 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1121 splash = maybe_show_splash ();
1123 SetAppName (_("DCP-o-matic Player"));
1125 if (!wxApp::OnInit()) {
1129 #ifdef DCPOMATIC_LINUX
1130 unsetenv ("UBUNTU_MENUPROXY");
1133 #ifdef DCPOMATIC_OSX
1134 make_foreground_application ();
1137 dcpomatic_setup_path_encoding ();
1139 /* Enable i18n; this will create a Config object
1140 to look for a force-configured language. This Config
1141 object will be wrong, however, because dcpomatic_setup
1142 hasn't yet been called and there aren't any filters etc.
1145 dcpomatic_setup_i18n ();
1147 /* Set things up, including filters etc.
1148 which will now be internationalised correctly.
1152 /* Force the configuration to be re-loaded correctly next
1157 signal_manager = new wxSignalManager (this);
1159 _frame = new DOMFrame ();
1160 SetTopWindow (_frame);
1161 _frame->Maximize ();
1169 auto server = new PlayServer (_frame);
1170 new thread (boost::bind (&PlayServer::run, server));
1171 } catch (std::exception& e) {
1172 /* This is not the end of the world; probably a failure to bind the server socket
1173 * because there's already another player running.
1175 LOG_DEBUG_PLAYER ("Failed to start play server (%1)", e.what());
1178 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
1180 _frame->load_dcp (_dcp_to_load);
1181 } catch (exception& e) {
1182 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
1188 _frame->load_stress_script (*_stress);
1189 } catch (exception& e) {
1190 error_dialog (0, wxString::Format("Could not load stress test file %s", std_to_wx(*_stress)));
1194 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1196 if (Config::instance()->check_for_updates ()) {
1197 UpdateChecker::instance()->run ();
1200 catch (exception& e)
1205 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
1211 void OnInitCmdLine (wxCmdLineParser& parser) override
1213 parser.SetDesc (command_line_description);
1214 parser.SetSwitchChars (wxT ("-"));
1217 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1219 if (parser.GetParamCount() > 0) {
1220 _dcp_to_load = wx_to_std (parser.GetParam (0));
1224 if (parser.Found("c", &config)) {
1225 Config::override_path = wx_to_std (config);
1228 if (parser.Found("s", &stress)) {
1229 _stress = wx_to_std (stress);
1235 void report_exception ()
1239 } catch (FileError& e) {
1243 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1244 std_to_wx (e.what()),
1245 std_to_wx (e.file().string().c_str ())
1248 } catch (exception& e) {
1252 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1253 std_to_wx (e.what ())
1257 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1261 /* An unhandled exception has occurred inside the main event loop */
1262 bool OnExceptionInMainLoop () override
1264 report_exception ();
1265 /* This will terminate the program */
1269 void OnUnhandledException () override
1271 report_exception ();
1276 signal_manager->ui_idle ();
1279 void config_failed_to_load ()
1281 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1284 void config_warning (string m)
1286 message_dialog (_frame, std_to_wx (m));
1289 DOMFrame* _frame = nullptr;
1290 string _dcp_to_load;
1291 boost::optional<string> _stress;