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;
80 /* Allow spare IDs after _history for the recent files list */
83 /* Allow spare IDs for CPLs */
84 ID_view_scale_appropriate = 200,
87 ID_view_scale_quarter,
88 ID_help_report_a_problem,
90 ID_tools_check_for_updates,
91 /* IDs for shortcuts (with no associated menu item) */
97 class DOMFrame : public wxFrame
101 : wxFrame (0, -1, _("DCP-o-matic Player"))
102 , _update_news_requested (false)
107 , _history_position (0)
108 , _history_separator (0)
112 #if defined(DCPOMATIC_WINDOWS)
113 maybe_open_console ();
114 cout << "DCP-o-matic Player is starting." << "\n";
117 wxMenuBar* bar = new wxMenuBar;
119 set_menu_sensitivity ();
122 #ifdef DCPOMATIC_WINDOWS
123 SetIcon (wxIcon (std_to_wx ("id")));
126 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
129 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
130 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
131 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
132 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
137 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
138 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
139 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
140 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
141 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
142 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
143 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
145 /* Use a panel as the only child of the Frame so that we avoid
146 the dark-grey background on Windows.
148 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
150 _viewer = new FilmViewer (overall_panel, false, false);
151 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
152 _info = new PlayerInformation (overall_panel, _viewer);
153 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
154 main_sizer->Add (_viewer, 1, wxEXPAND | wxALL, 6);
155 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
156 overall_panel->SetSizer (main_sizer);
159 int accelerators = 4;
161 int accelerators = 3;
164 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
165 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
166 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
167 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
169 accel[3].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
171 wxAcceleratorTable accel_table (accelerators, accel);
172 SetAcceleratorTable (accel_table);
175 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
176 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
177 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
179 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
182 void set_decode_reduction (optional<int> reduction)
184 _viewer->set_dcp_decode_reduction (reduction);
185 _info->triggered_update ();
186 Config::instance()->set_decode_reduction (reduction);
189 void load_dcp (boost::filesystem::path dir)
191 _film.reset (new Film (optional<boost::filesystem::path>()));
192 shared_ptr<DCPContent> dcp;
194 dcp.reset (new DCPContent (_film, dir));
195 } catch (boost::filesystem::filesystem_error& e) {
196 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
200 _film->examine_and_add_content (dcp, true);
201 bool const ok = progress (_("Loading DCP"));
202 if (!ok || !report_errors_from_last_job()) {
206 setup_from_dcp (dcp);
208 if (dcp->three_d()) {
209 _film->set_three_d (true);
212 _viewer->set_film (_film);
213 _viewer->set_position (DCPTime ());
214 _info->triggered_update ();
216 Config::instance()->add_to_player_history (dir);
218 set_menu_sensitivity ();
220 wxMenuItemList old = _cpl_menu->GetMenuItems();
221 for (wxMenuItemList::iterator i = old.begin(); i != old.end(); ++i) {
222 _cpl_menu->Remove (*i);
225 DCPExaminer ex (dcp);
226 int id = ID_view_cpl;
227 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
228 wxMenuItem* j = _cpl_menu->AppendRadioItem(id, i->id());
229 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
238 void setup_menu (wxMenuBar* m)
240 _file_menu = new wxMenu;
241 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
242 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
243 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
245 _history_position = _file_menu->GetMenuItems().GetCount();
247 _file_menu->AppendSeparator ();
248 _file_menu->Append (ID_file_close, _("&Close"));
249 _file_menu->AppendSeparator ();
252 _file_menu->Append (wxID_EXIT, _("&Exit"));
254 _file_menu->Append (wxID_EXIT, _("&Quit"));
258 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
260 wxMenu* edit = new wxMenu;
261 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
264 _cpl_menu = new wxMenu;
266 wxMenu* view = new wxMenu;
267 optional<int> c = Config::instance()->decode_reduction();
268 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
269 view->AppendSeparator();
270 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
271 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
272 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
273 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
275 wxMenu* tools = new wxMenu;
276 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
277 tools->AppendSeparator ();
278 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
280 wxMenu* help = new wxMenu;
282 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
284 help->Append (wxID_ABOUT, _("About"));
286 help->Append (ID_help_report_a_problem, _("Report a problem..."));
288 m->Append (_file_menu, _("&File"));
290 m->Append (edit, _("&Edit"));
292 m->Append (view, _("&View"));
293 m->Append (tools, _("&Tools"));
294 m->Append (help, _("&Help"));
299 wxString d = wxStandardPaths::Get().GetDocumentsDir();
300 if (Config::instance()->last_player_load_directory()) {
301 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
304 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
309 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
310 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
317 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
319 Config::instance()->set_last_player_load_directory (dcp.parent_path());
327 wxDirDialog* c = new wxDirDialog (
329 _("Select DCP to open as OV"),
330 wxStandardPaths::Get().GetDocumentsDir(),
331 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
337 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
338 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
345 DCPOMATIC_ASSERT (_film);
346 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
347 DCPOMATIC_ASSERT (dcp);
348 dcp->add_ov (wx_to_std(c->GetPath()));
349 JobManager::instance()->add(shared_ptr<Job>(new ExamineContentJob (_film, dcp)));
350 bool const ok = progress (_("Loading DCP"));
351 if (!ok || !report_errors_from_last_job()) {
354 setup_from_dcp (dcp);
358 _info->triggered_update ();
363 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
365 if (d->ShowModal() == wxID_OK) {
366 DCPOMATIC_ASSERT (_film);
367 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
368 DCPOMATIC_ASSERT (dcp);
370 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
371 dcp->examine (shared_ptr<Job>());
372 } catch (exception& e) {
373 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
380 _info->triggered_update ();
383 void file_history (wxCommandEvent& event)
385 vector<boost::filesystem::path> history = Config::instance()->player_history ();
386 int n = event.GetId() - ID_file_history;
387 if (n >= 0 && n < static_cast<int> (history.size ())) {
388 load_dcp (history[n]);
394 _viewer->set_film (shared_ptr<Film>());
396 _info->triggered_update ();
397 set_menu_sensitivity ();
405 void edit_preferences ()
407 if (!_config_dialog) {
408 _config_dialog = create_player_config_dialog ();
410 _config_dialog->Show (this);
413 void view_cpl (wxCommandEvent& ev)
415 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
416 DCPOMATIC_ASSERT (dcp);
417 DCPExaminer ex (dcp);
418 int id = ev.GetId() - ID_view_cpl;
419 DCPOMATIC_ASSERT (id >= 0);
420 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
421 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
422 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
428 dcp->set_cpl ((*i)->id());
429 dcp->examine (shared_ptr<Job>());
434 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
435 DCPOMATIC_ASSERT (dcp);
437 JobManager* jm = JobManager::instance ();
438 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
439 bool const ok = progress (_("Verifying DCP"));
444 DCPOMATIC_ASSERT (!jm->get().empty());
445 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
446 DCPOMATIC_ASSERT (last);
448 VerifyDCPDialog* d = new VerifyDCPDialog (this, last);
453 void tools_check_for_updates ()
455 UpdateChecker::instance()->run ();
456 _update_news_requested = true;
461 AboutDialog* d = new AboutDialog (this);
466 void help_report_a_problem ()
468 ReportProblemDialog* d = new ReportProblemDialog (this);
469 if (d->ShowModal () == wxID_OK) {
475 void update_checker_state_changed ()
477 UpdateChecker* uc = UpdateChecker::instance ();
479 bool const announce =
480 _update_news_requested ||
481 (uc->stable() && Config::instance()->check_for_updates()) ||
482 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
484 _update_news_requested = false;
490 if (uc->state() == UpdateChecker::YES) {
491 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
492 dialog->ShowModal ();
494 } else if (uc->state() == UpdateChecker::FAILED) {
495 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
497 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
500 _update_news_requested = false;
503 void config_changed ()
505 /* Instantly save any config changes when using the player GUI */
507 Config::instance()->write_config();
508 } catch (exception& e) {
512 _("Could not write to config file at %s. Your changes have not been saved."),
513 std_to_wx (Config::instance()->cinemas_file().string()).data()
518 for (int i = 0; i < _history_items; ++i) {
519 delete _file_menu->Remove (ID_file_history + i);
522 if (_history_separator) {
523 _file_menu->Remove (_history_separator);
525 delete _history_separator;
526 _history_separator = 0;
528 int pos = _history_position;
530 vector<boost::filesystem::path> history = Config::instance()->player_history ();
532 if (!history.empty ()) {
533 _history_separator = _file_menu->InsertSeparator (pos++);
536 for (size_t i = 0; i < history.size(); ++i) {
539 s = String::compose ("&%1 %2", i + 1, history[i].string());
541 s = history[i].string();
543 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
546 _history_items = history.size ();
549 void set_menu_sensitivity ()
551 _tools_verify->Enable (static_cast<bool>(_film));
552 _file_add_ov->Enable (static_cast<bool>(_film));
553 _file_add_kdm->Enable (static_cast<bool>(_film));
554 _view_cpl->Enable (static_cast<bool>(_film));
557 void start_stop_pressed ()
559 if (_viewer->playing()) {
568 _viewer->back_frame ();
571 void forward_frame ()
573 _viewer->forward_frame ();
578 /** @return false if the task was cancelled */
579 bool progress (wxString task)
581 JobManager* jm = JobManager::instance ();
583 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), task, 100, 0, wxPD_CAN_ABORT);
587 while (jm->work_to_do() || signal_manager->ui_idle()) {
589 if (!progress->Pulse()) {
590 /* user pressed cancel */
591 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
599 progress->Destroy ();
603 bool report_errors_from_last_job ()
605 JobManager* jm = JobManager::instance ();
607 DCPOMATIC_ASSERT (!jm->get().empty());
609 shared_ptr<Job> last = jm->get().back();
610 if (last->finished_in_error()) {
611 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
618 void setup_from_dcp (shared_ptr<DCPContent> dcp)
621 dcp->subtitle->set_use (true);
625 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
627 _film->set_container(r);
632 bool _update_news_requested;
633 PlayerInformation* _info;
634 wxPreferencesEditor* _config_dialog;
636 wxMenuItem* _view_cpl;
639 int _history_position;
640 wxMenuItem* _history_separator;
642 boost::shared_ptr<Film> _film;
643 boost::signals2::scoped_connection _config_changed_connection;
644 wxMenuItem* _file_add_ov;
645 wxMenuItem* _file_add_kdm;
646 wxMenuItem* _tools_verify;
649 static const wxCmdLineEntryDesc command_line_description[] = {
650 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
651 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
654 class PlayServer : public Server
657 explicit PlayServer (DOMFrame* frame)
658 : Server (PLAYER_PLAY_PORT)
662 void handle (shared_ptr<Socket> socket)
665 int const length = socket->read_uint32 ();
666 scoped_array<char> buffer (new char[length]);
667 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
668 string s (buffer.get());
669 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
670 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
681 * @brief The magic App class for wxWidgets.
683 class App : public wxApp
696 wxInitAllImageHandlers ();
698 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
699 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
701 wxSplashScreen* splash = maybe_show_splash ();
703 SetAppName (_("DCP-o-matic Player"));
705 if (!wxApp::OnInit()) {
709 #ifdef DCPOMATIC_LINUX
710 unsetenv ("UBUNTU_MENUPROXY");
714 ProcessSerialNumber serial;
715 GetCurrentProcess (&serial);
716 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
719 dcpomatic_setup_path_encoding ();
721 /* Enable i18n; this will create a Config object
722 to look for a force-configured language. This Config
723 object will be wrong, however, because dcpomatic_setup
724 hasn't yet been called and there aren't any filters etc.
727 dcpomatic_setup_i18n ();
729 /* Set things up, including filters etc.
730 which will now be internationalised correctly.
734 /* Force the configuration to be re-loaded correctly next
739 _frame = new DOMFrame ();
740 SetTopWindow (_frame);
747 signal_manager = new wxSignalManager (this);
749 PlayServer* server = new PlayServer (_frame);
750 new thread (boost::bind (&PlayServer::run, server));
752 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
754 _frame->load_dcp (_dcp_to_load);
755 } catch (exception& e) {
756 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
760 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
762 if (Config::instance()->check_for_updates ()) {
763 UpdateChecker::instance()->run ();
770 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
774 void OnInitCmdLine (wxCmdLineParser& parser)
776 parser.SetDesc (command_line_description);
777 parser.SetSwitchChars (wxT ("-"));
780 bool OnCmdLineParsed (wxCmdLineParser& parser)
782 if (parser.GetParamCount() > 0) {
783 _dcp_to_load = wx_to_std (parser.GetParam (0));
789 void report_exception ()
793 } catch (FileError& e) {
797 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
798 std_to_wx (e.what()),
799 std_to_wx (e.file().string().c_str ())
802 } catch (exception& e) {
806 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
807 std_to_wx (e.what ())
811 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
815 /* An unhandled exception has occurred inside the main event loop */
816 bool OnExceptionInMainLoop ()
819 /* This will terminate the program */
823 void OnUnhandledException ()
830 signal_manager->ui_idle ();
833 void config_failed_to_load ()
835 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
838 void config_warning (string m)
840 message_dialog (_frame, std_to_wx (m));