Comment.
[dcpomatic.git] / src / tools / dcpomatic.cc
index 6b7ad027303392c638fffc043916150ef2b266d8..c7532869e923ba99e948e39a5d0802f346e0ff4b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#include <iostream>
-#include <fstream>
-#include <boost/filesystem.hpp>
-#ifdef __WXMSW__
-#include <shellapi.h>
-#endif
-#ifdef __WXOSX__
-#include <ApplicationServices/ApplicationServices.h>
-#endif
-#include <wx/generic/aboutdlgg.h>
-#include <wx/stdpaths.h>
-#include <wx/cmdline.h>
-#include <wx/preferences.h>
-#include <libdcp/exceptions.h>
-#include "wx/film_viewer.h"
-#include "wx/film_editor.h"
-#include "wx/job_manager_view.h"
-#include "wx/config_dialog.h"
-#include "wx/job_wrapper.h"
-#include "wx/wx_util.h"
-#include "wx/new_film_dialog.h"
-#include "wx/properties_dialog.h"
-#include "wx/wx_ui_signaller.h"
-#include "wx/about_dialog.h"
-#include "wx/kdm_dialog.h"
-#include "wx/servers_list_dialog.h"
-#include "wx/hints_dialog.h"
-#include "wx/update_dialog.h"
+/** @file  src/tools/dcpomatic.cc
+ *  @brief The main DCP-o-matic GUI.
+ */
+
 #include "lib/film.h"
 #include "lib/config.h"
 #include "lib/util.h"
 #include "lib/version.h"
-#include "lib/ui_signaller.h"
+#include "lib/signal_manager.h"
 #include "lib/log.h"
 #include "lib/job_manager.h"
 #include "lib/transcode_job.h"
 #include "lib/server_finder.h"
 #include "lib/update.h"
 #include "lib/content_factory.h"
+#include "wx/film_viewer.h"
+#include "wx/film_editor.h"
+#include "wx/job_manager_view.h"
+#include "wx/config_dialog.h"
+#include "wx/wx_util.h"
+#include "wx/new_film_dialog.h"
+#include "wx/properties_dialog.h"
+#include "wx/wx_signal_manager.h"
+#include "wx/about_dialog.h"
+#include "wx/kdm_dialog.h"
+#include "wx/servers_list_dialog.h"
+#include "wx/hints_dialog.h"
+#include "wx/update_dialog.h"
+#include "wx/content_panel.h"
+#include "wx/report_problem_dialog.h"
+#include <dcp/exceptions.h>
+#include <wx/generic/aboutdlgg.h>
+#include <wx/stdpaths.h>
+#include <wx/cmdline.h>
+#include <wx/preferences.h>
+#ifdef __WXMSW__
+#include <shellapi.h>
+#endif
+#ifdef __WXOSX__
+#include <ApplicationServices/ApplicationServices.h>
+#endif
+#include <boost/filesystem.hpp>
+#include <iostream>
+#include <fstream>
+#include <sstream>
+
+#ifdef check
+#undef check
+#endif
 
 using std::cout;
+using std::wcout;
 using std::string;
 using std::vector;
 using std::wstring;
+using std::wstringstream;
 using std::map;
 using std::make_pair;
 using std::list;
@@ -72,8 +84,6 @@ using std::exception;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
 
