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/dcp_referencing_dialog.h"
30 #include "wx/dkdm_dialog.h"
31 #include "wx/export_subtitles_dialog.h"
32 #include "wx/export_video_file_dialog.h"
33 #include "wx/film_editor.h"
34 #include "wx/film_name_location_dialog.h"
35 #include "wx/film_viewer.h"
36 #include "wx/focus_manager.h"
37 #include "wx/full_config_dialog.h"
38 #include "wx/hints_dialog.h"
39 #include "wx/html_dialog.h"
40 #include "wx/file_dialog.h"
41 #include "wx/i18n_hook.h"
43 #include "wx/job_manager_view.h"
44 #include "wx/kdm_dialog.h"
45 #include "wx/nag_dialog.h"
46 #include "wx/paste_dialog.h"
47 #include "wx/recreate_chain_dialog.h"
48 #include "wx/report_problem_dialog.h"
49 #include "wx/save_template_dialog.h"
50 #include "wx/self_dkdm_dialog.h"
51 #include "wx/send_i18n_dialog.h"
52 #include "wx/servers_list_dialog.h"
53 #include "wx/standard_controls.h"
54 #include "wx/system_information_dialog.h"
55 #include "wx/templates_dialog.h"
56 #include "wx/update_dialog.h"
57 #include "wx/video_waveform_dialog.h"
58 #include "wx/wx_signal_manager.h"
59 #include "wx/wx_util.h"
60 #include "lib/analytics.h"
61 #include "lib/audio_content.h"
62 #include "lib/check_content_job.h"
63 #include "lib/cinema.h"
64 #include "lib/compose.hpp"
65 #include "lib/config.h"
66 #include "lib/constants.h"
67 #include "lib/content.h"
68 #include "lib/content_factory.h"
69 #include "lib/cross.h"
70 #include "lib/cross.h"
71 #include "lib/dcp_content.h"
72 #include "lib/dcpomatic_log.h"
73 #include "lib/dcpomatic_socket.h"
74 #include "lib/dkdm_wrapper.h"
75 #include "lib/email.h"
76 #include "lib/encode_server_finder.h"
77 #include "lib/exceptions.h"
78 #include "lib/ffmpeg_encoder.h"
80 #include "lib/font_config.h"
82 #include "lib/grok/context.h"
84 #include "lib/hints.h"
85 #include "lib/job_manager.h"
86 #include "lib/kdm_with_metadata.h"
88 #include "lib/make_dcp.h"
89 #include "lib/release_notes.h"
90 #include "lib/screen.h"
91 #include "lib/send_kdm_email_job.h"
92 #include "lib/signal_manager.h"
93 #include "lib/subtitle_encoder.h"
94 #include "lib/text_content.h"
95 #include "lib/transcode_job.h"
96 #include "lib/update_checker.h"
97 #include "lib/version.h"
98 #include "lib/video_content.h"
99 #include <dcp/exceptions.h>
100 #include <dcp/filesystem.h>
101 #include <dcp/raw_convert.h>
102 #include <dcp/warnings.h>
103 LIBDCP_DISABLE_WARNINGS
104 #include <wx/cmdline.h>
105 #include <wx/generic/aboutdlgg.h>
106 #include <wx/preferences.h>
107 #include <wx/splash.h>
108 #include <wx/stdpaths.h>
109 #include <wx/wxhtml.h>
110 LIBDCP_ENABLE_WARNINGS
112 #include <X11/Xlib.h>
115 #include <shellapi.h>
117 #include <boost/algorithm/string.hpp>
118 #include <boost/filesystem.hpp>
121 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
130 using std::dynamic_pointer_cast;
131 using std::exception;
134 using std::make_pair;
135 using std::make_shared;
137 using std::shared_ptr;
141 using boost::optional;
142 using boost::is_any_of;
143 using boost::algorithm::find;
144 #if BOOST_VERSION >= 106100
145 using namespace boost::placeholders;
147 using dcp::raw_convert;
150 class FilmChangedClosingDialog
153 explicit FilmChangedClosingDialog (string name)
156 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
157 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
158 /// project (Film) has been changed since it was last saved.
160 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
163 _dialog.SetYesNoCancelLabels(
164 _("Save film and close"), _("Close without saving film"), _("Don't close")
170 return _dialog.ShowModal();
174 wxMessageDialog _dialog;
178 class FilmChangedDuplicatingDialog
181 explicit FilmChangedDuplicatingDialog (string name)
184 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
185 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
186 /// project (Film) has been changed since it was last saved.
188 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
191 _dialog.SetYesNoCancelLabels(
192 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
198 return _dialog.ShowModal();
202 wxMessageDialog _dialog;
207 #define NEEDS_FILM 0x1
208 #define NOT_DURING_DCP_CREATION 0x2
209 #define NEEDS_CPL 0x4
210 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
211 #define NEEDS_SELECTED_CONTENT 0x10
212 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
213 #define NEEDS_CLIPBOARD 0x40
214 #define NEEDS_ENCRYPTION 0x80
215 #define NEEDS_DCP_CONTENT 0x100
218 map<wxMenuItem*, int> menu_items;
221 ID_file_new = DCPOMATIC_MAIN_MENU,
224 ID_file_save_as_template,
226 ID_file_duplicate_and_open,
228 /* Allow spare IDs after _history for the recent files list */
229 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
234 ID_jobs_make_dcp_batch,
237 ID_jobs_make_self_dkdm,
238 ID_jobs_export_video_file,
239 ID_jobs_export_subtitles,
240 ID_jobs_send_dcp_to_tms,
242 ID_jobs_open_dcp_in_player,
243 ID_view_closed_captions,
244 ID_view_video_waveform,
245 ID_tools_version_file,
247 ID_tools_encoding_servers,
248 ID_tools_manage_templates,
249 ID_tools_check_for_updates,
250 ID_tools_send_translations,
251 ID_tools_system_information,
252 ID_tools_restore_default_preferences,
253 ID_tools_export_preferences,
254 ID_tools_import_preferences,
255 ID_help_report_a_problem,
256 /* IDs for shortcuts (with no associated menu item) */
266 class LimitedFrameSplitter : public wxSplitterWindow
269 LimitedFrameSplitter(wxWindow* parent)
270 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
272 /* This value doesn't really mean much but we just want to stop double-click on the
273 divider from shrinking the left panel.
275 SetMinimumPaneSize(64);
277 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
280 bool OnSashPositionChange(int new_position) override
282 /* Try to stop the left bit of the splitter getting too small */
283 auto const ok = new_position > _left_panel_minimum_size;
285 Config::instance()->set_main_divider_sash_position(new_position);
291 void sized(wxSizeEvent& ev)
293 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
294 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
295 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
297 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
303 int const _left_panel_minimum_size = 200;
307 class DOMFrame : public wxFrame
310 explicit DOMFrame (wxString const& title)
311 : wxFrame (nullptr, -1, title)
312 /* Use a panel as the only child of the Frame so that we avoid
313 the dark-grey background on Windows.
315 , _splitter(new LimitedFrameSplitter(this))
316 , _right_panel(new wxPanel(_splitter, wxID_ANY))
317 , _film_viewer(_right_panel)
320 auto bar = new wxMenuBar;
324 #ifdef DCPOMATIC_WINDOWS
325 SetIcon (wxIcon (std_to_wx ("id")));
328 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
329 config_changed (Config::OTHER);
331 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_version_file, this), ID_tools_version_file);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_import_preferences, this), ID_tools_import_preferences);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
371 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
372 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
374 auto left_panel = new wxPanel(_splitter, wxID_ANY);
376 _film_editor = new FilmEditor(left_panel, _film_viewer);
378 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
379 left_sizer->Add(_film_editor, 1, wxEXPAND);
381 left_panel->SetSizerAndFit(left_sizer);
383 _controls = new StandardControls(_right_panel, _film_viewer, true);
384 _controls->set_film(_film_viewer.film());
385 auto job_manager_view = new JobManagerView(_right_panel, false);
387 auto right_sizer = new wxBoxSizer (wxVERTICAL);
388 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
389 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
390 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
392 _right_panel->SetSizer(right_sizer);
394 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
396 set_menu_sensitivity ();
398 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
401 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
403 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
405 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
406 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
410 void add_accelerators ()
413 int accelerators = 7;
415 int accelerators = 6;
417 std::vector<wxAcceleratorEntry> accel(accelerators);
418 /* [Shortcut] Ctrl+A:Add file(s) to the film */
419 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
420 /* [Shortcut] Delete:Remove selected content from film */
421 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
422 /* [Shortcut] Space:Start/stop playback */
423 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
424 /* [Shortcut] Ctrl+T:Open timeline window */
425 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
426 /* [Shortcut] Left arrow:Move back one frame */
427 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
428 /* [Shortcut] Right arrow:Move forward one frame */
429 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
431 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
433 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
434 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
435 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
436 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
437 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
438 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
439 wxAcceleratorTable accel_table (accelerators, accel.data());
440 SetAcceleratorTable (accel_table);
443 void remove_accelerators ()
445 SetAcceleratorTable (wxAcceleratorTable ());
448 void remove_clicked (wxCommandEvent& ev)
450 if (_film_editor->content_panel()->remove_clicked (true)) {
455 void new_film (boost::filesystem::path path, optional<string> template_name)
457 auto film = make_shared<Film>(path);
459 film->use_template (template_name.get());
461 film->set_name (path.filename().generic_string());
462 film->write_metadata ();
466 void load_film (boost::filesystem::path file)
469 auto film = make_shared<Film>(file);
470 auto const notes = film->read_metadata ();
471 film->read_ui_state();
473 if (film->state_version() == 4) {
476 _("This film was created with an old version of DVD-o-matic and may not load correctly "
477 "in this version. Please check the film's settings carefully.")
481 for (auto i: notes) {
482 error_dialog (0, std_to_wx(i));
487 JobManager::instance()->add(make_shared<CheckContentJob>(film));
489 catch (FileNotFoundError& e) {
490 auto const dir = e.file().parent_path();
491 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
493 this, _("Could not open this folder as a DCP-o-matic project."),
494 _("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.")
497 auto const p = std_to_wx(file.string ());
498 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
501 } catch (std::exception& e) {
502 auto const p = std_to_wx (file.string());
503 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
506 void set_film (shared_ptr<Film> film)
509 _film_viewer.set_film(_film);
510 _film_editor->set_film(_film);
511 _controls->set_film (_film);
512 _video_waveform_dialog.reset();
513 set_menu_sensitivity ();
514 if (_film && _film->directory()) {
515 Config::instance()->add_to_history (_film->directory().get());
518 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
519 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
520 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
521 dcpomatic_log = _film->log ();
526 shared_ptr<Film> film () const {
532 void show (wxShowEvent& ev)
534 if (ev.IsShown() && !_first_shown_called) {
535 _film_editor->first_shown ();
536 _first_shown_called = true;
540 void film_message (string m)
542 message_dialog (this, std_to_wx(m));
545 void film_change (ChangeType type)
547 if (type == ChangeType::DONE) {
548 set_menu_sensitivity ();
554 FilmNameLocationDialog dialog(this, _("New Film"), true);
555 int const r = dialog.ShowModal();
557 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
562 new_film(dialog.path(), dialog.template_name());
563 } catch (boost::filesystem::filesystem_error& e) {
564 #ifdef DCPOMATIC_WINDOWS
565 string bad_chars = "<>:\"/|?*";
566 string const filename = dialog.path().filename().string();
567 string found_bad_chars;
568 for (size_t i = 0; i < bad_chars.length(); ++i) {
569 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
570 found_bad_chars += bad_chars[i];
573 wxString message = _("Could not create folder to store film.");
575 if (!found_bad_chars.empty()) {
576 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
578 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
580 error_dialog (this, message, std_to_wx(e.what()));
582 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
591 _("Select film to open"),
592 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
593 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
598 r = dialog.ShowModal();
599 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
600 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
606 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
607 load_film(wx_to_std(dialog.GetPath()));
614 _film->write_metadata ();
615 } catch (exception& e) {
616 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
620 void file_save_as_template ()
622 SaveTemplateDialog dialog(this);
623 if (dialog.ShowModal() == wxID_OK) {
625 Config::instance()->save_template(_film, dialog.name());
626 } catch (exception& e) {
627 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
632 void file_duplicate ()
634 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
636 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
637 auto film = make_shared<Film>(dialog.path());
638 film->copy_from (_film);
639 film->set_name(dialog.path().filename().generic_string());
641 film->write_metadata();
642 } catch (exception& e) {
643 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
648 void file_duplicate_and_open ()
650 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
652 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
653 auto film = make_shared<Film>(dialog.path());
654 film->copy_from (_film);
655 film->set_name(dialog.path().filename().generic_string());
657 film->write_metadata ();
659 } catch (exception& e) {
660 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
667 if (_film && _film->dirty ()) {
668 FilmChangedClosingDialog dialog(_film->name());
669 switch (dialog.run()) {
671 /* Don't save and carry on to close */
674 /* Save and carry on to close */
675 _film->write_metadata ();
683 set_film (shared_ptr<Film>());
686 void file_history (wxCommandEvent& event)
688 auto history = Config::instance()->history ();
689 int n = event.GetId() - ID_file_history;
690 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
691 load_film (history[n]);
697 /* false here allows the close handler to veto the close request */
703 auto const sel = _film_editor->content_panel()->selected();
704 if (sel.size() == 1) {
705 _clipboard = sel.front()->clone();
715 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
716 if (dialog.ShowModal() != wxID_OK) {
720 for (auto i: _film_editor->content_panel()->selected()) {
721 if (dialog.video() && i->video) {
722 DCPOMATIC_ASSERT (_clipboard->video);
723 i->video->take_settings_from (_clipboard->video);
725 if (dialog.audio() && i->audio) {
726 DCPOMATIC_ASSERT (_clipboard->audio);
727 i->audio->take_settings_from (_clipboard->audio);
731 auto j = i->text.begin ();
732 auto k = _clipboard->text.begin ();
733 while (j != i->text.end() && k != _clipboard->text.end()) {
734 (*j)->take_settings_from (*k);
742 void edit_select_all ()
744 _film_editor->content_panel()->select_all();
747 void edit_preferences ()
749 if (!_config_dialog) {
750 _config_dialog = create_full_config_dialog ();
752 _config_dialog->Show (this);
755 void tools_restore_default_preferences ()
757 wxMessageDialog dialog(
759 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
760 _("Restore default preferences"),
761 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
764 if (dialog.ShowModal() == wxID_YES) {
765 Config::restore_defaults ();
769 void tools_export_preferences ()
772 this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_SAVE | wxFD_OVERWRITE_PROMPT, "Preferences", string("dcpomatic_config.zip")
775 if (dialog.ShowModal() == wxID_OK) {
776 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
777 if (boost::filesystem::exists(path)) {
778 boost::system::error_code ec;
779 boost::filesystem::remove(path, ec);
781 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
786 save_all_config_as_zip(path);
790 void tools_import_preferences()
792 FileDialog dialog(this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_OPEN, "Preferences");
795 Config::instance()->load_from_zip(dialog.path());
799 void jobs_make_dcp ()
805 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
808 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);
810 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);
812 if (!confirm_dialog (this, message)) {
817 if (Config::instance()->show_hints_before_make_dcp()) {
818 HintsDialog hints(this, _film, false);
819 if (hints.ShowModal() == wxID_CANCEL) {
824 if (_film->encrypted ()) {
825 NagDialog::maybe_nag (
827 Config::NAG_ENCRYPTED_METADATA,
828 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
829 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
830 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
831 "if you want to make KDMs for this film.")
835 /* Remove any existing DCP if the user agrees */
836 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
837 if (dcp::filesystem::exists(dcp_dir)) {
838 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
841 dcp::filesystem::remove_all(dcp_dir);
845 /* It seems to make sense to auto-save metadata here, since the make DCP may last
846 a long time, and crashes/power failures are moderately likely.
848 _film->write_metadata ();
849 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
850 } catch (BadSettingError& e) {
851 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
852 } catch (std::exception& e) {
853 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
857 void jobs_make_kdms ()
863 _kdm_dialog.reset(this, _film);
864 _kdm_dialog->Show ();
867 void jobs_make_dkdms ()
873 _dkdm_dialog.reset(this, _film);
874 _dkdm_dialog->Show ();
877 /** @return false if we succeeded, true if not */
878 bool send_to_other_tool (int port, function<void()> start, string message)
880 /* i = 0; try to connect via socket
881 i = 1; try again, and then try to start the tool
882 i = 2 onwards; try again.
884 for (int i = 0; i < 8; ++i) {
886 boost::asio::io_service io_service;
887 boost::asio::ip::tcp::resolver resolver (io_service);
888 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
889 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
891 socket.connect (*endpoint_iterator);
892 DCPOMATIC_ASSERT (_film->directory ());
893 socket.write (message.length() + 1);
894 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
899 } catch (exception& e) {
907 dcpomatic_sleep_seconds (1);
913 void jobs_make_dcp_batch ()
919 if (Config::instance()->show_hints_before_make_dcp()) {
920 HintsDialog hints(this, _film, false);
921 if (hints.ShowModal() == wxID_CANCEL) {
926 _film->write_metadata ();
928 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
930 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
932 error_dialog (this, _("Could not find batch converter."));
937 void jobs_open_dcp_in_player ()
943 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
945 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
947 error_dialog (this, _("Could not find player."));
952 void jobs_make_self_dkdm ()
958 SelfDKDMDialog dialog(this, _film);
959 if (dialog.ShowModal() != wxID_OK) {
963 NagDialog::maybe_nag (
965 Config::NAG_DKDM_CONFIG,
967 _("You are making a DKDM which is encrypted by a private key held in"
968 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
969 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
970 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
975 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
977 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
980 auto signer = Config::instance()->signer_chain();
981 if (!signer->valid()) {
982 error_dialog(this, _("The certificate chain for signing is invalid"));
986 optional<dcp::EncryptedKDM> kdm;
988 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
989 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
990 if (dialog.internal()) {
991 auto dkdms = Config::instance()->dkdms();
992 dkdms->add(make_shared<DKDM>(kdm));
993 Config::instance()->changed ();
995 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
998 } catch (dcp::NotEncryptedError& e) {
999 error_dialog (this, _("CPL's content is not encrypted."));
1000 } catch (exception& e) {
1001 error_dialog (this, e.what ());
1003 error_dialog (this, _("An unknown exception occurred."));
1008 void jobs_export_video_file ()
1010 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
1011 if (dialog.ShowModal() != wxID_OK) {
1015 if (dcp::filesystem::exists(dialog.path())) {
1016 bool ok = confirm_dialog(
1018 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1026 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1028 make_shared<FFmpegEncoder> (
1029 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1031 JobManager::instance()->add (job);
1035 void jobs_export_subtitles ()
1037 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1038 if (dialog.ShowModal() != wxID_OK) {
1041 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1043 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1045 JobManager::instance()->add(job);
1049 void jobs_send_dcp_to_tms ()
1051 _film->send_dcp_to_tms ();
1054 void jobs_show_dcp ()
1056 DCPOMATIC_ASSERT (_film->directory ());
1057 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1058 error_dialog (this, _("Could not show DCP."));
1062 void view_closed_captions ()
1064 _film_viewer.show_closed_captions ();
1067 void view_video_waveform ()
1069 if (!_video_waveform_dialog) {
1070 _video_waveform_dialog.reset(this, _film, _film_viewer);
1073 _video_waveform_dialog->Show ();
1076 void tools_system_information ()
1078 if (!_system_information_dialog) {
1079 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1082 _system_information_dialog->Show ();
1085 void tools_version_file()
1087 if (_dcp_referencing_dialog) {
1088 _dcp_referencing_dialog->Destroy();
1089 _dcp_referencing_dialog = nullptr;
1092 _dcp_referencing_dialog = new DCPReferencingDialog(this, _film);
1093 _dcp_referencing_dialog->Show();
1098 if (!_hints_dialog) {
1099 _hints_dialog = new HintsDialog (this, _film, true);
1102 _hints_dialog->Show ();
1105 void tools_encoding_servers ()
1107 if (!_servers_list_dialog) {
1108 _servers_list_dialog = new ServersListDialog (this);
1111 _servers_list_dialog->Show ();
1114 void tools_manage_templates ()
1116 if (!_templates_dialog) {
1117 _templates_dialog.reset(this);
1120 _templates_dialog->Show ();
1123 void tools_check_for_updates ()
1125 _update_news_requested = true;
1126 UpdateChecker::instance()->run();
1129 void tools_send_translations ()
1131 SendI18NDialog dialog(this);
1132 if (dialog.ShowModal() != wxID_OK) {
1137 body += dialog.name() + "\n";
1138 body += dialog.language() + "\n";
1139 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1141 auto translations = I18NHook::translations ();
1142 for (auto i: translations) {
1143 body += i.first + "\n" + i.second + "\n\n";
1145 if (dialog.email().find("@") == string::npos) {
1146 error_dialog (this, _("You must enter a valid email address when sending translations, "
1147 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1149 Email email(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1151 email.send("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1152 } catch (NetworkError& e) {
1153 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1160 AboutDialog dialog(this);
1164 void help_report_a_problem ()
1166 ReportProblemDialog dialog(this, _film);
1167 if (dialog.ShowModal() == wxID_OK) {
1172 bool should_close ()
1174 if (!JobManager::instance()->work_to_do ()) {
1178 wxMessageDialog dialog(
1180 _("There are unfinished jobs; are you sure you want to quit?"),
1181 _("Unfinished jobs"),
1182 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1185 return dialog.ShowModal() == wxID_YES;
1188 void close (wxCloseEvent& ev)
1190 if (!should_close ()) {
1195 if (_film && _film->dirty ()) {
1196 FilmChangedClosingDialog dialog(_film->name());
1197 switch (dialog.run()) {
1199 /* Don't save and carry on to close */
1202 /* Save and carry on to close */
1203 _film->write_metadata ();
1206 /* Veto the event and stop */
1212 /* We don't want to hear about any more configuration changes, since they
1213 cause the File menu to be altered, which itself will be deleted around
1214 now (without, as far as I can see, any way for us to find out).
1216 _config_changed_connection.disconnect ();
1218 /* Also stop hearing about analytics-related stuff */
1219 _analytics_message_connection.disconnect ();
1224 JobManager::drop ();
1227 void active_jobs_changed()
1229 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1230 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1231 * it by using an idle callback. This feels quite unpleasant.
1233 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1236 void set_menu_sensitivity ()
1238 auto jobs = JobManager::instance()->get ();
1239 auto i = jobs.begin();
1240 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1243 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1244 bool const have_cpl = _film && !_film->cpls().empty ();
1245 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1246 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1247 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1248 vector<shared_ptr<Content>> content;
1250 content = _film->content();
1252 bool const have_dcp_content = std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1253 return static_cast<bool>(dynamic_pointer_cast<const DCPContent>(content));
1254 }) != content.end();
1256 for (auto j: menu_items) {
1258 bool enabled = true;
1260 if ((j.second & NEEDS_FILM) && !_film) {
1264 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1268 if ((j.second & NEEDS_CPL) && !have_cpl) {
1272 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1276 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1280 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1284 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1288 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1292 if ((j.second & NEEDS_DCP_CONTENT) && !have_dcp_content) {
1296 j.first->Enable (enabled);
1300 /** @return true if the operation that called this method
1301 * should continue, false to abort it.
1304 bool maybe_save_film ()
1310 while (_film->dirty()) {
1311 T dialog(_film->name());
1312 switch (dialog.run()) {
1317 _film->write_metadata();
1319 } catch (exception& e) {
1320 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1321 /* Go round again for another try */
1333 bool maybe_save_then_delete_film ()
1335 bool const r = maybe_save_film<T> ();
1342 void add_item (wxMenu* menu, wxString text, int id, int sens)
1344 auto item = menu->Append (id, text);
1345 menu_items.insert (make_pair (item, sens));
1348 void setup_menu (wxMenuBar* m)
1350 _file_menu = new wxMenu;
1351 /* [Shortcut] Ctrl+N:New film */
1352 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1353 /* [Shortcut] Ctrl+O:Open existing film */
1354 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1355 _file_menu->AppendSeparator ();
1356 /* [Shortcut] Ctrl+S:Save current film */
1357 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1358 _file_menu->AppendSeparator ();
1359 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1360 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1361 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1363 _history_position = _file_menu->GetMenuItems().GetCount();
1365 _file_menu->AppendSeparator ();
1366 /* [Shortcut] Ctrl+W:Close current film */
1367 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1370 _file_menu->AppendSeparator ();
1374 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1376 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1379 auto edit = new wxMenu;
1380 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1381 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1382 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1383 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1384 edit->AppendSeparator ();
1385 /* [Shortcut] Shift+Ctrl+A:Select all content */
1386 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1389 add_item(_file_menu, _("&Preferences...\tCtrl-,"), wxID_PREFERENCES, ALWAYS);
1391 edit->AppendSeparator ();
1392 /* [Shortcut] Ctrl+P:Open preferences window */
1393 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1396 auto jobs_menu = new wxMenu;
1397 /* [Shortcut] Ctrl+M:Make DCP */
1398 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1399 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1400 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1401 jobs_menu->AppendSeparator ();
1402 /* [Shortcut] Ctrl+K:Make KDMs */
1403 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1404 /* [Shortcut] Ctrl+D:Make DKDMs */
1405 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1406 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1407 jobs_menu->AppendSeparator ();
1408 /* [Shortcut] Ctrl+E:Export video file */
1409 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1410 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1411 jobs_menu->AppendSeparator ();
1412 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1414 #if defined(DCPOMATIC_OSX)
1415 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1416 #elif defined(DCPOMATIC_WINDOWS)
1417 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1419 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1422 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1424 auto view = new wxMenu;
1425 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1426 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1428 auto tools = new wxMenu;
1429 add_item (tools, _("Version File (VF)..."), ID_tools_version_file, NEEDS_FILM | NEEDS_DCP_CONTENT);
1430 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1431 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1432 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1433 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1434 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1435 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1436 tools->AppendSeparator ();
1437 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1438 tools->AppendSeparator ();
1439 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1440 add_item (tools, _("Import preferences..."), ID_tools_import_preferences, ALWAYS);
1442 wxMenu* help = new wxMenu;
1444 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1446 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1448 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1450 m->Append (_file_menu, _("&File"));
1451 m->Append (edit, _("&Edit"));
1452 m->Append (jobs_menu, _("&Jobs"));
1453 m->Append (view, _("&View"));
1454 m->Append (tools, _("&Tools"));
1455 m->Append (help, _("&Help"));
1458 void config_changed (Config::Property what)
1460 /* Instantly save any config changes when using the DCP-o-matic GUI */
1462 case Config::CINEMAS:
1464 Config::instance()->write_cinemas();
1465 } catch (exception& e) {
1469 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1470 std_to_wx (Config::instance()->cinemas_file().string()).data()
1475 case Config::DKDM_RECIPIENTS:
1477 Config::instance()->write_dkdm_recipients();
1478 } catch (exception& e) {
1482 _("Could not write to DKDM recipients file at %s. Your changes have not been saved."),
1483 std_to_wx(Config::instance()->dkdm_recipients_file().string()).data()
1490 Config::instance()->write_config();
1491 } catch (exception& e) {
1495 _("Could not write to config file at %s. Your changes have not been saved."),
1496 std_to_wx (Config::instance()->cinemas_file().string()).data()
1502 for (int i = 0; i < _history_items; ++i) {
1503 delete _file_menu->Remove (ID_file_history + i);
1506 if (_history_separator) {
1507 _file_menu->Remove (_history_separator);
1509 delete _history_separator;
1510 _history_separator = 0;
1512 int pos = _history_position;
1514 /* Clear out non-existent history items before we re-build the menu */
1515 Config::instance()->clean_history ();
1516 auto history = Config::instance()->history();
1518 if (!history.empty ()) {
1519 _history_separator = _file_menu->InsertSeparator (pos++);
1522 for (size_t i = 0; i < history.size(); ++i) {
1525 s = String::compose ("&%1 %2", i + 1, history[i].string());
1527 s = history[i].string();
1529 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1532 _history_items = history.size ();
1534 dcpomatic_log->set_types (Config::instance()->log_types());
1536 #ifdef DCPOMATIC_GROK
1537 if (what == Config::GROK) {
1538 setup_grok_library_path();
1543 void update_checker_state_changed ()
1545 auto uc = UpdateChecker::instance ();
1547 bool const announce =
1548 _update_news_requested ||
1549 (uc->stable() && Config::instance()->check_for_updates()) ||
1550 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1552 _update_news_requested = false;
1558 if (uc->state() == UpdateChecker::State::YES) {
1559 UpdateDialog dialog(this, uc->stable(), uc->test());
1561 } else if (uc->state() == UpdateChecker::State::FAILED) {
1562 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1564 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1567 _update_news_requested = false;
1570 void start_stop_pressed ()
1572 if (_film_viewer.playing()) {
1573 _film_viewer.stop();
1575 _film_viewer.start();
1579 void timeline_pressed ()
1581 _film_editor->content_panel()->timeline_clicked ();
1586 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1589 void forward_frame ()
1591 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1594 void analytics_message (string title, string html)
1596 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1602 auto s = wx_to_std(_("DCP-o-matic"));
1604 if (_film->directory()) {
1605 s += " - " + _film->directory()->string();
1607 if (_film->dirty()) {
1612 SetTitle (std_to_wx(s));
1615 FilmEditor* _film_editor;
1616 LimitedFrameSplitter* _splitter;
1617 wxPanel* _right_panel;
1618 FilmViewer _film_viewer;
1619 StandardControls* _controls;
1620 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1621 SystemInformationDialog* _system_information_dialog = nullptr;
1622 DCPReferencingDialog* _dcp_referencing_dialog = nullptr;
1623 HintsDialog* _hints_dialog = nullptr;
1624 ServersListDialog* _servers_list_dialog = nullptr;
1625 wxPreferencesEditor* _config_dialog = nullptr;
1626 wx_ptr<KDMDialog> _kdm_dialog;
1627 wx_ptr<DKDMDialog> _dkdm_dialog;
1628 wx_ptr<TemplatesDialog> _templates_dialog;
1629 wxMenu* _file_menu = nullptr;
1630 shared_ptr<Film> _film;
1631 int _history_items = 0;
1632 int _history_position = 0;
1633 wxMenuItem* _history_separator = nullptr;
1634 boost::signals2::scoped_connection _config_changed_connection;
1635 boost::signals2::scoped_connection _analytics_message_connection;
1636 bool _update_news_requested = false;
1637 shared_ptr<Content> _clipboard;
1638 bool _first_shown_called = false;
1642 static const wxCmdLineEntryDesc command_line_description[] = {
1643 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1644 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1645 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1646 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1647 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1648 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1649 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1654 * @brief The magic App class for wxWidgets.
1656 class App : public wxApp
1662 dcpomatic_setup_path_encoding ();
1663 #ifdef DCPOMATIC_LINUX
1670 bool OnInit () override
1674 #if defined(DCPOMATIC_WINDOWS)
1675 if (Config::instance()->win32_console()) {
1678 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1679 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1680 FILE* hf_out = _fdopen(hCrt, "w");
1681 setvbuf(hf_out, NULL, _IONBF, 1);
1684 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1685 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1686 FILE* hf_in = _fdopen(hCrt, "r");
1687 setvbuf(hf_in, NULL, _IONBF, 128);
1690 cout << "DCP-o-matic is starting." << "\n";
1693 wxInitAllImageHandlers ();
1695 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1696 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1698 _splash = maybe_show_splash ();
1700 SetAppName (_("DCP-o-matic"));
1702 if (!wxApp::OnInit()) {
1706 #ifdef DCPOMATIC_LINUX
1707 unsetenv ("UBUNTU_MENUPROXY");
1710 #ifdef DCPOMATIC_OSX
1711 dcpomatic_sleep_seconds (1);
1712 make_foreground_application ();
1715 /* Enable i18n; this will create a Config object
1716 to look for a force-configured language. This Config
1717 object will be wrong, however, because dcpomatic_setup
1718 hasn't yet been called and there aren't any filters etc.
1721 dcpomatic_setup_i18n ();
1723 /* Set things up, including filters etc.
1724 which will now be internationalised correctly.
1728 /* Force the configuration to be re-loaded correctly next
1733 /* We only look out for bad configuration from here on, as before
1734 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1735 incorrect certificate chain validity errors.
1737 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1739 _frame = new DOMFrame (_("DCP-o-matic"));
1740 SetTopWindow (_frame);
1741 _frame->Maximize ();
1744 if (running_32_on_64 ()) {
1745 NagDialog::maybe_nag (
1746 _frame, Config::NAG_32_ON_64,
1747 _("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."),
1753 signal_manager = new wxSignalManager (this);
1754 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1756 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1758 _frame->load_film (_film_to_load);
1759 } catch (exception& e) {
1760 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()));
1764 if (!_film_to_create.empty ()) {
1765 _frame->new_film (_film_to_create, optional<string>());
1766 if (!_content_to_add.empty()) {
1767 for (auto i: content_factory(_content_to_add)) {
1768 _frame->film()->examine_and_add_content(i);
1771 if (!_dcp_to_add.empty ()) {
1772 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1776 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1777 _timer.reset (new wxTimer (this));
1778 _timer->Start (1000);
1780 if (Config::instance()->check_for_updates ()) {
1781 UpdateChecker::instance()->run ();
1784 auto release_notes = find_release_notes(gui_is_dark());
1785 if (release_notes) {
1786 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1791 #ifdef DCPOMATIC_GROK
1792 grk_plugin::setMessengerLogger(new grk_plugin::GrokLogger("[GROK] "));
1793 setup_grok_library_path();
1796 catch (exception& e)
1799 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1805 void OnInitCmdLine (wxCmdLineParser& parser) override
1807 parser.SetDesc (command_line_description);
1808 parser.SetSwitchChars (wxT ("-"));
1811 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1813 if (parser.Found (wxT("version"))) {
1814 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1815 exit (EXIT_SUCCESS);
1818 if (parser.GetParamCount() > 0) {
1819 if (parser.Found (wxT ("new"))) {
1820 _film_to_create = wx_to_std (parser.GetParam (0));
1822 _film_to_load = wx_to_std (parser.GetParam (0));
1827 if (parser.Found (wxT ("content"), &content)) {
1828 _content_to_add = wx_to_std (content);
1832 if (parser.Found (wxT ("dcp"), &dcp)) {
1833 _dcp_to_add = wx_to_std (dcp);
1837 if (parser.Found (wxT("config"), &config)) {
1838 State::override_path = wx_to_std (config);
1844 void report_exception ()
1848 } catch (FileError& e) {
1852 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1853 std_to_wx (e.what()),
1854 std_to_wx (e.file().string().c_str())
1857 } catch (boost::filesystem::filesystem_error& e) {
1861 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1862 std_to_wx (e.what()),
1863 std_to_wx (e.path1().string()),
1864 std_to_wx (e.path2().string())
1867 } catch (exception& e) {
1871 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1872 std_to_wx (e.what ())
1876 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1880 /* An unhandled exception has occurred inside the main event loop */
1881 bool OnExceptionInMainLoop () override
1883 report_exception ();
1884 /* This will terminate the program */
1888 void OnUnhandledException () override
1890 report_exception ();
1893 void idle (wxIdleEvent& ev)
1895 signal_manager->ui_idle ();
1902 EncodeServerFinder::instance()->rethrow ();
1903 } catch (exception& e) {
1904 error_dialog (0, std_to_wx (e.what ()));
1908 void close_splash ()
1916 void config_failed_to_load (Config::LoadFailure what)
1918 report_config_load_failure(_frame, what);
1921 void config_warning (string m)
1923 message_dialog (_frame, std_to_wx(m));
1926 bool config_bad (Config::BadReason reason)
1928 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1929 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1933 auto config = Config::instance();
1935 case Config::BAD_SIGNER_UTF8_STRINGS:
1937 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1940 RecreateChainDialog dialog(
1941 _frame, _("Recreate signing certificates"),
1942 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1943 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1944 "the certificate chain for signing DCPs and KDMs?"),
1946 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1948 return dialog.ShowModal() == wxID_OK;
1950 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1952 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1955 RecreateChainDialog dialog(
1956 _frame, _("Recreate signing certificates"),
1957 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1958 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1959 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1961 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1963 return dialog.ShowModal() == wxID_OK;
1965 case Config::BAD_SIGNER_INCONSISTENT:
1967 RecreateChainDialog dialog(
1968 _frame, _("Recreate signing certificates"),
1969 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1970 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1971 "the certificate chain for signing DCPs and KDMs?"),
1972 _("Close DCP-o-matic")
1974 if (dialog.ShowModal() != wxID_OK) {
1975 exit (EXIT_FAILURE);
1979 case Config::BAD_DECRYPTION_INCONSISTENT:
1981 RecreateChainDialog dialog(
1982 _frame, _("Recreate KDM decryption chain"),
1983 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1984 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1985 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1986 "configuration before continuing."),
1987 _("Close DCP-o-matic")
1989 if (dialog.ShowModal() != wxID_OK) {
1990 exit (EXIT_FAILURE);
1994 case Config::BAD_SIGNER_DN_QUALIFIER:
1996 RecreateChainDialog dialog(
1997 _frame, _("Recreate signing certificates"),
1998 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1999 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
2000 "by a bug in DCP-o-matic which has now been fixed. Do you want to re-create the certificate chain\n"
2001 "for signing DCPs and KDMs?"),
2003 Config::NAG_BAD_SIGNER_DN_QUALIFIER
2005 return dialog.ShowModal() == wxID_OK;
2008 DCPOMATIC_ASSERT (false);
2012 DOMFrame* _frame = nullptr;
2013 wxSplashScreen* _splash = nullptr;
2014 shared_ptr<wxTimer> _timer;
2015 string _film_to_load;
2016 string _film_to_create;
2017 string _content_to_add;