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 "lib/examine_content_job.h"
35 #include "lib/server.h"
36 #include "lib/dcpomatic_socket.h"
37 #include "wx/wx_signal_manager.h"
38 #include "wx/wx_util.h"
39 #include "wx/about_dialog.h"
40 #include "wx/report_problem_dialog.h"
41 #include "wx/film_viewer.h"
42 #include "wx/player_information.h"
43 #include "wx/update_dialog.h"
44 #include "wx/player_config_dialog.h"
45 #include "wx/verify_dcp_dialog.h"
47 #include <wx/stdpaths.h>
48 #include <wx/splash.h>
49 #include <wx/cmdline.h>
50 #include <wx/preferences.h>
51 #include <wx/progdlg.h>
53 #include <ApplicationServices/ApplicationServices.h>
55 #include <boost/bind.hpp>
69 using boost::shared_ptr;
70 using boost::scoped_array;
71 using boost::optional;
72 using boost::dynamic_pointer_cast;
81 /* Allow spare IDs after _history for the recent files list */
84 /* Allow spare IDs for CPLs */
85 ID_view_scale_appropriate = 200,
88 ID_view_scale_quarter,
89 ID_help_report_a_problem,
91 ID_tools_check_for_updates,
92 /* IDs for shortcuts (with no associated menu item) */
98 class DOMFrame : public wxFrame
102 : wxFrame (0, -1, _("DCP-o-matic Player"))
103 , _update_news_requested (false)
108 , _history_position (0)
109 , _history_separator (0)
113 #if defined(DCPOMATIC_WINDOWS)
114 maybe_open_console ();
115 cout << "DCP-o-matic Player is starting." << "\n";
118 wxMenuBar* bar = new wxMenuBar;
120 set_menu_sensitivity ();
123 #ifdef DCPOMATIC_WINDOWS
124 SetIcon (wxIcon (std_to_wx ("id")));
127 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
130 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
131 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
132 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
137 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
138 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
139 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
140 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
141 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
142 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
143 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
144 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
146 /* Use a panel as the only child of the Frame so that we avoid
147 the dark-grey background on Windows.
149 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
151 _viewer = new FilmViewer (overall_panel, false, false);
152 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
153 _info = new PlayerInformation (overall_panel, _viewer);
154 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
155 main_sizer->Add (_viewer, 1, wxEXPAND | wxALL, 6);
156 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
157 overall_panel->SetSizer (main_sizer);
160 int accelerators = 4;
162 int accelerators = 3;
165 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
166 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
167 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
168 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
170 accel[3].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
172 wxAcceleratorTable accel_table (accelerators, accel);
173 SetAcceleratorTable (accel_table);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
180 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
183 void set_decode_reduction (optional<int> reduction)
185 _viewer->set_dcp_decode_reduction (reduction);
186 _info->triggered_update ();
187 Config::instance()->set_decode_reduction (reduction);
190 void load_dcp (boost::filesystem::path dir)
192 _film.reset (new Film (optional<boost::filesystem::path>()));
193 shared_ptr<DCPContent> dcp;
195 dcp.reset (new DCPContent (_film, dir));
196 } catch (boost::filesystem::filesystem_error& e) {
197 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
201 _film->examine_and_add_content (dcp, true);
202 bool const ok = progress (_("Loading DCP"));
203 if (!ok || !report_errors_from_last_job()) {
207 setup_from_dcp (dcp);
209 if (dcp->three_d()) {
210 _film->set_three_d (true);
213 _viewer->set_film (_film);
214 _viewer->set_position (DCPTime ());
215 _info->triggered_update ();
217 Config::instance()->add_to_player_history (dir);
219 set_menu_sensitivity ();
221 wxMenuItemList old = _cpl_menu->GetMenuItems();
222 for (wxMenuItemList::iterator i = old.begin(); i != old.end(); ++i) {
223 _cpl_menu->Remove (*i);
226 DCPExaminer ex (dcp);
227 int id = ID_view_cpl;
228 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
229 wxMenuItem* j = _cpl_menu->AppendRadioItem(id, i->id());
230 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
239 void setup_menu (wxMenuBar* m)
241 _file_menu = new wxMenu;
242 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
243 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
244 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
246 _history_position = _file_menu->GetMenuItems().GetCount();
248 _file_menu->AppendSeparator ();
249 _file_menu->Append (ID_file_close, _("&Close"));
250 _file_menu->AppendSeparator ();
253 _file_menu->Append (wxID_EXIT, _("&Exit"));
255 _file_menu->Append (wxID_EXIT, _("&Quit"));
259 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
261 wxMenu* edit = new wxMenu;
262 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
265 _cpl_menu = new wxMenu;
267 wxMenu* view = new wxMenu;
268 optional<int> c = Config::instance()->decode_reduction();
269 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
270 view->AppendSeparator();
271 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
272 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
273 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
274 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
276 wxMenu* tools = new wxMenu;
277 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
278 tools->AppendSeparator ();
279 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
281 wxMenu* help = new wxMenu;
283 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
285 help->Append (wxID_ABOUT, _("About"));
287 help->Append (ID_help_report_a_problem, _("Report a problem..."));
289 m->Append (_file_menu, _("&File"));
291 m->Append (edit, _("&Edit"));
293 m->Append (view, _("&View"));
294 m->Append (tools, _("&Tools"));
295 m->Append (help, _("&Help"));
300 wxString d = wxStandardPaths::Get().GetDocumentsDir();
301 if (Config::instance()->last_player_load_directory()) {
302 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
305 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
310 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
311 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
318 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
320 Config::instance()->set_last_player_load_directory (dcp.parent_path());
328 wxDirDialog* c = new wxDirDialog (
330 _("Select DCP to open as OV"),
331 wxStandardPaths::Get().GetDocumentsDir(),
332 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
338 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
339 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
346 DCPOMATIC_ASSERT (_film);
347 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
348 DCPOMATIC_ASSERT (dcp);
349 dcp->add_ov (wx_to_std(c->GetPath()));
350 JobManager::instance()->add(shared_ptr<Job>(new ExamineContentJob (_film, dcp)));
351 bool const ok = progress (_("Loading DCP"));
352 if (!ok || !report_errors_from_last_job()) {
355 setup_from_dcp (dcp);
359 _info->triggered_update ();
364 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
366 if (d->ShowModal() == wxID_OK) {
367 DCPOMATIC_ASSERT (_film);
368 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
369 DCPOMATIC_ASSERT (dcp);
371 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
372 dcp->examine (shared_ptr<Job>());
373 } catch (exception& e) {
374 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
381 _info->triggered_update ();
384 void file_history (wxCommandEvent& event)
386 vector<boost::filesystem::path> history = Config::instance()->player_history ();
387 int n = event.GetId() - ID_file_history;
388 if (n >= 0 && n < static_cast<int> (history.size ())) {
389 load_dcp (history[n]);
395 _viewer->set_film (shared_ptr<Film>());
397 _info->triggered_update ();
398 set_menu_sensitivity ();
406 void edit_preferences ()
408 if (!_config_dialog) {
409 _config_dialog = create_player_config_dialog ();
411 _config_dialog->Show (this);
414 void view_cpl (wxCommandEvent& ev)
416 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
417 DCPOMATIC_ASSERT (dcp);
418 DCPExaminer ex (dcp);
419 int id = ev.GetId() - ID_view_cpl;
420 DCPOMATIC_ASSERT (id >= 0);
421 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
422 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
423 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
429 dcp->set_cpl ((*i)->id());
430 dcp->examine (shared_ptr<Job>());
435 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
436 DCPOMATIC_ASSERT (dcp);
438 JobManager* jm = JobManager::instance ();
439 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
440 bool const ok = progress (_("Verifying DCP"));
445 DCPOMATIC_ASSERT (!jm->get().empty());
446 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
447 DCPOMATIC_ASSERT (last);
449 VerifyDCPDialog* d = new VerifyDCPDialog (this, last);
454 void tools_check_for_updates ()
456 UpdateChecker::instance()->run ();
457 _update_news_requested = true;
462 AboutDialog* d = new AboutDialog (this);
467 void help_report_a_problem ()
469 ReportProblemDialog* d = new ReportProblemDialog (this);
470 if (d->ShowModal () == wxID_OK) {
476 void update_checker_state_changed ()
478 UpdateChecker* uc = UpdateChecker::instance ();
480 bool const announce =
481 _update_news_requested ||
482 (uc->stable() && Config::instance()->check_for_updates()) ||
483 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
485 _update_news_requested = false;
491 if (uc->state() == UpdateChecker::YES) {
492 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
493 dialog->ShowModal ();
495 } else if (uc->state() == UpdateChecker::FAILED) {
496 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
498 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
501 _update_news_requested = false;
504 void config_changed ()
506 /* Instantly save any config changes when using the player GUI */
508 Config::instance()->write_config();
509 } catch (exception& e) {
513 _("Could not write to config file at %s. Your changes have not been saved."),
514 std_to_wx (Config::instance()->cinemas_file().string()).data()
519 for (int i = 0; i < _history_items; ++i) {
520 delete _file_menu->Remove (ID_file_history + i);
523 if (_history_separator) {
524 _file_menu->Remove (_history_separator);
526 delete _history_separator;
527 _history_separator = 0;
529 int pos = _history_position;
531 vector<boost::filesystem::path> history = Config::instance()->player_history ();
533 if (!history.empty ()) {
534 _history_separator = _file_menu->InsertSeparator (pos++);
537 for (size_t i = 0; i < history.size(); ++i) {
540 s = String::compose ("&%1 %2", i + 1, history[i].string());
542 s = history[i].string();
544 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
547 _history_items = history.size ();
550 void set_menu_sensitivity ()
552 _tools_verify->Enable (static_cast<bool>(_film));
553 _file_add_ov->Enable (static_cast<bool>(_film));
554 _file_add_kdm->Enable (static_cast<bool>(_film));
555 _view_cpl->Enable (static_cast<bool>(_film));
558 void start_stop_pressed ()
560 if (_viewer->playing()) {
569 _viewer->back_frame ();
572 void forward_frame ()
574 _viewer->forward_frame ();
579 /** @return false if the task was cancelled */
580 bool progress (wxString task)
582 JobManager* jm = JobManager::instance ();
584 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), task, 100, 0, wxPD_CAN_ABORT);
588 while (jm->work_to_do() || signal_manager->ui_idle()) {
590 if (!progress->Pulse()) {
591 /* user pressed cancel */
592 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
600 progress->Destroy ();
604 bool report_errors_from_last_job ()
606 JobManager* jm = JobManager::instance ();
608 DCPOMATIC_ASSERT (!jm->get().empty());
610 shared_ptr<Job> last = jm->get().back();
611 if (last->finished_in_error()) {
612 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
619 void setup_from_dcp (shared_ptr<DCPContent> dcp)
622 dcp->subtitle->set_use (true);
626 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
628 _film->set_container(r);
633 bool _update_news_requested;
634 PlayerInformation* _info;
635 wxPreferencesEditor* _config_dialog;
637 wxMenuItem* _view_cpl;
640 int _history_position;
641 wxMenuItem* _history_separator;
643 boost::shared_ptr<Film> _film;
644 boost::signals2::scoped_connection _config_changed_connection;
645 wxMenuItem* _file_add_ov;
646 wxMenuItem* _file_add_kdm;
647 wxMenuItem* _tools_verify;
650 static const wxCmdLineEntryDesc command_line_description[] = {
651 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
652 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
655 class PlayServer : public Server
658 explicit PlayServer (DOMFrame* frame)
659 : Server (PLAYER_PLAY_PORT)
663 void handle (shared_ptr<Socket> socket)
666 int const length = socket->read_uint32 ();
667 scoped_array<char> buffer (new char[length]);
668 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
669 string s (buffer.get());
670 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
671 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
682 * @brief The magic App class for wxWidgets.
684 class App : public wxApp
697 wxInitAllImageHandlers ();
699 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
700 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
702 wxSplashScreen* splash = maybe_show_splash ();
704 SetAppName (_("DCP-o-matic Player"));
706 if (!wxApp::OnInit()) {
710 #ifdef DCPOMATIC_LINUX
711 unsetenv ("UBUNTU_MENUPROXY");
715 ProcessSerialNumber serial;
716 GetCurrentProcess (&serial);
717 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
720 dcpomatic_setup_path_encoding ();
722 /* Enable i18n; this will create a Config object
723 to look for a force-configured language. This Config
724 object will be wrong, however, because dcpomatic_setup
725 hasn't yet been called and there aren't any filters etc.
728 dcpomatic_setup_i18n ();
730 /* Set things up, including filters etc.
731 which will now be internationalised correctly.
735 /* Force the configuration to be re-loaded correctly next
740 _frame = new DOMFrame ();
741 SetTopWindow (_frame);
748 signal_manager = new wxSignalManager (this);
750 PlayServer* server = new PlayServer (_frame);
751 new thread (boost::bind (&PlayServer::run, server));
753 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
755 _frame->load_dcp (_dcp_to_load);
756 } catch (exception& e) {
757 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
761 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
763 if (Config::instance()->check_for_updates ()) {
764 UpdateChecker::instance()->run ();
771 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
775 void OnInitCmdLine (wxCmdLineParser& parser)
777 parser.SetDesc (command_line_description);
778 parser.SetSwitchChars (wxT ("-"));
781 bool OnCmdLineParsed (wxCmdLineParser& parser)
783 if (parser.GetParamCount() > 0) {
784 _dcp_to_load = wx_to_std (parser.GetParam (0));
790 void report_exception ()
794 } catch (FileError& e) {
798 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
799 std_to_wx (e.what()),
800 std_to_wx (e.file().string().c_str ())
803 } catch (exception& e) {
807 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
808 std_to_wx (e.what ())
812 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
816 /* An unhandled exception has occurred inside the main event loop */
817 bool OnExceptionInMainLoop ()
820 /* This will terminate the program */
824 void OnUnhandledException ()
831 signal_manager->ui_idle ();
834 void config_failed_to_load ()
836 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
839 void config_warning (string m)
841 message_dialog (_frame, std_to_wx (m));