src/lib/config.cc

   1 /*
   2     Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <sstream>
  21 #include <cstdlib>
  22 #include <fstream>
  23 #include <glib.h>
  24 #include <boost/filesystem.hpp>
  25 #include <boost/algorithm/string.hpp>
  26 #include <dcp/colour_matrix.h>
  27 #include <dcp/raw_convert.h>
  28 #include <libcxml/cxml.h>
  29 #include "config.h"
  30 #include "server.h"
  31 #include "scaler.h"
  32 #include "filter.h"
  33 #include "ratio.h"
  34 #include "dcp_content_type.h"
  35 #include "cinema_sound_processor.h"
  36 #include "colour_conversion.h"
  37 #include "cinema.h"
  38 #include "util.h"
  39
  40 #include "i18n.h"
  41
  42 using std::vector;
  43 using std::ifstream;
  44 using std::string;
  45 using std::list;
  46 using std::max;
  47 using std::exception;
  48 using std::cerr;
  49 using boost::shared_ptr;
  50 using boost::optional;
  51 using boost::algorithm::is_any_of;
  52 using boost::algorithm::split;
  53 using dcp::raw_convert;
  54
  55 Config* Config::_instance = 0;
  56
  57 /** Construct default configuration */
  58 Config::Config ()
  59         : _num_local_encoding_threads (max (2U, boost::thread::hardware_concurrency()))
  60         , _server_port_base (6192)
  61         , _use_any_servers (true)
  62         , _tms_path (".")
  63         , _cinema_sound_processor (CinemaSoundProcessor::from_id (N_("dolby_cp750")))
  64         , _allow_any_dcp_frame_rate (false)
  65         , _default_still_length (10)
  66         , _default_container (Ratio::from_id ("185"))
  67         , _default_dcp_content_type (DCPContentType::from_isdcf_name ("TST"))
  68         , _default_j2k_bandwidth (100000000)
  69         , _default_audio_delay (0)
  70         , _check_for_updates (false)
  71         , _check_for_test_updates (false)
  72         , _maximum_j2k_bandwidth (250000000)
  73         , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
  74 {
  75         _allowed_dcp_frame_rates.push_back (24);
  76         _allowed_dcp_frame_rates.push_back (25);
  77         _allowed_dcp_frame_rates.push_back (30);
  78         _allowed_dcp_frame_rates.push_back (48);
  79         _allowed_dcp_frame_rates.push_back (50);
  80         _allowed_dcp_frame_rates.push_back (60);
  81
  82         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6));
  83         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, dcp::colour_matrix::srgb_to_xyz, 2.6));
  84         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
  85
  86         reset_kdm_email ();
  87 }
  88
  89 void
  90 Config::read ()
  91 {
  92         if (!boost::filesystem::exists (file (false))) {
  93                 return;
  94         }
  95
  96         cxml::Document f ("Config");
  97         f.read_file (file (false));
  98         optional<string> c;
  99
 100         optional<int> version = f.optional_number_child<int> ("Version");
 101
 102         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 103         _default_directory = f.string_child ("DefaultDirectory");
 104
 105         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 106         if (!b) {
 107                 b = f.optional_number_child<int> ("ServerPortBase");
 108         }
 109         _server_port_base = b.get ();
 110
 111         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 112         _use_any_servers = u.get_value_or (true);
 113
 114         list<cxml::NodePtr> servers = f.node_children ("Server");
 115         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 116                 if ((*i)->node_children("HostName").size() == 1) {
 117                         _servers.push_back ((*i)->string_child ("HostName"));
 118                 } else {
 119                         _servers.push_back ((*i)->content ());
 120                 }
 121         }
 122
 123         _tms_ip = f.string_child ("TMSIP");
 124         _tms_path = f.string_child ("TMSPath");
 125         _tms_user = f.string_child ("TMSUser");
 126         _tms_password = f.string_child ("TMSPassword");
 127
 128         c = f.optional_string_child ("SoundProcessor");
 129         if (c) {
 130                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 131         }
 132         c = f.optional_string_child ("CinemaSoundProcessor");
 133         if (c) {
 134                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 135         }
 136
 137         _language = f.optional_string_child ("Language");
 138
 139         c = f.optional_string_child ("DefaultContainer");
 140         if (c) {
 141                 _default_container = Ratio::from_id (c.get ());
 142         }
 143
 144         c = f.optional_string_child ("DefaultDCPContentType");
 145         if (c) {
 146                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 147         }
 148
 149         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 150         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 151
 152         if (version && version.get() >= 2) {
 153                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 154         } else {
 155                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 156         }
 157
 158         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 159         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 160         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 161
 162         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 163
 164         if (!cc.empty ()) {
 165                 _colour_conversions.clear ();
 166         }
 167
 168         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 169                 _colour_conversions.push_back (PresetColourConversion (*i));
 170         }
 171
 172         if (!version) {
 173                 /* Loading version 0 (before Rec. 709 was added as a preset).
 174                    Add it in.
 175                 */
 176                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
 177         }
 178
 179         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 180         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 181                 /* Slightly grotty two-part construction of Cinema here so that we can use
 182                    shared_from_this.
 183                 */
 184                 shared_ptr<Cinema> cinema (new Cinema (*i));
 185                 cinema->read_screens (*i);
 186                 _cinemas.push_back (cinema);
 187         }
 188
 189         _mail_server = f.string_child ("MailServer");
 190         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 191         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 192         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 193         _kdm_from = f.string_child ("KDMFrom");
 194         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 195         _kdm_email = f.string_child ("KDMEmail");
 196
 197         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 198         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 199
 200         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 201         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 202
 203         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 204 }
 205
 206 /** @return Filename to write configuration to */
 207 boost::filesystem::path
 208 Config::file (bool old) const
 209 {
 210         boost::filesystem::path p;
 211         p /= g_get_user_config_dir ();
 212         boost::system::error_code ec;
 213         boost::filesystem::create_directory (p, ec);
 214         if (old) {
 215                 p /= ".dvdomatic";
 216         } else {
 217                 p /= "dcpomatic";
 218                 boost::filesystem::create_directory (p, ec);
 219                 p /= "config.xml";
 220         }
 221         return p;
 222 }
 223
 224 boost::filesystem::path
 225 Config::signer_chain_directory () const
 226 {
 227         boost::filesystem::path p;
 228         p /= g_get_user_config_dir ();
 229         p /= "dcpomatic";
 230         p /= "crypt";
 231         boost::filesystem::create_directories (p);
 232         return p;
 233 }
 234
 235 /** @return Singleton instance */
 236 Config *
 237 Config::instance ()
 238 {
 239         if (_instance == 0) {
 240                 _instance = new Config;
 241                 try {
 242                         _instance->read ();
 243                 } catch (exception& e) {
 244                         /* configuration load failed; never mind, just
 245                            stick with the default.
 246                         */
 247                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 248                 } catch (...) {
 249                         cerr << "dcpomatic: failed to load configuration\n";
 250                 }
 251         }
 252
 253         return _instance;
 254 }
 255
 256 /** Write our configuration to disk */
 257 void
 258 Config::write () const
 259 {
 260         xmlpp::Document doc;
 261         xmlpp::Element* root = doc.create_root_node ("Config");
 262
 263         root->add_child("Version")->add_child_text ("2");
 264         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 265         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 266         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 267         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 268
 269         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 270                 root->add_child("Server")->add_child_text (*i);
 271         }
 272
 273         root->add_child("TMSIP")->add_child_text (_tms_ip);
 274         root->add_child("TMSPath")->add_child_text (_tms_path);
 275         root->add_child("TMSUser")->add_child_text (_tms_user);
 276         root->add_child("TMSPassword")->add_child_text (_tms_password);
 277         if (_cinema_sound_processor) {
 278                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 279         }
 280         if (_language) {
 281                 root->add_child("Language")->add_child_text (_language.get());
 282         }
 283         if (_default_container) {
 284                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 285         }
 286         if (_default_dcp_content_type) {
 287                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 288         }
 289         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 290         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 291
 292         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 293
 294         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 295         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 296         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 297
 298         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 299                 i->as_xml (root->add_child ("ColourConversion"));
 300         }
 301
 302         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 303                 (*i)->as_xml (root->add_child ("Cinema"));
 304         }
 305
 306         root->add_child("MailServer")->add_child_text (_mail_server);
 307         root->add_child("MailUser")->add_child_text (_mail_user);
 308         root->add_child("MailPassword")->add_child_text (_mail_password);
 309         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 310         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 311         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 312         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 313
 314         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 315         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 316
 317         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 318         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 319         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 320
 321         doc.write_to_file_formatted (file(false).string ());
 322 }
 323
 324 boost::filesystem::path
 325 Config::default_directory_or (boost::filesystem::path a) const
 326 {
 327         if (_default_directory.empty()) {
 328                 return a;
 329         }
 330
 331         boost::system::error_code ec;
 332         bool const e = boost::filesystem::exists (_default_directory, ec);
 333         if (ec || !e) {
 334                 return a;
 335         }
 336
 337         return _default_directory;
 338 }
 339
 340 void
 341 Config::drop ()
 342 {
 343         delete _instance;
 344         _instance = 0;
 345 }
 346
 347 void
 348 Config::changed ()
 349 {
 350         write ();
 351         Changed ();
 352 }
 353
 354 void
 355 Config::reset_kdm_email ()
 356 {
 357         _kdm_email = _(
 358                 "Dear Projectionist\n\n"
 359                 "Please find attached KDMs for $CPL_NAME.\n\n"
 360                 "Cinema: $CINEMA_NAME\n"
 361                 "Screen(s): $SCREENS\n\n"
 362                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 363                 "Best regards,\nDCP-o-matic"
 364                 );
 365 }