2 Copyright (C) 2017-2018 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 "lib/cross.h"
22 #include "lib/config.h"
24 #include "lib/update_checker.h"
25 #include "lib/compose.hpp"
26 #include "lib/dcp_content.h"
27 #include "lib/job_manager.h"
29 #include "lib/video_content.h"
30 #include "lib/subtitle_content.h"
31 #include "lib/ratio.h"
32 #include "lib/verify_dcp_job.h"
33 #include "lib/dcp_examiner.h"
34 #include "wx/wx_signal_manager.h"
35 #include "wx/wx_util.h"
36 #include "wx/about_dialog.h"
37 #include "wx/report_problem_dialog.h"
38 #include "wx/film_viewer.h"
39 #include "wx/player_information.h"
40 #include "wx/update_dialog.h"
41 #include "wx/player_config_dialog.h"
42 #include "wx/verify_dcp_dialog.h"
44 #include <wx/stdpaths.h>
45 #include <wx/splash.h>
46 #include <wx/cmdline.h>
47 #include <wx/preferences.h>
48 #include <wx/progdlg.h>
50 #include <ApplicationServices/ApplicationServices.h>
52 #include <boost/bind.hpp>
66 using boost::shared_ptr;
67 using boost::optional;
68 using boost::dynamic_pointer_cast;
75 /* Allow spare IDs after _history for the recent files list */
78 /* Allow spare IDs for CPLs */
79 ID_view_scale_appropriate = 200,
82 ID_view_scale_quarter,
83 ID_help_report_a_problem,
85 ID_tools_check_for_updates,
86 /* IDs for shortcuts (with no associated menu item) */
92 class DOMFrame : public wxFrame
96 : wxFrame (0, -1, _("DCP-o-matic Player"))
97 , _update_news_requested (false)
102 , _history_position (0)
103 , _history_separator (0)
107 #if defined(DCPOMATIC_WINDOWS)
108 maybe_open_console ();
109 cout << "DCP-o-matic Player is starting." << "\n";
112 wxMenuBar* bar = new wxMenuBar;
114 set_menu_sensitivity ();
117 #ifdef DCPOMATIC_WINDOWS
118 SetIcon (wxIcon (std_to_wx ("id")));
121 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
124 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
125 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
126 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
127 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
128 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
129 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
130 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
131 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
132 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
137 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
138 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
140 /* Use a panel as the only child of the Frame so that we avoid
141 the dark-grey background on Windows.
143 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
145 _viewer = new FilmViewer (overall_panel, false, false);
146 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
147 _info = new PlayerInformation (overall_panel, _viewer);
148 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
149 main_sizer->Add (_viewer, 1, wxEXPAND | wxALL, 6);
150 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
151 overall_panel->SetSizer (main_sizer);
154 int accelerators = 4;
156 int accelerators = 3;
159 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
160 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
161 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
162 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
164 accel[3].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
166 wxAcceleratorTable accel_table (accelerators, accel);
167 SetAcceleratorTable (accel_table);
170 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
171 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
172 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
174 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
177 void set_decode_reduction (optional<int> reduction)
179 _viewer->set_dcp_decode_reduction (reduction);
180 _info->triggered_update ();
181 Config::instance()->set_decode_reduction (reduction);
184 void load_dcp (boost::filesystem::path dir)
186 _film.reset (new Film (optional<boost::filesystem::path>()));
187 shared_ptr<DCPContent> dcp;
189 dcp.reset (new DCPContent (_film, dir));
190 } catch (boost::filesystem::filesystem_error& e) {
191 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
195 _film->examine_and_add_content (dcp, true);
197 JobManager* jm = JobManager::instance ();
199 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), _("Loading DCP"));
201 while (jm->work_to_do() || signal_manager->ui_idle()) {
206 progress->Destroy ();
208 DCPOMATIC_ASSERT (!jm->get().empty());
210 shared_ptr<Job> last = jm->get().back();
211 if (last->finished_in_error()) {
212 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
217 dcp->subtitle->set_use (true);
220 if (dcp->three_d()) {
221 _film->set_three_d (true);
224 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
226 _film->set_container(r);
229 _viewer->set_film (_film);
230 _viewer->set_position (DCPTime ());
231 _info->triggered_update ();
233 Config::instance()->add_to_player_history (dir);
235 set_menu_sensitivity ();
237 wxMenuItemList old = _cpl_menu->GetMenuItems();
238 for (wxMenuItemList::iterator i = old.begin(); i != old.end(); ++i) {
239 _cpl_menu->Remove (*i);
242 DCPExaminer ex (dcp);
243 int id = ID_view_cpl;
244 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
245 wxMenuItem* j = _cpl_menu->AppendRadioItem(id, i->id());
246 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
255 void setup_menu (wxMenuBar* m)
257 _file_menu = new wxMenu;
258 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
259 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
260 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
262 _history_position = _file_menu->GetMenuItems().GetCount();
264 _file_menu->AppendSeparator ();
265 _file_menu->Append (ID_file_close, _("&Close"));
266 _file_menu->AppendSeparator ();
269 _file_menu->Append (wxID_EXIT, _("&Exit"));
271 _file_menu->Append (wxID_EXIT, _("&Quit"));
275 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
277 wxMenu* edit = new wxMenu;
278 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
281 _cpl_menu = new wxMenu;
283 wxMenu* view = new wxMenu;
284 optional<int> c = Config::instance()->decode_reduction();
285 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
286 view->AppendSeparator();
287 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
288 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
289 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
290 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
292 wxMenu* tools = new wxMenu;
293 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
294 tools->AppendSeparator ();
295 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
297 wxMenu* help = new wxMenu;
299 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
301 help->Append (wxID_ABOUT, _("About"));
303 help->Append (ID_help_report_a_problem, _("Report a problem..."));
305 m->Append (_file_menu, _("&File"));
307 m->Append (edit, _("&Edit"));
309 m->Append (view, _("&View"));
310 m->Append (tools, _("&Tools"));
311 m->Append (help, _("&Help"));
316 wxString d = wxStandardPaths::Get().GetDocumentsDir();
317 if (Config::instance()->last_player_load_directory()) {
318 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
321 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
326 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
327 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
334 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
336 Config::instance()->set_last_player_load_directory (dcp.parent_path());
344 wxDirDialog* c = new wxDirDialog (
346 _("Select DCP to open as OV"),
347 wxStandardPaths::Get().GetDocumentsDir(),
348 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
354 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
355 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
362 DCPOMATIC_ASSERT (_film);
363 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
364 DCPOMATIC_ASSERT (dcp);
365 dcp->add_ov (wx_to_std(c->GetPath()));
366 dcp->examine (shared_ptr<Job>());
367 /* Maybe we just gained some subtitles */
369 dcp->subtitle->set_use (true);
374 _info->triggered_update ();
379 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
381 if (d->ShowModal() == wxID_OK) {
382 DCPOMATIC_ASSERT (_film);
383 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
384 DCPOMATIC_ASSERT (dcp);
386 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
387 dcp->examine (shared_ptr<Job>());
388 } catch (exception& e) {
389 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
396 _info->triggered_update ();
399 void file_history (wxCommandEvent& event)
401 vector<boost::filesystem::path> history = Config::instance()->player_history ();
402 int n = event.GetId() - ID_file_history;
403 if (n >= 0 && n < static_cast<int> (history.size ())) {
404 load_dcp (history[n]);
410 _viewer->set_film (shared_ptr<Film>());
412 _info->triggered_update ();
413 set_menu_sensitivity ();
421 void edit_preferences ()
423 if (!_config_dialog) {
424 _config_dialog = create_player_config_dialog ();
426 _config_dialog->Show (this);
429 void view_cpl (wxCommandEvent& ev)
431 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
432 DCPOMATIC_ASSERT (dcp);
433 DCPExaminer ex (dcp);
434 int id = ev.GetId() - ID_view_cpl;
435 DCPOMATIC_ASSERT (id >= 0);
436 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
437 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
438 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
444 dcp->set_cpl ((*i)->id());
445 dcp->examine (shared_ptr<Job>());
450 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
451 DCPOMATIC_ASSERT (dcp);
453 JobManager* jm = JobManager::instance ();
454 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
456 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), _("Verifying DCP"));
458 while (jm->work_to_do() || signal_manager->ui_idle()) {
463 progress->Destroy ();
465 DCPOMATIC_ASSERT (!jm->get().empty());
466 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
467 DCPOMATIC_ASSERT (last);
469 VerifyDCPDialog* d = new VerifyDCPDialog (this, last);
474 void tools_check_for_updates ()
476 UpdateChecker::instance()->run ();
477 _update_news_requested = true;
482 AboutDialog* d = new AboutDialog (this);
487 void help_report_a_problem ()
489 ReportProblemDialog* d = new ReportProblemDialog (this);
490 if (d->ShowModal () == wxID_OK) {
496 void update_checker_state_changed ()
498 UpdateChecker* uc = UpdateChecker::instance ();
500 bool const announce =
501 _update_news_requested ||
502 (uc->stable() && Config::instance()->check_for_updates()) ||
503 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
505 _update_news_requested = false;
511 if (uc->state() == UpdateChecker::YES) {
512 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
513 dialog->ShowModal ();
515 } else if (uc->state() == UpdateChecker::FAILED) {
516 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
518 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
521 _update_news_requested = false;
524 void config_changed ()
526 /* Instantly save any config changes when using the player GUI */
528 Config::instance()->write_config();
529 } catch (exception& e) {
533 _("Could not write to config file at %s. Your changes have not been saved."),
534 std_to_wx (Config::instance()->cinemas_file().string()).data()
539 for (int i = 0; i < _history_items; ++i) {
540 delete _file_menu->Remove (ID_file_history + i);
543 if (_history_separator) {
544 _file_menu->Remove (_history_separator);
546 delete _history_separator;
547 _history_separator = 0;
549 int pos = _history_position;
551 vector<boost::filesystem::path> history = Config::instance()->player_history ();
553 if (!history.empty ()) {
554 _history_separator = _file_menu->InsertSeparator (pos++);
557 for (size_t i = 0; i < history.size(); ++i) {
560 s = String::compose ("&%1 %2", i + 1, history[i].string());
562 s = history[i].string();
564 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
567 _history_items = history.size ();
570 void set_menu_sensitivity ()
572 _tools_verify->Enable (static_cast<bool>(_film));
573 _file_add_ov->Enable (static_cast<bool>(_film));
574 _file_add_kdm->Enable (static_cast<bool>(_film));
575 _view_cpl->Enable (static_cast<bool>(_film));
578 void start_stop_pressed ()
580 if (_viewer->playing()) {
589 _viewer->back_frame ();
592 void forward_frame ()
594 _viewer->forward_frame ();
597 bool _update_news_requested;
598 PlayerInformation* _info;
599 wxPreferencesEditor* _config_dialog;
601 wxMenuItem* _view_cpl;
604 int _history_position;
605 wxMenuItem* _history_separator;
607 boost::shared_ptr<Film> _film;
608 boost::signals2::scoped_connection _config_changed_connection;
609 wxMenuItem* _file_add_ov;
610 wxMenuItem* _file_add_kdm;
611 wxMenuItem* _tools_verify;
614 static const wxCmdLineEntryDesc command_line_description[] = {
615 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
616 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
620 * @brief The magic App class for wxWidgets.
622 class App : public wxApp
635 wxInitAllImageHandlers ();
637 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
638 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
640 wxSplashScreen* splash = maybe_show_splash ();
642 SetAppName (_("DCP-o-matic Player"));
644 if (!wxApp::OnInit()) {
648 #ifdef DCPOMATIC_LINUX
649 unsetenv ("UBUNTU_MENUPROXY");
653 ProcessSerialNumber serial;
654 GetCurrentProcess (&serial);
655 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
658 dcpomatic_setup_path_encoding ();
660 /* Enable i18n; this will create a Config object
661 to look for a force-configured language. This Config
662 object will be wrong, however, because dcpomatic_setup
663 hasn't yet been called and there aren't any filters etc.
666 dcpomatic_setup_i18n ();
668 /* Set things up, including filters etc.
669 which will now be internationalised correctly.
673 /* Force the configuration to be re-loaded correctly next
678 _frame = new DOMFrame ();
679 SetTopWindow (_frame);
686 signal_manager = new wxSignalManager (this);
688 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
690 _frame->load_dcp (_dcp_to_load);
691 } catch (exception& e) {
692 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
696 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
698 if (Config::instance()->check_for_updates ()) {
699 UpdateChecker::instance()->run ();
706 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
710 void OnInitCmdLine (wxCmdLineParser& parser)
712 parser.SetDesc (command_line_description);
713 parser.SetSwitchChars (wxT ("-"));
716 bool OnCmdLineParsed (wxCmdLineParser& parser)
718 if (parser.GetParamCount() > 0) {
719 _dcp_to_load = wx_to_std (parser.GetParam (0));
725 void report_exception ()
729 } catch (FileError& e) {
733 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
734 std_to_wx (e.what()),
735 std_to_wx (e.file().string().c_str ())
738 } catch (exception& e) {
742 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
743 std_to_wx (e.what ())
747 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
751 /* An unhandled exception has occurred inside the main event loop */
752 bool OnExceptionInMainLoop ()
755 /* This will terminate the program */
759 void OnUnhandledException ()
766 signal_manager->ui_idle ();
769 void config_failed_to_load ()
771 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
774 void config_warning (string m)
776 message_dialog (_frame, std_to_wx (m));