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/caption_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_closed_captions = 200,
86 ID_view_scale_appropriate,
89 ID_view_scale_quarter,
90 ID_help_report_a_problem,
92 ID_tools_check_for_updates,
93 /* IDs for shortcuts (with no associated menu item) */
99 class DOMFrame : public wxFrame
103 : wxFrame (0, -1, _("DCP-o-matic Player"))
104 , _update_news_requested (false)
109 , _history_position (0)
110 , _history_separator (0)
114 #if defined(DCPOMATIC_WINDOWS)
115 maybe_open_console ();
116 cout << "DCP-o-matic Player is starting." << "\n";
119 wxMenuBar* bar = new wxMenuBar;
121 set_menu_sensitivity ();
124 #ifdef DCPOMATIC_WINDOWS
125 SetIcon (wxIcon (std_to_wx ("id")));
128 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this));
131 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
132 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_ov, this), ID_file_add_ov);
133 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_add_kdm, this), ID_file_add_kdm);
134 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
135 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
136 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
137 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
138 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
139 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_cpl, this, _1), ID_view_cpl, ID_view_cpl + MAX_CPLS);
140 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(0)), ID_view_scale_full);
141 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(1)), ID_view_scale_half);
142 Bind (wxEVT_MENU, boost::bind (&DOMFrame::set_decode_reduction, this, optional<int>(2)), ID_view_scale_quarter);
143 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
144 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
145 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_verify, this), ID_tools_verify);
146 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
148 /* Use a panel as the only child of the Frame so that we avoid
149 the dark-grey background on Windows.
151 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
153 _viewer = new FilmViewer (overall_panel, false, false);
154 _viewer->set_dcp_decode_reduction (Config::instance()->decode_reduction ());
155 _info = new PlayerInformation (overall_panel, _viewer);
156 wxSizer* main_sizer = new wxBoxSizer (wxVERTICAL);
157 main_sizer->Add (_viewer, 1, wxEXPAND | wxALL, 6);
158 main_sizer->Add (_info, 0, wxEXPAND | wxALL, 6);
159 overall_panel->SetSizer (main_sizer);
162 int accelerators = 4;
164 int accelerators = 3;
167 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
168 accel[0].Set(wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
169 accel[1].Set(wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
170 accel[2].Set(wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
172 accel[3].Set(wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
174 wxAcceleratorTable accel_table (accelerators, accel);
175 SetAcceleratorTable (accel_table);
178 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
179 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
180 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
182 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
185 void set_decode_reduction (optional<int> reduction)
187 _viewer->set_dcp_decode_reduction (reduction);
188 _info->triggered_update ();
189 Config::instance()->set_decode_reduction (reduction);
192 void load_dcp (boost::filesystem::path dir)
194 _film.reset (new Film (optional<boost::filesystem::path>()));
195 shared_ptr<DCPContent> dcp;
197 dcp.reset (new DCPContent (_film, dir));
198 } catch (boost::filesystem::filesystem_error& e) {
199 error_dialog (this, _("Could not load DCP"), std_to_wx (e.what()));
203 _film->examine_and_add_content (dcp, true);
204 bool const ok = progress (_("Loading DCP"));
205 if (!ok || !report_errors_from_last_job()) {
209 setup_from_dcp (dcp);
211 if (dcp->three_d()) {
212 _film->set_three_d (true);
215 _viewer->set_film (_film);
216 _viewer->set_position (DCPTime ());
217 _info->triggered_update ();
219 Config::instance()->add_to_player_history (dir);
221 set_menu_sensitivity ();
223 wxMenuItemList old = _cpl_menu->GetMenuItems();
224 for (wxMenuItemList::iterator i = old.begin(); i != old.end(); ++i) {
225 _cpl_menu->Remove (*i);
228 DCPExaminer ex (dcp);
229 int id = ID_view_cpl;
230 BOOST_FOREACH (shared_ptr<dcp::CPL> i, ex.cpls()) {
231 wxMenuItem* j = _cpl_menu->AppendRadioItem(id, i->id());
232 if (!dcp->cpl() || i->id() == *dcp->cpl()) {
241 void setup_menu (wxMenuBar* m)
243 _file_menu = new wxMenu;
244 _file_menu->Append (ID_file_open, _("&Open...\tCtrl-O"));
245 _file_add_ov = _file_menu->Append (ID_file_add_ov, _("&Add OV..."));
246 _file_add_kdm = _file_menu->Append (ID_file_add_kdm, _("&Add KDM..."));
248 _history_position = _file_menu->GetMenuItems().GetCount();
250 _file_menu->AppendSeparator ();
251 _file_menu->Append (ID_file_close, _("&Close"));
252 _file_menu->AppendSeparator ();
255 _file_menu->Append (wxID_EXIT, _("&Exit"));
257 _file_menu->Append (wxID_EXIT, _("&Quit"));
261 _file_menu->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
263 wxMenu* edit = new wxMenu;
264 edit->Append (wxID_PREFERENCES, _("&Preferences...\tCtrl-P"));
267 _cpl_menu = new wxMenu;
269 wxMenu* view = new wxMenu;
270 optional<int> c = Config::instance()->decode_reduction();
271 _view_cpl = view->Append(ID_view_cpl, _("CPL"), _cpl_menu);
272 view->Append(ID_view_closed_captions, _("Closed captions..."));
273 view->AppendSeparator();
274 view->AppendRadioItem(ID_view_scale_appropriate, _("Set decode resolution to match display"))->Check(!static_cast<bool>(c));
275 view->AppendRadioItem(ID_view_scale_full, _("Decode at full resolution"))->Check(c && c.get() == 0);
276 view->AppendRadioItem(ID_view_scale_half, _("Decode at half resolution"))->Check(c && c.get() == 1);
277 view->AppendRadioItem(ID_view_scale_quarter, _("Decode at quarter resolution"))->Check(c && c.get() == 2);
279 wxMenu* tools = new wxMenu;
280 _tools_verify = tools->Append (ID_tools_verify, _("Verify DCP"));
281 tools->AppendSeparator ();
282 tools->Append (ID_tools_check_for_updates, _("Check for updates"));
284 wxMenu* help = new wxMenu;
286 help->Append (wxID_ABOUT, _("About DCP-o-matic"));
288 help->Append (wxID_ABOUT, _("About"));
290 help->Append (ID_help_report_a_problem, _("Report a problem..."));
292 m->Append (_file_menu, _("&File"));
294 m->Append (edit, _("&Edit"));
296 m->Append (view, _("&View"));
297 m->Append (tools, _("&Tools"));
298 m->Append (help, _("&Help"));
303 wxString d = wxStandardPaths::Get().GetDocumentsDir();
304 if (Config::instance()->last_player_load_directory()) {
305 d = std_to_wx (Config::instance()->last_player_load_directory()->string());
308 wxDirDialog* c = new wxDirDialog (this, _("Select DCP to open"), d, wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST);
313 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
314 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
321 boost::filesystem::path const dcp (wx_to_std (c->GetPath ()));
323 Config::instance()->set_last_player_load_directory (dcp.parent_path());
331 wxDirDialog* c = new wxDirDialog (
333 _("Select DCP to open as OV"),
334 wxStandardPaths::Get().GetDocumentsDir(),
335 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
341 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
342 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
349 DCPOMATIC_ASSERT (_film);
350 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
351 DCPOMATIC_ASSERT (dcp);
352 dcp->add_ov (wx_to_std(c->GetPath()));
353 JobManager::instance()->add(shared_ptr<Job>(new ExamineContentJob (_film, dcp)));
354 bool const ok = progress (_("Loading DCP"));
355 if (!ok || !report_errors_from_last_job()) {
358 setup_from_dcp (dcp);
362 _info->triggered_update ();
367 wxFileDialog* d = new wxFileDialog (this, _("Select KDM"));
369 if (d->ShowModal() == wxID_OK) {
370 DCPOMATIC_ASSERT (_film);
371 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
372 DCPOMATIC_ASSERT (dcp);
374 dcp->add_kdm (dcp::EncryptedKDM (dcp::file_to_string (wx_to_std (d->GetPath ()), MAX_KDM_SIZE)));
375 dcp->examine (shared_ptr<Job>());
376 } catch (exception& e) {
377 error_dialog (this, wxString::Format (_("Could not load KDM.")), std_to_wx(e.what()));
384 _info->triggered_update ();
387 void file_history (wxCommandEvent& event)
389 vector<boost::filesystem::path> history = Config::instance()->player_history ();
390 int n = event.GetId() - ID_file_history;
391 if (n >= 0 && n < static_cast<int> (history.size ())) {
392 load_dcp (history[n]);
398 _viewer->set_film (shared_ptr<Film>());
400 _info->triggered_update ();
401 set_menu_sensitivity ();
409 void edit_preferences ()
411 if (!_config_dialog) {
412 _config_dialog = create_player_config_dialog ();
414 _config_dialog->Show (this);
417 void view_cpl (wxCommandEvent& ev)
419 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
420 DCPOMATIC_ASSERT (dcp);
421 DCPExaminer ex (dcp);
422 int id = ev.GetId() - ID_view_cpl;
423 DCPOMATIC_ASSERT (id >= 0);
424 DCPOMATIC_ASSERT (id < int(ex.cpls().size()));
425 list<shared_ptr<dcp::CPL> > cpls = ex.cpls();
426 list<shared_ptr<dcp::CPL> >::iterator i = cpls.begin();
432 dcp->set_cpl ((*i)->id());
433 dcp->examine (shared_ptr<Job>());
436 void view_closed_captions ()
438 _viewer->show_closed_captions ();
443 shared_ptr<DCPContent> dcp = boost::dynamic_pointer_cast<DCPContent>(_film->content().front());
444 DCPOMATIC_ASSERT (dcp);
446 JobManager* jm = JobManager::instance ();
447 jm->add (shared_ptr<Job> (new VerifyDCPJob (dcp->directories())));
448 bool const ok = progress (_("Verifying DCP"));
453 DCPOMATIC_ASSERT (!jm->get().empty());
454 shared_ptr<VerifyDCPJob> last = dynamic_pointer_cast<VerifyDCPJob> (jm->get().back());
455 DCPOMATIC_ASSERT (last);
457 VerifyDCPDialog* d = new VerifyDCPDialog (this, last);
462 void tools_check_for_updates ()
464 UpdateChecker::instance()->run ();
465 _update_news_requested = true;
470 AboutDialog* d = new AboutDialog (this);
475 void help_report_a_problem ()
477 ReportProblemDialog* d = new ReportProblemDialog (this);
478 if (d->ShowModal () == wxID_OK) {
484 void update_checker_state_changed ()
486 UpdateChecker* uc = UpdateChecker::instance ();
488 bool const announce =
489 _update_news_requested ||
490 (uc->stable() && Config::instance()->check_for_updates()) ||
491 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
493 _update_news_requested = false;
499 if (uc->state() == UpdateChecker::YES) {
500 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
501 dialog->ShowModal ();
503 } else if (uc->state() == UpdateChecker::FAILED) {
504 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
506 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
509 _update_news_requested = false;
512 void config_changed ()
514 /* Instantly save any config changes when using the player GUI */
516 Config::instance()->write_config();
517 } catch (exception& e) {
521 _("Could not write to config file at %s. Your changes have not been saved."),
522 std_to_wx (Config::instance()->cinemas_file().string()).data()
527 for (int i = 0; i < _history_items; ++i) {
528 delete _file_menu->Remove (ID_file_history + i);
531 if (_history_separator) {
532 _file_menu->Remove (_history_separator);
534 delete _history_separator;
535 _history_separator = 0;
537 int pos = _history_position;
539 vector<boost::filesystem::path> history = Config::instance()->player_history ();
541 if (!history.empty ()) {
542 _history_separator = _file_menu->InsertSeparator (pos++);
545 for (size_t i = 0; i < history.size(); ++i) {
548 s = String::compose ("&%1 %2", i + 1, history[i].string());
550 s = history[i].string();
552 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
555 _history_items = history.size ();
558 void set_menu_sensitivity ()
560 _tools_verify->Enable (static_cast<bool>(_film));
561 _file_add_ov->Enable (static_cast<bool>(_film));
562 _file_add_kdm->Enable (static_cast<bool>(_film));
563 _view_cpl->Enable (static_cast<bool>(_film));
566 void start_stop_pressed ()
568 if (_viewer->playing()) {
577 _viewer->back_frame ();
580 void forward_frame ()
582 _viewer->forward_frame ();
587 /** @return false if the task was cancelled */
588 bool progress (wxString task)
590 JobManager* jm = JobManager::instance ();
592 wxProgressDialog* progress = new wxProgressDialog (_("DCP-o-matic Player"), task, 100, 0, wxPD_CAN_ABORT);
596 while (jm->work_to_do() || signal_manager->ui_idle()) {
598 if (!progress->Pulse()) {
599 /* user pressed cancel */
600 BOOST_FOREACH (shared_ptr<Job> i, jm->get()) {
608 progress->Destroy ();
612 bool report_errors_from_last_job ()
614 JobManager* jm = JobManager::instance ();
616 DCPOMATIC_ASSERT (!jm->get().empty());
618 shared_ptr<Job> last = jm->get().back();
619 if (last->finished_in_error()) {
620 error_dialog(this, std_to_wx(last->error_summary()) + ".\n", std_to_wx(last->error_details()));
627 void setup_from_dcp (shared_ptr<DCPContent> dcp)
629 BOOST_FOREACH (shared_ptr<CaptionContent> i, dcp->caption) {
634 Ratio const * r = Ratio::nearest_from_ratio(dcp->video->size().ratio());
636 _film->set_container(r);
641 bool _update_news_requested;
642 PlayerInformation* _info;
643 wxPreferencesEditor* _config_dialog;
645 wxMenuItem* _view_cpl;
648 int _history_position;
649 wxMenuItem* _history_separator;
651 boost::shared_ptr<Film> _film;
652 boost::signals2::scoped_connection _config_changed_connection;
653 wxMenuItem* _file_add_ov;
654 wxMenuItem* _file_add_kdm;
655 wxMenuItem* _tools_verify;
658 static const wxCmdLineEntryDesc command_line_description[] = {
659 { wxCMD_LINE_PARAM, 0, 0, "DCP to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
660 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
663 class PlayServer : public Server
666 explicit PlayServer (DOMFrame* frame)
667 : Server (PLAYER_PLAY_PORT)
671 void handle (shared_ptr<Socket> socket)
674 int const length = socket->read_uint32 ();
675 scoped_array<char> buffer (new char[length]);
676 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
677 string s (buffer.get());
678 signal_manager->when_idle (bind (&DOMFrame::load_dcp, _frame, s));
679 socket->write (reinterpret_cast<uint8_t const *> ("OK"), 3);
690 * @brief The magic App class for wxWidgets.
692 class App : public wxApp
705 wxInitAllImageHandlers ();
707 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
708 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
710 wxSplashScreen* splash = maybe_show_splash ();
712 SetAppName (_("DCP-o-matic Player"));
714 if (!wxApp::OnInit()) {
718 #ifdef DCPOMATIC_LINUX
719 unsetenv ("UBUNTU_MENUPROXY");
723 ProcessSerialNumber serial;
724 GetCurrentProcess (&serial);
725 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
728 dcpomatic_setup_path_encoding ();
730 /* Enable i18n; this will create a Config object
731 to look for a force-configured language. This Config
732 object will be wrong, however, because dcpomatic_setup
733 hasn't yet been called and there aren't any filters etc.
736 dcpomatic_setup_i18n ();
738 /* Set things up, including filters etc.
739 which will now be internationalised correctly.
743 /* Force the configuration to be re-loaded correctly next
748 _frame = new DOMFrame ();
749 SetTopWindow (_frame);
756 signal_manager = new wxSignalManager (this);
758 PlayServer* server = new PlayServer (_frame);
759 new thread (boost::bind (&PlayServer::run, server));
761 if (!_dcp_to_load.empty() && boost::filesystem::is_directory (_dcp_to_load)) {
763 _frame->load_dcp (_dcp_to_load);
764 } catch (exception& e) {
765 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load DCP %1.")), _dcp_to_load)), std_to_wx(e.what()));
769 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
771 if (Config::instance()->check_for_updates ()) {
772 UpdateChecker::instance()->run ();
779 error_dialog (0, _("DCP-o-matic Player could not start."), std_to_wx(e.what()));
783 void OnInitCmdLine (wxCmdLineParser& parser)
785 parser.SetDesc (command_line_description);
786 parser.SetSwitchChars (wxT ("-"));
789 bool OnCmdLineParsed (wxCmdLineParser& parser)
791 if (parser.GetParamCount() > 0) {
792 _dcp_to_load = wx_to_std (parser.GetParam (0));
798 void report_exception ()
802 } catch (FileError& e) {
806 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
807 std_to_wx (e.what()),
808 std_to_wx (e.file().string().c_str ())
811 } catch (exception& e) {
815 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
816 std_to_wx (e.what ())
820 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
824 /* An unhandled exception has occurred inside the main event loop */
825 bool OnExceptionInMainLoop ()
828 /* This will terminate the program */
832 void OnUnhandledException ()
839 signal_manager->ui_idle ();
842 void config_failed_to_load ()
844 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
847 void config_warning (string m)
849 message_dialog (_frame, std_to_wx (m));