/*
- Copyright (C) 2012-2015 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/>.
*/
#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>
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 ()
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 ();
_language = optional<string> ();
_default_still_length = 10;
_default_container = Ratio::from_id ("185");
+ _default_scale_to = 0;
_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 = "";
_mail_password = "";
_kdm_from = "";
- _kdm_cc = "";
+ _kdm_cc.clear ();
_kdm_bcc = "";
_check_for_updates = false;
_check_for_test_updates = false;
_maximum_j2k_bandwidth = 250000000;
_log_types = LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR;
+ _analyse_ebur128 = true;
_automatic_audio_analysis = false;
#ifdef DCPOMATIC_WINDOWS
_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);
_allowed_dcp_frame_rates.push_back (60);
set_kdm_email_to_default ();
+ set_cover_sheet_to_default ();
}
void
void
Config::read ()
+try
{
- if (!have_existing ()) {
- /* 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;
- }
-
cxml::Document f ("Config");
- f.read_file (file ());
+ 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) {
_default_container = Ratio::from_id (c.get ());
}
+ c = f.optional_string_child ("DefaultScaleTo");
+ if (c) {
+ _default_scale_to = Ratio::from_id (c.get ());
+ }
+
c = f.optional_string_child ("DefaultDCPContentType");
if (c) {
_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")) {
_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");
- list<cxml::NodePtr> cin = f.node_children ("Cinema");
- for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
- /* Slightly grotty two-part construction of Cinema here so that we can use
- shared_from_this.
- */
- shared_ptr<Cinema> cinema (new Cinema (*i));
- cinema->read_screens (*i);
- _cinemas.push_back (cinema);
- }
+ /* Load any cinemas from config.xml */
+ read_cinemas (f);
_mail_server = f.string_child ("MailServer");
_mail_port = f.optional_number_child<int> ("MailPort").get_value_or (25);
_mail_password = f.optional_string_child("MailPassword").get_value_or ("");
_kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
_kdm_from = f.string_child ("KDMFrom");
- _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
+ BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("KDMCC")) {
+ if (!i->content().empty()) {
+ _kdm_cc.push_back (i->content ());
+ }
+ }
_kdm_bcc = f.optional_string_child ("KDMBCC").get_value_or ("");
_kdm_email = f.string_child ("KDMEmail");
_allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false);
_log_types = f.optional_number_child<int> ("LogTypes").get_value_or (LogEntry::TYPE_GENERAL | LogEntry::TYPE_WARNING | LogEntry::TYPE_ERROR);
+ _analyse_ebur128 = f.optional_bool_child("AnalyseEBUR128").get_value_or (true);
_automatic_audio_analysis = f.optional_bool_child ("AutomaticAudioAnalysis").get_value_or (false);
#ifdef DCPOMATIC_WINDOWS
_win32_console = f.optional_bool_child ("Win32Console").get_value_or (false);
_dkdms.push_back (dcp::EncryptedKDM (i->content ()));
}
+ _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)) {
+ cxml::Document f ("Cinemas");
+ f.read_file (_cinemas_file);
+ 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
-Config::file (bool create_directories)
+Config::path (string file, bool create_directories)
{
boost::filesystem::path p;
#ifdef DCPOMATIC_OSX
if (create_directories) {
boost::filesystem::create_directories (p, ec);
}
- p /= "config.xml";
+ p /= file;
return p;
}
{
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;
/** Write our configuration to disk */
void
Config::write () const
+{
+ write_config ();
+ write_cinemas ();
+}
+
+void
+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");
}
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);
if (_default_container) {
root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
}
+ if (_default_scale_to) {
+ root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ());
+ }
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);
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");
-
- for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
- (*i)->as_xml (root->add_child ("Cinema"));
+ 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);
root->add_child("MailPassword")->add_child_text (_mail_password);
root->add_child("KDMSubject")->add_child_text (_kdm_subject);
root->add_child("KDMFrom")->add_child_text (_kdm_from);
- root->add_child("KDMCC")->add_child_text (_kdm_cc);
+ BOOST_FOREACH (string i, _kdm_cc) {
+ root->add_child("KDMCC")->add_child_text (i);
+ }
root->add_child("KDMBCC")->add_child_text (_kdm_bcc);
root->add_child("KDMEmail")->add_child_text (_kdm_email);
root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
+ root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0");
root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0");
#ifdef DCPOMATIC_WINDOWS
root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0");
#endif
xmlpp::Element* signer = root->add_child ("Signer");
+ DCPOMATIC_ASSERT (_signer_chain);
BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->root_to_leaf ()) {
signer->add_child("Certificate")->add_child_text (i.certificate (true));
}
signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ());
xmlpp::Element* decryption = root->add_child ("Decryption");
+ DCPOMATIC_ASSERT (_decryption_chain);
BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->root_to_leaf ()) {
decryption->add_child("Certificate")->add_child_text (i.certificate (true));
}
root->add_child("DKDM")->add_child_text (i.as_xml ());
}
+ 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 ());
+ } catch (xmlpp::exception& e) {
+ string s = e.what ();
+ trim (s);
+ throw FileError (s, path("config.xml"));
+ }
+}
+
+void
+Config::write_cinemas () const
+{
+ xmlpp::Document doc;
+ xmlpp::Element* root = doc.create_root_node ("Cinemas");
+ root->add_child("Version")->add_child_text ("1");
+
+ for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
+ (*i)->as_xml (root->add_child ("Cinema"));
+ }
+
try {
- doc.write_to_file_formatted (file().string ());
+ doc.write_to_file_formatted (_cinemas_file.string ());
} catch (xmlpp::exception& e) {
string s = e.what ();
trim (s);
- throw FileError (s, file ());
+ throw FileError (s, _cinemas_file);
}
}
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
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)
{
}
bool
-Config::have_existing ()
+Config::have_existing (string file)
+{
+ return boost::filesystem::exists (path (file, false));
+}
+
+void
+Config::read_cinemas (cxml::Document const & f)
+{
+ _cinemas.clear ();
+ list<cxml::NodePtr> cin = f.node_children ("Cinema");
+ for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
+ /* Slightly grotty two-part construction of Cinema here so that we can use
+ shared_from_this.
+ */
+ shared_ptr<Cinema> cinema (new Cinema (*i));
+ cinema->read_screens (*i);
+ _cinemas.push_back (cinema);
+ }
+}
+
+void
+Config::set_cinemas_file (boost::filesystem::path file)
+{
+ _cinemas_file = file;
+
+ if (boost::filesystem::exists (_cinemas_file)) {
+ /* Existing file; read it in */
+ cxml::Document f ("Cinemas");
+ f.read_file (_cinemas_file);
+ read_cinemas (f);
+ }
+
+ 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 boost::filesystem::exists (file (false));
+ 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 ();
}