Simple cover sheet support (#1039).
[dcpomatic.git] / src / lib / config.cc
index 80598c7e9d8ed6fe091f1561a5650b1b51a5cf9c..a19a60f55aa06d5d16072f2cacea23f5bdd4ced6 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2017 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/>.
 
 */
 
@@ -28,8 +29,9 @@
 #include "cinema.h"
 #include "util.h"
 #include "cross.h"
-#include "raw_convert.h"
-#include <dcp/colour_matrix.h>
+#include "film.h"
+#include <dcp/raw_convert.h>
+#include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
 #include <libcxml/cxml.h>
 #include <glib.h>
@@ -56,8 +58,10 @@ using std::cerr;
 using boost::shared_ptr;
 using boost::optional;
 using boost::algorithm::trim;
+using dcp::raw_convert;
 
 Config* Config::_instance = 0;
+boost::signals2::signal<void ()> Config::FailedToLoad;
 
 /** Construct default configuration */
 Config::Config ()
@@ -68,7 +72,8 @@ Config::Config ()
 void
 Config::set_defaults ()
 {
-       _num_local_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
+       _master_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
+       _server_encoding_threads = max (2U, boost::thread::hardware_concurrency ());
        _server_port_base = 6192;
        _use_any_servers = true;
        _servers.clear ();
@@ -84,9 +89,10 @@ Config::set_defaults ()
        _default_still_length = 10;
        _default_container = Ratio::from_id ("185");
        _default_dcp_content_type = DCPContentType::from_isdcf_name ("FTR");
+       _default_dcp_audio_channels = 6;
        _default_j2k_bandwidth = 100000000;
        _default_audio_delay = 0;
-       _default_interop = false;
+       _default_interop = true;
        _mail_server = "";
        _mail_port = 25;
        _mail_user = "";
@@ -104,6 +110,18 @@ Config::set_defaults ()
        _win32_console = false;
 #endif
        _cinemas_file = path ("cinemas.xml");
+       _show_hints_before_make_dcp = true;
+       _confirm_kdm_email = true;
+       _kdm_container_name_format = dcp::NameFormat ("KDM %f %c");
+       _kdm_filename_format = dcp::NameFormat ("KDM %f %c %s");
+       _dcp_metadata_filename_format = dcp::NameFormat ("%t");
+       _dcp_asset_filename_format = dcp::NameFormat ("%t");
+       _jump_to_selected = true;
+       for (int i = 0; i < NAG_COUNT; ++i) {
+               _nagged[i] = false;
+       }
+       _preview_sound = false;
+       _preview_sound_output = optional<string> ();
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -114,6 +132,7 @@ Config::set_defaults ()
        _allowed_dcp_frame_rates.push_back (60);
 
        set_kdm_email_to_default ();
+       set_cover_sheet_to_default ();
 }
 
 void
@@ -140,26 +159,26 @@ Config::create_certificate_chain ()
 
 void
 Config::read ()
+try
 {
-       if (!have_existing ("config.xml")) {
-               cout << "No existing config.xml; creating chains.\n";
-               /* Make a new set of signing certificates and key */
-               _signer_chain = create_certificate_chain ();
-               /* And similar for decryption of KDMs */
-               _decryption_chain = create_certificate_chain ();
-               cout << "Writing config.\n";
-               write ();
-               return;
-       }
-
        cxml::Document f ("Config");
        f.read_file (path ("config.xml"));
        optional<string> c;
 
        optional<int> version = f.optional_number_child<int> ("Version");
 
-       _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
-       _default_directory = f.string_child ("DefaultDirectory");
+       if (f.optional_number_child<int>("NumLocalEncodingThreads")) {
+               _master_encoding_threads = _server_encoding_threads = f.optional_number_child<int>("NumLocalEncodingThreads").get();
+       } else {
+               _master_encoding_threads = f.number_child<int>("MasterEncodingThreads");
+               _server_encoding_threads = f.number_child<int>("ServerEncodingThreads");
+       }
+
+       _default_directory = f.optional_string_child ("DefaultDirectory");
+       if (_default_directory && _default_directory->empty ()) {
+               /* We used to store an empty value for this to mean "none set" */
+               _default_directory = boost::optional<boost::filesystem::path> ();
+       }
 
        boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
        if (!b) {
@@ -207,6 +226,8 @@ Config::read ()
                _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
        }
 
+       _default_dcp_audio_channels = f.optional_number_child<int>("DefaultDCPAudioChannels").get_value_or (6);
+
        if (f.optional_string_child ("DCPMetadataIssuer")) {
                _dcp_issuer = f.string_child ("DCPMetadataIssuer");
        } else if (f.optional_string_child ("DCPIssuer")) {
@@ -225,6 +246,7 @@ Config::read ()
        _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
        _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
        _default_interop = f.optional_bool_child("DefaultInterop").get_value_or (false);
+       _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 
        /* Load any cinemas from config.xml */
        read_cinemas (f);
@@ -293,6 +315,24 @@ Config::read ()
        }
 
        _cinemas_file = f.optional_string_child("CinemasFile").get_value_or (path ("cinemas.xml").string ());
+       _show_hints_before_make_dcp = f.optional_bool_child("ShowHintsBeforeMakeDCP").get_value_or (true);
+       _confirm_kdm_email = f.optional_bool_child("ConfirmKDMEmail").get_value_or (true);
+       _kdm_container_name_format = dcp::NameFormat (f.optional_string_child("KDMContainerNameFormat").get_value_or ("KDM %f %c"));
+       _kdm_filename_format = dcp::NameFormat (f.optional_string_child("KDMFilenameFormat").get_value_or ("KDM %f %c %s"));
+       _dcp_metadata_filename_format = dcp::NameFormat (f.optional_string_child("DCPMetadataFilenameFormat").get_value_or ("%t"));
+       _dcp_asset_filename_format = dcp::NameFormat (f.optional_string_child("DCPAssetFilenameFormat").get_value_or ("%t"));
+       _jump_to_selected = f.optional_bool_child("JumpToSelected").get_value_or (true);
+       BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) {
+               int const id = i->number_attribute<int>("Id");
+               if (id >= 0 && id < NAG_COUNT) {
+                       _nagged[id] = raw_convert<int>(i->content());
+               }
+       }
+       _preview_sound = f.optional_bool_child("PreviewSound").get_value_or (false);
+       _preview_sound_output = f.optional_string_child("PreviewSoundOutput");
+       if (f.optional_string_child("CoverSheet")) {
+               _cover_sheet = f.optional_string_child("CoverSheet").get();
+       }
 
        /* Replace any cinemas from config.xml with those from the configured file */
        if (boost::filesystem::exists (_cinemas_file)) {
@@ -301,6 +341,26 @@ Config::read ()
                read_cinemas (f);
        }
 }
