src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 /** @file src/config.h
  22  *  @brief Class holding configuration.
  23  */
  24
  25 #ifndef DCPOMATIC_CONFIG_H
  26 #define DCPOMATIC_CONFIG_H
  27
  28 #include "isdcf_metadata.h"
  29 #include "types.h"
  30 #include <dcp/certificate_chain.h>
  31 #include <dcp/encrypted_kdm.h>
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/signals2.hpp>
  34 #include <boost/filesystem.hpp>
  35 #include <vector>
  36
  37 class CinemaSoundProcessor;
  38 class DCPContentType;
  39 class Ratio;
  40 class Cinema;
  41
  42 /** @class Config
  43  *  @brief A singleton class holding configuration.
  44  */
  45 class Config : public boost::noncopyable
  46 {
  47 public:
  48         /** @return number of threads to use for J2K encoding on the local machine */
  49         int num_local_encoding_threads () const {
  50                 return _num_local_encoding_threads;
  51         }
  52
  53         boost::filesystem::path default_directory () const {
  54                 return _default_directory;
  55         }
  56
  57         boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
  58
  59         enum Property {
  60                 USE_ANY_SERVERS,
  61                 SERVERS,
  62                 OTHER
  63         };
  64
  65         /** @return base port number to use for J2K encoding servers */
  66         int server_port_base () const {
  67                 return _server_port_base;
  68         }
  69
  70         void set_use_any_servers (bool u) {
  71                 _use_any_servers = u;
  72                 changed (USE_ANY_SERVERS);
  73         }
  74
  75         bool use_any_servers () const {
  76                 return _use_any_servers;
  77         }
  78
  79         /** @param s New list of servers */
  80         void set_servers (std::vector<std::string> s) {
  81                 _servers = s;
  82                 changed (SERVERS);
  83         }
  84
  85         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
  86         std::vector<std::string> servers () const {
  87                 return _servers;
  88         }
  89
  90         bool only_servers_encode () const {
  91                 return _only_servers_encode;
  92         }
  93
  94         Protocol tms_protocol () const {
  95                 return _tms_protocol;
  96         }
  97
  98         /** @return The IP address of a TMS that we can copy DCPs to */
  99         std::string tms_ip () const {
 100                 return _tms_ip;
 101         }
 102
 103         /** @return The path on a TMS that we should changed DCPs to */
 104         std::string tms_path () const {
 105                 return _tms_path;
 106         }
 107
 108         /** @return User name to log into the TMS with */
 109         std::string tms_user () const {
 110                 return _tms_user;
 111         }
 112
 113         /** @return Password to log into the TMS with */
 114         std::string tms_password () const {
 115                 return _tms_password;
 116         }
 117
 118         /** @return The cinema sound processor that we are using */
 119         CinemaSoundProcessor const * cinema_sound_processor () const {
 120                 return _cinema_sound_processor;
 121         }
 122
 123         std::list<boost::shared_ptr<Cinema> > cinemas () const {
 124                 return _cinemas;
 125         }
 126
 127         std::list<int> allowed_dcp_frame_rates () const {
 128                 return _allowed_dcp_frame_rates;
 129         }
 130
 131         bool allow_any_dcp_frame_rate () const {
 132                 return _allow_any_dcp_frame_rate;
 133         }
 134
 135         ISDCFMetadata default_isdcf_metadata () const {
 136                 return _default_isdcf_metadata;
 137         }
 138
 139         boost::optional<std::string> language () const {
 140                 return _language;
 141         }
 142
 143         int default_still_length () const {
 144                 return _default_still_length;
 145         }
 146
 147         Ratio const * default_container () const {
 148                 return _default_container;
 149         }
 150
 151         DCPContentType const * default_dcp_content_type () const {
 152                 return _default_dcp_content_type;
 153         }
 154
 155         int default_dcp_audio_channels () const {
 156                 return _default_dcp_audio_channels;
 157         }
 158
 159         std::string dcp_issuer () const {
 160                 return _dcp_issuer;
 161         }
 162
 163         std::string dcp_creator () const {
 164                 return _dcp_creator;
 165         }
 166
 167         int default_j2k_bandwidth () const {
 168                 return _default_j2k_bandwidth;
 169         }
 170
 171         int default_audio_delay () const {
 172                 return _default_audio_delay;
 173         }
 174
 175         bool default_interop () const {
 176                 return _default_interop;
 177         }
 178
 179         std::string mail_server () const {
 180                 return _mail_server;
 181         }
 182
 183         int mail_port () const {
 184                 return _mail_port;
 185         }
 186
 187         std::string mail_user () const {
 188                 return _mail_user;
 189         }
 190
 191         std::string mail_password () const {
 192                 return _mail_password;
 193         }
 194
 195         std::string kdm_subject () const {
 196                 return _kdm_subject;
 197         }
 198
 199         std::string kdm_from () const {
 200                 return _kdm_from;
 201         }
 202
 203         std::vector<std::string> kdm_cc () const {
 204                 return _kdm_cc;
 205         }
 206
 207         std::string kdm_bcc () const {
 208                 return _kdm_bcc;
 209         }
 210
 211         std::string kdm_email () const {
 212                 return _kdm_email;
 213         }
 214
 215         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 216                 return _signer_chain;
 217         }
 218
 219         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 220                 return _decryption_chain;
 221         }
 222
 223         bool check_for_updates () const {
 224                 return _check_for_updates;
 225         }
 226
 227         bool check_for_test_updates () const {
 228                 return _check_for_test_updates;
 229         }
 230
 231         int maximum_j2k_bandwidth () const {
 232                 return _maximum_j2k_bandwidth;
 233         }
 234
 235         int log_types () const {
 236                 return _log_types;
 237         }
 238
 239         bool analyse_ebur128 () const {
 240                 return _analyse_ebur128;
 241         }
 242
 243         bool automatic_audio_analysis () const {
 244                 return _automatic_audio_analysis;
 245         }
 246
 247 #ifdef DCPOMATIC_WINDOWS
 248         bool win32_console () const {
 249                 return _win32_console;
 250         }
 251 #endif
 252
 253         std::vector<boost::filesystem::path> history () const {
 254                 return _history;
 255         }
 256
 257         std::vector<dcp::EncryptedKDM> dkdms () const {
 258                 return _dkdms;
 259         }
 260
 261         boost::filesystem::path cinemas_file () const {
 262                 return _cinemas_file;
 263         }
 264
 265         bool show_hints_before_make_dcp () const {
 266                 return _show_hints_before_make_dcp;
 267         }
 268
 269         /** @param n New number of local encoding threads */
 270         void set_num_local_encoding_threads (int n) {
 271                 maybe_set (_num_local_encoding_threads, n);
 272         }
 273
 274         void set_default_directory (boost::filesystem::path d) {
 275                 maybe_set (_default_directory, d);
 276         }
 277
 278         /** @param p New server port */
 279         void set_server_port_base (int p) {
 280                 maybe_set (_server_port_base, p);
 281         }
 282
 283         void set_only_servers_encode (bool o) {
 284                 maybe_set (_only_servers_encode, o);
 285         }
 286
 287         void set_tms_protocol (Protocol p) {
 288                 maybe_set (_tms_protocol, p);
 289         }
 290
 291         /** @param i IP address of a TMS that we can copy DCPs to */
 292         void set_tms_ip (std::string i) {
 293                 maybe_set (_tms_ip, i);
 294         }
 295
 296         /** @param p Path on a TMS that we should changed DCPs to */
 297         void set_tms_path (std::string p) {
 298                 maybe_set (_tms_path, p);
 299         }
 300
 301         /** @param u User name to log into the TMS with */
 302         void set_tms_user (std::string u) {
 303                 maybe_set (_tms_user, u);
 304         }
 305
 306         /** @param p Password to log into the TMS with */
 307         void set_tms_password (std::string p) {
 308                 maybe_set (_tms_password, p);
 309         }
 310
 311         void add_cinema (boost::shared_ptr<Cinema> c) {
 312                 _cinemas.push_back (c);
 313                 changed ();
 314         }
 315
 316         void remove_cinema (boost::shared_ptr<Cinema> c) {
 317                 _cinemas.remove (c);
 318                 changed ();
 319         }
 320
 321         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 322                 maybe_set (_allowed_dcp_frame_rates, r);
 323         }
 324
 325         void set_allow_any_dcp_frame_rate (bool a) {
 326                 maybe_set (_allow_any_dcp_frame_rate, a);
 327         }
 328
 329         void set_default_isdcf_metadata (ISDCFMetadata d) {
 330                 maybe_set (_default_isdcf_metadata, d);
 331         }
 332
 333         void set_language (std::string l) {
 334                 if (_language && _language.get() == l) {
 335                         return;
 336                 }
 337                 _language = l;
 338                 changed ();
 339         }
 340
 341         void unset_language () {
 342                 if (!_language) {
 343                         return;
 344                 }
 345
 346                 _language = boost::none;
 347                 changed ();
 348         }
 349
 350         void set_default_still_length (int s) {
 351                 maybe_set (_default_still_length, s);
 352         }
 353
 354         void set_default_container (Ratio const * c) {
 355                 maybe_set (_default_container, c);
 356         }
 357
 358         void set_default_dcp_content_type (DCPContentType const * t) {
 359                 maybe_set (_default_dcp_content_type, t);
 360         }
 361
 362         void set_default_dcp_audio_channels (int c) {
 363                 maybe_set (_default_dcp_audio_channels, c);
 364         }
 365
 366         void set_dcp_issuer (std::string i) {
 367                 maybe_set (_dcp_issuer, i);
 368         }
 369
 370         void set_dcp_creator (std::string c) {
 371                 maybe_set (_dcp_creator, c);
 372         }
 373
 374         void set_default_j2k_bandwidth (int b) {
 375                 maybe_set (_default_j2k_bandwidth, b);
 376         }
 377
 378         void set_default_audio_delay (int d) {
 379                 maybe_set (_default_audio_delay, d);
 380         }
 381
 382         void set_default_interop (bool i) {
 383                 maybe_set (_default_interop, i);
 384         }
 385
 386         void set_mail_server (std::string s) {
 387                 maybe_set (_mail_server, s);
 388         }
 389
 390         void set_mail_port (int p) {
 391                 maybe_set (_mail_port, p);
 392         }
 393
 394         void set_mail_user (std::string u) {
 395                 maybe_set (_mail_user, u);
 396         }
 397
 398         void set_mail_password (std::string p) {
 399                 maybe_set (_mail_password, p);
 400         }
 401
 402         void set_kdm_subject (std::string s) {
 403                 maybe_set (_kdm_subject, s);
 404         }
 405
 406         void set_kdm_from (std::string f) {
 407                 maybe_set (_kdm_from, f);
 408         }
 409
 410         void set_kdm_cc (std::vector<std::string> f) {
 411                 maybe_set (_kdm_cc, f);
 412         }
 413
 414         void set_kdm_bcc (std::string f) {
 415                 maybe_set (_kdm_bcc, f);
 416         }
 417
 418         void set_kdm_email (std::string e) {
 419                 maybe_set (_kdm_email, e);
 420         }
 421
 422         void reset_kdm_email ();
 423
 424         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
 425                 maybe_set (_signer_chain, s);
 426         }
 427
 428         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
 429                 maybe_set (_decryption_chain, c);
 430         }
 431
 432         void set_check_for_updates (bool c) {
 433                 maybe_set (_check_for_updates, c);
 434                 if (!c) {
 435                         set_check_for_test_updates (false);
 436                 }
 437         }
 438
 439         void set_check_for_test_updates (bool c) {
 440                 maybe_set (_check_for_test_updates, c);
 441         }
 442
 443         void set_maximum_j2k_bandwidth (int b) {
 444                 maybe_set (_maximum_j2k_bandwidth, b);
 445         }
 446
 447         void set_log_types (int t) {
 448                 maybe_set (_log_types, t);
 449         }
 450
 451         void set_analyse_ebur128 (bool a) {
 452                 maybe_set (_analyse_ebur128, a);
 453         }
 454
 455         void set_automatic_audio_analysis (bool a) {
 456                 maybe_set (_automatic_audio_analysis, a);
 457         }
 458
 459 #ifdef DCPOMATIC_WINDOWS
 460         void set_win32_console (bool c) {
 461                 maybe_set (_win32_console, c);
 462         }
 463 #endif
 464
 465         void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms)
 466         {
 467                 _dkdms = dkdms;
 468                 changed ();
 469         }
 470
 471         void set_cinemas_file (boost::filesystem::path file);
 472
 473         void set_show_hints_before_make_dcp (bool s) {
 474                 maybe_set (_show_hints_before_make_dcp, s);
 475         }
 476
 477         void clear_history () {
 478                 _history.clear ();
 479                 changed ();
 480         }
 481
 482         void add_to_history (boost::filesystem::path p);
 483
 484         void changed (Property p = OTHER);
 485         boost::signals2::signal<void (Property)> Changed;
 486         /** Emitted if ::read() failed on an existing Config file.  There is nothing
 487             a listener can do about it: this is just for information.
 488         */
 489         static boost::signals2::signal<void ()> FailedToLoad;
 490
 491         void write () const;
 492
 493         static Config* instance ();
 494         static void drop ();
 495         static void restore_defaults ();
 496         static bool have_existing (std::string);
 497
 498 private:
 499         Config ();
 500         static boost::filesystem::path path (std::string file, bool create_directories = true);
 501         void read ();
 502         void set_defaults ();
 503         void set_kdm_email_to_default ();
 504         void write_config_xml () const;
 505         void write_cinemas_xml () const;
 506         void read_cinemas (cxml::Document const & f);
 507         boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
 508
 509         template <class T>
 510         void maybe_set (T& member, T new_value) {
 511                 if (member == new_value) {
 512                         return;
 513                 }
 514                 member = new_value;
 515                 changed ();
 516         }
 517
 518         /** number of threads to use for J2K encoding on the local machine */
 519         int _num_local_encoding_threads;
 520         /** default directory to put new films in */
 521         boost::filesystem::path _default_directory;
 522         /** base port number to use for J2K encoding servers;
 523          *  this port and the two above it will be used.
 524          */
 525         int _server_port_base;
 526         /** true to broadcast on the `any' address to look for servers */
 527         bool _use_any_servers;
 528         /** J2K encoding servers that should definitely be used */
 529         std::vector<std::string> _servers;
 530         bool _only_servers_encode;
 531         Protocol _tms_protocol;
 532         /** The IP address of a TMS that we can copy DCPs to */
 533         std::string _tms_ip;
 534         /** The path on a TMS that we should write DCPs to */
 535         std::string _tms_path;
 536         /** User name to log into the TMS with */
 537         std::string _tms_user;
 538         /** Password to log into the TMS with */
 539         std::string _tms_password;
 540         /** Our cinema sound processor */
 541         CinemaSoundProcessor const * _cinema_sound_processor;
 542         std::list<int> _allowed_dcp_frame_rates;
 543         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 544         bool _allow_any_dcp_frame_rate;
 545         /** Default ISDCF metadata for newly-created Films */
 546         ISDCFMetadata _default_isdcf_metadata;
 547         boost::optional<std::string> _language;
 548         /** Default length of still image content (seconds) */
 549         int _default_still_length;
 550         Ratio const * _default_container;
 551         DCPContentType const * _default_dcp_content_type;
 552         int _default_dcp_audio_channels;
 553         std::string _dcp_issuer;
 554         std::string _dcp_creator;
 555         int _default_j2k_bandwidth;
 556         int _default_audio_delay;
 557         bool _default_interop;
 558         std::list<boost::shared_ptr<Cinema> > _cinemas;
 559         std::string _mail_server;
 560         int _mail_port;
 561         std::string _mail_user;
 562         std::string _mail_password;
 563         std::string _kdm_subject;
 564         std::string _kdm_from;
 565         std::vector<std::string> _kdm_cc;
 566         std::string _kdm_bcc;
 567         std::string _kdm_email;
 568         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
 569         /** Chain used to decrypt KDMs; the leaf of this chain is the target
 570          *  certificate for making KDMs given to DCP-o-matic.
 571          */
 572         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
 573         /** true to check for updates on startup */
 574         bool _check_for_updates;
 575         bool _check_for_test_updates;
 576         /** maximum allowed J2K bandwidth in bits per second */
 577         int _maximum_j2k_bandwidth;
 578         int _log_types;
 579         bool _analyse_ebur128;
 580         bool _automatic_audio_analysis;
 581 #ifdef DCPOMATIC_WINDOWS
 582         bool _win32_console;
 583 #endif
 584         std::vector<boost::filesystem::path> _history;
 585         std::vector<dcp::EncryptedKDM> _dkdms;
 586         boost::filesystem::path _cinemas_file;
 587         bool _show_hints_before_make_dcp;
 588
 589         /** Singleton instance, or 0 */
 590         static Config* _instance;
 591 };
 592
 593 #endif