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 ();
469 if (film->state_version() == 4) {
472 _("This film was created with an old version of DVD-o-matic and may not load correctly "
473 "in this version. Please check the film's settings carefully.")
477 for (auto i: notes) {
478 error_dialog (0, std_to_wx(i));
483 JobManager::instance()->add(make_shared<CheckContentJob>(film));
485 catch (FileNotFoundError& e) {
486 auto const dir = e.file().parent_path();
487 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
489 this, _("Could not open this folder as a DCP-o-matic project."),
490 _("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.")
493 auto const p = std_to_wx(file.string ());
494 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
497 } catch (std::exception& e) {
498 auto const p = std_to_wx (file.string());
499 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
502 void set_film (shared_ptr<Film> film)
505 _film_viewer.set_film(_film);
506 _film_editor->set_film(_film);
507 _controls->set_film (_film);
508 _video_waveform_dialog.reset();
509 set_menu_sensitivity ();
510 if (_film && _film->directory()) {
511 Config::instance()->add_to_history (_film->directory().get());
514 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
515 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
516 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
517 dcpomatic_log = _film->log ();
522 shared_ptr<Film> film () const {
528 void show (wxShowEvent& ev)
530 if (ev.IsShown() && !_first_shown_called) {
531 _film_editor->first_shown ();
532 _first_shown_called = true;
536 void film_message (string m)
538 message_dialog (this, std_to_wx(m));
541 void film_change (ChangeType type)
543 if (type == ChangeType::DONE) {
544 set_menu_sensitivity ();
550 FilmNameLocationDialog dialog(this, _("New Film"), true);
551 int const r = dialog.ShowModal();
553 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
558 new_film(dialog.path(), dialog.template_name());
559 } catch (boost::filesystem::filesystem_error& e) {
560 #ifdef DCPOMATIC_WINDOWS
561 string bad_chars = "<>:\"/|?*";
562 string const filename = dialog.path().filename().string();
563 string found_bad_chars;
564 for (size_t i = 0; i < bad_chars.length(); ++i) {
565 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
566 found_bad_chars += bad_chars[i];
569 wxString message = _("Could not create folder to store film.");
571 if (!found_bad_chars.empty()) {
572 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
574 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
576 error_dialog (this, message, std_to_wx(e.what()));
578 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
587 _("Select film to open"),
588 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
589 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
594 r = dialog.ShowModal();
595 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
596 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
602 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
603 load_film(wx_to_std(dialog.GetPath()));
610 _film->write_metadata ();
611 } catch (exception& e) {
612 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
616 void file_save_as_template ()
618 SaveTemplateDialog dialog(this);
619 if (dialog.ShowModal() == wxID_OK) {
621 Config::instance()->save_template(_film, dialog.name());
622 } catch (exception& e) {
623 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
628 void file_duplicate ()
630 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
632 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
633 auto film = make_shared<Film>(dialog.path());
634 film->copy_from (_film);
635 film->set_name(dialog.path().filename().generic_string());
637 film->write_metadata();
638 } catch (exception& e) {
639 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
644 void file_duplicate_and_open ()
646 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
648 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
649 auto film = make_shared<Film>(dialog.path());
650 film->copy_from (_film);
651 film->set_name(dialog.path().filename().generic_string());
653 film->write_metadata ();
655 } catch (exception& e) {
656 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
663 if (_film && _film->dirty ()) {
664 FilmChangedClosingDialog dialog(_film->name());
665 switch (dialog.run()) {
667 /* Don't save and carry on to close */
670 /* Save and carry on to close */
671 _film->write_metadata ();
679 set_film (shared_ptr<Film>());
682 void file_history (wxCommandEvent& event)
684 auto history = Config::instance()->history ();
685 int n = event.GetId() - ID_file_history;
686 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
687 load_film (history[n]);
693 /* false here allows the close handler to veto the close request */
699 auto const sel = _film_editor->content_panel()->selected();
700 if (sel.size() == 1) {
701 _clipboard = sel.front()->clone();
711 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
712 if (dialog.ShowModal() != wxID_OK) {
716 for (auto i: _film_editor->content_panel()->selected()) {
717 if (dialog.video() && i->video) {
718 DCPOMATIC_ASSERT (_clipboard->video);
719 i->video->take_settings_from (_clipboard->video);
721 if (dialog.audio() && i->audio) {
722 DCPOMATIC_ASSERT (_clipboard->audio);
723 i->audio->take_settings_from (_clipboard->audio);
727 auto j = i->text.begin ();
728 auto k = _clipboard->text.begin ();
729 while (j != i->text.end() && k != _clipboard->text.end()) {
730 (*j)->take_settings_from (*k);
738 void edit_select_all ()
740 _film_editor->content_panel()->select_all();
743 void edit_preferences ()
745 if (!_config_dialog) {
746 _config_dialog = create_full_config_dialog ();
748 _config_dialog->Show (this);
751 void tools_restore_default_preferences ()
753 wxMessageDialog dialog(
755 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
756 _("Restore default preferences"),
757 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
760 if (dialog.ShowModal() == wxID_YES) {
761 Config::restore_defaults ();
765 void tools_export_preferences ()
768 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
769 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
772 if (dialog.ShowModal() == wxID_OK) {
773 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
774 if (boost::filesystem::exists(path)) {
775 boost::system::error_code ec;
776 boost::filesystem::remove(path, ec);
778 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
783 save_all_config_as_zip(path);
787 void jobs_make_dcp ()
793 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
796 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);
798 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);
800 if (!confirm_dialog (this, message)) {
805 if (Config::instance()->show_hints_before_make_dcp()) {
806 HintsDialog hints(this, _film, false);
807 if (hints.ShowModal() == wxID_CANCEL) {
812 if (_film->encrypted ()) {
813 NagDialog::maybe_nag (
815 Config::NAG_ENCRYPTED_METADATA,
816 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
817 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
818 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
819 "if you want to make KDMs for this film.")
823 /* Remove any existing DCP if the user agrees */
824 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
825 if (dcp::filesystem::exists(dcp_dir)) {
826 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
829 dcp::filesystem::remove_all(dcp_dir);
833 /* It seems to make sense to auto-save metadata here, since the make DCP may last
834 a long time, and crashes/power failures are moderately likely.
836 _film->write_metadata ();
837 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
838 } catch (BadSettingError& e) {
839 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
840 } catch (std::exception& e) {
841 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
845 void jobs_make_kdms ()
851 _kdm_dialog.reset(this, _film);
852 _kdm_dialog->Show ();
855 void jobs_make_dkdms ()
861 _dkdm_dialog.reset(this, _film);
862 _dkdm_dialog->Show ();
865 /** @return false if we succeeded, true if not */
866 bool send_to_other_tool (int port, function<void()> start, string message)
868 /* i = 0; try to connect via socket
869 i = 1; try again, and then try to start the tool
870 i = 2 onwards; try again.
872 for (int i = 0; i < 8; ++i) {
874 boost::asio::io_service io_service;
875 boost::asio::ip::tcp::resolver resolver (io_service);
876 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
877 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
879 socket.connect (*endpoint_iterator);
880 DCPOMATIC_ASSERT (_film->directory ());
881 socket.write (message.length() + 1);
882 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
887 } catch (exception& e) {
895 dcpomatic_sleep_seconds (1);
901 void jobs_make_dcp_batch ()
907 if (Config::instance()->show_hints_before_make_dcp()) {
908 HintsDialog hints(this, _film, false);
909 if (hints.ShowModal() == wxID_CANCEL) {
914 _film->write_metadata ();
916 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
918 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
920 error_dialog (this, _("Could not find batch converter."));
925 void jobs_open_dcp_in_player ()
931 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
933 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
935 error_dialog (this, _("Could not find player."));
940 void jobs_make_self_dkdm ()
946 SelfDKDMDialog dialog(this, _film);
947 if (dialog.ShowModal() != wxID_OK) {
951 NagDialog::maybe_nag (
953 Config::NAG_DKDM_CONFIG,
955 _("You are making a DKDM which is encrypted by a private key held in"
956 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
957 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
958 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
963 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
965 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
968 auto signer = Config::instance()->signer_chain();
969 if (!signer->valid()) {
970 error_dialog(this, _("The certificate chain for signing is invalid"));
974 optional<dcp::EncryptedKDM> kdm;
976 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
977 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
978 if (dialog.internal()) {
979 auto dkdms = Config::instance()->dkdms();
980 dkdms->add(make_shared<DKDM>(kdm));
981 Config::instance()->changed ();
983 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
986 } catch (dcp::NotEncryptedError& e) {
987 error_dialog (this, _("CPL's content is not encrypted."));
988 } catch (exception& e) {
989 error_dialog (this, e.what ());
991 error_dialog (this, _("An unknown exception occurred."));
996 void jobs_export_video_file ()
998 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
999 if (dialog.ShowModal() != wxID_OK) {
1003 if (dcp::filesystem::exists(dialog.path())) {
1004 bool ok = confirm_dialog(
1006 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1014 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1016 make_shared<FFmpegEncoder> (
1017 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1019 JobManager::instance()->add (job);
1023 void jobs_export_subtitles ()
1025 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1026 if (dialog.ShowModal() != wxID_OK) {
1029 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1031 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1033 JobManager::instance()->add(job);
1037 void jobs_send_dcp_to_tms ()
1039 _film->send_dcp_to_tms ();
1042 void jobs_show_dcp ()
1044 DCPOMATIC_ASSERT (_film->directory ());
1045 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1046 error_dialog (this, _("Could not show DCP."));
1050 void view_closed_captions ()
1052 _film_viewer.show_closed_captions ();
1055 void view_video_waveform ()
1057 if (!_video_waveform_dialog) {
1058 _video_waveform_dialog.reset(this, _film, _film_viewer);
1061 _video_waveform_dialog->Show ();
1064 void tools_system_information ()
1066 if (!_system_information_dialog) {
1067 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1070 _system_information_dialog->Show ();
1073 void tools_version_file()
1075 if (_dcp_referencing_dialog) {
1076 _dcp_referencing_dialog->Destroy();
1077 _dcp_referencing_dialog = nullptr;
1080 _dcp_referencing_dialog = new DCPReferencingDialog(this, _film);
1081 _dcp_referencing_dialog->Show();
1086 if (!_hints_dialog) {
1087 _hints_dialog = new HintsDialog (this, _film, true);
1090 _hints_dialog->Show ();
1093 void tools_encoding_servers ()
1095 if (!_servers_list_dialog) {
1096 _servers_list_dialog = new ServersListDialog (this);
1099 _servers_list_dialog->Show ();
1102 void tools_manage_templates ()
1104 if (!_templates_dialog) {
1105 _templates_dialog.reset(this);
1108 _templates_dialog->Show ();
1111 void tools_check_for_updates ()
1113 _update_news_requested = true;
1114 UpdateChecker::instance()->run();
1117 void tools_send_translations ()
1119 SendI18NDialog dialog(this);
1120 if (dialog.ShowModal() != wxID_OK) {
1125 body += dialog.name() + "\n";
1126 body += dialog.language() + "\n";
1127 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1129 auto translations = I18NHook::translations ();
1130 for (auto i: translations) {
1131 body += i.first + "\n" + i.second + "\n\n";
1133 if (dialog.email().find("@") == string::npos) {
1134 error_dialog (this, _("You must enter a valid email address when sending translations, "
1135 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1137 Emailer emailer(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1139 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1140 } catch (NetworkError& e) {
1141 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1148 AboutDialog dialog(this);
1152 void help_report_a_problem ()
1154 ReportProblemDialog dialog(this, _film);
1155 if (dialog.ShowModal() == wxID_OK) {
1160 bool should_close ()
1162 if (!JobManager::instance()->work_to_do ()) {
1166 wxMessageDialog dialog(
1168 _("There are unfinished jobs; are you sure you want to quit?"),
1169 _("Unfinished jobs"),
1170 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1173 return dialog.ShowModal() == wxID_YES;
1176 void close (wxCloseEvent& ev)
1178 if (!should_close ()) {
1183 if (_film && _film->dirty ()) {
1184 FilmChangedClosingDialog dialog(_film->name());
1185 switch (dialog.run()) {
1187 /* Don't save and carry on to close */
1190 /* Save and carry on to close */
1191 _film->write_metadata ();
1194 /* Veto the event and stop */
1200 /* We don't want to hear about any more configuration changes, since they
1201 cause the File menu to be altered, which itself will be deleted around
1202 now (without, as far as I can see, any way for us to find out).
1204 _config_changed_connection.disconnect ();
1206 /* Also stop hearing about analytics-related stuff */
1207 _analytics_message_connection.disconnect ();
1212 JobManager::drop ();
1215 void active_jobs_changed()
1217 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1218 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1219 * it by using an idle callback. This feels quite unpleasant.
1221 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1224 void set_menu_sensitivity ()
1226 auto jobs = JobManager::instance()->get ();
1227 auto i = jobs.begin();
1228 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1231 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1232 bool const have_cpl = _film && !_film->cpls().empty ();
1233 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1234 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1235 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1236 vector<shared_ptr<Content>> content;
1238 content = _film->content();
1240 bool const have_dcp_content = std::find_if(content.begin(), content.end(), [](shared_ptr<const Content> content) {
1241 return static_cast<bool>(dynamic_pointer_cast<const DCPContent>(content));
1242 }) != content.end();
1244 for (auto j: menu_items) {
1246 bool enabled = true;
1248 if ((j.second & NEEDS_FILM) && !_film) {
1252 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1256 if ((j.second & NEEDS_CPL) && !have_cpl) {
1260 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1264 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1268 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1272 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1276 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1280 if ((j.second & NEEDS_DCP_CONTENT) && !have_dcp_content) {
1284 j.first->Enable (enabled);
1288 /** @return true if the operation that called this method
1289 * should continue, false to abort it.
1292 bool maybe_save_film ()
1298 while (_film->dirty()) {
1299 T dialog(_film->name());
1300 switch (dialog.run()) {
1305 _film->write_metadata();
1307 } catch (exception& e) {
1308 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1309 /* Go round again for another try */
1321 bool maybe_save_then_delete_film ()
1323 bool const r = maybe_save_film<T> ();
1330 void add_item (wxMenu* menu, wxString text, int id, int sens)
1332 auto item = menu->Append (id, text);
1333 menu_items.insert (make_pair (item, sens));
1336 void setup_menu (wxMenuBar* m)
1338 _file_menu = new wxMenu;
1339 /* [Shortcut] Ctrl+N:New film */
1340 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1341 /* [Shortcut] Ctrl+O:Open existing film */
1342 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1343 _file_menu->AppendSeparator ();
1344 /* [Shortcut] Ctrl+S:Save current film */
1345 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1346 _file_menu->AppendSeparator ();
1347 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1348 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1349 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1351 _history_position = _file_menu->GetMenuItems().GetCount();
1353 _file_menu->AppendSeparator ();
1354 /* [Shortcut] Ctrl+W:Close current film */
1355 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1358 _file_menu->AppendSeparator ();
1362 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1364 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1367 auto edit = new wxMenu;
1368 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1369 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1370 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1371 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1372 edit->AppendSeparator ();
1373 /* [Shortcut] Shift+Ctrl+A:Select all content */
1374 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1377 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1379 edit->AppendSeparator ();
1380 /* [Shortcut] Ctrl+P:Open preferences window */
1381 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1384 auto jobs_menu = new wxMenu;
1385 /* [Shortcut] Ctrl+M:Make DCP */
1386 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1387 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1388 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1389 jobs_menu->AppendSeparator ();
1390 /* [Shortcut] Ctrl+K:Make KDMs */
1391 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1392 /* [Shortcut] Ctrl+D:Make DKDMs */
1393 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1394 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1395 jobs_menu->AppendSeparator ();
1396 /* [Shortcut] Ctrl+E:Export video file */
1397 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1398 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1399 jobs_menu->AppendSeparator ();
1400 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1402 #if defined(DCPOMATIC_OSX)
1403 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1404 #elif defined(DCPOMATIC_WINDOWS)
1405 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1407 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1410 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1412 auto view = new wxMenu;
1413 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1414 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1416 auto tools = new wxMenu;
1417 add_item (tools, _("Version File (VF)..."), ID_tools_version_file, NEEDS_FILM | NEEDS_DCP_CONTENT);
1418 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1419 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1420 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1421 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1422 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1423 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1424 tools->AppendSeparator ();
1425 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1426 tools->AppendSeparator ();
1427 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1429 wxMenu* help = new wxMenu;
1431 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1433 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1435 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1437 m->Append (_file_menu, _("&File"));
1438 m->Append (edit, _("&Edit"));
1439 m->Append (jobs_menu, _("&Jobs"));
1440 m->Append (view, _("&View"));
1441 m->Append (tools, _("&Tools"));
1442 m->Append (help, _("&Help"));
1445 void config_changed (Config::Property what)
1447 /* Instantly save any config changes when using the DCP-o-matic GUI */
1448 if (what == Config::CINEMAS) {
1450 Config::instance()->write_cinemas();
1451 } catch (exception& e) {
1455 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1456 std_to_wx (Config::instance()->cinemas_file().string()).data()
1462 Config::instance()->write_config();
1463 } catch (exception& e) {
1467 _("Could not write to config file at %s. Your changes have not been saved."),
1468 std_to_wx (Config::instance()->cinemas_file().string()).data()
1474 for (int i = 0; i < _history_items; ++i) {
1475 delete _file_menu->Remove (ID_file_history + i);
1478 if (_history_separator) {
1479 _file_menu->Remove (_history_separator);
1481 delete _history_separator;
1482 _history_separator = 0;
1484 int pos = _history_position;
1486 /* Clear out non-existent history items before we re-build the menu */
1487 Config::instance()->clean_history ();
1488 auto history = Config::instance()->history();
1490 if (!history.empty ()) {
1491 _history_separator = _file_menu->InsertSeparator (pos++);
1494 for (size_t i = 0; i < history.size(); ++i) {
1497 s = String::compose ("&%1 %2", i + 1, history[i].string());
1499 s = history[i].string();
1501 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1504 _history_items = history.size ();
1506 dcpomatic_log->set_types (Config::instance()->log_types());
1508 #ifdef DCPOMATIC_GROK
1509 if (what == Config::GROK) {
1510 setup_grok_library_path();
1515 void update_checker_state_changed ()
1517 auto uc = UpdateChecker::instance ();
1519 bool const announce =
1520 _update_news_requested ||
1521 (uc->stable() && Config::instance()->check_for_updates()) ||
1522 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1524 _update_news_requested = false;
1530 if (uc->state() == UpdateChecker::State::YES) {
1531 UpdateDialog dialog(this, uc->stable(), uc->test());
1533 } else if (uc->state() == UpdateChecker::State::FAILED) {
1534 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1536 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1539 _update_news_requested = false;
1542 void start_stop_pressed ()
1544 if (_film_viewer.playing()) {
1545 _film_viewer.stop();
1547 _film_viewer.start();
1551 void timeline_pressed ()
1553 _film_editor->content_panel()->timeline_clicked ();
1558 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1561 void forward_frame ()
1563 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1566 void analytics_message (string title, string html)
1568 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1574 auto s = wx_to_std(_("DCP-o-matic"));
1576 if (_film->directory()) {
1577 s += " - " + _film->directory()->string();
1579 if (_film->dirty()) {
1584 SetTitle (std_to_wx(s));
1587 FilmEditor* _film_editor;
1588 LimitedFrameSplitter* _splitter;
1589 wxPanel* _right_panel;
1590 FilmViewer _film_viewer;
1591 StandardControls* _controls;
1592 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1593 SystemInformationDialog* _system_information_dialog = nullptr;
1594 DCPReferencingDialog* _dcp_referencing_dialog = nullptr;
1595 HintsDialog* _hints_dialog = nullptr;
1596 ServersListDialog* _servers_list_dialog = nullptr;
1597 wxPreferencesEditor* _config_dialog = nullptr;
1598 wx_ptr<KDMDialog> _kdm_dialog;
1599 wx_ptr<DKDMDialog> _dkdm_dialog;
1600 wx_ptr<TemplatesDialog> _templates_dialog;
1601 wxMenu* _file_menu = nullptr;
1602 shared_ptr<Film> _film;
1603 int _history_items = 0;
1604 int _history_position = 0;
1605 wxMenuItem* _history_separator = nullptr;
1606 boost::signals2::scoped_connection _config_changed_connection;
1607 boost::signals2::scoped_connection _analytics_message_connection;
1608 bool _update_news_requested = false;
1609 shared_ptr<Content> _clipboard;
1610 bool _first_shown_called = false;
1614 static const wxCmdLineEntryDesc command_line_description[] = {
1615 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1616 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1617 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1618 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1619 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1620 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1621 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1626 * @brief The magic App class for wxWidgets.
1628 class App : public wxApp
1634 dcpomatic_setup_path_encoding ();
1635 #ifdef DCPOMATIC_LINUX
1642 bool OnInit () override
1646 #if defined(DCPOMATIC_WINDOWS)
1647 if (Config::instance()->win32_console()) {
1650 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1651 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1652 FILE* hf_out = _fdopen(hCrt, "w");
1653 setvbuf(hf_out, NULL, _IONBF, 1);
1656 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1657 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1658 FILE* hf_in = _fdopen(hCrt, "r");
1659 setvbuf(hf_in, NULL, _IONBF, 128);
1662 cout << "DCP-o-matic is starting." << "\n";
1665 wxInitAllImageHandlers ();
1667 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1668 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1670 _splash = maybe_show_splash ();
1672 SetAppName (_("DCP-o-matic"));
1674 if (!wxApp::OnInit()) {
1678 #ifdef DCPOMATIC_LINUX
1679 unsetenv ("UBUNTU_MENUPROXY");
1682 #ifdef DCPOMATIC_OSX
1683 dcpomatic_sleep_seconds (1);
1684 make_foreground_application ();
1687 /* Enable i18n; this will create a Config object
1688 to look for a force-configured language. This Config
1689 object will be wrong, however, because dcpomatic_setup
1690 hasn't yet been called and there aren't any filters etc.
1693 dcpomatic_setup_i18n ();
1695 /* Set things up, including filters etc.
1696 which will now be internationalised correctly.
1700 /* Force the configuration to be re-loaded correctly next
1705 /* We only look out for bad configuration from here on, as before
1706 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1707 incorrect certificate chain validity errors.
1709 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1711 _frame = new DOMFrame (_("DCP-o-matic"));
1712 SetTopWindow (_frame);
1713 _frame->Maximize ();
1716 if (running_32_on_64 ()) {
1717 NagDialog::maybe_nag (
1718 _frame, Config::NAG_32_ON_64,
1719 _("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."),
1725 signal_manager = new wxSignalManager (this);
1726 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1728 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1730 _frame->load_film (_film_to_load);
1731 } catch (exception& e) {
1732 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()));
1736 if (!_film_to_create.empty ()) {
1737 _frame->new_film (_film_to_create, optional<string>());
1738 if (!_content_to_add.empty()) {
1739 for (auto i: content_factory(_content_to_add)) {
1740 _frame->film()->examine_and_add_content(i);
1743 if (!_dcp_to_add.empty ()) {
1744 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1748 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1749 _timer.reset (new wxTimer (this));
1750 _timer->Start (1000);
1752 if (Config::instance()->check_for_updates ()) {
1753 UpdateChecker::instance()->run ();
1756 auto release_notes = find_release_notes(gui_is_dark());
1757 if (release_notes) {
1758 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1763 #ifdef DCPOMATIC_GROK
1764 grk_plugin::setMessengerLogger(new grk_plugin::GrokLogger("[GROK] "));
1765 setup_grok_library_path();
1768 catch (exception& e)
1771 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1777 void OnInitCmdLine (wxCmdLineParser& parser) override
1779 parser.SetDesc (command_line_description);
1780 parser.SetSwitchChars (wxT ("-"));
1783 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1785 if (parser.Found (wxT("version"))) {
1786 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1787 exit (EXIT_SUCCESS);
1790 if (parser.GetParamCount() > 0) {
1791 if (parser.Found (wxT ("new"))) {
1792 _film_to_create = wx_to_std (parser.GetParam (0));
1794 _film_to_load = wx_to_std (parser.GetParam (0));
1799 if (parser.Found (wxT ("content"), &content)) {
1800 _content_to_add = wx_to_std (content);
1804 if (parser.Found (wxT ("dcp"), &dcp)) {
1805 _dcp_to_add = wx_to_std (dcp);
1809 if (parser.Found (wxT("config"), &config)) {
1810 State::override_path = wx_to_std (config);
1816 void report_exception ()
1820 } catch (FileError& e) {
1824 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1825 std_to_wx (e.what()),
1826 std_to_wx (e.file().string().c_str())
1829 } catch (boost::filesystem::filesystem_error& e) {
1833 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1834 std_to_wx (e.what()),
1835 std_to_wx (e.path1().string()),
1836 std_to_wx (e.path2().string())
1839 } catch (exception& e) {
1843 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1844 std_to_wx (e.what ())
1848 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1852 /* An unhandled exception has occurred inside the main event loop */
1853 bool OnExceptionInMainLoop () override
1855 report_exception ();
1856 /* This will terminate the program */
1860 void OnUnhandledException () override
1862 report_exception ();
1865 void idle (wxIdleEvent& ev)
1867 signal_manager->ui_idle ();
1874 EncodeServerFinder::instance()->rethrow ();
1875 } catch (exception& e) {
1876 error_dialog (0, std_to_wx (e.what ()));
1880 void close_splash ()
1888 void config_failed_to_load (Config::LoadFailure what)
1890 report_config_load_failure(_frame, what);
1893 void config_warning (string m)
1895 message_dialog (_frame, std_to_wx(m));
1898 bool config_bad (Config::BadReason reason)
1900 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1901 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1905 auto config = Config::instance();
1907 case Config::BAD_SIGNER_UTF8_STRINGS:
1909 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1912 RecreateChainDialog dialog(
1913 _frame, _("Recreate signing certificates"),
1914 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1915 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1916 "the certificate chain for signing DCPs and KDMs?"),
1918 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1920 return dialog.ShowModal() == wxID_OK;
1922 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1924 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1927 RecreateChainDialog dialog(
1928 _frame, _("Recreate signing certificates"),
1929 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1930 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1931 "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"),
1941 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1942 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1943 "the certificate chain for signing DCPs and KDMs?"),
1944 _("Close DCP-o-matic")
1946 if (dialog.ShowModal() != wxID_OK) {
1947 exit (EXIT_FAILURE);
1951 case Config::BAD_DECRYPTION_INCONSISTENT:
1953 RecreateChainDialog dialog(
1954 _frame, _("Recreate KDM decryption chain"),
1955 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1956 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1957 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1958 "configuration before continuing."),
1959 _("Close DCP-o-matic")
1961 if (dialog.ShowModal() != wxID_OK) {
1962 exit (EXIT_FAILURE);
1966 case Config::BAD_SIGNER_DN_QUALIFIER:
1968 RecreateChainDialog dialog(
1969 _frame, _("Recreate signing certificates"),
1970 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1971 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
1972 "by a bug in DCP-o-matic which has now been fixed. Do you want to re-create the certificate chain\n"
1973 "for signing DCPs and KDMs?"),
1975 Config::NAG_BAD_SIGNER_DN_QUALIFIER
1977 return dialog.ShowModal() == wxID_OK;
1980 DCPOMATIC_ASSERT (false);
1984 DOMFrame* _frame = nullptr;
1985 wxSplashScreen* _splash = nullptr;
1986 shared_ptr<wxTimer> _timer;
1987 string _film_to_load;
1988 string _film_to_create;
1989 string _content_to_add;