src/lib/config.h

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