2 Copyright (C) 2012-2018 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/>.
21 /** @file src/tools/dcpomatic.cc
22 * @brief The main DCP-o-matic GUI.
25 #include "wx/film_viewer.h"
26 #include "wx/film_editor.h"
27 #include "wx/job_manager_view.h"
28 #include "wx/full_config_dialog.h"
29 #include "wx/wx_util.h"
30 #include "wx/film_name_location_dialog.h"
31 #include "wx/wx_signal_manager.h"
32 #include "wx/recreate_chain_dialog.h"
33 #include "wx/about_dialog.h"
34 #include "wx/kdm_dialog.h"
35 #include "wx/self_dkdm_dialog.h"
36 #include "wx/servers_list_dialog.h"
37 #include "wx/hints_dialog.h"
38 #include "wx/update_dialog.h"
39 #include "wx/content_panel.h"
40 #include "wx/report_problem_dialog.h"
41 #include "wx/video_waveform_dialog.h"
42 #include "wx/save_template_dialog.h"
43 #include "wx/templates_dialog.h"
44 #include "wx/nag_dialog.h"
45 #include "wx/export_dialog.h"
46 #include "wx/paste_dialog.h"
47 #include "wx/focus_manager.h"
49 #include "lib/config.h"
51 #include "lib/video_content.h"
52 #include "lib/content.h"
53 #include "lib/version.h"
54 #include "lib/signal_manager.h"
56 #include "lib/job_manager.h"
57 #include "lib/exceptions.h"
58 #include "lib/cinema.h"
59 #include "lib/screen_kdm.h"
60 #include "lib/send_kdm_email_job.h"
61 #include "lib/encode_server_finder.h"
62 #include "lib/update_checker.h"
63 #include "lib/cross.h"
64 #include "lib/content_factory.h"
65 #include "lib/compose.hpp"
66 #include "lib/cinema_kdms.h"
67 #include "lib/dcpomatic_socket.h"
68 #include "lib/hints.h"
69 #include "lib/dcp_content.h"
70 #include "lib/ffmpeg_encoder.h"
71 #include "lib/transcode_job.h"
72 #include "lib/dkdm_wrapper.h"
73 #include "lib/audio_content.h"
74 #include "lib/text_content.h"
75 #include <dcp/exceptions.h>
76 #include <dcp/raw_convert.h>
77 #include <wx/generic/aboutdlgg.h>
78 #include <wx/stdpaths.h>
79 #include <wx/cmdline.h>
80 #include <wx/preferences.h>
81 #include <wx/splash.h>
86 #include <ApplicationServices/ApplicationServices.h>
88 #include <boost/filesystem.hpp>
89 #include <boost/noncopyable.hpp>
90 #include <boost/foreach.hpp>
93 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
105 using std::wstringstream;
107 using std::make_pair;
109 using std::exception;
110 using boost::shared_ptr;
111 using boost::dynamic_pointer_cast;
112 using boost::optional;
113 using boost::function;
114 using dcp::raw_convert;
116 class FilmChangedClosingDialog : public boost::noncopyable
119 explicit FilmChangedClosingDialog (string name)
121 _dialog = new wxMessageDialog (
123 wxString::Format (_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
124 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
125 /// project (Film) has been changed since it was last saved.
127 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
130 _dialog->SetYesNoCancelLabels (
131 _("Save film and close"), _("Close without saving film"), _("Don't close")
135 ~FilmChangedClosingDialog ()
142 return _dialog->ShowModal ();
146 wxMessageDialog* _dialog;
149 class FilmChangedDuplicatingDialog : public boost::noncopyable
152 explicit FilmChangedDuplicatingDialog (string name)
154 _dialog = new wxMessageDialog (
156 wxString::Format (_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
157 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
158 /// project (Film) has been changed since it was last saved.
160 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
163 _dialog->SetYesNoCancelLabels (
164 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
168 ~FilmChangedDuplicatingDialog ()
175 return _dialog->ShowModal ();
179 wxMessageDialog* _dialog;
183 #define NEEDS_FILM 0x1
184 #define NOT_DURING_DCP_CREATION 0x2
185 #define NEEDS_CPL 0x4
186 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
187 #define NEEDS_SELECTED_CONTENT 0x10
188 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
189 #define NEEDS_CLIPBOARD 0x40
190 #define NEEDS_ENCRYPTION 0x80
192 map<wxMenuItem*, int> menu_items;
198 ID_file_save_as_template,
200 ID_file_duplicate_and_open,
202 /* Allow spare IDs after _history for the recent files list */
205 ID_content_scale_to_fit_width,
206 ID_content_scale_to_fit_height,
208 ID_jobs_make_dcp_batch,
210 ID_jobs_make_self_dkdm,
212 ID_jobs_send_dcp_to_tms,
214 ID_jobs_open_dcp_in_player,
215 ID_view_closed_captions,
216 ID_view_video_waveform,
218 ID_tools_encoding_servers,
219 ID_tools_manage_templates,
220 ID_tools_check_for_updates,
221 ID_tools_restore_default_preferences,
222 ID_help_report_a_problem,
223 /* IDs for shortcuts (with no associated menu item) */
232 class DOMFrame : public wxFrame
235 explicit DOMFrame (wxString const & title)
236 : wxFrame (NULL, -1, title)
237 , _video_waveform_dialog (0)
239 , _servers_list_dialog (0)
242 , _templates_dialog (0)
245 , _history_position (0)
246 , _history_separator (0)
247 , _update_news_requested (false)
249 #if defined(DCPOMATIC_WINDOWS)
250 if (Config::instance()->win32_console ()) {
253 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
254 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
255 FILE* hf_out = _fdopen(hCrt, "w");
256 setvbuf(hf_out, NULL, _IONBF, 1);
259 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
260 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
261 FILE* hf_in = _fdopen(hCrt, "r");
262 setvbuf(hf_in, NULL, _IONBF, 128);
265 cout << "DCP-o-matic is starting." << "\n";
269 wxMenuBar* bar = new wxMenuBar;
273 #ifdef DCPOMATIC_WINDOWS
274 SetIcon (wxIcon (std_to_wx ("id")));
277 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
278 config_changed (Config::OTHER);
280 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
281 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
282 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
283 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
284 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
285 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
286 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
287 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
288 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
289 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
290 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
291 Bind (wxEVT_MENU, boost::bind (&DOMFrame::content_scale_to_fit_width, this), ID_content_scale_to_fit_width);
292 Bind (wxEVT_MENU, boost::bind (&DOMFrame::content_scale_to_fit_height, this), ID_content_scale_to_fit_height);
293 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
294 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
295 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
296 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
297 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export, this), ID_jobs_export);
298 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
299 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
300 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
301 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
302 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
303 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
304 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
305 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
306 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
307 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
308 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
309 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
311 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
313 /* Use a panel as the only child of the Frame so that we avoid
314 the dark-grey background on Windows.
316 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
318 _film_viewer = new FilmViewer (overall_panel);
319 _film_editor = new FilmEditor (overall_panel, _film_viewer);
320 JobManagerView* job_manager_view = new JobManagerView (overall_panel, false);
322 wxBoxSizer* right_sizer = new wxBoxSizer (wxVERTICAL);
323 right_sizer->Add (_film_viewer, 2, wxEXPAND | wxALL, 6);
324 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
326 wxBoxSizer* main_sizer = new wxBoxSizer (wxHORIZONTAL);
327 main_sizer->Add (_film_editor, 1, wxEXPAND | wxALL, 6);
328 main_sizer->Add (right_sizer, 2, wxEXPAND | wxALL, 6);
330 set_menu_sensitivity ();
332 _film_editor->FileChanged.connect (bind (&DOMFrame::file_changed, this, _1));
333 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
336 JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
338 overall_panel->SetSizer (main_sizer);
340 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
342 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
343 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
347 void add_accelerators ()
350 int accelerators = 7;
352 int accelerators = 6;
354 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
355 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
356 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
357 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
358 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
359 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
360 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
362 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), wxID_EXIT);
364 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
365 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
366 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
370 wxAcceleratorTable accel_table (accelerators, accel);
371 SetAcceleratorTable (accel_table);
375 void remove_accelerators ()
377 SetAcceleratorTable (wxAcceleratorTable ());
380 void remove_clicked (wxCommandEvent& ev)
382 if (_film_editor->content_panel()->remove_clicked (true)) {
387 void new_film (boost::filesystem::path path, optional<string> template_name)
389 shared_ptr<Film> film (new Film (path));
391 film->use_template (template_name.get());
393 film->set_name (path.filename().generic_string());
394 film->write_metadata ();
398 void load_film (boost::filesystem::path file)
401 shared_ptr<Film> film (new Film (file));
402 list<string> const notes = film->read_metadata ();
404 if (film->state_version() == 4) {
407 _("This film was created with an old version of DVD-o-matic and may not load correctly "
408 "in this version. Please check the film's settings carefully.")
412 for (list<string>::const_iterator i = notes.begin(); i != notes.end(); ++i) {
413 error_dialog (0, std_to_wx (*i));
418 catch (std::exception& e) {
419 wxString p = std_to_wx (file.string ());
420 wxCharBuffer b = p.ToUTF8 ();
421 error_dialog (this, wxString::Format (_("Could not open film at %s"), p.data()), std_to_wx (e.what()));
424 void set_film (shared_ptr<Film> film)
427 _film_viewer->set_film (_film);
428 _film_editor->set_film (_film);
429 if (_video_waveform_dialog) {
430 _video_waveform_dialog->Destroy ();
431 _video_waveform_dialog = 0;
433 set_menu_sensitivity ();
434 if (_film->directory()) {
435 Config::instance()->add_to_history (_film->directory().get());
437 _film->Changed.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
440 shared_ptr<Film> film () const {
446 void file_changed (boost::filesystem::path f)
448 string s = wx_to_std (_("DCP-o-matic"));
450 s += " - " + f.string ();
453 SetTitle (std_to_wx (s));
458 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("New Film"), true);
459 int const r = d->ShowModal ();
461 if (r == wxID_OK && d->check_path() && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
463 new_film (d->path(), d->template_name());
464 } catch (boost::filesystem::filesystem_error& e) {
465 error_dialog (this, _("Could not create folder to store film"), std_to_wx(e.what()));
474 wxDirDialog* c = new wxDirDialog (
476 _("Select film to open"),
477 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
478 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
484 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
485 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
491 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
492 load_film (wx_to_std (c->GetPath ()));
500 _film->write_metadata ();
503 void file_save_as_template ()
505 SaveTemplateDialog* d = new SaveTemplateDialog (this);
506 int const r = d->ShowModal ();
508 Config::instance()->save_template (_film, d->name ());
513 void file_duplicate ()
515 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
516 int const r = d->ShowModal ();
518 if (r == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
519 shared_ptr<Film> film (new Film (d->path()));
520 film->copy_from (_film);
521 film->set_name (d->path().filename().generic_string());
522 film->write_metadata ();
528 void file_duplicate_and_open ()
530 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
531 int const r = d->ShowModal ();
533 if (r == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
534 shared_ptr<Film> film (new Film (d->path()));
535 film->copy_from (_film);
536 film->set_name (d->path().filename().generic_string());
537 film->write_metadata ();
544 void file_history (wxCommandEvent& event)
546 vector<boost::filesystem::path> history = Config::instance()->history ();
547 int n = event.GetId() - ID_file_history;
548 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
549 load_film (history[n]);
555 /* false here allows the close handler to veto the close request */
561 ContentList const sel = _film_editor->content_panel()->selected();
562 DCPOMATIC_ASSERT (sel.size() == 1);
563 _clipboard = sel.front()->clone();
568 DCPOMATIC_ASSERT (_clipboard);
570 PasteDialog* d = new PasteDialog (this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
571 if (d->ShowModal() == wxID_OK) {
572 BOOST_FOREACH (shared_ptr<Content> i, _film_editor->content_panel()->selected()) {
573 if (d->video() && i->video) {
574 DCPOMATIC_ASSERT (_clipboard->video);
575 i->video->take_settings_from (_clipboard->video);
577 if (d->audio() && i->audio) {
578 DCPOMATIC_ASSERT (_clipboard->audio);
579 i->audio->take_settings_from (_clipboard->audio);
583 list<shared_ptr<TextContent> >::iterator j = i->text.begin ();
584 list<shared_ptr<TextContent> >::const_iterator k = _clipboard->text.begin ();
585 while (j != i->text.end() && k != _clipboard->text.end()) {
586 (*j)->take_settings_from (*k);
596 void edit_preferences ()
598 if (!_config_dialog) {
599 _config_dialog = create_full_config_dialog ();
601 _config_dialog->Show (this);
604 void tools_restore_default_preferences ()
606 wxMessageDialog* d = new wxMessageDialog (
608 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
609 _("Restore default preferences"),
610 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
613 int const r = d->ShowModal ();
617 Config::restore_defaults ();
621 void jobs_make_dcp ()
627 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
630 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);
632 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);
634 if (!confirm_dialog (this, message)) {
639 if (!get_hints(_film).empty() && Config::instance()->show_hints_before_make_dcp()) {
640 HintsDialog* hints = new HintsDialog (this, _film, false);
641 int const r = hints->ShowModal();
643 if (r == wxID_CANCEL) {
648 if (_film->encrypted ()) {
649 NagDialog::maybe_nag (
651 Config::NAG_ENCRYPTED_METADATA,
652 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
653 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
654 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
655 "if you want to make KDMs for this film.")
659 /* Remove any existing DCP if the user agrees */
660 boost::filesystem::path const dcp_dir = _film->dir (_film->dcp_name(), false);
661 if (boost::filesystem::exists (dcp_dir)) {
662 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
665 boost::filesystem::remove_all (dcp_dir);
669 /* It seems to make sense to auto-save metadata here, since the make DCP may last
670 a long time, and crashes/power failures are moderately likely.
672 _film->write_metadata ();
674 } catch (BadSettingError& e) {
675 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
676 } catch (std::exception& e) {
677 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
681 void jobs_make_kdms ()
688 _kdm_dialog->Destroy ();
692 _kdm_dialog = new KDMDialog (this, _film);
693 _kdm_dialog->Show ();
696 /** @return false if we succeeded, true if not */
697 bool send_to_other_tool (int port, function<void(boost::filesystem::path)> start, string message)
699 /* i = 0; try to connect via socket
700 i = 1; try again, and then try to start the tool
701 i = 2 onwards; try again.
703 for (int i = 0; i < 8; ++i) {
705 boost::asio::io_service io_service;
706 boost::asio::ip::tcp::resolver resolver (io_service);
707 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
708 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
710 socket.connect (*endpoint_iterator);
711 DCPOMATIC_ASSERT (_film->directory ());
712 socket.write (message.length() + 1);
713 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
718 } catch (exception& e) {
723 start (wx_to_std (wxStandardPaths::Get().GetExecutablePath()));
732 void jobs_make_dcp_batch ()
738 if (!get_hints(_film).empty() && Config::instance()->show_hints_before_make_dcp()) {
739 HintsDialog* hints = new HintsDialog (this, _film, false);
740 int const r = hints->ShowModal();
742 if (r == wxID_CANCEL) {
747 _film->write_metadata ();
749 if (send_to_other_tool (BATCH_JOB_PORT, bind (&start_batch_converter, _1), _film->directory()->string())) {
750 error_dialog (this, _("Could not find batch converter."));
754 void jobs_open_dcp_in_player ()
760 if (send_to_other_tool (PLAYER_PLAY_PORT, bind (&start_player, _1), _film->dir(_film->dcp_name(false)).string())) {
761 error_dialog (this, _("Could not find player."));
765 void jobs_make_self_dkdm ()
771 SelfDKDMDialog* d = new SelfDKDMDialog (this, _film);
772 if (d->ShowModal () != wxID_OK) {
777 NagDialog::maybe_nag (
779 Config::NAG_DKDM_CONFIG,
781 _("You are making a DKDM which is encrypted by a private key held in"
782 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
783 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
784 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_file().string()).data()
788 optional<dcp::EncryptedKDM> kdm;
790 kdm = _film->make_kdm (
791 Config::instance()->decryption_chain()->leaf(),
792 vector<dcp::Certificate> (),
794 dcp::LocalTime ("2012-01-01T01:00:00+00:00"),
795 dcp::LocalTime ("2112-01-01T01:00:00+00:00"),
796 dcp::MODIFIED_TRANSITIONAL_1,
800 } catch (dcp::NotEncryptedError& e) {
801 error_dialog (this, _("CPL's content is not encrypted."));
802 } catch (exception& e) {
803 error_dialog (this, e.what ());
805 error_dialog (this, _("An unknown exception occurred."));
809 if (d->internal ()) {
810 shared_ptr<DKDMGroup> dkdms = Config::instance()->dkdms ();
811 dkdms->add (shared_ptr<DKDM> (new DKDM (kdm.get())));
812 Config::instance()->changed ();
814 boost::filesystem::path path = d->directory() / (_film->dcp_name(false) + "_DKDM.xml");
824 ExportDialog* d = new ExportDialog (this);
825 if (d->ShowModal() == wxID_OK) {
826 shared_ptr<TranscodeJob> job (new TranscodeJob (_film));
827 job->set_encoder (shared_ptr<FFmpegEncoder> (new FFmpegEncoder (_film, job, d->path(), d->format(), d->mixdown_to_stereo())));
828 JobManager::instance()->add (job);
833 void content_scale_to_fit_width ()
835 ContentList vc = _film_editor->content_panel()->selected_video ();
836 for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
837 (*i)->video->scale_and_crop_to_fit_width ();
841 void content_scale_to_fit_height ()
843 ContentList vc = _film_editor->content_panel()->selected_video ();
844 for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
845 (*i)->video->scale_and_crop_to_fit_height ();
849 void jobs_send_dcp_to_tms ()
851 _film->send_dcp_to_tms ();
854 void jobs_show_dcp ()
856 DCPOMATIC_ASSERT (_film->directory ());
857 #ifdef DCPOMATIC_WINDOWS
859 args << "/select," << _film->dir (_film->dcp_name(false));
860 ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
863 #ifdef DCPOMATIC_LINUX
864 int r = system ("which nautilus");
865 if (WEXITSTATUS (r) == 0) {
866 r = system (String::compose("nautilus \"%1\"", _film->directory()->string()).c_str());
867 if (WEXITSTATUS (r)) {
868 error_dialog (this, _("Could not show DCP."), _("Could not run nautilus"));
871 int r = system ("which konqueror");
872 if (WEXITSTATUS (r) == 0) {
873 r = system (String::compose ("konqueror \"%1\"", _film->directory()->string()).c_str());
874 if (WEXITSTATUS (r)) {
875 error_dialog (this, _("Could not show DCP"), _("Could not run konqueror"));
882 int r = system (String::compose ("open -R \"%1\"", _film->dir (_film->dcp_name(false)).string()).c_str());
883 if (WEXITSTATUS (r)) {
884 error_dialog (this, _("Could not show DCP"));
889 void view_closed_captions ()
891 _film_viewer->show_closed_captions ();
894 void view_video_waveform ()
896 if (!_video_waveform_dialog) {
897 _video_waveform_dialog = new VideoWaveformDialog (this, _film, _film_viewer);
900 _video_waveform_dialog->Show ();
905 if (!_hints_dialog) {
906 _hints_dialog = new HintsDialog (this, _film, true);
909 _hints_dialog->Show ();
912 void tools_encoding_servers ()
914 if (!_servers_list_dialog) {
915 _servers_list_dialog = new ServersListDialog (this);
918 _servers_list_dialog->Show ();
921 void tools_manage_templates ()
923 if (!_templates_dialog) {
924 _templates_dialog = new TemplatesDialog (this);
927 _templates_dialog->Show ();
930 void tools_check_for_updates ()
932 UpdateChecker::instance()->run ();
933 _update_news_requested = true;
938 AboutDialog* d = new AboutDialog (this);
943 void help_report_a_problem ()
945 ReportProblemDialog* d = new ReportProblemDialog (this, _film);
946 if (d->ShowModal () == wxID_OK) {
954 if (!JobManager::instance()->work_to_do ()) {
958 wxMessageDialog* d = new wxMessageDialog (
960 _("There are unfinished jobs; are you sure you want to quit?"),
961 _("Unfinished jobs"),
962 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
965 bool const r = d->ShowModal() == wxID_YES;
970 void close (wxCloseEvent& ev)
972 if (!should_close ()) {
977 if (_film && _film->dirty ()) {
979 FilmChangedClosingDialog* dialog = new FilmChangedClosingDialog (_film->name ());
980 int const r = dialog->run ();
985 /* Don't save and carry on to close */
988 /* Save and carry on to close */
989 _film->write_metadata ();
992 /* Veto the event and stop */
998 /* We don't want to hear about any more configuration changes, since they
999 cause the File menu to be altered, which itself will be deleted around
1000 now (without, as far as I can see, any way for us to find out).
1002 _config_changed_connection.disconnect ();
1007 void set_menu_sensitivity ()
1009 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
1010 list<shared_ptr<Job> >::iterator i = jobs.begin();
1011 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1014 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1015 bool const have_cpl = _film && !_film->cpls().empty ();
1016 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1017 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1018 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1020 for (map<wxMenuItem*, int>::iterator j = menu_items.begin(); j != menu_items.end(); ++j) {
1022 bool enabled = true;
1024 if ((j->second & NEEDS_FILM) && !_film) {
1028 if ((j->second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1032 if ((j->second & NEEDS_CPL) && !have_cpl) {
1036 if ((j->second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1040 if ((j->second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1044 if ((j->second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1048 if ((j->second & NEEDS_CLIPBOARD) && !_clipboard) {
1052 if ((j->second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1056 j->first->Enable (enabled);
1060 /** @return true if the operation that called this method
1061 * should continue, false to abort it.
1064 bool maybe_save_film ()
1070 if (_film->dirty ()) {
1071 T d (_film->name ());
1076 _film->write_metadata ();
1087 bool maybe_save_then_delete_film ()
1089 bool const r = maybe_save_film<T> ();
1096 void add_item (wxMenu* menu, wxString text, int id, int sens)
1098 wxMenuItem* item = menu->Append (id, text);
1099 menu_items.insert (make_pair (item, sens));
1102 void setup_menu (wxMenuBar* m)
1104 _file_menu = new wxMenu;
1105 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1106 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1107 _file_menu->AppendSeparator ();
1108 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1109 _file_menu->AppendSeparator ();
1110 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1111 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1112 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1114 _history_position = _file_menu->GetMenuItems().GetCount();
1117 _file_menu->AppendSeparator ();
1121 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1123 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1126 wxMenu* edit = new wxMenu;
1127 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1128 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1131 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1133 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1136 wxMenu* content = new wxMenu;
1137 add_item (content, _("Scale to fit &width"), ID_content_scale_to_fit_width, NEEDS_FILM | NEEDS_SELECTED_VIDEO_CONTENT);
1138 add_item (content, _("Scale to fit &height"), ID_content_scale_to_fit_height, NEEDS_FILM | NEEDS_SELECTED_VIDEO_CONTENT);
1140 wxMenu* jobs_menu = new wxMenu;
1141 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1142 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1143 jobs_menu->AppendSeparator ();
1144 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1145 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1146 jobs_menu->AppendSeparator ();
1147 add_item (jobs_menu, _("Export...\tCtrl-E"), ID_jobs_export, NEEDS_FILM);
1148 jobs_menu->AppendSeparator ();
1149 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1150 add_item (jobs_menu, _("S&how DCP"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1151 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1153 wxMenu* view = new wxMenu;
1154 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1155 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1157 wxMenu* tools = new wxMenu;
1158 add_item (tools, _("Hints..."), ID_tools_hints, 0);
1159 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1160 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1161 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1162 tools->AppendSeparator ();
1163 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1165 wxMenu* help = new wxMenu;
1167 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1169 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1171 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1173 m->Append (_file_menu, _("&File"));
1174 m->Append (edit, _("&Edit"));
1175 m->Append (content, _("&Content"));
1176 m->Append (jobs_menu, _("&Jobs"));
1177 m->Append (view, _("&View"));
1178 m->Append (tools, _("&Tools"));
1179 m->Append (help, _("&Help"));
1182 void config_changed (Config::Property what)
1184 /* Instantly save any config changes when using the DCP-o-matic GUI */
1185 if (what == Config::CINEMAS) {
1187 Config::instance()->write_cinemas();
1188 } catch (exception& e) {
1192 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1193 std_to_wx (Config::instance()->cinemas_file().string()).data()
1199 Config::instance()->write_config();
1200 } catch (exception& e) {
1204 _("Could not write to config file at %s. Your changes have not been saved."),
1205 std_to_wx (Config::instance()->cinemas_file().string()).data()
1211 for (int i = 0; i < _history_items; ++i) {
1212 delete _file_menu->Remove (ID_file_history + i);
1215 if (_history_separator) {
1216 _file_menu->Remove (_history_separator);
1218 delete _history_separator;
1219 _history_separator = 0;
1221 int pos = _history_position;
1223 vector<boost::filesystem::path> history = Config::instance()->history ();
1225 if (!history.empty ()) {
1226 _history_separator = _file_menu->InsertSeparator (pos++);
1229 for (size_t i = 0; i < history.size(); ++i) {
1232 s = String::compose ("&%1 %2", i + 1, history[i].string());
1234 s = history[i].string();
1236 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1239 _history_items = history.size ();
1242 void update_checker_state_changed ()
1244 UpdateChecker* uc = UpdateChecker::instance ();
1246 bool const announce =
1247 _update_news_requested ||
1248 (uc->stable() && Config::instance()->check_for_updates()) ||
1249 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1251 _update_news_requested = false;
1257 if (uc->state() == UpdateChecker::YES) {
1258 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
1259 dialog->ShowModal ();
1261 } else if (uc->state() == UpdateChecker::FAILED) {
1262 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1264 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1267 _update_news_requested = false;
1270 void start_stop_pressed ()
1272 if (_film_viewer->playing()) {
1273 _film_viewer->stop();
1275 _film_viewer->start();
1279 void timeline_pressed ()
1281 _film_editor->content_panel()->timeline_clicked ();
1286 _film_viewer->back_frame ();
1289 void forward_frame ()
1291 _film_viewer->forward_frame ();
1294 FilmEditor* _film_editor;
1295 FilmViewer* _film_viewer;
1296 VideoWaveformDialog* _video_waveform_dialog;
1297 HintsDialog* _hints_dialog;
1298 ServersListDialog* _servers_list_dialog;
1299 wxPreferencesEditor* _config_dialog;
1300 KDMDialog* _kdm_dialog;
1301 TemplatesDialog* _templates_dialog;
1303 shared_ptr<Film> _film;
1305 int _history_position;
1306 wxMenuItem* _history_separator;
1307 boost::signals2::scoped_connection _config_changed_connection;
1308 bool _update_news_requested;
1309 shared_ptr<Content> _clipboard;
1312 static const wxCmdLineEntryDesc command_line_description[] = {
1313 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1314 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1315 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1316 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1317 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1321 * @brief The magic App class for wxWidgets.
1323 class App : public wxApp
1336 wxInitAllImageHandlers ();
1338 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1339 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1341 wxSplashScreen* splash = maybe_show_splash ();
1343 SetAppName (_("DCP-o-matic"));
1345 if (!wxApp::OnInit()) {
1349 #ifdef DCPOMATIC_LINUX
1350 unsetenv ("UBUNTU_MENUPROXY");
1354 ProcessSerialNumber serial;
1355 GetCurrentProcess (&serial);
1356 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
1359 dcpomatic_setup_path_encoding ();
1361 /* Enable i18n; this will create a Config object
1362 to look for a force-configured language. This Config
1363 object will be wrong, however, because dcpomatic_setup
1364 hasn't yet been called and there aren't any filters etc.
1367 dcpomatic_setup_i18n ();
1369 /* Set things up, including filters etc.
1370 which will now be internationalised correctly.
1374 /* Force the configuration to be re-loaded correctly next
1379 Config::BadSignerChain.connect (boost::bind (&App::config_bad_signer_chain, this));
1381 _frame = new DOMFrame (_("DCP-o-matic"));
1382 SetTopWindow (_frame);
1383 _frame->Maximize ();
1389 if (!_film_to_load.empty() && boost::filesystem::is_directory (_film_to_load)) {
1391 _frame->load_film (_film_to_load);
1392 } catch (exception& e) {
1393 error_dialog (0, std_to_wx (String::compose (wx_to_std (_("Could not load film %1 (%2)")), _film_to_load)), std_to_wx(e.what()));
1397 if (!_film_to_create.empty ()) {
1398 _frame->new_film (_film_to_create, optional<string> ());
1399 if (!_content_to_add.empty ()) {
1400 BOOST_FOREACH (shared_ptr<Content> i, content_factory (_frame->film(), _content_to_add)) {
1401 _frame->film()->examine_and_add_content (i);
1404 if (!_dcp_to_add.empty ()) {
1405 _frame->film()->examine_and_add_content (shared_ptr<DCPContent> (new DCPContent (_frame->film(), _dcp_to_add)));
1409 signal_manager = new wxSignalManager (this);
1410 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1412 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1413 _timer.reset (new wxTimer (this));
1414 _timer->Start (1000);
1416 if (Config::instance()->check_for_updates ()) {
1417 UpdateChecker::instance()->run ();
1422 catch (exception& e)
1424 error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1428 void OnInitCmdLine (wxCmdLineParser& parser)
1430 parser.SetDesc (command_line_description);
1431 parser.SetSwitchChars (wxT ("-"));
1434 bool OnCmdLineParsed (wxCmdLineParser& parser)
1436 if (parser.GetParamCount() > 0) {
1437 if (parser.Found (wxT ("new"))) {
1438 _film_to_create = wx_to_std (parser.GetParam (0));
1440 _film_to_load = wx_to_std (parser.GetParam (0));
1445 if (parser.Found (wxT ("content"), &content)) {
1446 _content_to_add = wx_to_std (content);
1450 if (parser.Found (wxT ("dcp"), &dcp)) {
1451 _dcp_to_add = wx_to_std (dcp);
1457 void report_exception ()
1461 } catch (FileError& e) {
1465 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1466 std_to_wx (e.what()),
1467 std_to_wx (e.file().string().c_str ())
1470 } catch (exception& e) {
1474 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1475 std_to_wx (e.what ())
1479 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1483 /* An unhandled exception has occurred inside the main event loop */
1484 bool OnExceptionInMainLoop ()
1486 report_exception ();
1487 /* This will terminate the program */
1491 void OnUnhandledException ()
1493 report_exception ();
1498 signal_manager->ui_idle ();
1504 EncodeServerFinder::instance()->rethrow ();
1505 } catch (exception& e) {
1506 error_dialog (0, std_to_wx (e.what ()));
1510 void config_failed_to_load ()
1512 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1515 void config_warning (string m)
1517 message_dialog (_frame, std_to_wx (m));
1520 bool config_bad_signer_chain ()
1522 if (Config::instance()->nagged(Config::NAG_BAD_SIGNER_CHAIN)) {
1526 RecreateChainDialog* d = new RecreateChainDialog (_frame);
1527 int const r = d->ShowModal ();
1529 return r == wxID_OK;
1533 shared_ptr<wxTimer> _timer;
1534 string _film_to_load;
1535 string _film_to_create;
1536 string _content_to_add;