src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2018 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                 SOUND,
  77                 SOUND_OUTPUT,
  78                 INTERFACE_COMPLEXITY,
  79                 OTHER
  80         };
  81
  82         /** @return base port number to use for J2K encoding servers */
  83         int server_port_base () const {
  84                 return _server_port_base;
  85         }
  86
  87         void set_use_any_servers (bool u) {
  88                 _use_any_servers = u;
  89                 changed (USE_ANY_SERVERS);
  90         }
  91
  92         bool use_any_servers () const {
  93                 return _use_any_servers;
  94         }
  95
  96         /** @param s New list of servers */
  97         void set_servers (std::vector<std::string> s) {
  98                 _servers = s;
  99                 changed (SERVERS);
 100         }
 101
 102         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
 103         std::vector<std::string> servers () const {
 104                 return _servers;
 105         }
 106
 107         bool only_servers_encode () const {
 108                 return _only_servers_encode;
 109         }
 110
 111         Protocol tms_protocol () const {
 112                 return _tms_protocol;
 113         }
 114
 115         /** @return The IP address of a TMS that we can copy DCPs to */
 116         std::string tms_ip () const {
 117                 return _tms_ip;
 118         }
 119
 120         /** @return The path on a TMS that we should changed DCPs to */
 121         std::string tms_path () const {
 122                 return _tms_path;
 123         }
 124
 125         /** @return User name to log into the TMS with */
 126         std::string tms_user () const {
 127                 return _tms_user;
 128         }
 129
 130         /** @return Password to log into the TMS with */
 131         std::string tms_password () const {
 132                 return _tms_password;
 133         }
 134
 135         /** @return The cinema sound processor that we are using */
 136         CinemaSoundProcessor const * cinema_sound_processor () const {
 137                 return _cinema_sound_processor;
 138         }
 139
 140         std::list<boost::shared_ptr<Cinema> > cinemas () const {
 141                 return _cinemas;
 142         }
 143
 144         std::list<int> allowed_dcp_frame_rates () const {
 145                 return _allowed_dcp_frame_rates;
 146         }
 147
 148         bool allow_any_dcp_frame_rate () const {
 149                 return _allow_any_dcp_frame_rate;
 150         }
 151
 152         bool allow_any_container () const {
 153                 return _allow_any_container;
 154         }
 155
 156         ISDCFMetadata default_isdcf_metadata () const {
 157                 return _default_isdcf_metadata;
 158         }
 159
 160         boost::optional<std::string> language () const {
 161                 return _language;
 162         }
 163
 164         int default_still_length () const {
 165                 return _default_still_length;
 166         }
 167
 168         Ratio const * default_container () const {
 169                 return _default_container;
 170         }
 171
 172         Ratio const * default_scale_to () const {
 173                 return _default_scale_to;
 174         }
 175
 176         DCPContentType const * default_dcp_content_type () const {
 177                 return _default_dcp_content_type;
 178         }
 179
 180         int default_dcp_audio_channels () const {
 181                 return _default_dcp_audio_channels;
 182         }
 183
 184         std::string dcp_issuer () const {
 185                 return _dcp_issuer;
 186         }
 187
 188         std::string dcp_creator () const {
 189                 return _dcp_creator;
 190         }
 191
 192         int default_j2k_bandwidth () const {
 193                 return _default_j2k_bandwidth;
 194         }
 195
 196         int default_audio_delay () const {
 197                 return _default_audio_delay;
 198         }
 199
 200         bool default_interop () const {
 201                 return _default_interop;
 202         }
 203
 204         bool default_upload_after_make_dcp () {
 205                 return _default_upload_after_make_dcp;
 206         }
 207
 208         void set_default_kdm_directory (boost::filesystem::path d) {
 209                 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
 210                         return;
 211                 }
 212                 _default_kdm_directory = d;
 213                 changed ();
 214         }
 215
 216         std::string mail_server () const {
 217                 return _mail_server;
 218         }
 219
 220         int mail_port () const {
 221                 return _mail_port;
 222         }
 223
 224         std::string mail_user () const {
 225                 return _mail_user;
 226         }
 227
 228         std::string mail_password () const {
 229                 return _mail_password;
 230         }
 231
 232         std::string kdm_subject () const {
 233                 return _kdm_subject;
 234         }
 235
 236         std::string kdm_from () const {
 237                 return _kdm_from;
 238         }
 239
 240         std::vector<std::string> kdm_cc () const {
 241                 return _kdm_cc;
 242         }
 243
 244         std::string kdm_bcc () const {
 245                 return _kdm_bcc;
 246         }
 247
 248         std::string kdm_email () const {
 249                 return _kdm_email;
 250         }
 251
 252         std::string notification_subject () const {
 253                 return _notification_subject;
 254         }
 255
 256         std::string notification_from () const {
 257                 return _notification_from;
 258         }
 259
 260         std::string notification_to () const {
 261                 return _notification_to;
 262         }
 263
 264         std::vector<std::string> notification_cc () const {
 265                 return _notification_cc;
 266         }
 267
 268         std::string notification_bcc () const {
 269                 return _notification_bcc;
 270         }
 271
 272         std::string notification_email () const {
 273                 return _notification_email;
 274         }
 275
 276         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 277                 return _signer_chain;
 278         }
 279
 280         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 281                 return _decryption_chain;
 282         }
 283
 284         bool check_for_updates () const {
 285                 return _check_for_updates;
 286         }
 287
 288         bool check_for_test_updates () const {
 289                 return _check_for_test_updates;
 290         }
 291
 292         int maximum_j2k_bandwidth () const {
 293                 return _maximum_j2k_bandwidth;
 294         }
 295
 296         int log_types () const {
 297                 return _log_types;
 298         }
 299
 300         bool analyse_ebur128 () const {
 301                 return _analyse_ebur128;
 302         }
 303
 304         bool automatic_audio_analysis () const {
 305                 return _automatic_audio_analysis;
 306         }
 307
 308 #ifdef DCPOMATIC_WINDOWS
 309         bool win32_console () const {
 310                 return _win32_console;
 311         }
 312 #endif
 313
 314         std::vector<boost::filesystem::path> history () const {
 315                 return _history;
 316         }
 317
 318         std::vector<boost::filesystem::path> player_history () const {
 319                 return _player_history;
 320         }
 321
 322         boost::shared_ptr<DKDMGroup> dkdms () const {
 323                 return _dkdms;
 324         }
 325
 326         boost::filesystem::path cinemas_file () const {
 327                 return _cinemas_file;
 328         }
 329
 330         bool show_hints_before_make_dcp () const {
 331                 return _show_hints_before_make_dcp;
 332         }
 333
 334         bool confirm_kdm_email () const {
 335                 return _confirm_kdm_email;
 336         }
 337
 338         dcp::NameFormat kdm_container_name_format () const {
 339                 return _kdm_container_name_format;
 340         }
 341
 342         dcp::NameFormat kdm_filename_format () const {
 343                 return _kdm_filename_format;
 344         }
 345
 346         dcp::NameFormat dcp_metadata_filename_format () const {
 347                 return _dcp_metadata_filename_format;
 348         }
 349
 350         dcp::NameFormat dcp_asset_filename_format () const {
 351                 return _dcp_asset_filename_format;
 352         }
 353
 354         bool jump_to_selected () const {
 355                 return _jump_to_selected;
 356         }
 357
 358         enum Nag {
 359                 NAG_DKDM_CONFIG,
 360                 NAG_ENCRYPTED_METADATA,
 361                 NAG_REMAKE_DECRYPTION_CHAIN,
 362                 NAG_BAD_SIGNER_CHAIN,
 363                 NAG_COUNT
 364         };
 365
 366         bool nagged (Nag nag) const {
 367                 return _nagged[nag];
 368         }
 369
 370         bool sound () const {
 371                 return _sound;
 372         }
 373
 374         std::string cover_sheet () const {
 375                 return _cover_sheet;
 376         }
 377
 378         boost::optional<std::string> sound_output () const {
 379                 return _sound_output;
 380         }
 381
 382         boost::optional<boost::filesystem::path> last_player_load_directory () const {
 383                 return _last_player_load_directory;
 384         }
 385
 386         enum KDMWriteType {
 387                 KDM_WRITE_FLAT,
 388                 KDM_WRITE_FOLDER,
 389                 KDM_WRITE_ZIP
 390         };
 391
 392         boost::optional<KDMWriteType> last_kdm_write_type () const {
 393                 return _last_kdm_write_type;
 394         }
 395
 396         enum DKDMWriteType {
 397                 DKDM_WRITE_INTERNAL,
 398                 DKDM_WRITE_FILE
 399         };
 400
 401         boost::optional<DKDMWriteType> last_dkdm_write_type () const {
 402                 return _last_dkdm_write_type;
 403         }
 404
 405         int frames_in_memory_multiplier () const {
 406                 return _frames_in_memory_multiplier;
 407         }
 408
 409         boost::optional<int> decode_reduction () const {
 410                 return _decode_reduction;
 411         }
 412
 413         bool default_notify () const {
 414                 return _default_notify;
 415         }
 416
 417         enum Notification {
 418                 MESSAGE_BOX,
 419                 EMAIL,
 420                 NOTIFICATION_COUNT
 421         };
 422
 423         bool notification (Notification n) const {
 424                 return _notification[n];
 425         }
 426
 427         boost::optional<std::string> barco_username () const {
 428                 return _barco_username;
 429         }
 430
 431         boost::optional<std::string> barco_password () const {
 432                 return _barco_password;
 433         }
 434
 435         boost::optional<std::string> christie_username () const {
 436                 return _christie_username;
 437         }
 438
 439         boost::optional<std::string> christie_password () const {
 440                 return _christie_password;
 441         }
 442
 443         boost::optional<std::string> gdc_username () const {
 444                 return _gdc_username;
 445         }
 446
 447         boost::optional<std::string> gdc_password () const {
 448                 return _gdc_password;
 449         }
 450
 451         enum Interface {
 452                 INTERFACE_SIMPLE,
 453                 INTERFACE_FULL
 454         };
 455
 456         Interface interface_complexity () const {
 457                 return _interface_complexity;
 458         }
 459
 460         /* SET (mostly) */
 461
 462         void set_master_encoding_threads (int n) {
 463                 maybe_set (_master_encoding_threads, n);
 464         }
 465
 466         void set_server_encoding_threads (int n) {
 467                 maybe_set (_server_encoding_threads, n);
 468         }
 469
 470         void set_default_directory (boost::filesystem::path d) {
 471                 if (_default_directory && *_default_directory == d) {
 472                         return;
 473                 }
 474                 _default_directory = d;
 475                 changed ();
 476         }
 477
 478         /** @param p New server port */
 479         void set_server_port_base (int p) {
 480                 maybe_set (_server_port_base, p);
 481         }
 482
 483         void set_only_servers_encode (bool o) {
 484                 maybe_set (_only_servers_encode, o);
 485         }
 486
 487         void set_tms_protocol (Protocol p) {
 488                 maybe_set (_tms_protocol, p);
 489         }
 490
 491         /** @param i IP address of a TMS that we can copy DCPs to */
 492         void set_tms_ip (std::string i) {
 493                 maybe_set (_tms_ip, i);
 494         }
 495
 496         /** @param p Path on a TMS that we should changed DCPs to */
 497         void set_tms_path (std::string p) {
 498                 maybe_set (_tms_path, p);
 499         }
 500
 501         /** @param u User name to log into the TMS with */
 502         void set_tms_user (std::string u) {
 503                 maybe_set (_tms_user, u);
 504         }
 505
 506         /** @param p Password to log into the TMS with */
 507         void set_tms_password (std::string p) {
 508                 maybe_set (_tms_password, p);
 509         }
 510
 511         void add_cinema (boost::shared_ptr<Cinema> c) {
 512                 _cinemas.push_back (c);
 513                 changed (CINEMAS);
 514         }
 515
 516         void remove_cinema (boost::shared_ptr<Cinema> c) {
 517                 _cinemas.remove (c);
 518                 changed (CINEMAS);
 519         }
 520
 521         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 522                 maybe_set (_allowed_dcp_frame_rates, r);
 523         }
 524
 525         void set_allow_any_dcp_frame_rate (bool a) {
 526                 maybe_set (_allow_any_dcp_frame_rate, a);
 527         }
 528
 529         void set_allow_any_container (bool a) {
 530                 maybe_set (_allow_any_container, a);
 531         }
 532
 533         void set_default_isdcf_metadata (ISDCFMetadata d) {
 534                 maybe_set (_default_isdcf_metadata, d);
 535         }
 536
 537         void set_language (std::string l) {
 538                 if (_language && _language.get() == l) {
 539                         return;
 540                 }
 541                 _language = l;
 542                 changed ();
 543         }
 544
 545         void unset_language () {
 546                 if (!_language) {
 547                         return;
 548                 }
 549
 550                 _language = boost::none;
 551                 changed ();
 552         }
 553
 554         void set_default_still_length (int s) {
 555                 maybe_set (_default_still_length, s);
 556         }
 557
 558         void set_default_container (Ratio const * c) {
 559                 maybe_set (_default_container, c);
 560         }
 561
 562         void set_default_scale_to (Ratio const * c) {
 563                 maybe_set (_default_scale_to, c);
 564         }
 565
 566         void set_default_dcp_content_type (DCPContentType const * t) {
 567                 maybe_set (_default_dcp_content_type, t);
 568         }
 569
 570         void set_default_dcp_audio_channels (int c) {
 571                 maybe_set (_default_dcp_audio_channels, c);
 572         }
 573
 574         void set_dcp_issuer (std::string i) {
 575                 maybe_set (_dcp_issuer, i);
 576         }
 577
 578         void set_dcp_creator (std::string c) {
 579                 maybe_set (_dcp_creator, c);
 580         }
 581
 582         void set_default_j2k_bandwidth (int b) {
 583                 maybe_set (_default_j2k_bandwidth, b);
 584         }
 585
 586         void set_default_audio_delay (int d) {
 587                 maybe_set (_default_audio_delay, d);
 588         }
 589
 590         void set_default_interop (bool i) {
 591                 maybe_set (_default_interop, i);
 592         }
 593
 594         void set_default_upload_after_make_dcp (bool u) {
 595                 maybe_set (_default_upload_after_make_dcp, u);
 596         }
 597
 598         void set_mail_server (std::string s) {
 599                 maybe_set (_mail_server, s);
 600         }
 601
 602         void set_mail_port (int p) {
 603                 maybe_set (_mail_port, p);
 604         }
 605
 606         void set_mail_user (std::string u) {
 607                 maybe_set (_mail_user, u);
 608         }
 609
 610         void set_mail_password (std::string p) {
 611                 maybe_set (_mail_password, p);
 612         }
 613
 614         void set_kdm_subject (std::string s) {
 615                 maybe_set (_kdm_subject, s);
 616         }
 617
 618         void set_kdm_from (std::string f) {
 619                 maybe_set (_kdm_from, f);
 620         }
 621
 622         void set_kdm_cc (std::vector<std::string> f) {
 623                 maybe_set (_kdm_cc, f);
 624         }
 625
 626         void set_kdm_bcc (std::string f) {
 627                 maybe_set (_kdm_bcc, f);
 628         }
 629
 630         void set_kdm_email (std::string e) {
 631                 maybe_set (_kdm_email, e);
 632         }
 633
 634         void reset_kdm_email ();
 635
 636         void set_notification_subject (std::string s) {
 637                 maybe_set (_notification_subject, s);
 638         }
 639
 640         void set_notification_from (std::string f) {
 641                 maybe_set (_notification_from, f);
 642         }
 643
 644         void set_notification_to (std::string t) {
 645                 maybe_set (_notification_to, t);
 646         }
 647
 648         void set_notification_cc (std::vector<std::string> f) {
 649                 maybe_set (_notification_cc, f);
 650         }
 651
 652         void set_notification_bcc (std::string f) {
 653                 maybe_set (_notification_bcc, f);
 654         }
 655
 656         void set_notification_email (std::string e) {
 657                 maybe_set (_notification_email, e);
 658         }
 659
 660         void reset_notification_email ();
 661
 662         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
 663                 maybe_set (_signer_chain, s);
 664         }
 665
 666         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
 667                 maybe_set (_decryption_chain, c);
 668         }
 669
 670         void set_check_for_updates (bool c) {
 671                 maybe_set (_check_for_updates, c);
 672                 if (!c) {
 673                         set_check_for_test_updates (false);
 674                 }
 675         }
 676
 677         void set_check_for_test_updates (bool c) {
 678                 maybe_set (_check_for_test_updates, c);
 679         }
 680
 681         void set_maximum_j2k_bandwidth (int b) {
 682                 maybe_set (_maximum_j2k_bandwidth, b);
 683         }
 684
 685         void set_log_types (int t) {
 686                 maybe_set (_log_types, t);
 687         }
 688
 689         void set_analyse_ebur128 (bool a) {
 690                 maybe_set (_analyse_ebur128, a);
 691         }
 692
 693         void set_automatic_audio_analysis (bool a) {
 694                 maybe_set (_automatic_audio_analysis, a);
 695         }
 696
 697 #ifdef DCPOMATIC_WINDOWS
 698         void set_win32_console (bool c) {
 699                 maybe_set (_win32_console, c);
 700         }
 701 #endif
 702
 703         void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
 704                 _dkdms = dkdms;
 705                 changed ();
 706         }
 707
 708         void set_cinemas_file (boost::filesystem::path file);
 709
 710         void set_show_hints_before_make_dcp (bool s) {
 711                 maybe_set (_show_hints_before_make_dcp, s);
 712         }
 713
 714         void set_confirm_kdm_email (bool s) {
 715                 maybe_set (_confirm_kdm_email, s);
 716         }
 717
 718         void set_sound (bool s) {
 719                 maybe_set (_sound, s, SOUND);
 720         }
 721
 722         void set_sound_output (std::string o) {
 723                 maybe_set (_sound_output, o, SOUND_OUTPUT);
 724         }
 725
 726         void set_last_player_load_directory (boost::filesystem::path d) {
 727                 maybe_set (_last_player_load_directory, d);
 728         }
 729
 730         void set_last_kdm_write_type (KDMWriteType t) {
 731                 maybe_set (_last_kdm_write_type, t);
 732         }
 733
 734         void set_last_dkdm_write_type (DKDMWriteType t) {
 735                 maybe_set (_last_dkdm_write_type, t);
 736         }
 737
 738         void unset_sound_output () {
 739                 if (!_sound_output) {
 740                         return;
 741                 }
 742
 743                 _sound_output = boost::none;
 744                 changed ();
 745         }
 746
 747         void set_kdm_container_name_format (dcp::NameFormat n) {
 748                 maybe_set (_kdm_container_name_format, n);
 749         }
 750
 751         void set_kdm_filename_format (dcp::NameFormat n) {
 752                 maybe_set (_kdm_filename_format, n);
 753         }
 754
 755         void set_dcp_metadata_filename_format (dcp::NameFormat n) {
 756                 maybe_set (_dcp_metadata_filename_format, n);
 757         }
 758
 759         void set_dcp_asset_filename_format (dcp::NameFormat n) {
 760                 maybe_set (_dcp_asset_filename_format, n);
 761         }
 762
 763         void set_frames_in_memory_multiplier (int m) {
 764                 maybe_set (_frames_in_memory_multiplier, m);
 765         }
 766
 767         void set_decode_reduction (boost::optional<int> r) {
 768                 maybe_set (_decode_reduction, r);
 769         }
 770
 771         void set_default_notify (bool n) {
 772                 maybe_set (_default_notify, n);
 773         }
 774
 775         void clear_history () {
 776                 _history.clear ();
 777                 changed ();
 778         }
 779
 780         void clear_player_history () {
 781                 _player_history.clear ();
 782                 changed ();
 783         }
 784
 785         void add_to_history (boost::filesystem::path p);
 786         void add_to_player_history (boost::filesystem::path p);
 787
 788         void set_jump_to_selected (bool j) {
 789                 maybe_set (_jump_to_selected, j);
 790         }
 791
 792         void set_nagged (Nag nag, bool nagged) {
 793                 maybe_set (_nagged[nag], nagged);
 794         }
 795
 796         void set_cover_sheet (std::string s) {
 797                 maybe_set (_cover_sheet, s);
 798         }
 799
 800         void reset_cover_sheet ();
 801
 802         void set_notification (Notification n, bool v) {
 803                 maybe_set (_notification[n], v);
 804         }
 805
 806         void set_barco_username (std::string u) {
 807                 maybe_set (_barco_username, u);
 808         }
 809
 810         void unset_barco_username () {
 811                 maybe_set (_barco_username, boost::optional<std::string>());
 812         }
 813
 814         void set_barco_password (std::string p) {
 815                 maybe_set (_barco_password, p);
 816         }
 817
 818         void unset_barco_password () {
 819                 maybe_set (_barco_password, boost::optional<std::string>());
 820         }
 821
 822         void set_christie_username (std::string u) {
 823                 maybe_set (_christie_username, u);
 824         }
 825
 826         void unset_christie_username () {
 827                 maybe_set (_christie_username, boost::optional<std::string>());
 828         }
 829
 830         void set_christie_password (std::string p) {
 831                 maybe_set (_christie_password, p);
 832         }
 833
 834         void unset_christie_password () {
 835                 maybe_set (_christie_password, boost::optional<std::string>());
 836         }
 837
 838         void set_gdc_username (std::string u) {
 839                 maybe_set (_gdc_username, u);
 840         }
 841
 842         void unset_gdc_username () {
 843                 maybe_set (_gdc_username, boost::optional<std::string>());
 844         }
 845
 846         void set_gdc_password (std::string p) {
 847                 maybe_set (_gdc_password, p);
 848         }
 849
 850         void unset_gdc_password () {
 851                 maybe_set (_gdc_password, boost::optional<std::string>());
 852         }
 853
 854         void set_interface_complexity (Interface i) {
 855                 maybe_set (_interface_complexity, i, INTERFACE_COMPLEXITY);
 856         }
 857
 858         void changed (Property p = OTHER);
 859         boost::signals2::signal<void (Property)> Changed;
 860         /** Emitted if read() failed on an existing Config file.  There is nothing
 861             a listener can do about it: this is just for information.
 862         */
 863         static boost::signals2::signal<void ()> FailedToLoad;
 864         /** Emitted if read() issued a warning which the user might want to know about */
 865         static boost::signals2::signal<void (std::string)> Warning;
 866         /** Emitted if there is a bad certificate in the signer chain.  Handler can call
 867          *  true to ask Config to re-create the chain.
 868          */
 869         static boost::signals2::signal<bool (void)> BadSignerChain;
 870
 871         void write () const;
 872         void write_config () const;
 873         void write_cinemas () const;
 874         void link (boost::filesystem::path new_file) const;
 875         void copy_and_link (boost::filesystem::path new_file) const;
 876
 877         void save_template (boost::shared_ptr<const Film> film, std::string name) const;
 878         bool existing_template (std::string name) const;
 879         std::list<std::string> templates () const;
 880         boost::filesystem::path template_path (std::string name) const;
 881         void rename_template (std::string old_name, std::string new_name) const;
 882         void delete_template (std::string name) const;
 883
 884         static Config* instance ();
 885         static void drop ();
 886         static void restore_defaults ();
 887         static bool have_existing (std::string);
 888         static boost::filesystem::path config_file ();
 889
 890         /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
 891         static boost::optional<boost::filesystem::path> override_path;
 892
 893 private:
 894         Config ();
 895         static boost::filesystem::path path (std::string file, bool create_directories = true);
 896         void read ();
 897         void set_defaults ();
 898         void set_kdm_email_to_default ();
 899         void set_notification_email_to_default ();
 900         void set_cover_sheet_to_default ();
 901         void read_cinemas (cxml::Document const & f);
 902         boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
 903         boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
 904         void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
 905         void backup ();
 906
 907         template <class T>
 908         void maybe_set (T& member, T new_value, Property prop = OTHER) {
 909                 if (member == new_value) {
 910                         return;
 911                 }
 912                 member = new_value;
 913                 changed (prop);
 914         }
 915
 916         template <class T>
 917         void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
 918                 if (member && member.get() == new_value) {
 919                         return;
 920                 }
 921                 member = new_value;
 922                 changed (prop);
 923         }
 924
 925         /** number of threads which a master DoM should use for J2K encoding on the local machine */
 926         int _master_encoding_threads;
 927         /** number of threads which a server should use for J2K encoding on the local machine */
 928         int _server_encoding_threads;
 929         /** default directory to put new films in */
 930         boost::optional<boost::filesystem::path> _default_directory;
 931         /** base port number to use for J2K encoding servers;
 932          *  this port and the two above it will be used.
 933          */
 934         int _server_port_base;
 935         /** true to broadcast on the `any' address to look for servers */
 936         bool _use_any_servers;
 937         /** J2K encoding servers that should definitely be used */
 938         std::vector<std::string> _servers;
 939         bool _only_servers_encode;
 940         Protocol _tms_protocol;
 941         /** The IP address of a TMS that we can copy DCPs to */
 942         std::string _tms_ip;
 943         /** The path on a TMS that we should write DCPs to */
 944         std::string _tms_path;
 945         /** User name to log into the TMS with */
 946         std::string _tms_user;
 947         /** Password to log into the TMS with */
 948         std::string _tms_password;
 949         /** Our cinema sound processor */
 950         CinemaSoundProcessor const * _cinema_sound_processor;
 951         std::list<int> _allowed_dcp_frame_rates;
 952         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 953         bool _allow_any_dcp_frame_rate;
 954         /** Allow any container ratio, not just the standard ones.  GDC SX-2001 will not play Flat
 955             DCPs at 25fps but will play 16:9, so this is very useful for some users.
 956             https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
 957         */
 958         bool _allow_any_container;
 959         /** Default ISDCF metadata for newly-created Films */
 960         ISDCFMetadata _default_isdcf_metadata;
 961         boost::optional<std::string> _language;
 962         /** Default length of still image content (seconds) */
 963         int _default_still_length;
 964         Ratio const * _default_container;
 965         Ratio const * _default_scale_to;
 966         DCPContentType const * _default_dcp_content_type;
 967         int _default_dcp_audio_channels;
 968         std::string _dcp_issuer;
 969         std::string _dcp_creator;
 970         int _default_j2k_bandwidth;
 971         int _default_audio_delay;
 972         bool _default_interop;
 973         /** Default directory to offer to write KDMs to; if it's not set,
 974             the home directory will be offered.
 975         */
 976         boost::optional<boost::filesystem::path> _default_kdm_directory;
 977         bool _default_upload_after_make_dcp;
 978         std::list<boost::shared_ptr<Cinema> > _cinemas;
 979         std::string _mail_server;
 980         int _mail_port;
 981         std::string _mail_user;
 982         std::string _mail_password;
 983         std::string _kdm_subject;
 984         std::string _kdm_from;
 985         std::vector<std::string> _kdm_cc;
 986         std::string _kdm_bcc;
 987         std::string _kdm_email;
 988         std::string _notification_subject;
 989         std::string _notification_from;
 990         std::string _notification_to;
 991         std::vector<std::string> _notification_cc;
 992         std::string _notification_bcc;
 993         std::string _notification_email;
 994         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
 995         /** Chain used to decrypt KDMs; the leaf of this chain is the target
 996          *  certificate for making KDMs given to DCP-o-matic.
 997          */
 998         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
 999         /** true to check for updates on startup */