-// #define DCPOMATIC_WINDOWS_CONSOLE 1
-
 class FilmChangedDialog
 {
 public:
@@ -82,6 +92,9 @@ public:
                _dialog = new wxMessageDialog (
                        0,
                        wxString::Format (_("Save changes to film \"%s\" before closing?"), std_to_wx (name).data()),
+                       /* TRANSLATORS: this is the heading for a dialog box, which tells the user that the current
+                          project (Film) has been changed since it was last saved.
+                       */
                        _("Film changed"),
                        wxYES_NO | wxYES_DEFAULT | wxICON_QUESTION
                        );
@@ -127,7 +140,11 @@ enum {
        ID_jobs_show_dcp,
        ID_tools_hints,
        ID_tools_encoding_servers,
-       ID_tools_check_for_updates
+       ID_tools_check_for_updates,
+       ID_tools_restore_default_preferences,
+       ID_help_report_a_problem,
+       /* IDs for shortcuts (with no associated menu item) */
+       ID_add_file
 };
 
 class Frame : public wxFrame
@@ -143,27 +160,31 @@ public:
                , _history_position (0)
                , _history_separator (0)
        {
-#if defined(DCPOMATIC_WINDOWS) && defined(DCPOMATIC_WINDOWS_CONSOLE)
-                AllocConsole();
-               
-               HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
-               int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
-               FILE* hf_out = _fdopen(hCrt, "w");
-               setvbuf(hf_out, NULL, _IONBF, 1);
-               *stdout = *hf_out;
-               
-               HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
-               hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
-               FILE* hf_in = _fdopen(hCrt, "r");
-               setvbuf(hf_in, NULL, _IONBF, 128);
-               *stdin = *hf_in;
+#if defined(DCPOMATIC_WINDOWS)
+               if (Config::instance()->win32_console ()) {
+                       AllocConsole();
+                       
+                       HANDLE handle_out = GetStdHandle(STD_OUTPUT_HANDLE);
+                       int hCrt = _open_osfhandle((intptr_t) handle_out, _O_TEXT);
+                       FILE* hf_out = _fdopen(hCrt, "w");
+                       setvbuf(hf_out, NULL, _IONBF, 1);
+                       *stdout = *hf_out;
+                       
+                       HANDLE handle_in = GetStdHandle(STD_INPUT_HANDLE);
+                       hCrt = _open_osfhandle((intptr_t) handle_in, _O_TEXT);
+                       FILE* hf_in = _fdopen(hCrt, "r");
+                       setvbuf(hf_in, NULL, _IONBF, 128);
+                       *stdin = *hf_in;
+
+                       cout << "DCP-o-matic is starting." << "\n";
+               }
 #endif
 
                wxMenuBar* bar = new wxMenuBar;
                setup_menu (bar);
                SetMenuBar (bar);
 
-               Config::instance()->Changed.connect (boost::bind (&Frame::config_changed, this));
+               _config_changed_connection = Config::instance()->Changed.connect (boost::bind (&Frame::config_changed, this));
                config_changed ();
 
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::file_new, this),                ID_file_new);
@@ -182,7 +203,9 @@ public:
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::tools_hints, this),             ID_tools_hints);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::tools_encoding_servers, this),  ID_tools_encoding_servers);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::tools_check_for_updates, this), ID_tools_check_for_updates);
+               Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::tools_restore_default_preferences, this), ID_tools_restore_default_preferences);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::help_about, this),              wxID_ABOUT);
+               Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&Frame::help_report_a_problem, this),   ID_help_report_a_problem);
 
                Bind (wxEVT_CLOSE_WINDOW, boost::bind (&Frame::close, this, _1));
 
@@ -193,7 +216,7 @@ public:
 
                _film_editor = new FilmEditor (overall_panel);
                _film_viewer = new FilmViewer (overall_panel);
-               JobManagerView* job_manager_view = new JobManagerView (overall_panel, static_cast<JobManagerView::Buttons> (0));
+               JobManagerView* job_manager_view = new JobManagerView (overall_panel);
 
                wxBoxSizer* right_sizer = new wxBoxSizer (wxVERTICAL);
                right_sizer->Add (_film_viewer, 2, wxEXPAND | wxALL, 6);
@@ -211,6 +234,15 @@ public:
                JobManager::instance()->ActiveJobsChanged.connect (boost::bind (&Frame::set_menu_sensitivity, this));
 
                overall_panel->SetSizer (main_sizer);
+
+               wxAcceleratorEntry accel[1];
+               accel[0].Set (wxACCEL_CTRL, static_cast<int>('A'), ID_add_file);
+               Bind (wxEVT_MENU, boost::bind (&ContentPanel::add_file_clicked, _film_editor->content_panel()), ID_add_file);
+               wxAcceleratorTable accel_table (1, accel);
+               SetAcceleratorTable (accel_table);
+
+               /* Instantly save any config changes when using the DCP-o-matic GUI */
+               Config::instance()->Changed.connect (boost::bind (&Config::write, Config::instance ()));
        }
 
        void new_film (boost::filesystem::path path)
@@ -368,18 +400,40 @@ private:
                _config_dialog->Show (this);
        }
 
