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/screen.h"
84 #include "lib/send_kdm_email_job.h"
85 #include "lib/signal_manager.h"
86 #include "lib/subtitle_encoder.h"
87 #include "lib/text_content.h"
88 #include "lib/transcode_job.h"
89 #include "lib/update_checker.h"
90 #include "lib/version.h"
91 #include "lib/video_content.h"
92 #include <dcp/exceptions.h>
93 #include <dcp/raw_convert.h>
94 #include <dcp/warnings.h>
95 LIBDCP_DISABLE_WARNINGS
96 #include <wx/cmdline.h>
97 #include <wx/generic/aboutdlgg.h>
98 #include <wx/preferences.h>
99 #include <wx/splash.h>
100 #include <wx/stdpaths.h>
101 #include <wx/wxhtml.h>
102 LIBDCP_ENABLE_WARNINGS
104 #include <X11/Xlib.h>
107 #include <shellapi.h>
109 #include <boost/algorithm/string.hpp>
110 #include <boost/filesystem.hpp>
113 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
122 using std::dynamic_pointer_cast;
123 using std::exception;
126 using std::make_pair;
127 using std::make_shared;
129 using std::shared_ptr;
133 using boost::optional;
134 using boost::is_any_of;
135 using boost::algorithm::find;
136 #if BOOST_VERSION >= 106100
137 using namespace boost::placeholders;
139 using dcp::raw_convert;
142 class FilmChangedClosingDialog
145 explicit FilmChangedClosingDialog (string name)
148 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
149 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
150 /// project (Film) has been changed since it was last saved.
152 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
155 _dialog.SetYesNoCancelLabels(
156 _("Save film and close"), _("Close without saving film"), _("Don't close")
162 return _dialog.ShowModal();
166 wxMessageDialog _dialog;
170 class FilmChangedDuplicatingDialog
173 explicit FilmChangedDuplicatingDialog (string name)
176 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
177 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
178 /// project (Film) has been changed since it was last saved.
180 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
183 _dialog.SetYesNoCancelLabels(
184 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
190 return _dialog.ShowModal();
194 wxMessageDialog _dialog;
199 #define NEEDS_FILM 0x1
200 #define NOT_DURING_DCP_CREATION 0x2
201 #define NEEDS_CPL 0x4
202 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
203 #define NEEDS_SELECTED_CONTENT 0x10
204 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
205 #define NEEDS_CLIPBOARD 0x40
206 #define NEEDS_ENCRYPTION 0x80
209 map<wxMenuItem*, int> menu_items;
215 ID_file_save_as_template,
217 ID_file_duplicate_and_open,
219 /* Allow spare IDs after _history for the recent files list */
225 ID_jobs_make_dcp_batch,
228 ID_jobs_make_self_dkdm,
229 ID_jobs_export_video_file,
230 ID_jobs_export_subtitles,
231 ID_jobs_send_dcp_to_tms,
233 ID_jobs_open_dcp_in_player,
234 ID_view_closed_captions,
235 ID_view_video_waveform,
237 ID_tools_encoding_servers,
238 ID_tools_manage_templates,
239 ID_tools_check_for_updates,
240 ID_tools_send_translations,
241 ID_tools_system_information,
242 ID_tools_restore_default_preferences,
243 ID_tools_export_preferences,
244 ID_help_report_a_problem,
245 /* IDs for shortcuts (with no associated menu item) */
255 class LimitedFrameSplitter : public wxSplitterWindow
258 LimitedFrameSplitter(wxWindow* parent)
259 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
261 /* This value doesn't really mean much but we just want to stop double-click on the
262 divider from shrinking the left panel.
264 SetMinimumPaneSize(64);
266 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
269 bool OnSashPositionChange(int new_position) override
271 /* Try to stop the left bit of the splitter getting too small */
272 auto const ok = new_position > _left_panel_minimum_size;
274 Config::instance()->set_main_divider_sash_position(new_position);
280 void sized(wxSizeEvent& ev)
282 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
283 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
284 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
286 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
292 int const _left_panel_minimum_size = 200;
296 class DOMFrame : public wxFrame
299 explicit DOMFrame (wxString const& title)
300 : wxFrame (nullptr, -1, title)
301 /* Use a panel as the only child of the Frame so that we avoid
302 the dark-grey background on Windows.
304 , _splitter(new LimitedFrameSplitter(this))
305 , _right_panel(new wxPanel(_splitter, wxID_ANY))
306 , _film_viewer(_right_panel)
308 #if defined(DCPOMATIC_WINDOWS)
309 if (Config::instance()->win32_console()) {
312 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
313 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
314 FILE* hf_out = _fdopen(hCrt, "w");
315 setvbuf(hf_out, NULL, _IONBF, 1);
318 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
319 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
320 FILE* hf_in = _fdopen(hCrt, "r");
321 setvbuf(hf_in, NULL, _IONBF, 128);
324 cout << "DCP-o-matic is starting." << "\n";
328 auto bar = new wxMenuBar;
332 #ifdef DCPOMATIC_WINDOWS
333 SetIcon (wxIcon (std_to_wx ("id")));
336 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
337 config_changed (Config::OTHER);
339 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
370 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
371 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
372 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
373 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
374 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
375 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
377 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
378 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
380 auto left_panel = new wxPanel(_splitter, wxID_ANY);
382 _film_editor = new FilmEditor(left_panel, _film_viewer);
384 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
385 left_sizer->Add(_film_editor, 1, wxEXPAND);
387 left_panel->SetSizerAndFit(left_sizer);
389 _controls = new StandardControls(_right_panel, _film_viewer, true);
390 auto job_manager_view = new JobManagerView(_right_panel, false);
392 auto right_sizer = new wxBoxSizer (wxVERTICAL);
393 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
394 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
395 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
397 _right_panel->SetSizer(right_sizer);
399 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
401 set_menu_sensitivity ();
403 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
406 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
408 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
410 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
411 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
415 void add_accelerators ()
418 int accelerators = 7;
420 int accelerators = 6;
422 std::vector<wxAcceleratorEntry> accel(accelerators);
423 /* [Shortcut] Ctrl+A:Add file(s) to the film */
424 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
425 /* [Shortcut] Delete:Remove selected content from film */
426 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
427 /* [Shortcut] Space:Start/stop playback */
428 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
429 /* [Shortcut] Ctrl+T:Open timeline window */
430 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
431 /* [Shortcut] Left arrow:Move back one frame */
432 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
433 /* [Shortcut] Right arrow:Move forward one frame */
434 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
436 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
438 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
439 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
440 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
441 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
442 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
443 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
444 wxAcceleratorTable accel_table (accelerators, accel.data());
445 SetAcceleratorTable (accel_table);
448 void remove_accelerators ()
450 SetAcceleratorTable (wxAcceleratorTable ());
453 void remove_clicked (wxCommandEvent& ev)
455 if (_film_editor->content_panel()->remove_clicked (true)) {
460 void new_film (boost::filesystem::path path, optional<string> template_name)
462 auto film = make_shared<Film>(path);
464 film->use_template (template_name.get());
466 film->set_name (path.filename().generic_string());
467 film->write_metadata ();
471 void load_film (boost::filesystem::path file)
474 auto film = make_shared<Film>(file);
475 auto const notes = film->read_metadata ();
477 if (film->state_version() == 4) {
480 _("This film was created with an old version of DVD-o-matic and may not load correctly "
481 "in this version. Please check the film's settings carefully.")
485 for (auto i: notes) {
486 error_dialog (0, std_to_wx(i));
491 JobManager::instance()->add(make_shared<CheckContentJob>(film));
493 catch (FileNotFoundError& e) {
494 auto const dir = e.file().parent_path();
495 if (boost::filesystem::exists(dir / "ASSETMAP") || boost::filesystem::exists(dir / "ASSETMAP.xml")) {
497 this, _("Could not open this folder as a DCP-o-matic project."),
498 _("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.")
501 auto const p = std_to_wx(file.string ());
502 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
505 } catch (std::exception& e) {
506 auto const p = std_to_wx (file.string());
507 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
510 void set_film (shared_ptr<Film> film)
513 _film_viewer.set_film(_film);
514 _film_editor->set_film(_film);
515 _controls->set_film (_film);
516 _video_waveform_dialog.reset();
517 set_menu_sensitivity ();
518 if (_film && _film->directory()) {
519 Config::instance()->add_to_history (_film->directory().get());
522 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
523 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
524 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
525 dcpomatic_log = _film->log ();
530 shared_ptr<Film> film () const {
536 void show (wxShowEvent& ev)
538 if (ev.IsShown() && !_first_shown_called) {
539 _film_editor->first_shown ();
540 _first_shown_called = true;
544 void film_message (string m)
546 message_dialog (this, std_to_wx(m));
549 void film_change (ChangeType type)
551 if (type == ChangeType::DONE) {
552 set_menu_sensitivity ();
558 FilmNameLocationDialog dialog(this, _("New Film"), true);
559 int const r = dialog.ShowModal();
561 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
566 new_film(dialog.path(), dialog.template_name());
567 } catch (boost::filesystem::filesystem_error& e) {
568 #ifdef DCPOMATIC_WINDOWS
569 string bad_chars = "<>:\"/|?*";
570 string const filename = d->path().filename().string();
571 string found_bad_chars;
572 for (size_t i = 0; i < bad_chars.length(); ++i) {
573 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
574 found_bad_chars += bad_chars[i];
577 wxString message = _("Could not create folder to store film.");
579 if (!found_bad_chars.empty()) {
580 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
582 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
584 error_dialog (this, message, std_to_wx(e.what()));
586 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
595 _("Select film to open"),
596 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
597 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
602 r = dialog.ShowModal();
603 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
604 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
610 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
611 load_film(wx_to_std(dialog.GetPath()));
617 _film->write_metadata ();
620 void file_save_as_template ()
622 SaveTemplateDialog dialog(this);
623 if (dialog.ShowModal() == wxID_OK) {
624 Config::instance()->save_template(_film, dialog.name());
628 void file_duplicate ()
630 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
632 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
633 auto film = make_shared<Film>(dialog.path());
634 film->copy_from (_film);
635 film->set_name(dialog.path().filename().generic_string());
636 film->write_metadata ();
640 void file_duplicate_and_open ()
642 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
644 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
645 auto film = make_shared<Film>(dialog.path());
646 film->copy_from (_film);
647 film->set_name(dialog.path().filename().generic_string());
648 film->write_metadata ();
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 DCPOMATIC_ASSERT (sel.size() == 1);
693 _clipboard = sel.front()->clone();
698 DCPOMATIC_ASSERT (_clipboard);
700 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
701 if (dialog.ShowModal() != wxID_OK) {
705 for (auto i: _film_editor->content_panel()->selected()) {
706 if (dialog.video() && i->video) {
707 DCPOMATIC_ASSERT (_clipboard->video);
708 i->video->take_settings_from (_clipboard->video);
710 if (dialog.audio() && i->audio) {
711 DCPOMATIC_ASSERT (_clipboard->audio);
712 i->audio->take_settings_from (_clipboard->audio);
716 auto j = i->text.begin ();
717 auto k = _clipboard->text.begin ();
718 while (j != i->text.end() && k != _clipboard->text.end()) {
719 (*j)->take_settings_from (*k);
727 void edit_select_all ()
729 _film_editor->content_panel()->select_all();
732 void edit_preferences ()
734 if (!_config_dialog) {
735 _config_dialog = create_full_config_dialog ();
737 _config_dialog->Show (this);
740 void tools_restore_default_preferences ()
742 wxMessageDialog dialog(
744 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
745 _("Restore default preferences"),
746 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
749 if (dialog.ShowModal() == wxID_YES) {
750 Config::restore_defaults ();
754 void tools_export_preferences ()
757 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
758 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
761 if (dialog.ShowModal() == wxID_OK) {
762 save_all_config_as_zip(wx_to_std(dialog.GetPath()));
766 void jobs_make_dcp ()
772 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
775 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);
777 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);
779 if (!confirm_dialog (this, message)) {
784 if (Config::instance()->show_hints_before_make_dcp()) {
785 HintsDialog hints(this, _film, false);
786 if (hints.ShowModal() == wxID_CANCEL) {
791 if (_film->encrypted ()) {
792 NagDialog::maybe_nag (
794 Config::NAG_ENCRYPTED_METADATA,
795 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
796 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
797 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
798 "if you want to make KDMs for this film.")
802 /* Remove any existing DCP if the user agrees */
803 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
804 if (boost::filesystem::exists(dcp_dir)) {
805 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
808 boost::filesystem::remove_all (dcp_dir);
812 /* It seems to make sense to auto-save metadata here, since the make DCP may last
813 a long time, and crashes/power failures are moderately likely.
815 _film->write_metadata ();
816 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
817 } catch (BadSettingError& e) {
818 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
819 } catch (std::exception& e) {
820 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
824 void jobs_make_kdms ()
830 _kdm_dialog.reset(this, _film);
831 _kdm_dialog->Show ();
834 void jobs_make_dkdms ()
840 _dkdm_dialog.reset(this, _film);
841 _dkdm_dialog->Show ();
844 /** @return false if we succeeded, true if not */
845 bool send_to_other_tool (int port, function<void()> start, string message)
847 /* i = 0; try to connect via socket
848 i = 1; try again, and then try to start the tool
849 i = 2 onwards; try again.
851 for (int i = 0; i < 8; ++i) {
853 boost::asio::io_service io_service;
854 boost::asio::ip::tcp::resolver resolver (io_service);
855 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
856 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
858 socket.connect (*endpoint_iterator);
859 DCPOMATIC_ASSERT (_film->directory ());
860 socket.write (message.length() + 1);
861 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
866 } catch (exception& e) {
874 dcpomatic_sleep_seconds (1);
880 void jobs_make_dcp_batch ()
886 if (Config::instance()->show_hints_before_make_dcp()) {
887 HintsDialog hints(this, _film, false);
888 if (hints.ShowModal() == wxID_CANCEL) {
893 _film->write_metadata ();
895 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
897 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
899 error_dialog (this, _("Could not find batch converter."));
904 void jobs_open_dcp_in_player ()
910 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
912 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
914 error_dialog (this, _("Could not find player."));
919 void jobs_make_self_dkdm ()
925 SelfDKDMDialog dialog(this, _film);
926 if (dialog.ShowModal() != wxID_OK) {
930 NagDialog::maybe_nag (
932 Config::NAG_DKDM_CONFIG,
934 _("You are making a DKDM which is encrypted by a private key held in"
935 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
936 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
937 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
942 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
944 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
947 optional<dcp::EncryptedKDM> kdm;
949 kdm = _film->make_kdm (
950 Config::instance()->decryption_chain()->leaf(),
954 dcp::Formulation::MODIFIED_TRANSITIONAL_1,
958 } catch (dcp::NotEncryptedError& e) {
959 error_dialog (this, _("CPL's content is not encrypted."));
960 } catch (exception& e) {
961 error_dialog (this, e.what ());
963 error_dialog (this, _("An unknown exception occurred."));
967 if (dialog.internal()) {
968 auto dkdms = Config::instance()->dkdms();
969 dkdms->add (make_shared<DKDM>(kdm.get()));
970 Config::instance()->changed ();
972 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
979 void jobs_export_video_file ()
981 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
982 if (dialog.ShowModal() != wxID_OK) {
986 if (boost::filesystem::exists(dialog.path())) {
987 bool ok = confirm_dialog(
989 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
997 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
999 make_shared<FFmpegEncoder> (
1000 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1002 JobManager::instance()->add (job);
1006 void jobs_export_subtitles ()
1008 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1009 if (dialog.ShowModal() != wxID_OK) {
1012 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1014 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1016 JobManager::instance()->add(job);
1020 void jobs_send_dcp_to_tms ()
1022 _film->send_dcp_to_tms ();
1025 void jobs_show_dcp ()
1027 DCPOMATIC_ASSERT (_film->directory ());
1028 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1029 error_dialog (this, _("Could not show DCP."));
1033 void view_closed_captions ()
1035 _film_viewer.show_closed_captions ();
1038 void view_video_waveform ()
1040 if (!_video_waveform_dialog) {
1041 _video_waveform_dialog.reset(this, _film, _film_viewer);
1044 _video_waveform_dialog->Show ();
1047 void tools_system_information ()
1049 if (!_system_information_dialog) {
1050 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1053 _system_information_dialog->Show ();
1058 if (!_hints_dialog) {
1059 _hints_dialog = new HintsDialog (this, _film, true);
1062 _hints_dialog->Show ();
1065 void tools_encoding_servers ()
1067 if (!_servers_list_dialog) {
1068 _servers_list_dialog = new ServersListDialog (this);
1071 _servers_list_dialog->Show ();
1074 void tools_manage_templates ()
1076 if (!_templates_dialog) {
1077 _templates_dialog.reset(this);
1080 _templates_dialog->Show ();
1083 void tools_check_for_updates ()
1085 _update_news_requested = true;
1086 UpdateChecker::instance()->run();
1089 void tools_send_translations ()
1091 SendI18NDialog dialog(this);
1092 if (dialog.ShowModal() != wxID_OK) {
1097 body += dialog.name() + "\n";
1098 body += dialog.language() + "\n";
1099 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1101 auto translations = I18NHook::translations ();
1102 for (auto i: translations) {
1103 body += i.first + "\n" + i.second + "\n\n";
1105 list<string> to = { "carl@dcpomatic.com" };
1106 if (dialog.email().find("@") == string::npos) {
1107 error_dialog (this, _("You must enter a valid email address when sending translations, "
1108 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1110 Emailer emailer(dialog.email(), to, "DCP-o-matic translations", body);
1112 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1113 } catch (NetworkError& e) {
1114 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1121 AboutDialog dialog(this);
1125 void help_report_a_problem ()
1127 ReportProblemDialog dialog(this, _film);
1128 if (dialog.ShowModal() == wxID_OK) {
1133 bool should_close ()
1135 if (!JobManager::instance()->work_to_do ()) {
1139 wxMessageDialog dialog(
1141 _("There are unfinished jobs; are you sure you want to quit?"),
1142 _("Unfinished jobs"),
1143 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1146 return dialog.ShowModal() == wxID_YES;
1149 void close (wxCloseEvent& ev)
1151 if (!should_close ()) {
1156 if (_film && _film->dirty ()) {
1157 FilmChangedClosingDialog dialog(_film->name());
1158 switch (dialog.run()) {
1160 /* Don't save and carry on to close */
1163 /* Save and carry on to close */
1164 _film->write_metadata ();
1167 /* Veto the event and stop */
1173 /* We don't want to hear about any more configuration changes, since they
1174 cause the File menu to be altered, which itself will be deleted around
1175 now (without, as far as I can see, any way for us to find out).
1177 _config_changed_connection.disconnect ();
1179 /* Also stop hearing about analytics-related stuff */
1180 _analytics_message_connection.disconnect ();
1185 void active_jobs_changed()
1187 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1188 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1189 * it by using an idle callback. This feels quite unpleasant.
1191 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1194 void set_menu_sensitivity ()
1196 auto jobs = JobManager::instance()->get ();
1197 auto i = jobs.begin();
1198 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1201 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1202 bool const have_cpl = _film && !_film->cpls().empty ();
1203 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1204 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1205 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1207 for (auto j: menu_items) {
1209 bool enabled = true;
1211 if ((j.second & NEEDS_FILM) && !_film) {
1215 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1219 if ((j.second & NEEDS_CPL) && !have_cpl) {
1223 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1227 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1231 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1235 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1239 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1243 j.first->Enable (enabled);
1247 /** @return true if the operation that called this method
1248 * should continue, false to abort it.
1251 bool maybe_save_film ()
1257 if (_film->dirty ()) {
1258 T d (_film->name ());
1263 _film->write_metadata ();
1274 bool maybe_save_then_delete_film ()
1276 bool const r = maybe_save_film<T> ();
1283 void add_item (wxMenu* menu, wxString text, int id, int sens)
1285 auto item = menu->Append (id, text);
1286 menu_items.insert (make_pair (item, sens));
1289 void setup_menu (wxMenuBar* m)
1291 _file_menu = new wxMenu;
1292 /* [Shortcut] Ctrl+N:New film */
1293 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1294 /* [Shortcut] Ctrl+O:Open existing film */
1295 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1296 _file_menu->AppendSeparator ();
1297 /* [Shortcut] Ctrl+S:Save current film */
1298 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1299 _file_menu->AppendSeparator ();
1300 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1301 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1302 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1304 _history_position = _file_menu->GetMenuItems().GetCount();
1306 _file_menu->AppendSeparator ();
1307 /* [Shortcut] Ctrl+W:Close current film */
1308 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1311 _file_menu->AppendSeparator ();
1315 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1317 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1320 auto edit = new wxMenu;
1321 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1322 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1323 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1324 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1325 edit->AppendSeparator ();
1326 /* [Shortcut] Shift+Ctrl+A:Select all content */
1327 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1330 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1332 edit->AppendSeparator ();
1333 /* [Shortcut] Ctrl+P:Open preferences window */
1334 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1337 auto jobs_menu = new wxMenu;
1338 /* [Shortcut] Ctrl+M:Make DCP */
1339 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1340 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1341 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1342 jobs_menu->AppendSeparator ();
1343 /* [Shortcut] Ctrl+K:Make KDMs */
1344 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1345 /* [Shortcut] Ctrl+D:Make DKDMs */
1346 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1347 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1348 jobs_menu->AppendSeparator ();
1349 /* [Shortcut] Ctrl+E:Export video file */
1350 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1351 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1352 jobs_menu->AppendSeparator ();
1353 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1355 #if defined(DCPOMATIC_OSX)
1356 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1357 #elif defined(DCPOMATIC_WINDOWS)
1358 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1360 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1363 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1365 auto view = new wxMenu;
1366 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1367 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1369 auto tools = new wxMenu;
1370 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1371 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1372 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1373 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1374 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1375 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1376 tools->AppendSeparator ();
1377 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1378 tools->AppendSeparator ();
1379 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1381 wxMenu* help = new wxMenu;
1383 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1385 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1387 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1389 m->Append (_file_menu, _("&File"));
1390 m->Append (edit, _("&Edit"));
1391 m->Append (jobs_menu, _("&Jobs"));
1392 m->Append (view, _("&View"));
1393 m->Append (tools, _("&Tools"));
1394 m->Append (help, _("&Help"));
1397 void config_changed (Config::Property what)
1399 /* Instantly save any config changes when using the DCP-o-matic GUI */
1400 if (what == Config::CINEMAS) {
1402 Config::instance()->write_cinemas();
1403 } catch (exception& e) {
1407 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1408 std_to_wx (Config::instance()->cinemas_file().string()).data()
1414 Config::instance()->write_config();
1415 } catch (exception& e) {
1419 _("Could not write to config file at %s. Your changes have not been saved."),
1420 std_to_wx (Config::instance()->cinemas_file().string()).data()
1426 for (int i = 0; i < _history_items; ++i) {
1427 delete _file_menu->Remove (ID_file_history + i);
1430 if (_history_separator) {
1431 _file_menu->Remove (_history_separator);
1433 delete _history_separator;
1434 _history_separator = 0;
1436 int pos = _history_position;
1438 /* Clear out non-existent history items before we re-build the menu */
1439 Config::instance()->clean_history ();
1440 auto history = Config::instance()->history();
1442 if (!history.empty ()) {
1443 _history_separator = _file_menu->InsertSeparator (pos++);
1446 for (size_t i = 0; i < history.size(); ++i) {
1449 s = String::compose ("&%1 %2", i + 1, history[i].string());
1451 s = history[i].string();
1453 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1456 _history_items = history.size ();
1458 dcpomatic_log->set_types (Config::instance()->log_types());
1461 void update_checker_state_changed ()
1463 auto uc = UpdateChecker::instance ();
1465 bool const announce =
1466 _update_news_requested ||
1467 (uc->stable() && Config::instance()->check_for_updates()) ||
1468 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1470 _update_news_requested = false;
1476 if (uc->state() == UpdateChecker::State::YES) {
1477 UpdateDialog dialog(this, uc->stable(), uc->test());
1479 } else if (uc->state() == UpdateChecker::State::FAILED) {
1480 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1482 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1485 _update_news_requested = false;
1488 void start_stop_pressed ()
1490 if (_film_viewer.playing()) {
1491 _film_viewer.stop();
1493 _film_viewer.start();
1497 void timeline_pressed ()
1499 _film_editor->content_panel()->timeline_clicked ();
1504 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1507 void forward_frame ()
1509 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1512 void analytics_message (string title, string html)
1514 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1520 auto s = wx_to_std(_("DCP-o-matic"));
1522 if (_film->directory()) {
1523 s += " - " + _film->directory()->string();
1525 if (_film->dirty()) {
1530 SetTitle (std_to_wx(s));
1533 FilmEditor* _film_editor;
1534 LimitedFrameSplitter* _splitter;
1535 wxPanel* _right_panel;
1536 FilmViewer _film_viewer;
1537 StandardControls* _controls;
1538 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1539 SystemInformationDialog* _system_information_dialog = nullptr;
1540 HintsDialog* _hints_dialog = nullptr;
1541 ServersListDialog* _servers_list_dialog = nullptr;
1542 wxPreferencesEditor* _config_dialog = nullptr;
1543 wx_ptr<KDMDialog> _kdm_dialog;
1544 wx_ptr<DKDMDialog> _dkdm_dialog;
1545 wx_ptr<TemplatesDialog> _templates_dialog;
1546 wxMenu* _file_menu = nullptr;
1547 shared_ptr<Film> _film;
1548 int _history_items = 0;
1549 int _history_position = 0;
1550 wxMenuItem* _history_separator = nullptr;
1551 boost::signals2::scoped_connection _config_changed_connection;
1552 boost::signals2::scoped_connection _analytics_message_connection;
1553 bool _update_news_requested = false;
1554 shared_ptr<Content> _clipboard;
1555 bool _first_shown_called = false;
1559 static const wxCmdLineEntryDesc command_line_description[] = {
1560 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1561 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1562 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1563 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1564 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1565 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1566 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1571 * @brief The magic App class for wxWidgets.
1573 class App : public wxApp
1579 #ifdef DCPOMATIC_LINUX
1586 bool OnInit () override
1589 wxInitAllImageHandlers ();
1591 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1592 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1594 _splash = maybe_show_splash ();
1596 SetAppName (_("DCP-o-matic"));
1598 if (!wxApp::OnInit()) {
1602 #ifdef DCPOMATIC_LINUX
1603 unsetenv ("UBUNTU_MENUPROXY");
1606 #ifdef DCPOMATIC_OSX
1607 dcpomatic_sleep_seconds (1);
1608 make_foreground_application ();
1611 dcpomatic_setup_path_encoding ();
1613 /* Enable i18n; this will create a Config object
1614 to look for a force-configured language. This Config
1615 object will be wrong, however, because dcpomatic_setup
1616 hasn't yet been called and there aren't any filters etc.
1619 dcpomatic_setup_i18n ();
1621 /* Set things up, including filters etc.
1622 which will now be internationalised correctly.
1626 /* Force the configuration to be re-loaded correctly next
1631 /* We only look out for bad configuration from here on, as before
1632 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1633 incorrect certificate chain validity errors.
1635 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1637 _frame = new DOMFrame (_("DCP-o-matic"));
1638 SetTopWindow (_frame);
1639 _frame->Maximize ();
1642 if (running_32_on_64 ()) {
1643 NagDialog::maybe_nag (
1644 _frame, Config::NAG_32_ON_64,
1645 _("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."),
1651 signal_manager = new wxSignalManager (this);
1652 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1654 if (!_film_to_load.empty() && boost::filesystem::is_directory(_film_to_load)) {
1656 _frame->load_film (_film_to_load);
1657 } catch (exception& e) {
1658 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()));
1662 if (!_film_to_create.empty ()) {
1663 _frame->new_film (_film_to_create, optional<string>());
1664 if (!_content_to_add.empty()) {
1665 for (auto i: content_factory(_content_to_add)) {
1666 _frame->film()->examine_and_add_content(i);
1669 if (!_dcp_to_add.empty ()) {
1670 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1674 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1675 _timer.reset (new wxTimer (this));
1676 _timer->Start (1000);
1678 if (Config::instance()->check_for_updates ()) {
1679 UpdateChecker::instance()->run ();
1682 auto release_notes = find_release_notes(gui_is_dark());
1683 if (release_notes) {
1684 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1689 catch (exception& e)
1692 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1698 void OnInitCmdLine (wxCmdLineParser& parser) override
1700 parser.SetDesc (command_line_description);
1701 parser.SetSwitchChars (wxT ("-"));
1704 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1706 if (parser.Found (wxT("version"))) {
1707 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1708 exit (EXIT_SUCCESS);
1711 if (parser.GetParamCount() > 0) {
1712 if (parser.Found (wxT ("new"))) {
1713 _film_to_create = wx_to_std (parser.GetParam (0));
1715 _film_to_load = wx_to_std (parser.GetParam (0));
1720 if (parser.Found (wxT ("content"), &content)) {
1721 _content_to_add = wx_to_std (content);
1725 if (parser.Found (wxT ("dcp"), &dcp)) {
1726 _dcp_to_add = wx_to_std (dcp);
1730 if (parser.Found (wxT("config"), &config)) {
1731 State::override_path = wx_to_std (config);
1737 void report_exception ()
1741 } catch (FileError& e) {
1745 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1746 std_to_wx (e.what()),
1747 std_to_wx (e.file().string().c_str())
1750 } catch (boost::filesystem::filesystem_error& e) {
1754 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1755 std_to_wx (e.what()),
1756 std_to_wx (e.path1().string()),
1757 std_to_wx (e.path2().string())
1760 } catch (exception& e) {
1764 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1765 std_to_wx (e.what ())
1769 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1773 /* An unhandled exception has occurred inside the main event loop */
1774 bool OnExceptionInMainLoop () override
1776 report_exception ();
1777 /* This will terminate the program */
1781 void OnUnhandledException () override
1783 report_exception ();
1786 void idle (wxIdleEvent& ev)
1788 signal_manager->ui_idle ();
1795 EncodeServerFinder::instance()->rethrow ();
1796 } catch (exception& e) {
1797 error_dialog (0, std_to_wx (e.what ()));
1801 void close_splash ()
1806 void config_failed_to_load (Config::LoadFailure what)
1808 report_config_load_failure(_frame, what);
1811 void config_warning (string m)
1813 message_dialog (_frame, std_to_wx(m));
1816 bool config_bad (Config::BadReason reason)
1818 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1819 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1823 auto config = Config::instance();
1825 case Config::BAD_SIGNER_UTF8_STRINGS:
1827 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1830 RecreateChainDialog dialog(
1831 _frame, _("Recreate signing certificates"),
1832 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1833 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1834 "the certificate chain for signing DCPs and KDMs?"),
1836 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1838 return dialog.ShowModal() == wxID_OK;
1840 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1842 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1845 RecreateChainDialog dialog(
1846 _frame, _("Recreate signing certificates"),
1847 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1848 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1849 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1851 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1853 return dialog.ShowModal() == wxID_OK;
1855 case Config::BAD_SIGNER_INCONSISTENT:
1857 RecreateChainDialog dialog(
1858 _frame, _("Recreate signing certificates"),
1859 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1860 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1861 "the certificate chain for signing DCPs and KDMs?"),
1862 _("Close DCP-o-matic")
1864 if (dialog.ShowModal() != wxID_OK) {
1865 exit (EXIT_FAILURE);
1869 case Config::BAD_DECRYPTION_INCONSISTENT:
1871 RecreateChainDialog dialog(
1872 _frame, _("Recreate KDM decryption chain"),
1873 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1874 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1875 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1876 "configuration before continuing."),
1877 _("Close DCP-o-matic")
1879 if (dialog.ShowModal() != wxID_OK) {
1880 exit (EXIT_FAILURE);
1885 DCPOMATIC_ASSERT (false);
1889 DOMFrame* _frame = nullptr;
1890 wx_ptr<wxSplashScreen> _splash;
1891 shared_ptr<wxTimer> _timer;
1892 string _film_to_load;
1893 string _film_to_create;
1894 string _content_to_add;