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