Basic template support (#485).
[dcpomatic.git] / src / tools / dcpomatic.cc
index f336f0a854ee1672b12278f18c090e7fcc6d7cc7..63e5ca6b14834e85dc1acbed2aac0a2845cace52 100644 (file)
@@ -1,19 +1,20 @@
 /*
     Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #include "wx/content_panel.h"
 #include "wx/report_problem_dialog.h"
 #include "wx/video_waveform_dialog.h"
+#include "wx/save_template_dialog.h"
 #include "lib/film.h"
 #include "lib/config.h"
 #include "lib/util.h"
 #include "lib/video_content.h"
+#include "lib/content.h"
 #include "lib/version.h"
 #include "lib/signal_manager.h"
 #include "lib/log.h"
@@ -56,7 +59,9 @@
 #include "lib/compose.hpp"
 #include "lib/cinema_kdms.h"
 #include "lib/dcpomatic_socket.h"
+#include "lib/hints.h"
 #include <dcp/exceptions.h>
+#include <dcp/raw_convert.h>
 #include <wx/generic/aboutdlgg.h>
 #include <wx/stdpaths.h>
 #include <wx/cmdline.h>
@@ -72,6 +77,7 @@
 #include <boost/noncopyable.hpp>
 #include <iostream>
 #include <fstream>
+/* This is OK as it's only used with DCPOMATIC_WINDOWS */
 #include <sstream>
 
 #ifdef check
@@ -90,6 +96,8 @@ using std::list;
 using std::exception;
 using boost::shared_ptr;
 using boost::dynamic_pointer_cast;
+using boost::optional;
+using dcp::raw_convert;
 
 class FilmChangedDialog : public boost::noncopyable
 {
@@ -102,7 +110,11 @@ public:
                        /// 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
+                       wxYES_NO | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
+                       );
+
+               _dialog->SetYesNoCancelLabels (
+                       _("Save film and close"), _("Close without saving film"), _("Don't close")
                        );
        }
 
@@ -132,6 +144,7 @@ enum {
        ID_file_new = 1,
        ID_file_open,
        ID_file_save,
+       ID_file_save_as_template,
        ID_file_history,
        /* Allow spare IDs after _history for the recent files list */
        ID_content_scale_to_fit_width = 100,
@@ -162,6 +175,7 @@ public:
                , _hints_dialog (0)
                , _servers_list_dialog (0)
                , _config_dialog (0)
+               , _kdm_dialog (0)
                , _file_menu (0)
                , _history_items (0)
                , _history_position (0)
@@ -198,6 +212,7 @@ public:
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_new, this),                ID_file_new);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_open, this),               ID_file_open);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_save, this),               ID_file_save);
+               Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_save_as_template, this),   ID_file_save_as_template);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_history, this, _1),        ID_file_history, ID_file_history + HISTORY_SIZE);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::file_exit, this),               wxID_EXIT);
                Bind (wxEVT_COMMAND_MENU_SELECTED, boost::bind (&DOMFrame::edit_preferences, this),        wxID_PREFERENCES);
@@ -266,9 +281,12 @@ public:
                }
        }
 
-       void new_film (boost::filesystem::path path)
+       void new_film (boost::filesystem::path path, optional<string> template_name)
        {
                shared_ptr<Film> film (new Film (path));
+               if (template_name) {
+                       film->use_template (template_name.get());
+               }
                film->write_metadata ();
                film->set_name (path.filename().generic_string());
                set_film (film);
@@ -277,8 +295,6 @@ public:
        void load_film (boost::filesystem::path file)
        try
        {
-               maybe_save_then_delete_film ();
-
                shared_ptr<Film> film (new Film (file));
                list<string> const notes = film->read_metadata ();
 
@@ -307,8 +323,12 @@ public:
                _film = film;
                _film_viewer->set_film (_film);
                _film_editor->set_film (_film);
+               delete _video_waveform_dialog;
+               _video_waveform_dialog = 0;
                set_menu_sensitivity ();
-               Config::instance()->add_to_history (_film->directory ());
+               if (_film->directory()) {
+                       Config::instance()->add_to_history (_film->directory().get());
+               }
        }
 
        shared_ptr<Film> film () const {
@@ -334,27 +354,28 @@ private:
 
                if (r == wxID_OK) {
 
-                       if (boost::filesystem::is_directory (d->get_path()) && !boost::filesystem::is_empty(d->get_path())) {
+                       if (boost::filesystem::is_directory (d->path()) && !boost::filesystem::is_empty(d->path())) {
                                if (!confirm_dialog (
                                            this,
                                            std_to_wx (
                                                    String::compose (wx_to_std (_("The directory %1 already exists and is not empty.  "
                                                                                  "Are you sure you want to use it?")),
-                                                                    d->get_path().string().c_str())
+                                                                    d->path().string().c_str())
                                                    )
                                            )) {
                                        return;
                                }
-                       } else if (boost::filesystem::is_regular_file (d->get_path())) {
+                       } else if (boost::filesystem::is_regular_file (d->path())) {
                                error_dialog (
                                        this,
-                                       String::compose (wx_to_std (_("%1 already exists as a file, so you cannot use it for a new film.")), d->get_path().c_str())
+                                       String::compose (wx_to_std (_("%1 already exists as a file, so you cannot use it for a new film.")), d->path().c_str())
                                        );
                                return;
                        }
 
-                       maybe_save_then_delete_film ();
-                       new_film (d->get_path ());
+                       if (maybe_save_then_delete_film ()) {
+                               new_film (d->path(), d->template_name());
+                       }
                }
 
                d->Destroy ();
@@ -379,7 +400,7 @@ private:
                        }
                }
 
