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_scale (Ratio::from_id ("185"))
  67         , _default_container (Ratio::from_id ("185"))
  68         , _default_dcp_content_type (DCPContentType::from_isdcf_name ("TST"))
  69         , _default_j2k_bandwidth (100000000)
  70         , _default_audio_delay (0)
  71         , _check_for_updates (false)
  72         , _check_for_test_updates (false)
  73         , _maximum_j2k_bandwidth (250000000)
  74         , _log_types (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR)
  75 {
  76         _allowed_dcp_frame_rates.push_back (24);
  77         _allowed_dcp_frame_rates.push_back (25);
  78         _allowed_dcp_frame_rates.push_back (30);
  79         _allowed_dcp_frame_rates.push_back (48);
  80         _allowed_dcp_frame_rates.push_back (50);
  81         _allowed_dcp_frame_rates.push_back (60);
  82
  83         _colour_conversions.push_back (PresetColourConversion (_("sRGB"), 2.4, true, dcp::colour_matrix::srgb_to_xyz, 2.6));
  84         _colour_conversions.push_back (PresetColourConversion (_("sRGB non-linearised"), 2.4, false, dcp::colour_matrix::srgb_to_xyz, 2.6));
  85         _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
  86
  87         reset_kdm_email ();
  88 }
  89
  90 void
  91 Config::read ()
  92 {
  93         if (!boost::filesystem::exists (file (false))) {
  94                 return;
  95         }
  96
  97         cxml::Document f ("Config");
  98         f.read_file (file (false));
  99         optional<string> c;
 100
 101         optional<int> version = f.optional_number_child<int> ("Version");
 102
 103         _num_local_encoding_threads = f.number_child<int> ("NumLocalEncodingThreads");
 104         _default_directory = f.string_child ("DefaultDirectory");
 105
 106         boost::optional<int> b = f.optional_number_child<int> ("ServerPort");
 107         if (!b) {
 108                 b = f.optional_number_child<int> ("ServerPortBase");
 109         }
 110         _server_port_base = b.get ();
 111
 112         boost::optional<bool> u = f.optional_bool_child ("UseAnyServers");
 113         _use_any_servers = u.get_value_or (true);
 114
 115         list<cxml::NodePtr> servers = f.node_children ("Server");
 116         for (list<cxml::NodePtr>::iterator i = servers.begin(); i != servers.end(); ++i) {
 117                 if ((*i)->node_children("HostName").size() == 1) {
 118                         _servers.push_back ((*i)->string_child ("HostName"));
 119                 } else {
 120                         _servers.push_back ((*i)->content ());
 121                 }
 122         }
 123
 124         _tms_ip = f.string_child ("TMSIP");
 125         _tms_path = f.string_child ("TMSPath");
 126         _tms_user = f.string_child ("TMSUser");
 127         _tms_password = f.string_child ("TMSPassword");
 128
 129         c = f.optional_string_child ("SoundProcessor");
 130         if (c) {
 131                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 132         }
 133         c = f.optional_string_child ("CinemaSoundProcessor");
 134         if (c) {
 135                 _cinema_sound_processor = CinemaSoundProcessor::from_id (c.get ());
 136         }
 137
 138         _language = f.optional_string_child ("Language");
 139
 140         c = f.optional_string_child ("DefaultScale");
 141         if (c) {
 142                 _default_scale = Ratio::from_id (c.get ());
 143         }
 144
 145         c = f.optional_string_child ("DefaultContainer");
 146         if (c) {
 147                 _default_container = Ratio::from_id (c.get ());
 148         }
 149
 150         c = f.optional_string_child ("DefaultDCPContentType");
 151         if (c) {
 152                 _default_dcp_content_type = DCPContentType::from_isdcf_name (c.get ());
 153         }
 154
 155         _dcp_metadata.issuer = f.optional_string_child ("DCPMetadataIssuer").get_value_or ("");
 156         _dcp_metadata.creator = f.optional_string_child ("DCPMetadataCreator").get_value_or ("");
 157
 158         if (version && version.get() >= 2) {
 159                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("ISDCFMetadata"));
 160         } else {
 161                 _default_isdcf_metadata = ISDCFMetadata (f.node_child ("DCIMetadata"));
 162         }
 163
 164         _default_still_length = f.optional_number_child<int>("DefaultStillLength").get_value_or (10);
 165         _default_j2k_bandwidth = f.optional_number_child<int>("DefaultJ2KBandwidth").get_value_or (200000000);
 166         _default_audio_delay = f.optional_number_child<int>("DefaultAudioDelay").get_value_or (0);
 167
 168         list<cxml::NodePtr> cc = f.node_children ("ColourConversion");
 169
 170         if (!cc.empty ()) {
 171                 _colour_conversions.clear ();
 172         }
 173
 174         for (list<cxml::NodePtr>::iterator i = cc.begin(); i != cc.end(); ++i) {
 175                 _colour_conversions.push_back (PresetColourConversion (*i));
 176         }
 177
 178         if (!version) {
 179                 /* Loading version 0 (before Rec. 709 was added as a preset).
 180                    Add it in.
 181                 */
 182                 _colour_conversions.push_back (PresetColourConversion (_("Rec. 709"), 2.2, false, dcp::colour_matrix::rec709_to_xyz, 2.6));
 183         }
 184
 185         list<cxml::NodePtr> cin = f.node_children ("Cinema");
 186         for (list<cxml::NodePtr>::iterator i = cin.begin(); i != cin.end(); ++i) {
 187                 /* Slightly grotty two-part construction of Cinema here so that we can use
 188                    shared_from_this.
 189                 */
 190                 shared_ptr<Cinema> cinema (new Cinema (*i));
 191                 cinema->read_screens (*i);
 192                 _cinemas.push_back (cinema);
 193         }
 194
 195         _mail_server = f.string_child ("MailServer");
 196         _mail_user = f.optional_string_child("MailUser").get_value_or ("");
 197         _mail_password = f.optional_string_child("MailPassword").get_value_or ("");
 198         _kdm_subject = f.optional_string_child ("KDMSubject").get_value_or (_("KDM delivery: $CPL_NAME"));
 199         _kdm_from = f.string_child ("KDMFrom");
 200         _kdm_cc = f.optional_string_child ("KDMCC").get_value_or ("");
 201         _kdm_email = f.string_child ("KDMEmail");
 202
 203         _check_for_updates = f.optional_bool_child("CheckForUpdates").get_value_or (false);
 204         _check_for_test_updates = f.optional_bool_child("CheckForTestUpdates").get_value_or (false);
 205
 206         _maximum_j2k_bandwidth = f.optional_number_child<int> ("MaximumJ2KBandwidth").get_value_or (250000000);
 207         _allow_any_dcp_frame_rate = f.optional_bool_child ("AllowAnyDCPFrameRate");
 208
 209         _log_types = f.optional_number_child<int> ("LogTypes").get_value_or (Log::TYPE_GENERAL | Log::TYPE_WARNING | Log::TYPE_ERROR);
 210 }
 211
 212 /** @return Filename to write configuration to */
 213 boost::filesystem::path
 214 Config::file (bool old) const
 215 {
 216         boost::filesystem::path p;
 217         p /= g_get_user_config_dir ();
 218         boost::system::error_code ec;
 219         boost::filesystem::create_directory (p, ec);
 220         if (old) {
 221                 p /= ".dvdomatic";
 222         } else {
 223                 p /= "dcpomatic";
 224                 boost::filesystem::create_directory (p, ec);
 225                 p /= "config.xml";
 226         }
 227         return p;
 228 }
 229
 230 boost::filesystem::path
 231 Config::signer_chain_directory () const
 232 {
 233         boost::filesystem::path p;
 234         p /= g_get_user_config_dir ();
 235         p /= "dcpomatic";
 236         p /= "crypt";
 237         boost::filesystem::create_directories (p);
 238         return p;
 239 }
 240
 241 /** @return Singleton instance */
 242 Config *
 243 Config::instance ()
 244 {
 245         if (_instance == 0) {
 246                 _instance = new Config;
 247                 try {
 248                         _instance->read ();
 249                 } catch (exception& e) {
 250                         /* configuration load failed; never mind, just
 251                            stick with the default.
 252                         */
 253                         cerr << "dcpomatic: failed to load configuration (" << e.what() << ")\n";
 254                 } catch (...) {
 255                         cerr << "dcpomatic: failed to load configuration\n";
 256                 }
 257         }
 258
 259         return _instance;
 260 }
 261
 262 /** Write our configuration to disk */
 263 void
 264 Config::write () const
 265 {
 266         xmlpp::Document doc;
 267         xmlpp::Element* root = doc.create_root_node ("Config");
 268
 269         root->add_child("Version")->add_child_text ("2");
 270         root->add_child("NumLocalEncodingThreads")->add_child_text (raw_convert<string> (_num_local_encoding_threads));
 271         root->add_child("DefaultDirectory")->add_child_text (_default_directory.string ());
 272         root->add_child("ServerPortBase")->add_child_text (raw_convert<string> (_server_port_base));
 273         root->add_child("UseAnyServers")->add_child_text (_use_any_servers ? "1" : "0");
 274
 275         for (vector<string>::const_iterator i = _servers.begin(); i != _servers.end(); ++i) {
 276                 root->add_child("Server")->add_child_text (*i);
 277         }
 278
 279         root->add_child("TMSIP")->add_child_text (_tms_ip);
 280         root->add_child("TMSPath")->add_child_text (_tms_path);
 281         root->add_child("TMSUser")->add_child_text (_tms_user);
 282         root->add_child("TMSPassword")->add_child_text (_tms_password);
 283         if (_cinema_sound_processor) {
 284                 root->add_child("CinemaSoundProcessor")->add_child_text (_cinema_sound_processor->id ());
 285         }
 286         if (_language) {
 287                 root->add_child("Language")->add_child_text (_language.get());
 288         }
 289         if (_default_scale) {
 290                 root->add_child("DefaultScale")->add_child_text (_default_scale->id ());
 291         }
 292         if (_default_container) {
 293                 root->add_child("DefaultContainer")->add_child_text (_default_container->id ());
 294         }
 295         if (_default_dcp_content_type) {
 296                 root->add_child("DefaultDCPContentType")->add_child_text (_default_dcp_content_type->isdcf_name ());
 297         }
 298         root->add_child("DCPMetadataIssuer")->add_child_text (_dcp_metadata.issuer);
 299         root->add_child("DCPMetadataCreator")->add_child_text (_dcp_metadata.creator);
 300
 301         _default_isdcf_metadata.as_xml (root->add_child ("ISDCFMetadata"));
 302
 303         root->add_child("DefaultStillLength")->add_child_text (raw_convert<string> (_default_still_length));
 304         root->add_child("DefaultJ2KBandwidth")->add_child_text (raw_convert<string> (_default_j2k_bandwidth));
 305         root->add_child("DefaultAudioDelay")->add_child_text (raw_convert<string> (_default_audio_delay));
 306
 307         for (vector<PresetColourConversion>::const_iterator i = _colour_conversions.begin(); i != _colour_conversions.end(); ++i) {
 308                 i->as_xml (root->add_child ("ColourConversion"));
 309         }
 310
 311         for (list<shared_ptr<Cinema> >::const_iterator i = _cinemas.begin(); i != _cinemas.end(); ++i) {
 312                 (*i)->as_xml (root->add_child ("Cinema"));
 313         }
 314
 315         root->add_child("MailServer")->add_child_text (_mail_server);
 316         root->add_child("MailUser")->add_child_text (_mail_user);
 317         root->add_child("MailPassword")->add_child_text (_mail_password);
 318         root->add_child("KDMSubject")->add_child_text (_kdm_subject);
 319         root->add_child("KDMFrom")->add_child_text (_kdm_from);
 320         root->add_child("KDMCC")->add_child_text (_kdm_cc);
 321         root->add_child("KDMEmail")->add_child_text (_kdm_email);
 322
 323         root->add_child("CheckForUpdates")->add_child_text (_check_for_updates ? "1" : "0");
 324         root->add_child("CheckForTestUpdates")->add_child_text (_check_for_test_updates ? "1" : "0");
 325
 326         root->add_child("MaximumJ2KBandwidth")->add_child_text (raw_convert<string> (_maximum_j2k_bandwidth));
 327         root->add_child("AllowAnyDCPFrameRate")->add_child_text (_allow_any_dcp_frame_rate ? "1" : "0");
 328         root->add_child("LogTypes")->add_child_text (raw_convert<string> (_log_types));
 329
 330         doc.write_to_file_formatted (file(false).string ());
 331 }
 332
 333 boost::filesystem::path
 334 Config::default_directory_or (boost::filesystem::path a) const
 335 {
 336         if (_default_directory.empty()) {
 337                 return a;
 338         }
 339
 340         boost::system::error_code ec;
 341         bool const e = boost::filesystem::exists (_default_directory, ec);
 342         if (ec || !e) {
 343                 return a;
 344         }
 345
 346         return _default_directory;
 347 }
 348
 349 void
 350 Config::drop ()
 351 {
 352         delete _instance;
 353         _instance = 0;
 354 }
 355
 356 void
 357 Config::changed ()
 358 {
 359         write ();
 360         Changed ();
 361 }
 362
 363 void
 364 Config::reset_kdm_email ()
 365 {
 366         _kdm_email = _(
 367                 "Dear Projectionist\n\n"
 368                 "Please find attached KDMs for $CPL_NAME.\n\n"
 369                 "Cinema: $CINEMA_NAME\n"
 370                 "Screen(s): $SCREENS\n\n"
 371                 "The KDMs are valid from $START_TIME until $END_TIME.\n\n"
 372                 "Best regards,\nDCP-o-matic"
 373                 );
 374 }