src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2015 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 /** @file src/config.h
  21  *  @brief Class holding configuration.
  22  */
  23
  24 #ifndef DCPOMATIC_CONFIG_H
  25 #define DCPOMATIC_CONFIG_H
  26
  27 #include "isdcf_metadata.h"
  28 #include "types.h"
  29 #include <dcp/certificate_chain.h>
  30 #include <dcp/encrypted_kdm.h>
  31 #include <boost/shared_ptr.hpp>
  32 #include <boost/signals2.hpp>
  33 #include <boost/filesystem.hpp>
  34 #include <vector>
  35
  36 class CinemaSoundProcessor;
  37 class DCPContentType;
  38 class Ratio;
  39 class Cinema;
  40 class JPEG2000Encoder;
  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         std::string dcp_issuer () const {
 156                 return _dcp_issuer;
 157         }
 158
 159         std::string dcp_creator () const {
 160                 return _dcp_creator;
 161         }
 162
 163         int default_j2k_bandwidth () const {
 164                 return _default_j2k_bandwidth;
 165         }
 166
 167         int default_audio_delay () const {
 168                 return _default_audio_delay;
 169         }
 170
 171         bool default_interop () const {
 172                 return _default_interop;
 173         }
 174
 175         std::string mail_server () const {
 176                 return _mail_server;
 177         }
 178
 179         int mail_port () const {
 180                 return _mail_port;
 181         }
 182
 183         std::string mail_user () const {
 184                 return _mail_user;
 185         }
 186
 187         std::string mail_password () const {
 188                 return _mail_password;
 189         }
 190
 191         std::string kdm_subject () const {
 192                 return _kdm_subject;
 193         }
 194
 195         std::string kdm_from () const {
 196                 return _kdm_from;
 197         }
 198
 199         std::vector<std::string> kdm_cc () const {
 200                 return _kdm_cc;
 201         }
 202
 203         std::string kdm_bcc () const {
 204                 return _kdm_bcc;
 205         }
 206
 207         std::string kdm_email () const {
 208                 return _kdm_email;
 209         }
 210
 211         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 212                 return _signer_chain;
 213         }
 214
 215         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 216                 return _decryption_chain;
 217         }
 218
 219         bool check_for_updates () const {
 220                 return _check_for_updates;
 221         }
 222
 223         bool check_for_test_updates () const {
 224                 return _check_for_test_updates;
 225         }
 226
 227         int maximum_j2k_bandwidth () const {
 228                 return _maximum_j2k_bandwidth;
 229         }
 230
 231         int log_types () const {
 232                 return _log_types;
 233         }
 234
 235         bool analyse_ebur128 () const {
 236                 return _analyse_ebur128;
 237         }
 238
 239         bool automatic_audio_analysis () const {
 240                 return _automatic_audio_analysis;
 241         }
 242
 243 #ifdef DCPOMATIC_WINDOWS
 244         bool win32_console () const {
 245                 return _win32_console;
 246         }
 247 #endif
 248         boost::optional<std::string> encoder () {
 249                 return _encoder;
 250         }
 251
 252         std::vector<boost::filesystem::path> history () const {
 253                 return _history;
 254         }
 255
 256         std::vector<dcp::EncryptedKDM> dkdms () const {
 257                 return _dkdms;
 258         }
 259
 260         boost::filesystem::path cinemas_file () const {
 261                 return _cinemas_file;
 262         }
 263
 264         /** @param n New number of local encoding threads */
 265         void set_num_local_encoding_threads (int n) {
 266                 maybe_set (_num_local_encoding_threads, n);
 267         }
 268
 269         void set_default_directory (boost::filesystem::path d) {
 270                 maybe_set (_default_directory, d);
 271         }
 272
 273         /** @param p New server port */
 274         void set_server_port_base (int p) {
 275                 maybe_set (_server_port_base, p);
 276         }
 277
 278         void set_only_servers_encode (bool o) {
 279                 maybe_set (_only_servers_encode, o);
 280         }
 281
 282         void set_tms_protocol (Protocol p) {
 283                 maybe_set (_tms_protocol, p);
 284         }
 285
 286         /** @param i IP address of a TMS that we can copy DCPs to */
 287         void set_tms_ip (std::string i) {
 288                 maybe_set (_tms_ip, i);
 289         }
 290
 291         /** @param p Path on a TMS that we should changed DCPs to */
 292         void set_tms_path (std::string p) {
 293                 maybe_set (_tms_path, p);
 294         }
 295
 296         /** @param u User name to log into the TMS with */
 297         void set_tms_user (std::string u) {
 298                 maybe_set (_tms_user, u);
 299         }
 300
 301         /** @param p Password to log into the TMS with */
 302         void set_tms_password (std::string p) {
 303                 maybe_set (_tms_password, p);
 304         }
 305
 306         void add_cinema (boost::shared_ptr<Cinema> c) {
 307                 _cinemas.push_back (c);
 308                 changed ();
 309         }
 310
 311         void remove_cinema (boost::shared_ptr<Cinema> c) {
 312                 _cinemas.remove (c);
 313                 changed ();
 314         }
 315
 316         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 317                 maybe_set (_allowed_dcp_frame_rates, r);
 318         }
 319
 320         void set_allow_any_dcp_frame_rate (bool a) {
 321                 maybe_set (_allow_any_dcp_frame_rate, a);
 322         }
 323
 324         void set_default_isdcf_metadata (ISDCFMetadata d) {
 325                 maybe_set (_default_isdcf_metadata, d);
 326         }
 327
 328         void set_language (std::string l) {
 329                 if (_language && _language.get() == l) {
 330                         return;
 331                 }
 332                 _language = l;
 333                 changed ();
 334         }
 335
 336         void unset_language () {
 337                 if (!_language) {
 338                         return;
 339                 }
 340
 341                 _language = boost::none;
 342                 changed ();
 343         }
 344
 345         void set_default_still_length (int s) {
 346                 maybe_set (_default_still_length, s);
 347         }
 348
 349         void set_default_container (Ratio const * c) {
 350                 maybe_set (_default_container, c);
 351         }
 352
 353         void set_default_dcp_content_type (DCPContentType const * t) {
 354                 maybe_set (_default_dcp_content_type, t);
 355         }
 356
 357         void set_dcp_issuer (std::string i) {
 358                 maybe_set (_dcp_issuer, i);
 359         }
 360
 361         void set_dcp_creator (std::string c) {
 362                 maybe_set (_dcp_creator, c);
 363         }
 364
 365         void set_default_j2k_bandwidth (int b) {
 366                 maybe_set (_default_j2k_bandwidth, b);
 367         }
 368
 369         void set_default_audio_delay (int d) {
 370                 maybe_set (_default_audio_delay, d);
 371         }
 372
 373         void set_default_interop (bool i) {
 374                 maybe_set (_default_interop, i);
 375         }
 376
 377         void set_mail_server (std::string s) {
 378                 maybe_set (_mail_server, s);
 379         }
 380
 381         void set_mail_port (int p) {
 382                 maybe_set (_mail_port, p);
 383         }
 384
 385         void set_mail_user (std::string u) {
 386                 maybe_set (_mail_user, u);
 387         }
 388
 389         void set_mail_password (std::string p) {
 390                 maybe_set (_mail_password, p);
 391         }
 392
 393         void set_kdm_subject (std::string s) {
 394                 maybe_set (_kdm_subject, s);
 395         }
 396
 397         void set_kdm_from (std::string f) {
 398                 maybe_set (_kdm_from, f);
 399         }
 400
 401         void set_kdm_cc (std::vector<std::string> f) {
 402                 maybe_set (_kdm_cc, f);
 403         }
 404
 405         void set_kdm_bcc (std::string f) {
 406                 maybe_set (_kdm_bcc, f);
 407         }
 408
 409         void set_kdm_email (std::string e) {
 410                 maybe_set (_kdm_email, e);
 411         }
 412
 413         void reset_kdm_email ();
 414
 415         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
 416                 maybe_set (_signer_chain, s);
 417         }
 418
 419         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
 420                 maybe_set (_decryption_chain, c);
 421         }
 422
 423         void set_check_for_updates (bool c) {
 424                 maybe_set (_check_for_updates, c);
 425                 if (!c) {
 426                         set_check_for_test_updates (false);
 427                 }
 428         }
 429
 430         void set_check_for_test_updates (bool c) {
 431                 maybe_set (_check_for_test_updates, c);
 432         }
 433
 434         void set_maximum_j2k_bandwidth (int b) {
 435                 maybe_set (_maximum_j2k_bandwidth, b);
 436         }
 437
 438         void set_log_types (int t) {
 439                 maybe_set (_log_types, t);
 440         }
 441
 442         void set_analyse_ebur128 (bool a) {
 443                 maybe_set (_analyse_ebur128, a);
 444         }
 445
 446         void set_automatic_audio_analysis (bool a) {
 447                 maybe_set (_automatic_audio_analysis, a);
 448         }
 449
 450 #ifdef DCPOMATIC_WINDOWS
 451         void set_win32_console (bool c) {
 452                 maybe_set (_win32_console, c);
 453         }
 454 #endif
 455
 456         void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms)
 457         {
 458                 _dkdms = dkdms;
 459                 changed ();
 460         }
 461
 462         void set_cinemas_file (boost::filesystem::path file);
 463
 464         void set_encoder (std::string id) {
 465                 if (_encoder && _encoder.get() == id) {
 466                         return;
 467                 }
 468
 469                 _encoder = id;
 470                 changed ();
 471         }
 472
 473         void clear_history () {
 474                 _history.clear ();
 475                 changed ();
 476         }
 477
 478         void add_to_history (boost::filesystem::path p);
 479
 480         void changed (Property p = OTHER);
 481         boost::signals2::signal<void (Property)> Changed;
 482
 483         void write () const;
 484
 485         static Config* instance ();
 486         static void drop ();
 487         static void restore_defaults ();
 488         static bool have_existing (std::string);
 489
 490 private:
 491         Config ();
 492         static boost::filesystem::path path (std::string file, bool create_directories = true);
 493         void read ();
 494         void set_defaults ();
 495         void set_kdm_email_to_default ();
 496         void write_config_xml () const;
 497         void write_cinemas_xml () const;
 498         void read_cinemas (cxml::Document const & f);
 499         boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
 500
 501         template <class T>
 502         void maybe_set (T& member, T new_value) {
 503                 if (member == new_value) {
 504                         return;
 505                 }
 506                 member = new_value;
 507                 changed ();
 508         }
 509
 510         /** number of threads to use for J2K encoding on the local machine */
 511         int _num_local_encoding_threads;
 512         /** default directory to put new films in */
 513         boost::filesystem::path _default_directory;
 514         /** base port number to use for J2K encoding servers;
 515          *  this port and the two above it will be used.
 516          */
 517         int _server_port_base;
 518         /** true to broadcast on the `any' address to look for servers */
 519         bool _use_any_servers;
 520         /** J2K encoding servers that should definitely be used */
 521         std::vector<std::string> _servers;
 522         bool _only_servers_encode;
 523         Protocol _tms_protocol;
 524         /** The IP address of a TMS that we can copy DCPs to */
 525         std::string _tms_ip;
 526         /** The path on a TMS that we should write DCPs to */
 527         std::string _tms_path;
 528         /** User name to log into the TMS with */
 529         std::string _tms_user;
 530         /** Password to log into the TMS with */
 531         std::string _tms_password;
 532         /** Our cinema sound processor */
 533         CinemaSoundProcessor const * _cinema_sound_processor;
 534         std::list<int> _allowed_dcp_frame_rates;
 535         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 536         bool _allow_any_dcp_frame_rate;
 537         /** Default ISDCF metadata for newly-created Films */
 538         ISDCFMetadata _default_isdcf_metadata;
 539         boost::optional<std::string> _language;
 540         /** Default length of still image content (seconds) */
 541         int _default_still_length;
 542         Ratio const * _default_container;
 543         DCPContentType const * _default_dcp_content_type;
 544         std::string _dcp_issuer;
 545         std::string _dcp_creator;
 546         int _default_j2k_bandwidth;
 547         int _default_audio_delay;
 548         bool _default_interop;
 549         std::list<boost::shared_ptr<Cinema> > _cinemas;
 550         std::string _mail_server;
 551         int _mail_port;
 552         std::string _mail_user;
 553         std::string _mail_password;
 554         std::string _kdm_subject;
 555         std::string _kdm_from;
 556         std::vector<std::string> _kdm_cc;
 557         std::string _kdm_bcc;
 558         std::string _kdm_email;
 559         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
 560         /** Chain used to decrypt KDMs; the leaf of this chain is the target
 561          *  certificate for making KDMs given to DCP-o-matic.
 562          */
 563         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
 564         /** true to check for updates on startup */
 565         bool _check_for_updates;
 566         bool _check_for_test_updates;
 567         /** maximum allowed J2K bandwidth in bits per second */
 568         int _maximum_j2k_bandwidth;
 569         int _log_types;
 570         bool _analyse_ebur128;
 571         bool _automatic_audio_analysis;
 572 #ifdef DCPOMATIC_WINDOWS
 573         bool _win32_console;
 574 #endif
 575         boost::optional<std::string> _encoder;
 576         std::vector<boost::filesystem::path> _history;
 577         std::vector<dcp::EncryptedKDM> _dkdms;
 578         boost::filesystem::path _cinemas_file;
 579
 580         /** Singleton instance, or 0 */
 581         static Config* _instance;
 582 };
 583
 584 #endif