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/>.
22 #include "wx/wx_signal_manager.h"
23 #include "wx/wx_util.h"
24 #include "wx/about_dialog.h"
25 #include "wx/report_problem_dialog.h"
26 #include "wx/film_viewer.h"
27 #include "wx/player_information.h"
28 #include "wx/update_dialog.h"
29 #include "wx/player_config_dialog.h"
30 #include "wx/verify_dcp_dialog.h"
31 #include "wx/controls.h"
32 #include "lib/cross.h"
33 #include "lib/config.h"
35 #include "lib/update_checker.h"
36 #include "lib/compose.hpp"
37 #include "lib/dcp_content.h"
38 #include "lib/job_manager.h"
41 #include "lib/video_content.h"
42 #include "lib/text_content.h"
43 #include "lib/ratio.h"
44 #include "lib/verify_dcp_job.h"
45 #include "lib/dcp_examiner.h"
46 #include "lib/examine_content_job.h"
47 #include "lib/server.h"
48 #include "lib/dcpomatic_socket.h"
50 #include <wx/stdpaths.h>
51 #include <wx/splash.h>
52 #include <wx/cmdline.h>
53 #include <wx/preferences.h>
54 #include <wx/progdlg.h>
56 #include <ApplicationServices/ApplicationServices.h>
58 #include <boost/bind.hpp>
72 using boost::shared_ptr;
73 using boost::scoped_array;
74 using boost::optional;
75 using boost::dynamic_pointer_cast;
84 /* Allow spare IDs after _history for the recent files list */
87 /* Allow spare IDs for CPLs */
88 ID_view_closed_captions = 200,
89 ID_view_scale_appropriate,
92 ID_view_scale_quarter,
93 ID_help_report_a_problem,
95 ID_tools_check_for_updates,
96 /* IDs for shortcuts (with no associated menu item) */
102 class DOMFrame : public wxFrame
106 : wxFrame (0, -1, _("DCP-o-matic Player"))
107 , _update_news_requested (false)
112 , _history_position (0)
113 , _history_separator (0)
116 #if defined(DCPOMATIC_WINDOWS)
117 maybe_open_console ();
118 cout << "DCP-o-matic Player is starting." << "\n";
121 wxMenuBar* bar = new wxMenuBar;
123 set_menu_sensitivity ();
126 #ifdef DCPOMATIC_WINDOWS
127 SetIcon (wxIcon (std_to_wx ("id")));
130 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
137 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
138 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
139 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
140 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
141 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
142 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
143 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
144 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
145 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
146 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
147 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
148 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
150 /* Use a panel as the only child of the Frame so that we avoid
151 the dark-grey background on Windows.
153 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
155 _viewer.reset (new FilmViewer (overall_panel));
156 _controls = new Controls (overall_panel, _viewer);
157 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
158 _info = new PlayerInformation (overall_panel, _viewer);
159 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
160 main_sizer->Add (_viewer->panel(), 1, wxEXPAND | wxALL, 6);
161 main_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
162 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
163 overall_panel->SetSizer (main_sizer);
166 int accelerators = 4;
168 int accelerators = 3;
171 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
172 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
173 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
174 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
176 accel[3].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
178 wxAcceleratorTable accel_table (accelerators, accel);
179 SetAcceleratorTable (accel_table);
182 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
183 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
184 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
186 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
189 void set_decode_reduction (optional<int> reduction)
191 _viewer->set_dcp_decode_reduction (reduction);
192 _info->triggered_update ();
193 Config::instance()->set_decode_reduction (reduction);
196 void load_dcp (boost::filesystem::path dir)
198 _film.reset (new Film (optional<boost::filesystem::path>()));
199 shared_ptr<DCPContent> dcp;
201 dcp.reset (new DCPContent (_film, dir));
202 } catch (boost::filesystem::filesystem_error& e) {
203 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
207 _film->examine_and_add_content (dcp, true);
208 bool const ok = progress (_("Loading DCP"));
209 if (!ok || !report_errors_from_last_job()) {
213 setup_from_dcp (dcp);
215 if (dcp->three_d()) {
216 _film->set_three_d (true);
219 _viewer->set_film (_film);
220 _viewer->seek (DCPTime(), true);
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(
237 wxString::Format("%s (%s)", std_to_wx(i->annotation_text()).data(), std_to_wx(i->id()).data())
239 j->Check(!dcp->cpl() || i->id() == *dcp->cpl());
246 void setup_menu (wxMenuBar* m)
248 _file_menu = new wxMenu;
249 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
250 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
251 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
253 _history_position = _file_menu->GetMenuItems().GetCount();
255 _file_menu->AppendSeparator ();
256 _file_menu->Append (ID_file_close, _("&Close"));
257 _file_menu->AppendSeparator ();
260 _file_menu->Append (wxID_EXIT, _("&Exit"));
262 _file_menu->Append (wxID_EXIT, _("&Quit"));
266 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
268 wxMenu* edit = new wxMenu;
269 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
272 _cpl_menu = new wxMenu;
274 wxMenu* view = new wxMenu;
275 optional<int> c = Config::instance()->decode_reduction();
276 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
277 view->Append(ID_view_closed_captions, _("Closed captions..."));
278 view->AppendSeparator();
279 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
280 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
281 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
282 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
284 wxMenu* tools = new wxMenu;
285 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
286 tools->AppendSeparator ();
287 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
289 wxMenu* help = new wxMenu;
291 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
293 help->Append (wxID_ABOUT, _("About"));
295 help->Append (ID_help_report_a_problem, _("Report a problem..."));
297 m->Append (_file_menu, _("&File"));
299 m->Append (edit, _("&Edit"));
301 m->Append (view, _("&View"));
302 m->Append (tools, _("&Tools"));
303 m->Append (help, _("&Help"));
308 wxString d = wxStandardPaths::Get().GetDocumentsDir();
309 if (Config::instance()->last_player_load_directory()) {
310 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
313 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
318 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
319 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
326 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
328 Config::instance()->set_last_player_load_directory (dcp.parent_path());
336 wxDirDialog* c = new wxDirDialog (
338 _("Select DCP to open as OV"),
339 wxStandardPaths::Get().GetDocumentsDir(),
340 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
346 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
347 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
354 DCPOMATIC_ASSERT (_film);
355 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
356 DCPOMATIC_ASSERT (dcp);
357 dcp->add_ov (wx_to_std(c->GetPath()));
358 JobManager::instance()->add(shared_ptr<Job>(new ExamineContentJob (_film, dcp)));
359 bool const ok = progress (_("Loading DCP"));
360 if (!ok || !report_errors_from_last_job()) {
363 setup_from_dcp (dcp);
367 _info->triggered_update ();
372 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
374 if (d->ShowModal() == wxID_OK) {
375 DCPOMATIC_ASSERT (_film);
376 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
377 DCPOMATIC_ASSERT (dcp);
379 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
380 dcp->examine (shared_ptr<Job>());
381 } catch (exception& e) {
382 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
389 _info->triggered_update ();
392 void file_history (wxCommandEvent& event)
394 vector<boost::filesystem::path> history = Config::instance()->player_history ();
395 int n = event.GetId() - ID_file_history;
396 if (n >= 0 && n < static_cast<int> (history.size ())) {
397 load_dcp (history[n]);
403 _viewer->set_film (shared_ptr<Film>());
405 _info->triggered_update ();
406 set_menu_sensitivity ();
414 void edit_preferences ()
416 if (!_config_dialog) {
417 _config_dialog = create_player_config_dialog ();
419 _config_dialog->Show (this);
422 void view_cpl (wxCommandEvent& ev)
424 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
425 DCPOMATIC_ASSERT (dcp);
426 DCPExaminer ex (dcp);
427 int id = ev.GetId() - ID_view_cpl;
428 DCPOMATIC_ASSERT (id >= 0);
429 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
430 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
431 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
437 dcp->set_cpl ((*i)->id());
438 dcp->examine (shared_ptr<Job>());
441 void view_closed_captions ()
443 _viewer->show_closed_captions ();
448 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
449 DCPOMATIC_ASSERT (dcp);
451 JobManager* jm = JobManager::instance ();
452 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
453 bool const ok = progress (_("Verifying DCP"));
458 DCPOMATIC_ASSERT (!jm->get().empty());
459 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
460 DCPOMATIC_ASSERT (last);
462 VerifyDCPDialog* d = new VerifyDCPDialog (this, last);
467 void tools_check_for_updates ()
469 UpdateChecker::instance()->run ();
470 _update_news_requested = true;
475 AboutDialog* d = new AboutDialog (this);
480 void help_report_a_problem ()
482 ReportProblemDialog* d = new ReportProblemDialog (this);
483 if (d->ShowModal () == wxID_OK) {
489 void update_checker_state_changed ()
491 UpdateChecker* uc = UpdateChecker::instance ();
493 bool const announce =
494 _update_news_requested ||
495 (uc->stable() && Config::instance()->check_for_updates()) ||
496 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
498 _update_news_requested = false;
504 if (uc->state() == UpdateChecker::YES) {
505 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
506 dialog->ShowModal ();
508 } else if (uc->state() == UpdateChecker::FAILED) {
509 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
511 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
514 _update_news_requested = false;
517 void config_changed ()
519 /* Instantly save any config changes when using the player GUI */
521 Config::instance()->write_config();
522 } catch (exception& e) {
526 _("Could not write to config file at %s. Your changes have not been saved."),
527 std_to_wx (Config::instance()->cinemas_file().string()).data()
532 for (int i = 0; i < _history_items; ++i) {
533 delete _file_menu->Remove (ID_file_history + i);
536 if (_history_separator) {
537 _file_menu->Remove (_history_separator);
539 delete _history_separator;
540 _history_separator = 0;
542 int pos = _history_position;
544 vector<boost::filesystem::path> history = Config::instance()->player_history ();
546 if (!history.empty ()) {
547 _history_separator = _file_menu->InsertSeparator (pos++);
550 for (size_t i = 0; i < history.size(); ++i) {
553 s = String::compose ("&%1 %2", i + 1, history[i].string());
555 s = history[i].string();
557 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
560 _history_items = history.size ();
563 void set_menu_sensitivity ()
565 _tools_verify->Enable (static_cast<bool>(_film));
566 _file_add_ov->Enable (static_cast<bool>(_film));
567 _file_add_kdm->Enable (static_cast<bool>(_film));
568 _view_cpl->Enable (static_cast<bool>(_film));
571 void start_stop_pressed ()
573 if (_viewer->playing()) {
582 _viewer->seek_by (-_viewer->one_video_frame(), true);
585 void forward_frame ()
587 _viewer->seek_by (_viewer->one_video_frame(), true);
592 /** @return false if the task was cancelled */
593 bool progress (wxString task)
595 JobManager* jm = JobManager::instance ();
597 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), task, 100, 0, wxPD_CAN_ABORT);
601 while (jm->work_to_do() || signal_manager->ui_idle()) {
603 if (!progress->Pulse()) {
604 /* user pressed cancel */
605 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
613 progress->Destroy ();
617 bool report_errors_from_last_job ()
619 JobManager* jm = JobManager::instance ();
621 DCPOMATIC_ASSERT (!jm->get().empty());
623 shared_ptr<Job> last = jm->get().back();
624 if (last->finished_in_error()) {
625 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
632 void setup_from_dcp (shared_ptr<DCPContent> dcp)
634 BOOST_FOREACH (shared_ptr<TextContent> i, dcp->text) {
639 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
641 _film->set_container(r);
646 bool _update_news_requested;
647 PlayerInformation* _info;
648 wxPreferencesEditor* _config_dialog;
650 wxMenuItem* _view_cpl;
653 int _history_position;
654 wxMenuItem* _history_separator;
655 shared_ptr<FilmViewer> _viewer;
657 boost::shared_ptr<Film> _film;
658 boost::signals2::scoped_connection _config_changed_connection;
659 wxMenuItem* _file_add_ov;
660 wxMenuItem* _file_add_kdm;
661 wxMenuItem* _tools_verify;
664 static const wxCmdLineEntryDesc command_line_description[] = {
665 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
666 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
669 class PlayServer : public Server
672 explicit PlayServer (DOMFrame* frame)
673 : Server (PLAYER_PLAY_PORT)
677 void handle (shared_ptr<Socket> socket)
680 int const length = socket->read_uint32 ();
681 scoped_array<char> buffer (new char[length]);
682 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
683 string s (buffer.get());
684 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
685 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
696 * @brief The magic App class for wxWidgets.
698 class App : public wxApp
711 wxInitAllImageHandlers ();
713 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
714 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
716 wxSplashScreen* splash = maybe_show_splash ();
718 SetAppName (_("DCP-o-matic Player"));
720 if (!wxApp::OnInit()) {
724 #ifdef DCPOMATIC_LINUX
725 unsetenv ("UBUNTU_MENUPROXY");
729 ProcessSerialNumber serial;
730 GetCurrentProcess (&serial);
731 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
734 dcpomatic_setup_path_encoding ();
736 /* Enable i18n; this will create a Config object
737 to look for a force-configured language. This Config
738 object will be wrong, however, because dcpomatic_setup
739 hasn't yet been called and there aren't any filters etc.
742 dcpomatic_setup_i18n ();
744 /* Set things up, including filters etc.
745 which will now be internationalised correctly.
749 /* Force the configuration to be re-loaded correctly next
754 _frame = new DOMFrame ();
755 SetTopWindow (_frame);
762 signal_manager = new wxSignalManager (this);
764 PlayServer* server = new PlayServer (_frame);
765 new thread (boost::bind (&PlayServer::run, server));
767 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
769 _frame->load_dcp (_dcp_to_load);
770 } catch (exception& e) {
771 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
775 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
777 if (Config::instance()->check_for_updates ()) {
778 UpdateChecker::instance()->run ();
785 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
789 void OnInitCmdLine (wxCmdLineParser& parser)
791 parser.SetDesc (command_line_description);
792 parser.SetSwitchChars (wxT ("-"));
795 bool OnCmdLineParsed (wxCmdLineParser& parser)
797 if (parser.GetParamCount() > 0) {
798 _dcp_to_load = wx_to_std (parser.GetParam (0));
804 void report_exception ()
808 } catch (FileError& e) {
812 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
813 std_to_wx (e.what()),
814 std_to_wx (e.file().string().c_str ())
817 } catch (exception& e) {
821 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
822 std_to_wx (e.what ())
826 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
830 /* An unhandled exception has occurred inside the main event loop */
831 bool OnExceptionInMainLoop ()
834 /* This will terminate the program */
838 void OnUnhandledException ()
845 signal_manager->ui_idle ();
848 void config_failed_to_load ()
850 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
853 void config_warning (string m)
855 message_dialog (_frame, std_to_wx (m));