+catch (...) {
+       if (have_existing ("config.xml")) {
+
+               /* Make a copy of the configuration */
+               try {
+                       boost::filesystem::copy_file (path ("config.xml", false), path ("config.xml.backup", false));
+                       boost::filesystem::copy_file (path ("cinemas.xml", false), path ("cinemas.xml.backup", false));
+               } catch (...) {}
+
+               /* We have a config file but it didn't load */
+               FailedToLoad ();
+       }
+       set_defaults ();
+       /* Make a new set of signing certificates and key */
+       _signer_chain = create_certificate_chain ();
+       /* And similar for decryption of KDMs */
+       _decryption_chain = create_certificate_chain ();
+       write ();
+}
+
 
 /** @return Filename to write configuration to */
 boost::filesystem::path
@@ -331,16 +391,7 @@ Config::instance ()
 {
        if (_instance == 0) {
                _instance = new Config;
-               try {
-                       _instance->read ();
-               } catch (exception& e) {
-                       /* configuration load failed; never mind, just
-                          stick with the default.
-                       */
-                       cerr << "dcpomatic: warning: configuration did not load (" << e.what() << "); using defaults\n";
-               } catch (...) {
-                       cerr << "dcpomatic: warning: configuration did not load; using defaults\n";
-               }
+               _instance->read ();
        }
 
        return _instance;
@@ -350,19 +401,22 @@ Config::instance ()
 void
 Config::write () const
 {
-       write_config_xml ();
-       write_cinemas_xml ();
+       write_config ();
+       write_cinemas ();
 }
 
 void
-Config::write_config_xml () const
+Config::write_config () const
 {
        xmlpp::Document doc;
        xmlpp::Element* root = doc.create_root_node ("Config");
 
        root->add_child("Version")->add_child_text ("2");
-       root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
-       root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
+       root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
+       root->add_child("ServerEncodingThreads")->add_child_text (raw_convert<string> (_server_encoding_threads));
+       if (_default_directory) {
+               root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ());
+       }
        root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
        root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 
@@ -371,7 +425,7 @@ Config::write_config_xml () const
        }
 
        root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0");
-       root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (_tms_protocol));
+       root->add_child("TMSProtocol")->add_child_text (raw_convert<string> (static_cast<int> (_tms_protocol)));
        root->add_child("TMSIP")->add_child_text (_tms_ip);
        root->add_child("TMSPath")->add_child_text (_tms_path);
        root->add_child("TMSUser")->add_child_text (_tms_user);
@@ -388,6 +442,7 @@ Config::write_config_xml () const
        if (_default_dcp_content_type) {
                root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
        }
