2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 /** @file src/tools/dcpomatic.cc
23 * @brief The main DCP-o-matic GUI.
27 #include "wx/about_dialog.h"
28 #include "wx/content_panel.h"
29 #include "wx/dkdm_dialog.h"
30 #include "wx/export_subtitles_dialog.h"
31 #include "wx/export_video_file_dialog.h"
32 #include "wx/film_editor.h"
33 #include "wx/film_name_location_dialog.h"
34 #include "wx/film_viewer.h"
35 #include "wx/focus_manager.h"
36 #include "wx/full_config_dialog.h"
37 #include "wx/hints_dialog.h"
38 #include "wx/html_dialog.h"
39 #include "wx/i18n_hook.h"
41 #include "wx/job_manager_view.h"
42 #include "wx/kdm_dialog.h"
43 #include "wx/nag_dialog.h"
44 #include "wx/paste_dialog.h"
45 #include "wx/recreate_chain_dialog.h"
46 #include "wx/report_problem_dialog.h"
47 #include "wx/save_template_dialog.h"
48 #include "wx/self_dkdm_dialog.h"
49 #include "wx/send_i18n_dialog.h"
50 #include "wx/servers_list_dialog.h"
51 #include "wx/standard_controls.h"
52 #include "wx/system_information_dialog.h"
53 #include "wx/templates_dialog.h"
54 #include "wx/update_dialog.h"
55 #include "wx/video_waveform_dialog.h"
56 #include "wx/wx_signal_manager.h"
57 #include "wx/wx_util.h"
58 #include "lib/analytics.h"
59 #include "lib/audio_content.h"
60 #include "lib/check_content_job.h"
61 #include "lib/cinema.h"
62 #include "lib/compose.hpp"
63 #include "lib/config.h"
64 #include "lib/constants.h"
65 #include "lib/content.h"
66 #include "lib/content_factory.h"
67 #include "lib/cross.h"
68 #include "lib/cross.h"
69 #include "lib/dcp_content.h"
70 #include "lib/dcpomatic_log.h"
71 #include "lib/dcpomatic_socket.h"
72 #include "lib/dkdm_wrapper.h"
73 #include "lib/emailer.h"
74 #include "lib/encode_server_finder.h"
75 #include "lib/exceptions.h"
76 #include "lib/ffmpeg_encoder.h"
78 #include "lib/font_config.h"
79 #include "lib/grok/context.h"
80 #include "lib/hints.h"
81 #include "lib/job_manager.h"
82 #include "lib/kdm_with_metadata.h"
84 #include "lib/make_dcp.h"
85 #include "lib/release_notes.h"
86 #include "lib/screen.h"
87 #include "lib/send_kdm_email_job.h"
88 #include "lib/signal_manager.h"
89 #include "lib/subtitle_encoder.h"
90 #include "lib/text_content.h"
91 #include "lib/transcode_job.h"
92 #include "lib/update_checker.h"
93 #include "lib/version.h"
94 #include "lib/video_content.h"
95 #include <dcp/exceptions.h>
96 #include <dcp/filesystem.h>
97 #include <dcp/raw_convert.h>
98 #include <dcp/warnings.h>
99 LIBDCP_DISABLE_WARNINGS
100 #include <wx/cmdline.h>
101 #include <wx/generic/aboutdlgg.h>
102 #include <wx/preferences.h>
103 #include <wx/splash.h>
104 #include <wx/stdpaths.h>
105 #include <wx/wxhtml.h>
106 LIBDCP_ENABLE_WARNINGS
108 #include <X11/Xlib.h>
111 #include <shellapi.h>
113 #include <boost/algorithm/string.hpp>
114 #include <boost/filesystem.hpp>
117 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
126 using std::dynamic_pointer_cast;
127 using std::exception;
130 using std::make_pair;
131 using std::make_shared;
133 using std::shared_ptr;
137 using boost::optional;
138 using boost::is_any_of;
139 using boost::algorithm::find;
140 #if BOOST_VERSION >= 106100
141 using namespace boost::placeholders;
143 using dcp::raw_convert;
146 class FilmChangedClosingDialog
149 explicit FilmChangedClosingDialog (string name)
152 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
153 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
154 /// project (Film) has been changed since it was last saved.
156 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
159 _dialog.SetYesNoCancelLabels(
160 _("Save film and close"), _("Close without saving film"), _("Don't close")
166 return _dialog.ShowModal();
170 wxMessageDialog _dialog;
174 class FilmChangedDuplicatingDialog
177 explicit FilmChangedDuplicatingDialog (string name)
180 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
181 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
182 /// project (Film) has been changed since it was last saved.
184 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
187 _dialog.SetYesNoCancelLabels(
188 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
194 return _dialog.ShowModal();
198 wxMessageDialog _dialog;
203 #define NEEDS_FILM 0x1
204 #define NOT_DURING_DCP_CREATION 0x2
205 #define NEEDS_CPL 0x4
206 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
207 #define NEEDS_SELECTED_CONTENT 0x10
208 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
209 #define NEEDS_CLIPBOARD 0x40
210 #define NEEDS_ENCRYPTION 0x80
213 map<wxMenuItem*, int> menu_items;
216 ID_file_new = DCPOMATIC_MAIN_MENU,
219 ID_file_save_as_template,
221 ID_file_duplicate_and_open,
223 /* Allow spare IDs after _history for the recent files list */
224 ID_file_close = DCPOMATIC_MAIN_MENU + 100,
229 ID_jobs_make_dcp_batch,
232 ID_jobs_make_self_dkdm,
233 ID_jobs_export_video_file,
234 ID_jobs_export_subtitles,
235 ID_jobs_send_dcp_to_tms,
237 ID_jobs_open_dcp_in_player,
238 ID_view_closed_captions,
239 ID_view_video_waveform,
241 ID_tools_encoding_servers,
242 ID_tools_manage_templates,
243 ID_tools_check_for_updates,
244 ID_tools_send_translations,
245 ID_tools_system_information,
246 ID_tools_restore_default_preferences,
247 ID_tools_export_preferences,
248 ID_help_report_a_problem,
249 /* IDs for shortcuts (with no associated menu item) */
259 class LimitedFrameSplitter : public wxSplitterWindow
262 LimitedFrameSplitter(wxWindow* parent)
263 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
265 /* This value doesn't really mean much but we just want to stop double-click on the
266 divider from shrinking the left panel.
268 SetMinimumPaneSize(64);
270 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
273 bool OnSashPositionChange(int new_position) override
275 /* Try to stop the left bit of the splitter getting too small */
276 auto const ok = new_position > _left_panel_minimum_size;
278 Config::instance()->set_main_divider_sash_position(new_position);
284 void sized(wxSizeEvent& ev)
286 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
287 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
288 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
290 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
296 int const _left_panel_minimum_size = 200;
300 class DOMFrame : public wxFrame
303 explicit DOMFrame (wxString const& title)
304 : wxFrame (nullptr, -1, title)
305 /* Use a panel as the only child of the Frame so that we avoid
306 the dark-grey background on Windows.
308 , _splitter(new LimitedFrameSplitter(this))
309 , _right_panel(new wxPanel(_splitter, wxID_ANY))
310 , _film_viewer(_right_panel)
313 auto bar = new wxMenuBar;
317 #ifdef DCPOMATIC_WINDOWS
318 SetIcon (wxIcon (std_to_wx ("id")));
321 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
322 config_changed (Config::OTHER);
324 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
326 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
327 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
328 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
329 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
330 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
331 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
332 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
362 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
363 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
365 auto left_panel = new wxPanel(_splitter, wxID_ANY);
367 _film_editor = new FilmEditor(left_panel, _film_viewer);
369 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
370 left_sizer->Add(_film_editor, 1, wxEXPAND);
372 left_panel->SetSizerAndFit(left_sizer);
374 _controls = new StandardControls(_right_panel, _film_viewer, true);
375 _controls->set_film(_film_viewer.film());
376 auto job_manager_view = new JobManagerView(_right_panel, false);
378 auto right_sizer = new wxBoxSizer (wxVERTICAL);
379 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
380 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
381 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
383 _right_panel->SetSizer(right_sizer);
385 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
387 set_menu_sensitivity ();
389 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
392 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
394 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
396 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
397 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
401 void add_accelerators ()
404 int accelerators = 7;
406 int accelerators = 6;
408 std::vector<wxAcceleratorEntry> accel(accelerators);
409 /* [Shortcut] Ctrl+A:Add file(s) to the film */
410 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
411 /* [Shortcut] Delete:Remove selected content from film */
412 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
413 /* [Shortcut] Space:Start/stop playback */
414 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
415 /* [Shortcut] Ctrl+T:Open timeline window */
416 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
417 /* [Shortcut] Left arrow:Move back one frame */
418 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
419 /* [Shortcut] Right arrow:Move forward one frame */
420 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
422 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
424 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
425 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
426 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
427 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
428 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
429 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
430 wxAcceleratorTable accel_table (accelerators, accel.data());
431 SetAcceleratorTable (accel_table);
434 void remove_accelerators ()
436 SetAcceleratorTable (wxAcceleratorTable ());
439 void remove_clicked (wxCommandEvent& ev)
441 if (_film_editor->content_panel()->remove_clicked (true)) {
446 void new_film (boost::filesystem::path path, optional<string> template_name)
448 auto film = make_shared<Film>(path);
450 film->use_template (template_name.get());
452 film->set_name (path.filename().generic_string());
453 film->write_metadata ();
457 void load_film (boost::filesystem::path file)
460 auto film = make_shared<Film>(file);
461 auto const notes = film->read_metadata ();
463 if (film->state_version() == 4) {
466 _("This film was created with an old version of DVD-o-matic and may not load correctly "
467 "in this version. Please check the film's settings carefully.")
471 for (auto i: notes) {
472 error_dialog (0, std_to_wx(i));
477 JobManager::instance()->add(make_shared<CheckContentJob>(film));
479 catch (FileNotFoundError& e) {
480 auto const dir = e.file().parent_path();
481 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
483 this, _("Could not open this folder as a DCP-o-matic project."),
484 _("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.")
487 auto const p = std_to_wx(file.string ());
488 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
491 } catch (std::exception& e) {
492 auto const p = std_to_wx (file.string());
493 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
496 void set_film (shared_ptr<Film> film)
499 _film_viewer.set_film(_film);
500 _film_editor->set_film(_film);
501 _controls->set_film (_film);
502 _video_waveform_dialog.reset();
503 set_menu_sensitivity ();
504 if (_film && _film->directory()) {
505 Config::instance()->add_to_history (_film->directory().get());
508 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
509 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
510 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
511 dcpomatic_log = _film->log ();
516 shared_ptr<Film> film () const {
522 void show (wxShowEvent& ev)
524 if (ev.IsShown() && !_first_shown_called) {
525 _film_editor->first_shown ();
526 _first_shown_called = true;
530 void film_message (string m)
532 message_dialog (this, std_to_wx(m));
535 void film_change (ChangeType type)
537 if (type == ChangeType::DONE) {
538 set_menu_sensitivity ();
544 FilmNameLocationDialog dialog(this, _("New Film"), true);
545 int const r = dialog.ShowModal();
547 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
552 new_film(dialog.path(), dialog.template_name());
553 } catch (boost::filesystem::filesystem_error& e) {
554 #ifdef DCPOMATIC_WINDOWS
555 string bad_chars = "<>:\"/|?*";
556 string const filename = dialog.path().filename().string();
557 string found_bad_chars;
558 for (size_t i = 0; i < bad_chars.length(); ++i) {
559 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
560 found_bad_chars += bad_chars[i];
563 wxString message = _("Could not create folder to store film.");
565 if (!found_bad_chars.empty()) {
566 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
568 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
570 error_dialog (this, message, std_to_wx(e.what()));
572 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
581 _("Select film to open"),
582 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
583 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
588 r = dialog.ShowModal();
589 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
590 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
596 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
597 load_film(wx_to_std(dialog.GetPath()));
604 _film->write_metadata ();
605 } catch (exception& e) {
606 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
610 void file_save_as_template ()
612 SaveTemplateDialog dialog(this);
613 if (dialog.ShowModal() == wxID_OK) {
615 Config::instance()->save_template(_film, dialog.name());
616 } catch (exception& e) {
617 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
622 void file_duplicate ()
624 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
626 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
627 auto film = make_shared<Film>(dialog.path());
628 film->copy_from (_film);
629 film->set_name(dialog.path().filename().generic_string());
631 film->write_metadata();
632 } catch (exception& e) {
633 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
638 void file_duplicate_and_open ()
640 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
642 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
643 auto film = make_shared<Film>(dialog.path());
644 film->copy_from (_film);
645 film->set_name(dialog.path().filename().generic_string());
647 film->write_metadata ();
649 } catch (exception& e) {
650 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
657 if (_film && _film->dirty ()) {
658 FilmChangedClosingDialog dialog(_film->name());
659 switch (dialog.run()) {
661 /* Don't save and carry on to close */
664 /* Save and carry on to close */
665 _film->write_metadata ();
673 set_film (shared_ptr<Film>());
676 void file_history (wxCommandEvent& event)
678 auto history = Config::instance()->history ();
679 int n = event.GetId() - ID_file_history;
680 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
681 load_film (history[n]);
687 /* false here allows the close handler to veto the close request */
693 auto const sel = _film_editor->content_panel()->selected();
694 if (sel.size() == 1) {
695 _clipboard = sel.front()->clone();
705 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
706 if (dialog.ShowModal() != wxID_OK) {
710 for (auto i: _film_editor->content_panel()->selected()) {
711 if (dialog.video() && i->video) {
712 DCPOMATIC_ASSERT (_clipboard->video);
713 i->video->take_settings_from (_clipboard->video);
715 if (dialog.audio() && i->audio) {
716 DCPOMATIC_ASSERT (_clipboard->audio);
717 i->audio->take_settings_from (_clipboard->audio);
721 auto j = i->text.begin ();
722 auto k = _clipboard->text.begin ();
723 while (j != i->text.end() && k != _clipboard->text.end()) {
724 (*j)->take_settings_from (*k);
732 void edit_select_all ()
734 _film_editor->content_panel()->select_all();
737 void edit_preferences ()
739 if (!_config_dialog) {
740 _config_dialog = create_full_config_dialog ();
742 _config_dialog->Show (this);
745 void tools_restore_default_preferences ()
747 wxMessageDialog dialog(
749 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
750 _("Restore default preferences"),
751 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
754 if (dialog.ShowModal() == wxID_YES) {
755 Config::restore_defaults ();
759 void tools_export_preferences ()
762 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
763 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
766 if (dialog.ShowModal() == wxID_OK) {
767 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
768 if (boost::filesystem::exists(path)) {
769 boost::system::error_code ec;
770 boost::filesystem::remove(path, ec);
772 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
777 save_all_config_as_zip(path);
781 void jobs_make_dcp ()
787 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
790 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);
792 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);
794 if (!confirm_dialog (this, message)) {
799 if (Config::instance()->show_hints_before_make_dcp()) {
800 HintsDialog hints(this, _film, false);
801 if (hints.ShowModal() == wxID_CANCEL) {
806 if (_film->encrypted ()) {
807 NagDialog::maybe_nag (
809 Config::NAG_ENCRYPTED_METADATA,
810 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
811 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
812 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
813 "if you want to make KDMs for this film.")
817 /* Remove any existing DCP if the user agrees */
818 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
819 if (dcp::filesystem::exists(dcp_dir)) {
820 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
823 dcp::filesystem::remove_all(dcp_dir);
827 /* It seems to make sense to auto-save metadata here, since the make DCP may last
828 a long time, and crashes/power failures are moderately likely.
830 _film->write_metadata ();
831 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
832 } catch (BadSettingError& e) {
833 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
834 } catch (std::exception& e) {
835 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
839 void jobs_make_kdms ()
845 _kdm_dialog.reset(this, _film);
846 _kdm_dialog->Show ();
849 void jobs_make_dkdms ()
855 _dkdm_dialog.reset(this, _film);
856 _dkdm_dialog->Show ();
859 /** @return false if we succeeded, true if not */
860 bool send_to_other_tool (int port, function<void()> start, string message)
862 /* i = 0; try to connect via socket
863 i = 1; try again, and then try to start the tool
864 i = 2 onwards; try again.
866 for (int i = 0; i < 8; ++i) {
868 boost::asio::io_service io_service;
869 boost::asio::ip::tcp::resolver resolver (io_service);
870 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
871 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
873 socket.connect (*endpoint_iterator);
874 DCPOMATIC_ASSERT (_film->directory ());
875 socket.write (message.length() + 1);
876 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
881 } catch (exception& e) {
889 dcpomatic_sleep_seconds (1);
895 void jobs_make_dcp_batch ()
901 if (Config::instance()->show_hints_before_make_dcp()) {
902 HintsDialog hints(this, _film, false);
903 if (hints.ShowModal() == wxID_CANCEL) {
908 _film->write_metadata ();
910 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
912 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
914 error_dialog (this, _("Could not find batch converter."));
919 void jobs_open_dcp_in_player ()
925 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
927 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
929 error_dialog (this, _("Could not find player."));
934 void jobs_make_self_dkdm ()
940 SelfDKDMDialog dialog(this, _film);
941 if (dialog.ShowModal() != wxID_OK) {
945 NagDialog::maybe_nag (
947 Config::NAG_DKDM_CONFIG,
949 _("You are making a DKDM which is encrypted by a private key held in"
950 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
951 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
952 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
957 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
959 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
962 auto signer = Config::instance()->signer_chain();
963 if (!signer->valid()) {
964 error_dialog(this, _("The certificate chain for signing is invalid"));
968 optional<dcp::EncryptedKDM> kdm;
970 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
971 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
972 if (dialog.internal()) {
973 auto dkdms = Config::instance()->dkdms();
974 dkdms->add(make_shared<DKDM>(kdm));
975 Config::instance()->changed ();
977 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
980 } catch (dcp::NotEncryptedError& e) {
981 error_dialog (this, _("CPL's content is not encrypted."));
982 } catch (exception& e) {
983 error_dialog (this, e.what ());
985 error_dialog (this, _("An unknown exception occurred."));
990 void jobs_export_video_file ()
992 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
993 if (dialog.ShowModal() != wxID_OK) {
997 if (dcp::filesystem::exists(dialog.path())) {
998 bool ok = confirm_dialog(
1000 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1008 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1010 make_shared<FFmpegEncoder> (
1011 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1013 JobManager::instance()->add (job);
1017 void jobs_export_subtitles ()
1019 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1020 if (dialog.ShowModal() != wxID_OK) {
1023 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1025 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1027 JobManager::instance()->add(job);
1031 void jobs_send_dcp_to_tms ()
1033 _film->send_dcp_to_tms ();
1036 void jobs_show_dcp ()
1038 DCPOMATIC_ASSERT (_film->directory ());
1039 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1040 error_dialog (this, _("Could not show DCP."));
1044 void view_closed_captions ()
1046 _film_viewer.show_closed_captions ();
1049 void view_video_waveform ()
1051 if (!_video_waveform_dialog) {
1052 _video_waveform_dialog.reset(this, _film, _film_viewer);
1055 _video_waveform_dialog->Show ();
1058 void tools_system_information ()
1060 if (!_system_information_dialog) {
1061 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1064 _system_information_dialog->Show ();
1069 if (!_hints_dialog) {
1070 _hints_dialog = new HintsDialog (this, _film, true);
1073 _hints_dialog->Show ();
1076 void tools_encoding_servers ()
1078 if (!_servers_list_dialog) {
1079 _servers_list_dialog = new ServersListDialog (this);
1082 _servers_list_dialog->Show ();
1085 void tools_manage_templates ()
1087 if (!_templates_dialog) {
1088 _templates_dialog.reset(this);
1091 _templates_dialog->Show ();
1094 void tools_check_for_updates ()
1096 _update_news_requested = true;
1097 UpdateChecker::instance()->run();
1100 void tools_send_translations ()
1102 SendI18NDialog dialog(this);
1103 if (dialog.ShowModal() != wxID_OK) {
1108 body += dialog.name() + "\n";
1109 body += dialog.language() + "\n";
1110 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1112 auto translations = I18NHook::translations ();
1113 for (auto i: translations) {
1114 body += i.first + "\n" + i.second + "\n\n";
1116 if (dialog.email().find("@") == string::npos) {
1117 error_dialog (this, _("You must enter a valid email address when sending translations, "
1118 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1120 Emailer emailer(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1122 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1123 } catch (NetworkError& e) {
1124 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1131 AboutDialog dialog(this);
1135 void help_report_a_problem ()
1137 ReportProblemDialog dialog(this, _film);
1138 if (dialog.ShowModal() == wxID_OK) {
1143 bool should_close ()
1145 if (!JobManager::instance()->work_to_do ()) {
1149 wxMessageDialog dialog(
1151 _("There are unfinished jobs; are you sure you want to quit?"),
1152 _("Unfinished jobs"),
1153 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1156 return dialog.ShowModal() == wxID_YES;
1159 void close (wxCloseEvent& ev)
1161 if (!should_close ()) {
1166 if (_film && _film->dirty ()) {
1167 FilmChangedClosingDialog dialog(_film->name());
1168 switch (dialog.run()) {
1170 /* Don't save and carry on to close */
1173 /* Save and carry on to close */
1174 _film->write_metadata ();
1177 /* Veto the event and stop */
1183 /* We don't want to hear about any more configuration changes, since they
1184 cause the File menu to be altered, which itself will be deleted around
1185 now (without, as far as I can see, any way for us to find out).
1187 _config_changed_connection.disconnect ();
1189 /* Also stop hearing about analytics-related stuff */
1190 _analytics_message_connection.disconnect ();
1195 JobManager::drop ();
1198 void active_jobs_changed()
1200 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1201 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1202 * it by using an idle callback. This feels quite unpleasant.
1204 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1207 void set_menu_sensitivity ()
1209 auto jobs = JobManager::instance()->get ();
1210 auto i = jobs.begin();
1211 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1214 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1215 bool const have_cpl = _film && !_film->cpls().empty ();
1216 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1217 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1218 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1220 for (auto j: menu_items) {
1222 bool enabled = true;
1224 if ((j.second & NEEDS_FILM) && !_film) {
1228 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1232 if ((j.second & NEEDS_CPL) && !have_cpl) {
1236 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1240 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1244 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1248 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1252 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1256 j.first->Enable (enabled);
1260 /** @return true if the operation that called this method
1261 * should continue, false to abort it.
1264 bool maybe_save_film ()
1270 while (_film->dirty()) {
1271 T dialog(_film->name());
1272 switch (dialog.run()) {
1277 _film->write_metadata();
1279 } catch (exception& e) {
1280 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1281 /* Go round again for another try */
1293 bool maybe_save_then_delete_film ()
1295 bool const r = maybe_save_film<T> ();
1302 void add_item (wxMenu* menu, wxString text, int id, int sens)
1304 auto item = menu->Append (id, text);
1305 menu_items.insert (make_pair (item, sens));
1308 void setup_menu (wxMenuBar* m)
1310 _file_menu = new wxMenu;
1311 /* [Shortcut] Ctrl+N:New film */
1312 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1313 /* [Shortcut] Ctrl+O:Open existing film */
1314 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1315 _file_menu->AppendSeparator ();
1316 /* [Shortcut] Ctrl+S:Save current film */
1317 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1318 _file_menu->AppendSeparator ();
1319 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1320 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1321 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1323 _history_position = _file_menu->GetMenuItems().GetCount();
1325 _file_menu->AppendSeparator ();
1326 /* [Shortcut] Ctrl+W:Close current film */
1327 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1330 _file_menu->AppendSeparator ();
1334 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1336 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1339 auto edit = new wxMenu;
1340 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1341 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1342 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1343 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1344 edit->AppendSeparator ();
1345 /* [Shortcut] Shift+Ctrl+A:Select all content */
1346 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1349 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1351 edit->AppendSeparator ();
1352 /* [Shortcut] Ctrl+P:Open preferences window */
1353 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1356 auto jobs_menu = new wxMenu;
1357 /* [Shortcut] Ctrl+M:Make DCP */
1358 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1359 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1360 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1361 jobs_menu->AppendSeparator ();
1362 /* [Shortcut] Ctrl+K:Make KDMs */
1363 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1364 /* [Shortcut] Ctrl+D:Make DKDMs */
1365 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1366 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1367 jobs_menu->AppendSeparator ();
1368 /* [Shortcut] Ctrl+E:Export video file */
1369 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1370 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1371 jobs_menu->AppendSeparator ();
1372 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1374 #if defined(DCPOMATIC_OSX)
1375 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1376 #elif defined(DCPOMATIC_WINDOWS)
1377 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1379 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1382 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1384 auto view = new wxMenu;
1385 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1386 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1388 auto tools = new wxMenu;
1389 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1390 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1391 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1392 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1393 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1394 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1395 tools->AppendSeparator ();
1396 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1397 tools->AppendSeparator ();
1398 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1400 wxMenu* help = new wxMenu;
1402 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1404 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1406 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1408 m->Append (_file_menu, _("&File"));
1409 m->Append (edit, _("&Edit"));
1410 m->Append (jobs_menu, _("&Jobs"));
1411 m->Append (view, _("&View"));
1412 m->Append (tools, _("&Tools"));
1413 m->Append (help, _("&Help"));
1416 void config_changed (Config::Property what)
1418 /* Instantly save any config changes when using the DCP-o-matic GUI */
1419 if (what == Config::CINEMAS) {
1421 Config::instance()->write_cinemas();
1422 } catch (exception& e) {
1426 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1427 std_to_wx (Config::instance()->cinemas_file().string()).data()
1433 Config::instance()->write_config();
1434 } catch (exception& e) {
1438 _("Could not write to config file at %s. Your changes have not been saved."),
1439 std_to_wx (Config::instance()->cinemas_file().string()).data()
1445 for (int i = 0; i < _history_items; ++i) {
1446 delete _file_menu->Remove (ID_file_history + i);
1449 if (_history_separator) {
1450 _file_menu->Remove (_history_separator);
1452 delete _history_separator;
1453 _history_separator = 0;
1455 int pos = _history_position;
1457 /* Clear out non-existent history items before we re-build the menu */
1458 Config::instance()->clean_history ();
1459 auto history = Config::instance()->history();
1461 if (!history.empty ()) {
1462 _history_separator = _file_menu->InsertSeparator (pos++);
1465 for (size_t i = 0; i < history.size(); ++i) {
1468 s = String::compose ("&%1 %2", i + 1, history[i].string());
1470 s = history[i].string();
1472 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1475 _history_items = history.size ();
1477 dcpomatic_log->set_types (Config::instance()->log_types());
1480 void update_checker_state_changed ()
1482 auto uc = UpdateChecker::instance ();
1484 bool const announce =
1485 _update_news_requested ||
1486 (uc->stable() && Config::instance()->check_for_updates()) ||
1487 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1489 _update_news_requested = false;
1495 if (uc->state() == UpdateChecker::State::YES) {
1496 UpdateDialog dialog(this, uc->stable(), uc->test());
1498 } else if (uc->state() == UpdateChecker::State::FAILED) {
1499 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1501 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1504 _update_news_requested = false;
1507 void start_stop_pressed ()
1509 if (_film_viewer.playing()) {
1510 _film_viewer.stop();
1512 _film_viewer.start();
1516 void timeline_pressed ()
1518 _film_editor->content_panel()->timeline_clicked ();
1523 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1526 void forward_frame ()
1528 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1531 void analytics_message (string title, string html)
1533 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1539 auto s = wx_to_std(_("DCP-o-matic"));
1541 if (_film->directory()) {
1542 s += " - " + _film->directory()->string();
1544 if (_film->dirty()) {
1549 SetTitle (std_to_wx(s));
1552 FilmEditor* _film_editor;
1553 LimitedFrameSplitter* _splitter;
1554 wxPanel* _right_panel;
1555 FilmViewer _film_viewer;
1556 StandardControls* _controls;
1557 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1558 SystemInformationDialog* _system_information_dialog = nullptr;
1559 HintsDialog* _hints_dialog = nullptr;
1560 ServersListDialog* _servers_list_dialog = nullptr;
1561 wxPreferencesEditor* _config_dialog = nullptr;
1562 wx_ptr<KDMDialog> _kdm_dialog;
1563 wx_ptr<DKDMDialog> _dkdm_dialog;
1564 wx_ptr<TemplatesDialog> _templates_dialog;
1565 wxMenu* _file_menu = nullptr;
1566 shared_ptr<Film> _film;
1567 int _history_items = 0;
1568 int _history_position = 0;
1569 wxMenuItem* _history_separator = nullptr;
1570 boost::signals2::scoped_connection _config_changed_connection;
1571 boost::signals2::scoped_connection _analytics_message_connection;
1572 bool _update_news_requested = false;
1573 shared_ptr<Content> _clipboard;
1574 bool _first_shown_called = false;
1578 static const wxCmdLineEntryDesc command_line_description[] = {
1579 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1580 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1581 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1582 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1583 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1584 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1585 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1590 * @brief The magic App class for wxWidgets.
1592 class App : public wxApp
1598 dcpomatic_setup_path_encoding ();
1599 #ifdef DCPOMATIC_LINUX
1606 bool OnInit () override
1610 #if defined(DCPOMATIC_WINDOWS)
1611 if (Config::instance()->win32_console()) {
1614 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1615 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1616 FILE* hf_out = _fdopen(hCrt, "w");
1617 setvbuf(hf_out, NULL, _IONBF, 1);
1620 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1621 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1622 FILE* hf_in = _fdopen(hCrt, "r");
1623 setvbuf(hf_in, NULL, _IONBF, 128);
1626 cout << "DCP-o-matic is starting." << "\n";
1629 wxInitAllImageHandlers ();
1631 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1632 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1634 _splash = maybe_show_splash ();
1636 SetAppName (_("DCP-o-matic"));
1638 if (!wxApp::OnInit()) {
1642 #ifdef DCPOMATIC_LINUX
1643 unsetenv ("UBUNTU_MENUPROXY");
1646 #ifdef DCPOMATIC_OSX
1647 dcpomatic_sleep_seconds (1);
1648 make_foreground_application ();
1651 /* Enable i18n; this will create a Config object
1652 to look for a force-configured language. This Config
1653 object will be wrong, however, because dcpomatic_setup
1654 hasn't yet been called and there aren't any filters etc.
1657 dcpomatic_setup_i18n ();
1659 /* Set things up, including filters etc.
1660 which will now be internationalised correctly.
1664 /* Force the configuration to be re-loaded correctly next
1669 /* We only look out for bad configuration from here on, as before
1670 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1671 incorrect certificate chain validity errors.
1673 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1675 _frame = new DOMFrame (_("DCP-o-matic"));
1676 SetTopWindow (_frame);
1677 _frame->Maximize ();
1680 if (running_32_on_64 ()) {
1681 NagDialog::maybe_nag (
1682 _frame, Config::NAG_32_ON_64,
1683 _("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."),
1689 signal_manager = new wxSignalManager (this);
1690 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1692 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1694 _frame->load_film (_film_to_load);
1695 } catch (exception& e) {
1696 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()));
1700 if (!_film_to_create.empty ()) {
1701 _frame->new_film (_film_to_create, optional<string>());
1702 if (!_content_to_add.empty()) {
1703 for (auto i: content_factory(_content_to_add)) {
1704 _frame->film()->examine_and_add_content(i);
1707 if (!_dcp_to_add.empty ()) {
1708 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1712 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1713 _timer.reset (new wxTimer (this));
1714 _timer->Start (1000);
1716 if (Config::instance()->check_for_updates ()) {
1717 UpdateChecker::instance()->run ();
1720 auto release_notes = find_release_notes(gui_is_dark());
1721 if (release_notes) {
1722 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1727 grk_plugin::setMessengerLogger(new grk_plugin::GrokLogger("[GROK] "));
1729 catch (exception& e)
1732 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1738 void OnInitCmdLine (wxCmdLineParser& parser) override
1740 parser.SetDesc (command_line_description);
1741 parser.SetSwitchChars (wxT ("-"));
1744 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1746 if (parser.Found (wxT("version"))) {
1747 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1748 exit (EXIT_SUCCESS);
1751 if (parser.GetParamCount() > 0) {
1752 if (parser.Found (wxT ("new"))) {
1753 _film_to_create = wx_to_std (parser.GetParam (0));
1755 _film_to_load = wx_to_std (parser.GetParam (0));
1760 if (parser.Found (wxT ("content"), &content)) {
1761 _content_to_add = wx_to_std (content);
1765 if (parser.Found (wxT ("dcp"), &dcp)) {
1766 _dcp_to_add = wx_to_std (dcp);
1770 if (parser.Found (wxT("config"), &config)) {
1771 State::override_path = wx_to_std (config);
1777 void report_exception ()
1781 } catch (FileError& e) {
1785 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1786 std_to_wx (e.what()),
1787 std_to_wx (e.file().string().c_str())
1790 } catch (boost::filesystem::filesystem_error& e) {
1794 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1795 std_to_wx (e.what()),
1796 std_to_wx (e.path1().string()),
1797 std_to_wx (e.path2().string())
1800 } catch (exception& e) {
1804 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1805 std_to_wx (e.what ())
1809 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1813 /* An unhandled exception has occurred inside the main event loop */
1814 bool OnExceptionInMainLoop () override
1816 report_exception ();
1817 /* This will terminate the program */
1821 void OnUnhandledException () override
1823 report_exception ();
1826 void idle (wxIdleEvent& ev)
1828 signal_manager->ui_idle ();
1835 EncodeServerFinder::instance()->rethrow ();
1836 } catch (exception& e) {
1837 error_dialog (0, std_to_wx (e.what ()));
1841 void close_splash ()
1849 void config_failed_to_load (Config::LoadFailure what)
1851 report_config_load_failure(_frame, what);
1854 void config_warning (string m)
1856 message_dialog (_frame, std_to_wx(m));
1859 bool config_bad (Config::BadReason reason)
1861 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1862 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1866 auto config = Config::instance();
1868 case Config::BAD_SIGNER_UTF8_STRINGS:
1870 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1873 RecreateChainDialog dialog(
1874 _frame, _("Recreate signing certificates"),
1875 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1876 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1877 "the certificate chain for signing DCPs and KDMs?"),
1879 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1881 return dialog.ShowModal() == wxID_OK;
1883 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1885 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1888 RecreateChainDialog dialog(
1889 _frame, _("Recreate signing certificates"),
1890 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1891 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1892 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1894 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1896 return dialog.ShowModal() == wxID_OK;
1898 case Config::BAD_SIGNER_INCONSISTENT:
1900 RecreateChainDialog dialog(
1901 _frame, _("Recreate signing certificates"),
1902 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1903 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1904 "the certificate chain for signing DCPs and KDMs?"),
1905 _("Close DCP-o-matic")
1907 if (dialog.ShowModal() != wxID_OK) {
1908 exit (EXIT_FAILURE);
1912 case Config::BAD_DECRYPTION_INCONSISTENT:
1914 RecreateChainDialog dialog(
1915 _frame, _("Recreate KDM decryption chain"),
1916 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1917 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1918 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1919 "configuration before continuing."),
1920 _("Close DCP-o-matic")
1922 if (dialog.ShowModal() != wxID_OK) {
1923 exit (EXIT_FAILURE);
1927 case Config::BAD_SIGNER_DN_QUALIFIER:
1929 RecreateChainDialog dialog(
1930 _frame, _("Recreate signing certificates"),
1931 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1932 "which will prevent DCPs from being validated correctly on some systems. This error was caused\n"
1933 "by a bug in DCP-o-matic which has now been fixed. Do you want to re-create the certificate chain\n"
1934 "for signing DCPs and KDMs?"),
1936 Config::NAG_BAD_SIGNER_DN_QUALIFIER
1938 return dialog.ShowModal() == wxID_OK;
1941 DCPOMATIC_ASSERT (false);
1945 DOMFrame* _frame = nullptr;
1946 wxSplashScreen* _splash = nullptr;
1947 shared_ptr<wxTimer> _timer;
1948 string _film_to_load;
1949 string _film_to_create;
1950 string _content_to_add;