Add defaults for facility, studio, chain, distributor (#2075).
[dcpomatic.git] / src / lib / config.cc
index eae57cc06f365195683780fb9d4c8358a576bcf4..ed00d274bd0e78664453ace902e927a9460e7e48 100644 (file)
@@ -88,7 +88,7 @@ Config::set_defaults ()
        _use_any_servers = true;
        _servers.clear ();
        _only_servers_encode = false;
-       _tms_protocol = FILE_TRANSFER_PROTOCOL_SCP;
+       _tms_protocol = FileTransferProtocol::SCP;
        _tms_ip = "";
        _tms_path = ".";
        _tms_user = "";
@@ -103,11 +103,12 @@ Config::set_defaults ()
        _default_dcp_audio_channels = 6;
        _default_j2k_bandwidth = 150000000;
        _default_audio_delay = 0;
-       _default_interop = true;
+       _default_interop = false;
+       _default_metadata.clear ();
        _upload_after_make_dcp = false;
        _mail_server = "";
        _mail_port = 25;
-       _mail_protocol = EMAIL_PROTOCOL_AUTO;
+       _mail_protocol = EmailProtocol::AUTO;
        _mail_user = "";
        _mail_password = "";
        _kdm_from = "";
@@ -175,6 +176,8 @@ Config::set_defaults ()
        _player_playlist_directory = boost::none;
        _player_kdm_directory = boost::none;
        _audio_mapping = boost::none;
+       _custom_languages.clear ();
+       _add_files_path = boost::none;
 
        _allowed_dcp_frame_rates.clear ();
        _allowed_dcp_frame_rates.push_back (24);
@@ -269,7 +272,7 @@ try
        }
 
        _only_servers_encode = f.optional_bool_child ("OnlyServersEncode").get_value_or (false);
-       _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FILE_TRANSFER_PROTOCOL_SCP)));
+       _tms_protocol = static_cast<FileTransferProtocol>(f.optional_number_child<int>("TMSProtocol").get_value_or(static_cast<int>(FileTransferProtocol::SCP)));
        _tms_ip = f.string_child ("TMSIP");
        _tms_path = f.string_child ("TMSPath");
        _tms_user = f.string_child ("TMSUser");
@@ -307,16 +310,15 @@ try
        _dcp_product_version = f.optional_string_child("DCPProductVersion").get_value_or("");
        _dcp_j2k_comment = f.optional_string_child("DCPJ2KComment").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<int>("DefaultStillLength").get_value_or (10);
        _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);
