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