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/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/send_i18n_dialog.h"
51 #include "wx/servers_list_dialog.h"
52 #include "wx/standard_controls.h"
53 #include "wx/system_information_dialog.h"
54 #include "wx/templates_dialog.h"
55 #include "wx/update_dialog.h"
56 #include "wx/video_waveform_dialog.h"
57 #include "wx/wx_signal_manager.h"
58 #include "wx/wx_util.h"
59 #include "lib/analytics.h"
60 #include "lib/audio_content.h"
61 #include "lib/check_content_job.h"
62 #include "lib/cinema.h"
63 #include "lib/compose.hpp"
64 #include "lib/config.h"
65 #include "lib/constants.h"
66 #include "lib/content.h"
67 #include "lib/content_factory.h"
68 #include "lib/cross.h"
69 #include "lib/cross.h"
70 #include "lib/dcp_content.h"
71 #include "lib/dcpomatic_log.h"
72 #include "lib/dcpomatic_socket.h"
73 #include "lib/dkdm_wrapper.h"
74 #include "lib/emailer.h"
75 #include "lib/encode_server_finder.h"
76 #include "lib/exceptions.h"
77 #include "lib/ffmpeg_encoder.h"
79 #include "lib/font_config.h"
81 #include "lib/grok/context.h"
83 #include "lib/hints.h"
84 #include "lib/job_manager.h"
85 #include "lib/kdm_with_metadata.h"
87 #include "lib/make_dcp.h"
88 #include "lib/release_notes.h"
89 #include "lib/screen.h"
90 #include "lib/send_kdm_email_job.h"
91 #include "lib/signal_manager.h"
92 #include "lib/subtitle_encoder.h"
93 #include "lib/text_content.h"
94 #include "lib/transcode_job.h"
95 #include "lib/update_checker.h"
96 #include "lib/version.h"
97 #include "lib/video_content.h"
98 #include <dcp/exceptions.h>
99 #include <dcp/filesystem.h>
100 #include <dcp/raw_convert.h>
101 #include <dcp/warnings.h>
102 LIBDCP_DISABLE_WARNINGS
103 #include <wx/cmdline.h>
104 #include <wx/generic/aboutdlgg.h>
105 #include <wx/preferences.h>
106 #include <wx/splash.h>
107 #include <wx/stdpaths.h>
108 #include <wx/wxhtml.h>
109 LIBDCP_ENABLE_WARNINGS
111 #include <X11/Xlib.h>
114 #include <shellapi.h>
116 #include <boost/algorithm/string.hpp>
117 #include <boost/filesystem.hpp>
120 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
129 using std::dynamic_pointer_cast;
130 using std::exception;
133 using std::make_pair;
134 using std::make_shared;
136 using std::shared_ptr;
140 using boost::optional;
141 using boost::is_any_of;
142 using boost::algorithm::find;
143 #if BOOST_VERSION >= 106100
144 using namespace boost::placeholders;
146 using dcp::raw_convert;
149 class FilmChangedClosingDialog
152 explicit FilmChangedClosingDialog (string name)
155 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
156 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
157 /// project (Film) has been changed since it was last saved.
159 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
162 _dialog.SetYesNoCancelLabels(
163 _("Save film and close"), _("Close without saving film"), _("Don't close")
169 return _dialog.ShowModal();
173 wxMessageDialog _dialog;
177 class FilmChangedDuplicatingDialog
180 explicit FilmChangedDuplicatingDialog (string name)
183 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
184 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
185 /// project (Film) has been changed since it was last saved.
187 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
190 _dialog.SetYesNoCancelLabels(
191 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
197 return _dialog.ShowModal();
201 wxMessageDialog _dialog;
206 #define NEEDS_FILM 0x1
207 #define NOT_DURING_DCP_CREATION 0x2
208 #define NEEDS_CPL 0x4
209 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
210 #define NEEDS_SELECTED_CONTENT 0x10
211 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
212 #define NEEDS_CLIPBOARD 0x40
213 #define NEEDS_ENCRYPTION 0x80
214 #define NEEDS_DCP_CONTENT 0x100
217 map<wxMenuItem*, int> menu_items;
220 ID_file_new = DCPOMATIC_MAIN_MENU,
223 ID_file_save_as_template,
225 ID_file_duplicate_and_open,
227 /* Allow spare IDs after _history for the recent files list */
228 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
233 ID_jobs_make_dcp_batch,
236 ID_jobs_make_self_dkdm,
237 ID_jobs_export_video_file,
238 ID_jobs_export_subtitles,
239 ID_jobs_send_dcp_to_tms,
241 ID_jobs_open_dcp_in_player,
242 ID_view_closed_captions,
243 ID_view_video_waveform,
244 ID_tools_version_file,
246 ID_tools_encoding_servers,
247 ID_tools_manage_templates,
248 ID_tools_check_for_updates,
249 ID_tools_send_translations,
250 ID_tools_system_information,
251 ID_tools_restore_default_preferences,
252 ID_tools_export_preferences,
253 ID_help_report_a_problem,
254 /* IDs for shortcuts (with no associated menu item) */
264 class LimitedFrameSplitter : public wxSplitterWindow
267 LimitedFrameSplitter(wxWindow* parent)
268 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
270 /* This value doesn't really mean much but we just want to stop double-click on the
271 divider from shrinking the left panel.
273 SetMinimumPaneSize(64);
275 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
278 bool OnSashPositionChange(int new_position) override
280 /* Try to stop the left bit of the splitter getting too small */
281 auto const ok = new_position > _left_panel_minimum_size;
283 Config::instance()->set_main_divider_sash_position(new_position);
289 void sized(wxSizeEvent& ev)
291 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
292 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
293 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
295 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
301 int const _left_panel_minimum_size = 200;
305 class DOMFrame : public wxFrame
308 explicit DOMFrame (wxString const& title)
309 : wxFrame (nullptr, -1, title)
310 /* Use a panel as the only child of the Frame so that we avoid
311 the dark-grey background on Windows.
313 , _splitter(new LimitedFrameSplitter(this))
314 , _right_panel(new wxPanel(_splitter, wxID_ANY))
315 , _film_viewer(_right_panel)
318 auto bar = new wxMenuBar;
322 #ifdef DCPOMATIC_WINDOWS
323 SetIcon (wxIcon (std_to_wx ("id")));
326 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
327 config_changed (Config::OTHER);
329 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
331 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
332 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_version_file, this), ID_tools_version_file);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
368 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
369 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
371 auto left_panel = new wxPanel(_splitter, wxID_ANY);
373 _film_editor = new FilmEditor(left_panel, _film_viewer);
375 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
376 left_sizer->Add(_film_editor, 1, wxEXPAND);
378 left_panel->SetSizerAndFit(left_sizer);
380 _controls = new StandardControls(_right_panel, _film_viewer, true);
381 _controls->set_film(_film_viewer.film());
382 auto job_manager_view = new JobManagerView(_right_panel, false);
384 auto right_sizer = new wxBoxSizer (wxVERTICAL);
385 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
386 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
387 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
389 _right_panel->SetSizer(right_sizer);
391 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
393 set_menu_sensitivity ();
395 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
398 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
400 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
402 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
403 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
407 void add_accelerators ()
410 int accelerators = 7;
412 int accelerators = 6;
414 std::vector<wxAcceleratorEntry> accel(accelerators);
415 /* [Shortcut] Ctrl+A:Add file(s) to the film */
416 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
417 /* [Shortcut] Delete:Remove selected content from film */
418 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
419 /* [Shortcut] Space:Start/stop playback */
420 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
421 /* [Shortcut] Ctrl+T:Open timeline window */
422 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
423 /* [Shortcut] Left arrow:Move back one frame */
424 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
425 /* [Shortcut] Right arrow:Move forward one frame */
426 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
428 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
430 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
431 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
432 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
433 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
434 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
435 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
436 wxAcceleratorTable accel_table (accelerators, accel.data());
437 SetAcceleratorTable (accel_table);
440 void remove_accelerators ()
442 SetAcceleratorTable (wxAcceleratorTable ());
445 void remove_clicked (wxCommandEvent& ev)
447 if (_film_editor->content_panel()->remove_clicked (true)) {
452 void new_film (boost::filesystem::path path, optional<string> template_name)
454 auto film = make_shared<Film>(path);
456 film->use_template (template_name.get());
458 film->set_name (path.filename().generic_string());
459 film->write_metadata ();
463 void load_film (boost::filesystem::path file)
466 auto film = make_shared<Film>(file);
467 auto const notes = film->read_metadata ();
468 film->read_ui_state();
470 if (film->state_version() == 4) {
473 _("This film was created with an old version of DVD-o-matic and may not load correctly "
474 "in this version. Please check the film's settings carefully.")
478 for (auto i: notes) {
479 error_dialog (0, std_to_wx(i));
484 JobManager::instance()->add(make_shared<CheckContentJob>(film));
486 catch (FileNotFoundError& e) {
487 auto const dir = e.file().parent_path();
488 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
490 this, _("Could not open this folder as a DCP-o-matic project."),
491 _("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.")
494 auto const p = std_to_wx(file.string ());
495 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
498 } catch (std::exception& e) {
499 auto const p = std_to_wx (file.string());
500 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
503 void set_film (shared_ptr<Film> film)
506 _film_viewer.set_film(_film);
507 _film_editor->set_film(_film);
508 _controls->set_film (_film);
509 _video_waveform_dialog.reset();
510 set_menu_sensitivity ();
511 if (_film && _film->directory()) {
512 Config::instance()->add_to_history (_film->directory().get());
515 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
516 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
517 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
518 dcpomatic_log = _film->log ();
523 shared_ptr<Film> film () const {
529 void show (wxShowEvent& ev)
531 if (ev.IsShown() && !_first_shown_called) {
532 _film_editor->first_shown ();
533 _first_shown_called = true;
537 void film_message (string m)
539 message_dialog (this, std_to_wx(m));
542 void film_change (ChangeType type)
544 if (type == ChangeType::DONE) {
545 set_menu_sensitivity ();
551 FilmNameLocationDialog dialog(this, _("New Film"), true);
552 int const r = dialog.ShowModal();
554 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
559 new_film(dialog.path(), dialog.template_name());
560 } catch (boost::filesystem::filesystem_error& e) {
561 #ifdef DCPOMATIC_WINDOWS
562 string bad_chars = "<>:\"/|?*";
563 string const filename = dialog.path().filename().string();
564 string found_bad_chars;
565 for (size_t i = 0; i < bad_chars.length(); ++i) {
566 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
567 found_bad_chars += bad_chars[i];
570 wxString message = _("Could not create folder to store film.");
572 if (!found_bad_chars.empty()) {
573 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
575 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
577 error_dialog (this, message, std_to_wx(e.what()));
579 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
588 _("Select film to open"),
589 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
590 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
595 r = dialog.ShowModal();
596 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
597 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
603 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
604 load_film(wx_to_std(dialog.GetPath()));
611 _film->write_metadata ();
612 } catch (exception& e) {
613 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
617 void file_save_as_template ()
619 SaveTemplateDialog dialog(this);
620 if (dialog.ShowModal() == wxID_OK) {
622 Config::instance()->save_template(_film, dialog.name());
623 } catch (exception& e) {
624 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
629 void file_duplicate ()
631 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
633 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
634 auto film = make_shared<Film>(dialog.path());
635 film->copy_from (_film);
636 film->set_name(dialog.path().filename().generic_string());
638 film->write_metadata();
639 } catch (exception& e) {
640 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
645 void file_duplicate_and_open ()
647 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
649 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
650 auto film = make_shared<Film>(dialog.path());
651 film->copy_from (_film);
652 film->set_name(dialog.path().filename().generic_string());
654 film->write_metadata ();
656 } catch (exception& e) {
657 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
664 if (_film && _film->dirty ()) {
665 FilmChangedClosingDialog dialog(_film->name());
666 switch (dialog.run()) {
668 /* Don't save and carry on to close */
671 /* Save and carry on to close */
672 _film->write_metadata ();
680 set_film (shared_ptr<Film>());
683 void file_history (wxCommandEvent& event)
685 auto history = Config::instance()->history ();
686 int n = event.GetId() - ID_file_history;
687 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
688 load_film (history[n]);
694 /* false here allows the close handler to veto the close request */
700 auto const sel = _film_editor->content_panel()->selected();
701 if (sel.size() == 1) {
702 _clipboard = sel.front()->clone();
712 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
713 if (dialog.ShowModal() != wxID_OK) {
717 for (auto i: _film_editor->content_panel()->selected()) {
718 if (dialog.video() && i->video) {
719 DCPOMATIC_ASSERT (_clipboard->video);
720 i->video->take_settings_from (_clipboard->video);
722 if (dialog.audio() && i->audio) {
723 DCPOMATIC_ASSERT (_clipboard->audio);
724 i->audio->take_settings_from (_clipboard->audio);
728 auto j = i->text.begin ();
729 auto k = _clipboard->text.begin ();
730 while (j != i->text.end() && k != _clipboard->text.end()) {
731 (*j)->take_settings_from (*k);
739 void edit_select_all ()
741 _film_editor->content_panel()->select_all();
744 void edit_preferences ()
746 if (!_config_dialog) {
747 _config_dialog = create_full_config_dialog ();
749 _config_dialog->Show (this);
752 void tools_restore_default_preferences ()
754 wxMessageDialog dialog(
756 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
757 _("Restore default preferences"),
758 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
761 if (dialog.ShowModal() == wxID_YES) {
762 Config::restore_defaults ();
766 void tools_export_preferences ()
769 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
770 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
773 if (dialog.ShowModal() == wxID_OK) {
774 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
775 if (boost::filesystem::exists(path)) {
776 boost::system::error_code ec;
777 boost::filesystem::remove(path, ec);
779 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
784 save_all_config_as_zip(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 ();
1074 void tools_version_file()
1076 if (_dcp_referencing_dialog) {
1077 _dcp_referencing_dialog->Destroy();
1078 _dcp_referencing_dialog = nullptr;
1081 _dcp_referencing_dialog = new DCPReferencingDialog(this, _film);
1082 _dcp_referencing_dialog->Show();
1087 if (!_hints_dialog) {
1088 _hints_dialog = new HintsDialog (this, _film, true);
1091 _hints_dialog->Show ();
1094 void tools_encoding_servers ()
1096 if (!_servers_list_dialog) {
1097 _servers_list_dialog = new ServersListDialog (this);
1100 _servers_list_dialog->Show ();
1103 void tools_manage_templates ()
1105 if (!_templates_dialog) {
1106 _templates_dialog.reset(this);
1109 _templates_dialog->Show ();
1112 void tools_check_for_updates ()
1114 _update_news_requested = true;
1115 UpdateChecker::instance()->run();
1118 void tools_send_translations ()
1120 SendI18NDialog dialog(this);
1121 if (dialog.ShowModal() != wxID_OK) {
1126 body += dialog.name() + "\n";
1127 body += dialog.language() + "\n";
1128 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1130 auto translations = I18NHook::translations ();
1131 for (auto i: translations) {
1132 body += i.first + "\n" + i.second + "\n\n";
1134 if (dialog.email().find("@") == string::npos) {
1135 error_dialog (this, _("You must enter a valid email address when sending translations, "
1136 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1138 Emailer emailer(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1140 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1141 } catch (NetworkError& e) {
1142 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1149 AboutDialog dialog(this);
1153 void help_report_a_problem ()
1155 ReportProblemDialog dialog(this, _film);
1156 if (dialog.ShowModal() == wxID_OK) {
1161 bool should_close ()
1163 if (!JobManager::instance()->work_to_do ()) {
1167 wxMessageDialog dialog(
1169 _("There are unfinished jobs; are you sure you want to quit?"),
1170 _("Unfinished jobs"),
1171 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1174 return dialog.ShowModal() == wxID_YES;
1177 void close (wxCloseEvent& ev)
1179 if (!should_close ()) {
1184 if (_film && _film->dirty ()) {
1185 FilmChangedClosingDialog dialog(_film->name());
1186 switch (dialog.run()) {
1188 /* Don't save and carry on to close */
1191 /* Save and carry on to close */
1192 _film->write_metadata ();
1195 /* Veto the event and stop */
1201 /* We don't want to hear about any more configuration changes, since they
1202 cause the File menu to be altered, which itself will be deleted around
1203 now (without, as far as I can see, any way for us to find out).
1205 _config_changed_connection.disconnect ();
1207 /* Also stop hearing about analytics-related stuff */
1208 _analytics_message_connection.disconnect ();
1213 JobManager::drop ();
1216 void active_jobs_changed()
1218 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1219 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1220 * it by using an idle callback. This feels quite unpleasant.
1222 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1225 void set_menu_sensitivity ()
1227 auto jobs = JobManager::instance()->get ();
1228 auto i = jobs.begin();
1229 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1232 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1233 bool const have_cpl = _film && !_film->cpls().empty ();
1234 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1235 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1236 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1237 vector<shared_ptr<Content>> content;
1239 content = _film->content();
1241 bool const have_dcp_content = std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1242 return static_cast<bool>(dynamic_pointer_cast<const DCPContent>(content));
1243 }) != content.end();
1245 for (auto j: menu_items) {
1247 bool enabled = true;
1249 if ((j.second & NEEDS_FILM) && !_film) {
1253 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1257 if ((j.second & NEEDS_CPL) && !have_cpl) {
1261 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1265 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1269 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1273 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1277 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1281 if ((j.second & NEEDS_DCP_CONTENT) && !have_dcp_content) {
1285 j.first->Enable (enabled);
1289 /** @return true if the operation that called this method
1290 * should continue, false to abort it.
1293 bool maybe_save_film ()
1299 while (_film->dirty()) {
1300 T dialog(_film->name());
1301 switch (dialog.run()) {
1306 _film->write_metadata();
1308 } catch (exception& e) {
1309 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1310 /* Go round again for another try */
1322 bool maybe_save_then_delete_film ()
1324 bool const r = maybe_save_film<T> ();
1331 void add_item (wxMenu* menu, wxString text, int id, int sens)
1333 auto item = menu->Append (id, text);
1334 menu_items.insert (make_pair (item, sens));
1337 void setup_menu (wxMenuBar* m)
1339 _file_menu = new wxMenu;
1340 /* [Shortcut] Ctrl+N:New film */
1341 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1342 /* [Shortcut] Ctrl+O:Open existing film */
1343 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1344 _file_menu->AppendSeparator ();
1345 /* [Shortcut] Ctrl+S:Save current film */
1346 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1347 _file_menu->AppendSeparator ();
1348 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1349 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1350 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1352 _history_position = _file_menu->GetMenuItems().GetCount();
1354 _file_menu->AppendSeparator ();
1355 /* [Shortcut] Ctrl+W:Close current film */
1356 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1359 _file_menu->AppendSeparator ();
1363 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1365 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1368 auto edit = new wxMenu;
1369 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1370 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1371 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1372 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1373 edit->AppendSeparator ();
1374 /* [Shortcut] Shift+Ctrl+A:Select all content */
1375 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1378 add_item(_file_menu, _("&Preferences...\tCtrl-,"), wxID_PREFERENCES, ALWAYS);
1380 edit->AppendSeparator ();
1381 /* [Shortcut] Ctrl+P:Open preferences window */
1382 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1385 auto jobs_menu = new wxMenu;
1386 /* [Shortcut] Ctrl+M:Make DCP */
1387 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1388 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1389 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1390 jobs_menu->AppendSeparator ();
1391 /* [Shortcut] Ctrl+K:Make KDMs */
1392 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1393 /* [Shortcut] Ctrl+D:Make DKDMs */
1394 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1395 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1396 jobs_menu->AppendSeparator ();
1397 /* [Shortcut] Ctrl+E:Export video file */
1398 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1399 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1400 jobs_menu->AppendSeparator ();
1401 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1403 #if defined(DCPOMATIC_OSX)
1404 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1405 #elif defined(DCPOMATIC_WINDOWS)
1406 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1408 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1411 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1413 auto view = new wxMenu;
1414 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1415 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1417 auto tools = new wxMenu;
1418 add_item (tools, _("Version File (VF)..."), ID_tools_version_file, NEEDS_FILM | NEEDS_DCP_CONTENT);
1419 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1420 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1421 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1422 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1423 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1424 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1425 tools->AppendSeparator ();
1426 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1427 tools->AppendSeparator ();
1428 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1430 wxMenu* help = new wxMenu;
1432 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1434 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1436 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1438 m->Append (_file_menu, _("&File"));
1439 m->Append (edit, _("&Edit"));
1440 m->Append (jobs_menu, _("&Jobs"));
1441 m->Append (view, _("&View"));
1442 m->Append (tools, _("&Tools"));
1443 m->Append (help, _("&Help"));
1446 void config_changed (Config::Property what)
1448 /* Instantly save any config changes when using the DCP-o-matic GUI */
1449 if (what == Config::CINEMAS) {
1451 Config::instance()->write_cinemas();
1452 } catch (exception& e) {
1456 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1457 std_to_wx (Config::instance()->cinemas_file().string()).data()
1463 Config::instance()->write_config();
1464 } catch (exception& e) {
1468 _("Could not write to config file at %s. Your changes have not been saved."),
1469 std_to_wx (Config::instance()->cinemas_file().string()).data()
1475 for (int i = 0; i < _history_items; ++i) {
1476 delete _file_menu->Remove (ID_file_history + i);
1479 if (_history_separator) {
1480 _file_menu->Remove (_history_separator);
1482 delete _history_separator;
1483 _history_separator = 0;
1485 int pos = _history_position;
1487 /* Clear out non-existent history items before we re-build the menu */
1488 Config::instance()->clean_history ();
1489 auto history = Config::instance()->history();
1491 if (!history.empty ()) {
1492 _history_separator = _file_menu->InsertSeparator (pos++);
1495 for (size_t i = 0; i < history.size(); ++i) {
1498 s = String::compose ("&%1 %2", i + 1, history[i].string());
1500 s = history[i].string();
1502 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1505 _history_items = history.size ();
1507 dcpomatic_log->set_types (Config::instance()->log_types());
1509 #ifdef DCPOMATIC_GROK
1510 if (what == Config::GROK) {
1511 setup_grok_library_path();
1516 void update_checker_state_changed ()
1518 auto uc = UpdateChecker::instance ();
1520 bool const announce =
1521 _update_news_requested ||
1522 (uc->stable() && Config::instance()->check_for_updates()) ||
1523 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1525 _update_news_requested = false;
1531 if (uc->state() == UpdateChecker::State::YES) {
1532 UpdateDialog dialog(this, uc->stable(), uc->test());
1534 } else if (uc->state() == UpdateChecker::State::FAILED) {
1535 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1537 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1540 _update_news_requested = false;
1543 void start_stop_pressed ()
1545 if (_film_viewer.playing()) {
1546 _film_viewer.stop();
1548 _film_viewer.start();
1552 void timeline_pressed ()
1554 _film_editor->content_panel()->timeline_clicked ();
1559 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1562 void forward_frame ()
1564 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1567 void analytics_message (string title, string html)
1569 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1575 auto s = wx_to_std(_("DCP-o-matic"));
1577 if (_film->directory()) {
1578 s += " - " + _film->directory()->string();
1580 if (_film->dirty()) {
1585 SetTitle (std_to_wx(s));
1588 FilmEditor* _film_editor;
1589 LimitedFrameSplitter* _splitter;
1590 wxPanel* _right_panel;
1591 FilmViewer _film_viewer;
1592 StandardControls* _controls;
1593 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1594 SystemInformationDialog* _system_information_dialog = nullptr;
1595 DCPReferencingDialog* _dcp_referencing_dialog = nullptr;
1596 HintsDialog* _hints_dialog = nullptr;
1597 ServersListDialog* _servers_list_dialog = nullptr;
1598 wxPreferencesEditor* _config_dialog = nullptr;
1599 wx_ptr<KDMDialog> _kdm_dialog;
1600 wx_ptr<DKDMDialog> _dkdm_dialog;
1601 wx_ptr<TemplatesDialog> _templates_dialog;
1602 wxMenu* _file_menu = nullptr;
1603 shared_ptr<Film> _film;
1604 int _history_items = 0;
1605 int _history_position = 0;
1606 wxMenuItem* _history_separator = nullptr;
1607 boost::signals2::scoped_connection _config_changed_connection;
1608 boost::signals2::scoped_connection _analytics_message_connection;
1609 bool _update_news_requested = false;
1610 shared_ptr<Content> _clipboard;
1611 bool _first_shown_called = false;
1615 static const wxCmdLineEntryDesc command_line_description[] = {
1616 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1617 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1618 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1619 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1620 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1621 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1622 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1627 * @brief The magic App class for wxWidgets.
1629 class App : public wxApp
1635 dcpomatic_setup_path_encoding ();
1636 #ifdef DCPOMATIC_LINUX
1643 bool OnInit () override
1647 #if defined(DCPOMATIC_WINDOWS)
1648 if (Config::instance()->win32_console()) {
1651 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1652 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1653 FILE* hf_out = _fdopen(hCrt, "w");
1654 setvbuf(hf_out, NULL, _IONBF, 1);
1657 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1658 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1659 FILE* hf_in = _fdopen(hCrt, "r");
1660 setvbuf(hf_in, NULL, _IONBF, 128);
1663 cout << "DCP-o-matic is starting." << "\n";
1666 wxInitAllImageHandlers ();
1668 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1669 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1671 _splash = maybe_show_splash ();
1673 SetAppName (_("DCP-o-matic"));
1675 if (!wxApp::OnInit()) {
1679 #ifdef DCPOMATIC_LINUX
1680 unsetenv ("UBUNTU_MENUPROXY");
1683 #ifdef DCPOMATIC_OSX
1684 dcpomatic_sleep_seconds (1);
1685 make_foreground_application ();
1688 /* Enable i18n; this will create a Config object
1689 to look for a force-configured language. This Config
1690 object will be wrong, however, because dcpomatic_setup
1691 hasn't yet been called and there aren't any filters etc.
1694 dcpomatic_setup_i18n ();
1696 /* Set things up, including filters etc.
1697 which will now be internationalised correctly.
1701 /* Force the configuration to be re-loaded correctly next
1706 /* We only look out for bad configuration from here on, as before
1707 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1708 incorrect certificate chain validity errors.
1710 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1712 _frame = new DOMFrame (_("DCP-o-matic"));
1713 SetTopWindow (_frame);
1714 _frame->Maximize ();
1717 if (running_32_on_64 ()) {
1718 NagDialog::maybe_nag (
1719 _frame, Config::NAG_32_ON_64,
1720 _("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."),
1726 signal_manager = new wxSignalManager (this);
1727 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1729 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1731 _frame->load_film (_film_to_load);
1732 } catch (exception& e) {
1733 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()));
1737 if (!_film_to_create.empty ()) {
1738 _frame->new_film (_film_to_create, optional<string>());
1739 if (!_content_to_add.empty()) {
1740 for (auto i: content_factory(_content_to_add)) {
1741 _frame->film()->examine_and_add_content(i);
1744 if (!_dcp_to_add.empty ()) {
1745 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1749 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1750 _timer.reset (new wxTimer (this));
1751 _timer->Start (1000);
1753 if (Config::instance()->check_for_updates ()) {
1754 UpdateChecker::instance()->run ();
1757 auto release_notes = find_release_notes(gui_is_dark());
1758 if (release_notes) {
1759 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1764 #ifdef DCPOMATIC_GROK
1765 grk_plugin::setMessengerLogger(new grk_plugin::GrokLogger("[GROK] "));
1766 setup_grok_library_path();
1769 catch (exception& e)
1772 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1778 void OnInitCmdLine (wxCmdLineParser& parser) override
1780 parser.SetDesc (command_line_description);
1781 parser.SetSwitchChars (wxT ("-"));
1784 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1786 if (parser.Found (wxT("version"))) {
1787 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1788 exit (EXIT_SUCCESS);
1791 if (parser.GetParamCount() > 0) {
1792 if (parser.Found (wxT ("new"))) {
1793 _film_to_create = wx_to_std (parser.GetParam (0));
1795 _film_to_load = wx_to_std (parser.GetParam (0));
1800 if (parser.Found (wxT ("content"), &content)) {
1801 _content_to_add = wx_to_std (content);
1805 if (parser.Found (wxT ("dcp"), &dcp)) {
1806 _dcp_to_add = wx_to_std (dcp);
1810 if (parser.Found (wxT("config"), &config)) {
1811 State::override_path = wx_to_std (config);
1817 void report_exception ()
1821 } catch (FileError& e) {
1825 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1826 std_to_wx (e.what()),
1827 std_to_wx (e.file().string().c_str())
1830 } catch (boost::filesystem::filesystem_error& e) {
1834 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1835 std_to_wx (e.what()),
1836 std_to_wx (e.path1().string()),
1837 std_to_wx (e.path2().string())
1840 } catch (exception& e) {
1844 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1845 std_to_wx (e.what ())
1849 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1853 /* An unhandled exception has occurred inside the main event loop */
1854 bool OnExceptionInMainLoop () override
1856 report_exception ();
1857 /* This will terminate the program */
1861 void OnUnhandledException () override
1863 report_exception ();
1866 void idle (wxIdleEvent& ev)
1868 signal_manager->ui_idle ();
1875 EncodeServerFinder::instance()->rethrow ();
1876 } catch (exception& e) {
1877 error_dialog (0, std_to_wx (e.what ()));
1881 void close_splash ()
1889 void config_failed_to_load (Config::LoadFailure what)
1891 report_config_load_failure(_frame, what);
1894 void config_warning (string m)
1896 message_dialog (_frame, std_to_wx(m));
1899 bool config_bad (Config::BadReason reason)
1901 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1902 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1906 auto config = Config::instance();
1908 case Config::BAD_SIGNER_UTF8_STRINGS:
1910 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1913 RecreateChainDialog dialog(
1914 _frame, _("Recreate signing certificates"),
1915 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1916 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1917 "the certificate chain for signing DCPs and KDMs?"),
1919 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1921 return dialog.ShowModal() == wxID_OK;
1923 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1925 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1928 RecreateChainDialog dialog(
1929 _frame, _("Recreate signing certificates"),
1930 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1931 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1932 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1934 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1936 return dialog.ShowModal() == wxID_OK;
1938 case Config::BAD_SIGNER_INCONSISTENT:
1940 RecreateChainDialog dialog(
1941 _frame, _("Recreate signing certificates"),
1942 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1943 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1944 "the certificate chain for signing DCPs and KDMs?"),
1945 _("Close DCP-o-matic")
1947 if (dialog.ShowModal() != wxID_OK) {
1948 exit (EXIT_FAILURE);
1952 case Config::BAD_DECRYPTION_INCONSISTENT:
1954 RecreateChainDialog dialog(
1955 _frame, _("Recreate KDM decryption chain"),
1956 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1957 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1958 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1959 "configuration before continuing."),
1960 _("Close DCP-o-matic")
1962 if (dialog.ShowModal() != wxID_OK) {
1963 exit (EXIT_FAILURE);
1967 case Config::BAD_SIGNER_DN_QUALIFIER:
1969 RecreateChainDialog dialog(
1970 _frame, _("Recreate signing certificates"),
1971 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1972 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
1973 "by a bug in DCP-o-matic which has now been fixed. Do you want to re-create the certificate chain\n"
1974 "for signing DCPs and KDMs?"),
1976 Config::NAG_BAD_SIGNER_DN_QUALIFIER
1978 return dialog.ShowModal() == wxID_OK;
1981 DCPOMATIC_ASSERT (false);
1985 DOMFrame* _frame = nullptr;
1986 wxSplashScreen* _splash = nullptr;
1987 shared_ptr<wxTimer> _timer;
1988 string _film_to_load;
1989 string _film_to_create;
1990 string _content_to_add;