Another macOS std::list boost::thread SNAFU.
[dcpomatic.git] / src / lib / config.cc
index 99ed74b29bc27d53c27fb0cfcecf36dfd38e6580..7f32320dfb3f49e50fab88d2d20dcee39deb9e8b 100644 (file)
@@ -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"
@@ -54,6 +53,7 @@ using std::cout;
 using std::ifstream;
 using std::string;
 using std::list;
+using std::min;
 using std::max;
 using std::remove;
 using std::exception;
@@ -69,8 +69,7 @@ Config* Config::_instance = 0;
 int const Config::_current_version = 3;
 boost::signals2::signal<void ()> Config::FailedToLoad;
 boost::signals2::signal<void (string)> Config::Warning;
-boost::signals2::signal<bool (void)> Config::BadSignerChain;
-boost::optional<boost::filesystem::path> Config::override_path;
+boost::signals2::signal<bool (Config::BadReason)> Config::Bad;
 
 /** Construct default configuration */
 Config::Config ()
@@ -89,26 +88,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<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_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,11 +167,14 @@ 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;
+       _audio_mapping = boost::none;
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        _player_background_image = boost::none;
        _kdm_server_url = "http://localhost:8000/{CPL}";
@@ -285,25 +288,15 @@ try
        }
 
        _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
-       _tms_protocol = static_cast<Protocol> (f.optional_number_child<int> ("TMSProtocol").get_value_or (static_cast<int> (PROTOCOL_SCP)));
+       _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(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<string> 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<string> c = f.optional_string_child ("DefaultContainer");
        if (c) {
                _default_container = Ratio::from_id (c.get ());
        }
@@ -347,6 +340,21 @@ try
 
        _mail_server = f.string_child ("MailServer");
        _mail_port = f.optional_number_child<int> ("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 ("");
 
@@ -379,6 +387,7 @@ try
        _maximum_j2k_bandwidth = f.optional_number_child<int> ("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<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);
@@ -425,30 +434,6 @@ try
        }
 #endif
 
-       /* These must be done before we call BadSignerChain as that might set one
-          of the nags.
-       */
-       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());
-               }
-       }
-
-       bool bad_signer_chain = false;
-       BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
-               if (i.has_utf8_strings()) {
-                       bad_signer_chain = true;
-               }
-       }
-
-       if (bad_signer_chain) {
-               optional<bool> const remake = BadSignerChain();
-               if (remake && *remake) {
-                       _signer_chain = create_certificate_chain ();
-               }
-       }
-
        cxml::NodePtr decryption = f.optional_node_child ("Decryption");
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        if (decryption && decryption->node_children().size() == 1) {
@@ -476,6 +461,48 @@ try
                _decryption_chain = create_certificate_chain ();
        }
 #endif
+
+       /* 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")) {
+               int const id = i->number_attribute<int>("Id");
+               if (id >= 0 && id < NAG_COUNT) {
+                       _nagged[id] = raw_convert<int>(i->content());
+               }
+       }
+
+       optional<BadReason> bad;
+
+       BOOST_FOREACH (dcp::Certificate const & i, _signer_chain->unordered()) {
+               if (i.has_utf8_strings()) {
+                       bad = BAD_SIGNER_UTF8_STRINGS;
+               }
+       }
+
+       if (!_signer_chain->chain_valid() || !_signer_chain->private_key_valid()) {
+               bad = BAD_SIGNER_INCONSISTENT;
+       }
+
+       if (!_decryption_chain->chain_valid() || !_decryption_chain->private_key_valid()) {
+               bad = BAD_DECRYPTION_INCONSISTENT;
+       }
+
+       if (bad) {
+               optional<bool> 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;
+                       }
+               }
+       }
+
        if (f.optional_node_child("DKDMGroup")) {
                /* New-style: all DKDMs in a group */
                _dkdms = dynamic_pointer_cast<DKDMGroup> (DKDMBase::read (f.node_child("DKDMGroup")));
@@ -549,11 +576,27 @@ try
        }
 
        _image_display = f.optional_number_child<int>("ImageDisplay").get_value_or(0);
+       optional<string> 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");
+
+       if (f.optional_node_child("AudioMapping")) {
+               _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
+       }
+
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        _player_background_image = f.optional_string_child("PlayerBackgroundImage");
        _kdm_server_url = f.optional_string_child("KDMServerURL").get_value_or("http://localhost:8000/{CPL}");
@@ -587,33 +630,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 ()
@@ -641,7 +657,7 @@ Config::write_config () const
        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));
