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"
48 #include "wx/initial_setup_dialog.h"
50 #include "lib/config.h"
52 #include "lib/video_content.h"
53 #include "lib/content.h"
54 #include "lib/version.h"
55 #include "lib/signal_manager.h"
57 #include "lib/job_manager.h"
58 #include "lib/exceptions.h"
59 #include "lib/cinema.h"
60 #include "lib/screen_kdm.h"
61 #include "lib/send_kdm_email_job.h"
62 #include "lib/encode_server_finder.h"
63 #include "lib/update_checker.h"
64 #include "lib/cross.h"
65 #include "lib/content_factory.h"
66 #include "lib/compose.hpp"
67 #include "lib/cinema_kdms.h"
68 #include "lib/dcpomatic_socket.h"
69 #include "lib/hints.h"
70 #include "lib/dcp_content.h"
71 #include "lib/ffmpeg_encoder.h"
72 #include "lib/transcode_job.h"
73 #include "lib/dkdm_wrapper.h"
74 #include "lib/audio_content.h"
75 #include "lib/check_content_change_job.h"
76 #include "lib/text_content.h"
77 #include <dcp/exceptions.h>
78 #include <dcp/raw_convert.h>
79 #include <wx/generic/aboutdlgg.h>
80 #include <wx/stdpaths.h>
81 #include <wx/cmdline.h>
82 #include <wx/preferences.h>
83 #include <wx/splash.h>
88 #include <ApplicationServices/ApplicationServices.h>
90 #include <boost/filesystem.hpp>
91 #include <boost/noncopyable.hpp>
92 #include <boost/foreach.hpp>
95 /* This is OK as it's only used with DCPOMATIC_WINDOWS */
107 using std::wstringstream;
109 using std::make_pair;
111 using std::exception;
112 using boost::shared_ptr;
113 using boost::dynamic_pointer_cast;
114 using boost::optional;
115 using boost::function;
116 using dcp::raw_convert;
118 class FilmChangedClosingDialog : public boost::noncopyable
121 explicit FilmChangedClosingDialog (string name)
123 _dialog = new wxMessageDialog (
125 wxString::Format (_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
126 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
127 /// project (Film) has been changed since it was last saved.
129 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
132 _dialog->SetYesNoCancelLabels (
133 _("Save film and close"), _("Close without saving film"), _("Don't close")
137 ~FilmChangedClosingDialog ()
144 return _dialog->ShowModal ();
148 wxMessageDialog* _dialog;
151 class FilmChangedDuplicatingDialog : public boost::noncopyable
154 explicit FilmChangedDuplicatingDialog (string name)
156 _dialog = new wxMessageDialog (
158 wxString::Format (_("Save changes to film \"%s\" before duplicating?"), std_to_wx (name).data()),
159 /// TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
160 /// project (Film) has been changed since it was last saved.
162 wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
165 _dialog->SetYesNoCancelLabels (
166 _("Save film and duplicate"), _("Duplicate without saving film"), _("Don't duplicate")
170 ~FilmChangedDuplicatingDialog ()
177 return _dialog->ShowModal ();
181 wxMessageDialog* _dialog;
185 #define NEEDS_FILM 0x1
186 #define NOT_DURING_DCP_CREATION 0x2
187 #define NEEDS_CPL 0x4
188 #define NEEDS_SINGLE_SELECTED_CONTENT 0x8
189 #define NEEDS_SELECTED_CONTENT 0x10
190 #define NEEDS_SELECTED_VIDEO_CONTENT 0x20
191 #define NEEDS_CLIPBOARD 0x40
192 #define NEEDS_ENCRYPTION 0x80
194 map<wxMenuItem*, int> menu_items;
200 ID_file_save_as_template,
202 ID_file_duplicate_and_open,
204 /* Allow spare IDs after _history for the recent files list */
207 ID_content_scale_to_fit_width,
208 ID_content_scale_to_fit_height,
210 ID_jobs_make_dcp_batch,
212 ID_jobs_make_self_dkdm,
214 ID_jobs_send_dcp_to_tms,
216 ID_jobs_open_dcp_in_player,
217 ID_view_closed_captions,
218 ID_view_video_waveform,
220 ID_tools_encoding_servers,
221 ID_tools_manage_templates,
222 ID_tools_check_for_updates,
223 ID_tools_restore_default_preferences,
224 ID_help_report_a_problem,
225 /* IDs for shortcuts (with no associated menu item) */
234 class DOMFrame : public wxFrame
237 explicit DOMFrame (wxString const & title)
238 : wxFrame (NULL, -1, title)
239 , _video_waveform_dialog (0)
241 , _servers_list_dialog (0)
244 , _templates_dialog (0)
247 , _history_position (0)
248 , _history_separator (0)
249 , _update_news_requested (false)
251 #if defined(DCPOMATIC_WINDOWS)
252 if (Config::instance()->win32_console ()) {
255 HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
256 int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
257 FILE* hf_out = _fdopen(hCrt, "w");
258 setvbuf(hf_out, NULL, _IONBF, 1);
261 HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
262 hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
263 FILE* hf_in = _fdopen(hCrt, "r");
264 setvbuf(hf_in, NULL, _IONBF, 128);
267 cout << "DCP-o-matic is starting." << "\n";
271 wxMenuBar* bar = new wxMenuBar;
275 #ifdef DCPOMATIC_WINDOWS
276 SetIcon (wxIcon (std_to_wx ("id")));
279 _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&DOMFrame::config_changed, this, _1));
280 config_changed (Config::OTHER);
282 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_new, this), ID_file_new);
283 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_open, this), ID_file_open);
284 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save, this), ID_file_save);
285 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_save_as_template, this), ID_file_save_as_template);
286 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate, this), ID_file_duplicate);
287 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_duplicate_and_open, this), ID_file_duplicate_and_open);
288 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_history, this, _1), ID_file_history, ID_file_history + HISTORY_SIZE);
289 Bind (wxEVT_MENU, boost::bind (&DOMFrame::file_exit, this), wxID_EXIT);
290 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_copy, this), ID_edit_copy);
291 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_paste, this), ID_edit_paste);
292 Bind (wxEVT_MENU, boost::bind (&DOMFrame::edit_preferences, this), wxID_PREFERENCES);
293 Bind (wxEVT_MENU, boost::bind (&DOMFrame::content_scale_to_fit_width, this), ID_content_scale_to_fit_width);
294 Bind (wxEVT_MENU, boost::bind (&DOMFrame::content_scale_to_fit_height, this), ID_content_scale_to_fit_height);
295 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp, this), ID_jobs_make_dcp);
296 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_kdms, this), ID_jobs_make_kdms);
297 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_dcp_batch, this), ID_jobs_make_dcp_batch);
298 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_make_self_dkdm, this), ID_jobs_make_self_dkdm);
299 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_export, this), ID_jobs_export);
300 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_send_dcp_to_tms, this), ID_jobs_send_dcp_to_tms);
301 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_show_dcp, this), ID_jobs_show_dcp);
302 Bind (wxEVT_MENU, boost::bind (&DOMFrame::jobs_open_dcp_in_player, this), ID_jobs_open_dcp_in_player);
303 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_closed_captions, this), ID_view_closed_captions);
304 Bind (wxEVT_MENU, boost::bind (&DOMFrame::view_video_waveform, this), ID_view_video_waveform);
305 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_hints, this), ID_tools_hints);
306 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_encoding_servers, this), ID_tools_encoding_servers);
307 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_manage_templates, this), ID_tools_manage_templates);
308 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_check_for_updates, this), ID_tools_check_for_updates);
309 Bind (wxEVT_MENU, boost::bind (&DOMFrame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
310 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_about, this), wxID_ABOUT);
311 Bind (wxEVT_MENU, boost::bind (&DOMFrame::help_report_a_problem, this), ID_help_report_a_problem);
313 Bind (wxEVT_CLOSE_WINDOW, boost::bind (&DOMFrame::close, this, _1));
315 /* Use a panel as the only child of the Frame so that we avoid
316 the dark-grey background on Windows.
318 wxPanel* overall_panel = new wxPanel (this, wxID_ANY);
320 _film_viewer = new FilmViewer (overall_panel);
321 _film_editor = new FilmEditor (overall_panel, _film_viewer);
322 JobManagerView* job_manager_view = new JobManagerView (overall_panel, false);
324 wxBoxSizer* right_sizer = new wxBoxSizer (wxVERTICAL);
325 right_sizer->Add (_film_viewer, 2, wxEXPAND | wxALL, 6);
326 right_sizer->Add (job_manager_view, 1, wxEXPAND | wxALL, 6);
328 wxBoxSizer* main_sizer = new wxBoxSizer (wxHORIZONTAL);
329 main_sizer->Add (_film_editor, 1, wxEXPAND | wxALL, 6);
330 main_sizer->Add (right_sizer, 2, wxEXPAND | wxALL, 6);
332 set_menu_sensitivity ();
334 _film_editor->FileChanged.connect (bind (&DOMFrame::file_changed, this, _1));
335 _film_editor->content_panel()->SelectionChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
338 JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&DOMFrame::set_menu_sensitivity, this));
340 overall_panel->SetSizer (main_sizer);
342 UpdateChecker::instance()->StateChanged.connect (boost::bind (&DOMFrame::update_checker_state_changed, this));
344 FocusManager::instance()->SetFocus.connect (boost::bind (&DOMFrame::remove_accelerators, this));
345 FocusManager::instance()->KillFocus.connect (boost::bind (&DOMFrame::add_accelerators, this));
349 void add_accelerators ()
352 int accelerators = 7;
354 int accelerators = 6;
356 wxAcceleratorEntry* accel = new wxAcceleratorEntry[accelerators];
357 accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
358 accel[1].Set (wxACCEL_NORMAL, WXK_DELETE, ID_remove);
359 accel[2].Set (wxACCEL_NORMAL, WXK_SPACE, ID_start_stop);
360 accel[3].Set (wxACCEL_CTRL, static_cast<int>('T'), ID_timeline);
361 accel[4].Set (wxACCEL_NORMAL, WXK_LEFT, ID_back_frame);
362 accel[5].Set (wxACCEL_NORMAL, WXK_RIGHT, ID_forward_frame);
364 accel[6].Set (wxACCEL_CTRL, static_cast<int>('W'), wxID_EXIT);
366 Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
367 Bind (wxEVT_MENU, boost::bind (&DOMFrame::remove_clicked, this, _1), ID_remove);
368 Bind (wxEVT_MENU, boost::bind (&DOMFrame::start_stop_pressed, this), ID_start_stop);
369 Bind (wxEVT_MENU, boost::bind (&DOMFrame::timeline_pressed, this), ID_timeline);
370 Bind (wxEVT_MENU, boost::bind (&DOMFrame::back_frame, this), ID_back_frame);
371 Bind (wxEVT_MENU, boost::bind (&DOMFrame::forward_frame, this), ID_forward_frame);
372 wxAcceleratorTable accel_table (accelerators, accel);
373 SetAcceleratorTable (accel_table);
377 void remove_accelerators ()
379 SetAcceleratorTable (wxAcceleratorTable ());
382 void remove_clicked (wxCommandEvent& ev)
384 if (_film_editor->content_panel()->remove_clicked (true)) {
389 void new_film (boost::filesystem::path path, optional<string> template_name)
391 shared_ptr<Film> film (new Film (path));
393 film->use_template (template_name.get());
395 film->set_name (path.filename().generic_string());
396 film->write_metadata ();
400 void load_film (boost::filesystem::path file)
403 shared_ptr<Film> film (new Film (file));
404 list<string> const notes = film->read_metadata ();
406 if (film->state_version() == 4) {
409 _("This film was created with an old version of DVD-o-matic and may not load correctly "
410 "in this version. Please check the film's settings carefully.")
414 for (list<string>::const_iterator i = notes.begin(); i != notes.end(); ++i) {
415 error_dialog (0, std_to_wx (*i));
420 JobManager::instance()->add(shared_ptr<Job>(new CheckContentChangeJob(film)));
422 catch (std::exception& e) {
423 wxString p = std_to_wx (file.string ());
424 wxCharBuffer b = p.ToUTF8 ();
425 error_dialog (this, wxString::Format (_("Could not open film at %s"), p.data()), std_to_wx (e.what()));
428 void set_film (shared_ptr<Film> film)
431 _film_viewer->set_film (_film);
432 _film_editor->set_film (_film);
433 if (_video_waveform_dialog) {
434 _video_waveform_dialog->Destroy ();
435 _video_waveform_dialog = 0;
437 set_menu_sensitivity ();
438 if (_film->directory()) {
439 Config::instance()->add_to_history (_film->directory().get());
441 _film->Change.connect (boost::bind (&DOMFrame::film_change, this, _1));
444 shared_ptr<Film> film () const {
450 void film_change (ChangeType type)
452 if (type == CHANGE_TYPE_DONE) {
453 set_menu_sensitivity ();
457 void file_changed (boost::filesystem::path f)
459 string s = wx_to_std (_("DCP-o-matic"));
461 s += " - " + f.string ();
464 SetTitle (std_to_wx (s));
469 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("New Film"), true);
470 int const r = d->ShowModal ();
472 if (r == wxID_OK && d->check_path() && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
474 new_film (d->path(), d->template_name());
475 } catch (boost::filesystem::filesystem_error& e) {
476 error_dialog (this, _("Could not create folder to store film"), std_to_wx(e.what()));
485 wxDirDialog* c = new wxDirDialog (
487 _("Select film to open"),
488 std_to_wx (Config::instance()->default_directory_or (wx_to_std (wxStandardPaths::Get().GetDocumentsDir())).string ()),
489 wxDEFAULT_DIALOG_STYLE | wxDD_DIR_MUST_EXIST
495 if (r == wxID_OK && c->GetPath() == wxStandardPaths::Get().GetDocumentsDir()) {
496 error_dialog (this, _("You did not select a folder. Make sure that you select a folder before clicking Open."));
502 if (r == wxID_OK && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
503 load_film (wx_to_std (c->GetPath ()));
511 _film->write_metadata ();
514 void file_save_as_template ()
516 SaveTemplateDialog* d = new SaveTemplateDialog (this);
517 int const r = d->ShowModal ();
519 Config::instance()->save_template (_film, d->name ());
524 void file_duplicate ()
526 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
527 int const r = d->ShowModal ();
529 if (r == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
530 shared_ptr<Film> film (new Film (d->path()));
531 film->copy_from (_film);
532 film->set_name (d->path().filename().generic_string());
533 film->write_metadata ();
539 void file_duplicate_and_open ()
541 FilmNameLocationDialog* d = new FilmNameLocationDialog (this, _("Duplicate Film"), false);
542 int const r = d->ShowModal ();
544 if (r == wxID_OK && d->check_path() && maybe_save_film<FilmChangedDuplicatingDialog>()) {
545 shared_ptr<Film> film (new Film (d->path()));
546 film->copy_from (_film);
547 film->set_name (d->path().filename().generic_string());
548 film->write_metadata ();
555 void file_history (wxCommandEvent& event)
557 vector<boost::filesystem::path> history = Config::instance()->history ();
558 int n = event.GetId() - ID_file_history;
559 if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film<FilmChangedClosingDialog>()) {
560 load_film (history[n]);
566 /* false here allows the close handler to veto the close request */
572 ContentList const sel = _film_editor->content_panel()->selected();
573 DCPOMATIC_ASSERT (sel.size() == 1);
574 _clipboard = sel.front()->clone();
579 DCPOMATIC_ASSERT (_clipboard);
581 PasteDialog* d = new PasteDialog (this, static_cast<bool>(_clipboard->video), static_cast<bool>(_clipboard->audio), !_clipboard->text.empty());
582 if (d->ShowModal() == wxID_OK) {
583 BOOST_FOREACH (shared_ptr<Content> i, _film_editor->content_panel()->selected()) {
584 if (d->video() && i->video) {
585 DCPOMATIC_ASSERT (_clipboard->video);
586 i->video->take_settings_from (_clipboard->video);
588 if (d->audio() && i->audio) {
589 DCPOMATIC_ASSERT (_clipboard->audio);
590 i->audio->take_settings_from (_clipboard->audio);
594 list<shared_ptr<TextContent> >::iterator j = i->text.begin ();
595 list<shared_ptr<TextContent> >::const_iterator k = _clipboard->text.begin ();
596 while (j != i->text.end() && k != _clipboard->text.end()) {
597 (*j)->take_settings_from (*k);
607 void edit_preferences ()
609 if (!_config_dialog) {
610 _config_dialog = create_full_config_dialog ();
612 _config_dialog->Show (this);
615 void tools_restore_default_preferences ()
617 wxMessageDialog* d = new wxMessageDialog (
619 _("Are you sure you want to restore preferences to their defaults? This cannot be undone."),
620 _("Restore default preferences"),
621 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
624 int const r = d->ShowModal ();
628 Config::restore_defaults ();
632 void jobs_make_dcp ()
638 if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
641 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);
643 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);
645 if (!confirm_dialog (this, message)) {
650 if (Config::instance()->show_hints_before_make_dcp()) {
651 HintsDialog* hints = new HintsDialog (this, _film, false);
652 int const r = hints->ShowModal();
654 if (r == wxID_CANCEL) {
659 if (_film->encrypted ()) {
660 NagDialog::maybe_nag (
662 Config::NAG_ENCRYPTED_METADATA,
663 _("You are making an encrypted DCP. It will not be possible to make KDMs for this DCP unless you have copies of "
664 "the <tt>metadata.xml</tt> file within the film and the metadata files within the DCP.\n\n"
665 "You should ensure that these files are <span weight=\"bold\" size=\"larger\">BACKED UP</span> "
666 "if you want to make KDMs for this film.")
670 /* Remove any existing DCP if the user agrees */
671 boost::filesystem::path const dcp_dir = _film->dir (_film->dcp_name(), false);
672 if (boost::filesystem::exists (dcp_dir)) {
673 if (!confirm_dialog (this, wxString::Format (_("Do you want to overwrite the existing DCP %s?"), std_to_wx(dcp_dir.string()).data()))) {
676 boost::filesystem::remove_all (dcp_dir);
680 /* It seems to make sense to auto-save metadata here, since the make DCP may last
681 a long time, and crashes/power failures are moderately likely.
683 _film->write_metadata ();
685 } catch (BadSettingError& e) {
686 error_dialog (this, wxString::Format (_("Bad setting for %s."), std_to_wx(e.setting()).data()), std_to_wx(e.what()));
687 } catch (std::exception& e) {
688 error_dialog (this, wxString::Format (_("Could not make DCP.")), std_to_wx(e.what()));
692 void jobs_make_kdms ()
699 _kdm_dialog->Destroy ();
703 _kdm_dialog = new KDMDialog (this, _film);
704 _kdm_dialog->Show ();
707 /** @return false if we succeeded, true if not */
708 bool send_to_other_tool (int port, function<void(boost::filesystem::path)> start, string message)
710 /* i = 0; try to connect via socket
711 i = 1; try again, and then try to start the tool
712 i = 2 onwards; try again.
714 for (int i = 0; i < 8; ++i) {
716 boost::asio::io_service io_service;
717 boost::asio::ip::tcp::resolver resolver (io_service);
718 boost::asio::ip::tcp::resolver::query query ("127.0.0.1", raw_convert<string> (port));
719 boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
721 socket.connect (*endpoint_iterator);
722 DCPOMATIC_ASSERT (_film->directory ());
723 socket.write (message.length() + 1);
724 socket.write ((uint8_t *) message.c_str(), message.length() + 1);
729 } catch (exception& e) {
734 start (wx_to_std (wxStandardPaths::Get().GetExecutablePath()));
743 void jobs_make_dcp_batch ()
749 if (Config::instance()->show_hints_before_make_dcp()) {
750 HintsDialog* hints = new HintsDialog (this, _film, false);
751 int const r = hints->ShowModal();
753 if (r == wxID_CANCEL) {
758 _film->write_metadata ();
760 if (send_to_other_tool (BATCH_JOB_PORT, bind (&start_batch_converter, _1), _film->directory()->string())) {
761 error_dialog (this, _("Could not find batch converter."));
765 void jobs_open_dcp_in_player ()
771 if (send_to_other_tool (PLAYER_PLAY_PORT, bind (&start_player, _1), _film->dir(_film->dcp_name(false)).string())) {
772 error_dialog (this, _("Could not find player."));
776 void jobs_make_self_dkdm ()
782 SelfDKDMDialog* d = new SelfDKDMDialog (this, _film);
783 if (d->ShowModal () != wxID_OK) {
788 NagDialog::maybe_nag (
790 Config::NAG_DKDM_CONFIG,
792 _("You are making a DKDM which is encrypted by a private key held in"
793 "\n\n<tt>%s</tt>\n\nIt is <span weight=\"bold\" size=\"larger\">VITALLY IMPORTANT</span> "
794 "that you <span weight=\"bold\" size=\"larger\">BACK UP THIS FILE</span> since if it is lost "
795 "your DKDMs (and the DCPs they protect) will become useless."), std_to_wx(Config::config_file().string()).data()
799 optional<dcp::EncryptedKDM> kdm;
801 kdm = _film->make_kdm (
802 Config::instance()->decryption_chain()->leaf(),
803 vector<dcp::Certificate> (),
805 dcp::LocalTime ("2012-01-01T01:00:00+00:00"),
806 dcp::LocalTime ("2112-01-01T01:00:00+00:00"),
807 dcp::MODIFIED_TRANSITIONAL_1,
811 } catch (dcp::NotEncryptedError& e) {
812 error_dialog (this, _("CPL's content is not encrypted."));
813 } catch (exception& e) {
814 error_dialog (this, e.what ());
816 error_dialog (this, _("An unknown exception occurred."));
820 if (d->internal ()) {
821 shared_ptr<DKDMGroup> dkdms = Config::instance()->dkdms ();
822 dkdms->add (shared_ptr<DKDM> (new DKDM (kdm.get())));
823 Config::instance()->changed ();
825 boost::filesystem::path path = d->directory() / (_film->dcp_name(false) + "_DKDM.xml");
835 ExportDialog* d = new ExportDialog (this);
836 if (d->ShowModal() == wxID_OK) {
837 shared_ptr<TranscodeJob> job (new TranscodeJob (_film));
839 shared_ptr<FFmpegEncoder> (
840 new FFmpegEncoder (_film, job, d->path(), d->format(), d->mixdown_to_stereo(), d->split_reels(), d->x264_crf())
843 JobManager::instance()->add (job);
848 void content_scale_to_fit_width ()
850 ContentList vc = _film_editor->content_panel()->selected_video ();
851 for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
852 (*i)->video->scale_and_crop_to_fit_width ();
856 void content_scale_to_fit_height ()
858 ContentList vc = _film_editor->content_panel()->selected_video ();
859 for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
860 (*i)->video->scale_and_crop_to_fit_height ();
864 void jobs_send_dcp_to_tms ()
866 _film->send_dcp_to_tms ();
869 void jobs_show_dcp ()
871 DCPOMATIC_ASSERT (_film->directory ());
872 #ifdef DCPOMATIC_WINDOWS
874 args << "/select," << _film->dir (_film->dcp_name(false));
875 ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
878 #ifdef DCPOMATIC_LINUX
879 int r = system ("which nautilus");
880 if (WEXITSTATUS (r) == 0) {
881 r = system (String::compose("nautilus \"%1\"", _film->directory()->string()).c_str());
882 if (WEXITSTATUS (r)) {
883 error_dialog (this, _("Could not show DCP."), _("Could not run nautilus"));
886 int r = system ("which konqueror");
887 if (WEXITSTATUS (r) == 0) {
888 r = system (String::compose ("konqueror \"%1\"", _film->directory()->string()).c_str());
889 if (WEXITSTATUS (r)) {
890 error_dialog (this, _("Could not show DCP"), _("Could not run konqueror"));
897 int r = system (String::compose ("open -R \"%1\"", _film->dir (_film->dcp_name(false)).string()).c_str());
898 if (WEXITSTATUS (r)) {
899 error_dialog (this, _("Could not show DCP"));
904 void view_closed_captions ()
906 _film_viewer->show_closed_captions ();
909 void view_video_waveform ()
911 if (!_video_waveform_dialog) {
912 _video_waveform_dialog = new VideoWaveformDialog (this, _film, _film_viewer);
915 _video_waveform_dialog->Show ();
920 if (!_hints_dialog) {
921 _hints_dialog = new HintsDialog (this, _film, true);
924 _hints_dialog->Show ();
927 void tools_encoding_servers ()
929 if (!_servers_list_dialog) {
930 _servers_list_dialog = new ServersListDialog (this);
933 _servers_list_dialog->Show ();
936 void tools_manage_templates ()
938 if (!_templates_dialog) {
939 _templates_dialog = new TemplatesDialog (this);
942 _templates_dialog->Show ();
945 void tools_check_for_updates ()
947 UpdateChecker::instance()->run ();
948 _update_news_requested = true;
953 AboutDialog* d = new AboutDialog (this);
958 void help_report_a_problem ()
960 ReportProblemDialog* d = new ReportProblemDialog (this, _film);
961 if (d->ShowModal () == wxID_OK) {
969 if (!JobManager::instance()->work_to_do ()) {
973 wxMessageDialog* d = new wxMessageDialog (
975 _("There are unfinished jobs; are you sure you want to quit?"),
976 _("Unfinished jobs"),
977 wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
980 bool const r = d->ShowModal() == wxID_YES;
985 void close (wxCloseEvent& ev)
987 if (!should_close ()) {
992 if (_film && _film->dirty ()) {
994 FilmChangedClosingDialog* dialog = new FilmChangedClosingDialog (_film->name ());
995 int const r = dialog->run ();
1000 /* Don't save and carry on to close */
1003 /* Save and carry on to close */
1004 _film->write_metadata ();
1007 /* Veto the event and stop */
1013 /* We don't want to hear about any more configuration changes, since they
1014 cause the File menu to be altered, which itself will be deleted around
1015 now (without, as far as I can see, any way for us to find out).
1017 _config_changed_connection.disconnect ();
1022 void set_menu_sensitivity ()
1024 list<shared_ptr<Job> > jobs = JobManager::instance()->get ();
1025 list<shared_ptr<Job> >::iterator i = jobs.begin();
1026 while (i != jobs.end() && (*i)->json_name() != "transcode") {
1029 bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
1030 bool const have_cpl = _film && !_film->cpls().empty ();
1031 bool const have_single_selected_content = _film_editor->content_panel()->selected().size() == 1;
1032 bool const have_selected_content = !_film_editor->content_panel()->selected().empty();
1033 bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
1035 for (map<wxMenuItem*, int>::iterator j = menu_items.begin(); j != menu_items.end(); ++j) {
1037 bool enabled = true;
1039 if ((j->second & NEEDS_FILM) && !_film) {
1043 if ((j->second & NOT_DURING_DCP_CREATION) && dcp_creation) {
1047 if ((j->second & NEEDS_CPL) && !have_cpl) {
1051 if ((j->second & NEEDS_SELECTED_CONTENT) && !have_selected_content) {
1055 if ((j->second & NEEDS_SINGLE_SELECTED_CONTENT) && !have_single_selected_content) {
1059 if ((j->second & NEEDS_SELECTED_VIDEO_CONTENT) && !have_selected_video_content) {
1063 if ((j->second & NEEDS_CLIPBOARD) && !_clipboard) {
1067 if ((j->second & NEEDS_ENCRYPTION) && (!_film || !_film->encrypted())) {
1071 j->first->Enable (enabled);
1075 /** @return true if the operation that called this method
1076 * should continue, false to abort it.
1079 bool maybe_save_film ()
1085 if (_film->dirty ()) {
1086 T d (_film->name ());
1091 _film->write_metadata ();
1102 bool maybe_save_then_delete_film ()
1104 bool const r = maybe_save_film<T> ();
1111 void add_item (wxMenu* menu, wxString text, int id, int sens)
1113 wxMenuItem* item = menu->Append (id, text);
1114 menu_items.insert (make_pair (item, sens));
1117 void setup_menu (wxMenuBar* m)
1119 _file_menu = new wxMenu;
1120 add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
1121 add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
1122 _file_menu->AppendSeparator ();
1123 add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
1124 _file_menu->AppendSeparator ();
1125 add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
1126 add_item (_file_menu, _("Duplicate..."), ID_file_duplicate, NEEDS_FILM);
1127 add_item (_file_menu, _("Duplicate and open..."), ID_file_duplicate_and_open, NEEDS_FILM);
1129 _history_position = _file_menu->GetMenuItems().GetCount();
1132 _file_menu->AppendSeparator ();
1136 add_item (_file_menu, _("&Exit"), wxID_EXIT, ALWAYS);
1138 add_item (_file_menu, _("&Quit"), wxID_EXIT, ALWAYS);
1141 wxMenu* edit = new wxMenu;
1142 add_item (edit, _("Copy settings\tCtrl-C"), ID_edit_copy, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SINGLE_SELECTED_CONTENT);
1143 add_item (edit, _("Paste settings...\tCtrl-V"), ID_edit_paste, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_SELECTED_CONTENT | NEEDS_CLIPBOARD);
1146 add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1148 add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
1151 wxMenu* content = new wxMenu;
1152 add_item (content, _("Scale to fit &width"), ID_content_scale_to_fit_width, NEEDS_FILM | NEEDS_SELECTED_VIDEO_CONTENT);
1153 add_item (content, _("Scale to fit &height"), ID_content_scale_to_fit_height, NEEDS_FILM | NEEDS_SELECTED_VIDEO_CONTENT);
1155 wxMenu* jobs_menu = new wxMenu;
1156 add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1157 add_item (jobs_menu, _("Make DCP in &batch converter\tCtrl-B"), ID_jobs_make_dcp_batch, NEEDS_FILM | NOT_DURING_DCP_CREATION);
1158 jobs_menu->AppendSeparator ();
1159 add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
1160 add_item (jobs_menu, _("Make DKDM for DCP-o-matic..."), ID_jobs_make_self_dkdm, NEEDS_FILM | NEEDS_ENCRYPTION);
1161 jobs_menu->AppendSeparator ();
1162 add_item (jobs_menu, _("Export...\tCtrl-E"), ID_jobs_export, NEEDS_FILM);
1163 jobs_menu->AppendSeparator ();
1164 add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1165 add_item (jobs_menu, _("S&how DCP"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1166 add_item (jobs_menu, _("Open DCP in &player"), ID_jobs_open_dcp_in_player, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
1168 wxMenu* view = new wxMenu;
1169 add_item (view, _("Closed captions..."), ID_view_closed_captions, NEEDS_FILM);
1170 add_item (view, _("Video waveform..."), ID_view_video_waveform, NEEDS_FILM);
1172 wxMenu* tools = new wxMenu;
1173 add_item (tools, _("Hints..."), ID_tools_hints, 0);
1174 add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
1175 add_item (tools, _("Manage templates..."), ID_tools_manage_templates, 0);
1176 add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
1177 tools->AppendSeparator ();
1178 add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
1180 wxMenu* help = new wxMenu;
1182 add_item (help, _("About DCP-o-matic"), wxID_ABOUT, ALWAYS);
1184 add_item (help, _("About"), wxID_ABOUT, ALWAYS);
1186 add_item (help, _("Report a problem..."), ID_help_report_a_problem, NEEDS_FILM);
1188 m->Append (_file_menu, _("&File"));
1189 m->Append (edit, _("&Edit"));
1190 m->Append (content, _("&Content"));
1191 m->Append (jobs_menu, _("&Jobs"));
1192 m->Append (view, _("&View"));
1193 m->Append (tools, _("&Tools"));
1194 m->Append (help, _("&Help"));
1197 void config_changed (Config::Property what)
1199 /* Instantly save any config changes when using the DCP-o-matic GUI */
1200 if (what == Config::CINEMAS) {
1202 Config::instance()->write_cinemas();
1203 } catch (exception& e) {
1207 _("Could not write to cinemas file at %s. Your changes have not been saved."),
1208 std_to_wx (Config::instance()->cinemas_file().string()).data()
1214 Config::instance()->write_config();
1215 } catch (exception& e) {
1219 _("Could not write to config file at %s. Your changes have not been saved."),
1220 std_to_wx (Config::instance()->cinemas_file().string()).data()
1226 for (int i = 0; i < _history_items; ++i) {
1227 delete _file_menu->Remove (ID_file_history + i);
1230 if (_history_separator) {
1231 _file_menu->Remove (_history_separator);
1233 delete _history_separator;
1234 _history_separator = 0;
1236 int pos = _history_position;
1238 vector<boost::filesystem::path> history = Config::instance()->history ();
1240 if (!history.empty ()) {
1241 _history_separator = _file_menu->InsertSeparator (pos++);
1244 for (size_t i = 0; i < history.size(); ++i) {
1247 s = String::compose ("&%1 %2", i + 1, history[i].string());
1249 s = history[i].string();
1251 _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
1254 _history_items = history.size ();
1257 void update_checker_state_changed ()
1259 UpdateChecker* uc = UpdateChecker::instance ();
1261 bool const announce =
1262 _update_news_requested ||
1263 (uc->stable() && Config::instance()->check_for_updates()) ||
1264 (uc->test() && Config::instance()->check_for_updates() && Config::instance()->check_for_test_updates());
1266 _update_news_requested = false;
1272 if (uc->state() == UpdateChecker::YES) {
1273 UpdateDialog* dialog = new UpdateDialog (this, uc->stable (), uc->test ());
1274 dialog->ShowModal ();
1276 } else if (uc->state() == UpdateChecker::FAILED) {
1277 error_dialog (this, _("The DCP-o-matic download server could not be contacted."));
1279 error_dialog (this, _("There are no new versions of DCP-o-matic available."));
1282 _update_news_requested = false;
1285 void start_stop_pressed ()
1287 if (_film_viewer->playing()) {
1288 _film_viewer->stop();
1290 _film_viewer->start();
1294 void timeline_pressed ()
1296 _film_editor->content_panel()->timeline_clicked ();
1301 _film_viewer->back_frame ();
1304 void forward_frame ()
1306 _film_viewer->forward_frame ();
1309 FilmEditor* _film_editor;
1310 FilmViewer* _film_viewer;
1311 VideoWaveformDialog* _video_waveform_dialog;
1312 HintsDialog* _hints_dialog;
1313 ServersListDialog* _servers_list_dialog;
1314 wxPreferencesEditor* _config_dialog;
1315 KDMDialog* _kdm_dialog;
1316 TemplatesDialog* _templates_dialog;
1318 shared_ptr<Film> _film;
1320 int _history_position;
1321 wxMenuItem* _history_separator;
1322 boost::signals2::scoped_connection _config_changed_connection;
1323 bool _update_news_requested;
1324 shared_ptr<Content> _clipboard;
1327 static const wxCmdLineEntryDesc command_line_description[] = {
1328 { wxCMD_LINE_SWITCH, "n", "new", "create new film", wxCMD_LINE_VAL_NONE, wxCMD_LINE_PARAM_OPTIONAL },
1329 { wxCMD_LINE_OPTION, "c", "content", "add content file / directory", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1330 { wxCMD_LINE_OPTION, "d", "dcp", "add content DCP", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1331 { wxCMD_LINE_PARAM, 0, 0, "film to load or create", wxCMD_LINE_VAL_STRING, wxCMD_LINE_PARAM_OPTIONAL },
1332 { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
1336 * @brief The magic App class for wxWidgets.
1338 class App : public wxApp
1351 wxInitAllImageHandlers ();
1353 Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
1354 Config::Warning.connect (boost::bind (&App::config_warning, this, _1));
1356 wxSplashScreen* splash = maybe_show_splash ();
1358 SetAppName (_("DCP-o-matic"));
1360 if (!wxApp::OnInit()) {
1364 #ifdef DCPOMATIC_LINUX
1365 unsetenv ("UBUNTU_MENUPROXY");
1369 ProcessSerialNumber serial;
1370 GetCurrentProcess (&serial);
1371 TransformProcessType (&serial, kProcessTransformToForegroundApplication);
1374 dcpomatic_setup_path_encoding ();
1376 /* Enable i18n; this will create a Config object
1377 to look for a force-configured language. This Config
1378 object will be wrong, however, because dcpomatic_setup
1379 hasn't yet been called and there aren't any filters etc.
1382 dcpomatic_setup_i18n ();
1384 /* Set things up, including filters etc.
1385 which will now be internationalised correctly.
1389 /* Force the configuration to be re-loaded correctly next
1394 Config::BadSignerChain.connect (boost::bind (&App::config_bad_signer_chain, this));
1396 _frame = new DOMFrame (_("DCP-o-matic"));
1397 SetTopWindow (_frame);
1398 _frame->Maximize ();
1403 if (!Config::instance()->nagged(Config::NAG_INITIAL_SETUP)) {
1404 InitialSetupDialog* d = new InitialSetupDialog ();
1407 Config::instance()->set_nagged(Config::NAG_INITIAL_SETUP, true);
1412 if (!_film_to_load.empty() && boost::filesystem::is_directory (_film_to_load)) {
1414 _frame->load_film (_film_to_load);
1415 } catch (exception& e) {
1416 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()));
1420 if (!_film_to_create.empty ()) {
1421 _frame->new_film (_film_to_create, optional<string> ());
1422 if (!_content_to_add.empty ()) {
1423 BOOST_FOREACH (shared_ptr<Content> i, content_factory (_frame->film(), _content_to_add)) {
1424 _frame->film()->examine_and_add_content (i);
1427 if (!_dcp_to_add.empty ()) {
1428 _frame->film()->examine_and_add_content (shared_ptr<DCPContent> (new DCPContent (_frame->film(), _dcp_to_add)));
1432 signal_manager = new wxSignalManager (this);
1433 Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
1435 Bind (wxEVT_TIMER, boost::bind (&App::check, this));
1436 _timer.reset (new wxTimer (this));
1437 _timer->Start (1000);
1439 if (Config::instance()->check_for_updates ()) {
1440 UpdateChecker::instance()->run ();
1445 catch (exception& e)
1447 error_dialog (0, wxString::Format ("DCP-o-matic could not start."), std_to_wx(e.what()));
1451 void OnInitCmdLine (wxCmdLineParser& parser)
1453 parser.SetDesc (command_line_description);
1454 parser.SetSwitchChars (wxT ("-"));
1457 bool OnCmdLineParsed (wxCmdLineParser& parser)
1459 if (parser.GetParamCount() > 0) {
1460 if (parser.Found (wxT ("new"))) {
1461 _film_to_create = wx_to_std (parser.GetParam (0));
1463 _film_to_load = wx_to_std (parser.GetParam (0));
1468 if (parser.Found (wxT ("content"), &content)) {
1469 _content_to_add = wx_to_std (content);
1473 if (parser.Found (wxT ("dcp"), &dcp)) {
1474 _dcp_to_add = wx_to_std (dcp);
1480 void report_exception ()
1484 } catch (FileError& e) {
1488 _("An exception occurred: %s (%s)\n\n") + REPORT_PROBLEM,
1489 std_to_wx (e.what()),
1490 std_to_wx (e.file().string().c_str ())
1493 } catch (exception& e) {
1497 _("An exception occurred: %s.\n\n") + REPORT_PROBLEM,
1498 std_to_wx (e.what ())
1502 error_dialog (0, _("An unknown exception occurred.") + " " + REPORT_PROBLEM);
1506 /* An unhandled exception has occurred inside the main event loop */
1507 bool OnExceptionInMainLoop ()
1509 report_exception ();
1510 /* This will terminate the program */
1514 void OnUnhandledException ()
1516 report_exception ();
1521 signal_manager->ui_idle ();
1527 EncodeServerFinder::instance()->rethrow ();
1528 } catch (exception& e) {
1529 error_dialog (0, std_to_wx (e.what ()));
1533 void config_failed_to_load ()
1535 message_dialog (_frame, _("The existing configuration failed to load. Default values will be used instead. These may take a short time to create."));
1538 void config_warning (string m)
1540 message_dialog (_frame, std_to_wx (m));
1543 bool config_bad_signer_chain ()
1545 if (Config::instance()->nagged(Config::NAG_BAD_SIGNER_CHAIN)) {
1549 RecreateChainDialog* d = new RecreateChainDialog (_frame);
1550 int const r = d->ShowModal ();
1552 return r == wxID_OK;
1556 shared_ptr<wxTimer> _timer;
1557 string _film_to_load;
1558 string _film_to_create;
1559 string _content_to_add;