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/load_config_from_zip_dialog.h"
46 #include "wx/nag_dialog.h"
47 #include "wx/paste_dialog.h"
48 #include "wx/recreate_chain_dialog.h"
49 #include "wx/report_problem_dialog.h"
50 #include "wx/save_template_dialog.h"
51 #include "wx/self_dkdm_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 "wx/wx_variant.h"
61 #include "lib/analytics.h"
62 #include "lib/audio_content.h"
63 #include "lib/check_content_job.h"
64 #include "lib/cinema.h"
65 #include "lib/compose.hpp"
66 #include "lib/config.h"
67 #include "lib/constants.h"
68 #include "lib/content.h"
69 #include "lib/content_factory.h"
70 #include "lib/cross.h"
71 #include "lib/cross.h"
72 #include "lib/dcp_content.h"
73 #include "lib/dcpomatic_log.h"
74 #include "lib/dcpomatic_socket.h"
75 #include "lib/dkdm_wrapper.h"
76 #include "lib/email.h"
77 #include "lib/encode_server_finder.h"
78 #include "lib/exceptions.h"
79 #include "lib/ffmpeg_film_encoder.h"
81 #include "lib/font_config.h"
83 #include "lib/grok/context.h"
85 #include "lib/hints.h"
86 #include "lib/job_manager.h"
87 #include "lib/kdm_with_metadata.h"
89 #include "lib/make_dcp.h"
90 #include "lib/release_notes.h"
91 #include "lib/screen.h"
92 #include "lib/send_kdm_email_job.h"
93 #include "lib/signal_manager.h"
94 #include "lib/subtitle_film_encoder.h"
95 #include "lib/text_content.h"
96 #include "lib/transcode_job.h"
97 #include "lib/unzipper.h"
98 #include "lib/update_checker.h"
99 #include "lib/variant.h"
100 #include "lib/version.h"
101 #include "lib/video_content.h"
102 #include <dcp/exceptions.h>
103 #include <dcp/filesystem.h>
104 #include <dcp/raw_convert.h>
105 #include <dcp/scope_guard.h>
106 #include <dcp/warnings.h>
107 LIBDCP_DISABLE_WARNINGS
108 #include <wx/cmdline.h>
109 #include <wx/generic/aboutdlgg.h>
110 #include <wx/preferences.h>
111 #include <wx/splash.h>
112 #include <wx/stdpaths.h>
113 #include <wx/wxhtml.h>
114 LIBDCP_ENABLE_WARNINGS
116 #include <X11/Xlib.h>
119 #include <shellapi.h>
121 #include <boost/algorithm/string.hpp>
122 #include <boost/filesystem.hpp>
125 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
134 using std::dynamic_pointer_cast;
135 using std::exception;
138 using std::make_pair;
139 using std::make_shared;
141 using std::shared_ptr;
145 using boost::optional;
146 using boost::is_any_of;
147 using boost::algorithm::find;
148 #if BOOST_VERSION >= 106100
149 using namespace boost::placeholders;
151 using dcp::raw_convert;
154 class FilmChangedClosingDialog
157 explicit FilmChangedClosingDialog (string name)
160 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
161 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
162 /// project (Film) has been changed since it was last saved.
164 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
167 _dialog.SetYesNoCancelLabels(
168 _("Save film and close"), _("Close without saving film"), _("Don't close")
174 return _dialog.ShowModal();
178 wxMessageDialog _dialog;
182 class FilmChangedDuplicatingDialog
185 explicit FilmChangedDuplicatingDialog (string name)
188 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
189 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
190 /// project (Film) has been changed since it was last saved.
192 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
195 _dialog.SetYesNoCancelLabels(
196 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
202 return _dialog.ShowModal();
206 wxMessageDialog _dialog;
211 #define NEEDS_FILM 0x1
212 #define NOT_DURING_DCP_CREATION 0x2
213 #define NEEDS_CPL 0x4
214 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
215 #define NEEDS_SELECTED_CONTENT 0x10
216 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
217 #define NEEDS_CLIPBOARD 0x40
218 #define NEEDS_ENCRYPTION 0x80
219 #define NEEDS_DCP_CONTENT 0x100
222 map<wxMenuItem*, int> menu_items;
225 ID_file_new = DCPOMATIC_MAIN_MENU,
228 ID_file_save_as_template,
230 ID_file_duplicate_and_open,
232 /* Allow spare IDs after _history for the recent files list */
233 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
238 ID_jobs_make_dcp_batch,
241 ID_jobs_make_self_dkdm,
242 ID_jobs_export_video_file,
243 ID_jobs_export_subtitles,
244 ID_jobs_send_dcp_to_tms,
246 ID_jobs_open_dcp_in_player,
247 ID_view_closed_captions,
248 ID_view_video_waveform,
249 ID_tools_version_file,
251 ID_tools_encoding_servers,
252 ID_tools_manage_templates,
253 ID_tools_check_for_updates,
254 ID_tools_system_information,
255 ID_tools_restore_default_preferences,
256 ID_tools_export_preferences,
257 ID_tools_import_preferences,
258 ID_help_report_a_problem,
259 /* IDs for shortcuts (with no associated menu item) */
269 class LimitedFrameSplitter : public wxSplitterWindow
272 LimitedFrameSplitter(wxWindow* parent)
273 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
275 /* This value doesn't really mean much but we just want to stop double-click on the
276 divider from shrinking the left panel.
278 SetMinimumPaneSize(64);
280 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
283 bool OnSashPositionChange(int new_position) override
285 /* Try to stop the left bit of the splitter getting too small */
286 auto const ok = new_position > _left_panel_minimum_size;
288 Config::instance()->set_main_divider_sash_position(new_position);
294 void sized(wxSizeEvent& ev)
296 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
297 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
298 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
300 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
306 int const _left_panel_minimum_size = 200;
310 class DOMFrame : public wxFrame
313 explicit DOMFrame (wxString const& title)
314 : wxFrame (nullptr, -1, title)
315 /* Use a panel as the only child of the Frame so that we avoid
316 the dark-grey background on Windows.
318 , _splitter(new LimitedFrameSplitter(this))
319 , _right_panel(new wxPanel(_splitter, wxID_ANY))
320 , _film_viewer(_right_panel)
323 auto bar = new wxMenuBar;
327 #ifdef DCPOMATIC_WINDOWS
328 SetIcon (wxIcon (std_to_wx ("id")));
331 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
332 config_changed(Config::OTHER);
334 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_version_file, this), ID_tools_version_file);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_import_preferences, this), ID_tools_import_preferences);
370 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
371 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
373 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
374 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
376 auto left_panel = new wxPanel(_splitter, wxID_ANY);
378 _film_editor = new FilmEditor(left_panel, _film_viewer);
380 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
381 left_sizer->Add(_film_editor, 1, wxEXPAND);
383 left_panel->SetSizerAndFit(left_sizer);
385 _controls = new StandardControls(_right_panel, _film_viewer, true);
386 _controls->set_film(_film_viewer.film());
387 auto job_manager_view = new JobManagerView(_right_panel, false);
389 auto right_sizer = new wxBoxSizer (wxVERTICAL);
390 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
391 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
392 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
394 _right_panel->SetSizer(right_sizer);
396 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
398 set_menu_sensitivity ();
400 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
403 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
405 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
407 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
408 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
412 void add_accelerators ()
415 int accelerators = 7;
417 int accelerators = 6;
419 std::vector<wxAcceleratorEntry> accel(accelerators);
420 /* [Shortcut] Ctrl+A:Add file(s) to the film */
421 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
422 /* [Shortcut] Delete:Remove selected content from film */
423 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
424 /* [Shortcut] Space:Start/stop playback */
425 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
426 /* [Shortcut] Ctrl+T:Open timeline window */
427 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
428 /* [Shortcut] Left arrow:Move back one frame */
429 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
430 /* [Shortcut] Right arrow:Move forward one frame */
431 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
433 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
435 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
436 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
437 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
438 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
439 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
440 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
441 wxAcceleratorTable accel_table (accelerators, accel.data());
442 SetAcceleratorTable (accel_table);
445 void remove_accelerators ()
447 SetAcceleratorTable (wxAcceleratorTable ());
450 void remove_clicked (wxCommandEvent& ev)
452 if (_film_editor->content_panel()->remove_clicked (true)) {
457 void new_film (boost::filesystem::path path, optional<string> template_name)
459 auto film = make_shared<Film>(path);
461 film->use_template (template_name.get());
463 film->set_name (path.filename().generic_string());
464 film->write_metadata ();
468 void load_film (boost::filesystem::path file)
471 auto film = make_shared<Film>(file);
472 auto const notes = film->read_metadata ();
473 film->read_ui_state();
475 if (film->state_version() == 4) {
478 _("This film was created with an old version of DVD-o-matic and may not load correctly "
479 "in this version. Please check the film's settings carefully.")
483 for (auto i: notes) {
484 error_dialog (0, std_to_wx(i));
489 JobManager::instance()->add(make_shared<CheckContentJob>(film));
491 catch (FileNotFoundError& e) {
492 auto const dir = e.file().parent_path();
493 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
495 this, variant::wx::insert_dcpomatic(_("Could not open this folder as a %s project.")),
496 variant::wx::insert_dcpomatic(
497 _("It looks like you are trying to open a DCP. File -> Open is for loading %s projects, not DCPs. "
498 "To import a DCP, create a new project with File -> New and then click the \"Add DCP...\" button."))
501 auto const p = std_to_wx(file.string ());
502 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
505 } catch (std::exception& e) {
506 auto const p = std_to_wx (file.string());
507 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
510 void set_film (shared_ptr<Film> film)
513 _film_viewer.set_film(_film);
514 _film_editor->set_film(_film);
515 _controls->set_film (_film);
516 _video_waveform_dialog.reset();
517 set_menu_sensitivity ();
518 if (_film && _film->directory()) {
519 Config::instance()->add_to_history (_film->directory().get());
522 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
523 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
524 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
525 dcpomatic_log = _film->log ();
530 shared_ptr<Film> film () const {
536 void show (wxShowEvent& ev)
538 if (ev.IsShown() && !_first_shown_called) {
539 _film_editor->first_shown ();
540 _first_shown_called = true;
544 void film_message (string m)
546 message_dialog (this, std_to_wx(m));
549 void film_change (ChangeType type)
551 if (type == ChangeType::DONE) {
552 set_menu_sensitivity ();
558 FilmNameLocationDialog dialog(this, _("New Film"), true);
559 int const r = dialog.ShowModal();
561 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
566 new_film(dialog.path(), dialog.template_name());
567 } catch (boost::filesystem::filesystem_error& e) {
568 #ifdef DCPOMATIC_WINDOWS
569 string bad_chars = "<>:\"/|?*";
570 string const filename = dialog.path().filename().string();
571 string found_bad_chars;
572 for (size_t i = 0; i < bad_chars.length(); ++i) {
573 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
574 found_bad_chars += bad_chars[i];
577 wxString message = _("Could not create folder to store film.");
579 if (!found_bad_chars.empty()) {
580 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
582 message += variant::wx::insert_dcpomatic(_("Please check that you do not have Windows controlled folder access enabled for %s."));
584 error_dialog (this, message, std_to_wx(e.what()));
586 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
595 _("Select film to open"),
596 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
597 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
602 r = dialog.ShowModal();
603 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
604 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
610 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
611 load_film(wx_to_std(dialog.GetPath()));
618 _film->write_metadata ();
619 } catch (exception& e) {
620 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
624 void file_save_as_template ()
626 SaveTemplateDialog dialog(this);
627 if (dialog.ShowModal() == wxID_OK) {
629 Config::instance()->save_template(_film, dialog.name());
630 } catch (exception& e) {
631 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
636 void file_duplicate ()
638 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
640 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
641 auto film = make_shared<Film>(dialog.path());
642 film->copy_from (_film);
643 film->set_name(dialog.path().filename().generic_string());
645 film->write_metadata();
646 } catch (exception& e) {
647 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
652 void file_duplicate_and_open ()
654 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
656 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
657 auto film = make_shared<Film>(dialog.path());
658 film->copy_from (_film);
659 film->set_name(dialog.path().filename().generic_string());
661 film->write_metadata ();
663 } catch (exception& e) {
664 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
671 if (_film && _film->dirty ()) {
672 FilmChangedClosingDialog dialog(_film->name());
673 switch (dialog.run()) {
675 /* Don't save and carry on to close */
678 /* Save and carry on to close */
679 _film->write_metadata ();
687 set_film (shared_ptr<Film>());
690 void file_history (wxCommandEvent& event)
692 auto history = Config::instance()->history ();
693 int n = event.GetId() - ID_file_history;
694 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
695 load_film (history[n]);
701 /* false here allows the close handler to veto the close request */
707 auto const sel = _film_editor->content_panel()->selected();
708 if (sel.size() == 1) {
709 _clipboard = sel.front()->clone();
719 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
720 if (dialog.ShowModal() != wxID_OK) {
724 for (auto i: _film_editor->content_panel()->selected()) {
725 if (dialog.video() && i->video) {
726 DCPOMATIC_ASSERT (_clipboard->video);
727 i->video->take_settings_from (_clipboard->video);
729 if (dialog.audio() && i->audio) {
730 DCPOMATIC_ASSERT (_clipboard->audio);
731 i->audio->take_settings_from (_clipboard->audio);
735 auto j = i->text.begin ();
736 auto k = _clipboard->text.begin ();
737 while (j != i->text.end() && k != _clipboard->text.end()) {
738 (*j)->take_settings_from (*k);
746 void edit_select_all ()
748 _film_editor->content_panel()->select_all();
751 void edit_preferences ()
753 if (!_config_dialog) {
754 _config_dialog = create_full_config_dialog ();
756 _config_dialog->Show (this);
759 void tools_restore_default_preferences ()
761 wxMessageDialog dialog(
763 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
764 _("Restore default preferences"),
765 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
768 if (dialog.ShowModal() == wxID_YES) {
769 Config::restore_defaults ();
773 void tools_export_preferences ()
776 this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_SAVE | wxFD_OVERWRITE_PROMPT, "Preferences", string("dcpomatic_config.zip")
779 if (dialog.ShowModal() == wxID_OK) {
780 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
781 if (boost::filesystem::exists(path)) {
782 boost::system::error_code ec;
783 boost::filesystem::remove(path, ec);
785 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
790 save_all_config_as_zip(path);
794 void tools_import_preferences()
796 FileDialog dialog(this, _("Specify ZIP file"), wxT("ZIP files (*.zip)|*.zip"), wxFD_OPEN, "Preferences");
798 if (!dialog.show()) {
802 auto action = Config::CinemasAction::WRITE_TO_CURRENT_PATH;
804 if (Config::zip_contains_cinemas(dialog.path()) && Config::cinemas_file_from_zip(dialog.path()) != Config::instance()->cinemas_file()) {
805 LoadConfigFromZIPDialog how(this, dialog.path());
806 if (how.ShowModal() == wxID_CANCEL) {
810 action = how.action();
813 Config::instance()->load_from_zip(dialog.path(), action);
816 void jobs_make_dcp ()
821 if (!_film->should_be_enough_disk_space(required, available)) {
822 auto const 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);
823 if (!confirm_dialog (this, message)) {
828 if (Config::instance()->show_hints_before_make_dcp()) {
829 HintsDialog hints(this, _film, false);
830 if (hints.ShowModal() == wxID_CANCEL) {
835 if (_film->encrypted ()) {
836 NagDialog::maybe_nag (
838 Config::NAG_ENCRYPTED_METADATA,
839 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
840 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
841 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
842 "if you want to make KDMs for this film.")
846 /* Remove any existing DCP if the user agrees */
847 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
848 if (dcp::filesystem::exists(dcp_dir)) {
849 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
853 preserve_assets(dcp_dir, _film->assets_path());
854 dcp::filesystem::remove_all(dcp_dir);
858 /* It seems to make sense to auto-save metadata here, since the make DCP may last
859 a long time, and crashes/power failures are moderately likely.
861 _film->write_metadata ();
862 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
863 } catch (BadSettingError& e) {
864 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
865 } catch (std::exception& e) {
866 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
870 void jobs_make_kdms ()
876 _kdm_dialog.reset(this, _film);
877 _kdm_dialog->Show ();
880 void jobs_make_dkdms ()
886 _dkdm_dialog.reset(this, _film);
887 _dkdm_dialog->Show ();
890 /** @return false if we succeeded, true if not */
891 bool send_to_other_tool (int port, function<void()> start, string message)
893 /* i = 0; try to connect via socket
894 i = 1; try again, and then try to start the tool
895 i = 2 onwards; try again.
897 for (int i = 0; i < 8; ++i) {
899 boost::asio::io_service io_service;
900 boost::asio::ip::tcp::resolver resolver (io_service);
901 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
902 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
904 socket.connect (*endpoint_iterator);
905 DCPOMATIC_ASSERT (_film->directory ());
906 socket.write (message.length() + 1);
907 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
912 } catch (exception& e) {
920 dcpomatic_sleep_seconds (1);
926 void jobs_make_dcp_batch ()
932 if (Config::instance()->show_hints_before_make_dcp()) {
933 HintsDialog hints(this, _film, false);
934 if (hints.ShowModal() == wxID_CANCEL) {
939 _film->write_metadata ();
941 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
943 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
945 error_dialog (this, _("Could not find batch converter."));
950 void jobs_open_dcp_in_player ()
956 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
958 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
960 error_dialog (this, _("Could not find player."));
965 void jobs_make_self_dkdm ()
971 SelfDKDMDialog dialog(this, _film);
972 if (dialog.ShowModal() != wxID_OK) {
976 NagDialog::maybe_nag (
978 Config::NAG_DKDM_CONFIG,
980 _("You are making a DKDM which is encrypted by a private key held in"
981 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
982 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
983 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
988 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
990 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
993 auto signer = Config::instance()->signer_chain();
994 if (!signer->valid()) {
995 error_dialog(this, _("The certificate chain for signing is invalid"));
999 optional<dcp::EncryptedKDM> kdm;
1001 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
1002 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
1003 if (dialog.internal()) {
1004 auto dkdms = Config::instance()->dkdms();
1005 dkdms->add(make_shared<DKDM>(kdm));
1006 Config::instance()->changed ();
1008 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
1011 } catch (dcp::NotEncryptedError& e) {
1012 error_dialog (this, _("CPL's content is not encrypted."));
1013 } catch (exception& e) {
1014 error_dialog (this, e.what ());
1016 error_dialog (this, _("An unknown exception occurred."));
1021 void jobs_export_video_file ()
1023 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
1024 if (dialog.ShowModal() != wxID_OK) {
1028 if (dcp::filesystem::exists(dialog.path())) {
1029 bool ok = confirm_dialog(
1031 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1039 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1041 make_shared<FFmpegFilmEncoder>(
1042 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1044 JobManager::instance()->add (job);
1048 void jobs_export_subtitles ()
1050 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1051 if (dialog.ShowModal() != wxID_OK) {
1054 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1056 make_shared<SubtitleFilmEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1058 JobManager::instance()->add(job);
1062 void jobs_send_dcp_to_tms ()
1064 _film->send_dcp_to_tms ();
1067 void jobs_show_dcp ()
1069 DCPOMATIC_ASSERT (_film->directory ());
1070 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1071 error_dialog (this, _("Could not show DCP."));
1075 void view_closed_captions ()
1077 _film_viewer.show_closed_captions ();
1080 void view_video_waveform ()
1082 if (!_video_waveform_dialog) {
1083 _video_waveform_dialog.reset(this, _film, _film_viewer);
1086 _video_waveform_dialog->Show ();
1089 void tools_system_information ()
1091 if (!_system_information_dialog) {
1092 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1095 _system_information_dialog->Show ();
1098 void tools_version_file()
1100 if (_dcp_referencing_dialog) {
1101 _dcp_referencing_dialog->Destroy();
1102 _dcp_referencing_dialog = nullptr;
1105 _dcp_referencing_dialog = new DCPReferencingDialog(this, _film);
1106 _dcp_referencing_dialog->Show();
1111 if (!_hints_dialog) {
1112 _hints_dialog = new HintsDialog (this, _film, true);
1115 _hints_dialog->Show ();
1118 void tools_encoding_servers ()
1120 if (!_servers_list_dialog) {
1121 _servers_list_dialog = new ServersListDialog (this);
1124 _servers_list_dialog->Show ();
1127 void tools_manage_templates ()
1129 if (!_templates_dialog) {
1130 _templates_dialog.reset(this);
1133 _templates_dialog->Show ();
1136 void tools_check_for_updates ()
1138 _update_news_requested = true;
1139 UpdateChecker::instance()->run();
1144 AboutDialog dialog(this);
1148 void help_report_a_problem ()
1150 ReportProblemDialog dialog(this, _film);
1151 if (dialog.ShowModal() == wxID_OK) {
1156 bool should_close ()
1158 if (!JobManager::instance()->work_to_do ()) {
1162 wxMessageDialog dialog(
1164 _("There are unfinished jobs; are you sure you want to quit?"),
1165 _("Unfinished jobs"),
1166 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1169 return dialog.ShowModal() == wxID_YES;
1172 void close (wxCloseEvent& ev)
1174 if (!should_close ()) {
1179 if (_film && _film->dirty ()) {
1180 FilmChangedClosingDialog dialog(_film->name());
1181 switch (dialog.run()) {
1183 /* Don't save and carry on to close */
1186 /* Save and carry on to close */
1187 _film->write_metadata ();
1190 /* Veto the event and stop */
1196 /* We don't want to hear about any more configuration changes, since they
1197 cause the File menu to be altered, which itself will be deleted around
1198 now (without, as far as I can see, any way for us to find out).
1200 _config_changed_connection.disconnect ();
1202 /* Also stop hearing about analytics-related stuff */
1203 _analytics_message_connection.disconnect ();
1208 JobManager::drop ();
1211 void active_jobs_changed()
1213 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1214 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1215 * it by using an idle callback. This feels quite unpleasant.
1217 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1220 void set_menu_sensitivity ()
1222 auto jobs = JobManager::instance()->get ();
1223 auto i = jobs.begin();
1224 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1227 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1228 bool const have_cpl = _film && !_film->cpls().empty ();
1229 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1230 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1231 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1232 vector<shared_ptr<Content>> content;
1234 content = _film->content();
1236 bool const have_dcp_content = std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1237 return static_cast<bool>(dynamic_pointer_cast<const DCPContent>(content));
1238 }) != content.end();
1240 for (auto j: menu_items) {
1242 bool enabled = true;
1244 if ((j.second & NEEDS_FILM) && !_film) {
1248 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1252 if ((j.second & NEEDS_CPL) && !have_cpl) {
1256 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1260 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1264 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1268 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1272 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1276 if ((j.second & NEEDS_DCP_CONTENT) && !have_dcp_content) {
1280 j.first->Enable (enabled);
1284 /** @return true if the operation that called this method
1285 * should continue, false to abort it.
1288 bool maybe_save_film ()
1294 while (_film->dirty()) {
1295 T dialog(_film->name());
1296 switch (dialog.run()) {
1301 _film->write_metadata();
1303 } catch (exception& e) {
1304 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1305 /* Go round again for another try */
1317 bool maybe_save_then_delete_film ()
1319 bool const r = maybe_save_film<T> ();
1326 void add_item (wxMenu* menu, wxString text, int id, int sens)
1328 auto item = menu->Append (id, text);
1329 menu_items.insert (make_pair (item, sens));
1332 void setup_menu (wxMenuBar* m)
1334 _file_menu = new wxMenu;
1335 /* [Shortcut] Ctrl+N:New film */
1336 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1337 /* [Shortcut] Ctrl+O:Open existing film */
1338 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1339 _file_menu->AppendSeparator ();
1340 /* [Shortcut] Ctrl+S:Save current film */
1341 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1342 _file_menu->AppendSeparator ();
1343 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1344 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1345 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1347 _history_position = _file_menu->GetMenuItems().GetCount();
1349 _file_menu->AppendSeparator ();
1350 /* [Shortcut] Ctrl+W:Close current film */
1351 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1354 _file_menu->AppendSeparator ();
1358 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1360 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1363 auto edit = new wxMenu;
1364 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1365 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1366 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1367 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1368 edit->AppendSeparator ();
1369 /* [Shortcut] Shift+Ctrl+A:Select all content */
1370 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1373 add_item(_file_menu, _("&Preferences...\tCtrl-,"), wxID_PREFERENCES, ALWAYS);
1375 edit->AppendSeparator ();
1376 /* [Shortcut] Ctrl+P:Open preferences window */
1377 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1380 auto jobs_menu = new wxMenu;
1381 /* [Shortcut] Ctrl+M:Make DCP */
1382 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1383 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1384 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1385 jobs_menu->AppendSeparator ();
1386 /* [Shortcut] Ctrl+K:Make KDMs */
1387 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1388 /* [Shortcut] Ctrl+D:Make DKDMs */
1389 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1390 add_item(jobs_menu, variant::wx::insert_dcpomatic(_("Make DKDM for %s...")), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1391 jobs_menu->AppendSeparator ();
1392 /* [Shortcut] Ctrl+E:Export video file */
1393 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1394 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1395 jobs_menu->AppendSeparator ();
1396 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1398 #if defined(DCPOMATIC_OSX)
1399 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1400 #elif defined(DCPOMATIC_WINDOWS)
1401 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1403 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1406 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1408 auto view = new wxMenu;
1409 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1410 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1412 auto tools = new wxMenu;
1413 add_item (tools, _("Version File (VF)..."), ID_tools_version_file, NEEDS_FILM | NEEDS_DCP_CONTENT);
1414 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1415 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1416 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1417 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1418 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1419 tools->AppendSeparator ();
1420 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1421 tools->AppendSeparator ();
1422 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1423 add_item (tools, _("Import preferences..."), ID_tools_import_preferences, ALWAYS);
1425 wxMenu* help = new wxMenu;
1427 add_item(help, variant::wx::insert_dcpomatic(_("About %s")), wxID_ABOUT, ALWAYS);
1429 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1431 if (variant::show_report_a_problem()) {
1432 add_item(help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1435 m->Append (_file_menu, _("&File"));
1436 m->Append (edit, _("&Edit"));
1437 m->Append (jobs_menu, _("&Jobs"));
1438 m->Append (view, _("&View"));
1439 m->Append (tools, _("&Tools"));
1440 m->Append (help, _("&Help"));
1443 void config_changed(Config::Property what)
1445 /* Instantly save any config changes when using the DCP-o-matic GUI */
1447 Config::instance()->write_config();
1448 } catch (exception& e) {
1452 _("Could not write to config file at %s. Your changes have not been saved."),
1453 std_to_wx (Config::instance()->cinemas_file().string()).data()
1458 for (int i = 0; i < _history_items; ++i) {
1459 delete _file_menu->Remove (ID_file_history + i);
1462 if (_history_separator) {
1463 _file_menu->Remove (_history_separator);
1465 delete _history_separator;
1466 _history_separator = 0;
1468 int pos = _history_position;
1470 /* Clear out non-existent history items before we re-build the menu */
1471 Config::instance()->clean_history ();
1472 auto history = Config::instance()->history();
1474 if (!history.empty ()) {
1475 _history_separator = _file_menu->InsertSeparator (pos++);
1478 for (size_t i = 0; i < history.size(); ++i) {
1481 s = String::compose ("&%1 %2", i + 1, history[i].string());
1483 s = history[i].string();
1485 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1488 _history_items = history.size ();
1490 dcpomatic_log->set_types (Config::instance()->log_types());
1492 #ifdef DCPOMATIC_GROK
1493 if (what == Config::GROK) {
1494 setup_grok_library_path();
1497 LIBDCP_UNUSED(what);
1501 void update_checker_state_changed ()
1503 auto uc = UpdateChecker::instance ();
1505 bool const announce =
1506 _update_news_requested ||
1507 (uc->stable() && Config::instance()->check_for_updates()) ||
1508 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1510 _update_news_requested = false;
1516 if (uc->state() == UpdateChecker::State::YES) {
1517 UpdateDialog dialog(this, uc->stable(), uc->test());
1519 } else if (uc->state() == UpdateChecker::State::FAILED) {
1520 error_dialog(this, variant::wx::insert_dcpomatic(_("The %s download server could not be contacted.")));
1522 error_dialog(this, variant::wx::insert_dcpomatic(_("There are no new versions of %s available.")));
1525 _update_news_requested = false;
1528 void start_stop_pressed ()
1530 if (_film_viewer.playing()) {
1531 _film_viewer.stop();
1533 _film_viewer.start();
1537 void timeline_pressed ()
1539 _film_editor->content_panel()->timeline_clicked ();
1544 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1547 void forward_frame ()
1549 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1552 void analytics_message (string title, string html)
1554 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1560 auto s = variant::dcpomatic();
1562 if (_film->directory()) {
1563 s += " - " + _film->directory()->string();
1565 if (_film->dirty()) {
1570 SetTitle (std_to_wx(s));
1573 FilmEditor* _film_editor;
1574 LimitedFrameSplitter* _splitter;
1575 wxPanel* _right_panel;
1576 FilmViewer _film_viewer;
1577 StandardControls* _controls;
1578 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1579 SystemInformationDialog* _system_information_dialog = nullptr;
1580 DCPReferencingDialog* _dcp_referencing_dialog = nullptr;
1581 HintsDialog* _hints_dialog = nullptr;
1582 ServersListDialog* _servers_list_dialog = nullptr;
1583 wxPreferencesEditor* _config_dialog = nullptr;
1584 wx_ptr<KDMDialog> _kdm_dialog;
1585 wx_ptr<DKDMDialog> _dkdm_dialog;
1586 wx_ptr<TemplatesDialog> _templates_dialog;
1587 wxMenu* _file_menu = nullptr;
1588 shared_ptr<Film> _film;
1589 int _history_items = 0;
1590 int _history_position = 0;
1591 wxMenuItem* _history_separator = nullptr;
1592 boost::signals2::scoped_connection _config_changed_connection;
1593 boost::signals2::scoped_connection _analytics_message_connection;
1594 bool _update_news_requested = false;
1595 shared_ptr<Content> _clipboard;
1596 bool _first_shown_called = false;
1600 static const wxCmdLineEntryDesc command_line_description[] = {
1601 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1602 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1603 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1604 { wxCMD_LINE_SWITCH, "v", "version", "show version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1605 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1606 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1607 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1612 * @brief The magic App class for wxWidgets.
1614 class App : public wxApp
1620 dcpomatic_setup_path_encoding ();
1621 #ifdef DCPOMATIC_LINUX
1628 bool OnInit () override
1632 #if defined(DCPOMATIC_WINDOWS)
1633 if (Config::instance()->win32_console()) {
1636 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1637 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1638 FILE* hf_out = _fdopen(hCrt, "w");
1639 setvbuf(hf_out, NULL, _IONBF, 1);
1642 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1643 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1644 FILE* hf_in = _fdopen(hCrt, "r");
1645 setvbuf(hf_in, NULL, _IONBF, 128);
1648 cout << variant::insert_dcpomatic("%1 is starting.") << "\n";
1651 wxInitAllImageHandlers ();
1653 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1654 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1656 _splash = maybe_show_splash ();
1658 SetAppName(variant::wx::dcpomatic());
1660 if (!wxApp::OnInit()) {
1664 #ifdef DCPOMATIC_LINUX
1665 unsetenv ("UBUNTU_MENUPROXY");
1668 #ifdef DCPOMATIC_OSX
1669 dcpomatic_sleep_seconds (1);
1670 make_foreground_application ();
1673 /* Enable i18n; this will create a Config object
1674 to look for a force-configured language. This Config
1675 object will be wrong, however, because dcpomatic_setup
1676 hasn't yet been called and there aren't any filters etc.
1679 dcpomatic_setup_i18n ();
1681 /* Set things up, including filters etc.
1682 which will now be internationalised correctly.
1686 /* Force the configuration to be re-loaded correctly next
1691 /* We only look out for bad configuration from here on, as before
1692 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1693 incorrect certificate chain validity errors.
1695 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1697 _frame = new DOMFrame(variant::wx::dcpomatic());
1698 SetTopWindow (_frame);
1699 _frame->Maximize ();
1702 if (running_32_on_64 ()) {
1703 NagDialog::maybe_nag (
1704 _frame, Config::NAG_32_ON_64,
1706 _("You are running the 32-bit version of %s on a 64-bit version of Windows. "
1707 "This will limit the memory available to %s and may cause errors. You are "
1708 "strongly advised to install the 64-bit version of %s."),
1709 variant::wx::dcpomatic(),
1710 variant::wx::dcpomatic(),
1711 variant::wx::dcpomatic()
1718 signal_manager = new wxSignalManager (this);
1719 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1721 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1723 _frame->load_film (_film_to_load);
1724 } catch (exception& e) {
1725 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()));
1729 if (!_film_to_create.empty ()) {
1730 _frame->new_film (_film_to_create, optional<string>());
1731 if (!_content_to_add.empty()) {
1732 for (auto i: content_factory(_content_to_add)) {
1733 _frame->film()->examine_and_add_content(i);
1736 if (!_dcp_to_add.empty ()) {
1737 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1741 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1742 _timer.reset (new wxTimer (this));
1743 _timer->Start (1000);
1745 if (Config::instance()->check_for_updates ()) {
1746 UpdateChecker::instance()->run ();
1749 auto release_notes = find_release_notes(gui_is_dark());
1750 if (release_notes) {
1751 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1756 #ifdef DCPOMATIC_GROK
1757 grk_plugin::setMessengerLogger(new grk_plugin::GrokLogger("[GROK] "));
1758 setup_grok_library_path();
1761 catch (exception& e)
1764 error_dialog(nullptr, variant::wx::insert_dcpomatic(_("%s could not start.")), std_to_wx(e.what()));
1770 void OnInitCmdLine (wxCmdLineParser& parser) override
1772 parser.SetDesc (command_line_description);
1773 parser.SetSwitchChars (wxT ("-"));
1776 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1778 if (parser.Found (wxT("version"))) {
1779 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1780 exit (EXIT_SUCCESS);
1783 if (parser.GetParamCount() > 0) {
1784 if (parser.Found (wxT ("new"))) {
1785 _film_to_create = wx_to_std (parser.GetParam (0));
1787 _film_to_load = wx_to_std (parser.GetParam (0));
1792 if (parser.Found (wxT ("content"), &content)) {
1793 _content_to_add = wx_to_std (content);
1797 if (parser.Found (wxT ("dcp"), &dcp)) {
1798 _dcp_to_add = wx_to_std (dcp);
1802 if (parser.Found (wxT("config"), &config)) {
1803 State::override_path = wx_to_std (config);
1809 void report_exception ()
1813 } catch (FileError& e) {
1817 _("An exception occurred: %s (%s)\n\n%s"),
1818 std_to_wx(e.what()),
1819 std_to_wx(e.file().string().c_str()),
1820 wx::report_problem()
1823 } catch (boost::filesystem::filesystem_error& e) {
1827 _("An exception occurred: %s (%s) (%s)\n\n%s"),
1828 std_to_wx(e.what()),
1829 std_to_wx(e.path1().string()),
1830 std_to_wx(e.path2().string()),
1831 wx::report_problem()
1834 } catch (exception& e) {
1838 _("An exception occurred: %s.\n\n%s"),
1839 std_to_wx(e.what()),
1840 wx::report_problem()
1844 error_dialog(nullptr, _("An unknown exception occurred.") + " " + wx::report_problem());
1848 /* An unhandled exception has occurred inside the main event loop */
1849 bool OnExceptionInMainLoop () override
1851 report_exception ();
1852 /* This will terminate the program */
1856 void OnUnhandledException () override
1858 report_exception ();
1861 void idle (wxIdleEvent& ev)
1863 signal_manager->ui_idle ();
1870 EncodeServerFinder::instance()->rethrow ();
1871 } catch (exception& e) {
1872 error_dialog (0, std_to_wx (e.what ()));
1876 void close_splash ()
1884 void config_failed_to_load (Config::LoadFailure what)
1886 report_config_load_failure(_frame, what);
1889 void config_warning (string m)
1891 message_dialog (_frame, std_to_wx(m));
1894 bool config_bad (Config::BadReason reason)
1896 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1897 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1901 auto config = Config::instance();
1903 case Config::BAD_SIGNER_UTF8_STRINGS:
1905 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1908 RecreateChainDialog dialog(
1909 _frame, _("Recreate signing certificates"),
1910 variant::wx::insert_dcpomatic(
1911 _("The certificate chain that %s uses for signing DCPs and KDMs contains a small error\n"
1912 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1913 "the certificate chain for signing DCPs and KDMs?")
1916 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1918 return dialog.ShowModal() == wxID_OK;
1920 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1922 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1925 RecreateChainDialog dialog(
1926 _frame, _("Recreate signing certificates"),
1927 variant::wx::insert_dcpomatic(
1928 _("The certificate chain that %s uses for signing DCPs and KDMs has a validity period\n"
1929 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1930 "Do you want to re-create the certificate chain for signing DCPs and KDMs?")
1933 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1935 return dialog.ShowModal() == wxID_OK;
1937 case Config::BAD_SIGNER_INCONSISTENT:
1939 RecreateChainDialog dialog(
1940 _frame, _("Recreate signing certificates"),
1942 _("The certificate chain that %s uses for signing DCPs and KDMs is inconsistent and\n"
1943 "cannot be used. %s cannot start unless you re-create it. Do you want to re-create\n"
1944 "the certificate chain for signing DCPs and KDMs?"),
1945 variant::wx::dcpomatic(),
1946 variant::wx::dcpomatic()
1948 variant::wx::insert_dcpomatic(_("Close %s"))
1950 if (dialog.ShowModal() != wxID_OK) {
1951 exit (EXIT_FAILURE);
1955 case Config::BAD_DECRYPTION_INCONSISTENT:
1957 RecreateChainDialog dialog(
1958 _frame, _("Recreate KDM decryption chain"),
1960 _("The certificate chain that %s uses for decrypting KDMs is inconsistent and\n"
1961 "cannot be used. %s cannot start unless you re-create it. Do you want to re-create\n"
1962 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1963 "configuration before continuing."),
1964 variant::wx::dcpomatic(),
1965 variant::wx::dcpomatic()
1967 variant::wx::insert_dcpomatic(_("Close %s"))
1969 if (dialog.ShowModal() != wxID_OK) {
1970 exit (EXIT_FAILURE);
1974 case Config::BAD_SIGNER_DN_QUALIFIER:
1976 RecreateChainDialog dialog(
1977 _frame, _("Recreate signing certificates"),
1979 _("The certificate chain that %s uses for signing DCPs and KDMs contains a small error\n"
1980 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
1981 "by a bug in %s which has now been fixed. Do you want to re-create the certificate chain\n"
1982 "for signing DCPs and KDMs?"),
1983 variant::wx::dcpomatic(),
1984 variant::wx::dcpomatic()
1987 Config::NAG_BAD_SIGNER_DN_QUALIFIER
1989 return dialog.ShowModal() == wxID_OK;
1992 DCPOMATIC_ASSERT (false);
1996 DOMFrame* _frame = nullptr;
1997 wxSplashScreen* _splash = nullptr;
1998 shared_ptr<wxTimer> _timer;
1999 string _film_to_load;
2000 string _film_to_create;
2001 string _content_to_add;