+       root->add_child("Version")->add_child_text (raw_convert<string>(_current_version));
        /* [XML] MasterEncodingThreads Number of encoding threads to use when running as master. */
        root->add_child("MasterEncodingThreads")->add_child_text (raw_convert<string> (_master_encoding_threads));
        /* [XML] ServerEncodingThreads Number of encoding threads to use when running as server. */
@@ -679,12 +695,6 @@ Config::write_config () const
        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 <code>dolby_cp750</code>.
-               */
-               root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
-       }
        if (_language) {
                /* [XML:opt] Language Language to use in the GUI e.g. <code>fr_FR</code>. */
                root->add_child("Language")->add_child_text (_language.get());
@@ -741,6 +751,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<string> (_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. */
@@ -785,6 +810,8 @@ Config::write_config () const
        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. */
        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.
@@ -987,24 +1014,39 @@ Config::write_config () const
 
        /* [XML] ImageDisplay Screen number to put image on in dual-screen player mode. */
        root->add_child("ImageDisplay")->add_child_text(raw_convert<string>(_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) {
-               /* [XML] PlayerLogFile Filename to use for player logs */
-               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 Filename to use for player content in the dual-screen mode. */
+               /* [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 Filename to use for player playlists in the dual-screen mode. */
+               /* [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 Filename to use for player KDMs in the dual-screen mode. */
+               /* [XML] PlayerKDMDirectory Directory to use for player KDMs in the dual-screen mode. */
                root->add_child("PlayerKDMDirectory")->add_child_text(_player_kdm_directory->string());
        }
+       if (_audio_mapping) {
+               _audio_mapping->as_xml (root->add_child("AudioMapping"));
+       }
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        if (_player_background_image) {
                root->add_child("PlayerBackgroundImage")->add_child_text(_player_background_image->string());
@@ -1162,12 +1204,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<boost::filesystem::path>& h, boost::filesystem::path p)
 {
@@ -1182,6 +1238,22 @@ Config::add_to_history_internal (vector<boost::filesystem::path>& h, boost::file
        changed (HISTORY);
 }
 
+void
+Config::clean_history_internal (vector<boost::filesystem::path>& h)
+{
+       vector<boost::filesystem::path> 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)
 {
@@ -1333,3 +1405,53 @@ Config::have_write_permission () const
        fclose (f);
        return true;
 }
+
+/** @param  output_channels Number of output channels in use.
+ *  @return Audio mapping for this output channel count (may be a default).
+ */
+AudioMapping
+Config::audio_mapping (int output_channels)
+{
+       if (!_audio_mapping || _audio_mapping->output_channels() != output_channels) {
+               /* Set up a default */
+               _audio_mapping = AudioMapping (MAX_DCP_AUDIO_CHANNELS, output_channels);
+               if (output_channels == 2) {
+                       /* Special case for stereo output.
+                          Map so that Lt = L(-3dB) + Ls(-3dB) + C(-6dB) + Lfe(-10dB)
+                          Rt = R(-3dB) + Rs(-3dB) + C(-6dB) + Lfe(-10dB)
+                       */
+                       _audio_mapping->set (dcp::LEFT,   0, 1 / sqrt(2));  // L   -> Lt
+                       _audio_mapping->set (dcp::RIGHT,  1, 1 / sqrt(2));  // R   -> Rt
+                       _audio_mapping->set (dcp::CENTRE, 0, 1 / 2.0);      // C   -> Lt
+                       _audio_mapping->set (dcp::CENTRE, 1, 1 / 2.0);      // C   -> Rt
+                       _audio_mapping->set (dcp::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
+                       _audio_mapping->set (dcp::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
+                       _audio_mapping->set (dcp::LS,     0, 1 / sqrt(2));  // Ls  -> Lt
+                       _audio_mapping->set (dcp::RS,     1, 1 / sqrt(2));  // Rs  -> Rt
+               } else {
+                       /* 1:1 mapping */
+                       for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
+                               _audio_mapping->set (i, i, 1);
+                       }
+               }
+       }
+
+       return *_audio_mapping;
+}
+
+void
+Config::set_audio_mapping (AudioMapping m)
+{
+       _audio_mapping = m;
+       changed (AUDIO_MAPPING);
+}
+
+void
+Config::set_audio_mapping_to_default ()
+{
+       DCPOMATIC_ASSERT (_audio_mapping);
+       int const ch = _audio_mapping->output_channels ();
+       _audio_mapping = boost::none;
+       _audio_mapping = audio_mapping (ch);
+       changed (AUDIO_MAPPING);
+}