2 Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
22 /** @file src/tools/dcpomatic.cc
23 * @brief The main DCP-o-matic GUI.
27 #include "wx/about_dialog.h"
28 #include "wx/content_panel.h"
29 #include "wx/dkdm_dialog.h"
30 #include "wx/export_subtitles_dialog.h"
31 #include "wx/export_video_file_dialog.h"
32 #include "wx/film_editor.h"
33 #include "wx/film_name_location_dialog.h"
34 #include "wx/film_viewer.h"
35 #include "wx/focus_manager.h"
36 #include "wx/full_config_dialog.h"
37 #include "wx/hints_dialog.h"
38 #include "wx/html_dialog.h"
39 #include "wx/i18n_hook.h"
40 #include "wx/job_manager_view.h"
41 #include "wx/kdm_dialog.h"
42 #include "wx/nag_dialog.h"
43 #include "wx/paste_dialog.h"
44 #include "wx/recreate_chain_dialog.h"
45 #include "wx/report_problem_dialog.h"
46 #include "wx/save_template_dialog.h"
47 #include "wx/self_dkdm_dialog.h"
48 #include "wx/send_i18n_dialog.h"
49 #include "wx/servers_list_dialog.h"
50 #include "wx/standard_controls.h"
51 #include "wx/system_information_dialog.h"
52 #include "wx/templates_dialog.h"
53 #include "wx/update_dialog.h"
54 #include "wx/video_waveform_dialog.h"
55 #include "wx/wx_signal_manager.h"
56 #include "wx/wx_util.h"
57 #include "lib/analytics.h"
58 #include "lib/audio_content.h"
59 #include "lib/check_content_job.h"
60 #include "lib/cinema.h"
61 #include "lib/compose.hpp"
62 #include "lib/config.h"
63 #include "lib/constants.h"
64 #include "lib/content.h"
65 #include "lib/content_factory.h"
66 #include "lib/cross.h"
67 #include "lib/cross.h"
68 #include "lib/dcp_content.h"
69 #include "lib/dcpomatic_log.h"
70 #include "lib/dcpomatic_socket.h"
71 #include "lib/dkdm_wrapper.h"
72 #include "lib/emailer.h"
73 #include "lib/encode_server_finder.h"
74 #include "lib/exceptions.h"
75 #include "lib/ffmpeg_encoder.h"
77 #include "lib/font_config.h"
78 #include "lib/hints.h"
79 #include "lib/job_manager.h"
80 #include "lib/kdm_with_metadata.h"
82 #include "lib/make_dcp.h"
83 #include "lib/release_notes.h"
84 #include "lib/screen.h"
85 #include "lib/send_kdm_email_job.h"
86 #include "lib/signal_manager.h"
87 #include "lib/subtitle_encoder.h"
88 #include "lib/text_content.h"
89 #include "lib/transcode_job.h"
90 #include "lib/update_checker.h"
91 #include "lib/version.h"
92 #include "lib/video_content.h"
93 #include <dcp/exceptions.h>
94 #include <dcp/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)
149 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
150 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
151 /// project (Film) has been changed since it was last saved.
153 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
156 _dialog.SetYesNoCancelLabels(
157 _("Save film and close"), _("Close without saving film"), _("Don't close")
163 return _dialog.ShowModal();
167 wxMessageDialog _dialog;
171 class FilmChangedDuplicatingDialog
174 explicit FilmChangedDuplicatingDialog (string name)
177 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
178 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
179 /// project (Film) has been changed since it was last saved.
181 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
184 _dialog.SetYesNoCancelLabels(
185 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
191 return _dialog.ShowModal();
195 wxMessageDialog _dialog;
200 #define NEEDS_FILM 0x1
201 #define NOT_DURING_DCP_CREATION 0x2
202 #define NEEDS_CPL 0x4
203 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
204 #define NEEDS_SELECTED_CONTENT 0x10
205 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
206 #define NEEDS_CLIPBOARD 0x40
207 #define NEEDS_ENCRYPTION 0x80
210 map<wxMenuItem*, int> menu_items;
216 ID_file_save_as_template,
218 ID_file_duplicate_and_open,
220 /* Allow spare IDs after _history for the recent files list */
226 ID_jobs_make_dcp_batch,
229 ID_jobs_make_self_dkdm,
230 ID_jobs_export_video_file,
231 ID_jobs_export_subtitles,
232 ID_jobs_send_dcp_to_tms,
234 ID_jobs_open_dcp_in_player,
235 ID_view_closed_captions,
236 ID_view_video_waveform,
238 ID_tools_encoding_servers,
239 ID_tools_manage_templates,
240 ID_tools_check_for_updates,
241 ID_tools_send_translations,
242 ID_tools_system_information,
243 ID_tools_restore_default_preferences,
244 ID_tools_export_preferences,
245 ID_help_report_a_problem,
246 /* IDs for shortcuts (with no associated menu item) */
256 class LimitedFrameSplitter : public wxSplitterWindow
259 LimitedFrameSplitter(wxWindow* parent)
260 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
262 /* This value doesn't really mean much but we just want to stop double-click on the
263 divider from shrinking the left panel.
265 SetMinimumPaneSize(64);
267 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
270 bool OnSashPositionChange(int new_position) override
272 /* Try to stop the left bit of the splitter getting too small */
273 auto const ok = new_position > _left_panel_minimum_size;
275 Config::instance()->set_main_divider_sash_position(new_position);
281 void sized(wxSizeEvent& ev)
283 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
284 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
285 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
287 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
293 int const _left_panel_minimum_size = 200;
297 class DOMFrame : public wxFrame
300 explicit DOMFrame (wxString const& title)
301 : wxFrame (nullptr, -1, title)
302 /* Use a panel as the only child of the Frame so that we avoid
303 the dark-grey background on Windows.
305 , _splitter(new LimitedFrameSplitter(this))
306 , _right_panel(new wxPanel(_splitter, wxID_ANY))
307 , _film_viewer(_right_panel)
309 #if defined(DCPOMATIC_WINDOWS)
310 if (Config::instance()->win32_console()) {
313 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
314 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
315 FILE* hf_out = _fdopen(hCrt, "w");
316 setvbuf(hf_out, NULL, _IONBF, 1);
319 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
320 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
321 FILE* hf_in = _fdopen(hCrt, "r");
322 setvbuf(hf_in, NULL, _IONBF, 128);
325 cout << "DCP-o-matic is starting." << "\n";
329 auto bar = new wxMenuBar;
333 #ifdef DCPOMATIC_WINDOWS
334 SetIcon (wxIcon (std_to_wx ("id")));
337 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
338 config_changed (Config::OTHER);
340 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
370 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
371 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
372 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
373 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
374 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
375 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
376 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
378 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
379 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
381 auto left_panel = new wxPanel(_splitter, wxID_ANY);
383 _film_editor = new FilmEditor(left_panel, _film_viewer);
385 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
386 left_sizer->Add(_film_editor, 1, wxEXPAND);
388 left_panel->SetSizerAndFit(left_sizer);
390 _controls = new StandardControls(_right_panel, _film_viewer, true);
391 auto job_manager_view = new JobManagerView(_right_panel, false);
393 auto right_sizer = new wxBoxSizer (wxVERTICAL);
394 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
395 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
396 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
398 _right_panel->SetSizer(right_sizer);
400 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
402 set_menu_sensitivity ();
404 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
407 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
409 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
411 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
412 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
416 void add_accelerators ()
419 int accelerators = 7;
421 int accelerators = 6;
423 std::vector<wxAcceleratorEntry> accel(accelerators);
424 /* [Shortcut] Ctrl+A:Add file(s) to the film */
425 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
426 /* [Shortcut] Delete:Remove selected content from film */
427 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
428 /* [Shortcut] Space:Start/stop playback */
429 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
430 /* [Shortcut] Ctrl+T:Open timeline window */
431 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
432 /* [Shortcut] Left arrow:Move back one frame */
433 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
434 /* [Shortcut] Right arrow:Move forward one frame */
435 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
437 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
439 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
440 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
441 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
442 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
443 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
444 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
445 wxAcceleratorTable accel_table (accelerators, accel.data());
446 SetAcceleratorTable (accel_table);
449 void remove_accelerators ()
451 SetAcceleratorTable (wxAcceleratorTable ());
454 void remove_clicked (wxCommandEvent& ev)
456 if (_film_editor->content_panel()->remove_clicked (true)) {
461 void new_film (boost::filesystem::path path, optional<string> template_name)
463 auto film = make_shared<Film>(path);
465 film->use_template (template_name.get());
467 film->set_name (path.filename().generic_string());
468 film->write_metadata ();
472 void load_film (boost::filesystem::path file)
475 auto film = make_shared<Film>(file);
476 auto const notes = film->read_metadata ();
478 if (film->state_version() == 4) {
481 _("This film was created with an old version of DVD-o-matic and may not load correctly "
482 "in this version. Please check the film's settings carefully.")
486 for (auto i: notes) {
487 error_dialog (0, std_to_wx(i));
492 JobManager::instance()->add(make_shared<CheckContentJob>(film));
494 catch (FileNotFoundError& e) {
495 auto const dir = e.file().parent_path();
496 if (boost::filesystem::exists(dir / "ASSETMAP") || boost::filesystem::exists(dir / "ASSETMAP.xml")) {
498 this, _("Could not open this folder as a DCP-o-matic project."),
499 _("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.")
502 auto const p = std_to_wx(file.string ());
503 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
506 } catch (std::exception& e) {
507 auto const p = std_to_wx (file.string());
508 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
511 void set_film (shared_ptr<Film> film)
514 _film_viewer.set_film(_film);
515 _film_editor->set_film(_film);
516 _controls->set_film (_film);
517 _video_waveform_dialog.reset();
518 set_menu_sensitivity ();
519 if (_film && _film->directory()) {
520 Config::instance()->add_to_history (_film->directory().get());
523 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
524 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
525 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
526 dcpomatic_log = _film->log ();
531 shared_ptr<Film> film () const {
537 void show (wxShowEvent& ev)
539 if (ev.IsShown() && !_first_shown_called) {
540 _film_editor->first_shown ();
541 _first_shown_called = true;
545 void film_message (string m)
547 message_dialog (this, std_to_wx(m));
550 void film_change (ChangeType type)
552 if (type == ChangeType::DONE) {
553 set_menu_sensitivity ();
559 FilmNameLocationDialog dialog(this, _("New Film"), true);
560 int const r = dialog.ShowModal();
562 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
567 new_film(dialog.path(), dialog.template_name());
568 } catch (boost::filesystem::filesystem_error& e) {
569 #ifdef DCPOMATIC_WINDOWS
570 string bad_chars = "<>:\"/|?*";
571 string const filename = dialog.path().filename().string();
572 string found_bad_chars;
573 for (size_t i = 0; i < bad_chars.length(); ++i) {
574 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
575 found_bad_chars += bad_chars[i];
578 wxString message = _("Could not create folder to store film.");
580 if (!found_bad_chars.empty()) {
581 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
583 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
585 error_dialog (this, message, std_to_wx(e.what()));
587 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
596 _("Select film to open"),
597 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
598 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
603 r = dialog.ShowModal();
604 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
605 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
611 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
612 load_film(wx_to_std(dialog.GetPath()));
619 _film->write_metadata ();
620 } catch (exception& e) {
621 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
625 void file_save_as_template ()
627 SaveTemplateDialog dialog(this);
628 if (dialog.ShowModal() == wxID_OK) {
630 Config::instance()->save_template(_film, dialog.name());
631 } catch (exception& e) {
632 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
637 void file_duplicate ()
639 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
641 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
642 auto film = make_shared<Film>(dialog.path());
643 film->copy_from (_film);
644 film->set_name(dialog.path().filename().generic_string());
646 film->write_metadata();
647 } catch (exception& e) {
648 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
653 void file_duplicate_and_open ()
655 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
657 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
658 auto film = make_shared<Film>(dialog.path());
659 film->copy_from (_film);
660 film->set_name(dialog.path().filename().generic_string());
662 film->write_metadata ();
664 } catch (exception& e) {
665 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
672 if (_film && _film->dirty ()) {
673 FilmChangedClosingDialog dialog(_film->name());
674 switch (dialog.run()) {
676 /* Don't save and carry on to close */
679 /* Save and carry on to close */
680 _film->write_metadata ();
688 set_film (shared_ptr<Film>());
691 void file_history (wxCommandEvent& event)
693 auto history = Config::instance()->history ();
694 int n = event.GetId() - ID_file_history;
695 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
696 load_film (history[n]);
702 /* false here allows the close handler to veto the close request */
708 auto const sel = _film_editor->content_panel()->selected();
709 DCPOMATIC_ASSERT (sel.size() == 1);
710 _clipboard = sel.front()->clone();
715 DCPOMATIC_ASSERT (_clipboard);
717 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
718 if (dialog.ShowModal() != wxID_OK) {
722 for (auto i: _film_editor->content_panel()->selected()) {
723 if (dialog.video() && i->video) {
724 DCPOMATIC_ASSERT (_clipboard->video);
725 i->video->take_settings_from (_clipboard->video);
727 if (dialog.audio() && i->audio) {
728 DCPOMATIC_ASSERT (_clipboard->audio);
729 i->audio->take_settings_from (_clipboard->audio);
733 auto j = i->text.begin ();
734 auto k = _clipboard->text.begin ();
735 while (j != i->text.end() && k != _clipboard->text.end()) {
736 (*j)->take_settings_from (*k);
744 void edit_select_all ()
746 _film_editor->content_panel()->select_all();
749 void edit_preferences ()
751 if (!_config_dialog) {
752 _config_dialog = create_full_config_dialog ();
754 _config_dialog->Show (this);
757 void tools_restore_default_preferences ()
759 wxMessageDialog dialog(
761 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
762 _("Restore default preferences"),
763 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
766 if (dialog.ShowModal() == wxID_YES) {
767 Config::restore_defaults ();
771 void tools_export_preferences ()
774 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
775 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
778 if (dialog.ShowModal() == wxID_OK) {
779 save_all_config_as_zip(wx_to_std(dialog.GetPath()));
783 void jobs_make_dcp ()
789 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
792 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);
794 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);
796 if (!confirm_dialog (this, message)) {
801 if (Config::instance()->show_hints_before_make_dcp()) {
802 HintsDialog hints(this, _film, false);
803 if (hints.ShowModal() == wxID_CANCEL) {
808 if (_film->encrypted ()) {
809 NagDialog::maybe_nag (
811 Config::NAG_ENCRYPTED_METADATA,
812 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
813 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
814 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
815 "if you want to make KDMs for this film.")
819 /* Remove any existing DCP if the user agrees */
820 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
821 if (boost::filesystem::exists(dcp_dir)) {
822 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
825 boost::filesystem::remove_all (dcp_dir);
829 /* It seems to make sense to auto-save metadata here, since the make DCP may last
830 a long time, and crashes/power failures are moderately likely.
832 _film->write_metadata ();
833 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
834 } catch (BadSettingError& e) {
835 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
836 } catch (std::exception& e) {
837 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
841 void jobs_make_kdms ()
847 _kdm_dialog.reset(this, _film);
848 _kdm_dialog->Show ();
851 void jobs_make_dkdms ()
857 _dkdm_dialog.reset(this, _film);
858 _dkdm_dialog->Show ();
861 /** @return false if we succeeded, true if not */
862 bool send_to_other_tool (int port, function<void()> start, string message)
864 /* i = 0; try to connect via socket
865 i = 1; try again, and then try to start the tool
866 i = 2 onwards; try again.
868 for (int i = 0; i < 8; ++i) {
870 boost::asio::io_service io_service;
871 boost::asio::ip::tcp::resolver resolver (io_service);
872 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
873 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
875 socket.connect (*endpoint_iterator);
876 DCPOMATIC_ASSERT (_film->directory ());
877 socket.write (message.length() + 1);
878 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
883 } catch (exception& e) {
891 dcpomatic_sleep_seconds (1);
897 void jobs_make_dcp_batch ()
903 if (Config::instance()->show_hints_before_make_dcp()) {
904 HintsDialog hints(this, _film, false);
905 if (hints.ShowModal() == wxID_CANCEL) {
910 _film->write_metadata ();
912 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
914 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
916 error_dialog (this, _("Could not find batch converter."));
921 void jobs_open_dcp_in_player ()
927 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
929 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
931 error_dialog (this, _("Could not find player."));
936 void jobs_make_self_dkdm ()
942 SelfDKDMDialog dialog(this, _film);
943 if (dialog.ShowModal() != wxID_OK) {
947 NagDialog::maybe_nag (
949 Config::NAG_DKDM_CONFIG,
951 _("You are making a DKDM which is encrypted by a private key held in"
952 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
953 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
954 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
959 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
961 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
964 auto signer = Config::instance()->signer_chain();
965 if (!signer->valid()) {
966 error_dialog(this, _("The certificate chain for signing is invalid"));
970 optional<dcp::EncryptedKDM> kdm;
972 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
973 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
974 if (dialog.internal()) {
975 auto dkdms = Config::instance()->dkdms();
976 dkdms->add(make_shared<DKDM>(kdm));
977 Config::instance()->changed ();
979 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
982 } catch (dcp::NotEncryptedError& e) {
983 error_dialog (this, _("CPL's content is not encrypted."));
984 } catch (exception& e) {
985 error_dialog (this, e.what ());
987 error_dialog (this, _("An unknown exception occurred."));
992 void jobs_export_video_file ()
994 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
995 if (dialog.ShowModal() != wxID_OK) {
999 if (boost::filesystem::exists(dialog.path())) {
1000 bool ok = confirm_dialog(
1002 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1010 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1012 make_shared<FFmpegEncoder> (
1013 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1015 JobManager::instance()->add (job);
1019 void jobs_export_subtitles ()
1021 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1022 if (dialog.ShowModal() != wxID_OK) {
1025 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1027 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1029 JobManager::instance()->add(job);
1033 void jobs_send_dcp_to_tms ()
1035 _film->send_dcp_to_tms ();
1038 void jobs_show_dcp ()
1040 DCPOMATIC_ASSERT (_film->directory ());
1041 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1042 error_dialog (this, _("Could not show DCP."));
1046 void view_closed_captions ()
1048 _film_viewer.show_closed_captions ();
1051 void view_video_waveform ()
1053 if (!_video_waveform_dialog) {
1054 _video_waveform_dialog.reset(this, _film, _film_viewer);
1057 _video_waveform_dialog->Show ();
1060 void tools_system_information ()
1062 if (!_system_information_dialog) {
1063 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1066 _system_information_dialog->Show ();
1071 if (!_hints_dialog) {
1072 _hints_dialog = new HintsDialog (this, _film, true);
1075 _hints_dialog->Show ();
1078 void tools_encoding_servers ()
1080 if (!_servers_list_dialog) {
1081 _servers_list_dialog = new ServersListDialog (this);
1084 _servers_list_dialog->Show ();
1087 void tools_manage_templates ()
1089 if (!_templates_dialog) {
1090 _templates_dialog.reset(this);
1093 _templates_dialog->Show ();
1096 void tools_check_for_updates ()
1098 _update_news_requested = true;
1099 UpdateChecker::instance()->run();
1102 void tools_send_translations ()
1104 SendI18NDialog dialog(this);
1105 if (dialog.ShowModal() != wxID_OK) {
1110 body += dialog.name() + "\n";
1111 body += dialog.language() + "\n";
1112 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1114 auto translations = I18NHook::translations ();
1115 for (auto i: translations) {
1116 body += i.first + "\n" + i.second + "\n\n";
1118 list<string> to = { "carl@dcpomatic.com" };
1119 if (dialog.email().find("@") == string::npos) {
1120 error_dialog (this, _("You must enter a valid email address when sending translations, "
1121 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1123 Emailer emailer(dialog.email(), to, "DCP-o-matic translations", body);
1125 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1126 } catch (NetworkError& e) {
1127 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1134 AboutDialog dialog(this);
1138 void help_report_a_problem ()
1140 ReportProblemDialog dialog(this, _film);
1141 if (dialog.ShowModal() == wxID_OK) {
1146 bool should_close ()
1148 if (!JobManager::instance()->work_to_do ()) {
1152 wxMessageDialog dialog(
1154 _("There are unfinished jobs; are you sure you want to quit?"),
1155 _("Unfinished jobs"),
1156 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1159 return dialog.ShowModal() == wxID_YES;
1162 void close (wxCloseEvent& ev)
1164 if (!should_close ()) {
1169 if (_film && _film->dirty ()) {
1170 FilmChangedClosingDialog dialog(_film->name());
1171 switch (dialog.run()) {
1173 /* Don't save and carry on to close */
1176 /* Save and carry on to close */
1177 _film->write_metadata ();
1180 /* Veto the event and stop */
1186 /* We don't want to hear about any more configuration changes, since they
1187 cause the File menu to be altered, which itself will be deleted around
1188 now (without, as far as I can see, any way for us to find out).
1190 _config_changed_connection.disconnect ();
1192 /* Also stop hearing about analytics-related stuff */
1193 _analytics_message_connection.disconnect ();
1200 void active_jobs_changed()
1202 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1203 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1204 * it by using an idle callback. This feels quite unpleasant.
1206 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1209 void set_menu_sensitivity ()
1211 auto jobs = JobManager::instance()->get ();
1212 auto i = jobs.begin();
1213 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1216 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1217 bool const have_cpl = _film && !_film->cpls().empty ();
1218 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1219 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1220 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1222 for (auto j: menu_items) {
1224 bool enabled = true;
1226 if ((j.second & NEEDS_FILM) && !_film) {
1230 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1234 if ((j.second & NEEDS_CPL) && !have_cpl) {
1238 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1242 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1246 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1250 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1254 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1258 j.first->Enable (enabled);
1262 /** @return true if the operation that called this method
1263 * should continue, false to abort it.
1266 bool maybe_save_film ()
1272 if (_film->dirty ()) {
1273 T d (_film->name ());
1278 _film->write_metadata ();
1289 bool maybe_save_then_delete_film ()
1291 bool const r = maybe_save_film<T> ();
1298 void add_item (wxMenu* menu, wxString text, int id, int sens)
1300 auto item = menu->Append (id, text);
1301 menu_items.insert (make_pair (item, sens));
1304 void setup_menu (wxMenuBar* m)
1306 _file_menu = new wxMenu;
1307 /* [Shortcut] Ctrl+N:New film */
1308 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1309 /* [Shortcut] Ctrl+O:Open existing film */
1310 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1311 _file_menu->AppendSeparator ();
1312 /* [Shortcut] Ctrl+S:Save current film */
1313 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1314 _file_menu->AppendSeparator ();
1315 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1316 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1317 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1319 _history_position = _file_menu->GetMenuItems().GetCount();
1321 _file_menu->AppendSeparator ();
1322 /* [Shortcut] Ctrl+W:Close current film */
1323 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1326 _file_menu->AppendSeparator ();
1330 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1332 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1335 auto edit = new wxMenu;
1336 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1337 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1338 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1339 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1340 edit->AppendSeparator ();
1341 /* [Shortcut] Shift+Ctrl+A:Select all content */
1342 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1345 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1347 edit->AppendSeparator ();
1348 /* [Shortcut] Ctrl+P:Open preferences window */
1349 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1352 auto jobs_menu = new wxMenu;
1353 /* [Shortcut] Ctrl+M:Make DCP */
1354 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1355 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1356 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1357 jobs_menu->AppendSeparator ();
1358 /* [Shortcut] Ctrl+K:Make KDMs */
1359 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1360 /* [Shortcut] Ctrl+D:Make DKDMs */
1361 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1362 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1363 jobs_menu->AppendSeparator ();
1364 /* [Shortcut] Ctrl+E:Export video file */
1365 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1366 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1367 jobs_menu->AppendSeparator ();
1368 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1370 #if defined(DCPOMATIC_OSX)
1371 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1372 #elif defined(DCPOMATIC_WINDOWS)
1373 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1375 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1378 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1380 auto view = new wxMenu;
1381 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1382 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1384 auto tools = new wxMenu;
1385 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1386 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1387 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1388 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1389 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1390 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1391 tools->AppendSeparator ();
1392 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1393 tools->AppendSeparator ();
1394 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1396 wxMenu* help = new wxMenu;
1398 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1400 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1402 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1404 m->Append (_file_menu, _("&File"));
1405 m->Append (edit, _("&Edit"));
1406 m->Append (jobs_menu, _("&Jobs"));
1407 m->Append (view, _("&View"));
1408 m->Append (tools, _("&Tools"));
1409 m->Append (help, _("&Help"));
1412 void config_changed (Config::Property what)
1414 /* Instantly save any config changes when using the DCP-o-matic GUI */
1415 if (what == Config::CINEMAS) {
1417 Config::instance()->write_cinemas();
1418 } catch (exception& e) {
1422 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1423 std_to_wx (Config::instance()->cinemas_file().string()).data()
1429 Config::instance()->write_config();
1430 } catch (exception& e) {
1434 _("Could not write to config file at %s. Your changes have not been saved."),
1435 std_to_wx (Config::instance()->cinemas_file().string()).data()
1441 for (int i = 0; i < _history_items; ++i) {
1442 delete _file_menu->Remove (ID_file_history + i);
1445 if (_history_separator) {
1446 _file_menu->Remove (_history_separator);
1448 delete _history_separator;
1449 _history_separator = 0;
1451 int pos = _history_position;
1453 /* Clear out non-existent history items before we re-build the menu */
1454 Config::instance()->clean_history ();
1455 auto history = Config::instance()->history();
1457 if (!history.empty ()) {
1458 _history_separator = _file_menu->InsertSeparator (pos++);
1461 for (size_t i = 0; i < history.size(); ++i) {
1464 s = String::compose ("&%1 %2", i + 1, history[i].string());
1466 s = history[i].string();
1468 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1471 _history_items = history.size ();
1473 dcpomatic_log->set_types (Config::instance()->log_types());
1476 void update_checker_state_changed ()
1478 auto uc = UpdateChecker::instance ();
1480 bool const announce =
1481 _update_news_requested ||
1482 (uc->stable() && Config::instance()->check_for_updates()) ||
1483 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1485 _update_news_requested = false;
1491 if (uc->state() == UpdateChecker::State::YES) {
1492 UpdateDialog dialog(this, uc->stable(), uc->test());
1494 } else if (uc->state() == UpdateChecker::State::FAILED) {
1495 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1497 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1500 _update_news_requested = false;
1503 void start_stop_pressed ()
1505 if (_film_viewer.playing()) {
1506 _film_viewer.stop();
1508 _film_viewer.start();
1512 void timeline_pressed ()
1514 _film_editor->content_panel()->timeline_clicked ();
1519 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1522 void forward_frame ()
1524 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1527 void analytics_message (string title, string html)
1529 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1535 auto s = wx_to_std(_("DCP-o-matic"));
1537 if (_film->directory()) {
1538 s += " - " + _film->directory()->string();
1540 if (_film->dirty()) {
1545 SetTitle (std_to_wx(s));
1548 FilmEditor* _film_editor;
1549 LimitedFrameSplitter* _splitter;
1550 wxPanel* _right_panel;
1551 FilmViewer _film_viewer;
1552 StandardControls* _controls;
1553 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1554 SystemInformationDialog* _system_information_dialog = nullptr;
1555 HintsDialog* _hints_dialog = nullptr;
1556 ServersListDialog* _servers_list_dialog = nullptr;
1557 wxPreferencesEditor* _config_dialog = nullptr;
1558 wx_ptr<KDMDialog> _kdm_dialog;
1559 wx_ptr<DKDMDialog> _dkdm_dialog;
1560 wx_ptr<TemplatesDialog> _templates_dialog;
1561 wxMenu* _file_menu = nullptr;
1562 shared_ptr<Film> _film;
1563 int _history_items = 0;
1564 int _history_position = 0;
1565 wxMenuItem* _history_separator = nullptr;
1566 boost::signals2::scoped_connection _config_changed_connection;
1567 boost::signals2::scoped_connection _analytics_message_connection;
1568 bool _update_news_requested = false;
1569 shared_ptr<Content> _clipboard;
1570 bool _first_shown_called = false;
1574 static const wxCmdLineEntryDesc command_line_description[] = {
1575 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1576 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1577 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1578 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1579 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1580 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1581 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1586 * @brief The magic App class for wxWidgets.
1588 class App : public wxApp
1594 #ifdef DCPOMATIC_LINUX
1601 bool OnInit () override
1604 wxInitAllImageHandlers ();
1606 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1607 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1609 _splash = maybe_show_splash ();
1611 SetAppName (_("DCP-o-matic"));
1613 if (!wxApp::OnInit()) {
1617 #ifdef DCPOMATIC_LINUX
1618 unsetenv ("UBUNTU_MENUPROXY");
1621 #ifdef DCPOMATIC_OSX
1622 dcpomatic_sleep_seconds (1);
1623 make_foreground_application ();
1626 dcpomatic_setup_path_encoding ();
1628 /* Enable i18n; this will create a Config object
1629 to look for a force-configured language. This Config
1630 object will be wrong, however, because dcpomatic_setup
1631 hasn't yet been called and there aren't any filters etc.
1634 dcpomatic_setup_i18n ();
1636 /* Set things up, including filters etc.
1637 which will now be internationalised correctly.
1641 /* Force the configuration to be re-loaded correctly next
1646 /* We only look out for bad configuration from here on, as before
1647 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1648 incorrect certificate chain validity errors.
1650 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1652 _frame = new DOMFrame (_("DCP-o-matic"));
1653 SetTopWindow (_frame);
1654 _frame->Maximize ();
1657 if (running_32_on_64 ()) {
1658 NagDialog::maybe_nag (
1659 _frame, Config::NAG_32_ON_64,
1660 _("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."),
1666 signal_manager = new wxSignalManager (this);
1667 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1669 if (!_film_to_load.empty() && boost::filesystem::is_directory(_film_to_load)) {
1671 _frame->load_film (_film_to_load);
1672 } catch (exception& e) {
1673 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()));
1677 if (!_film_to_create.empty ()) {
1678 _frame->new_film (_film_to_create, optional<string>());
1679 if (!_content_to_add.empty()) {
1680 for (auto i: content_factory(_content_to_add)) {
1681 _frame->film()->examine_and_add_content(i);
1684 if (!_dcp_to_add.empty ()) {
1685 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1689 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1690 _timer.reset (new wxTimer (this));
1691 _timer->Start (1000);
1693 if (Config::instance()->check_for_updates ()) {
1694 UpdateChecker::instance()->run ();
1697 auto release_notes = find_release_notes(gui_is_dark());
1698 if (release_notes) {
1699 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1704 catch (exception& e)
1707 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1713 void OnInitCmdLine (wxCmdLineParser& parser) override
1715 parser.SetDesc (command_line_description);
1716 parser.SetSwitchChars (wxT ("-"));
1719 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1721 if (parser.Found (wxT("version"))) {
1722 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1723 exit (EXIT_SUCCESS);
1726 if (parser.GetParamCount() > 0) {
1727 if (parser.Found (wxT ("new"))) {
1728 _film_to_create = wx_to_std (parser.GetParam (0));
1730 _film_to_load = wx_to_std (parser.GetParam (0));
1735 if (parser.Found (wxT ("content"), &content)) {
1736 _content_to_add = wx_to_std (content);
1740 if (parser.Found (wxT ("dcp"), &dcp)) {
1741 _dcp_to_add = wx_to_std (dcp);
1745 if (parser.Found (wxT("config"), &config)) {
1746 State::override_path = wx_to_std (config);
1752 void report_exception ()
1756 } catch (FileError& e) {
1760 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1761 std_to_wx (e.what()),
1762 std_to_wx (e.file().string().c_str())
1765 } catch (boost::filesystem::filesystem_error& e) {
1769 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1770 std_to_wx (e.what()),
1771 std_to_wx (e.path1().string()),
1772 std_to_wx (e.path2().string())
1775 } catch (exception& e) {
1779 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1780 std_to_wx (e.what ())
1784 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1788 /* An unhandled exception has occurred inside the main event loop */
1789 bool OnExceptionInMainLoop () override
1791 report_exception ();
1792 /* This will terminate the program */
1796 void OnUnhandledException () override
1798 report_exception ();
1801 void idle (wxIdleEvent& ev)
1803 signal_manager->ui_idle ();
1810 EncodeServerFinder::instance()->rethrow ();
1811 } catch (exception& e) {
1812 error_dialog (0, std_to_wx (e.what ()));
1816 void close_splash ()
1821 void config_failed_to_load (Config::LoadFailure what)
1823 report_config_load_failure(_frame, what);
1826 void config_warning (string m)
1828 message_dialog (_frame, std_to_wx(m));
1831 bool config_bad (Config::BadReason reason)
1833 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1834 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1838 auto config = Config::instance();
1840 case Config::BAD_SIGNER_UTF8_STRINGS:
1842 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1845 RecreateChainDialog dialog(
1846 _frame, _("Recreate signing certificates"),
1847 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1848 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1849 "the certificate chain for signing DCPs and KDMs?"),
1851 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1853 return dialog.ShowModal() == wxID_OK;
1855 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1857 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1860 RecreateChainDialog dialog(
1861 _frame, _("Recreate signing certificates"),
1862 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1863 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1864 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1866 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
1868 return dialog.ShowModal() == wxID_OK;
1870 case Config::BAD_SIGNER_INCONSISTENT:
1872 RecreateChainDialog dialog(
1873 _frame, _("Recreate signing certificates"),
1874 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
1875 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1876 "the certificate chain for signing DCPs and KDMs?"),
1877 _("Close DCP-o-matic")
1879 if (dialog.ShowModal() != wxID_OK) {
1880 exit (EXIT_FAILURE);
1884 case Config::BAD_DECRYPTION_INCONSISTENT:
1886 RecreateChainDialog dialog(
1887 _frame, _("Recreate KDM decryption chain"),
1888 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
1889 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
1890 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
1891 "configuration before continuing."),
1892 _("Close DCP-o-matic")
1894 if (dialog.ShowModal() != wxID_OK) {
1895 exit (EXIT_FAILURE);
1900 DCPOMATIC_ASSERT (false);
1904 DOMFrame* _frame = nullptr;
1905 wx_ptr<wxSplashScreen> _splash;
1906 shared_ptr<wxTimer> _timer;
1907 string _film_to_load;
1908 string _film_to_create;
1909 string _content_to_add;