1000         bool _check_for_updates;
1001         bool _check_for_test_updates;
1002         /** maximum allowed J2K bandwidth in bits per second */
1003         int _maximum_j2k_bandwidth;
1004         int _log_types;
1005         bool _analyse_ebur128;
1006         bool _automatic_audio_analysis;
1007 #ifdef DCPOMATIC_WINDOWS
1008         bool _win32_console;
1009 #endif
1010         std::vector<boost::filesystem::path> _history;
1011         std::vector<boost::filesystem::path> _player_history;
1012         boost::shared_ptr<DKDMGroup> _dkdms;
1013         boost::filesystem::path _cinemas_file;
1014         bool _show_hints_before_make_dcp;
1015         bool _confirm_kdm_email;
1016         dcp::NameFormat _kdm_filename_format;
1017         dcp::NameFormat _kdm_container_name_format;
1018         dcp::NameFormat _dcp_metadata_filename_format;
1019         dcp::NameFormat _dcp_asset_filename_format;
1020         bool _jump_to_selected;
1021         bool _nagged[NAG_COUNT];
1022         bool _sound;
1023         /** name of a specific sound output stream to use, or empty to use the default */
1024         boost::optional<std::string> _sound_output;
1025         std::string _cover_sheet;
1026         boost::optional<boost::filesystem::path> _last_player_load_directory;
1027         boost::optional<KDMWriteType> _last_kdm_write_type;
1028         boost::optional<DKDMWriteType> _last_dkdm_write_type;
1029         int _frames_in_memory_multiplier;
1030         boost::optional<int> _decode_reduction;
1031         bool _default_notify;
1032         bool _notification[NOTIFICATION_COUNT];
1033         boost::optional<std::string> _barco_username;
1034         boost::optional<std::string> _barco_password;
1035         boost::optional<std::string> _christie_username;
1036         boost::optional<std::string> _christie_password;
1037         boost::optional<std::string> _gdc_username;
1038         boost::optional<std::string> _gdc_password;
1039         Interface _interface_complexity;
1040
1041         static int const _current_version;
1042
1043         /** Singleton instance, or 0 */
1044         static Config* _instance;
1045 };
1046
1047 #endif