2 Copyright (C) 2012-2021 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 /** @file src/tools/dcpomatic.cc
23 * @brief The main DCP-o-matic GUI.
27 #include "wx/about_dialog.h"
28 #include "wx/content_panel.h"
29 #include "wx/dkdm_dialog.h"
30 #include "wx/export_subtitles_dialog.h"
31 #include "wx/export_video_file_dialog.h"
32 #include "wx/film_editor.h"
33 #include "wx/film_name_location_dialog.h"
34 #include "wx/film_viewer.h"
35 #include "wx/focus_manager.h"
36 #include "wx/full_config_dialog.h"
37 #include "wx/hints_dialog.h"
38 #include "wx/html_dialog.h"
39 #include "wx/file_dialog.h"
40 #include "wx/i18n_hook.h"
42 #include "wx/job_manager_view.h"
43 #include "wx/kdm_dialog.h"
44 #include "wx/nag_dialog.h"
45 #include "wx/paste_dialog.h"
46 #include "wx/recreate_chain_dialog.h"
47 #include "wx/report_problem_dialog.h"
48 #include "wx/save_template_dialog.h"
49 #include "wx/self_dkdm_dialog.h"
50 #include "wx/servers_list_dialog.h"
51 #include "wx/standard_controls.h"
52 #include "wx/system_information_dialog.h"
53 #include "wx/templates_dialog.h"
54 #include "wx/update_dialog.h"
55 #include "wx/video_waveform_dialog.h"
56 #include "wx/wx_signal_manager.h"
57 #include "wx/wx_util.h"
58 #include "lib/analytics.h"
59 #include "lib/audio_content.h"
60 #include "lib/check_content_job.h"
61 #include "lib/cinema.h"
62 #include "lib/compose.hpp"
63 #include "lib/config.h"
64 #include "lib/constants.h"
65 #include "lib/content.h"
66 #include "lib/content_factory.h"
67 #include "lib/cross.h"
68 #include "lib/cross.h"
69 #include "lib/dcp_content.h"
70 #include "lib/dcpomatic_log.h"
71 #include "lib/dcpomatic_socket.h"
72 #include "lib/dkdm_wrapper.h"
73 #include "lib/email.h"
74 #include "lib/encode_server_finder.h"
75 #include "lib/exceptions.h"
76 #include "lib/ffmpeg_encoder.h"
78 #include "lib/font_config.h"
79 #include "lib/hints.h"
80 #include "lib/job_manager.h"
81 #include "lib/kdm_with_metadata.h"
83 #include "lib/make_dcp.h"
84 #include "lib/release_notes.h"
85 #include "lib/screen.h"
86 #include "lib/send_kdm_email_job.h"
87 #include "lib/signal_manager.h"
88 #include "lib/subtitle_encoder.h"
89 #include "lib/text_content.h"
90 #include "lib/transcode_job.h"
91 #include "lib/update_checker.h"
92 #include "lib/version.h"
93 #include "lib/video_content.h"
94 #include <dcp/exceptions.h>
95 #include <dcp/filesystem.h>
96 #include <dcp/raw_convert.h>
97 #include <dcp/warnings.h>
98 LIBDCP_DISABLE_WARNINGS
99 #include <wx/cmdline.h>
100 #include <wx/generic/aboutdlgg.h>
101 #include <wx/preferences.h>
102 #include <wx/splash.h>
103 #include <wx/stdpaths.h>
104 #include <wx/wxhtml.h>
105 LIBDCP_ENABLE_WARNINGS
107 #include <X11/Xlib.h>
110 #include <shellapi.h>
112 #include <boost/algorithm/string.hpp>
113 #include <boost/filesystem.hpp>
116 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
125 using std::dynamic_pointer_cast;
126 using std::exception;
129 using std::make_pair;
130 using std::make_shared;
132 using std::shared_ptr;
136 using boost::optional;
137 using boost::is_any_of;
138 using boost::algorithm::find;
139 #if BOOST_VERSION >= 106100
140 using namespace boost::placeholders;
142 using dcp::raw_convert;
145 class FilmChangedClosingDialog
148 explicit FilmChangedClosingDialog (string name)
151 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
152 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
153 /// project (Film) has been changed since it was last saved.
155 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
158 _dialog.SetYesNoCancelLabels(
159 _("Save film and close"), _("Close without saving film"), _("Don't close")
165 return _dialog.ShowModal();
169 wxMessageDialog _dialog;
173 class FilmChangedDuplicatingDialog
176 explicit FilmChangedDuplicatingDialog (string name)
179 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
180 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
181 /// project (Film) has been changed since it was last saved.
183 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
186 _dialog.SetYesNoCancelLabels(
187 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
193 return _dialog.ShowModal();
197 wxMessageDialog _dialog;
202 #define NEEDS_FILM 0x1
203 #define NOT_DURING_DCP_CREATION 0x2
204 #define NEEDS_CPL 0x4
205 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
206 #define NEEDS_SELECTED_CONTENT 0x10
207 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
208 #define NEEDS_CLIPBOARD 0x40
209 #define NEEDS_ENCRYPTION 0x80
212 map<wxMenuItem*, int> menu_items;
215 ID_file_new = DCPOMATIC_MAIN_MENU,
218 ID_file_save_as_template,
220 ID_file_duplicate_and_open,
222 /* Allow spare IDs after _history for the recent files list */
223 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
228 ID_jobs_make_dcp_batch,
231 ID_jobs_make_self_dkdm,
232 ID_jobs_export_video_file,
233 ID_jobs_export_subtitles,
234 ID_jobs_send_dcp_to_tms,
236 ID_jobs_open_dcp_in_player,
237 ID_view_closed_captions,
238 ID_view_video_waveform,
240 ID_tools_encoding_servers,
241 ID_tools_manage_templates,
242 ID_tools_check_for_updates,
243 ID_tools_system_information,
244 ID_tools_restore_default_preferences,
245 ID_tools_export_preferences,
246 ID_tools_import_preferences,
247 ID_help_report_a_problem,
248 /* IDs for shortcuts (with no associated menu item) */
258 class LimitedFrameSplitter : public wxSplitterWindow
261 LimitedFrameSplitter(wxWindow* parent)
262 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
264 /* This value doesn't really mean much but we just want to stop double-click on the
265 divider from shrinking the left panel.
267 SetMinimumPaneSize(64);
269 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
272 bool OnSashPositionChange(int new_position) override
274 /* Try to stop the left bit of the splitter getting too small */
275 auto const ok = new_position > _left_panel_minimum_size;
277 Config::instance()->set_main_divider_sash_position(new_position);
283 void sized(wxSizeEvent& ev)
285 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
286 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
287 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
289 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
295 int const _left_panel_minimum_size = 200;
299 class DOMFrame : public wxFrame
302 explicit DOMFrame (wxString const& title)
303 : wxFrame (nullptr, -1, title)
304 /* Use a panel as the only child of the Frame so that we avoid
305 the dark-grey background on Windows.
307 , _splitter(new LimitedFrameSplitter(this))
308 , _right_panel(new wxPanel(_splitter, wxID_ANY))
309 , _film_viewer(_right_panel)
312 auto bar = new wxMenuBar;
316 #ifdef DCPOMATIC_WINDOWS
317 SetIcon (wxIcon (std_to_wx ("id")));
320 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
321 config_changed (Config::OTHER);
323 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
325 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
326 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
327 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
328 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
329 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
330 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
331 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
332 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_import_preferences, this), ID_tools_import_preferences);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
361 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
362 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
364 auto left_panel = new wxPanel(_splitter, wxID_ANY);
366 _film_editor = new FilmEditor(left_panel, _film_viewer);
368 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
369 left_sizer->Add(_film_editor, 1, wxEXPAND);
371 left_panel->SetSizerAndFit(left_sizer);
373 _controls = new StandardControls(_right_panel, _film_viewer, true);
374 _controls->set_film(_film_viewer.film());
375 auto job_manager_view = new JobManagerView(_right_panel, false);
377 auto right_sizer = new wxBoxSizer (wxVERTICAL);
378 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
379 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
380 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
382 _right_panel->SetSizer(right_sizer);
384 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
386 set_menu_sensitivity ();
388 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
391 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
393 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
395 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
396 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
400 void add_accelerators ()
403 int accelerators = 7;
405 int accelerators = 6;
407 std::vector<wxAcceleratorEntry> accel(accelerators);
408 /* [Shortcut] Ctrl+A:Add file(s) to the film */
409 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
410 /* [Shortcut] Delete:Remove selected content from film */
411 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
412 /* [Shortcut] Space:Start/stop playback */
413 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
414 /* [Shortcut] Ctrl+T:Open timeline window */
415 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
416 /* [Shortcut] Left arrow:Move back one frame */
417 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
418 /* [Shortcut] Right arrow:Move forward one frame */
419 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
421 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
423 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
424 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
425 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
426 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
427 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
428 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
429 wxAcceleratorTable accel_table (accelerators, accel.data());
430 SetAcceleratorTable (accel_table);
433 void remove_accelerators ()
435 SetAcceleratorTable (wxAcceleratorTable ());
438 void remove_clicked (wxCommandEvent& ev)
440 if (_film_editor->content_panel()->remove_clicked (true)) {
445 void new_film (boost::filesystem::path path, optional<string> template_name)
447 auto film = make_shared<Film>(path);
449 film->use_template (template_name.get());
451 film->set_name (path.filename().generic_string());
452 film->write_metadata ();
456 void load_film (boost::filesystem::path file)
459 auto film = make_shared<Film>(file);
460 auto const notes = film->read_metadata ();
462 if (film->state_version() == 4) {
465 _("This film was created with an old version of DVD-o-matic and may not load correctly "
466 "in this version. Please check the film's settings carefully.")
470 for (auto i: notes) {
471 error_dialog (0, std_to_wx(i));
476 JobManager::instance()->add(make_shared<CheckContentJob>(film));
478 catch (FileNotFoundError& e) {
479 auto const dir = e.file().parent_path();
480 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
482 this, _("Could not open this folder as a DCP-o-matic project."),
483 _("It looks like you are trying to open a DCP. File -> Open is for loading DCP-o-matic projects, not DCPs. To import a DCP, create a new project with File -> New and then click the \"Add DCP...\" button.")
486 auto const p = std_to_wx(file.string ());
487 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
490 } catch (std::exception& e) {
491 auto const p = std_to_wx (file.string());
492 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
495 void set_film (shared_ptr<Film> film)
498 _film_viewer.set_film(_film);
499 _film_editor->set_film(_film);
500 _controls->set_film (_film);
501 _video_waveform_dialog.reset();
502 set_menu_sensitivity ();
503 if (_film && _film->directory()) {
504 Config::instance()->add_to_history (_film->directory().get());
507 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
508 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
509 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
510 dcpomatic_log = _film->log ();
515 shared_ptr<Film> film () const {
521 void show (wxShowEvent& ev)
523 if (ev.IsShown() && !_first_shown_called) {
524 _film_editor->first_shown ();
525 _first_shown_called = true;
529 void film_message (string m)
531 message_dialog (this, std_to_wx(m));
534 void film_change (ChangeType type)
536 if (type == ChangeType::DONE) {
537 set_menu_sensitivity ();
543 FilmNameLocationDialog dialog(this, _("New Film"), true);
544 int const r = dialog.ShowModal();
546 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
551 new_film(dialog.path(), dialog.template_name());
552 } catch (boost::filesystem::filesystem_error& e) {
553 #ifdef DCPOMATIC_WINDOWS
554 string bad_chars = "<>:\"/|?*";
555 string const filename = dialog.path().filename().string();
556 string found_bad_chars;
557 for (size_t i = 0; i < bad_chars.length(); ++i) {
558 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
559 found_bad_chars += bad_chars[i];
562 wxString message = _("Could not create folder to store film.");
564 if (!found_bad_chars.empty()) {
565 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
567 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
569 error_dialog (this, message, std_to_wx(e.what()));
571 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
580 _("Select film to open"),
581 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
582 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
587 r = dialog.ShowModal();
588 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
589 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
595 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
596 load_film(wx_to_std(dialog.GetPath()));
603 _film->write_metadata ();
604 } catch (exception& e) {
605 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
609 void file_save_as_template ()
611 SaveTemplateDialog dialog(this);
612 if (dialog.ShowModal() == wxID_OK) {
614 Config::instance()->save_template(_film, dialog.name());
615 } catch (exception& e) {
616 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
621 void file_duplicate ()
623 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
625 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
626 auto film = make_shared<Film>(dialog.path());
627 film->copy_from (_film);
628 film->set_name(dialog.path().filename().generic_string());
630 film->write_metadata();
631 } catch (exception& e) {
632 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
637 void file_duplicate_and_open ()
639 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
641 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
642 auto film = make_shared<Film>(dialog.path());
643 film->copy_from (_film);
644 film->set_name(dialog.path().filename().generic_string());
646 film->write_metadata ();
648 } catch (exception& e) {
649 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
656 if (_film && _film->dirty ()) {
657 FilmChangedClosingDialog dialog(_film->name());
658 switch (dialog.run()) {
660 /* Don't save and carry on to close */
663 /* Save and carry on to close */
664 _film->write_metadata ();
672 set_film (shared_ptr<Film>());
675 void file_history (wxCommandEvent& event)
677 auto history = Config::instance()->history ();
678 int n = event.GetId() - ID_file_history;
679 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
680 load_film (history[n]);
686 /* false here allows the close handler to veto the close request */
692 auto const sel = _film_editor->content_panel()->selected();
693 if (sel.size() == 1) {
694 _clipboard = sel.front()->clone();
704 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
705 if (dialog.ShowModal() != wxID_OK) {
709 for (auto i: _film_editor->content_panel()->selected()) {
710 if (dialog.video() && i->video) {
711 DCPOMATIC_ASSERT (_clipboard->video);
712 i->video->take_settings_from (_clipboard->video);
714 if (dialog.audio() && i->audio) {
715 DCPOMATIC_ASSERT (_clipboard->audio);
716 i->audio->take_settings_from (_clipboard->audio);
720 auto j = i->text.begin ();
721 auto k = _clipboard->text.begin ();
722 while (j != i->text.end() && k != _clipboard->text.end()) {
723 (*j)->take_settings_from (*k);
731 void edit_select_all ()
733 _film_editor->content_panel()->select_all();
736 void edit_preferences ()
738 if (!_config_dialog) {
739 _config_dialog = create_full_config_dialog ();
741 _config_dialog->Show (this);
744 void tools_restore_default_preferences ()
746 wxMessageDialog dialog(
748 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
749 _("Restore default preferences"),
750 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
753 if (dialog.ShowModal() == wxID_YES) {
754 Config::restore_defaults ();
758 void tools_export_preferences ()
761 this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_SAVE | wxFD_OVERWRITE_PROMPT, "Preferences", string("dcpomatic_config.zip")
764 if (dialog.ShowModal() == wxID_OK) {
765 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
766 if (boost::filesystem::exists(path)) {
767 boost::system::error_code ec;
768 boost::filesystem::remove(path, ec);
770 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
775 save_all_config_as_zip(path);
779 void tools_import_preferences()
781 FileDialog dialog(this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_OPEN, "Preferences");
784 Config::instance()->load_from_zip(dialog.path());
788 void jobs_make_dcp ()
794 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
797 message = wxString::Format (_("The DCP for this film will take up about %.1f GB, and the disk that you are using only has %.1f GB available. Do you want to continue anyway?"), required, available);
799 message = wxString::Format (_("The DCP and intermediate files for this film will take up about %.1f GB, and the disk that you are using only has %.1f GB available. You would need half as much space if the filesystem supported hard links, but it does not. Do you want to continue anyway?"), required, available);
801 if (!confirm_dialog (this, message)) {
806 if (Config::instance()->show_hints_before_make_dcp()) {
807 HintsDialog hints(this, _film, false);
808 if (hints.ShowModal() == wxID_CANCEL) {
813 if (_film->encrypted ()) {
814 NagDialog::maybe_nag (
816 Config::NAG_ENCRYPTED_METADATA,
817 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
818 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
819 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
820 "if you want to make KDMs for this film.")
824 /* Remove any existing DCP if the user agrees */
825 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
826 if (dcp::filesystem::exists(dcp_dir)) {
827 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
830 dcp::filesystem::remove_all(dcp_dir);
834 /* It seems to make sense to auto-save metadata here, since the make DCP may last
835 a long time, and crashes/power failures are moderately likely.
837 _film->write_metadata ();
838 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
839 } catch (BadSettingError& e) {
840 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
841 } catch (std::exception& e) {
842 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
846 void jobs_make_kdms ()
852 _kdm_dialog.reset(this, _film);
853 _kdm_dialog->Show ();
856 void jobs_make_dkdms ()
862 _dkdm_dialog.reset(this, _film);
863 _dkdm_dialog->Show ();
866 /** @return false if we succeeded, true if not */
867 bool send_to_other_tool (int port, function<void()> start, string message)
869 /* i = 0; try to connect via socket
870 i = 1; try again, and then try to start the tool
871 i = 2 onwards; try again.
873 for (int i = 0; i < 8; ++i) {
875 boost::asio::io_service io_service;
876 boost::asio::ip::tcp::resolver resolver (io_service);
877 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
878 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
880 socket.connect (*endpoint_iterator);
881 DCPOMATIC_ASSERT (_film->directory ());
882 socket.write (message.length() + 1);
883 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
888 } catch (exception& e) {
896 dcpomatic_sleep_seconds (1);
902 void jobs_make_dcp_batch ()
908 if (Config::instance()->show_hints_before_make_dcp()) {
909 HintsDialog hints(this, _film, false);
910 if (hints.ShowModal() == wxID_CANCEL) {
915 _film->write_metadata ();
917 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
919 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
921 error_dialog (this, _("Could not find batch converter."));
926 void jobs_open_dcp_in_player ()
932 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
934 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
936 error_dialog (this, _("Could not find player."));
941 void jobs_make_self_dkdm ()
947 SelfDKDMDialog dialog(this, _film);
948 if (dialog.ShowModal() != wxID_OK) {
952 NagDialog::maybe_nag (
954 Config::NAG_DKDM_CONFIG,
956 _("You are making a DKDM which is encrypted by a private key held in"
957 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
958 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
959 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
964 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
966 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
969 auto signer = Config::instance()->signer_chain();
970 if (!signer->valid()) {
971 error_dialog(this, _("The certificate chain for signing is invalid"));
975 optional<dcp::EncryptedKDM> kdm;
977 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
978 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
979 if (dialog.internal()) {
980 auto dkdms = Config::instance()->dkdms();
981 dkdms->add(make_shared<DKDM>(kdm));
982 Config::instance()->changed ();
984 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
987 } catch (dcp::NotEncryptedError& e) {
988 error_dialog (this, _("CPL's content is not encrypted."));
989 } catch (exception& e) {
990 error_dialog (this, e.what ());
992 error_dialog (this, _("An unknown exception occurred."));
997 void jobs_export_video_file ()
999 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
1000 if (dialog.ShowModal() != wxID_OK) {
1004 if (dcp::filesystem::exists(dialog.path())) {
1005 bool ok = confirm_dialog(
1007 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1015 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1017 make_shared<FFmpegEncoder> (
1018 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1020 JobManager::instance()->add (job);
1024 void jobs_export_subtitles ()
1026 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1027 if (dialog.ShowModal() != wxID_OK) {
1030 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1032 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1034 JobManager::instance()->add(job);
1038 void jobs_send_dcp_to_tms ()
1040 _film->send_dcp_to_tms ();
1043 void jobs_show_dcp ()
1045 DCPOMATIC_ASSERT (_film->directory ());
1046 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1047 error_dialog (this, _("Could not show DCP."));
1051 void view_closed_captions ()
1053 _film_viewer.show_closed_captions ();
1056 void view_video_waveform ()
1058 if (!_video_waveform_dialog) {
1059 _video_waveform_dialog.reset(this, _film, _film_viewer);
1062 _video_waveform_dialog->Show ();
1065 void tools_system_information ()
1067 if (!_system_information_dialog) {
1068 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1071 _system_information_dialog->Show ();
1076 if (!_hints_dialog) {
1077 _hints_dialog = new HintsDialog (this, _film, true);
1080 _hints_dialog->Show ();
1083 void tools_encoding_servers ()
1085 if (!_servers_list_dialog) {
1086 _servers_list_dialog = new ServersListDialog (this);
1089 _servers_list_dialog->Show ();
1092 void tools_manage_templates ()
1094 if (!_templates_dialog) {
1095 _templates_dialog.reset(this);
1098 _templates_dialog->Show ();
1101 void tools_check_for_updates ()
1103 _update_news_requested = true;
1104 UpdateChecker::instance()->run();
1109 AboutDialog dialog(this);
1113 void help_report_a_problem ()
1115 ReportProblemDialog dialog(this, _film);
1116 if (dialog.ShowModal() == wxID_OK) {
1121 bool should_close ()
1123 if (!JobManager::instance()->work_to_do ()) {
1127 wxMessageDialog dialog(
1129 _("There are unfinished jobs; are you sure you want to quit?"),
1130 _("Unfinished jobs"),
1131 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1134 return dialog.ShowModal() == wxID_YES;
1137 void close (wxCloseEvent& ev)
1139 if (!should_close ()) {
1144 if (_film && _film->dirty ()) {
1145 FilmChangedClosingDialog dialog(_film->name());
1146 switch (dialog.run()) {
1148 /* Don't save and carry on to close */
1151 /* Save and carry on to close */
1152 _film->write_metadata ();
1155 /* Veto the event and stop */
1161 /* We don't want to hear about any more configuration changes, since they
1162 cause the File menu to be altered, which itself will be deleted around
1163 now (without, as far as I can see, any way for us to find out).
1165 _config_changed_connection.disconnect ();
1167 /* Also stop hearing about analytics-related stuff */
1168 _analytics_message_connection.disconnect ();
1175 void active_jobs_changed()
1177 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1178 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1179 * it by using an idle callback. This feels quite unpleasant.
1181 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1184 void set_menu_sensitivity ()
1186 auto jobs = JobManager::instance()->get ();
1187 auto i = jobs.begin();
1188 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1191 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1192 bool const have_cpl = _film && !_film->cpls().empty ();
1193 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1194 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1195 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1197 for (auto j: menu_items) {
1199 bool enabled = true;
1201 if ((j.second & NEEDS_FILM) && !_film) {
1205 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1209 if ((j.second & NEEDS_CPL) && !have_cpl) {
1213 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1217 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1221 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1225 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1229 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1233 j.first->Enable (enabled);
1237 /** @return true if the operation that called this method
1238 * should continue, false to abort it.
1241 bool maybe_save_film ()
1247 while (_film->dirty()) {
1248 T dialog(_film->name());
1249 switch (dialog.run()) {
1254 _film->write_metadata();
1256 } catch (exception& e) {
1257 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1258 /* Go round again for another try */
1270 bool maybe_save_then_delete_film ()
1272 bool const r = maybe_save_film<T> ();
1279 void add_item (wxMenu* menu, wxString text, int id, int sens)
1281 auto item = menu->Append (id, text);
1282 menu_items.insert (make_pair (item, sens));
1285 void setup_menu (wxMenuBar* m)
1287 _file_menu = new wxMenu;
1288 /* [Shortcut] Ctrl+N:New film */
1289 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1290 /* [Shortcut] Ctrl+O:Open existing film */
1291 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1292 _file_menu->AppendSeparator ();
1293 /* [Shortcut] Ctrl+S:Save current film */
1294 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1295 _file_menu->AppendSeparator ();
1296 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1297 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1298 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1300 _history_position = _file_menu->GetMenuItems().GetCount();
1302 _file_menu->AppendSeparator ();
1303 /* [Shortcut] Ctrl+W:Close current film */
1304 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1307 _file_menu->AppendSeparator ();
1311 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1313 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1316 auto edit = new wxMenu;
1317 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1318 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1319 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1320 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1321 edit->AppendSeparator ();
1322 /* [Shortcut] Shift+Ctrl+A:Select all content */
1323 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1326 add_item(_file_menu, _("&Preferences...\tCtrl-,"), wxID_PREFERENCES, ALWAYS);
1328 edit->AppendSeparator ();
1329 /* [Shortcut] Ctrl+P:Open preferences window */
1330 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1333 auto jobs_menu = new wxMenu;
1334 /* [Shortcut] Ctrl+M:Make DCP */
1335 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1336 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1337 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1338 jobs_menu->AppendSeparator ();
1339 /* [Shortcut] Ctrl+K:Make KDMs */
1340 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1341 /* [Shortcut] Ctrl+D:Make DKDMs */
1342 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1343 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1344 jobs_menu->AppendSeparator ();
1345 /* [Shortcut] Ctrl+E:Export video file */
1346 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1347 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1348 jobs_menu->AppendSeparator ();
1349 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1351 #if defined(DCPOMATIC_OSX)
1352 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1353 #elif defined(DCPOMATIC_WINDOWS)
1354 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1356 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1359 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1361 auto view = new wxMenu;
1362 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1363 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1365 auto tools = new wxMenu;
1366 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1367 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1368 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1369 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1370 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1371 tools->AppendSeparator ();
1372 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1373 tools->AppendSeparator ();
1374 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1375 add_item (tools, _("Import preferences..."), ID_tools_import_preferences, ALWAYS);
1377 wxMenu* help = new wxMenu;
1379 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1381 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1383 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1385 m->Append (_file_menu, _("&File"));
1386 m->Append (edit, _("&Edit"));
1387 m->Append (jobs_menu, _("&Jobs"));
1388 m->Append (view, _("&View"));
1389 m->Append (tools, _("&Tools"));
1390 m->Append (help, _("&Help"));
1393 void config_changed (Config::Property what)
1395 /* Instantly save any config changes when using the DCP-o-matic GUI */
1397 case Config::CINEMAS:
1399 Config::instance()->write_cinemas();
1400 } catch (exception& e) {
1404 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1405 std_to_wx (Config::instance()->cinemas_file().string()).data()
1410 case Config::DKDM_RECIPIENTS:
1412 Config::instance()->write_dkdm_recipients();
1413 } catch (exception& e) {
1417 _("Could not write to DKDM recipients file at %s. Your changes have not been saved."),
1418 std_to_wx(Config::instance()->dkdm_recipients_file().string()).data()
1425 Config::instance()->write_config();
1426 } catch (exception& e) {
1430 _("Could not write to config file at %s. Your changes have not been saved."),
1431 std_to_wx (Config::instance()->cinemas_file().string()).data()
1437 for (int i = 0; i < _history_items; ++i) {
1438 delete _file_menu->Remove (ID_file_history + i);
1441 if (_history_separator) {
1442 _file_menu->Remove (_history_separator);
1444 delete _history_separator;
1445 _history_separator = 0;
1447 int pos = _history_position;
1449 /* Clear out non-existent history items before we re-build the menu */
1450 Config::instance()->clean_history ();
1451 auto history = Config::instance()->history();
1453 if (!history.empty ()) {
1454 _history_separator = _file_menu->InsertSeparator (pos++);
1457 for (size_t i = 0; i < history.size(); ++i) {
1460 s = String::compose ("&%1 %2", i + 1, history[i].string());
1462 s = history[i].string();
1464 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1467 _history_items = history.size ();
1469 dcpomatic_log->set_types (Config::instance()->log_types());
1472 void update_checker_state_changed ()
1474 auto uc = UpdateChecker::instance ();
1476 bool const announce =
1477 _update_news_requested ||
1478 (uc->stable() && Config::instance()->check_for_updates()) ||
1479 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1481 _update_news_requested = false;
1487 if (uc->state() == UpdateChecker::State::YES) {
1488 UpdateDialog dialog(this, uc->stable(), uc->test());
1490 } else if (uc->state() == UpdateChecker::State::FAILED) {
1491 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1493 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1496 _update_news_requested = false;
1499 void start_stop_pressed ()
1501 if (_film_viewer.playing()) {
1502 _film_viewer.stop();
1504 _film_viewer.start();
1508 void timeline_pressed ()
1510 _film_editor->content_panel()->timeline_clicked ();
1515 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1518 void forward_frame ()
1520 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1523 void analytics_message (string title, string html)
1525 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1531 auto s = wx_to_std(_("DCP-o-matic"));
1533 if (_film->directory()) {
1534 s += " - " + _film->directory()->string();
1536 if (_film->dirty()) {
1541 SetTitle (std_to_wx(s));
1544 FilmEditor* _film_editor;
1545 LimitedFrameSplitter* _splitter;
1546 wxPanel* _right_panel;
1547 FilmViewer _film_viewer;
1548 StandardControls* _controls;
1549 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1550 SystemInformationDialog* _system_information_dialog = nullptr;
1551 HintsDialog* _hints_dialog = nullptr;
1552 ServersListDialog* _servers_list_dialog = nullptr;
1553 wxPreferencesEditor* _config_dialog = nullptr;
1554 wx_ptr<KDMDialog> _kdm_dialog;
1555 wx_ptr<DKDMDialog> _dkdm_dialog;
1556 wx_ptr<TemplatesDialog> _templates_dialog;
1557 wxMenu* _file_menu = nullptr;
1558 shared_ptr<Film> _film;
1559 int _history_items = 0;
1560 int _history_position = 0;
1561 wxMenuItem* _history_separator = nullptr;
1562 boost::signals2::scoped_connection _config_changed_connection;
1563 boost::signals2::scoped_connection _analytics_message_connection;
1564 bool _update_news_requested = false;
1565 shared_ptr<Content> _clipboard;
1566 bool _first_shown_called = false;
1570 static const wxCmdLineEntryDesc command_line_description[] = {
1571 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1572 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1573 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1574 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1575 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1576 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1577 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1582 * @brief The magic App class for wxWidgets.
1584 class App : public wxApp
1590 dcpomatic_setup_path_encoding ();
1591 #ifdef DCPOMATIC_LINUX
1598 bool OnInit () override
1602 #if defined(DCPOMATIC_WINDOWS)
1603 if (Config::instance()->win32_console()) {
1606 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1607 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1608 FILE* hf_out = _fdopen(hCrt, "w");
1609 setvbuf(hf_out, NULL, _IONBF, 1);
1612 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1613 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1614 FILE* hf_in = _fdopen(hCrt, "r");
1615 setvbuf(hf_in, NULL, _IONBF, 128);
1618 cout << "DCP-o-matic is starting." << "\n";
1621 wxInitAllImageHandlers ();
1623 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1624 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1626 _splash = maybe_show_splash ();
1628 SetAppName (_("DCP-o-matic"));
1630 if (!wxApp::OnInit()) {
1634 #ifdef DCPOMATIC_LINUX
1635 unsetenv ("UBUNTU_MENUPROXY");
1638 #ifdef DCPOMATIC_OSX
1639 dcpomatic_sleep_seconds (1);
1640 make_foreground_application ();
1643 /* Enable i18n; this will create a Config object
1644 to look for a force-configured language. This Config
1645 object will be wrong, however, because dcpomatic_setup
1646 hasn't yet been called and there aren't any filters etc.
1649 dcpomatic_setup_i18n ();
1651 /* Set things up, including filters etc.
1652 which will now be internationalised correctly.
1656 /* Force the configuration to be re-loaded correctly next
1661 /* We only look out for bad configuration from here on, as before
1662 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1663 incorrect certificate chain validity errors.
1665 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1667 _frame = new DOMFrame (_("DCP-o-matic"));
1668 SetTopWindow (_frame);
1669 _frame->Maximize ();
1672 if (running_32_on_64 ()) {
1673 NagDialog::maybe_nag (
1674 _frame, Config::NAG_32_ON_64,
1675 _("You are running the 32-bit version of DCP-o-matic on a 64-bit version of Windows. This will limit the memory available to DCP-o-matic and may cause errors. You are strongly advised to install the 64-bit version of DCP-o-matic."),
1681 signal_manager = new wxSignalManager (this);
1682 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1684 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1686 _frame->load_film (_film_to_load);
1687 } catch (exception& e) {
1688 error_dialog (nullptr, std_to_wx(String::compose(wx_to_std(_("Could not load film %1 (%2)")), _film_to_load)), std_to_wx(e.what()));
1692 if (!_film_to_create.empty ()) {
1693 _frame->new_film (_film_to_create, optional<string>());
1694 if (!_content_to_add.empty()) {
1695 for (auto i: content_factory(_content_to_add)) {
1696 _frame->film()->examine_and_add_content(i);
1699 if (!_dcp_to_add.empty ()) {
1700 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1704 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1705 _timer.reset (new wxTimer (this));
1706 _timer->Start (1000);
1708 if (Config::instance()->check_for_updates ()) {
1709 UpdateChecker::instance()->run ();
1712 auto release_notes = find_release_notes(gui_is_dark());
1713 if (release_notes) {
1714 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1719 catch (exception& e)
1722 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1728 void OnInitCmdLine (wxCmdLineParser& parser) override
1730 parser.SetDesc (command_line_description);
1731 parser.SetSwitchChars (wxT ("-"));
1734 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1736 if (parser.Found (wxT("version"))) {
1737 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1738 exit (EXIT_SUCCESS);
1741 if (parser.GetParamCount() > 0) {
1742 if (parser.Found (wxT ("new"))) {
1743 _film_to_create = wx_to_std (parser.GetParam (0));
1745 _film_to_load = wx_to_std (parser.GetParam (0));
1750 if (parser.Found (wxT ("content"), &content)) {
1751 _content_to_add = wx_to_std (content);
1755 if (parser.Found (wxT ("dcp"), &dcp)) {
1756 _dcp_to_add = wx_to_std (dcp);
1760 if (parser.Found (wxT("config"), &config)) {
1761 State::override_path = wx_to_std (config);
1767 void report_exception ()
1771 } catch (FileError& e) {
1775 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1776 std_to_wx (e.what()),
1777 std_to_wx (e.file().string().c_str())
1780 } catch (boost::filesystem::filesystem_error& e) {
1784 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1785 std_to_wx (e.what()),
1786 std_to_wx (e.path1().string()),
1787 std_to_wx (e.path2().string())
1790 } catch (exception& e) {
1794 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1795 std_to_wx (e.what ())
1799 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1803 /* An unhandled exception has occurred inside the main event loop */
1804 bool OnExceptionInMainLoop () override
1806 report_exception ();
1807 /* This will terminate the program */
1811 void OnUnhandledException () override
1813 report_exception ();
1816 void idle (wxIdleEvent& ev)
1818 signal_manager->ui_idle ();
1825 EncodeServerFinder::instance()->rethrow ();
1826 } catch (exception& e) {
1827 error_dialog (0, std_to_wx (e.what ()));
1831 void close_splash ()
1839 void config_failed_to_load (Config::LoadFailure what)
1841 report_config_load_failure(_frame, what);
1844 void config_warning (string m)
1846 message_dialog (_frame, std_to_wx(m));
1849 bool config_bad (Config::BadReason reason)
1851 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1852 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1856 auto config = Config::instance();
1858 case Config::BAD_SIGNER_UTF8_STRINGS:
1860 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1863 RecreateChainDialog dialog(
1864 _frame, _("Recreate signing certificates"),
1865 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1866 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1867 "the certificate chain for signing DCPs and KDMs?"),
1869 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1871 return dialog.ShowModal() == wxID_OK;
1873 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1875 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1878 RecreateChainDialog dialog(
1879 _frame, _("Recreate signing certificates"),
1880 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1881 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1882 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1884 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1886 return dialog.ShowModal() == wxID_OK;
1888 case Config::BAD_SIGNER_INCONSISTENT:
1890 RecreateChainDialog dialog(
1891 _frame, _("Recreate signing certificates"),
1892 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1893 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1894 "the certificate chain for signing DCPs and KDMs?"),
1895 _("Close DCP-o-matic")
1897 if (dialog.ShowModal() != wxID_OK) {
1898 exit (EXIT_FAILURE);
1902 case Config::BAD_DECRYPTION_INCONSISTENT:
1904 RecreateChainDialog dialog(
1905 _frame, _("Recreate KDM decryption chain"),
1906 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1907 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1908 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1909 "configuration before continuing."),
1910 _("Close DCP-o-matic")
1912 if (dialog.ShowModal() != wxID_OK) {
1913 exit (EXIT_FAILURE);
1917 case Config::BAD_SIGNER_DN_QUALIFIER:
1919 RecreateChainDialog dialog(
1920 _frame, _("Recreate signing certificates"),
1921 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1922 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
1923 "by a bug in DCP-o-matic which has now been fixed. Do you want to re-create the certificate chain\n"
1924 "for signing DCPs and KDMs?"),
1926 Config::NAG_BAD_SIGNER_DN_QUALIFIER
1928 return dialog.ShowModal() == wxID_OK;
1931 DCPOMATIC_ASSERT (false);
1935 DOMFrame* _frame = nullptr;
1936 wxSplashScreen* _splash = nullptr;
1937 shared_ptr<wxTimer> _timer;
1938 string _film_to_load;
1939 string _film_to_create;
1940 string _content_to_add;