src/lib/config.h

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