X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fconfig.cc;h=8dabcb71dcd4d1ff70f82155ab635192218d84b0;hb=35c0a33f8da3b1f99ec32a8c42f578cbc063e7e4;hp=e726acee189498b4b9ef75d6cda1de63c5821e70;hpb=635e9a1f0de1a7a8ec573e04391ccc83ee457d72;p=dcpomatic.git diff --git a/src/lib/config.cc b/src/lib/config.cc index e726acee1..8dabcb71d 100644 --- a/src/lib/config.cc +++ b/src/lib/config.cc @@ -1,42 +1,49 @@ /* - Copyright (C) 2012-2015 Carl Hetherington + Copyright (C) 2012-2017 Carl Hetherington - 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 . */ #include "config.h" -#include "server.h" #include "filter.h" #include "ratio.h" +#include "types.h" +#include "log.h" #include "dcp_content_type.h" #include "cinema_sound_processor.h" #include "colour_conversion.h" #include "cinema.h" #include "util.h" #include "cross.h" -#include "raw_convert.h" -#include -#include +#include "film.h" +#include "dkdm_wrapper.h" +#include +#include #include #include #include +#include #include #include +#include +#include #include #include +#include #include "i18n.h" @@ -51,12 +58,18 @@ using std::exception; using std::cerr; using boost::shared_ptr; using boost::optional; +using boost::dynamic_pointer_cast; using boost::algorithm::trim; +using dcp::raw_convert; Config* Config::_instance = 0; +boost::signals2::signal Config::FailedToLoad; +boost::signals2::signal Config::Warning; /** Construct default configuration */ Config::Config () + /* DKDMs are not considered a thing to reset on set_defaults() */ + : _dkdms (new DKDMGroup ("root")) { set_defaults (); } @@ -64,24 +77,68 @@ 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 (); + _only_servers_encode = false; + _tms_protocol = PROTOCOL_SCP; + _tms_ip = ""; _tms_path = "."; + _tms_user = ""; + _tms_password = ""; _cinema_sound_processor = CinemaSoundProcessor::from_id (N_("dolby_cp750")); _allow_any_dcp_frame_rate = false; + _language = optional (); _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 = true; + _mail_server = ""; + _mail_port = 25; + _mail_user = ""; + _mail_password = ""; + _kdm_from = ""; + _kdm_cc.clear (); + _kdm_bcc = ""; _check_for_updates = false; _check_for_test_updates = false; _maximum_j2k_bandwidth = 250000000; - _log_types = Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR | Log::TYPE_DEBUG; -#ifdef DCPOMATIC_WINDOWS + _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 +#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; + } + _sound = false; + _sound_output = optional (); + + /* I think the scaling factor here should be the ratio of the longest frame + encode time to the shortest; if the thread count is T, longest time is L + and the shortest time S we could encode L/S frames per thread whilst waiting + for the L frame to encode so we might have to store LT/S frames. + + However we don't want to use too much memory, so keep it a bit lower than we'd + perhaps like. A J2K frame is typically about 1Mb so 3 here will mean we could + use about 240Mb with 72 encoding threads. + */ + _frames_in_memory_multiplier = 3; _allowed_dcp_frame_rates.clear (); _allowed_dcp_frame_rates.push_back (24); @@ -92,6 +149,7 @@ Config::set_defaults () _allowed_dcp_frame_rates.push_back (60); set_kdm_email_to_default (); + set_cover_sheet_to_default (); } void @@ -101,25 +159,42 @@ Config::restore_defaults () Config::instance()->changed (); } +shared_ptr +Config::create_certificate_chain () +{ + return shared_ptr ( + new dcp::CertificateChain ( + openssl_path(), + "dcpomatic.com", + "dcpomatic.com", + ".dcpomatic.smpte-430-2.ROOT", + ".dcpomatic.smpte-430-2.INTERMEDIATE", + "CS.dcpomatic.smpte-430-2.LEAF" + ) + ); +} + void Config::read () +try { - if (!boost::filesystem::exists (file ())) { - /* Make a new set of signing certificates and key */ - _signer.reset (new dcp::Signer (openssl_path ())); - /* And decryption keys */ - make_decryption_keys (); - return; - } - cxml::Document f ("Config"); - f.read_file (file ()); - optional c; + f.read_file (config_file ()); optional version = f.optional_number_child ("Version"); - _num_local_encoding_threads = f.number_child ("NumLocalEncodingThreads"); - _default_directory = f.string_child ("DefaultDirectory"); + if (f.optional_number_child("NumLocalEncodingThreads")) { + _master_encoding_threads = _server_encoding_threads = f.optional_number_child("NumLocalEncodingThreads").get(); + } else { + _master_encoding_threads = f.number_child("MasterEncodingThreads"); + _server_encoding_threads = f.number_child("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::optional b = f.optional_number_child ("ServerPort"); if (!b) { @@ -130,20 +205,22 @@ Config::read () boost::optional u = f.optional_bool_child ("UseAnyServers"); _use_any_servers = u.get_value_or (true); - list servers = f.node_children ("Server"); - for (list::iterator i = servers.begin(); i != servers.end(); ++i) { - if ((*i)->node_children("HostName").size() == 1) { - _servers.push_back ((*i)->string_child ("HostName")); + BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Server")) { + if (i->node_children("HostName").size() == 1) { + _servers.push_back (i->string_child ("HostName")); } else { - _servers.push_back ((*i)->content ()); + _servers.push_back (i->content ()); } } - + + _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false); + _tms_protocol = static_cast (f.optional_number_child ("TMSProtocol").get_value_or (static_cast (PROTOCOL_SCP))); _tms_ip = f.string_child ("TMSIP"); _tms_path = f.string_child ("TMSPath"); _tms_user = f.string_child ("TMSUser"); _tms_password = f.string_child ("TMSPassword"); + optional c; c = f.optional_string_child ("SoundProcessor"); if (c) { _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ()); @@ -160,43 +237,57 @@ Config::read () _default_container = Ratio::from_id (c.get ()); } + if (_default_container && !_default_container->used_for_container()) { + Warning (_("Your default container is not valid and has been changed to Flat (1.85:1)")); + _default_container = Ratio::from_id ("185"); + } + + 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("DefaultDCPAudioChannels").get_value_or (6); + if (f.optional_string_child ("DCPMetadataIssuer")) { _dcp_issuer = f.string_child ("DCPMetadataIssuer"); } else if (f.optional_string_child ("DCPIssuer")) { _dcp_issuer = f.string_child ("DCPIssuer"); } - + + _dcp_creator = f.optional_string_child ("DCPCreator").get_value_or (""); + if (version && version.get() >= 2) { _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata")); } else { _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata")); } - + _default_still_length = f.optional_number_child("DefaultStillLength").get_value_or (10); _default_j2k_bandwidth = f.optional_number_child("DefaultJ2KBandwidth").get_value_or (200000000); _default_audio_delay = f.optional_number_child("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 cin = f.node_children ("Cinema"); - for (list::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 (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 ("MailPort").get_value_or (25); _mail_user = f.optional_string_child("MailUser").get_value_or (""); _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"); @@ -204,59 +295,109 @@ Config::read () _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false); _maximum_j2k_bandwidth = f.optional_number_child ("MaximumJ2KBandwidth").get_value_or (250000000); - _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate"); + _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false); - _log_types = f.optional_number_child ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR); -#ifdef DCPOMATIC_WINDOWS + _log_types = f.optional_number_child ("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); -#endif +#endif list his = f.node_children ("History"); - for (list::const_iterator i = his.begin(); i != his.end(); ++i) { - _history.push_back ((*i)->content ()); + BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("History")) { + _history.push_back (i->content ()); } cxml::NodePtr signer = f.optional_node_child ("Signer"); - dcp::CertificateChain signer_chain; if (signer) { + shared_ptr c (new dcp::CertificateChain ()); /* Read the signing certificates and private key in from the config file */ - list certificates = signer->node_children ("Certificate"); - for (list::const_iterator i = certificates.begin(); i != certificates.end(); ++i) { - signer_chain.add (dcp::Certificate ((*i)->content ())); + BOOST_FOREACH (cxml::NodePtr i, signer->node_children ("Certificate")) { + c->add (dcp::Certificate (i->content ())); } - - _signer.reset (new dcp::Signer (signer_chain, signer->string_child ("PrivateKey"))); + c->set_key (signer->string_child ("PrivateKey")); + _signer_chain = c; } else { /* Make a new set of signing certificates and key */ - _signer.reset (new dcp::Signer (openssl_path ())); + _signer_chain = create_certificate_chain (); } - if (f.optional_string_child ("DecryptionCertificate")) { - _decryption_certificate = dcp::Certificate (f.string_child ("DecryptionCertificate")); + cxml::NodePtr decryption = f.optional_node_child ("Decryption"); + if (decryption) { + shared_ptr c (new dcp::CertificateChain ()); + BOOST_FOREACH (cxml::NodePtr i, decryption->node_children ("Certificate")) { + c->add (dcp::Certificate (i->content ())); + } + c->set_key (decryption->string_child ("PrivateKey")); + _decryption_chain = c; + } else { + _decryption_chain = create_certificate_chain (); } - if (f.optional_string_child ("DecryptionPrivateKey")) { - _decryption_private_key = f.string_child ("DecryptionPrivateKey"); + if (f.optional_node_child("DKDMGroup")) { + /* New-style: all DKDMs in a group */ + _dkdms = dynamic_pointer_cast (DKDMBase::read (f.node_child("DKDMGroup"))); + } else { + /* Old-style: one or more DKDM nodes */ + _dkdms.reset (new DKDMGroup ("root")); + BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("DKDM")) { + _dkdms->add (DKDMBase::read (i)); + } } - - if (!f.optional_string_child ("DecryptionCertificate") || !f.optional_string_child ("DecryptionPrivateKey")) { - /* Generate our own decryption certificate and key if either is not present in config */ - make_decryption_keys (); + _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("Id"); + if (id >= 0 && id < NAG_COUNT) { + _nagged[id] = raw_convert(i->content()); + } + } + /* The variable was renamed but not the XML tag */ + _sound = f.optional_bool_child("PreviewSound").get_value_or (false); + _sound_output = f.optional_string_child("PreviewSoundOutput"); + if (f.optional_string_child("CoverSheet")) { + _cover_sheet = f.optional_string_child("CoverSheet").get(); + } + _last_player_load_directory = f.optional_string_child("LastPlayerLoadDirectory"); + _frames_in_memory_multiplier = f.optional_number_child("FramesInMemoryMultiplier").get_value_or(3); + + /* 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")) { -void -Config::make_decryption_keys () -{ - boost::filesystem::path p = dcp::make_certificate_chain (openssl_path ()); - _decryption_certificate = dcp::Certificate (dcp::file_to_string (p / "leaf.signed.pem")); - _decryption_private_key = dcp::file_to_string (p / "leaf.key"); - boost::filesystem::remove_all (p); + /* 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 () const +Config::path (string file, bool create_directories) { boost::filesystem::path p; #ifdef DCPOMATIC_OSX @@ -270,8 +411,10 @@ Config::file () const p /= "dcpomatic2"; #endif boost::system::error_code ec; - boost::filesystem::create_directories (p, ec); - p /= "config.xml"; + if (create_directories) { + boost::filesystem::create_directories (p, ec); + } + p /= file; return p; } @@ -281,16 +424,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: failed to load configuration (" << e.what() << ")\n"; - } catch (...) { - cerr << "dcpomatic: failed to load configuration\n"; - } + _instance->read (); } return _instance; @@ -299,104 +433,280 @@ Config::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"); + /* [XML] Version The version number of the configuration file format; currently 2. */ root->add_child("Version")->add_child_text ("2"); - root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert (_num_local_encoding_threads)); - root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ()); + /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */ + root->add_child("MasterEncodingThreads")->add_child_text (raw_convert (_master_encoding_threads)); + /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */ + root->add_child("ServerEncodingThreads")->add_child_text (raw_convert (_server_encoding_threads)); + if (_default_directory) { + /* [XML:opt] DefaultDirectory Default directory when creating a new film in the GUI. */ + root->add_child("DefaultDirectory")->add_child_text (_default_directory->string ()); + } + /* [XML] ServerPortBase Port number to use for frame encoding requests. ServerPortBase + 1 and + ServerPortBase + 2 are used for querying servers. ServerPortBase + 3 is used + by the batch converter to listen for job requests. + */ root->add_child("ServerPortBase")->add_child_text (raw_convert (_server_port_base)); + /* [XML] UseAnyServers 1 to broadcast to look for encoding servers to use, 0 to use only those configured. */ root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0"); - - for (vector::const_iterator i = _servers.begin(); i != _servers.end(); ++i) { - root->add_child("Server")->add_child_text (*i); + + BOOST_FOREACH (string i, _servers) { + /* [XML:opt] Server IP address or hostname of an encoding server to use; you can use as many of these tags + as you like. + */ + root->add_child("Server")->add_child_text (i); } + /* [XML] OnlyServersEncode 1 to set the master to do decoding of source content no JPEG2000 encoding; all encoding + is done by the encoding servers. 0 to set the master to do some encoding as well as coordinating the job. + */ + root->add_child("OnlyServersEncode")->add_child_text (_only_servers_encode ? "1" : "0"); + /* [XML] TMSProtocol Protocol to use to copy files to a TMS; 0 to use SCP, 1 for FTP. */ + root->add_child("TMSProtocol")->add_child_text (raw_convert (static_cast (_tms_protocol))); + /* [XML] TMSIP IP address of TMS */ root->add_child("TMSIP")->add_child_text (_tms_ip); + /* [XML] TMSPath Path on the TMS to copy files to */ root->add_child("TMSPath")->add_child_text (_tms_path); + /* [XML] TMSUser Username to log into the TMS with */ root->add_child("TMSUser")->add_child_text (_tms_user); + /* [XML] TMSPassword Password to log into the TMS with */ root->add_child("TMSPassword")->add_child_text (_tms_password); if (_cinema_sound_processor) { + /* [XML:opt] CinemaSoundProcessor Identifier of the type of cinema sound processor to use when calculating + gain changes from fader positions. Currently can only be dolby_cp750. + */ root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ()); } if (_language) { + /* [XML:opt] Language Language to use in the GUI e.g. fr_FR. */ root->add_child("Language")->add_child_text (_language.get()); } if (_default_container) { + /* [XML:opt] DefaultContainer ID of default container + * to use when creating new films (185,239 or + * full-frame). + */ root->add_child("DefaultContainer")->add_child_text (_default_container->id ()); } + if (_default_scale_to) { + /* [XML:opt] DefaultScaleTo ID of default ratio to scale content to when creating new films + (see DefaultContainer for IDs). + */ + root->add_child("DefaultScaleTo")->add_child_text (_default_scale_to->id ()); + } if (_default_dcp_content_type) { + /* [XML:opt] DefaultDCPContentType Default content type ot use when creating new films (FTR, SHR, + TLR, TST, XSN, RTG, TSR, POL, + PSA or ADV). */ root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ()); } + /* [XML] DefaultDCPAudioChannels Default number of audio channels to use when creating new films. */ + root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert (_default_dcp_audio_channels)); + /* [XML] DCPIssuer Issuer text to write into CPL files. */ root->add_child("DCPIssuer")->add_child_text (_dcp_issuer); - + /* [XML] DCPIssuer Creator text to write into CPL files. */ + root->add_child("DCPCreator")->add_child_text (_dcp_creator); + + /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <ContentVersion>, + <AudioLanguage>, <SubtitleLanguage>, <Territory>, + <Rating>, <Studio>, <Facility>, <TempVersion>, + <PreRelease>, <RedBand>, <Chain>, <TwoDVersionOFThreeD>, + <MasteredLuminance>. + */ _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata")); + /* [XML] DefaultStillLength Default length (in seconds) for still images in new films. */ root->add_child("DefaultStillLength")->add_child_text (raw_convert (_default_still_length)); + /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */ root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert (_default_j2k_bandwidth)); + /* [XML] DefaultAudioDelay Default delay to apply to audio (positive moves audio later) in milliseconds. */ root->add_child("DefaultAudioDelay")->add_child_text (raw_convert (_default_audio_delay)); - - for (list >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) { - (*i)->as_xml (root->add_child ("Cinema")); + /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */ + root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0"); + if (_default_kdm_directory) { + /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */ + root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ()); } - + /* [XML] MailServer Hostname of SMTP server to use. */ root->add_child("MailServer")->add_child_text (_mail_server); + /* [XML] MailPort Port number to use on SMTP server. */ + root->add_child("MailPort")->add_child_text (raw_convert (_mail_port)); + /* [XML] MailUser Username to use on SMTP server. */ root->add_child("MailUser")->add_child_text (_mail_user); + /* [XML] MailPassword Password to use on SMTP server. */ root->add_child("MailPassword")->add_child_text (_mail_password); + /* [XML] KDMSubject Subject to use for KDM emails. */ root->add_child("KDMSubject")->add_child_text (_kdm_subject); + /* [XML] KDMFrom From address to use for KDM emails. */ root->add_child("KDMFrom")->add_child_text (_kdm_from); - root->add_child("KDMCC")->add_child_text (_kdm_cc); + BOOST_FOREACH (string i, _kdm_cc) { + /* [XML] KDMCC CC address to use for KDM emails; you can use as many of these tags as you like. */ + root->add_child("KDMCC")->add_child_text (i); + } + /* [XML] KDMBCC BCC address to use for KDM emails */ root->add_child("KDMBCC")->add_child_text (_kdm_bcc); + /* [XML] KDMEmail Text of KDM email */ root->add_child("KDMEmail")->add_child_text (_kdm_email); + /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */ root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0"); + /* [XML] CheckForUpdates 1 to check dcpomatic.com for new text versions, 0 to check only on request */ root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0"); + /* [XML] MaximumJ2KBandwidth Maximum J2K bandwidth (in bits per second) that can be specified in the GUI */ root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert (_maximum_j2k_bandwidth)); + /* [XML] AllowAnyDCPFrameRate 1 to allow users to specify any frame rate when creating DCPs, 0 to limit the GUI to standard rates */ root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0"); + /* [XML] LogTypes Types of logging to write; a bitfield where 1 is general notes, 2 warnings, 4 errors, 8 debug information related + to encoding, 16 debug information related to encoding, 32 debug information for timing purposes, 64 debug information related + to sending email. + */ root->add_child("LogTypes")->add_child_text (raw_convert (_log_types)); -#ifdef DCPOMATIC_WINDOWS + /* [XML] AnalyseEBUR128 1 to do EBUR128 analyses when analysing audio, otherwise 0. */ + root->add_child("AnalyseEBUR128")->add_child_text (_analyse_ebur128 ? "1" : "0"); + /* [XML] AutomaticAudioAnalysis 1 to run audio analysis automatically when audio content is added to the film, otherwise 0. */ + root->add_child("AutomaticAudioAnalysis")->add_child_text (_automatic_audio_analysis ? "1" : "0"); +#ifdef DCPOMATIC_WINDOWS + /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0. */ root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0"); -#endif +#endif + /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs. Should contain <Certificate> + tags in order and a <PrivateKey> tag all containing PEM-encoded certificates or private keys as appropriate. + */ xmlpp::Element* signer = root->add_child ("Signer"); - dcp::CertificateChain::List certs = _signer->certificates().root_to_leaf (); - for (dcp::CertificateChain::List::const_iterator i = certs.begin(); i != certs.end(); ++i) { - signer->add_child("Certificate")->add_child_text (i->certificate (true)); + DCPOMATIC_ASSERT (_signer_chain); + BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) { + signer->add_child("Certificate")->add_child_text (i.certificate (true)); + } + signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ()); + + /* [XML] Decryption Certificate chain and private key to use when decrypting KDMs */ + xmlpp::Element* decryption = root->add_child ("Decryption"); + DCPOMATIC_ASSERT (_decryption_chain); + BOOST_FOREACH (dcp::Certificate const & i, _decryption_chain->unordered()) { + decryption->add_child("Certificate")->add_child_text (i.certificate (true)); + } + decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ()); + + /* [XML] History Filename of DCP to present in the File menu of the GUI; there can be more than one + of these tags. + */ + BOOST_FOREACH (boost::filesystem::path i, _history) { + root->add_child("History")->add_child_text (i.string ()); + } + + /* [XML] DKDMGroup A group of DKDMs, each with a Name attribute, containing other <DKDMGroup> + or <DKDM> tags. + */ + /* [XML] DKDM A DKDM as XML */ + _dkdms->as_xml (root); + + /* [XML] CinemasFile Filename of cinemas list file */ + root->add_child("CinemasFile")->add_child_text (_cinemas_file.string()); + /* [XML] ShowHintsBeforeMakeDCP 1 to show hints in the GUI before making a DCP, otherwise 0 */ + root->add_child("ShowHintsBeforeMakeDCP")->add_child_text (_show_hints_before_make_dcp ? "1" : "0"); + /* [XML] ConfirmKDMEmail 1 to confirm before sending KDM emails in the GUI, otherwise 0 */ + root->add_child("ConfirmKDMEmail")->add_child_text (_confirm_kdm_email ? "1" : "0"); + /* [XML] KDMFilenameFormat Format for KDM filenames */ + root->add_child("KDMFilenameFormat")->add_child_text (_kdm_filename_format.specification ()); + /* [XML] KDMContainerNameFormat Format for KDM containers (directories or ZIP files) */ + root->add_child("KDMContainerNameFormat")->add_child_text (_kdm_container_name_format.specification ()); + /* [XML] DCPMetadataFilenameFormat Format for DCP metadata filenames */ + root->add_child("DCPMetadataFilenameFormat")->add_child_text (_dcp_metadata_filename_format.specification ()); + /* [XML] DCPAssetFilenameFormat Format for DCP asset filenames */ + root->add_child("DCPAssetFilenameFormat")->add_child_text (_dcp_asset_filename_format.specification ()); + /* [XML] JumpToSelected 1 to make the GUI jump to the start of content when it is selected, otherwise 0 */ + root->add_child("JumpToSelected")->add_child_text (_jump_to_selected ? "1" : "0"); + /* [XML] Nagged 1 if a particular nag screen has been shown and should not be shown again, otherwise 0 */ + for (int i = 0; i < NAG_COUNT; ++i) { + xmlpp::Element* e = root->add_child ("Nagged"); + e->set_attribute ("Id", raw_convert(i)); + e->add_child_text (_nagged[i] ? "1" : "0"); + } + /* [XML] PreviewSound 1 to use sound in the GUI preview and player, otherwise 0 */ + root->add_child("PreviewSound")->add_child_text (_sound ? "1" : "0"); + if (_sound_output) { + /* [XML:opt] PreviewSoundOutput Name of the audio output to use */ + root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get()); } - signer->add_child("PrivateKey")->add_child_text (_signer->key ()); + /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */ + root->add_child("CoverSheet")->add_child_text (_cover_sheet); + if (_last_player_load_directory) { + root->add_child("LastPlayerLoadDirectory")->add_child_text(_last_player_load_directory->string()); + } + /* [XML] FramesInMemoryMultiplier value to multiply the encoding threads count by to get the maximum number of + frames to be held in memory at once. + */ + root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert(_frames_in_memory_multiplier)); - root->add_child("DecryptionCertificate")->add_child_text (_decryption_certificate.certificate (true)); - root->add_child("DecryptionPrivateKey")->add_child_text (_decryption_private_key); + try { + doc.write_to_file_formatted(config_file().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 (vector::const_iterator i = _history.begin(); i != _history.end(); ++i) { - root->add_child("History")->add_child_text (i->string ()); + BOOST_FOREACH (shared_ptr i, _cinemas) { + 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 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 @@ -407,14 +717,16 @@ Config::drop () } void -Config::changed () +Config::changed (Property what) { - Changed (); + Changed (what); } void Config::set_kdm_email_to_default () { + _kdm_subject = _("KDM delivery: $CPL_NAME"); + _kdm_email = _( "Dear Projectionist\n\n" "Please find attached KDMs for $CPL_NAME.\n\n" @@ -432,12 +744,27 @@ 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" + "Audio Language: $AUDIO_LANGUAGE\n" + "Subtitle Language: $SUBTITLE_LANGUAGE\n" + "Length: $LENGTH\n" + "Size: $SIZE\n" + ); +} + void Config::add_to_history (boost::filesystem::path p) { /* Remove existing instances of this path in the history */ _history.erase (remove (_history.begin(), _history.end(), p), _history.end ()); - + _history.insert (_history.begin (), p); if (_history.size() > HISTORY_SIZE) { _history.pop_back (); @@ -445,3 +772,133 @@ Config::add_to_history (boost::filesystem::path p) changed (); } + +bool +Config::have_existing (string file) +{ + return boost::filesystem::exists (path (file, false)); +} + +void +Config::read_cinemas (cxml::Document const & f) +{ + _cinemas.clear (); + list cin = f.node_children ("Cinema"); + BOOST_FOREACH (cxml::ConstNodePtr i, f.node_children("Cinema")) { + /* Slightly grotty two-part construction of Cinema here so that we can use + shared_from_this. + */ + shared_ptr 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 film, string name) const +{ + film->write_template (template_path (name)); +} + +list +Config::templates () const +{ + if (!boost::filesystem::exists (path ("templates"))) { + return list (); + } + + list 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 containing the actual settings, following a link if required */ +boost::filesystem::path +Config::config_file () +{ + cxml::Document f ("Config"); + boost::filesystem::path main = path("config.xml", false); + if (!boost::filesystem::exists (main)) { + /* It doesn't exist, so there can't be any links; just return it */ + return main; + } + + /* See if there's a link */ + f.read_file (main); + optional link = f.optional_string_child("Link"); + if (link) { + return *link; + } + + return main; +} + +void +Config::reset_cover_sheet () +{ + set_cover_sheet_to_default (); + changed (); +} + +void +Config::link (boost::filesystem::path new_file) const +{ + xmlpp::Document doc; + doc.create_root_node("Config")->add_child("Link")->add_child_text(new_file.string()); + try { + doc.write_to_file_formatted(path("config.xml", true).string()); + } catch (xmlpp::exception& e) { + string s = e.what (); + trim (s); + throw FileError (s, path("config.xml")); + } +} + +void +Config::copy_and_link (boost::filesystem::path new_file) const +{ + write (); + boost::filesystem::copy_file (config_file(), new_file, boost::filesystem::copy_option::overwrite_if_exists); + link (new_file); +}