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) */
90 class DOMFrame : public wxFrame
94 : wxFrame (0, -1, _("DCP-o-matic Player"))
95 , _update_news_requested (false)
100 , _history_position (0)
101 , _history_separator (0)
105 #if defined(DCPOMATIC_WINDOWS)
106 maybe_open_console ();
107 cout << "DCP-o-matic Player is starting." << "\n";
110 wxMenuBar* bar = new wxMenuBar;
112 set_menu_sensitivity ();
115 #ifdef DCPOMATIC_WINDOWS
116 SetIcon (wxIcon (std_to_wx ("id")));
119 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
122 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
123 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
124 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
125 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
126 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
127 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
128 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
129 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
130 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
131 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
132 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
138 /* Use a panel as the only child of the Frame so that we avoid
139 the dark-grey background on Windows.
141 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
143 _viewer = new FilmViewer (overall_panel, false, false);
144 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
145 _info = new PlayerInformation (overall_panel, _viewer);
146 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
147 main_sizer->Add (_viewer, 1, wxEXPAND | wxALL, 6);
148 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
149 overall_panel->SetSizer (main_sizer);
152 int accelerators = 2;
154 int accelerators = 1;
157 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
158 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
160 accel[1].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
162 wxAcceleratorTable accel_table (accelerators, accel);
163 SetAcceleratorTable (accel_table);
166 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
168 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
171 void set_decode_reduction (optional<int> reduction)
173 _viewer->set_dcp_decode_reduction (reduction);
174 _info->triggered_update ();
175 Config::instance()->set_decode_reduction (reduction);
178 void load_dcp (boost::filesystem::path dir)
180 _film.reset (new Film (optional<boost::filesystem::path>()));
181 shared_ptr<DCPContent> dcp;
183 dcp.reset (new DCPContent (_film, dir));
184 } catch (boost::filesystem::filesystem_error& e) {
185 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
189 _film->examine_and_add_content (dcp, true);
191 JobManager* jm = JobManager::instance ();
193 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), _("Loading DCP"));
195 while (jm->work_to_do() || signal_manager->ui_idle()) {
200 progress->Destroy ();
202 DCPOMATIC_ASSERT (!jm->get().empty());
204 shared_ptr<Job> last = jm->get().back();
205 if (last->finished_in_error()) {
206 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
211 dcp->subtitle->set_use (true);
214 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
216 _film->set_container(r);
219 _viewer->set_film (_film);
220 _viewer->set_position (DCPTime ());
221 _info->triggered_update ();
223 Config::instance()->add_to_player_history (dir);
225 set_menu_sensitivity ();
227 wxMenuItemList old = _cpl_menu->GetMenuItems();
228 for (wxMenuItemList::iterator i = old.begin(); i != old.end(); ++i) {
229 _cpl_menu->Remove (*i);
232 DCPExaminer ex (dcp);
233 int id = ID_view_cpl;
234 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
235 wxMenuItem* j = _cpl_menu->AppendRadioItem(id, i->id());
236 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
244 void setup_menu (wxMenuBar* m)
246 _file_menu = new wxMenu;
247 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
248 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
249 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
251 _history_position = _file_menu->GetMenuItems().GetCount();
253 _file_menu->AppendSeparator ();
254 _file_menu->Append (ID_file_close, _("&Close"));
255 _file_menu->AppendSeparator ();
258 _file_menu->Append (wxID_EXIT, _("&Exit"));
260 _file_menu->Append (wxID_EXIT, _("&Quit"));
264 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
266 wxMenu* edit = new wxMenu;
267 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
270 _cpl_menu = new wxMenu;
272 wxMenu* view = new wxMenu;
273 optional<int> c = Config::instance()->decode_reduction();
274 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
275 view->AppendSeparator();
276 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
277 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
278 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
279 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
281 wxMenu* tools = new wxMenu;
282 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
283 tools->AppendSeparator ();
284 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
286 wxMenu* help = new wxMenu;
288 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
290 help->Append (wxID_ABOUT, _("About"));
292 help->Append (ID_help_report_a_problem, _("Report a problem..."));
294 m->Append (_file_menu, _("&File"));
296 m->Append (edit, _("&Edit"));
298 m->Append (view, _("&View"));
299 m->Append (tools, _("&Tools"));
300 m->Append (help, _("&Help"));
305 wxString d = wxStandardPaths::Get().GetDocumentsDir();
306 if (Config::instance()->last_player_load_directory()) {
307 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
310 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
315 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
316 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
323 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
325 Config::instance()->set_last_player_load_directory (dcp.parent_path());
333 wxDirDialog* c = new wxDirDialog (
335 _("Select DCP to open as OV"),
336 wxStandardPaths::Get().GetDocumentsDir(),
337 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
343 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
344 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
351 DCPOMATIC_ASSERT (_film);
352 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
353 DCPOMATIC_ASSERT (dcp);
354 dcp->add_ov (wx_to_std(c->GetPath()));
355 dcp->examine (shared_ptr<Job>());
356 /* Maybe we just gained some subtitles */
358 dcp->subtitle->set_use (true);
363 _info->triggered_update ();
368 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
370 if (d->ShowModal() == wxID_OK) {
371 DCPOMATIC_ASSERT (_film);
372 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
373 DCPOMATIC_ASSERT (dcp);
375 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
376 dcp->examine (shared_ptr<Job>());
377 } catch (exception& e) {
378 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
385 _info->triggered_update ();
388 void file_history (wxCommandEvent& event)
390 vector<boost::filesystem::path> history = Config::instance()->player_history ();
391 int n = event.GetId() - ID_file_history;
392 if (n >= 0 && n < static_cast<int> (history.size ())) {
393 load_dcp (history[n]);
399 _viewer->set_film (shared_ptr<Film>());
401 _info->triggered_update ();
402 set_menu_sensitivity ();
410 void edit_preferences ()
412 if (!_config_dialog) {
413 _config_dialog = create_player_config_dialog ();
415 _config_dialog->Show (this);
418 void view_cpl (wxCommandEvent& ev)
420 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
421 DCPOMATIC_ASSERT (dcp);
422 DCPExaminer ex (dcp);
423 int id = ev.GetId() - ID_view_cpl;
424 DCPOMATIC_ASSERT (id >= 0);
425 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
426 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
427 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
433 dcp->set_cpl ((*i)->id());
434 dcp->examine (shared_ptr<Job>());
439 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
440 DCPOMATIC_ASSERT (dcp);
442 JobManager* jm = JobManager::instance ();
443 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
445 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), _("Verifying DCP"));
447 while (jm->work_to_do() || signal_manager->ui_idle()) {
452 progress->Destroy ();
454 DCPOMATIC_ASSERT (!jm->get().empty());
455 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
456 DCPOMATIC_ASSERT (last);
458 VerifyDCPDialog* d = new VerifyDCPDialog (this, last->notes ());
463 void tools_check_for_updates ()
465 UpdateChecker::instance()->run ();
466 _update_news_requested = true;
471 AboutDialog* d = new AboutDialog (this);
476 void help_report_a_problem ()
478 ReportProblemDialog* d = new ReportProblemDialog (this);
479 if (d->ShowModal () == wxID_OK) {
485 void update_checker_state_changed ()
487 UpdateChecker* uc = UpdateChecker::instance ();
489 bool const announce =
490 _update_news_requested ||
491 (uc->stable() && Config::instance()->check_for_updates()) ||
492 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
494 _update_news_requested = false;
500 if (uc->state() == UpdateChecker::YES) {
501 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
502 dialog->ShowModal ();
504 } else if (uc->state() == UpdateChecker::FAILED) {
505 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
507 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
510 _update_news_requested = false;
513 void config_changed ()
515 /* Instantly save any config changes when using the player GUI */
517 Config::instance()->write_config();
518 } catch (exception& e) {
522 _("Could not write to config file at %s. Your changes have not been saved."),
523 std_to_wx (Config::instance()->cinemas_file().string()).data()
528 for (int i = 0; i < _history_items; ++i) {
529 delete _file_menu->Remove (ID_file_history + i);
532 if (_history_separator) {
533 _file_menu->Remove (_history_separator);
535 delete _history_separator;
536 _history_separator = 0;
538 int pos = _history_position;
540 vector<boost::filesystem::path> history = Config::instance()->player_history ();
542 if (!history.empty ()) {
543 _history_separator = _file_menu->InsertSeparator (pos++);
546 for (size_t i = 0; i < history.size(); ++i) {
549 s = String::compose ("&%1 %2", i + 1, history[i].string());
551 s = history[i].string();
553 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
556 _history_items = history.size ();
559 void set_menu_sensitivity ()
561 _tools_verify->Enable (static_cast<bool>(_film));
562 _file_add_ov->Enable (static_cast<bool>(_film));
563 _file_add_kdm->Enable (static_cast<bool>(_film));
564 _view_cpl->Enable (static_cast<bool>(_film));
567 void start_stop_pressed ()
569 if (_viewer->playing()) {
576 bool _update_news_requested;
577 PlayerInformation* _info;
578 wxPreferencesEditor* _config_dialog;
580 wxMenuItem* _view_cpl;
583 int _history_position;
584 wxMenuItem* _history_separator;
586 boost::shared_ptr<Film> _film;
587 boost::signals2::scoped_connection _config_changed_connection;
588 wxMenuItem* _file_add_ov;
589 wxMenuItem* _file_add_kdm;
590 wxMenuItem* _tools_verify;
593 static const wxCmdLineEntryDesc command_line_description[] = {
594 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
595 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
599 * @brief The magic App class for wxWidgets.
601 class App : public wxApp
614 wxInitAllImageHandlers ();
616 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
617 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
619 wxSplashScreen* splash = maybe_show_splash ();
621 SetAppName (_("DCP-o-matic Player"));
623 if (!wxApp::OnInit()) {
627 #ifdef DCPOMATIC_LINUX
628 unsetenv ("UBUNTU_MENUPROXY");
632 ProcessSerialNumber serial;
633 GetCurrentProcess (&serial);
634 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
637 dcpomatic_setup_path_encoding ();
639 /* Enable i18n; this will create a Config object
640 to look for a force-configured language. This Config
641 object will be wrong, however, because dcpomatic_setup
642 hasn't yet been called and there aren't any filters etc.
645 dcpomatic_setup_i18n ();
647 /* Set things up, including filters etc.
648 which will now be internationalised correctly.
652 /* Force the configuration to be re-loaded correctly next
657 _frame = new DOMFrame ();
658 SetTopWindow (_frame);
665 signal_manager = new wxSignalManager (this);
667 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
669 _frame->load_dcp (_dcp_to_load);
670 } catch (exception& e) {
671 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
675 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
677 if (Config::instance()->check_for_updates ()) {
678 UpdateChecker::instance()->run ();
685 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
689 void OnInitCmdLine (wxCmdLineParser& parser)
691 parser.SetDesc (command_line_description);
692 parser.SetSwitchChars (wxT ("-"));
695 bool OnCmdLineParsed (wxCmdLineParser& parser)
697 if (parser.GetParamCount() > 0) {
698 _dcp_to_load = wx_to_std (parser.GetParam (0));
704 void report_exception ()
708 } catch (FileError& e) {
712 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
713 std_to_wx (e.what()),
714 std_to_wx (e.file().string().c_str ())
717 } catch (exception& e) {
721 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
722 std_to_wx (e.what ())
726 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
730 /* An unhandled exception has occurred inside the main event loop */
731 bool OnExceptionInMainLoop ()
734 /* This will terminate the program */
738 void OnUnhandledException ()
745 signal_manager->ui_idle ();
748 void config_failed_to_load ()
750 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
753 void config_warning (string m)
755 message_dialog (_frame, std_to_wx (m));