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