+       void tools_restore_default_preferences ()
+       {
+               Config::restore_defaults ();
+       }
+
        void jobs_make_dcp ()
        {
                double required;
                double available;
+               bool can_hard_link;
 
-               if (!_film->should_be_enough_disk_space (required, available)) {
-                       if (!confirm_dialog (this, 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))) {
+               if (!_film->should_be_enough_disk_space (required, available, can_hard_link)) {
+                       wxString message;
+                       if (can_hard_link) {
+                               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);
+                       } else {
+                               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);
+                       }
+                       if (!confirm_dialog (this, message)) {
                                return;
                        }
                }
-               
-               JobWrapper::make_dcp (this, _film);
+
+               try {
+                       /* It seems to make sense to auto-save metadata here, since the make DCP may last
+                          a long time, and crashes/power failures are moderately likely.
+                       */
+                       _film->write_metadata ();
+                       _film->make_dcp ();
+               } catch (BadSettingError& e) {
+                       error_dialog (this, wxString::Format (_("Bad setting for %s (%s)"), std_to_wx(e.setting()).data(), std_to_wx(e.what()).data()));
+               } catch (std::exception& e) {
+                       error_dialog (this, wxString::Format (_("Could not make DCP: %s"), std_to_wx(e.what()).data()));
+               }
        }
 
        void jobs_make_kdms ()
@@ -402,12 +456,12 @@ private:
                                        shared_ptr<Job> (new SendKDMEmailJob (_film, d->screens (), d->cpl (), d->from (), d->until (), d->formulation ()))
                                        );
                        }
-               } catch (libdcp::NotEncryptedError& e) {
+               } catch (dcp::NotEncryptedError& e) {
                        error_dialog (this, _("CPL's content is not encrypted."));
                } catch (exception& e) {
                        error_dialog (this, e.what ());
                } catch (...) {
-                       error_dialog (this, _("An unknown exeception occurred."));
+                       error_dialog (this, _("An unknown exception occurred."));
                }
        
                d->Destroy ();
@@ -415,7 +469,7 @@ private:
 
        void content_scale_to_fit_width ()
        {
-               VideoContentList vc = _film_editor->selected_video_content ();
+               VideoContentList vc = _film_editor->content_panel()->selected_video ();
                for (VideoContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
                        (*i)->scale_and_crop_to_fit_width ();
                }
@@ -423,7 +477,7 @@ private:
 
        void content_scale_to_fit_height ()
        {
-               VideoContentList vc = _film_editor->selected_video_content ();
+               VideoContentList vc = _film_editor->content_panel()->selected_video ();
                for (VideoContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
                        (*i)->scale_and_crop_to_fit_height ();
                }
@@ -436,12 +490,13 @@ private:
 
        void jobs_show_dcp ()
        {
-#ifdef __WXMSW__
-               string d = _film->directory().string ();
-               wstring w;
-               w.assign (d.begin(), d.end());
-               ShellExecute (0, L"open", w.c_str(), 0, 0, SW_SHOWDEFAULT);
-#else
+#ifdef DCPOMATIC_WINDOWS
+               wstringstream args;
+               args << "/select," << _film->dir (_film->dcp_name(false));
+               ShellExecute (0, L"open", L"explorer.exe", args.str().c_str(), 0, SW_SHOWDEFAULT);
+#endif
+
+#ifdef DCPOMATIC_LINUX
                int r = system ("which nautilus");
                if (WEXITSTATUS (r) == 0) {
                        r = system (string ("nautilus " + _film->directory().string()).c_str ());
@@ -458,6 +513,13 @@ private:
                        }
                }
 #endif         
+
+#ifdef DCPOMATIC_OSX
+               int r = system (string ("open -R " + _film->dir (_film->dcp_name (false)).string ()).c_str ());
+               if (WEXITSTATUS (r)) {
+                       error_dialog (this, _("Could not show DCP"));
+               }
+#endif                
        }
 
        void tools_hints ()
@@ -490,6 +552,15 @@ private:
                d->Destroy ();
        }
 
+       void help_report_a_problem ()
+       {
+               ReportProblemDialog* d = new ReportProblemDialog (this, _film);
+               if (d->ShowModal () == wxID_OK) {
+                       d->report ();
+               }
+               d->Destroy ();
+       }
+
        bool should_close ()
        {
                if (!JobManager::instance()->work_to_do ()) {
@@ -515,8 +586,13 @@ private:
                        return;
                }
 
+               /* We don't want to hear about any more configuration changes, since they
+                  cause the File menu to be altered, which itself will be deleted around
+                  now (without, as far as I can see, any way for us to find out).
+               */
+               _config_changed_connection.disconnect ();
+               
                maybe_save_then_delete_film ();
-
                ev.Skip ();
        }
 