-               if (r == wxID_OK) {
+               if (r == wxID_OK && maybe_save_then_delete_film()) {
                        load_film (wx_to_std (c->GetPath ()));
                }
 
@@ -391,11 +412,27 @@ private:
                _film->write_metadata ();
        }
 
+       void file_save_as_template ()
+       {
+               SaveTemplateDialog* d = new SaveTemplateDialog (this);
+               int const r = d->ShowModal ();
+               if (r == wxID_OK) {
+                       bool ok = true;
+                       if (Config::instance()->existing_template (d->name ())) {
+                               ok = confirm_dialog (d, _("There is already a template with this name.  Do you want to overwrite it?"));
+                       }
+                       if (ok) {
+                               Config::instance()->save_template (_film, d->name ());
+                       }
+               }
+               d->Destroy ();
+       }
+
        void file_history (wxCommandEvent& event)
        {
                vector<boost::filesystem::path> history = Config::instance()->history ();
                int n = event.GetId() - ID_file_history;
-               if (n >= 0 && n < static_cast<int> (history.size ())) {
+               if (n >= 0 && n < static_cast<int> (history.size ()) && maybe_save_then_delete_film()) {
                        load_film (history[n]);
                }
        }
@@ -449,6 +486,15 @@ private:
                        }
                }
 
+               if (!get_hints(_film).empty() && Config::instance()->show_hints_before_make_dcp()) {
+                       HintsDialog* hints = new HintsDialog (this, _film, false);
+                       int const r = hints->ShowModal();
+                       hints->Destroy ();
+                       if (r == wxID_CANCEL) {
+                               return;
+                       }
+               }
+
                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.
@@ -468,41 +514,13 @@ private:
                        return;
                }
 
-               KDMDialog* d = new KDMDialog (this, _film);
-               if (d->ShowModal () != wxID_OK) {
-                       d->Destroy ();
-                       return;
+               if (_kdm_dialog) {
+                       _kdm_dialog->Destroy ();
+                       _kdm_dialog = 0;
                }
 
-               try {
-                       list<ScreenKDM> screen_kdms = _film->make_kdms (d->screens(), d->cpl(), d->from(), d->until(), d->formulation());
-                       if (d->write_to ()) {
-                               ScreenKDM::write_files (
-                                       _film->name(),
-                                       screen_kdms,
-                                       d->directory()
-                                       );
-                       } else {
-                               JobManager::instance()->add (
-                                       shared_ptr<Job> (new SendKDMEmailJob (
-                                                                _film->name(),
-                                                                _film->dcp_name(),
-                                                                d->from(),
-                                                                d->until(),
-                                                                CinemaKDMs::collect (screen_kdms),
-                                                                _film->log()
-                                                                ))
-                                       );
-                       }
-               } 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 exception occurred."));
-               }
-
-               d->Destroy ();
+               _kdm_dialog = new KDMDialog (this, _film);
+               _kdm_dialog->Show (this);
        }
 
        void jobs_make_dcp_batch ()
@@ -511,6 +529,15 @@ private:
                        return;
                }
 
