2 Copyright (C) 2012-2022 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 #ifdef DCPOMATIC_CUCUMBER
30 #include "wx/cucumber_bridge.h"
31 #include "wx/cucumber_registry.h"
33 #include "wx/dkdm_dialog.h"
34 #include "wx/export_subtitles_dialog.h"
35 #include "wx/export_video_file_dialog.h"
36 #include "wx/film_editor.h"
37 #include "wx/film_name_location_dialog.h"
38 #include "wx/film_viewer.h"
39 #include "wx/focus_manager.h"
40 #include "wx/full_config_dialog.h"
41 #include "wx/hints_dialog.h"
42 #include "wx/html_dialog.h"
43 #include "wx/i18n_hook.h"
44 #include "wx/job_manager_view.h"
45 #include "wx/kdm_dialog.h"
46 #include "wx/nag_dialog.h"
47 #include "wx/paste_dialog.h"
48 #include "wx/recreate_chain_dialog.h"
49 #include "wx/report_problem_dialog.h"
50 #include "wx/save_template_dialog.h"
51 #include "wx/self_dkdm_dialog.h"
52 #include "wx/send_i18n_dialog.h"
53 #include "wx/servers_list_dialog.h"
54 #include "wx/standard_controls.h"
55 #include "wx/system_information_dialog.h"
56 #include "wx/templates_dialog.h"
57 #include "wx/update_dialog.h"
58 #include "wx/video_waveform_dialog.h"
59 #include "wx/wx_signal_manager.h"
60 #include "wx/wx_util.h"
61 #include "lib/analytics.h"
62 #include "lib/audio_content.h"
63 #include "lib/check_content_job.h"
64 #include "lib/cinema.h"
65 #include "lib/compose.hpp"
66 #include "lib/config.h"
67 #include "lib/constants.h"
68 #include "lib/content.h"
69 #include "lib/content_factory.h"
70 #include "lib/cross.h"
71 #include "lib/cross.h"
72 #include "lib/dcp_content.h"
73 #include "lib/dcpomatic_log.h"
74 #include "lib/dcpomatic_socket.h"
75 #include "lib/dkdm_wrapper.h"
76 #include "lib/emailer.h"
77 #include "lib/encode_server_finder.h"
78 #include "lib/exceptions.h"
79 #include "lib/ffmpeg_encoder.h"
81 #include "lib/font_config.h"
82 #include "lib/hints.h"
83 #include "lib/job_manager.h"
84 #include "lib/kdm_with_metadata.h"
86 #include "lib/make_dcp.h"
87 #include "lib/release_notes.h"
88 #include "lib/screen.h"
89 #include "lib/send_kdm_email_job.h"
90 #include "lib/signal_manager.h"
91 #include "lib/subtitle_encoder.h"
92 #include "lib/text_content.h"
93 #include "lib/transcode_job.h"
94 #include "lib/update_checker.h"
95 #include "lib/version.h"
96 #include "lib/video_content.h"
97 #include <dcp/exceptions.h>
98 #include <dcp/filesystem.h>
99 #include <dcp/raw_convert.h>
100 #include <dcp/warnings.h>
101 LIBDCP_DISABLE_WARNINGS
102 #include <wx/cmdline.h>
103 #include <wx/generic/aboutdlgg.h>
104 #include <wx/preferences.h>
105 #include <wx/splash.h>
106 #include <wx/stdpaths.h>
107 #include <wx/wxhtml.h>
108 LIBDCP_ENABLE_WARNINGS
110 #include <X11/Xlib.h>
116 #include <shellapi.h>
118 #include <boost/algorithm/string.hpp>
119 #include <boost/filesystem.hpp>
122 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
131 using std::dynamic_pointer_cast;
132 using std::exception;
135 using std::make_pair;
136 using std::make_shared;
138 using std::shared_ptr;
142 using boost::optional;
143 using boost::is_any_of;
144 using boost::algorithm::find;
145 #if BOOST_VERSION >= 106100
146 using namespace boost::placeholders;
148 using dcp::raw_convert;
151 class FilmChangedClosingDialog
154 explicit FilmChangedClosingDialog (string name)
157 wxString::Format(_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
158 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
159 /// project (Film) has been changed since it was last saved.
161 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
164 _dialog.SetYesNoCancelLabels(
165 _("Save film and close"), _("Close without saving film"), _("Don't close")
171 return _dialog.ShowModal();
175 wxMessageDialog _dialog;
179 class FilmChangedDuplicatingDialog
182 explicit FilmChangedDuplicatingDialog (string name)
185 wxString::Format(_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
186 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
187 /// project (Film) has been changed since it was last saved.
189 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
192 _dialog.SetYesNoCancelLabels(
193 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
199 return _dialog.ShowModal();
203 wxMessageDialog _dialog;
208 #define NEEDS_FILM 0x1
209 #define NOT_DURING_DCP_CREATION 0x2
210 #define NEEDS_CPL 0x4
211 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
212 #define NEEDS_SELECTED_CONTENT 0x10
213 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
214 #define NEEDS_CLIPBOARD 0x40
215 #define NEEDS_ENCRYPTION 0x80
218 map<wxMenuItem*, int> menu_items;
224 ID_file_save_as_template,
226 ID_file_duplicate_and_open,
228 /* Allow spare IDs after _history for the recent files list */
234 ID_jobs_make_dcp_batch,
237 ID_jobs_make_self_dkdm,
238 ID_jobs_export_video_file,
239 ID_jobs_export_subtitles,
240 ID_jobs_send_dcp_to_tms,
242 ID_jobs_open_dcp_in_player,
243 ID_view_closed_captions,
244 ID_view_video_waveform,
246 ID_tools_encoding_servers,
247 ID_tools_manage_templates,
248 ID_tools_check_for_updates,
249 ID_tools_send_translations,
250 ID_tools_system_information,
251 ID_tools_restore_default_preferences,
252 ID_tools_export_preferences,
253 ID_help_report_a_problem,
254 /* IDs for shortcuts (with no associated menu item) */
264 class LimitedFrameSplitter : public wxSplitterWindow
267 LimitedFrameSplitter(wxWindow* parent)
268 : wxSplitterWindow(parent, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSP_NOBORDER | wxSP_3DSASH | wxSP_LIVE_UPDATE)
270 /* This value doesn't really mean much but we just want to stop double-click on the
271 divider from shrinking the left panel.
273 SetMinimumPaneSize(64);
275 Bind(wxEVT_SIZE, boost::bind(&LimitedFrameSplitter::sized, this, _1));
278 bool OnSashPositionChange(int new_position) override
280 /* Try to stop the left bit of the splitter getting too small */
281 auto const ok = new_position > _left_panel_minimum_size;
283 Config::instance()->set_main_divider_sash_position(new_position);
289 void sized(wxSizeEvent& ev)
291 if (GetSize().GetWidth() > _left_panel_minimum_size && GetSashPosition() < _left_panel_minimum_size) {
292 /* The window is now fairly big but the left panel is small; this happens when the DCP-o-matic window
293 * is shrunk and then made larger again. Try to set a sensible left panel size in this case.
295 SetSashPosition(Config::instance()->main_divider_sash_position().get_value_or(_left_panel_minimum_size));
301 int const _left_panel_minimum_size = 200;
305 class DOMFrame : public wxFrame
308 explicit DOMFrame (wxString const& title)
309 : wxFrame (nullptr, -1, title)
310 /* Use a panel as the only child of the Frame so that we avoid
311 the dark-grey background on Windows.
313 , _splitter(new LimitedFrameSplitter(this))
314 , _right_panel(new wxPanel(_splitter, wxID_ANY))
315 , _film_viewer(_right_panel)
318 auto bar = new wxMenuBar;
322 #ifdef DCPOMATIC_WINDOWS
323 SetIcon (wxIcon (std_to_wx ("id")));
326 _config_changed_connection = Config::instance()->Changed.connect(boost::bind(&DOMFrame::config_changed, this, _1));
327 config_changed (Config::OTHER);
329 _analytics_message_connection = Analytics::instance()->Message.connect(boost::bind(&DOMFrame::analytics_message, this, _1, _2));
331 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
332 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
333 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
334 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
335 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
336 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
337 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_close, this), ID_file_close);
338 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
339 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
340 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
341 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
342 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_select_all, this), ID_edit_select_all);
343 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
344 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
345 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
346 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dkdms, this), ID_jobs_make_dkdms);
347 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
348 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
349 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_video_file, this), ID_jobs_export_video_file);
350 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export_subtitles, this), ID_jobs_export_subtitles);
351 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
352 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
353 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
354 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
355 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
356 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
357 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
358 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
359 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
360 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_send_translations, this), ID_tools_send_translations);
361 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_system_information, this),ID_tools_system_information);
362 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
363 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_export_preferences, this), ID_tools_export_preferences);
364 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
367 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
368 Bind (wxEVT_SHOW, boost::bind (&DOMFrame::show, this, _1));
370 auto left_panel = new wxPanel(_splitter, wxID_ANY);
372 _film_editor = new FilmEditor(left_panel, _film_viewer);
374 auto left_sizer = new wxBoxSizer(wxHORIZONTAL);
375 left_sizer->Add(_film_editor, 1, wxEXPAND);
377 left_panel->SetSizerAndFit(left_sizer);
379 _controls = new StandardControls(_right_panel, _film_viewer, true);
380 _controls->set_film(_film_viewer.film());
381 auto job_manager_view = new JobManagerView(_right_panel, false);
383 auto right_sizer = new wxBoxSizer (wxVERTICAL);
384 right_sizer->Add(_film_viewer.panel(), 2, wxEXPAND | wxALL, 6);
385 right_sizer->Add (_controls, 0, wxEXPAND | wxALL, 6);
386 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
388 _right_panel->SetSizer(right_sizer);
390 _splitter->SplitVertically(left_panel, _right_panel, Config::instance()->main_divider_sash_position().get_value_or(left_panel->GetSize().GetWidth() + 8));
392 set_menu_sensitivity ();
394 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
397 JobManager::instance()->ActiveJobsChanged.connect(boost::bind(&DOMFrame::active_jobs_changed, this));
399 UpdateChecker::instance()->StateChanged.connect(boost::bind(&DOMFrame::update_checker_state_changed, this));
401 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
402 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
406 void add_accelerators ()
409 int accelerators = 7;
411 int accelerators = 6;
413 std::vector<wxAcceleratorEntry> accel(accelerators);
414 /* [Shortcut] Ctrl+A:Add file(s) to the film */
415 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
416 /* [Shortcut] Delete:Remove selected content from film */
417 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
418 /* [Shortcut] Space:Start/stop playback */
419 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
420 /* [Shortcut] Ctrl+T:Open timeline window */
421 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
422 /* [Shortcut] Left arrow:Move back one frame */
423 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
424 /* [Shortcut] Right arrow:Move forward one frame */
425 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
427 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), ID_file_close);
429 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
430 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
431 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
432 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
433 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
434 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
435 wxAcceleratorTable accel_table (accelerators, accel.data());
436 SetAcceleratorTable (accel_table);
439 void remove_accelerators ()
441 SetAcceleratorTable (wxAcceleratorTable ());
444 void remove_clicked (wxCommandEvent& ev)
446 if (_film_editor->content_panel()->remove_clicked (true)) {
451 void new_film (boost::filesystem::path path, optional<string> template_name)
453 auto film = make_shared<Film>(path);
455 film->use_template (template_name.get());
457 film->set_name (path.filename().generic_string());
458 film->write_metadata ();
462 void load_film (boost::filesystem::path file)
465 auto film = make_shared<Film>(file);
466 auto const notes = film->read_metadata ();
468 if (film->state_version() == 4) {
471 _("This film was created with an old version of DVD-o-matic and may not load correctly "
472 "in this version. Please check the film's settings carefully.")
476 for (auto i: notes) {
477 error_dialog (0, std_to_wx(i));
482 JobManager::instance()->add(make_shared<CheckContentJob>(film));
484 catch (FileNotFoundError& e) {
485 auto const dir = e.file().parent_path();
486 if (dcp::filesystem::exists(dir / "ASSETMAP") || dcp::filesystem::exists(dir / "ASSETMAP.xml")) {
488 this, _("Could not open this folder as a DCP-o-matic project."),
489 _("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.")
492 auto const p = std_to_wx(file.string ());
493 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
496 } catch (std::exception& e) {
497 auto const p = std_to_wx (file.string());
498 error_dialog (this, wxString::Format(_("Could not open film at %s"), p.data()), std_to_wx(e.what()));
501 void set_film (shared_ptr<Film> film)
504 _film_viewer.set_film(_film);
505 _film_editor->set_film(_film);
506 _controls->set_film (_film);
507 _video_waveform_dialog.reset();
508 set_menu_sensitivity ();
509 if (_film && _film->directory()) {
510 Config::instance()->add_to_history (_film->directory().get());
513 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
514 _film->Message.connect (boost::bind(&DOMFrame::film_message, this, _1));
515 _film->DirtyChange.connect (boost::bind(&DOMFrame::set_title, this));
516 dcpomatic_log = _film->log ();
521 shared_ptr<Film> film () const {
525 #ifdef DCPOMATIC_CUCUMBER
526 void cucumber_add_content_file (string filename) {
527 std::cout << ".cucumber_add_content_file\n";
528 _film_editor->cucumber_add_content_file (filename);
531 /* Could be called from any thread */
532 std::string cucumber_get_content_list () {
533 std::cout << ".cucumber_get_content_list\n";
534 return _film_editor->cucumber_get_content_list();
540 void show (wxShowEvent& ev)
542 if (ev.IsShown() && !_first_shown_called) {
543 _film_editor->first_shown ();
544 _first_shown_called = true;
548 void film_message (string m)
550 message_dialog (this, std_to_wx(m));
553 void film_change (ChangeType type)
555 if (type == ChangeType::DONE) {
556 set_menu_sensitivity ();
562 FilmNameLocationDialog dialog(this, _("New Film"), true);
563 int const r = dialog.ShowModal();
565 if (r != wxID_OK || !dialog.check_path() || !maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
570 new_film(dialog.path(), dialog.template_name());
571 } catch (boost::filesystem::filesystem_error& e) {
572 #ifdef DCPOMATIC_WINDOWS
573 string bad_chars = "<>:\"/|?*";
574 string const filename = dialog.path().filename().string();
575 string found_bad_chars;
576 for (size_t i = 0; i < bad_chars.length(); ++i) {
577 if (filename.find(bad_chars[i]) != string::npos && found_bad_chars.find(bad_chars[i]) == string::npos) {
578 found_bad_chars += bad_chars[i];
581 wxString message = _("Could not create folder to store film.");
583 if (!found_bad_chars.empty()) {
584 message += wxString::Format (_("Try removing the %s characters from your folder name."), std_to_wx(found_bad_chars).data());
586 message += _("Please check that you do not have Windows controlled folder access enabled for DCP-o-matic.");
588 error_dialog (this, message, std_to_wx(e.what()));
590 error_dialog (this, _("Could not create folder to store film."), std_to_wx(e.what()));
599 _("Select film to open"),
600 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
601 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
606 r = dialog.ShowModal();
607 if (r == wxID_OK && dialog.GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
608 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
614 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
615 load_film(wx_to_std(dialog.GetPath()));
622 _film->write_metadata ();
623 } catch (exception& e) {
624 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
628 void file_save_as_template ()
630 SaveTemplateDialog dialog(this);
631 if (dialog.ShowModal() == wxID_OK) {
633 Config::instance()->save_template(_film, dialog.name());
634 } catch (exception& e) {
635 error_dialog(this, _("Could not save template."), std_to_wx(e.what()));
640 void file_duplicate ()
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());
649 film->write_metadata();
650 } catch (exception& e) {
651 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
656 void file_duplicate_and_open ()
658 FilmNameLocationDialog dialog(this, _("Duplicate Film"), false);
660 if (dialog.ShowModal() == wxID_OK && dialog.check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
661 auto film = make_shared<Film>(dialog.path());
662 film->copy_from (_film);
663 film->set_name(dialog.path().filename().generic_string());
665 film->write_metadata ();
667 } catch (exception& e) {
668 error_dialog(this, _("Could not duplicate project."), std_to_wx(e.what()));
675 if (_film && _film->dirty ()) {
676 FilmChangedClosingDialog dialog(_film->name());
677 switch (dialog.run()) {
679 /* Don't save and carry on to close */
682 /* Save and carry on to close */
683 _film->write_metadata ();
691 set_film (shared_ptr<Film>());
694 void file_history (wxCommandEvent& event)
696 auto history = Config::instance()->history ();
697 int n = event.GetId() - ID_file_history;
698 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
699 load_film (history[n]);
705 /* false here allows the close handler to veto the close request */
711 auto const sel = _film_editor->content_panel()->selected();
712 if (sel.size() == 1) {
713 _clipboard = sel.front()->clone();
723 PasteDialog dialog(this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
724 if (dialog.ShowModal() != wxID_OK) {
728 for (auto i: _film_editor->content_panel()->selected()) {
729 if (dialog.video() && i->video) {
730 DCPOMATIC_ASSERT (_clipboard->video);
731 i->video->take_settings_from (_clipboard->video);
733 if (dialog.audio() && i->audio) {
734 DCPOMATIC_ASSERT (_clipboard->audio);
735 i->audio->take_settings_from (_clipboard->audio);
739 auto j = i->text.begin ();
740 auto k = _clipboard->text.begin ();
741 while (j != i->text.end() && k != _clipboard->text.end()) {
742 (*j)->take_settings_from (*k);
750 void edit_select_all ()
752 _film_editor->content_panel()->select_all();
755 void edit_preferences ()
757 if (!_config_dialog) {
758 _config_dialog = create_full_config_dialog ();
760 _config_dialog->Show (this);
763 void tools_restore_default_preferences ()
765 wxMessageDialog dialog(
767 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
768 _("Restore default preferences"),
769 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
772 if (dialog.ShowModal() == wxID_YES) {
773 Config::restore_defaults ();
777 void tools_export_preferences ()
780 this, _("Specify ZIP file"), wxEmptyString, wxT("dcpomatic_config.zip"), wxT("ZIP files (*.zip)|*.zip"),
781 wxFD_SAVE | wxFD_OVERWRITE_PROMPT
784 if (dialog.ShowModal() == wxID_OK) {
785 save_all_config_as_zip(wx_to_std(dialog.GetPath()));
789 void jobs_make_dcp ()
795 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
798 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);
800 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);
802 if (!confirm_dialog (this, message)) {
807 if (Config::instance()->show_hints_before_make_dcp()) {
808 HintsDialog hints(this, _film, false);
809 if (hints.ShowModal() == wxID_CANCEL) {
814 if (_film->encrypted ()) {
815 NagDialog::maybe_nag (
817 Config::NAG_ENCRYPTED_METADATA,
818 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
819 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
820 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
821 "if you want to make KDMs for this film.")
825 /* Remove any existing DCP if the user agrees */
826 auto const dcp_dir = _film->dir (_film->dcp_name(), false);
827 if (dcp::filesystem::exists(dcp_dir)) {
828 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
831 dcp::filesystem::remove_all(dcp_dir);
835 /* It seems to make sense to auto-save metadata here, since the make DCP may last
836 a long time, and crashes/power failures are moderately likely.
838 _film->write_metadata ();
839 make_dcp (_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
840 } catch (BadSettingError& e) {
841 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
842 } catch (std::exception& e) {
843 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
847 void jobs_make_kdms ()
853 _kdm_dialog.reset(this, _film);
854 _kdm_dialog->Show ();
857 void jobs_make_dkdms ()
863 _dkdm_dialog.reset(this, _film);
864 _dkdm_dialog->Show ();
867 /** @return false if we succeeded, true if not */
868 bool send_to_other_tool (int port, function<void()> start, string message)
870 /* i = 0; try to connect via socket
871 i = 1; try again, and then try to start the tool
872 i = 2 onwards; try again.
874 for (int i = 0; i < 8; ++i) {
876 boost::asio::io_service io_service;
877 boost::asio::ip::tcp::resolver resolver (io_service);
878 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
879 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
881 socket.connect (*endpoint_iterator);
882 DCPOMATIC_ASSERT (_film->directory ());
883 socket.write (message.length() + 1);
884 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
889 } catch (exception& e) {
897 dcpomatic_sleep_seconds (1);
903 void jobs_make_dcp_batch ()
909 if (Config::instance()->show_hints_before_make_dcp()) {
910 HintsDialog hints(this, _film, false);
911 if (hints.ShowModal() == wxID_CANCEL) {
916 _film->write_metadata ();
918 if (send_to_other_tool (BATCH_JOB_PORT, &start_batch_converter, _film->directory()->string())) {
920 error_dialog (this, _("Could not start the batch converter. You may need to download it from dcpomatic.com."));
922 error_dialog (this, _("Could not find batch converter."));
927 void jobs_open_dcp_in_player ()
933 if (send_to_other_tool (PLAYER_PLAY_PORT, &start_player, _film->dir(_film->dcp_name(false)).string())) {
935 error_dialog (this, _("Could not start the player. You may need to download it from dcpomatic.com."));
937 error_dialog (this, _("Could not find player."));
942 void jobs_make_self_dkdm ()
948 SelfDKDMDialog dialog(this, _film);
949 if (dialog.ShowModal() != wxID_OK) {
953 NagDialog::maybe_nag (
955 Config::NAG_DKDM_CONFIG,
957 _("You are making a DKDM which is encrypted by a private key held in"
958 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
959 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
960 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_read_file().string()).data()
965 dcp::LocalTime from (Config::instance()->signer_chain()->leaf().not_before());
967 dcp::LocalTime to (Config::instance()->signer_chain()->leaf().not_after());
970 auto signer = Config::instance()->signer_chain();
971 if (!signer->valid()) {
972 error_dialog(this, _("The certificate chain for signing is invalid"));
976 optional<dcp::EncryptedKDM> kdm;
978 auto const decrypted_kdm = _film->make_kdm(dialog.cpl(), from, to);
979 auto const kdm = decrypted_kdm.encrypt(signer, Config::instance()->decryption_chain()->leaf(), {}, dcp::Formulation::MODIFIED_TRANSITIONAL_1, true, 0);
980 if (dialog.internal()) {
981 auto dkdms = Config::instance()->dkdms();
982 dkdms->add(make_shared<DKDM>(kdm));
983 Config::instance()->changed ();
985 auto path = dialog.directory() / (_film->dcp_name(false) + "_DKDM.xml");
988 } catch (dcp::NotEncryptedError& e) {
989 error_dialog (this, _("CPL's content is not encrypted."));
990 } catch (exception& e) {
991 error_dialog (this, e.what ());
993 error_dialog (this, _("An unknown exception occurred."));
998 void jobs_export_video_file ()
1000 ExportVideoFileDialog dialog(this, _film->isdcf_name(true));
1001 if (dialog.ShowModal() != wxID_OK) {
1005 if (dcp::filesystem::exists(dialog.path())) {
1006 bool ok = confirm_dialog(
1008 wxString::Format(_("File %s already exists. Do you want to overwrite it?"), std_to_wx(dialog.path().string()).data())
1016 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1018 make_shared<FFmpegEncoder> (
1019 _film, job, dialog.path(), dialog.format(), dialog.mixdown_to_stereo(), dialog.split_reels(), dialog.split_streams(), dialog.x264_crf())
1021 JobManager::instance()->add (job);
1025 void jobs_export_subtitles ()
1027 ExportSubtitlesDialog dialog(this, _film->reels().size(), _film->interop());
1028 if (dialog.ShowModal() != wxID_OK) {
1031 auto job = make_shared<TranscodeJob>(_film, TranscodeJob::ChangedBehaviour::EXAMINE_THEN_STOP);
1033 make_shared<SubtitleEncoder>(_film, job, dialog.path(), _film->isdcf_name(true), dialog.split_reels(), dialog.include_font())
1035 JobManager::instance()->add(job);
1039 void jobs_send_dcp_to_tms ()
1041 _film->send_dcp_to_tms ();
1044 void jobs_show_dcp ()
1046 DCPOMATIC_ASSERT (_film->directory ());
1047 if (show_in_file_manager(_film->directory().get(), _film->dir(_film->dcp_name(false)))) {
1048 error_dialog (this, _("Could not show DCP."));
1052 void view_closed_captions ()
1054 _film_viewer.show_closed_captions ();
1057 void view_video_waveform ()
1059 if (!_video_waveform_dialog) {
1060 _video_waveform_dialog.reset(this, _film, _film_viewer);
1063 _video_waveform_dialog->Show ();
1066 void tools_system_information ()
1068 if (!_system_information_dialog) {
1069 _system_information_dialog = new SystemInformationDialog (this, _film_viewer);
1072 _system_information_dialog->Show ();
1077 if (!_hints_dialog) {
1078 _hints_dialog = new HintsDialog (this, _film, true);
1081 _hints_dialog->Show ();
1084 void tools_encoding_servers ()
1086 if (!_servers_list_dialog) {
1087 _servers_list_dialog = new ServersListDialog (this);
1090 _servers_list_dialog->Show ();
1093 void tools_manage_templates ()
1095 if (!_templates_dialog) {
1096 _templates_dialog.reset(this);
1099 _templates_dialog->Show ();
1102 void tools_check_for_updates ()
1104 _update_news_requested = true;
1105 UpdateChecker::instance()->run();
1108 void tools_send_translations ()
1110 SendI18NDialog dialog(this);
1111 if (dialog.ShowModal() != wxID_OK) {
1116 body += dialog.name() + "\n";
1117 body += dialog.language() + "\n";
1118 body += string(dcpomatic_version) + " " + string(dcpomatic_git_commit) + "\n";
1120 auto translations = I18NHook::translations ();
1121 for (auto i: translations) {
1122 body += i.first + "\n" + i.second + "\n\n";
1124 if (dialog.email().find("@") == string::npos) {
1125 error_dialog (this, _("You must enter a valid email address when sending translations, "
1126 "otherwise the DCP-o-matic maintainers cannot credit you or contact you with questions."));
1128 Emailer emailer(dialog.email(), { "carl@dcpomatic.com" }, "DCP-o-matic translations", body);
1130 emailer.send ("main.carlh.net", 2525, EmailProtocol::STARTTLS);
1131 } catch (NetworkError& e) {
1132 error_dialog (this, _("Could not send translations"), std_to_wx(e.what()));
1139 AboutDialog dialog(this);
1143 void help_report_a_problem ()
1145 ReportProblemDialog dialog(this, _film);
1146 if (dialog.ShowModal() == wxID_OK) {
1151 bool should_close ()
1153 if (!JobManager::instance()->work_to_do ()) {
1157 wxMessageDialog dialog(
1159 _("There are unfinished jobs; are you sure you want to quit?"),
1160 _("Unfinished jobs"),
1161 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
1164 return dialog.ShowModal() == wxID_YES;
1167 void close (wxCloseEvent& ev)
1169 if (!should_close ()) {
1174 if (_film && _film->dirty ()) {
1175 FilmChangedClosingDialog dialog(_film->name());
1176 switch (dialog.run()) {
1178 /* Don't save and carry on to close */
1181 /* Save and carry on to close */
1182 _film->write_metadata ();
1185 /* Veto the event and stop */
1191 /* We don't want to hear about any more configuration changes, since they
1192 cause the File menu to be altered, which itself will be deleted around
1193 now (without, as far as I can see, any way for us to find out).
1195 _config_changed_connection.disconnect ();
1197 /* Also stop hearing about analytics-related stuff */
1198 _analytics_message_connection.disconnect ();
1205 void active_jobs_changed()
1207 /* ActiveJobsChanged can be called while JobManager holds a lock on its mutex, making
1208 * the call to JobManager::get() in set_menu_sensitivity() deadlock unless we work around
1209 * it by using an idle callback. This feels quite unpleasant.
1211 signal_manager->when_idle(boost::bind(&DOMFrame::set_menu_sensitivity, this));
1214 void set_menu_sensitivity ()
1216 auto jobs = JobManager::instance()->get ();
1217 auto i = jobs.begin();
1218 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1221 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1222 bool const have_cpl = _film && !_film->cpls().empty ();
1223 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1224 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1225 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1227 for (auto j: menu_items) {
1229 bool enabled = true;
1231 if ((j.second & NEEDS_FILM) && !_film) {
1235 if ((j.second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1239 if ((j.second & NEEDS_CPL) && !have_cpl) {
1243 if ((j.second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1247 if ((j.second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1251 if ((j.second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1255 if ((j.second & NEEDS_CLIPBOARD) && !_clipboard) {
1259 if ((j.second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1263 j.first->Enable (enabled);
1267 /** @return true if the operation that called this method
1268 * should continue, false to abort it.
1271 bool maybe_save_film ()
1277 while (_film->dirty()) {
1278 T dialog(_film->name());
1279 switch (dialog.run()) {
1284 _film->write_metadata();
1286 } catch (exception& e) {
1287 error_dialog(this, _("Could not save project."), std_to_wx(e.what()));
1288 /* Go round again for another try */
1300 bool maybe_save_then_delete_film ()
1302 bool const r = maybe_save_film<T> ();
1309 void add_item (wxMenu* menu, wxString text, int id, int sens)
1311 auto item = menu->Append (id, text);
1312 menu_items.insert (make_pair (item, sens));
1315 void setup_menu (wxMenuBar* m)
1317 _file_menu = new wxMenu;
1318 /* [Shortcut] Ctrl+N:New film */
1319 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1320 /* [Shortcut] Ctrl+O:Open existing film */
1321 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1322 _file_menu->AppendSeparator ();
1323 /* [Shortcut] Ctrl+S:Save current film */
1324 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1325 _file_menu->AppendSeparator ();
1326 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1327 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1328 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1330 _history_position = _file_menu->GetMenuItems().GetCount();
1332 _file_menu->AppendSeparator ();
1333 /* [Shortcut] Ctrl+W:Close current film */
1334 add_item (_file_menu, _("&Close\tCtrl-W"), ID_file_close, NEEDS_FILM);
1337 _file_menu->AppendSeparator ();
1341 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1343 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1346 auto edit = new wxMenu;
1347 /* [Shortcut] Ctrl+C:Copy settings from currently selected content */
1348 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1349 /* [Shortcut] Ctrl+V:Paste settings into currently selected content */
1350 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1351 edit->AppendSeparator ();
1352 /* [Shortcut] Shift+Ctrl+A:Select all content */
1353 add_item (edit, _("Select all\tShift-Ctrl-A"), ID_edit_select_all, NEEDS_FILM);
1356 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1358 edit->AppendSeparator ();
1359 /* [Shortcut] Ctrl+P:Open preferences window */
1360 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1363 auto jobs_menu = new wxMenu;
1364 /* [Shortcut] Ctrl+M:Make DCP */
1365 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1366 /* [Shortcut] Ctrl+B:Make DCP in the batch converter*/
1367 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1368 jobs_menu->AppendSeparator ();
1369 /* [Shortcut] Ctrl+K:Make KDMs */
1370 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1371 /* [Shortcut] Ctrl+D:Make DKDMs */
1372 add_item (jobs_menu, _("Make &DKDMs...\tCtrl-D"), ID_jobs_make_dkdms, NEEDS_FILM);
1373 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1374 jobs_menu->AppendSeparator ();
1375 /* [Shortcut] Ctrl+E:Export video file */
1376 add_item (jobs_menu, _("Export video file...\tCtrl-E"), ID_jobs_export_video_file, NEEDS_FILM);
1377 add_item (jobs_menu, _("Export subtitles..."), ID_jobs_export_subtitles, NEEDS_FILM);
1378 jobs_menu->AppendSeparator ();
1379 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1381 #if defined(DCPOMATIC_OSX)
1382 add_item (jobs_menu, _("S&how DCP in Finder"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1383 #elif defined(DCPOMATIC_WINDOWS)
1384 add_item (jobs_menu, _("S&how DCP in Explorer"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1386 add_item (jobs_menu, _("S&how DCP in Files"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1389 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1391 auto view = new wxMenu;
1392 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1393 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1395 auto tools = new wxMenu;
1396 add_item (tools, _("Hints..."), ID_tools_hints, NEEDS_FILM);
1397 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1398 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1399 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1400 add_item (tools, _("Send translations..."), ID_tools_send_translations, 0);
1401 add_item (tools, _("System information..."), ID_tools_system_information, 0);
1402 tools->AppendSeparator ();
1403 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1404 tools->AppendSeparator ();
1405 add_item (tools, _("Export preferences..."), ID_tools_export_preferences, ALWAYS);
1407 wxMenu* help = new wxMenu;
1409 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1411 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1413 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1415 m->Append (_file_menu, _("&File"));
1416 m->Append (edit, _("&Edit"));
1417 m->Append (jobs_menu, _("&Jobs"));
1418 m->Append (view, _("&View"));
1419 m->Append (tools, _("&Tools"));
1420 m->Append (help, _("&Help"));
1423 void config_changed (Config::Property what)
1425 /* Instantly save any config changes when using the DCP-o-matic GUI */
1426 if (what == Config::CINEMAS) {
1428 Config::instance()->write_cinemas();
1429 } catch (exception& e) {
1433 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1434 std_to_wx (Config::instance()->cinemas_file().string()).data()
1440 Config::instance()->write_config();
1441 } catch (exception& e) {
1445 _("Could not write to config file at %s. Your changes have not been saved."),
1446 std_to_wx (Config::instance()->cinemas_file().string()).data()
1452 for (int i = 0; i < _history_items; ++i) {
1453 delete _file_menu->Remove (ID_file_history + i);
1456 if (_history_separator) {
1457 _file_menu->Remove (_history_separator);
1459 delete _history_separator;
1460 _history_separator = 0;
1462 int pos = _history_position;
1464 /* Clear out non-existent history items before we re-build the menu */
1465 Config::instance()->clean_history ();
1466 auto history = Config::instance()->history();
1468 if (!history.empty ()) {
1469 _history_separator = _file_menu->InsertSeparator (pos++);
1472 for (size_t i = 0; i < history.size(); ++i) {
1475 s = String::compose ("&%1 %2", i + 1, history[i].string());
1477 s = history[i].string();
1479 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1482 _history_items = history.size ();
1484 dcpomatic_log->set_types (Config::instance()->log_types());
1487 void update_checker_state_changed ()
1489 auto uc = UpdateChecker::instance ();
1491 bool const announce =
1492 _update_news_requested ||
1493 (uc->stable() && Config::instance()->check_for_updates()) ||
1494 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1496 _update_news_requested = false;
1502 if (uc->state() == UpdateChecker::State::YES) {
1503 UpdateDialog dialog(this, uc->stable(), uc->test());
1505 } else if (uc->state() == UpdateChecker::State::FAILED) {
1506 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1508 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1511 _update_news_requested = false;
1514 void start_stop_pressed ()
1516 if (_film_viewer.playing()) {
1517 _film_viewer.stop();
1519 _film_viewer.start();
1523 void timeline_pressed ()
1525 _film_editor->content_panel()->timeline_clicked ();
1530 _film_viewer.seek_by(-_film_viewer.one_video_frame(), true);
1533 void forward_frame ()
1535 _film_viewer.seek_by(_film_viewer.one_video_frame(), true);
1538 void analytics_message (string title, string html)
1540 HTMLDialog dialog(this, std_to_wx(title), std_to_wx(html));
1546 auto s = wx_to_std(_("DCP-o-matic"));
1548 if (_film->directory()) {
1549 s += " - " + _film->directory()->string();
1551 if (_film->dirty()) {
1556 SetTitle (std_to_wx(s));
1559 FilmEditor* _film_editor;
1560 LimitedFrameSplitter* _splitter;
1561 wxPanel* _right_panel;
1562 FilmViewer _film_viewer;
1563 StandardControls* _controls;
1564 wx_ptr<VideoWaveformDialog> _video_waveform_dialog;
1565 SystemInformationDialog* _system_information_dialog = nullptr;
1566 HintsDialog* _hints_dialog = nullptr;
1567 ServersListDialog* _servers_list_dialog = nullptr;
1568 wxPreferencesEditor* _config_dialog = nullptr;
1569 wx_ptr<KDMDialog> _kdm_dialog;
1570 wx_ptr<DKDMDialog> _dkdm_dialog;
1571 wx_ptr<TemplatesDialog> _templates_dialog;
1572 wxMenu* _file_menu = nullptr;
1573 shared_ptr<Film> _film;
1574 int _history_items = 0;
1575 int _history_position = 0;
1576 wxMenuItem* _history_separator = nullptr;
1577 boost::signals2::scoped_connection _config_changed_connection;
1578 boost::signals2::scoped_connection _analytics_message_connection;
1579 bool _update_news_requested = false;
1580 shared_ptr<Content> _clipboard;
1581 bool _first_shown_called = false;
1585 static const wxCmdLineEntryDesc command_line_description[] = {
1586 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1587 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1588 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1589 { wxCMD_LINE_SWITCH, "v", "version", "show DCP-o-matic version", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1590 #ifdef DCPOMATIC_CUCUMBER
1591 { wxCMD_LINE_SWITCH, "t", "cucumber", "enable cucumber tests", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1593 { wxCMD_LINE_OPTION, "", "config", "directory containing config.xml and cinemas.xml", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1594 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1595 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1600 * @brief The magic App class for wxWidgets.
1602 class App : public wxApp
1608 #ifdef DCPOMATIC_LINUX
1615 bool OnInit () override
1619 #if defined(DCPOMATIC_WINDOWS)
1620 if (Config::instance()->win32_console()) {
1623 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
1624 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
1625 FILE* hf_out = _fdopen(hCrt, "w");
1626 setvbuf(hf_out, NULL, _IONBF, 1);
1629 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
1630 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
1631 FILE* hf_in = _fdopen(hCrt, "r");
1632 setvbuf(hf_in, NULL, _IONBF, 128);
1635 cout << "DCP-o-matic is starting." << "\n";
1638 wxInitAllImageHandlers ();
1640 Config::FailedToLoad.connect(boost::bind(&App::config_failed_to_load, this, _1));
1641 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1643 _splash = maybe_show_splash ();
1645 SetAppName (_("DCP-o-matic"));
1647 if (!wxApp::OnInit()) {
1651 #ifdef DCPOMATIC_LINUX
1652 unsetenv ("UBUNTU_MENUPROXY");
1655 #ifdef DCPOMATIC_OSX
1656 dcpomatic_sleep_seconds (1);
1657 make_foreground_application ();
1660 dcpomatic_setup_path_encoding ();
1662 /* Enable i18n; this will create a Config object
1663 to look for a force-configured language. This Config
1664 object will be wrong, however, because dcpomatic_setup
1665 hasn't yet been called and there aren't any filters etc.
1668 dcpomatic_setup_i18n ();
1670 /* Set things up, including filters etc.
1671 which will now be internationalised correctly.
1675 /* Force the configuration to be re-loaded correctly next
1680 /* We only look out for bad configuration from here on, as before
1681 dcpomatic_setup() we haven't got OpenSSL ready so there will be
1682 incorrect certificate chain validity errors.
1684 Config::Bad.connect (boost::bind(&App::config_bad, this, _1));
1686 _frame = new DOMFrame (_("DCP-o-matic"));
1687 SetTopWindow (_frame);
1688 _frame->Maximize ();
1691 if (running_32_on_64 ()) {
1692 NagDialog::maybe_nag (
1693 _frame, Config::NAG_32_ON_64,
1694 _("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."),
1700 signal_manager = new wxSignalManager (this);
1701 Bind (wxEVT_IDLE, boost::bind (&App::idle, this, _1));
1703 if (!_film_to_load.empty() && dcp::filesystem::is_directory(_film_to_load)) {
1705 _frame->load_film (_film_to_load);
1706 } catch (exception& e) {
1707 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()));
1711 if (!_film_to_create.empty ()) {
1712 _frame->new_film (_film_to_create, optional<string>());
1713 if (!_content_to_add.empty()) {
1714 for (auto i: content_factory(_content_to_add)) {
1715 _frame->film()->examine_and_add_content(i);
1718 if (!_dcp_to_add.empty ()) {
1719 _frame->film()->examine_and_add_content(make_shared<DCPContent>(_dcp_to_add));
1723 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1724 _timer.reset (new wxTimer (this));
1725 _timer->Start (1000);
1727 if (Config::instance()->check_for_updates ()) {
1728 UpdateChecker::instance()->run ();
1731 auto release_notes = find_release_notes(gui_is_dark());
1732 if (release_notes) {
1733 HTMLDialog notes(nullptr, _("Release notes"), std_to_wx(*release_notes), true);
1738 #ifdef DCPOMATIC_CUCUMBER
1739 if (_cucumber_bridge) {
1740 _cucumber_bridge->start();
1744 catch (exception& e)
1747 error_dialog (nullptr, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1753 int FilterEvent(wxEvent& event) override
1755 auto key = dynamic_cast<wxKeyEvent*>(&event);
1756 if (key && key->GetEventType() == wxEVT_CHAR) {
1757 std::cout << "CHAR: " << key->m_keyCode << " " << key->m_uniChar << " " << key->m_rawCode << " " << key->m_rawFlags << "\n";
1758 } else if (key && key->GetEventType() == wxEVT_KEY_UP) {
1759 std::cout << "KEY_UP: " << key->m_keyCode << " " << key->m_uniChar << " " << key->m_rawCode << " " << key->m_rawFlags << "\n";
1760 } else if (key && key->GetEventType() == wxEVT_KEY_DOWN) {
1761 std::cout << "KEY_DOWN: " << key->m_keyCode << " " << key->m_uniChar << " " << key->m_rawCode << " " << key->m_rawFlags << "\n";
1766 void OnInitCmdLine(wxCmdLineParser& parser) override
1768 parser.SetDesc (command_line_description);
1769 parser.SetSwitchChars (wxT ("-"));
1772 bool OnCmdLineParsed (wxCmdLineParser& parser) override
1774 if (parser.Found (wxT("version"))) {
1775 cout << "dcpomatic version " << dcpomatic_version << " " << dcpomatic_git_commit << "\n";
1776 exit (EXIT_SUCCESS);
1779 if (parser.GetParamCount() > 0) {
1780 if (parser.Found (wxT ("new"))) {
1781 _film_to_create = wx_to_std (parser.GetParam (0));
1783 _film_to_load = wx_to_std (parser.GetParam (0));
1788 if (parser.Found (wxT ("content"), &content)) {
1789 _content_to_add = wx_to_std (content);
1793 if (parser.Found (wxT ("dcp"), &dcp)) {
1794 _dcp_to_add = wx_to_std (dcp);
1798 if (parser.Found (wxT("config"), &config)) {
1799 State::override_path = wx_to_std (config);
1802 #ifdef DCPOMATIC_CUCUMBER
1803 if (parser.Found(wxT("cucumber"))) {
1804 _cucumber_bridge = new CucumberBridge ();
1805 _cucumber_bridge->ClickButton.connect (bind(&App::cucumber_click_button, this, _1));
1806 _cucumber_bridge->SelectMenu.connect (bind(&App::cucumber_select_menu, this, _1));
1807 _cucumber_bridge->Type.connect (bind(&App::cucumber_type, this, _1));
1808 _cucumber_bridge->AddContentFile.connect (bind(&App::cucumber_add_content_file, this, _1));
1809 _cucumber_bridge->GetContentList.connect (bind(&App::cucumber_get_content_list, this));
1817 #ifdef DCPOMATIC_CUCUMBER
1818 void cucumber_add_content_file (string filename)
1820 _frame->cucumber_add_content_file (filename);
1824 std::string cucumber_get_content_list ()
1826 return _frame->cucumber_get_content_list ();
1830 void cucumber_click_button (string id)
1832 CucumberRegistry::instance()->click_button (id);
1836 void cucumber_select_menu (string id)
1838 if (id == CUCUMBER_MENU_FILE_NEW) {
1839 wxPostEvent (_frame, wxMenuEvent(wxEVT_MENU, ID_file_new));
1844 void cucumber_type (string text)
1846 #ifdef DCPOMATIC_LINUX
1847 // xdo_t* xdo = xdo_new (NULL);
1848 // xdo_enter_text_window (xdo, CURRENTWINDOW, text.c_str(), 200000);
1849 // xdo_send_keysequence_window (xdo, CURRENTWINDOW, "Return", 200000);
1851 auto send = [this](int code, int rawcode) {
1852 auto event = wxKeyEvent(wxEVT_KEY_DOWN);
1853 event.SetEventObject(this);
1854 event.m_keyCode = event.m_uniChar = code;
1855 event.m_rawCode = rawcode;
1856 std::cout << "process " << code << " " << rawcode << "\n";
1857 ProcessEvent (event);
1859 event = wxKeyEvent(wxEVT_CHAR);
1860 event.SetEventObject(this);
1861 event.m_keyCode = event.m_uniChar = code;
1862 event.m_rawCode = rawcode;
1863 std::cout << "process " << code << " " << rawcode << "\n";
1864 ProcessEvent (event);
1866 event = wxKeyEvent(wxEVT_KEY_UP);
1867 event.SetEventObject(this);
1868 event.m_keyCode = event.m_uniChar = code;
1869 event.m_rawCode = rawcode;
1870 std::cout << "process " << code << " " << rawcode << "\n";
1871 ProcessEvent (event);
1874 for (auto i = 0U; i < text.length(); ++i) {
1875 send (text[i], text[i]);
1877 send (WXK_RETURN, 65293);
1882 void report_exception ()
1886 } catch (FileError& e) {
1890 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1891 std_to_wx (e.what()),
1892 std_to_wx (e.file().string().c_str())
1895 } catch (boost::filesystem::filesystem_error& e) {
1899 _("An exception occurred: %s (%s) (%s)\n\n") + REPORT_PROBLEM,
1900 std_to_wx (e.what()),
1901 std_to_wx (e.path1().string()),
1902 std_to_wx (e.path2().string())
1905 } catch (exception& e) {
1909 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1910 std_to_wx (e.what ())
1914 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1918 /* An unhandled exception has occurred inside the main event loop */
1919 bool OnExceptionInMainLoop () override
1921 report_exception ();
1922 /* This will terminate the program */
1926 void OnUnhandledException () override
1928 report_exception ();
1931 void idle (wxIdleEvent& ev)
1933 signal_manager->ui_idle ();
1940 EncodeServerFinder::instance()->rethrow ();
1941 } catch (exception& e) {
1942 error_dialog (0, std_to_wx (e.what ()));
1946 void close_splash ()
1954 void config_failed_to_load (Config::LoadFailure what)
1956 report_config_load_failure(_frame, what);
1959 void config_warning (string m)
1961 message_dialog (_frame, std_to_wx(m));
1964 bool config_bad (Config::BadReason reason)
1966 /* Destroy the splash screen here, as otherwise bad things seem to happen (for reasons unknown)
1967 when we open our recreate dialog, close it, *then* try to Destroy the splash (the Destroy fails).
1971 auto config = Config::instance();
1973 case Config::BAD_SIGNER_UTF8_STRINGS:
1975 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_UTF8)) {
1978 RecreateChainDialog dialog(
1979 _frame, _("Recreate signing certificates"),
1980 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs contains a small error\n"
1981 "which will prevent DCPs from being validated correctly on some systems. Do you want to re-create\n"
1982 "the certificate chain for signing DCPs and KDMs?"),
1984 Config::NAG_BAD_SIGNER_CHAIN_UTF8
1986 return dialog.ShowModal() == wxID_OK;
1988 case Config::BAD_SIGNER_VALIDITY_TOO_LONG:
1990 if (config->nagged(Config::NAG_BAD_SIGNER_CHAIN_VALIDITY)) {
1993 RecreateChainDialog dialog(
1994 _frame, _("Recreate signing certificates"),
1995 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs has a validity period\n"
1996 "that is too long. This will cause problems playing back DCPs on some systems.\n"
1997 "Do you want to re-create the certificate chain for signing DCPs and KDMs?"),
1999 Config::NAG_BAD_SIGNER_CHAIN_VALIDITY
2001 return dialog.ShowModal() == wxID_OK;
2003 case Config::BAD_SIGNER_INCONSISTENT:
2005 RecreateChainDialog dialog(
2006 _frame, _("Recreate signing certificates"),
2007 _("The certificate chain that DCP-o-matic uses for signing DCPs and KDMs is inconsistent and\n"
2008 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
2009 "the certificate chain for signing DCPs and KDMs?"),
2010 _("Close DCP-o-matic")
2012 if (dialog.ShowModal() != wxID_OK) {
2013 exit (EXIT_FAILURE);
2017 case Config::BAD_DECRYPTION_INCONSISTENT:
2019 RecreateChainDialog dialog(
2020 _frame, _("Recreate KDM decryption chain"),
2021 _("The certificate chain that DCP-o-matic uses for decrypting KDMs is inconsistent and\n"
2022 "cannot be used. DCP-o-matic cannot start unless you re-create it. Do you want to re-create\n"
2023 "the certificate chain for decrypting KDMs? You may want to say \"No\" here and back up your\n"
2024 "configuration before continuing."),
2025 _("Close DCP-o-matic")
2027 if (dialog.ShowModal() != wxID_OK) {
2028 exit (EXIT_FAILURE);
2033 DCPOMATIC_ASSERT (false);
2037 DOMFrame* _frame = nullptr;
2038 wxSplashScreen* _splash = nullptr;
2039 shared_ptr<wxTimer> _timer;
2040 string _film_to_load;
2041 string _film_to_create;
2042 string _content_to_add;
2044 #ifdef DCPOMATIC_CUCUMBER
2045 CucumberBridge* _cucumber_bridge = nullptr;