+       root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_default_dcp_audio_channels));
        root->add_child("DCPIssuer")->add_child_text (_dcp_issuer);
        root->add_child("DCPCreator")->add_child_text (_dcp_creator);
 
@@ -397,6 +452,9 @@ Config::write_config_xml () const
        root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
        root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
        root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
+       if (_default_kdm_directory) {
+               root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
+       }
        root->add_child("MailServer")->add_child_text (_mail_server);
        root->add_child("MailPort")->add_child_text (raw_convert<string> (_mail_port));
        root->add_child("MailUser")->add_child_text (_mail_user);
@@ -444,6 +502,23 @@ Config::write_config_xml () const
        }
 
        root->add_child("CinemasFile")->add_child_text (_cinemas_file.string());
+       root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0");
+       root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0");
+       root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ());
+       root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ());
+       root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ());
+       root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ());
+       root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0");
+       for (int i = 0; i < NAG_COUNT; ++i) {
+               xmlpp::Element* e = root->add_child ("Nagged");
+               e->set_attribute ("Id", raw_convert<string>(i));
+               e->add_child_text (_nagged[i] ? "1" : "0");
+       }
+       root->add_child("PreviewSound")->add_child_text (_preview_sound ? "1" : "0");
+       if (_preview_sound_output) {
+               root->add_child("PreviewSoundOutput")->add_child_text (_preview_sound_output.get());
+       }
+       root->add_child("CoverSheet")->add_child_text (_cover_sheet);
 
        try {
                doc.write_to_file_formatted (path("config.xml").string ());
@@ -455,7 +530,7 @@ Config::write_config_xml () const
 }
 
 void
-Config::write_cinemas_xml () const
+Config::write_cinemas () const
 {
        xmlpp::Document doc;
        xmlpp::Element* root = doc.create_root_node ("Cinemas");
@@ -477,17 +552,29 @@ Config::write_cinemas_xml () const
 boost::filesystem::path
 Config::default_directory_or (boost::filesystem::path a) const
 {
-       if (_default_directory.empty()) {
+       return directory_or (_default_directory, a);
+}
+
+boost::filesystem::path
+Config::default_kdm_directory_or (boost::filesystem::path a) const
+{
+       return directory_or (_default_kdm_directory, a);
+}
+
+boost::filesystem::path
+Config::directory_or (optional<boost::filesystem::path> dir, boost::filesystem::path a) const
+{
+       if (!dir) {
                return a;
        }
 
        boost::system::error_code ec;
-       bool const e = boost::filesystem::exists (_default_directory, ec);
+       bool const e = boost::filesystem::exists (*dir, ec);
        if (ec || !e) {
                return a;
        }
 
-       return _default_directory;
+       return *dir;
 }
 
 void
@@ -500,7 +587,6 @@ Config::drop ()
 void
 Config::changed (Property what)
 {
-       cout << what << " changed in config.\n";
        Changed (what);
 }
 
@@ -526,6 +612,18 @@ Config::reset_kdm_email ()
        changed ();
 }
 
+void
+Config::set_cover_sheet_to_default ()
+{
+       _cover_sheet = _(
+               "$CPL_NAME\n\n"
+               "Type: $TYPE\n"
+               "Format: $CONTAINER\n"
+               "Audio: $AUDIO\n"
+               "Length: $LENGTH\n"
+               );
+}
+
 void
 Config::add_to_history (boost::filesystem::path p)
 {
@@ -575,3 +673,61 @@ Config::set_cinemas_file (boost::filesystem::path file)
 
        changed (OTHER);
 }
+
+void
+Config::save_template (shared_ptr<const Film> film, string name) const
+{
+       film->write_template (template_path (name));
+}
+
+list<string>
+Config::templates () const
+{
+       if (!boost::filesystem::exists (path ("templates"))) {
+               return list<string> ();
+       }
+
+       list<string> n;
+       for (boost::filesystem::directory_iterator i (path("templates")); i != boost::filesystem::directory_iterator(); ++i) {
+               n.push_back (i->path().filename().string());
+       }
+       return n;
+}
+
+bool
+Config::existing_template (string name) const
+{
+       return boost::filesystem::exists (template_path (name));
+}
+
+boost::filesystem::path
+Config::template_path (string name) const
+{
+       return path("templates") / tidy_for_filename (name);
+}
+
+void
+Config::rename_template (string old_name, string new_name) const
+{
+       boost::filesystem::rename (template_path (old_name), template_path (new_name));
+}
+
+void
+Config::delete_template (string name) const
+{
+       boost::filesystem::remove (template_path (name));
+}
+
+/** @return Path to the config.xml, for telling the user what it is */
+boost::filesystem::path
+Config::config_path ()
+{
+       return path("config.xml", false);
+}
+
+void
+Config::reset_cover_sheet ()
+{
+       set_cover_sheet_to_default ();
+       changed ();
+}