+
+       for (auto const& i: f.node_children("DefaultMetadata")) {
+               _default_metadata[i->string_attribute("key")] = i->content();
+       }
+
        _default_kdm_directory = f.optional_string_child("DefaultKDMDirectory");
 
        /* Read any cinemas that are still lying around in the config file
@@ -331,13 +333,13 @@ try
                /* 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;
+                       _mail_protocol = EmailProtocol::AUTO;
                } else if (protocol == "Plain") {
-                       _mail_protocol = EMAIL_PROTOCOL_PLAIN;
+                       _mail_protocol = EmailProtocol::PLAIN;
                } else if (protocol == "STARTTLS") {
-                       _mail_protocol = EMAIL_PROTOCOL_STARTTLS;
+                       _mail_protocol = EmailProtocol::STARTTLS;
                } else if (protocol == "SSL") {
-                       _mail_protocol = EMAIL_PROTOCOL_SSL;
+                       _mail_protocol = EmailProtocol::SSL;
                }
        }
 
@@ -549,6 +551,17 @@ try
                _audio_mapping = AudioMapping (f.node_child("AudioMapping"), Film::current_state_version);
        }
 
+       for (auto i: f.node_children("CustomLanguage")) {
+               try {
+                       /* This will fail if it's called before dcp::init() as it won't recognise the
+                        * tag.  That's OK because the Config will be reloaded again later.
+                        */
+                       _custom_languages.push_back (dcp::LanguageTag(i->content()));
+               } catch (std::runtime_error& e) {}
+       }
+
+       _add_files_path = f.optional_string_child("AddFilesPath");
+
        if (boost::filesystem::exists (_cinemas_file)) {
                cxml::Document f ("Cinemas");
                f.read_file (_cinemas_file);
@@ -662,7 +675,7 @@ Config::write_config () const
        root->add_child("DefaultDCPAudioChannels")->add_child_text (raw_convert<string> (_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. */
+       /* [XML] DCPCreator Creator text to write into CPL files. */
        root->add_child("DCPCreator")->add_child_text (_dcp_creator);
        /* [XML] Company name to write into MXF files. */
        root->add_child("DCPCompanyName")->add_child_text (_dcp_company_name);
@@ -675,14 +688,6 @@ Config::write_config () const
        /* [XML] UploadAfterMakeDCP 1 to upload to a TMS after making a DCP, 0 for no upload. */
        root->add_child("UploadAfterMakeDCP")->add_child_text (_upload_after_make_dcp ? "1" : "0");
 
-       /* [XML] ISDCFMetadata Default ISDCF metadata to use for new films; child tags are <code>&lt;ContentVersion&gt;</code>,
-          <code>&lt;AudioLanguage&gt;</code>, <code>&lt;SubtitleLanguage&gt;</code>, <code>&lt;Territory&gt;</code>,
-          <code>&lt;Rating&gt;</code>, <code>&lt;Studio&gt;</code>, <code>&lt;Facility&gt;</code>, <code>&lt;TempVersion&gt;</code>,
-          <code>&lt;PreRelease&gt;</code>, <code>&lt;RedBand&gt;</code>, <code>&lt;Chain&gt;</code>, <code>&lt;TwoDVersionOFThreeD&gt;</code>,
-          <code>&lt;MasteredLuminance&gt;</code>.
-       */
-       _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<string> (_default_still_length));
        /* [XML] DefaultJ2KBandwidth Default bitrate (in bits per second) for JPEG2000 data in new films. */
@@ -691,6 +696,11 @@ Config::write_config () const
        root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
        /* [XML] DefaultInterop 1 to default new films to Interop, 0 for SMPTE. */
        root->add_child("DefaultInterop")->add_child_text (_default_interop ? "1" : "0");
+       for (auto const& i: _default_metadata) {
+               auto c = root->add_child("DefaultMetadata");
+               c->set_attribute("key", i.first);
+               c->add_child_text(i.second);
+       }
        if (_default_kdm_directory) {
                /* [XML:opt] DefaultKDMDirectory Default directory to write KDMs to. */
                root->add_child("DefaultKDMDirectory")->add_child_text (_default_kdm_directory->string ());
@@ -701,16 +711,16 @@ Config::write_config () const
        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:
+       case EmailProtocol::AUTO:
                root->add_child("MailProtocol")->add_child_text("Auto");
                break;
-       case EMAIL_PROTOCOL_PLAIN:
+       case EmailProtocol::PLAIN:
                root->add_child("MailProtocol")->add_child_text("Plain");
                break;
-       case EMAIL_PROTOCOL_STARTTLS:
+       case EmailProtocol::STARTTLS:
                root->add_child("MailProtocol")->add_child_text("STARTTLS");
                break;
-       case EMAIL_PROTOCOL_SSL:
+       case EmailProtocol::SSL:
                root->add_child("MailProtocol")->add_child_text("SSL");
                break;
        }
@@ -771,8 +781,13 @@ Config::write_config () const
        /* [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");
+       if (_win32_console) {
+               /* [XML] Win32Console 1 to open a console when running on Windows, otherwise 0.
+                * We only write this if it's true, which is a bit of a hack to allow unit tests to work
+                * more easily on Windows (without a platform-specific reference in config_write_utf8_test)
+                */
+               root->add_child("Win32Console")->add_child_text ("1");
+       }
 #endif
 
        /* [XML] Signer Certificate chain and private key to use when signing DCPs and KDMs.  Should contain <code>&lt;Certificate&gt;</code>
@@ -972,6 +987,13 @@ Config::write_config () const
        if (_audio_mapping) {
                _audio_mapping->as_xml (root->add_child("AudioMapping"));
        }
+       for (auto const& i: _custom_languages) {
+               root->add_child("CustomLanguage")->add_child_text(i.to_string());
+       }
+       if (_add_files_path) {
+               /* [XML] The default path that will be offered in the picker when adding files to a film */
+               root->add_child("AddFilesPath")->add_child_text(_add_files_path->string());
+       }
 
        try {
                auto const s = doc.write_to_string_formatted ();
@@ -980,7 +1002,7 @@ Config::write_config () const
                if (!f) {
                        throw FileError (_("Could not open file for writing"), tmp);
                }
-               checked_fwrite (s.c_str(), s.length(), f, tmp);
+               checked_fwrite (s.c_str(), s.bytes(), f, tmp);
                fclose (f);
                boost::filesystem::remove (config_file());
                boost::filesystem::rename (tmp, config_file());
@@ -1376,14 +1398,14 @@ Config::audio_mapping (int output_channels)
                           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
+                       _audio_mapping->set (dcp::Channel::LEFT,   0, 1 / sqrt(2));  // L   -> Lt
+                       _audio_mapping->set (dcp::Channel::RIGHT,  1, 1 / sqrt(2));  // R   -> Rt
+                       _audio_mapping->set (dcp::Channel::CENTRE, 0, 1 / 2.0);      // C   -> Lt
+                       _audio_mapping->set (dcp::Channel::CENTRE, 1, 1 / 2.0);      // C   -> Rt
+                       _audio_mapping->set (dcp::Channel::LFE,    0, 1 / sqrt(10)); // Lfe -> Lt
+                       _audio_mapping->set (dcp::Channel::LFE,    1, 1 / sqrt(10)); // Lfe -> Rt
+                       _audio_mapping->set (dcp::Channel::LS,     0, 1 / sqrt(2));  // Ls  -> Lt
+                       _audio_mapping->set (dcp::Channel::RS,     1, 1 / sqrt(2));  // Rs  -> Rt
                } else {
                        /* 1:1 mapping */
                        for (int i = 0; i < min (MAX_DCP_AUDIO_CHANNELS, output_channels); ++i) {
@@ -1411,3 +1433,14 @@ Config::set_audio_mapping_to_default ()
        _audio_mapping = audio_mapping (ch);
        changed (AUDIO_MAPPING);
 }
+
+
+void
+Config::add_custom_language (dcp::LanguageTag tag)
+{
+       if (find(_custom_languages.begin(), _custom_languages.end(), tag) == _custom_languages.end()) {
+               _custom_languages.push_back (tag);
+               changed ();
+       }
+}
+