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