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/hints.h"
78 #include "lib/job_manager.h"
79 #include "lib/kdm_with_metadata.h"
81 #include "lib/make_dcp.h"
82 #include "lib/release_notes.h"
83 #include "lib/scope_guard.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/raw_convert.h>
95 #include <dcp/warnings.h>
96 LIBDCP_DISABLE_WARNINGS
97 #include <wx/cmdline.h>
98 #include <wx/generic/aboutdlgg.h>
99 #include <wx/preferences.h>
100 #include <wx/splash.h>
101 #include <wx/stdpaths.h>
102 #include <wx/wxhtml.h>
103 LIBDCP_ENABLE_WARNINGS
105 #include <X11/Xlib.h>
108 #include <shellapi.h>
110 #include <boost/algorithm/string.hpp>
111 #include <boost/filesystem.hpp>
114 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
123 using std::dynamic_pointer_cast;
124 using std::exception;
127 using std::make_pair;
128 using std::make_shared;
130 using std::shared_ptr;
134 using boost::optional;
135 using boost::is_any_of;
136 using boost::algorithm::find;
137 #if BOOST_VERSION >= 106100
138 using namespace boost::placeholders;
140 using dcp::raw_convert;
143 class FilmChangedClosingDialog
146 explicit FilmChangedClosingDialog (string name)
148 _dialog = new wxMessageDialog (
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")
162 ~FilmChangedClosingDialog ()
167 FilmChangedClosingDialog (FilmChangedClosingDialog const&) = delete;
168 FilmChangedClosingDialog& operator= (FilmChangedClosingDialog const&) = delete;
172 return _dialog->ShowModal ();
176 wxMessageDialog* _dialog;
180 class FilmChangedDuplicatingDialog
183 explicit FilmChangedDuplicatingDialog (string name)
185 _dialog = new wxMessageDialog (
187 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
188 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
189 /// project (Film) has been changed since it was last saved.
191 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
194 _dialog->SetYesNoCancelLabels (
195 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
199 ~FilmChangedDuplicatingDialog ()
204 FilmChangedDuplicatingDialog (FilmChangedDuplicatingDialog const&) = delete;
205 FilmChangedDuplicatingDialog& operator= (FilmChangedDuplicatingDialog const&) = delete;
209 return _dialog->ShowModal ();
213 wxMessageDialog* _dialog;
218 #define NEEDS_FILM 0x1
219 #define NOT_DURING_DCP_CREATION 0x2
220 #define NEEDS_CPL 0x4
221 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
222 #define NEEDS_SELECTED_CONTENT 0x10
223 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
224 #define NEEDS_CLIPBOARD 0x40
225 #define NEEDS_ENCRYPTION 0x80
228 map<wxMenuItem*, int> menu_items;
234 ID_file_save_as_template,
236 ID_file_duplicate_and_open,
238 /* Allow spare IDs after _history for the recent files list */
244 ID_jobs_make_dcp_batch,
247 ID_jobs_make_self_dkdm,
248 ID_jobs_export_video_file,
249 ID_jobs_export_subtitles,
250 ID_jobs_send_dcp_to_tms,
252 ID_jobs_open_dcp_in_player,
253 ID_view_closed_captions,
254 ID_view_video_waveform,
256 ID_tools_encoding_servers,
257 ID_tools_manage_templates,
258 ID_tools_check_for_updates,
259 ID_tools_send_translations,
260 ID_tools_system_information,
261 ID_tools_restore_default_preferences,
262 ID_tools_export_preferences,
263 ID_help_report_a_problem,
264 /* IDs for shortcuts (with no associated menu item) */
274 class LimitedFrameSplitter : public wxSplitterWindow
277 LimitedFrameSplitter(wxWindow* parent)
278 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
280 /* This value doesn't really mean much but we just want to stop double-click on the
281 divider from shrinking the left panel.
283 SetMinimumPaneSize(64);
285 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
288 bool OnSashPositionChange(int new_position) override
290 /* Try to stop the left bit of the splitter getting too small */
291 auto const ok = new_position > _left_panel_minimum_size;
293 Config::instance()->set_main_divider_sash_position(new_position);
299 void sized(wxSizeEvent& ev)
301 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
302 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
303 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
305 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
311 int const _left_panel_minimum_size = 200;
315 class DOMFrame : public wxFrame
318 explicit DOMFrame (wxString const& title)
319 : wxFrame (nullptr, -1, title)
320 /* Use a panel as the only child of the Frame so that we avoid
321 the dark-grey background on Windows.
323 , _splitter(new LimitedFrameSplitter(this))
324 , _right_panel(new wxPanel(_splitter, wxID_ANY))
325 , _film_viewer(_right_panel)
327 #if defined(DCPOMATIC_WINDOWS)
328 if (Config::instance()->win32_console()) {
331 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
332 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
333 FILE* hf_out = _fdopen(hCrt, "w");
334 setvbuf(hf_out, NULL, _IONBF, 1);
337 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
338 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
339 FILE* hf_in = _fdopen(hCrt, "r");
340 setvbuf(hf_in, NULL, _IONBF, 128);
343 cout << "DCP-o-matic is starting." << "\n";
347 auto bar = new wxMenuBar;
351 #ifdef DCPOMATIC_WINDOWS
352 SetIcon (wxIcon (std_to_wx ("id")));
355 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
356 config_changed (Config::OTHER);
358 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
370 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
371 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
372 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
373 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
374 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
375 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
376 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
377 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
378 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
379 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
380 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
381 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
382 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
383 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
384 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
385 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
386 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
387 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
388 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
389 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
390 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
391 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
392 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
393 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
394 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
396 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
397 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
399 auto left_panel = new wxPanel(_splitter, wxID_ANY);
401 _film_editor = new FilmEditor(left_panel, _film_viewer);
403 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
404 left_sizer->Add(_film_editor, 1, wxEXPAND);
406 left_panel->SetSizerAndFit(left_sizer);
408 _controls = new StandardControls(_right_panel, _film_viewer, true);
409 auto job_manager_view = new JobManagerView(_right_panel, false);
411 auto right_sizer = new wxBoxSizer (wxVERTICAL);
412 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
413 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
414 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
416 _right_panel->SetSizer(right_sizer);
418 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
420 set_menu_sensitivity ();
422 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
425 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
427 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
429 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
430 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
434 void add_accelerators ()
437 int accelerators = 7;
439 int accelerators = 6;
441 std::vector<wxAcceleratorEntry> accel(accelerators);
442 /* [Shortcut] Ctrl+A:Add file(s) to the film */
443 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
444 /* [Shortcut] Delete:Remove selected content from film */
445 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
446 /* [Shortcut] Space:Start/stop playback */
447 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
448 /* [Shortcut] Ctrl+T:Open timeline window */
449 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
450 /* [Shortcut] Left arrow:Move back one frame */
451 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
452 /* [Shortcut] Right arrow:Move forward one frame */
453 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
455 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
457 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
458 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
459 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
460 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
461 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
462 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
463 wxAcceleratorTable accel_table (accelerators, accel.data());
464 SetAcceleratorTable (accel_table);
467 void remove_accelerators ()
469 SetAcceleratorTable (wxAcceleratorTable ());
472 void remove_clicked (wxCommandEvent& ev)
474 if (_film_editor->content_panel()->remove_clicked (true)) {
479 void new_film (boost::filesystem::path path, optional<string> template_name)
481 auto film = make_shared<Film>(path);
483 film->use_template (template_name.get());
485 film->set_name (path.filename().generic_string());
486 film->write_metadata ();
490 void load_film (boost::filesystem::path file)
493 auto film = make_shared<Film>(file);
494 auto const notes = film->read_metadata ();
496 if (film->state_version() == 4) {
499 _("This film was created with an old version of DVD-o-matic and may not load correctly "
500 "in this version. Please check the film's settings carefully.")
504 for (auto i: notes) {
505 error_dialog (0, std_to_wx(i));
510 JobManager::instance()->add(make_shared<CheckContentJob>(film));
512 catch (FileNotFoundError& e) {
513 auto const dir = e.file().parent_path();
514 if (boost::filesystem::exists(dir / "ASSETMAP") || boost::filesystem::exists(dir / "ASSETMAP.xml")) {
516 this, _("Could not open this folder as a DCP-o-matic project."),
517 _("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.")
520 auto const p = std_to_wx(file.string ());
521 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
524 } catch (std::exception& e) {
525 auto const p = std_to_wx (file.string());
526 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
529 void set_film (shared_ptr<Film> film)
532 _film_viewer.set_film(_film);
533 _film_editor->set_film(_film);
534 _controls->set_film (_film);
535 if (_video_waveform_dialog) {
536 _video_waveform_dialog->Destroy ();
537 _video_waveform_dialog = nullptr;
539 set_menu_sensitivity ();
540 if (_film && _film->directory()) {
541 Config::instance()->add_to_history (_film->directory().get());
544 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
545 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
546 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
547 dcpomatic_log = _film->log ();
552 shared_ptr<Film> film () const {
558 void show (wxShowEvent& ev)
560 if (ev.IsShown() && !_first_shown_called) {
561 _film_editor->first_shown ();
562 _first_shown_called = true;
566 void film_message (string m)
568 message_dialog (this, std_to_wx(m));
571 void film_change (ChangeType type)
573 if (type == ChangeType::DONE) {
574 set_menu_sensitivity ();
580 auto d = new FilmNameLocationDialog (this, _("New Film"), true);
581 ScopeGuard sg = [d]() { d->Destroy(); };
582 int const r = d->ShowModal ();
584 if (r != wxID_OK || !d->check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
589 new_film (d->path(), d->template_name());
590 } catch (boost::filesystem::filesystem_error& e) {
591 #ifdef DCPOMATIC_WINDOWS
592 string bad_chars = "<>:\"/|?*";
593 string const filename = d->path().filename().string();
594 string found_bad_chars;
595 for (size_t i = 0; i < bad_chars.length(); ++i) {
596 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
597 found_bad_chars += bad_chars[i];
600 wxString message = _("Could not create folder to store film.");
602 if (!found_bad_chars.empty()) {
603 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
605 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
607 error_dialog (this, message, std_to_wx(e.what()));
609 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
616 auto c = new wxDirDialog (
618 _("Select film to open"),
619 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
620 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
622 ScopeGuard sg = [c]() { c->Destroy(); };
627 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
628 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
634 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
635 load_film (wx_to_std (c->GetPath ()));
641 _film->write_metadata ();
644 void file_save_as_template ()
646 auto d = new SaveTemplateDialog (this);
647 ScopeGuard sg = [d]() { d->Destroy(); };
648 if (d->ShowModal() == wxID_OK) {
649 Config::instance()->save_template (_film, d->name ());
653 void file_duplicate ()
655 auto d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
656 ScopeGuard sg = [d]() { d->Destroy(); };
658 if (d->ShowModal() == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
659 shared_ptr<Film> film (new Film (d->path()));
660 film->copy_from (_film);
661 film->set_name (d->path().filename().generic_string());
662 film->write_metadata ();
666 void file_duplicate_and_open ()
668 auto d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
669 ScopeGuard sg = [d]() { d->Destroy(); };
671 if (d->ShowModal() == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
672 shared_ptr<Film> film (new Film (d->path()));
673 film->copy_from (_film);
674 film->set_name (d->path().filename().generic_string());
675 film->write_metadata ();
682 if (_film && _film->dirty ()) {
684 auto dialog = new FilmChangedClosingDialog (_film->name ());
685 int const r = dialog->run ();
690 /* Don't save and carry on to close */
693 /* Save and carry on to close */
694 _film->write_metadata ();
702 set_film (shared_ptr<Film>());
705 void file_history (wxCommandEvent& event)
707 auto history = Config::instance()->history ();
708 int n = event.GetId() - ID_file_history;
709 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
710 load_film (history[n]);
716 /* false here allows the close handler to veto the close request */
722 auto const sel = _film_editor->content_panel()->selected();
723 DCPOMATIC_ASSERT (sel.size() == 1);
724 _clipboard = sel.front()->clone();
729 DCPOMATIC_ASSERT (_clipboard);
731 auto d = new PasteDialog (this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
732 ScopeGuard sg = [d]() { d->Destroy(); };
733 if (d->ShowModal() != wxID_OK) {
737 for (auto i: _film_editor->content_panel()->selected()) {
738 if (d->video() && i->video) {
739 DCPOMATIC_ASSERT (_clipboard->video);
740 i->video->take_settings_from (_clipboard->video);
742 if (d->audio() && i->audio) {
743 DCPOMATIC_ASSERT (_clipboard->audio);
744 i->audio->take_settings_from (_clipboard->audio);
748 auto j = i->text.begin ();
749 auto k = _clipboard->text.begin ();
750 while (j != i->text.end() && k != _clipboard->text.end()) {
751 (*j)->take_settings_from (*k);
759 void edit_select_all ()
761 _film_editor->content_panel()->select_all();
764 void edit_preferences ()
766 if (!_config_dialog) {
767 _config_dialog = create_full_config_dialog ();
769 _config_dialog->Show (this);
772 void tools_restore_default_preferences ()
774 auto d = new wxMessageDialog (
776 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
777 _("Restore default preferences"),
778 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
780 ScopeGuard sg = [d]() { d->Destroy(); };
782 if (d->ShowModal() == wxID_YES) {
783 Config::restore_defaults ();
787 void tools_export_preferences ()
789 auto dialog = new wxFileDialog (
790 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
791 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
793 ScopeGuard sg = [dialog]() { dialog->Destroy(); };
795 if (dialog->ShowModal() == wxID_OK) {
796 save_all_config_as_zip (wx_to_std(dialog->GetPath()));
800 void jobs_make_dcp ()
806 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
809 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);
811 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);
813 if (!confirm_dialog (this, message)) {
818 if (Config::instance()->show_hints_before_make_dcp()) {
819 auto hints = new HintsDialog (this, _film, false);
820 ScopeGuard sg = [hints]() { hints->Destroy(); };
821 if (hints->ShowModal() == wxID_CANCEL) {
826 if (_film->encrypted ()) {
827 NagDialog::maybe_nag (
829 Config::NAG_ENCRYPTED_METADATA,
830 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
831 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
832 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
833 "if you want to make KDMs for this film.")
837 /* Remove any existing DCP if the user agrees */
838 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
839 if (boost::filesystem::exists(dcp_dir)) {
840 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
843 boost::filesystem::remove_all (dcp_dir);
847 /* It seems to make sense to auto-save metadata here, since the make DCP may last
848 a long time, and crashes/power failures are moderately likely.
850 _film->write_metadata ();
851 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
852 } catch (BadSettingError& e) {
853 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
854 } catch (std::exception& e) {
855 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
859 void jobs_make_kdms ()
866 _kdm_dialog->Destroy ();
870 _kdm_dialog = new KDMDialog (this, _film);
871 _kdm_dialog->Show ();
874 void jobs_make_dkdms ()
881 _dkdm_dialog->Destroy ();
882 _dkdm_dialog = nullptr;
885 _dkdm_dialog = new DKDMDialog (this, _film);
886 _dkdm_dialog->Show ();
889 /** @return false if we succeeded, true if not */
890 bool send_to_other_tool (int port, function<void()> start, string message)
892 /* i = 0; try to connect via socket
893 i = 1; try again, and then try to start the tool
894 i = 2 onwards; try again.
896 for (int i = 0; i < 8; ++i) {
898 boost::asio::io_service io_service;
899 boost::asio::ip::tcp::resolver resolver (io_service);
900 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
901 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
903 socket.connect (*endpoint_iterator);
904 DCPOMATIC_ASSERT (_film->directory ());
905 socket.write (message.length() + 1);
906 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
911 } catch (exception& e) {
919 dcpomatic_sleep_seconds (1);
925 void jobs_make_dcp_batch ()
931 if (Config::instance()->show_hints_before_make_dcp()) {
932 auto hints = new HintsDialog (this, _film, false);
933 ScopeGuard sg = [hints]() { hints->Destroy(); };
934 if (hints->ShowModal() == wxID_CANCEL) {
939 _film->write_metadata ();
941 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
943 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
945 error_dialog (this, _("Could not find batch converter."));
950 void jobs_open_dcp_in_player ()
956 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
958 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
960 error_dialog (this, _("Could not find player."));
965 void jobs_make_self_dkdm ()
971 auto d = new SelfDKDMDialog (this, _film);
972 ScopeGuard sg = [d]() { d->Destroy(); };
973 if (d->ShowModal () != wxID_OK) {
977 NagDialog::maybe_nag (
979 Config::NAG_DKDM_CONFIG,
981 _("You are making a DKDM which is encrypted by a private key held in"
982 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
983 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
984 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
989 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
991 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
994 optional<dcp::EncryptedKDM> kdm;
996 kdm = _film->make_kdm (
997 Config::instance()->decryption_chain()->leaf(),
1001 dcp::Formulation::MODIFIED_TRANSITIONAL_1,
1005 } catch (dcp::NotEncryptedError& e) {
1006 error_dialog (this, _("CPL's content is not encrypted."));
1007 } catch (exception& e) {
1008 error_dialog (this, e.what ());
1010 error_dialog (this, _("An unknown exception occurred."));
1014 if (d->internal ()) {
1015 auto dkdms = Config::instance()->dkdms();
1016 dkdms->add (make_shared<DKDM>(kdm.get()));
1017 Config::instance()->changed ();
1019 auto path = d->directory() / (_film->dcp_name(false) + "_DKDM.xml");
1026 void jobs_export_video_file ()
1028 auto d = new ExportVideoFileDialog (this, _film->isdcf_name(true));
1029 ScopeGuard sg = [d]() { d->Destroy(); };
1030 if (d->ShowModal() != wxID_OK) {
1034 if (boost::filesystem::exists(d->path())) {
1035 bool ok = confirm_dialog(
1037 wxString::Format (_("File %s already exists. Do you want to overwrite it?"), std_to_wx(d->path().string()).data())
1045 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1047 make_shared<FFmpegEncoder> (
1048 _film, job, d->path(), d->format(), d->mixdown_to_stereo(), d->split_reels(), d->split_streams(), d->x264_crf())
1050 JobManager::instance()->add (job);
1054 void jobs_export_subtitles ()
1056 auto d = new ExportSubtitlesDialog (this, _film->reels().size(), _film->interop());
1057 ScopeGuard sg = [d]() { d->Destroy(); };
1058 if (d->ShowModal() != wxID_OK) {
1061 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1063 make_shared<SubtitleEncoder>(_film, job, d->path(), _film->isdcf_name(true), d->split_reels(), d->include_font())
1065 JobManager::instance()->add(job);
1069 void jobs_send_dcp_to_tms ()
1071 _film->send_dcp_to_tms ();
1074 void jobs_show_dcp ()
1076 DCPOMATIC_ASSERT (_film->directory ());
1077 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1078 error_dialog (this, _("Could not show DCP."));
1082 void view_closed_captions ()
1084 _film_viewer.show_closed_captions ();
1087 void view_video_waveform ()
1089 if (!_video_waveform_dialog) {
1090 _video_waveform_dialog = new VideoWaveformDialog (this, _film, _film_viewer);
1093 _video_waveform_dialog->Show ();
1096 void tools_system_information ()
1098 if (!_system_information_dialog) {
1099 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1102 _system_information_dialog->Show ();
1107 if (!_hints_dialog) {
1108 _hints_dialog = new HintsDialog (this, _film, true);
1111 _hints_dialog->Show ();
1114 void tools_encoding_servers ()
1116 if (!_servers_list_dialog) {
1117 _servers_list_dialog = new ServersListDialog (this);
1120 _servers_list_dialog->Show ();
1123 void tools_manage_templates ()
1125 if (!_templates_dialog) {
1126 _templates_dialog = new TemplatesDialog (this);
1129 _templates_dialog->Show ();
1132 void tools_check_for_updates ()
1134 _update_news_requested = true;
1135 UpdateChecker::instance()->run();
1138 void tools_send_translations ()
1140 auto d = new SendI18NDialog (this);
1141 ScopeGuard sg = [d]() { d->Destroy(); };
1142 if (d->ShowModal() == wxID_OK) {
1144 body += d->name() + "\n";
1145 body += d->language() + "\n";
1146 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1148 auto translations = I18NHook::translations ();
1149 for (auto i: translations) {
1150 body += i.first + "\n" + i.second + "\n\n";
1152 list<string> to = { "carl@dcpomatic.com" };
1153 if (d->email().find("@") == string::npos) {
1154 error_dialog (this, _("You must enter a valid email address when sending translations, "
1155 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1157 Emailer emailer (d->email(), to, "DCP-o-matic translations", body);
1159 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1160 } catch (NetworkError& e) {
1161 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1169 auto d = new AboutDialog (this);
1170 ScopeGuard sg = [d]() { d->Destroy(); };
1174 void help_report_a_problem ()
1176 auto d = new ReportProblemDialog (this, _film);
1177 ScopeGuard sg = [d]() { d->Destroy(); };
1178 if (d->ShowModal () == wxID_OK) {
1183 bool should_close ()
1185 if (!JobManager::instance()->work_to_do ()) {
1189 auto d = new wxMessageDialog (
1191 _("There are unfinished jobs; are you sure you want to quit?"),
1192 _("Unfinished jobs"),
1193 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1195 ScopeGuard sg = [d]() { d->Destroy(); };
1197 return d->ShowModal() == wxID_YES;
1200 void close (wxCloseEvent& ev)
1202 if (!should_close ()) {
1207 if (_film && _film->dirty ()) {
1209 auto dialog = new FilmChangedClosingDialog (_film->name ());
1210 int const r = dialog->run ();
1215 /* Don't save and carry on to close */
1218 /* Save and carry on to close */
1219 _film->write_metadata ();
1222 /* Veto the event and stop */
1228 /* We don't want to hear about any more configuration changes, since they
1229 cause the File menu to be altered, which itself will be deleted around
1230 now (without, as far as I can see, any way for us to find out).
1232 _config_changed_connection.disconnect ();
1234 /* Also stop hearing about analytics-related stuff */
1235 _analytics_message_connection.disconnect ();
1240 void active_jobs_changed()
1242 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1243 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1244 * it by using an idle callback. This feels quite unpleasant.
1246 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1249 void set_menu_sensitivity ()
1251 auto jobs = JobManager::instance()->get ();
1252 auto i = jobs.begin();
1253 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1256 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1257 bool const have_cpl = _film && !_film->cpls().empty ();
1258 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1259 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1260 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1262 for (auto j: menu_items) {
1264 bool enabled = true;
1266 if ((j.second & NEEDS_FILM) && !_film) {
1270 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1274 if ((j.second & NEEDS_CPL) && !have_cpl) {
1278 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1282 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1286 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1290 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1294 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1298 j.first->Enable (enabled);
1302 /** @return true if the operation that called this method
1303 * should continue, false to abort it.
1306 bool maybe_save_film ()
1312 if (_film->dirty ()) {
1313 T d (_film->name ());
1318 _film->write_metadata ();
1329 bool maybe_save_then_delete_film ()
1331 bool const r = maybe_save_film<T> ();
1338 void add_item (wxMenu* menu, wxString text, int id, int sens)
1340 auto item = menu->Append (id, text);
1341 menu_items.insert (make_pair (item, sens));
1344 void setup_menu (wxMenuBar* m)
1346 _file_menu = new wxMenu;
1347 /* [Shortcut] Ctrl+N:New film */
1348 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1349 /* [Shortcut] Ctrl+O:Open existing film */
1350 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1351 _file_menu->AppendSeparator ();
1352 /* [Shortcut] Ctrl+S:Save current film */
1353 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1354 _file_menu->AppendSeparator ();
1355 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1356 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1357 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1359 _history_position = _file_menu->GetMenuItems().GetCount();
1361 _file_menu->AppendSeparator ();
1362 /* [Shortcut] Ctrl+W:Close current film */
1363 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1366 _file_menu->AppendSeparator ();
1370 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1372 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1375 auto edit = new wxMenu;
1376 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1377 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1378 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1379 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1380 edit->AppendSeparator ();
1381 /* [Shortcut] Shift+Ctrl+A:Select all content */
1382 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1385 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1387 edit->AppendSeparator ();
1388 /* [Shortcut] Ctrl+P:Open preferences window */
1389 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1392 auto jobs_menu = new wxMenu;
1393 /* [Shortcut] Ctrl+M:Make DCP */
1394 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1395 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1396 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1397 jobs_menu->AppendSeparator ();
1398 /* [Shortcut] Ctrl+K:Make KDMs */
1399 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1400 /* [Shortcut] Ctrl+D:Make DKDMs */
1401 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1402 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1403 jobs_menu->AppendSeparator ();
1404 /* [Shortcut] Ctrl+E:Export video file */
1405 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1406 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1407 jobs_menu->AppendSeparator ();
1408 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1410 #if defined(DCPOMATIC_OSX)
1411 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1412 #elif defined(DCPOMATIC_WINDOWS)
1413 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1415 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1418 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1420 auto view = new wxMenu;
1421 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1422 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1424 auto tools = new wxMenu;
1425 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1426 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1427 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1428 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1429 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1430 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1431 tools->AppendSeparator ();
1432 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1433 tools->AppendSeparator ();
1434 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1436 wxMenu* help = new wxMenu;
1438 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1440 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1442 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1444 m->Append (_file_menu, _("&File"));
1445 m->Append (edit, _("&Edit"));
1446 m->Append (jobs_menu, _("&Jobs"));
1447 m->Append (view, _("&View"));
1448 m->Append (tools, _("&Tools"));
1449 m->Append (help, _("&Help"));
1452 void config_changed (Config::Property what)
1454 /* Instantly save any config changes when using the DCP-o-matic GUI */
1455 if (what == Config::CINEMAS) {
1457 Config::instance()->write_cinemas();
1458 } catch (exception& e) {
1462 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1463 std_to_wx (Config::instance()->cinemas_file().string()).data()
1469 Config::instance()->write_config();
1470 } catch (exception& e) {
1474 _("Could not write to config file at %s. Your changes have not been saved."),
1475 std_to_wx (Config::instance()->cinemas_file().string()).data()
1481 for (int i = 0; i < _history_items; ++i) {
1482 delete _file_menu->Remove (ID_file_history + i);
1485 if (_history_separator) {
1486 _file_menu->Remove (_history_separator);
1488 delete _history_separator;
1489 _history_separator = 0;
1491 int pos = _history_position;
1493 /* Clear out non-existent history items before we re-build the menu */
1494 Config::instance()->clean_history ();
1495 auto history = Config::instance()->history();
1497 if (!history.empty ()) {
1498 _history_separator = _file_menu->InsertSeparator (pos++);
1501 for (size_t i = 0; i < history.size(); ++i) {
1504 s = String::compose ("&%1 %2", i + 1, history[i].string());
1506 s = history[i].string();
1508 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1511 _history_items = history.size ();
1513 dcpomatic_log->set_types (Config::instance()->log_types());
1516 void update_checker_state_changed ()
1518 auto uc = UpdateChecker::instance ();
1520 bool const announce =
1521 _update_news_requested ||
1522 (uc->stable() && Config::instance()->check_for_updates()) ||
1523 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1525 _update_news_requested = false;
1531 if (uc->state() == UpdateChecker::State::YES) {
1532 auto dialog = new UpdateDialog (this, uc->stable(), uc->test());
1533 ScopeGuard sg = [dialog]() { dialog->Destroy(); };
1534 dialog->ShowModal ();
1535 } else if (uc->state() == UpdateChecker::State::FAILED) {
1536 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1538 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1541 _update_news_requested = false;
1544 void start_stop_pressed ()
1546 if (_film_viewer.playing()) {
1547 _film_viewer.stop();
1549 _film_viewer.start();
1553 void timeline_pressed ()
1555 _film_editor->content_panel()->timeline_clicked ();
1560 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1563 void forward_frame ()
1565 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1568 void analytics_message (string title, string html)
1570 auto d = new HTMLDialog(this, std_to_wx(title), std_to_wx(html));
1571 ScopeGuard sg = [d]() { d->Destroy(); };
1577 auto s = wx_to_std(_("DCP-o-matic"));
1579 if (_film->directory()) {
1580 s += " - " + _film->directory()->string();
1582 if (_film->dirty()) {
1587 SetTitle (std_to_wx(s));
1590 FilmEditor* _film_editor;
1591 LimitedFrameSplitter* _splitter;
1592 wxPanel* _right_panel;
1593 FilmViewer _film_viewer;
1594 StandardControls* _controls;
1595 VideoWaveformDialog* _video_waveform_dialog = nullptr;
1596 SystemInformationDialog* _system_information_dialog = nullptr;
1597 HintsDialog* _hints_dialog = nullptr;
1598 ServersListDialog* _servers_list_dialog = nullptr;
1599 wxPreferencesEditor* _config_dialog = nullptr;
1600 KDMDialog* _kdm_dialog = nullptr;
1601 DKDMDialog* _dkdm_dialog = nullptr;
1602 TemplatesDialog* _templates_dialog = nullptr;
1603 wxMenu* _file_menu = nullptr;
1604 shared_ptr<Film> _film;
1605 int _history_items = 0;
1606 int _history_position = 0;
1607 wxMenuItem* _history_separator = nullptr;
1608 boost::signals2::scoped_connection _config_changed_connection;
1609 boost::signals2::scoped_connection _analytics_message_connection;
1610 bool _update_news_requested = false;
1611 shared_ptr<Content> _clipboard;
1612 bool _first_shown_called = false;
1616 static const wxCmdLineEntryDesc command_line_description[] = {
1617 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1618 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1619 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1620 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1621 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1622 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1623 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1628 * @brief The magic App class for wxWidgets.
1630 class App : public wxApp
1636 #ifdef DCPOMATIC_LINUX
1643 bool OnInit () override
1646 wxInitAllImageHandlers ();
1648 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1649 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1651 _splash = maybe_show_splash ();
1653 SetAppName (_("DCP-o-matic"));
1655 if (!wxApp::OnInit()) {
1659 #ifdef DCPOMATIC_LINUX
1660 unsetenv ("UBUNTU_MENUPROXY");
1663 #ifdef DCPOMATIC_OSX
1664 dcpomatic_sleep_seconds (1);
1665 make_foreground_application ();
1668 dcpomatic_setup_path_encoding ();
1670 /* Enable i18n; this will create a Config object
1671 to look for a force-configured language. This Config
1672 object will be wrong, however, because dcpomatic_setup
1673 hasn't yet been called and there aren't any filters etc.
1676 dcpomatic_setup_i18n ();
1678 /* Set things up, including filters etc.
1679 which will now be internationalised correctly.
1683 /* Force the configuration to be re-loaded correctly next
1688 /* We only look out for bad configuration from here on, as before
1689 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1690 incorrect certificate chain validity errors.
1692 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1694 _frame = new DOMFrame (_("DCP-o-matic"));
1695 SetTopWindow (_frame);
1696 _frame->Maximize ();
1699 if (running_32_on_64 ()) {
1700 NagDialog::maybe_nag (
1701 _frame, Config::NAG_32_ON_64,
1702 _("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."),
1708 signal_manager = new wxSignalManager (this);
1709 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1711 if (!_film_to_load.empty() && boost::filesystem::is_directory(_film_to_load)) {
1713 _frame->load_film (_film_to_load);
1714 } catch (exception& e) {
1715 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()));
1719 if (!_film_to_create.empty ()) {
1720 _frame->new_film (_film_to_create, optional<string>());
1721 if (!_content_to_add.empty()) {
1722 for (auto i: content_factory(_content_to_add)) {
1723 _frame->film()->examine_and_add_content(i);
1726 if (!_dcp_to_add.empty ()) {
1727 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1731 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1732 _timer.reset (new wxTimer (this));
1733 _timer->Start (1000);
1735 if (Config::instance()->check_for_updates ()) {
1736 UpdateChecker::instance()->run ();
1739 auto release_notes = find_release_notes(gui_is_dark());
1740 if (release_notes) {
1741 auto notes = new HTMLDialog(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1742 ScopeGuard sg = [notes]() { notes->Destroy(); };
1747 catch (exception& e)
1750 _splash->Destroy ();
1753 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1759 void OnInitCmdLine (wxCmdLineParser& parser) override
1761 parser.SetDesc (command_line_description);
1762 parser.SetSwitchChars (wxT ("-"));
1765 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1767 if (parser.Found (wxT("version"))) {
1768 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1769 exit (EXIT_SUCCESS);
1772 if (parser.GetParamCount() > 0) {
1773 if (parser.Found (wxT ("new"))) {
1774 _film_to_create = wx_to_std (parser.GetParam (0));
1776 _film_to_load = wx_to_std (parser.GetParam (0));
1781 if (parser.Found (wxT ("content"), &content)) {
1782 _content_to_add = wx_to_std (content);
1786 if (parser.Found (wxT ("dcp"), &dcp)) {
1787 _dcp_to_add = wx_to_std (dcp);
1791 if (parser.Found (wxT("config"), &config)) {
1792 State::override_path = wx_to_std (config);
1798 void report_exception ()
1802 } catch (FileError& e) {
1806 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1807 std_to_wx (e.what()),
1808 std_to_wx (e.file().string().c_str())
1811 } catch (boost::filesystem::filesystem_error& e) {
1815 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1816 std_to_wx (e.what()),
1817 std_to_wx (e.path1().string()),
1818 std_to_wx (e.path2().string())
1821 } catch (exception& e) {
1825 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1826 std_to_wx (e.what ())
1830 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1834 /* An unhandled exception has occurred inside the main event loop */
1835 bool OnExceptionInMainLoop () override
1837 report_exception ();
1838 /* This will terminate the program */
1842 void OnUnhandledException () override
1844 report_exception ();
1847 void idle (wxIdleEvent& ev)
1849 signal_manager->ui_idle ();
1856 EncodeServerFinder::instance()->rethrow ();
1857 } catch (exception& e) {
1858 error_dialog (0, std_to_wx (e.what ()));
1862 void close_splash ()
1865 _splash->Destroy ();
1870 void config_failed_to_load (Config::LoadFailure what)
1872 report_config_load_failure(_frame, what);
1875 void config_warning (string m)
1877 message_dialog (_frame, std_to_wx(m));
1880 bool config_bad (Config::BadReason reason)
1882 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1883 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1885 _splash->Destroy ();
1888 auto config = Config::instance();
1890 case Config::BAD_SIGNER_UTF8_STRINGS:
1892 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1895 auto d = new RecreateChainDialog (
1896 _frame, _("Recreate signing certificates"),
1897 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1898 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1899 "the certificate chain for signing DCPs and KDMs?"),
1901 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1903 ScopeGuard sg = [d]() { d->Destroy(); };
1904 return d->ShowModal() == wxID_OK;
1906 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1908 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1911 auto d = new RecreateChainDialog (
1912 _frame, _("Recreate signing certificates"),
1913 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1914 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1915 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1917 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1919 ScopeGuard sg = [d]() { d->Destroy(); };
1920 return d->ShowModal() == wxID_OK;
1922 case Config::BAD_SIGNER_INCONSISTENT:
1924 auto d = new RecreateChainDialog (
1925 _frame, _("Recreate signing certificates"),
1926 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1927 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1928 "the certificate chain for signing DCPs and KDMs?"),
1929 _("Close DCP-o-matic")
1931 ScopeGuard sg = [d]() { d->Destroy(); };
1932 if (d->ShowModal() != wxID_OK) {
1933 exit (EXIT_FAILURE);
1937 case Config::BAD_DECRYPTION_INCONSISTENT:
1939 auto d = new RecreateChainDialog (
1940 _frame, _("Recreate KDM decryption chain"),
1941 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1942 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1943 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1944 "configuration before continuing."),
1945 _("Close DCP-o-matic")
1947 ScopeGuard sg = [d]() { d->Destroy(); };
1948 if (d->ShowModal() != wxID_OK) {
1949 exit (EXIT_FAILURE);
1954 DCPOMATIC_ASSERT (false);
1958 DOMFrame* _frame = nullptr;
1959 wxSplashScreen* _splash = nullptr;
1960 shared_ptr<wxTimer> _timer;
1961 string _film_to_load;
1962 string _film_to_create;
1963 string _content_to_add;