+               if (!get_hints(_film).empty() && Config::instance()->show_hints_before_make_dcp()) {
+                       HintsDialog* hints = new HintsDialog (this, _film, false);
+                       int const r = hints->ShowModal();
+                       hints->Destroy ();
+                       if (r == wxID_CANCEL) {
+                               return;
+                       }
+               }
+
                _film->write_metadata ();
 
                /* i = 0; try to connect via socket
@@ -525,7 +552,8 @@ private:
                                boost::asio::ip::tcp::resolver::iterator endpoint_iterator = resolver.resolve (query);
                                Socket socket (5);
                                socket.connect (*endpoint_iterator);
-                               string s = _film->directory().string ();
+                               DCPOMATIC_ASSERT (_film->directory ());
+                               string s = _film->directory()->string ();
                                socket.write (s.length() + 1);
                                socket.write ((uint8_t *) s.c_str(), s.length() + 1);
                                /* OK\0 */
@@ -558,20 +586,16 @@ private:
                        return;
                }
 
+               optional<dcp::EncryptedKDM> kdm;
                try {
-                       vector<dcp::EncryptedKDM> dkdms = Config::instance()->dkdms ();
-                       dkdms.push_back (
-                               _film->make_kdm (
-                                       Config::instance()->decryption_chain()->leaf(),
-                                       vector<dcp::Certificate> (),
-                                       d->cpl (),
-                                       dcp::LocalTime ("2012-01-01T01:00:00+00:00"),
-                                       dcp::LocalTime ("2112-01-01T01:00:00+00:00"),
-                                       dcp::MODIFIED_TRANSITIONAL_1
-                                       )
+                       kdm = _film->make_kdm (
+                               Config::instance()->decryption_chain()->leaf(),
+                               vector<dcp::Certificate> (),
+                               d->cpl (),
+                               dcp::LocalTime ("2012-01-01T01:00:00+00:00"),
+                               dcp::LocalTime ("2112-01-01T01:00:00+00:00"),
+                               dcp::MODIFIED_TRANSITIONAL_1
                                );
-
-                       Config::instance()->set_dkdms (dkdms);
                } catch (dcp::NotEncryptedError& e) {
                        error_dialog (this, _("CPL's content is not encrypted."));
                } catch (exception& e) {
@@ -580,22 +604,33 @@ private:
                        error_dialog (this, _("An unknown exception occurred."));
                }
 
+               if (kdm) {
+                       if (d->internal ()) {
+                               vector<dcp::EncryptedKDM> dkdms = Config::instance()->dkdms ();
+                               dkdms.push_back (kdm.get());
+                               Config::instance()->set_dkdms (dkdms);
+                       } else {
+                               boost::filesystem::path path = d->directory() / (_film->dcp_name(false) + "_DKDM.xml");
+                               kdm->as_xml (path);
+                       }
+               }
+
                d->Destroy ();
        }
 
        void content_scale_to_fit_width ()
        {
-               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 ();
+               ContentList vc = _film_editor->content_panel()->selected_video ();
+               for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
+                       (*i)->video->scale_and_crop_to_fit_width ();
                }
        }
 
        void content_scale_to_fit_height ()
        {
-               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 ();
+               ContentList vc = _film_editor->content_panel()->selected_video ();
+               for (ContentList::iterator i = vc.begin(); i != vc.end(); ++i) {
+                       (*i)->video->scale_and_crop_to_fit_height ();
                }
        }
 
