X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.cc;h=581620f832846f8a2f8e7418478fb43666dbc5ab;hp=9dd6f638e7c6e16ba29545f942dc1388ed887378;hb=96f7dd41a2c8627bc1ea0d24d84142eb04b4ffef;hpb=e6c52dcb012b441f2b0d3ba2345d91f2658644d2 diff --git a/src/lib/config.cc b/src/lib/config.cc index 9dd6f638e..581620f83 100644 --- a/src/lib/config.cc +++ b/src/lib/config.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2018 Carl Hetherington + Copyright (C) 2012-2019 Carl Hetherington This file is part of DCP-o-matic. @@ -24,7 +24,6 @@ #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" @@ -69,8 +68,7 @@ Config* Config::_instance = 0; int const Config::_current_version = 3; boost::signals2::signal Config::FailedToLoad; boost::signals2::signal Config::Warning; -boost::signals2::signal Config::BadSignerChain; -boost::optional Config::override_path; +boost::signals2::signal Config::Bad; /** Construct default configuration */ Config::Config () @@ -89,26 +87,27 @@ Config::set_defaults () _use_any_servers = true; _servers.clear (); _only_servers_encode = false; - _tms_protocol = PROTOCOL_SCP; + _tms_protocol = FILE_TRANSFER_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; _allow_any_container = false; + _show_experimental_audio_processors = 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_j2k_bandwidth = 150000000; _default_audio_delay = 0; _default_interop = true; _default_upload_after_make_dcp = false; _mail_server = ""; _mail_port = 25; + _mail_protocol = EMAIL_PROTOCOL_AUTO; _mail_user = ""; _mail_password = ""; _kdm_from = ""; @@ -167,8 +166,10 @@ Config::set_defaults () _interface_complexity = INTERFACE_SIMPLE; _player_mode = PLAYER_MODE_WINDOW; _image_display = 0; + _video_view_type = VIDEO_VIEW_SIMPLE; _respect_kdm_validity_periods = true; - _player_log_file = boost::none; + _player_activity_log_file = boost::none; + _player_debug_log_file = boost::none; _player_content_directory = boost::none; _player_playlist_directory = boost::none; _player_kdm_directory = boost::none; @@ -179,6 +180,8 @@ Config::set_defaults () _player_watermark_period = 1; _player_watermark_duration = 50; _player_lock_file = boost::none; + _signer_chain_path = "signer"; + _decryption_chain_path = "decryption"; #endif _allowed_dcp_frame_rates.clear (); @@ -283,25 +286,15 @@ try } _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_protocol = static_cast(f.optional_number_child("TMSProtocol").get_value_or(static_cast(FILE_TRANSFER_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 ()); - } - c = f.optional_string_child ("CinemaSoundProcessor"); - if (c) { - _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ()); - } - _language = f.optional_string_child ("Language"); - c = f.optional_string_child ("DefaultContainer"); + optional c = f.optional_string_child ("DefaultContainer"); if (c) { _default_container = Ratio::from_id (c.get ()); } @@ -345,6 +338,21 @@ try _mail_server = f.string_child ("MailServer"); _mail_port = f.optional_number_child ("MailPort").get_value_or (25); + + { + /* Make sure this matches the code in write_config */ + string const protocol = f.optional_string_child("MailProtocol").get_value_or("Auto"); + if (protocol == "Auto") { + _mail_protocol = EMAIL_PROTOCOL_AUTO; + } else if (protocol == "Plain") { + _mail_protocol = EMAIL_PROTOCOL_PLAIN; + } else if (protocol == "STARTTLS") { + _mail_protocol = EMAIL_PROTOCOL_STARTTLS; + } else if (protocol == "SSL") { + _mail_protocol = EMAIL_PROTOCOL_SSL; + } + } + _mail_user = f.optional_string_child("MailUser").get_value_or (""); _mail_password = f.optional_string_child("MailPassword").get_value_or (""); @@ -377,6 +385,7 @@ try _maximum_j2k_bandwidth = f.optional_number_child ("MaximumJ2KBandwidth").get_value_or (250000000); _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate").get_value_or (false); _allow_any_container = f.optional_bool_child ("AllowAnyContainer").get_value_or (false); + _show_experimental_audio_processors = f.optional_bool_child ("ShowExperimentalAudioProcessors").get_value_or (false); _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); @@ -394,6 +403,21 @@ try } cxml::NodePtr signer = f.optional_node_child ("Signer"); +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (signer && signer->node_children().size() == 1) { + /* The content of is a path to a file; if it's relative it's in the same + directory as .config. */ + _signer_chain_path = signer->content(); + if (_signer_chain_path.is_relative()) { + _signer_chain = read_swaroop_chain (path(_signer_chain_path.string())); + } else { + _signer_chain = read_swaroop_chain (_signer_chain_path); + } + } else { + /* is not present or has children: ignore it and remake. */ + _signer_chain = create_certificate_chain (); + } +#else if (signer) { shared_ptr c (new dcp::CertificateChain ()); /* Read the signing certificates and private key in from the config file */ @@ -406,8 +430,37 @@ try /* Make a new set of signing certificates and key */ _signer_chain = create_certificate_chain (); } +#endif + + cxml::NodePtr decryption = f.optional_node_child ("Decryption"); +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (decryption && decryption->node_children().size() == 1) { + /* The content of is a path to a file; if it's relative, it's in the same + directory as .config. */ + _decryption_chain_path = decryption->content(); + if (_decryption_chain_path.is_relative()) { + _decryption_chain = read_swaroop_chain (path(_decryption_chain_path.string())); + } else { + _decryption_chain = read_swaroop_chain (_decryption_chain_path); + } + } else { + /* is not present or has more children: ignore it and remake. */ + _decryption_chain = create_certificate_chain (); + } +#else + 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 (); + } +#endif - /* These must be done before we call BadSignerChain as that might set one + /* These must be done before we call Bad as that might set one of the nags. */ BOOST_FOREACH (cxml::NodePtr i, f.node_children("Nagged")) { @@ -417,42 +470,35 @@ try } } - bool bad_signer_chain = false; + optional bad; + BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) { if (i.has_utf8_strings()) { - bad_signer_chain = true; + bad = BAD_SIGNER_UTF8_STRINGS; } } - if (bad_signer_chain) { - optional const remake = BadSignerChain(); - if (remake && *remake) { - _signer_chain = create_certificate_chain (); - } + if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) { + bad = BAD_SIGNER_INCONSISTENT; } - 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 ())); - } - optional key = decryption->optional_string_child ("PrivateKey"); -#ifdef DCPOMATIC_VARIANT_SWAROOP - if (key) { - c->set_key (*key); - } else { - dcp::Data encrypted_key (path("private")); - dcp::Data iv (path("iv")); - c->set_key (dcpomatic::decrypt (encrypted_key, key_from_uuid(), iv)); + if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) { + bad = BAD_DECRYPTION_INCONSISTENT; + } + + if (bad) { + optional const remake = Bad(*bad); + if (remake && *remake) { + switch (*bad) { + case BAD_SIGNER_UTF8_STRINGS: + case BAD_SIGNER_INCONSISTENT: + _signer_chain = create_certificate_chain (); + break; + case BAD_DECRYPTION_INCONSISTENT: + _decryption_chain = create_certificate_chain (); + break; + } } -#else - DCPOMATIC_ASSERT (key); - c->set_key (*key); -#endif - _decryption_chain = c; - } else { - _decryption_chain = create_certificate_chain (); } if (f.optional_node_child("DKDMGroup")) { @@ -528,8 +574,19 @@ try } _image_display = f.optional_number_child("ImageDisplay").get_value_or(0); + optional vc = f.optional_string_child("VideoViewType"); + if (vc && *vc == "opengl") { + _video_view_type = VIDEO_VIEW_OPENGL; + } else if (vc && *vc == "simple") { + _video_view_type = VIDEO_VIEW_SIMPLE; + } _respect_kdm_validity_periods = f.optional_bool_child("RespectKDMValidityPeriods").get_value_or(true); - _player_log_file = f.optional_string_child("PlayerLogFile"); + /* PlayerLogFile is old name */ + _player_activity_log_file = f.optional_string_child("PlayerLogFile"); + if (!_player_activity_log_file) { + _player_activity_log_file = f.optional_string_child("PlayerActivityLogFile"); + } + _player_debug_log_file = f.optional_string_child("PlayerDebugLogFile"); _player_content_directory = f.optional_string_child("PlayerContentDirectory"); _player_playlist_directory = f.optional_string_child("PlayerPlaylistDirectory"); _player_kdm_directory = f.optional_string_child("PlayerKDMDirectory"); @@ -566,33 +623,6 @@ catch (...) { write (); } -/** @return Filename to write configuration to */ -boost::filesystem::path -Config::path (string file, bool create_directories) -{ - boost::filesystem::path p; - if (override_path) { - p = *override_path; - } else { -#ifdef DCPOMATIC_OSX - p /= g_get_home_dir (); - p /= "Library"; - p /= "Preferences"; - p /= "com.dcpomatic"; - p /= "2"; -#else - p /= g_get_user_config_dir (); - p /= "dcpomatic2"; -#endif - } - boost::system::error_code ec; - if (create_directories) { - boost::filesystem::create_directories (p, ec); - } - p /= file; - return p; -} - /** @return Singleton instance */ Config * Config::instance () @@ -613,27 +643,14 @@ Config::write () const write_cinemas (); } -#ifdef DCPOMATIC_VARIANT_SWAROOP -/* Make up a key from the machine UUID */ -dcp::Data -Config::key_from_uuid () const -{ - dcp::Data key (dcpomatic::crypto_key_length()); - memset (key.data().get(), 0, key.size()); - string const magic = command_and_read ("dcpomatic2_uuid"); - strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length()); - return key; -} -#endif - 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 */ - root->add_child("Version")->add_child_text (String::compose ("%1", _current_version)); + /* [XML] Version The version number of the configuration file format. */ + root->add_child("Version")->add_child_text (raw_convert(_current_version)); /* [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. */ @@ -663,20 +680,14 @@ Config::write_config () const 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 */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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()); @@ -706,6 +717,7 @@ Config::write_config () const 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] DefaultUploadAfterMakeDCP 1 to default to uploading to a TMS after making a DCP, 0 to default to no upload. */ root->add_child("DefaultUploadAfterMakeDCP")->add_child_text (_default_upload_after_make_dcp ? "1" : "0"); /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <ContentVersion>, @@ -732,6 +744,21 @@ Config::write_config () const 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] MailProtocol Protocol to use on SMTP server (Auto, Plain, STARTTLS or SSL) */ + switch (_mail_protocol) { + case EMAIL_PROTOCOL_AUTO: + root->add_child("MailProtocol")->add_child_text("Auto"); + break; + case EMAIL_PROTOCOL_PLAIN: + root->add_child("MailProtocol")->add_child_text("Plain"); + break; + case EMAIL_PROTOCOL_STARTTLS: + root->add_child("MailProtocol")->add_child_text("STARTTLS"); + break; + case EMAIL_PROTOCOL_SSL: + root->add_child("MailProtocol")->add_child_text("SSL"); + break; + } /* [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. */ @@ -745,37 +772,39 @@ Config::write_config () const /* [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 */ + /* [XML] KDMBCC BCC address to use for KDM emails. */ root->add_child("KDMBCC")->add_child_text (_kdm_bcc); - /* [XML] KDMEmail Text of KDM email */ + /* [XML] KDMEmail Text of KDM email. */ root->add_child("KDMEmail")->add_child_text (_kdm_email); - /* [XML] NotificationSubject Subject to use for Notification emails. */ + /* [XML] NotificationSubject Subject to use for notification emails. */ root->add_child("NotificationSubject")->add_child_text (_notification_subject); - /* [XML] NotificationFrom From address to use for Notification emails. */ + /* [XML] NotificationFrom From address to use for notification emails. */ root->add_child("NotificationFrom")->add_child_text (_notification_from); - /* [XML] NotificationFrom To address to use for Notification emails. */ + /* [XML] NotificationFrom To address to use for notification emails. */ root->add_child("NotificationTo")->add_child_text (_notification_to); BOOST_FOREACH (string i, _notification_cc) { - /* [XML] NotificationCC CC address to use for Notification emails; you can use as many of these tags as you like. */ + /* [XML] NotificationCC CC address to use for notification emails; you can use as many of these tags as you like. */ root->add_child("NotificationCC")->add_child_text (i); } - /* [XML] NotificationBCC BCC address to use for Notification emails */ + /* [XML] NotificationBCC BCC address to use for notification emails. */ root->add_child("NotificationBCC")->add_child_text (_notification_bcc); - /* [XML] NotificationEmail Text of Notification email */ + /* [XML] NotificationEmail Text of notification email. */ root->add_child("NotificationEmail")->add_child_text (_notification_email); - /* [XML] CheckForUpdates 1 to check dcpomatic.com for new versions, 0 to check only on request */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers */ + /* [XML] AllowAnyContainer 1 to allow users to user any container ratio for their DCP, 0 to limit the GUI to standard containers. */ root->add_child("AllowAnyContainer")->add_child_text (_allow_any_container ? "1" : "0"); + /* [XML] ShowExperimentalAudioProcessors 1 to offer users the (experimental) audio upmixer processors, 0 to hide them */ + root->add_child("ShowExperimentalAudioProcessors")->add_child_text (_show_experimental_audio_processors ? "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. @@ -790,6 +819,14 @@ Config::write_config () const root->add_child("Win32Console")->add_child_text (_win32_console ? "1" : "0"); #endif +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (_signer_chain_path.is_relative()) { + write_swaroop_chain (_signer_chain, path(_signer_chain_path.string())); + } else { + write_swaroop_chain (_signer_chain, _signer_chain_path); + } + root->add_child("Signer")->add_child_text(_signer_chain_path.string()); +#else /* [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. */ @@ -799,19 +836,22 @@ Config::write_config () const signer->add_child("Certificate")->add_child_text (i.certificate (true)); } signer->add_child("PrivateKey")->add_child_text (_signer_chain->key().get ()); +#endif +#ifdef DCPOMATIC_VARIANT_SWAROOP + if (_decryption_chain_path.is_relative()) { + write_swaroop_chain (_decryption_chain, path(_decryption_chain_path.string())); + } else { + write_swaroop_chain (_decryption_chain, _decryption_chain_path); + } + root->add_child("Decryption")->add_child_text(_decryption_chain_path.string()); +#else /* [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)); } -#ifdef DCPOMATIC_VARIANT_SWAROOP - dcp::Data iv = dcpomatic::random_iv (); - dcp::Data encrypted_key = dcpomatic::encrypt (_decryption_chain->key().get(), key_from_uuid(), iv); - encrypted_key.write (path("private")); - iv.write (path("iv")); -#else decryption->add_child("PrivateKey")->add_child_text (_decryption_chain->key().get ()); #endif @@ -822,6 +862,9 @@ Config::write_config () const root->add_child("History")->add_child_text (i.string ()); } + /* [XML] History Filename of DCP to present in the File menu of the player; there can be more than one + of these tags. + */ BOOST_FOREACH (boost::filesystem::path i, _player_history) { root->add_child("PlayerHistory")->add_child_text (i.string ()); } @@ -832,39 +875,40 @@ Config::write_config () const /* [XML] DKDM A DKDM as XML */ _dkdms->as_xml (root); - /* [XML] CinemasFile Filename of cinemas list file */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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) */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [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 */ + /* [XML:opt] PreviewSoundOutput Name of the audio output to use. */ root->add_child("PreviewSoundOutput")->add_child_text (_sound_output.get()); } - /* [XML] CoverSheet Text of the cover sheet to write when making DCPs */ + /* [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] LastKDMWriteType Last type of KDM-write: flat for a flat file, folder for a folder or zip for a ZIP file. */ if (_last_kdm_write_type) { switch (_last_kdm_write_type.get()) { case KDM_WRITE_FLAT: @@ -878,6 +922,7 @@ Config::write_config () const break; } } + /* [XML] LastDKDMWriteType Last type of DKDM-write: file for a file, internal to add to DCP-o-matic's list. */ if (_last_dkdm_write_type) { switch (_last_dkdm_write_type.get()) { case DKDM_WRITE_INTERNAL: @@ -893,15 +938,15 @@ Config::write_config () const */ root->add_child("FramesInMemoryMultiplier")->add_child_text(raw_convert(_frames_in_memory_multiplier)); - /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player */ + /* [XML] DecodeReduction power of 2 to reduce DCP images by before decoding in the player. */ if (_decode_reduction) { root->add_child("DecodeReduction")->add_child_text(raw_convert(_decode_reduction.get())); } - /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0 */ + /* [XML] DefaultNotify 1 to default jobs to notify when complete, otherwise 0. */ root->add_child("DefaultNotify")->add_child_text(_default_notify ? "1" : "0"); - /* [XML] Notification 1 if a notification type is enabled, otherwise 0 */ + /* [XML] Notification 1 if a notification type is enabled, otherwise 0. */ for (int i = 0; i < NOTIFICATION_COUNT; ++i) { xmlpp::Element* e = root->add_child ("Notification"); e->set_attribute ("Id", raw_convert(i)); @@ -909,26 +954,33 @@ Config::write_config () const } if (_barco_username) { + /* [XML] BarcoUsername Username for logging into Barco's servers when downloading server certificates. */ root->add_child("BarcoUsername")->add_child_text(*_barco_username); } if (_barco_password) { + /* [XML] BarcoPassword Password for logging into Barco's servers when downloading server certificates. */ root->add_child("BarcoPassword")->add_child_text(*_barco_password); } if (_christie_username) { + /* [XML] ChristieUsername Username for logging into Christie's servers when downloading server certificates. */ root->add_child("ChristieUsername")->add_child_text(*_christie_username); } if (_christie_password) { + /* [XML] ChristiePassword Password for logging into Christie's servers when downloading server certificates. */ root->add_child("ChristiePassword")->add_child_text(*_christie_password); } if (_gdc_username) { + /* [XML] GCCUsername Username for logging into GDC's servers when downloading server certificates. */ root->add_child("GDCUsername")->add_child_text(*_gdc_username); } if (_gdc_password) { + /* [XML] GCCPassword Password for logging into GDC's servers when downloading server certificates. */ root->add_child("GDCPassword")->add_child_text(*_gdc_password); } + /* [XML] InterfaceComplexity simple for the reduced interface or full for the full interface. */ switch (_interface_complexity) { case INTERFACE_SIMPLE: root->add_child("InterfaceComplexity")->add_child_text("simple"); @@ -938,6 +990,9 @@ Config::write_config () const break; } + /* [XML] PlayerMode window for a single window, full for full-screen and dual for full screen playback + with controls on another monitor. + */ switch (_player_mode) { case PLAYER_MODE_WINDOW: root->add_child("PlayerMode")->add_child_text("window"); @@ -950,18 +1005,36 @@ Config::write_config () const break; } + /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */ root->add_child("ImageDisplay")->add_child_text(raw_convert(_image_display)); + switch (_video_view_type) { + case VIDEO_VIEW_SIMPLE: + root->add_child("VideoViewType")->add_child_text("simple"); + break; + case VIDEO_VIEW_OPENGL: + root->add_child("VideoViewType")->add_child_text("opengl"); + break; + } + /* [XML] RespectKDMValidityPeriods 1 to refuse to use KDMs that are out of date, 0 to ignore KDM dates. */ root->add_child("RespectKDMValidityPeriods")->add_child_text(_respect_kdm_validity_periods ? "1" : "0"); - if (_player_log_file) { - root->add_child("PlayerLogFile")->add_child_text(_player_log_file->string()); + if (_player_activity_log_file) { + /* [XML] PlayerLogFile Filename to use for player activity logs (e.g starting, stopping, playlist loads) */ + root->add_child("PlayerActivityLogFile")->add_child_text(_player_activity_log_file->string()); + } + if (_player_debug_log_file) { + /* [XML] PlayerLogFile Filename to use for player debug logs */ + root->add_child("PlayerDebugLogFile")->add_child_text(_player_debug_log_file->string()); } if (_player_content_directory) { + /* [XML] PlayerContentDirectory Directory to use for player content in the dual-screen mode. */ root->add_child("PlayerContentDirectory")->add_child_text(_player_content_directory->string()); } if (_player_playlist_directory) { + /* [XML] PlayerPlaylistDirectory Directory to use for player playlists in the dual-screen mode. */ root->add_child("PlayerPlaylistDirectory")->add_child_text(_player_playlist_directory->string()); } if (_player_kdm_directory) { + /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */ root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string()); } #ifdef DCPOMATIC_VARIANT_SWAROOP @@ -1121,12 +1194,26 @@ Config::add_to_history (boost::filesystem::path p) add_to_history_internal (_history, p); } +/** Remove non-existant items from the history */ +void +Config::clean_history () +{ + clean_history_internal (_history); +} + void Config::add_to_player_history (boost::filesystem::path p) { add_to_history_internal (_player_history, p); } +/** Remove non-existant items from the player history */ +void +Config::clean_player_history () +{ + clean_history_internal (_player_history); +} + void Config::add_to_history_internal (vector& h, boost::filesystem::path p) { @@ -1141,6 +1228,22 @@ Config::add_to_history_internal (vector& h, boost::file changed (HISTORY); } +void +Config::clean_history_internal (vector& h) +{ + vector old = h; + h.clear (); + BOOST_FOREACH (boost::filesystem::path i, old) { + try { + if (boost::filesystem::is_directory(i)) { + h.push_back (i); + } + } catch (...) { + /* We couldn't find out if it's a directory for some reason; just ignore it */ + } + } +} + bool Config::have_existing (string file) {