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"
40 #include "wx/job_manager_view.h"
41 #include "wx/kdm_dialog.h"
42 #include "wx/nag_dialog.h"
43 #include "wx/paste_dialog.h"
44 #include "wx/recreate_chain_dialog.h"
45 #include "wx/report_problem_dialog.h"
46 #include "wx/save_template_dialog.h"
47 #include "wx/self_dkdm_dialog.h"
48 #include "wx/send_i18n_dialog.h"
49 #include "wx/servers_list_dialog.h"
50 #include "wx/standard_controls.h"
51 #include "wx/system_information_dialog.h"
52 #include "wx/templates_dialog.h"
53 #include "wx/update_dialog.h"
54 #include "wx/video_waveform_dialog.h"
55 #include "wx/wx_signal_manager.h"
56 #include "wx/wx_util.h"
57 #include "lib/analytics.h"
58 #include "lib/audio_content.h"
59 #include "lib/check_content_job.h"
60 #include "lib/cinema.h"
61 #include "lib/compose.hpp"
62 #include "lib/config.h"
63 #include "lib/constants.h"
64 #include "lib/content.h"
65 #include "lib/content_factory.h"
66 #include "lib/cross.h"
67 #include "lib/cross.h"
68 #include "lib/dcp_content.h"
69 #include "lib/dcpomatic_log.h"
70 #include "lib/dcpomatic_socket.h"
71 #include "lib/dkdm_wrapper.h"
72 #include "lib/emailer.h"
73 #include "lib/encode_server_finder.h"
74 #include "lib/exceptions.h"
75 #include "lib/ffmpeg_encoder.h"
77 #include "lib/font_config.h"
78 #include "lib/hints.h"
79 #include "lib/job_manager.h"
80 #include "lib/kdm_with_metadata.h"
82 #include "lib/make_dcp.h"
83 #include "lib/release_notes.h"
84 #include "lib/screen.h"
85 #include "lib/send_kdm_email_job.h"
86 #include "lib/signal_manager.h"
87 #include "lib/subtitle_encoder.h"
88 #include "lib/text_content.h"
89 #include "lib/transcode_job.h"
90 #include "lib/update_checker.h"
91 #include "lib/version.h"
92 #include "lib/video_content.h"
93 #include <dcp/exceptions.h>
94 #include <dcp/filesystem.h>
95 #include <dcp/raw_convert.h>
96 #include <dcp/warnings.h>
97 LIBDCP_DISABLE_WARNINGS
98 #include <wx/cmdline.h>
99 #include <wx/generic/aboutdlgg.h>
100 #include <wx/preferences.h>
101 #include <wx/splash.h>
102 #include <wx/stdpaths.h>
103 #include <wx/wxhtml.h>
104 LIBDCP_ENABLE_WARNINGS
106 #include <X11/Xlib.h>
109 #include <shellapi.h>
111 #include <boost/algorithm/string.hpp>
112 #include <boost/filesystem.hpp>
115 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
124 using std::dynamic_pointer_cast;
125 using std::exception;
128 using std::make_pair;
129 using std::make_shared;
131 using std::shared_ptr;
135 using boost::optional;
136 using boost::is_any_of;
137 using boost::algorithm::find;
138 #if BOOST_VERSION >= 106100
139 using namespace boost::placeholders;
141 using dcp::raw_convert;
144 class FilmChangedClosingDialog
147 explicit FilmChangedClosingDialog (string name)
150 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
151 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
152 /// project (Film) has been changed since it was last saved.
154 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
157 _dialog.SetYesNoCancelLabels(
158 _("Save film and close"), _("Close without saving film"), _("Don't close")
164 return _dialog.ShowModal();
168 wxMessageDialog _dialog;
172 class FilmChangedDuplicatingDialog
175 explicit FilmChangedDuplicatingDialog (string name)
178 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
179 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
180 /// project (Film) has been changed since it was last saved.
182 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
185 _dialog.SetYesNoCancelLabels(
186 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
192 return _dialog.ShowModal();
196 wxMessageDialog _dialog;
201 #define NEEDS_FILM 0x1
202 #define NOT_DURING_DCP_CREATION 0x2
203 #define NEEDS_CPL 0x4
204 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
205 #define NEEDS_SELECTED_CONTENT 0x10
206 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
207 #define NEEDS_CLIPBOARD 0x40
208 #define NEEDS_ENCRYPTION 0x80
211 map<wxMenuItem*, int> menu_items;
217 ID_file_save_as_template,
219 ID_file_duplicate_and_open,
221 /* Allow spare IDs after _history for the recent files list */
227 ID_jobs_make_dcp_batch,
230 ID_jobs_make_self_dkdm,
231 ID_jobs_export_video_file,
232 ID_jobs_export_subtitles,
233 ID_jobs_send_dcp_to_tms,
235 ID_jobs_open_dcp_in_player,
236 ID_view_closed_captions,
237 ID_view_video_waveform,
239 ID_tools_encoding_servers,
240 ID_tools_manage_templates,
241 ID_tools_check_for_updates,
242 ID_tools_send_translations,
243 ID_tools_system_information,
244 ID_tools_restore_default_preferences,
245 ID_tools_export_preferences,
246 ID_help_report_a_problem,
247 /* IDs for shortcuts (with no associated menu item) */
257 class LimitedFrameSplitter : public wxSplitterWindow
260 LimitedFrameSplitter(wxWindow* parent)
261 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
263 /* This value doesn't really mean much but we just want to stop double-click on the
264 divider from shrinking the left panel.
266 SetMinimumPaneSize(64);
268 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
271 bool OnSashPositionChange(int new_position) override
273 /* Try to stop the left bit of the splitter getting too small */
274 auto const ok = new_position > _left_panel_minimum_size;
276 Config::instance()->set_main_divider_sash_position(new_position);
282 void sized(wxSizeEvent& ev)
284 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
285 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
286 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
288 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
294 int const _left_panel_minimum_size = 200;
298 class DOMFrame : public wxFrame
301 explicit DOMFrame (wxString const& title)
302 : wxFrame (nullptr, -1, title)
303 /* Use a panel as the only child of the Frame so that we avoid
304 the dark-grey background on Windows.
306 , _splitter(new LimitedFrameSplitter(this))
307 , _right_panel(new wxPanel(_splitter, wxID_ANY))
308 , _film_viewer(_right_panel)
311 auto bar = new wxMenuBar;
315 #ifdef DCPOMATIC_WINDOWS
316 SetIcon (wxIcon (std_to_wx ("id")));
319 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
320 config_changed (Config::OTHER);
322 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
324 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
325 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
326 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
327 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
328 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
329 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
330 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
331 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
332 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
360 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
361 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
363 auto left_panel = new wxPanel(_splitter, wxID_ANY);
365 _film_editor = new FilmEditor(left_panel, _film_viewer);
367 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
368 left_sizer->Add(_film_editor, 1, wxEXPAND);
370 left_panel->SetSizerAndFit(left_sizer);
372 _controls = new StandardControls(_right_panel, _film_viewer, true);
373 _controls->set_film(_film_viewer.film());
374 auto job_manager_view = new JobManagerView(_right_panel, false);
376 auto right_sizer = new wxBoxSizer (wxVERTICAL);
377 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
378 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
379 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
381 _right_panel->SetSizer(right_sizer);
383 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
385 set_menu_sensitivity ();
387 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
390 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
392 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
394 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
395 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
399 void add_accelerators ()
402 int accelerators = 7;
404 int accelerators = 6;
406 std::vector<wxAcceleratorEntry> accel(accelerators);
407 /* [Shortcut] Ctrl+A:Add file(s) to the film */
408 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
409 /* [Shortcut] Delete:Remove selected content from film */
410 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
411 /* [Shortcut] Space:Start/stop playback */
412 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
413 /* [Shortcut] Ctrl+T:Open timeline window */
414 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
415 /* [Shortcut] Left arrow:Move back one frame */
416 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
417 /* [Shortcut] Right arrow:Move forward one frame */
418 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
420 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
422 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
423 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
424 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
425 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
426 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
427 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
428 wxAcceleratorTable accel_table (accelerators, accel.data());
429 SetAcceleratorTable (accel_table);
432 void remove_accelerators ()
434 SetAcceleratorTable (wxAcceleratorTable ());
437 void remove_clicked (wxCommandEvent& ev)
439 if (_film_editor->content_panel()->remove_clicked (true)) {
444 void new_film (boost::filesystem::path path, optional<string> template_name)
446 auto film = make_shared<Film>(path);
448 film->use_template (template_name.get());
450 film->set_name (path.filename().generic_string());
451 film->write_metadata ();
455 void load_film (boost::filesystem::path file)
458 auto film = make_shared<Film>(file);
459 auto const notes = film->read_metadata ();
461 if (film->state_version() == 4) {
464 _("This film was created with an old version of DVD-o-matic and may not load correctly "
465 "in this version. Please check the film's settings carefully.")
469 for (auto i: notes) {
470 error_dialog (0, std_to_wx(i));
475 JobManager::instance()->add(make_shared<CheckContentJob>(film));
477 catch (FileNotFoundError& e) {
478 auto const dir = e.file().parent_path();
479 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
481 this, _("Could not open this folder as a DCP-o-matic project."),
482 _("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.")
485 auto const p = std_to_wx(file.string ());
486 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
489 } catch (std::exception& e) {
490 auto const p = std_to_wx (file.string());
491 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
494 void set_film (shared_ptr<Film> film)
497 _film_viewer.set_film(_film);
498 _film_editor->set_film(_film);
499 _controls->set_film (_film);
500 _video_waveform_dialog.reset();
501 set_menu_sensitivity ();
502 if (_film && _film->directory()) {
503 Config::instance()->add_to_history (_film->directory().get());
506 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
507 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
508 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
509 dcpomatic_log = _film->log ();
514 shared_ptr<Film> film () const {
520 void show (wxShowEvent& ev)
522 if (ev.IsShown() && !_first_shown_called) {
523 _film_editor->first_shown ();
524 _first_shown_called = true;
528 void film_message (string m)
530 message_dialog (this, std_to_wx(m));
533 void film_change (ChangeType type)
535 if (type == ChangeType::DONE) {
536 set_menu_sensitivity ();
542 FilmNameLocationDialog dialog(this, _("New Film"), true);
543 int const r = dialog.ShowModal();
545 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
550 new_film(dialog.path(), dialog.template_name());
551 } catch (boost::filesystem::filesystem_error& e) {
552 #ifdef DCPOMATIC_WINDOWS
553 string bad_chars = "<>:\"/|?*";
554 string const filename = dialog.path().filename().string();
555 string found_bad_chars;
556 for (size_t i = 0; i < bad_chars.length(); ++i) {
557 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
558 found_bad_chars += bad_chars[i];
561 wxString message = _("Could not create folder to store film.");
563 if (!found_bad_chars.empty()) {
564 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
566 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
568 error_dialog (this, message, std_to_wx(e.what()));
570 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
579 _("Select film to open"),
580 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
581 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
586 r = dialog.ShowModal();
587 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
588 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
594 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
595 load_film(wx_to_std(dialog.GetPath()));
602 _film->write_metadata ();
603 } catch (exception& e) {
604 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
608 void file_save_as_template ()
610 SaveTemplateDialog dialog(this);
611 if (dialog.ShowModal() == wxID_OK) {
613 Config::instance()->save_template(_film, dialog.name());
614 } catch (exception& e) {
615 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
620 void file_duplicate ()
622 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
624 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
625 auto film = make_shared<Film>(dialog.path());
626 film->copy_from (_film);
627 film->set_name(dialog.path().filename().generic_string());
629 film->write_metadata();
630 } catch (exception& e) {
631 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
636 void file_duplicate_and_open ()
638 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
640 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
641 auto film = make_shared<Film>(dialog.path());
642 film->copy_from (_film);
643 film->set_name(dialog.path().filename().generic_string());
645 film->write_metadata ();
647 } catch (exception& e) {
648 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
655 if (_film && _film->dirty ()) {
656 FilmChangedClosingDialog dialog(_film->name());
657 switch (dialog.run()) {
659 /* Don't save and carry on to close */
662 /* Save and carry on to close */
663 _film->write_metadata ();
671 set_film (shared_ptr<Film>());
674 void file_history (wxCommandEvent& event)
676 auto history = Config::instance()->history ();
677 int n = event.GetId() - ID_file_history;
678 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
679 load_film (history[n]);
685 /* false here allows the close handler to veto the close request */
691 auto const sel = _film_editor->content_panel()->selected();
692 if (sel.size() == 1) {
693 _clipboard = sel.front()->clone();
703 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
704 if (dialog.ShowModal() != wxID_OK) {
708 for (auto i: _film_editor->content_panel()->selected()) {
709 if (dialog.video() && i->video) {
710 DCPOMATIC_ASSERT (_clipboard->video);
711 i->video->take_settings_from (_clipboard->video);
713 if (dialog.audio() && i->audio) {
714 DCPOMATIC_ASSERT (_clipboard->audio);
715 i->audio->take_settings_from (_clipboard->audio);
719 auto j = i->text.begin ();
720 auto k = _clipboard->text.begin ();
721 while (j != i->text.end() && k != _clipboard->text.end()) {
722 (*j)->take_settings_from (*k);
730 void edit_select_all ()
732 _film_editor->content_panel()->select_all();
735 void edit_preferences ()
737 if (!_config_dialog) {
738 _config_dialog = create_full_config_dialog ();
740 _config_dialog->Show (this);
743 void tools_restore_default_preferences ()
745 wxMessageDialog dialog(
747 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
748 _("Restore default preferences"),
749 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
752 if (dialog.ShowModal() == wxID_YES) {
753 Config::restore_defaults ();
757 void tools_export_preferences ()
760 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
761 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
764 if (dialog.ShowModal() == wxID_OK) {
765 auto const path = boost::filesystem::path(wx_to_std(dialog.GetPath()));
766 if (boost::filesystem::exists(path)) {
767 boost::system::error_code ec;
768 boost::filesystem::remove(path, ec);
770 error_dialog(nullptr, _("Could not remove existing preferences file"), std_to_wx(path.string()));
775 save_all_config_as_zip(path);
779 void jobs_make_dcp ()
785 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
788 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);
790 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);
792 if (!confirm_dialog (this, message)) {
797 if (Config::instance()->show_hints_before_make_dcp()) {
798 HintsDialog hints(this, _film, false);
799 if (hints.ShowModal() == wxID_CANCEL) {
804 if (_film->encrypted ()) {
805 NagDialog::maybe_nag (
807 Config::NAG_ENCRYPTED_METADATA,
808 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
809 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
810 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
811 "if you want to make KDMs for this film.")
815 /* Remove any existing DCP if the user agrees */
816 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
817 if (dcp::filesystem::exists(dcp_dir)) {
818 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
821 dcp::filesystem::remove_all(dcp_dir);
825 /* It seems to make sense to auto-save metadata here, since the make DCP may last
826 a long time, and crashes/power failures are moderately likely.
828 _film->write_metadata ();
829 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
830 } catch (BadSettingError& e) {
831 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
832 } catch (std::exception& e) {
833 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
837 void jobs_make_kdms ()
843 _kdm_dialog.reset(this, _film);
844 _kdm_dialog->Show ();
847 void jobs_make_dkdms ()
853 _dkdm_dialog.reset(this, _film);
854 _dkdm_dialog->Show ();
857 /** @return false if we succeeded, true if not */
858 bool send_to_other_tool (int port, function<void()> start, string message)
860 /* i = 0; try to connect via socket
861 i = 1; try again, and then try to start the tool
862 i = 2 onwards; try again.
864 for (int i = 0; i < 8; ++i) {
866 boost::asio::io_service io_service;
867 boost::asio::ip::tcp::resolver resolver (io_service);
868 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
869 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
871 socket.connect (*endpoint_iterator);
872 DCPOMATIC_ASSERT (_film->directory ());
873 socket.write (message.length() + 1);
874 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
879 } catch (exception& e) {
887 dcpomatic_sleep_seconds (1);
893 void jobs_make_dcp_batch ()
899 if (Config::instance()->show_hints_before_make_dcp()) {
900 HintsDialog hints(this, _film, false);
901 if (hints.ShowModal() == wxID_CANCEL) {
906 _film->write_metadata ();
908 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
910 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
912 error_dialog (this, _("Could not find batch converter."));
917 void jobs_open_dcp_in_player ()
923 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
925 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
927 error_dialog (this, _("Could not find player."));
932 void jobs_make_self_dkdm ()
938 SelfDKDMDialog dialog(this, _film);
939 if (dialog.ShowModal() != wxID_OK) {
943 NagDialog::maybe_nag (
945 Config::NAG_DKDM_CONFIG,
947 _("You are making a DKDM which is encrypted by a private key held in"
948 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
949 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
950 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
955 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
957 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
960 auto signer = Config::instance()->signer_chain();
961 if (!signer->valid()) {
962 error_dialog(this, _("The certificate chain for signing is invalid"));
966 optional<dcp::EncryptedKDM> kdm;
968 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
969 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
970 if (dialog.internal()) {
971 auto dkdms = Config::instance()->dkdms();
972 dkdms->add(make_shared<DKDM>(kdm));
973 Config::instance()->changed ();
975 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
978 } catch (dcp::NotEncryptedError& e) {
979 error_dialog (this, _("CPL's content is not encrypted."));
980 } catch (exception& e) {
981 error_dialog (this, e.what ());
983 error_dialog (this, _("An unknown exception occurred."));
988 void jobs_export_video_file ()
990 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
991 if (dialog.ShowModal() != wxID_OK) {
995 if (dcp::filesystem::exists(dialog.path())) {
996 bool ok = confirm_dialog(
998 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1006 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1008 make_shared<FFmpegEncoder> (
1009 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1011 JobManager::instance()->add (job);
1015 void jobs_export_subtitles ()
1017 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1018 if (dialog.ShowModal() != wxID_OK) {
1021 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1023 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1025 JobManager::instance()->add(job);
1029 void jobs_send_dcp_to_tms ()
1031 _film->send_dcp_to_tms ();
1034 void jobs_show_dcp ()
1036 DCPOMATIC_ASSERT (_film->directory ());
1037 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1038 error_dialog (this, _("Could not show DCP."));
1042 void view_closed_captions ()
1044 _film_viewer.show_closed_captions ();
1047 void view_video_waveform ()
1049 if (!_video_waveform_dialog) {
1050 _video_waveform_dialog.reset(this, _film, _film_viewer);
1053 _video_waveform_dialog->Show ();
1056 void tools_system_information ()
1058 if (!_system_information_dialog) {
1059 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1062 _system_information_dialog->Show ();
1067 if (!_hints_dialog) {
1068 _hints_dialog = new HintsDialog (this, _film, true);
1071 _hints_dialog->Show ();
1074 void tools_encoding_servers ()
1076 if (!_servers_list_dialog) {
1077 _servers_list_dialog = new ServersListDialog (this);
1080 _servers_list_dialog->Show ();
1083 void tools_manage_templates ()
1085 if (!_templates_dialog) {
1086 _templates_dialog.reset(this);
1089 _templates_dialog->Show ();
1092 void tools_check_for_updates ()
1094 _update_news_requested = true;
1095 UpdateChecker::instance()->run();
1098 void tools_send_translations ()
1100 SendI18NDialog dialog(this);
1101 if (dialog.ShowModal() != wxID_OK) {
1106 body += dialog.name() + "\n";
1107 body += dialog.language() + "\n";
1108 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1110 auto translations = I18NHook::translations ();
1111 for (auto i: translations) {
1112 body += i.first + "\n" + i.second + "\n\n";
1114 if (dialog.email().find("@") == string::npos) {
1115 error_dialog (this, _("You must enter a valid email address when sending translations, "
1116 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1118 Emailer emailer(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1120 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1121 } catch (NetworkError& e) {
1122 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1129 AboutDialog dialog(this);
1133 void help_report_a_problem ()
1135 ReportProblemDialog dialog(this, _film);
1136 if (dialog.ShowModal() == wxID_OK) {
1141 bool should_close ()
1143 if (!JobManager::instance()->work_to_do ()) {
1147 wxMessageDialog dialog(
1149 _("There are unfinished jobs; are you sure you want to quit?"),
1150 _("Unfinished jobs"),
1151 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1154 return dialog.ShowModal() == wxID_YES;
1157 void close (wxCloseEvent& ev)
1159 if (!should_close ()) {
1164 if (_film && _film->dirty ()) {
1165 FilmChangedClosingDialog dialog(_film->name());
1166 switch (dialog.run()) {
1168 /* Don't save and carry on to close */
1171 /* Save and carry on to close */
1172 _film->write_metadata ();
1175 /* Veto the event and stop */
1181 /* We don't want to hear about any more configuration changes, since they
1182 cause the File menu to be altered, which itself will be deleted around
1183 now (without, as far as I can see, any way for us to find out).
1185 _config_changed_connection.disconnect ();
1187 /* Also stop hearing about analytics-related stuff */
1188 _analytics_message_connection.disconnect ();
1195 void active_jobs_changed()
1197 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1198 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1199 * it by using an idle callback. This feels quite unpleasant.
1201 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1204 void set_menu_sensitivity ()
1206 auto jobs = JobManager::instance()->get ();
1207 auto i = jobs.begin();
1208 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1211 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1212 bool const have_cpl = _film && !_film->cpls().empty ();
1213 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1214 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1215 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1217 for (auto j: menu_items) {
1219 bool enabled = true;
1221 if ((j.second & NEEDS_FILM) && !_film) {
1225 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1229 if ((j.second & NEEDS_CPL) && !have_cpl) {
1233 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1237 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1241 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1245 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1249 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1253 j.first->Enable (enabled);
1257 /** @return true if the operation that called this method
1258 * should continue, false to abort it.
1261 bool maybe_save_film ()
1267 while (_film->dirty()) {
1268 T dialog(_film->name());
1269 switch (dialog.run()) {
1274 _film->write_metadata();
1276 } catch (exception& e) {
1277 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1278 /* Go round again for another try */
1290 bool maybe_save_then_delete_film ()
1292 bool const r = maybe_save_film<T> ();
1299 void add_item (wxMenu* menu, wxString text, int id, int sens)
1301 auto item = menu->Append (id, text);
1302 menu_items.insert (make_pair (item, sens));
1305 void setup_menu (wxMenuBar* m)
1307 _file_menu = new wxMenu;
1308 /* [Shortcut] Ctrl+N:New film */
1309 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1310 /* [Shortcut] Ctrl+O:Open existing film */
1311 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1312 _file_menu->AppendSeparator ();
1313 /* [Shortcut] Ctrl+S:Save current film */
1314 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1315 _file_menu->AppendSeparator ();
1316 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1317 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1318 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1320 _history_position = _file_menu->GetMenuItems().GetCount();
1322 _file_menu->AppendSeparator ();
1323 /* [Shortcut] Ctrl+W:Close current film */
1324 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1327 _file_menu->AppendSeparator ();
1331 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1333 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1336 auto edit = new wxMenu;
1337 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1338 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1339 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1340 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1341 edit->AppendSeparator ();
1342 /* [Shortcut] Shift+Ctrl+A:Select all content */
1343 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1346 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1348 edit->AppendSeparator ();
1349 /* [Shortcut] Ctrl+P:Open preferences window */
1350 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1353 auto jobs_menu = new wxMenu;
1354 /* [Shortcut] Ctrl+M:Make DCP */
1355 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1356 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1357 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1358 jobs_menu->AppendSeparator ();
1359 /* [Shortcut] Ctrl+K:Make KDMs */
1360 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1361 /* [Shortcut] Ctrl+D:Make DKDMs */
1362 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1363 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1364 jobs_menu->AppendSeparator ();
1365 /* [Shortcut] Ctrl+E:Export video file */
1366 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1367 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1368 jobs_menu->AppendSeparator ();
1369 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1371 #if defined(DCPOMATIC_OSX)
1372 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1373 #elif defined(DCPOMATIC_WINDOWS)
1374 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1376 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1379 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1381 auto view = new wxMenu;
1382 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1383 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1385 auto tools = new wxMenu;
1386 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1387 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1388 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1389 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1390 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1391 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1392 tools->AppendSeparator ();
1393 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1394 tools->AppendSeparator ();
1395 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1397 wxMenu* help = new wxMenu;
1399 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1401 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1403 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1405 m->Append (_file_menu, _("&File"));
1406 m->Append (edit, _("&Edit"));
1407 m->Append (jobs_menu, _("&Jobs"));
1408 m->Append (view, _("&View"));
1409 m->Append (tools, _("&Tools"));
1410 m->Append (help, _("&Help"));
1413 void config_changed (Config::Property what)
1415 /* Instantly save any config changes when using the DCP-o-matic GUI */
1416 if (what == Config::CINEMAS) {
1418 Config::instance()->write_cinemas();
1419 } catch (exception& e) {
1423 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1424 std_to_wx (Config::instance()->cinemas_file().string()).data()
1430 Config::instance()->write_config();
1431 } catch (exception& e) {
1435 _("Could not write to config file at %s. Your changes have not been saved."),
1436 std_to_wx (Config::instance()->cinemas_file().string()).data()
1442 for (int i = 0; i < _history_items; ++i) {
1443 delete _file_menu->Remove (ID_file_history + i);
1446 if (_history_separator) {
1447 _file_menu->Remove (_history_separator);
1449 delete _history_separator;
1450 _history_separator = 0;
1452 int pos = _history_position;
1454 /* Clear out non-existent history items before we re-build the menu */
1455 Config::instance()->clean_history ();
1456 auto history = Config::instance()->history();
1458 if (!history.empty ()) {
1459 _history_separator = _file_menu->InsertSeparator (pos++);
1462 for (size_t i = 0; i < history.size(); ++i) {
1465 s = String::compose ("&%1 %2", i + 1, history[i].string());
1467 s = history[i].string();
1469 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1472 _history_items = history.size ();
1474 dcpomatic_log->set_types (Config::instance()->log_types());
1477 void update_checker_state_changed ()
1479 auto uc = UpdateChecker::instance ();
1481 bool const announce =
1482 _update_news_requested ||
1483 (uc->stable() && Config::instance()->check_for_updates()) ||
1484 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1486 _update_news_requested = false;
1492 if (uc->state() == UpdateChecker::State::YES) {
1493 UpdateDialog dialog(this, uc->stable(), uc->test());
1495 } else if (uc->state() == UpdateChecker::State::FAILED) {
1496 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1498 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1501 _update_news_requested = false;
1504 void start_stop_pressed ()
1506 if (_film_viewer.playing()) {
1507 _film_viewer.stop();
1509 _film_viewer.start();
1513 void timeline_pressed ()
1515 _film_editor->content_panel()->timeline_clicked ();
1520 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1523 void forward_frame ()
1525 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1528 void analytics_message (string title, string html)
1530 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1536 auto s = wx_to_std(_("DCP-o-matic"));
1538 if (_film->directory()) {
1539 s += " - " + _film->directory()->string();
1541 if (_film->dirty()) {
1546 SetTitle (std_to_wx(s));
1549 FilmEditor* _film_editor;
1550 LimitedFrameSplitter* _splitter;
1551 wxPanel* _right_panel;
1552 FilmViewer _film_viewer;
1553 StandardControls* _controls;
1554 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1555 SystemInformationDialog* _system_information_dialog = nullptr;
1556 HintsDialog* _hints_dialog = nullptr;
1557 ServersListDialog* _servers_list_dialog = nullptr;
1558 wxPreferencesEditor* _config_dialog = nullptr;
1559 wx_ptr<KDMDialog> _kdm_dialog;
1560 wx_ptr<DKDMDialog> _dkdm_dialog;
1561 wx_ptr<TemplatesDialog> _templates_dialog;
1562 wxMenu* _file_menu = nullptr;
1563 shared_ptr<Film> _film;
1564 int _history_items = 0;
1565 int _history_position = 0;
1566 wxMenuItem* _history_separator = nullptr;
1567 boost::signals2::scoped_connection _config_changed_connection;
1568 boost::signals2::scoped_connection _analytics_message_connection;
1569 bool _update_news_requested = false;
1570 shared_ptr<Content> _clipboard;
1571 bool _first_shown_called = false;
1575 static const wxCmdLineEntryDesc command_line_description[] = {
1576 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1577 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1578 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1579 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1580 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1581 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1582 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1587 * @brief The magic App class for wxWidgets.
1589 class App : public wxApp
1595 dcpomatic_setup_path_encoding ();
1596 #ifdef DCPOMATIC_LINUX
1603 bool OnInit () override
1607 #if defined(DCPOMATIC_WINDOWS)
1608 if (Config::instance()->win32_console()) {
1611 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1612 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1613 FILE* hf_out = _fdopen(hCrt, "w");
1614 setvbuf(hf_out, NULL, _IONBF, 1);
1617 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1618 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1619 FILE* hf_in = _fdopen(hCrt, "r");
1620 setvbuf(hf_in, NULL, _IONBF, 128);
1623 cout << "DCP-o-matic is starting." << "\n";
1626 wxInitAllImageHandlers ();
1628 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1629 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1631 _splash = maybe_show_splash ();
1633 SetAppName (_("DCP-o-matic"));
1635 if (!wxApp::OnInit()) {
1639 #ifdef DCPOMATIC_LINUX
1640 unsetenv ("UBUNTU_MENUPROXY");
1643 #ifdef DCPOMATIC_OSX
1644 dcpomatic_sleep_seconds (1);
1645 make_foreground_application ();
1648 /* Enable i18n; this will create a Config object
1649 to look for a force-configured language. This Config
1650 object will be wrong, however, because dcpomatic_setup
1651 hasn't yet been called and there aren't any filters etc.
1654 dcpomatic_setup_i18n ();
1656 /* Set things up, including filters etc.
1657 which will now be internationalised correctly.
1661 /* Force the configuration to be re-loaded correctly next
1666 /* We only look out for bad configuration from here on, as before
1667 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1668 incorrect certificate chain validity errors.
1670 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1672 _frame = new DOMFrame (_("DCP-o-matic"));
1673 SetTopWindow (_frame);
1674 _frame->Maximize ();
1677 if (running_32_on_64 ()) {
1678 NagDialog::maybe_nag (
1679 _frame, Config::NAG_32_ON_64,
1680 _("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."),
1686 signal_manager = new wxSignalManager (this);
1687 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1689 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1691 _frame->load_film (_film_to_load);
1692 } catch (exception& e) {
1693 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()));
1697 if (!_film_to_create.empty ()) {
1698 _frame->new_film (_film_to_create, optional<string>());
1699 if (!_content_to_add.empty()) {
1700 for (auto i: content_factory(_content_to_add)) {
1701 _frame->film()->examine_and_add_content(i);
1704 if (!_dcp_to_add.empty ()) {
1705 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1709 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1710 _timer.reset (new wxTimer (this));
1711 _timer->Start (1000);
1713 if (Config::instance()->check_for_updates ()) {
1714 UpdateChecker::instance()->run ();
1717 auto release_notes = find_release_notes(gui_is_dark());
1718 if (release_notes) {
1719 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1724 catch (exception& e)
1727 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1733 void OnInitCmdLine (wxCmdLineParser& parser) override
1735 parser.SetDesc (command_line_description);
1736 parser.SetSwitchChars (wxT ("-"));
1739 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1741 if (parser.Found (wxT("version"))) {
1742 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1743 exit (EXIT_SUCCESS);
1746 if (parser.GetParamCount() > 0) {
1747 if (parser.Found (wxT ("new"))) {
1748 _film_to_create = wx_to_std (parser.GetParam (0));
1750 _film_to_load = wx_to_std (parser.GetParam (0));
1755 if (parser.Found (wxT ("content"), &content)) {
1756 _content_to_add = wx_to_std (content);
1760 if (parser.Found (wxT ("dcp"), &dcp)) {
1761 _dcp_to_add = wx_to_std (dcp);
1765 if (parser.Found (wxT("config"), &config)) {
1766 State::override_path = wx_to_std (config);
1772 void report_exception ()
1776 } catch (FileError& e) {
1780 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1781 std_to_wx (e.what()),
1782 std_to_wx (e.file().string().c_str())
1785 } catch (boost::filesystem::filesystem_error& e) {
1789 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1790 std_to_wx (e.what()),
1791 std_to_wx (e.path1().string()),
1792 std_to_wx (e.path2().string())
1795 } catch (exception& e) {
1799 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1800 std_to_wx (e.what ())
1804 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1808 /* An unhandled exception has occurred inside the main event loop */
1809 bool OnExceptionInMainLoop () override
1811 report_exception ();
1812 /* This will terminate the program */
1816 void OnUnhandledException () override
1818 report_exception ();
1821 void idle (wxIdleEvent& ev)
1823 signal_manager->ui_idle ();
1830 EncodeServerFinder::instance()->rethrow ();
1831 } catch (exception& e) {
1832 error_dialog (0, std_to_wx (e.what ()));
1836 void close_splash ()
1844 void config_failed_to_load (Config::LoadFailure what)
1846 report_config_load_failure(_frame, what);
1849 void config_warning (string m)
1851 message_dialog (_frame, std_to_wx(m));
1854 bool config_bad (Config::BadReason reason)
1856 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1857 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1861 auto config = Config::instance();
1863 case Config::BAD_SIGNER_UTF8_STRINGS:
1865 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1868 RecreateChainDialog dialog(
1869 _frame, _("Recreate signing certificates"),
1870 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1871 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1872 "the certificate chain for signing DCPs and KDMs?"),
1874 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1876 return dialog.ShowModal() == wxID_OK;
1878 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1880 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1883 RecreateChainDialog dialog(
1884 _frame, _("Recreate signing certificates"),
1885 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1886 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1887 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1889 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1891 return dialog.ShowModal() == wxID_OK;
1893 case Config::BAD_SIGNER_INCONSISTENT:
1895 RecreateChainDialog dialog(
1896 _frame, _("Recreate signing certificates"),
1897 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1898 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1899 "the certificate chain for signing DCPs and KDMs?"),
1900 _("Close DCP-o-matic")
1902 if (dialog.ShowModal() != wxID_OK) {
1903 exit (EXIT_FAILURE);
1907 case Config::BAD_DECRYPTION_INCONSISTENT:
1909 RecreateChainDialog dialog(
1910 _frame, _("Recreate KDM decryption chain"),
1911 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1912 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1913 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1914 "configuration before continuing."),
1915 _("Close DCP-o-matic")
1917 if (dialog.ShowModal() != wxID_OK) {
1918 exit (EXIT_FAILURE);
1923 DCPOMATIC_ASSERT (false);
1927 DOMFrame* _frame = nullptr;
1928 wxSplashScreen* _splash = nullptr;
1929 shared_ptr<wxTimer> _timer;
1930 string _film_to_load;
1931 string _film_to_create;
1932 string _content_to_add;