@@ -606,6 +641,7 @@ private:
 
        void jobs_show_dcp ()
        {
+               DCPOMATIC_ASSERT (_film->directory ());
 #ifdef DCPOMATIC_WINDOWS
                wstringstream args;
                args << "/select," << _film->dir (_film->dcp_name(false));
@@ -615,14 +651,14 @@ private:
 #ifdef DCPOMATIC_LINUX
                int r = system ("which nautilus");
                if (WEXITSTATUS (r) == 0) {
-                       r = system (string ("nautilus " + _film->directory().string()).c_str ());
+                       r = system (string ("nautilus " + _film->directory()->string()).c_str ());
                        if (WEXITSTATUS (r)) {
                                error_dialog (this, _("Could not show DCP (could not run nautilus)"));
                        }
                } else {
                        int r = system ("which konqueror");
                        if (WEXITSTATUS (r) == 0) {
-                               r = system (string ("konqueror " + _film->directory().string()).c_str ());
+                               r = system (string ("konqueror " + _film->directory()->string()).c_str ());
                                if (WEXITSTATUS (r)) {
                                        error_dialog (this, _("Could not show DCP (could not run konqueror)"));
                                }
@@ -641,7 +677,7 @@ private:
        void tools_video_waveform ()
        {
                if (!_video_waveform_dialog) {
-                       _video_waveform_dialog = new VideoWaveformDialog (this, _film_viewer);
+                       _video_waveform_dialog = new VideoWaveformDialog (this, _film, _film_viewer);
                }
 
                _video_waveform_dialog->Show ();
@@ -650,7 +686,7 @@ private:
        void tools_hints ()
        {
                if (!_hints_dialog) {
-                       _hints_dialog = new HintsDialog (this, _film);
+                       _hints_dialog = new HintsDialog (this, _film, true);
                }
 
                _hints_dialog->Show ();
@@ -714,21 +750,9 @@ private:
 
                if (_film && _film->dirty ()) {
 
-                       wxMessageDialog* dialog = new wxMessageDialog (
-                               0,
-                               wxString::Format (_("Save changes to film \"%s\" before closing?"), std_to_wx (_film->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 | wxCANCEL | wxYES_DEFAULT | wxICON_QUESTION
-                               );
-
-                       dialog->SetYesNoCancelLabels (
-                               _("Save film and close"), _("Close without saving film"), _("Don't close")
-                               );
-
-                       int const r = dialog->ShowModal ();
-                       dialog->Destroy ();
+                       FilmChangedDialog* dialog = new FilmChangedDialog (_film->name ());
+                       int const r = dialog->run ();
+                       delete dialog;
 
                        switch (r) {
                        case wxID_NO:
@@ -789,10 +813,13 @@ private:
                }
        }
 
-       void maybe_save_then_delete_film ()
+       /** @return true if the operation that called this method
+        *  should continue, false to abort it.
+        */
+       bool maybe_save_then_delete_film ()
        {
                if (!_film) {
-                       return;
+                       return true;
                }
 
                if (_film->dirty ()) {
@@ -803,10 +830,13 @@ private:
                        case wxID_YES:
                                _film->write_metadata ();
                                break;
+                       case wxID_CANCEL:
+                               return false;
                        }
                }
 
                _film.reset ();
+               return true;
        }
 
        void add_item (wxMenu* menu, wxString text, int id, int sens)
@@ -822,6 +852,8 @@ private:
                add_item (_file_menu, _("&Open...\tCtrl-O"), ID_file_open, ALWAYS);
                _file_menu->AppendSeparator ();
                add_item (_file_menu, _("&Save\tCtrl-S"), ID_file_save, NEEDS_FILM);
+               _file_menu->AppendSeparator ();
+               add_item (_file_menu, _("Save as &template..."), ID_file_save_as_template, NEEDS_FILM);
 
                _history_position = _file_menu->GetMenuItems().GetCount();
 
@@ -901,12 +933,13 @@ private:
                }
 
                for (size_t i = 0; i < history.size(); ++i) {
-                       SafeStringStream s;
+                       string s;
                        if (i < 9) {
-                               s << "&" << (i + 1) << " ";
+                               s = String::compose ("&%1 %2", i + 1, history[i].string());
+                       } else {
+                               s = history[i].string();
                        }
-                       s << history[i].string();
-                       _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s.str ()));
+                       _file_menu->Insert (pos++, ID_file_history + i, std_to_wx (s));
                }
 
                _history_items = history.size ();
@@ -946,6 +979,7 @@ private:
        HintsDialog* _hints_dialog;
        ServersListDialog* _servers_list_dialog;
        wxPreferencesEditor* _config_dialog;
+       KDMDialog* _kdm_dialog;
        wxMenu* _file_menu;
        shared_ptr<Film> _film;
        int _history_items;
@@ -980,6 +1014,8 @@ private:
        {
                wxInitAllImageHandlers ();
 
+               Config::FailedToLoad.connect (boost::bind (&App::config_failed_to_load, this));
+
                wxSplashScreen* splash = 0;
                try {
                        if (!Config::have_existing ("config.xml")) {
@@ -1047,7 +1083,7 @@ private:
                }
 
                if (!_film_to_create.empty ()) {
-                       _frame->new_film (_film_to_create);
+                       _frame->new_film (_film_to_create, optional<string> ());
                        if (!_content_to_add.empty ()) {
                                _frame->film()->examine_and_add_content (content_factory (_frame->film(), _content_to_add));
                        }
@@ -1149,6 +1185,11 @@ private:
                }
        }
 
+       void config_failed_to_load ()
+       {
+               message_dialog (_frame, _("The existing configuration failed to load.  Default values will be used instead.  These may take a short time to create."));
+       }
+
        DOMFrame* _frame;
        shared_ptr<wxTimer> _timer;
        string _film_to_load;