@@ -529,7 +605,7 @@ private:
                }
                bool const dcp_creation = (i != jobs.end ()) && !(*i)->finished ();
                bool const have_cpl = _film && !_film->cpls().empty ();
-               bool const have_selected_video_content = !_film_editor->selected_video_content().empty();
+               bool const have_selected_video_content = !_film_editor->content_panel()->selected_video().empty();
                
                for (map<wxMenuItem*, int>::iterator j = menu_items.begin(); j != menu_items.end(); ++j) {
                        
@@ -584,10 +660,10 @@ private:
        void setup_menu (wxMenuBar* m)
        {
                _file_menu = new wxMenu;
-               add_item (_file_menu, _("New..."), ID_file_new, ALWAYS);
-               add_item (_file_menu, _("&Open..."), ID_file_open, ALWAYS);
+               add_item (_file_menu, _("New...\tCtrl-N"), ID_file_new, ALWAYS);
+               add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
                _file_menu->AppendSeparator ();
-               add_item (_file_menu, _("&Save"), ID_file_save, NEEDS_FILM);
+               add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
                _file_menu->AppendSeparator ();
                add_item (_file_menu, _("&Properties..."), ID_file_properties, NEEDS_FILM);
 
@@ -604,10 +680,10 @@ private:
 #endif 
        
 #ifdef __WXOSX__       
-               add_item (_file_menu, _("&Preferences..."), wxID_PREFERENCES, ALWAYS);
+               add_item (_file_menu, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
 #else
                wxMenu* edit = new wxMenu;
-               add_item (edit, _("&Preferences..."), wxID_PREFERENCES, ALWAYS);
+               add_item (edit, _("&Preferences...\tCtrl-P"), wxID_PREFERENCES, ALWAYS);
 #endif
 
                wxMenu* content = new wxMenu;
@@ -615,8 +691,8 @@ private:
                add_item (content, _("Scale to fit &height"), ID_content_scale_to_fit_height, NEEDS_FILM | NEEDS_SELECTED_VIDEO_CONTENT);
                
                wxMenu* jobs_menu = new wxMenu;
-               add_item (jobs_menu, _("&Make DCP"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
-               add_item (jobs_menu, _("Make &KDMs..."), ID_jobs_make_kdms, NEEDS_FILM);
+               add_item (jobs_menu, _("&Make DCP\tCtrl-M"), ID_jobs_make_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION);
+               add_item (jobs_menu, _("Make &KDMs...\tCtrl-K"), ID_jobs_make_kdms, NEEDS_FILM);
                add_item (jobs_menu, _("&Send DCP to TMS"), ID_jobs_send_dcp_to_tms, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
                add_item (jobs_menu, _("S&how DCP"), ID_jobs_show_dcp, NEEDS_FILM | NOT_DURING_DCP_CREATION | NEEDS_CPL);
 
@@ -624,6 +700,8 @@ private:
                add_item (tools, _("Hints..."), ID_tools_hints, 0);
                add_item (tools, _("Encoding servers..."), ID_tools_encoding_servers, 0);
                add_item (tools, _("Check for updates"), ID_tools_check_for_updates, 0);
+               tools->AppendSeparator ();
+               add_item (tools, _("Restore default preferences"), ID_tools_restore_default_preferences, ALWAYS);
                
                wxMenu* help = new wxMenu;
 #ifdef __WXOSX__       
@@ -631,6 +709,7 @@ private:
 #else  
                add_item (help, _("About"), wxID_ABOUT, ALWAYS);
 #endif 
+               add_item (help, _("Report a problem..."), ID_help_report_a_problem, ALWAYS);
                
                m->Append (_file_menu, _("&File"));
 #ifndef __WXOSX__      
@@ -684,6 +763,7 @@ private:
        int _history_items;
        int _history_position;
        wxMenuItem* _history_separator;
+       boost::signals2::scoped_connection _config_changed_connection;
 };
 
 static const wxCmdLineEntryDesc command_line_description[] = {
@@ -693,8 +773,19 @@ static const wxCmdLineEntryDesc command_line_description[] = {
        { wxCMD_LINE_NONE, "", "", "", wxCmdLineParamType (0), 0 }
 };
 
+/** @class App
+ *  @brief The magic App class for wxWidgets.
+ */
 class App : public wxApp
 {
+public:
+       App ()
+               : wxApp ()
+               , _frame (0)
+       {}
+
+private:       
+               
        bool OnInit ()
        try
        {
@@ -719,12 +810,12 @@ class App : public wxApp
                /* Enable i18n; this will create a Config object
                   to look for a force-configured language.  This Config
                   object will be wrong, however, because dcpomatic_setup
-                  hasn't yet been called and there aren't any scalers, filters etc.
+                  hasn't yet been called and there aren't any filters etc.
                   set up yet.
                */
                dcpomatic_setup_i18n ();
 
-               /* Set things up, including scalers / filters etc.
+               /* Set things up, including filters etc.
                   which will now be internationalised correctly.
                */
                dcpomatic_setup ();
@@ -754,7 +845,7 @@ class App : public wxApp
                        }
                }
 
-               ui_signaller = new wxUISignaller (this);
+               signal_manager = new wxSignalManager (this);
                Bind (wxEVT_IDLE, boost::bind (&App::idle, this));
 
                Bind (wxEVT_TIMER, boost::bind (&App::check, this));
@@ -803,10 +894,12 @@ class App : public wxApp
        {
                try {
                        throw;
+               } catch (FileError& e) {
+                       error_dialog (0, wxString::Format (_("An exception occurred: %s in %s.\n\n" + REPORT_PROBLEM), e.what(), e.file().string().c_str ()));
                } catch (exception& e) {
-                       error_dialog (0, wxString::Format (_("An exception occurred (%s).  Please report this problem to the DCP-o-matic author (carl@dcpomatic.com)."), e.what ()));
+                       error_dialog (0, wxString::Format (_("An exception occurred: %s.\n\n"), e.what ()) + "  " + REPORT_PROBLEM);
                } catch (...) {
-                       error_dialog (0, _("An unknown exception occurred.  Please report this problem to the DCP-o-matic author (carl@dcpomatic.com)."));
+                       error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
                }
 
                /* This will terminate the program */
@@ -815,12 +908,12 @@ class App : public wxApp
        
        void OnUnhandledException ()
        {
-               error_dialog (0, _("An unknown exception occurred.  Please report this problem to the DCP-o-matic author (carl@dcpomatic.com)."));
+               error_dialog (0, _("An unknown exception occurred.") + "  " + REPORT_PROBLEM);
        }
 
        void idle ()
        {
-               ui_signaller->ui_idle ();
+               signal_manager->ui_idle ();
        }
 
        void check ()
@@ -834,29 +927,19 @@ class App : public wxApp
 
        void update_checker_state_changed ()
        {
-               switch (UpdateChecker::instance()->state ()) {
-               case UpdateChecker::YES:
-               {
-                       string test;
-                       if (Config::instance()->check_for_test_updates ()) {
-                               test = UpdateChecker::instance()->test ();
-                       }
-                       UpdateDialog* dialog = new UpdateDialog (_frame, UpdateChecker::instance()->stable (), test);
+               UpdateChecker* uc = UpdateChecker::instance ();
+               if (uc->state() == UpdateChecker::YES && (uc->stable() || uc->test())) {
+                       UpdateDialog* dialog = new UpdateDialog (_frame, uc->stable (), uc->test ());
                        dialog->ShowModal ();
                        dialog->Destroy ();
-                       break;
-               }
-               case UpdateChecker::NO:
+               } else if (uc->state() == UpdateChecker::FAILED) {
                        if (!UpdateChecker::instance()->last_emit_was_first ()) {
-                               error_dialog (_frame, _("There are no new versions of DCP-o-matic available."));
+                               error_dialog (_frame, _("The DCP-o-matic download server could not be contacted."));
                        }
-                       break;
-               case UpdateChecker::FAILED:
+               } else {
                        if (!UpdateChecker::instance()->last_emit_was_first ()) {
-                               error_dialog (_frame, _("The DCP-o-matic download server could not be contacted."));
+                               error_dialog (_frame, _("There are no new versions of DCP-o-matic available."));
                        }
-               default:
-                       break;
                }
        }