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