src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2022 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
  26 #ifndef DCPOMATIC_CONFIG_H
  27 #define DCPOMATIC_CONFIG_H
  28
  29
  30 #include "audio_mapping.h"
  31 #include "export_config.h"
  32 #include "rough_duration.h"
  33 #include "state.h"
  34 #include "types.h"
  35 #include <dcp/name_format.h>
  36 #include <dcp/certificate_chain.h>
  37 #include <dcp/encrypted_kdm.h>
  38 #include <dcp/language_tag.h>
  39 #include <boost/signals2.hpp>
  40 #include <boost/filesystem.hpp>
  41 #include <vector>
  42
  43
  44 class Cinema;
  45 class CinemaSoundProcessor;
  46 class DCPContentType;
  47 class DKDMGroup;
  48 class DKDMRecipient;
  49 class Film;
  50 class Ratio;
  51
  52
  53 extern void save_all_config_as_zip (boost::filesystem::path zip_file);
  54
  55
  56 /** @class Config
  57  *  @brief A singleton class holding configuration.
  58  */
  59 class Config : public State
  60 {
  61 public:
  62         /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
  63         int master_encoding_threads () const {
  64                 return _master_encoding_threads;
  65         }
  66
  67         /** @return number of threads which a server should use for J2K encoding on the local machine */
  68         int server_encoding_threads () const {
  69                 return _server_encoding_threads;
  70         }
  71
  72         boost::optional<boost::filesystem::path> default_directory () const {
  73                 return _default_directory;
  74         }
  75
  76         boost::optional<boost::filesystem::path> default_kdm_directory () const {
  77                 return _default_kdm_directory;
  78         }
  79
  80         boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
  81         boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
  82
  83         enum Property {
  84                 USE_ANY_SERVERS,
  85                 SERVERS,
  86                 CINEMAS,
  87                 DKDM_RECIPIENTS,
  88                 SOUND,
  89                 SOUND_OUTPUT,
  90                 PLAYER_CONTENT_DIRECTORY,
  91                 PLAYER_PLAYLIST_DIRECTORY,
  92                 PLAYER_DEBUG_LOG,
  93                 HISTORY,
  94                 SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
  95                 AUDIO_MAPPING,
  96                 AUTO_CROP_THRESHOLD,
  97                 OTHER
  98         };
  99
 100         /** @return base port number to use for J2K encoding servers */
 101         int server_port_base () const {
 102                 return _server_port_base;
 103         }
 104
 105         void set_use_any_servers (bool u) {
 106                 _use_any_servers = u;
 107                 changed (USE_ANY_SERVERS);
 108         }
 109
 110         bool use_any_servers () const {
 111                 return _use_any_servers;
 112         }
 113
 114         /** @param s New list of servers */
 115         void set_servers (std::vector<std::string> s) {
 116                 _servers = s;
 117                 changed (SERVERS);
 118         }
 119
 120         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
 121         std::vector<std::string> servers () const {
 122                 return _servers;
 123         }
 124
 125         bool only_servers_encode () const {
 126                 return _only_servers_encode;
 127         }
 128
 129         FileTransferProtocol tms_protocol () const {
 130                 return _tms_protocol;
 131         }
 132
 133         bool tms_passive() const {
 134                 return _tms_passive;
 135         }
 136
 137         /** @return The IP address of a TMS that we can copy DCPs to */
 138         std::string tms_ip () const {
 139                 return _tms_ip;
 140         }
 141
 142         /** @return The path on a TMS that we should changed DCPs to */
 143         std::string tms_path () const {
 144                 return _tms_path;
 145         }
 146
 147         /** @return User name to log into the TMS with */
 148         std::string tms_user () const {
 149                 return _tms_user;
 150         }
 151
 152         /** @return Password to log into the TMS with */
 153         std::string tms_password () const {
 154                 return _tms_password;
 155         }
 156
 157         std::list<std::shared_ptr<Cinema>> cinemas () const {
 158                 return _cinemas;
 159         }
 160
 161         std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
 162                 return _dkdm_recipients;
 163         }
 164
 165         std::list<int> allowed_dcp_frame_rates () const {
 166                 return _allowed_dcp_frame_rates;
 167         }
 168
 169         bool allow_any_dcp_frame_rate () const {
 170                 return _allow_any_dcp_frame_rate;
 171         }
 172
 173         bool allow_any_container () const {
 174                 return _allow_any_container;
 175         }
 176
 177         bool allow_96khz_audio () const {
 178                 return _allow_96khz_audio;
 179         }
 180
 181         bool use_all_audio_channels () const {
 182                 return _use_all_audio_channels;
 183         }
 184
 185         bool show_experimental_audio_processors () const {
 186                 return _show_experimental_audio_processors;
 187         }
 188
 189         boost::optional<std::string> language () const {
 190                 return _language;
 191         }
 192
 193         int default_still_length () const {
 194                 return _default_still_length;
 195         }
 196
 197         Ratio const * default_container () const {
 198                 return _default_container;
 199         }
 200
 201         DCPContentType const * default_dcp_content_type () const {
 202                 return _default_dcp_content_type;
 203         }
 204
 205         int default_dcp_audio_channels () const {
 206                 return _default_dcp_audio_channels;
 207         }
 208
 209         std::string dcp_issuer () const {
 210                 return _dcp_issuer;
 211         }
 212
 213         std::string dcp_creator () const {
 214                 return _dcp_creator;
 215         }
 216
 217         std::string dcp_company_name () const {
 218                 return _dcp_company_name;
 219         }
 220
 221         std::string dcp_product_name () const {
 222                 return _dcp_product_name;
 223         }
 224
 225         std::string dcp_product_version () const {
 226                 return _dcp_product_version;
 227         }
 228
 229         std::string dcp_j2k_comment () const {
 230                 return _dcp_j2k_comment;
 231         }
 232
 233         int default_j2k_bandwidth () const {
 234                 return _default_j2k_bandwidth;
 235         }
 236
 237         int default_audio_delay () const {
 238                 return _default_audio_delay;
 239         }
 240
 241         bool default_interop () const {
 242                 return _default_interop;
 243         }
 244
 245         std::map<std::string, std::string> default_metadata () const {
 246                 return _default_metadata;
 247         }
 248
 249         bool upload_after_make_dcp () {
 250                 return _upload_after_make_dcp;
 251         }
 252
 253         void set_default_kdm_directory (boost::filesystem::path d) {
 254                 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
 255                         return;
 256                 }
 257                 _default_kdm_directory = d;
 258                 changed ();
 259         }
 260
 261         std::string mail_server () const {
 262                 return _mail_server;
 263         }
 264
 265         int mail_port () const {
 266                 return _mail_port;
 267         }
 268
 269         EmailProtocol mail_protocol () const {
 270                 return _mail_protocol;
 271         }
 272
 273         std::string mail_user () const {
 274                 return _mail_user;
 275         }
 276
 277         std::string mail_password () const {
 278                 return _mail_password;
 279         }
 280
 281         std::string kdm_subject () const {
 282                 return _kdm_subject;
 283         }
 284
 285         std::string kdm_from () const {
 286                 return _kdm_from;
 287         }
 288
 289         std::vector<std::string> kdm_cc () const {
 290                 return _kdm_cc;
 291         }
 292
 293         std::string kdm_bcc () const {
 294                 return _kdm_bcc;
 295         }
 296
 297         std::string kdm_email () const {
 298                 return _kdm_email;
 299         }
 300
 301         std::string notification_subject () const {
 302                 return _notification_subject;
 303         }
 304
 305         std::string notification_from () const {
 306                 return _notification_from;
 307         }
 308
 309         std::string notification_to () const {
 310                 return _notification_to;
 311         }
 312
 313         std::vector<std::string> notification_cc () const {
 314                 return _notification_cc;
 315         }
 316
 317         std::string notification_bcc () const {
 318                 return _notification_bcc;
 319         }
 320
 321         std::string notification_email () const {
 322                 return _notification_email;
 323         }
 324
 325         std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 326                 return _signer_chain;
 327         }
 328
 329         std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 330                 return _decryption_chain;
 331         }
 332
 333         bool check_for_updates () const {
 334                 return _check_for_updates;
 335         }
 336
 337         bool check_for_test_updates () const {
 338                 return _check_for_test_updates;
 339         }
 340
 341         int maximum_j2k_bandwidth () const {
 342                 return _maximum_j2k_bandwidth;
 343         }
 344
 345         int log_types () const {
 346                 return _log_types;
 347         }
 348
 349         bool analyse_ebur128 () const {
 350                 return _analyse_ebur128;
 351         }
 352
 353         bool automatic_audio_analysis () const {
 354                 return _automatic_audio_analysis;
 355         }
 356
 357 #ifdef DCPOMATIC_WINDOWS
 358         bool win32_console () const {
 359                 return _win32_console;
 360         }
 361 #endif
 362
 363         std::vector<boost::filesystem::path> history () const {
 364                 return _history;
 365         }
 366
 367         std::vector<boost::filesystem::path> player_history () const {
 368                 return _player_history;
 369         }
 370
 371         std::shared_ptr<DKDMGroup> dkdms () const {
 372                 return _dkdms;
 373         }
 374
 375         boost::filesystem::path cinemas_file () const {
 376                 return _cinemas_file;
 377         }
 378
 379         boost::filesystem::path dkdm_recipients_file () const {
 380                 return _dkdm_recipients_file;
 381         }
 382
 383         bool show_hints_before_make_dcp () const {
 384                 return _show_hints_before_make_dcp;
 385         }
 386
 387         bool confirm_kdm_email () const {
 388                 return _confirm_kdm_email;
 389         }
 390
 391         dcp::NameFormat kdm_container_name_format () const {
 392                 return _kdm_container_name_format;
 393         }
 394
 395         dcp::NameFormat kdm_filename_format () const {
 396                 return _kdm_filename_format;
 397         }
 398
 399         dcp::NameFormat dkdm_filename_format () const {
 400                 return _dkdm_filename_format;
 401         }
 402
 403         dcp::NameFormat dcp_metadata_filename_format () const {
 404                 return _dcp_metadata_filename_format;
 405         }
 406
 407         dcp::NameFormat dcp_asset_filename_format () const {
 408                 return _dcp_asset_filename_format;
 409         }
 410
 411         bool jump_to_selected () const {
 412                 return _jump_to_selected;
 413         }
 414
 415         /* This could be an enum class but we use the enum a lot to index _nagged
 416          * so it means a lot of casts.
 417          */
 418         enum Nag {
 419                 NAG_DKDM_CONFIG,
 420                 NAG_ENCRYPTED_METADATA,
 421                 NAG_ALTER_DECRYPTION_CHAIN,
 422                 NAG_BAD_SIGNER_CHAIN_UTF8,
 423                 NAG_IMPORT_DECRYPTION_CHAIN,
 424                 NAG_DELETE_DKDM,
 425                 NAG_32_ON_64,
 426                 NAG_TOO_MANY_DROPPED_FRAMES,
 427                 NAG_BAD_SIGNER_CHAIN_VALIDITY,
 428                 NAG_COUNT
 429         };
 430
 431         bool nagged (Nag nag) const {
 432                 return _nagged[nag];
 433         }
 434
 435         bool sound () const {
 436                 return _sound;
 437         }
 438
 439         std::string cover_sheet () const {
 440                 return _cover_sheet;
 441         }
 442
 443         boost::optional<std::string> sound_output () const {
 444                 return _sound_output;
 445         }
 446
 447         boost::optional<boost::filesystem::path> last_player_load_directory () const {
 448                 return _last_player_load_directory;
 449         }
 450
 451         enum KDMWriteType {
 452                 KDM_WRITE_FLAT,
 453                 KDM_WRITE_FOLDER,
 454                 KDM_WRITE_ZIP
 455         };
 456
 457         boost::optional<KDMWriteType> last_kdm_write_type () const {
 458                 return _last_kdm_write_type;
 459         }
 460
 461         enum DKDMWriteType {
 462                 DKDM_WRITE_INTERNAL,
 463                 DKDM_WRITE_FILE
 464         };
 465
 466         boost::optional<DKDMWriteType> last_dkdm_write_type () const {
 467                 return _last_dkdm_write_type;
 468         }
 469
 470         int frames_in_memory_multiplier () const {
 471                 return _frames_in_memory_multiplier;
 472         }
 473
 474         boost::optional<int> decode_reduction () const {
 475                 return _decode_reduction;
 476         }
 477
 478         bool default_notify () const {
 479                 return _default_notify;
 480         }
 481
 482         enum Notification {
 483                 MESSAGE_BOX,
 484                 EMAIL,
 485                 NOTIFICATION_COUNT
 486         };
 487
 488         bool notification (Notification n) const {
 489                 return _notification[n];
 490         }
 491
 492         boost::optional<std::string> barco_username () const {
 493                 return _barco_username;
 494         }
 495
 496         boost::optional<std::string> barco_password () const {
 497                 return _barco_password;
 498         }
 499
 500         boost::optional<std::string> christie_username () const {
 501                 return _christie_username;
 502         }
 503
 504         boost::optional<std::string> christie_password () const {
 505                 return _christie_password;
 506         }
 507
 508         boost::optional<std::string> gdc_username () const {
 509                 return _gdc_username;
 510         }
 511
 512         boost::optional<std::string> gdc_password () const {
 513                 return _gdc_password;
 514         }
 515
 516         enum PlayerMode {
 517                 PLAYER_MODE_WINDOW, ///< one window containing image and controls
 518                 PLAYER_MODE_FULL,   ///< just the image filling the screen
 519                 PLAYER_MODE_DUAL    ///< image on one monitor and extended controls on the other
 520         };
 521
 522         PlayerMode player_mode () const {
 523                 return _player_mode;
 524         }
 525
 526         int image_display () const {
 527                 return _image_display;
 528         }
 529
 530         enum VideoViewType {
 531                 VIDEO_VIEW_SIMPLE,
 532                 VIDEO_VIEW_OPENGL
 533         };
 534
 535         VideoViewType video_view_type () const {
 536                 return _video_view_type;
 537         }
 538
 539         bool respect_kdm_validity_periods () const {
 540                 return _respect_kdm_validity_periods;
 541         }
 542
 543         boost::optional<boost::filesystem::path> player_debug_log_file () const {
 544                 return _player_debug_log_file;
 545         }
 546
 547         boost::optional<boost::filesystem::path> player_content_directory () const {
 548                 return _player_content_directory;
 549         }
 550
 551         boost::optional<boost::filesystem::path> player_playlist_directory () const {
 552                 return _player_playlist_directory;
 553         }
 554
 555         boost::optional<boost::filesystem::path> player_kdm_directory () const {
 556                 return _player_kdm_directory;
 557         }
 558
 559         AudioMapping audio_mapping (int output_channels);
 560
 561         std::vector<dcp::LanguageTag> custom_languages () const {
 562                 return _custom_languages;
 563         }
 564
 565         boost::optional<boost::filesystem::path> add_files_path () const {
 566                 return _add_files_path;
 567         }
 568
 569         bool use_isdcf_name_by_default () const {
 570                 return _use_isdcf_name_by_default;
 571         }
 572
 573         bool write_kdms_to_disk () const {
 574                 return _write_kdms_to_disk;
 575         }
 576
 577         bool email_kdms () const {
 578                 return _email_kdms;
 579         }
 580
 581         dcp::Formulation default_kdm_type () const {
 582                 return _default_kdm_type;
 583         }
 584
 585         RoughDuration default_kdm_duration () const {
 586                 return _default_kdm_duration;
 587         }
 588
 589         double auto_crop_threshold () const {
 590                 return _auto_crop_threshold;
 591         }
 592
 593         boost::optional<std::string> last_release_notes_version () const {
 594                 return _last_release_notes_version;
 595         }
 596
 597         boost::optional<int> main_divider_sash_position() const {
 598                 return _main_divider_sash_position;
 599         }
 600
 601         boost::optional<int> main_content_divider_sash_position() const {
 602                 return _main_content_divider_sash_position;
 603         }
 604
 605         /* SET (mostly) */
 606
 607         void set_master_encoding_threads (int n) {
 608                 maybe_set (_master_encoding_threads, n);
 609         }
 610
 611         void set_server_encoding_threads (int n) {
 612                 maybe_set (_server_encoding_threads, n);
 613         }
 614
 615         void set_default_directory (boost::filesystem::path d) {
 616                 if (_default_directory && *_default_directory == d) {
 617                         return;
 618                 }
 619                 _default_directory = d;
 620                 changed ();
 621         }
 622
 623         /** @param p New server port */
 624         void set_server_port_base (int p) {
 625                 maybe_set (_server_port_base, p);
 626         }
 627
 628         void set_only_servers_encode (bool o) {
 629                 maybe_set (_only_servers_encode, o);
 630         }
 631
 632         void set_tms_protocol (FileTransferProtocol p) {
 633                 maybe_set (_tms_protocol, p);
 634         }
 635
 636         void set_tms_passive(bool passive) {
 637                 maybe_set(_tms_passive, passive);
 638         }
 639
 640         /** @param i IP address of a TMS that we can copy DCPs to */
 641         void set_tms_ip (std::string i) {
 642                 maybe_set (_tms_ip, i);
 643         }
 644
 645         /** @param p Path on a TMS that we should changed DCPs to */
 646         void set_tms_path (std::string p) {
 647                 maybe_set (_tms_path, p);
 648         }
 649
 650         /** @param u User name to log into the TMS with */
 651         void set_tms_user (std::string u) {
 652                 maybe_set (_tms_user, u);
 653         }
 654
 655         /** @param p Password to log into the TMS with */
 656         void set_tms_password (std::string p) {
 657                 maybe_set (_tms_password, p);
 658         }
 659
 660         void add_cinema (std::shared_ptr<Cinema> c) {
 661                 _cinemas.push_back (c);
 662                 changed (CINEMAS);
 663         }
 664
 665         void remove_cinema (std::shared_ptr<Cinema> c) {
 666                 _cinemas.remove (c);
 667                 changed (CINEMAS);
 668         }
 669
 670         void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
 671                 _dkdm_recipients.push_back (c);
 672                 changed (DKDM_RECIPIENTS);
 673         }
 674
 675         void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
 676                 _dkdm_recipients.remove (c);
 677                 changed (DKDM_RECIPIENTS);
 678         }
 679
 680         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 681                 maybe_set (_allowed_dcp_frame_rates, r);
 682         }
 683
 684         void set_allow_any_dcp_frame_rate (bool a) {
 685                 maybe_set (_allow_any_dcp_frame_rate, a);
 686         }
 687
 688         void set_allow_any_container (bool a) {
 689                 maybe_set (_allow_any_container, a);
 690         }
 691
 692         void set_allow_96hhz_audio (bool a) {
 693                 maybe_set (_allow_96khz_audio, a);
 694         }
 695
 696         void set_use_all_audio_channels (bool a) {
 697                 maybe_set (_use_all_audio_channels, a);
 698         }
 699
 700         void set_show_experimental_audio_processors (bool e) {
 701                 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
 702         }
 703
 704         void set_language (std::string l) {
 705                 if (_language && _language.get() == l) {
 706                         return;
 707                 }
 708                 _language = l;
 709                 changed ();
 710         }
 711
 712         void unset_language () {
 713                 if (!_language) {
 714                         return;
 715                 }
 716
 717                 _language = boost::none;
 718                 changed ();
 719         }
 720
 721         void set_default_still_length (int s) {
 722                 maybe_set (_default_still_length, s);
 723         }
 724
 725         void set_default_container (Ratio const * c) {
 726                 maybe_set (_default_container, c);
 727         }
 728
 729         void set_default_dcp_content_type (DCPContentType const * t) {
 730                 maybe_set (_default_dcp_content_type, t);
 731         }
 732
 733         void set_default_dcp_audio_channels (int c) {
 734                 maybe_set (_default_dcp_audio_channels, c);
 735         }
 736
 737         void set_dcp_issuer (std::string i) {
 738                 maybe_set (_dcp_issuer, i);
 739         }
 740
 741         void set_dcp_creator (std::string c) {
 742                 maybe_set (_dcp_creator, c);
 743         }
 744
 745         void set_dcp_company_name (std::string c) {
 746                 maybe_set (_dcp_company_name, c);
 747         }
 748
 749         void set_dcp_product_name (std::string c) {
 750                 maybe_set (_dcp_product_name, c);
 751         }
 752
 753         void set_dcp_product_version (std::string c) {
 754                 maybe_set (_dcp_product_version, c);
 755         }
 756
 757         void set_dcp_j2k_comment (std::string c) {
 758                 maybe_set (_dcp_j2k_comment, c);
 759         }
 760
 761         void set_default_j2k_bandwidth (int b) {
 762                 maybe_set (_default_j2k_bandwidth, b);
 763         }
 764
 765         void set_default_audio_delay (int d) {
 766                 maybe_set (_default_audio_delay, d);
 767         }
 768
 769         void set_default_interop (bool i) {
 770                 maybe_set (_default_interop, i);
 771         }
 772
 773         void set_default_metadata (std::map<std::string, std::string> const& metadata) {
 774                 maybe_set (_default_metadata, metadata);
 775         }
 776
 777         void set_upload_after_make_dcp (bool u) {
 778                 maybe_set (_upload_after_make_dcp, u);
 779         }
 780
 781         void set_mail_server (std::string s) {
 782                 maybe_set (_mail_server, s);
 783         }
 784
 785         void set_mail_port (int p) {
 786                 maybe_set (_mail_port, p);
 787         }
 788
 789         void set_mail_protocol (EmailProtocol p) {
 790                 maybe_set (_mail_protocol, p);
 791         }
 792
 793         void set_mail_user (std::string u) {
 794                 maybe_set (_mail_user, u);
 795         }
 796
 797         void set_mail_password (std::string p) {
 798                 maybe_set (_mail_password, p);
 799         }
 800
 801         void set_kdm_subject (std::string s) {
 802                 maybe_set (_kdm_subject, s);
 803         }
 804
 805         void set_kdm_from (std::string f) {
 806                 maybe_set (_kdm_from, f);
 807         }
 808
 809         void set_kdm_cc (std::vector<std::string> f) {
 810                 maybe_set (_kdm_cc, f);
 811         }
 812
 813         void set_kdm_bcc (std::string f) {
 814                 maybe_set (_kdm_bcc, f);
 815         }
 816
 817         void set_kdm_email (std::string e) {
 818                 maybe_set (_kdm_email, e);
 819         }
 820
 821         void reset_kdm_email ();
 822
 823         void set_notification_subject (std::string s) {
 824                 maybe_set (_notification_subject, s);
 825         }
 826
 827         void set_notification_from (std::string f) {
 828                 maybe_set (_notification_from, f);
 829         }
 830
 831         void set_notification_to (std::string t) {
 832                 maybe_set (_notification_to, t);
 833         }
 834
 835         void set_notification_cc (std::vector<std::string> f) {
 836                 maybe_set (_notification_cc, f);
 837         }
 838
 839         void set_notification_bcc (std::string f) {
 840                 maybe_set (_notification_bcc, f);
 841         }
 842
 843         void set_notification_email (std::string e) {
 844                 maybe_set (_notification_email, e);
 845         }
 846
 847         void reset_notification_email ();
 848
 849         void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
 850                 maybe_set (_signer_chain, s);
 851         }
 852
 853         void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
 854                 maybe_set (_decryption_chain, c);
 855         }
 856
 857         void set_check_for_updates (bool c) {
 858                 maybe_set (_check_for_updates, c);
 859                 if (!c) {
 860                         set_check_for_test_updates (false);
 861                 }
 862         }
 863
 864         void set_check_for_test_updates (bool c) {
 865                 maybe_set (_check_for_test_updates, c);
 866         }
 867
 868         void set_maximum_j2k_bandwidth (int b) {
 869                 maybe_set (_maximum_j2k_bandwidth, b);
 870         }
 871
 872         void set_log_types (int t) {
 873                 maybe_set (_log_types, t);
 874         }
 875
 876         void set_analyse_ebur128 (bool a) {
 877                 maybe_set (_analyse_ebur128, a);
 878         }
 879
 880         void set_automatic_audio_analysis (bool a) {
 881                 maybe_set (_automatic_audio_analysis, a);
 882         }
 883
 884 #ifdef DCPOMATIC_WINDOWS
 885         void set_win32_console (bool c) {
 886                 maybe_set (_win32_console, c);
 887         }
 888 #endif
 889
 890         void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
 891                 _dkdms = dkdms;
 892                 changed ();
 893         }
 894
 895         void set_cinemas_file (boost::filesystem::path file);
 896
 897         void set_show_hints_before_make_dcp (bool s) {
 898                 maybe_set (_show_hints_before_make_dcp, s);
 899         }
 900
 901         void set_confirm_kdm_email (bool s) {
 902                 maybe_set (_confirm_kdm_email, s);
 903         }
 904
 905         void set_sound (bool s) {
 906                 maybe_set (_sound, s, SOUND);
 907         }
 908
 909         void set_sound_output (std::string o) {
 910                 maybe_set (_sound_output, o, SOUND_OUTPUT);
 911         }
 912
 913         void set_last_player_load_directory (boost::filesystem::path d) {
 914                 maybe_set (_last_player_load_directory, d);
 915         }
 916
 917         void set_last_kdm_write_type (KDMWriteType t) {
 918                 maybe_set (_last_kdm_write_type, t);
 919         }
 920
 921         void set_last_dkdm_write_type (DKDMWriteType t) {
 922                 maybe_set (_last_dkdm_write_type, t);
 923         }
 924
 925         void unset_sound_output () {
 926                 if (!_sound_output) {
 927                         return;
 928                 }
 929
 930                 _sound_output = boost::none;
 931                 changed ();
 932         }
 933
 934         void set_kdm_container_name_format (dcp::NameFormat n) {
 935                 maybe_set (_kdm_container_name_format, n);
 936         }
 937
 938         void set_kdm_filename_format (dcp::NameFormat n) {
 939                 maybe_set (_kdm_filename_format, n);
 940         }
 941
 942         void set_dkdm_filename_format (dcp::NameFormat n) {
 943                 maybe_set (_dkdm_filename_format, n);
 944         }
 945
 946         void set_dcp_metadata_filename_format (dcp::NameFormat n) {
 947                 maybe_set (_dcp_metadata_filename_format, n);
 948         }
 949
 950         void set_dcp_asset_filename_format (dcp::NameFormat n) {
 951                 maybe_set (_dcp_asset_filename_format, n);
 952         }
 953
 954         void set_frames_in_memory_multiplier (int m) {
 955                 maybe_set (_frames_in_memory_multiplier, m);
 956         }
 957
 958         void set_decode_reduction (boost::optional<int> r) {
 959                 maybe_set (_decode_reduction, r);
 960         }
 961
 962         void set_default_notify (bool n) {
 963                 maybe_set (_default_notify, n);
 964         }
 965
 966         void clear_history () {
 967                 _history.clear ();
 968                 changed ();
 969         }
 970
 971         void clear_player_history () {
 972                 _player_history.clear ();
 973                 changed ();
 974         }
 975
 976         void add_to_history (boost::filesystem::path p);
 977         void clean_history ();
 978         void add_to_player_history (boost::filesystem::path p);
 979         void clean_player_history ();
 980
 981         void set_jump_to_selected (bool j) {
 982                 maybe_set (_jump_to_selected, j);
 983         }
 984
 985         void set_nagged (Nag nag, bool nagged) {
 986                 maybe_set (_nagged[nag], nagged);
 987         }
 988
 989         void set_cover_sheet (std::string s) {
 990                 maybe_set (_cover_sheet, s);
 991         }
 992
 993         void reset_cover_sheet ();
 994
 995         void set_notification (Notification n, bool v) {
 996                 maybe_set (_notification[n], v);
 997         }
 998
 999         void set_barco_username (std::string u) {
1000                 maybe_set (_barco_username, u);
1001         }
1002
1003         void unset_barco_username () {
1004                 maybe_set (_barco_username, boost::optional<std::string>());
1005         }
1006
1007         void set_barco_password (std::string p) {
1008                 maybe_set (_barco_password, p);
1009         }
1010
1011         void unset_barco_password () {
1012                 maybe_set (_barco_password, boost::optional<std::string>());
1013         }
1014
1015         void set_christie_username (std::string u) {
1016                 maybe_set (_christie_username, u);
1017         }
1018
1019         void unset_christie_username () {
1020                 maybe_set (_christie_username, boost::optional<std::string>());
1021         }
1022
1023         void set_christie_password (std::string p) {
1024                 maybe_set (_christie_password, p);
1025         }
1026
1027         void unset_christie_password () {
1028                 maybe_set (_christie_password, boost::optional<std::string>());
1029         }
1030
1031         void set_gdc_username (std::string u) {
1032                 maybe_set (_gdc_username, u);
1033         }
1034
1035         void unset_gdc_username () {
1036                 maybe_set (_gdc_username, boost::optional<std::string>());
1037         }
1038
1039         void set_gdc_password (std::string p) {
1040                 maybe_set (_gdc_password, p);
1041         }
1042
1043         void unset_gdc_password () {
1044                 maybe_set (_gdc_password, boost::optional<std::string>());
1045         }
1046
1047         void set_player_mode (PlayerMode m) {
1048                 maybe_set (_player_mode, m);
1049         }
1050
1051         void set_image_display (int n) {
1052                 maybe_set (_image_display, n);
1053         }
1054
1055         void set_video_view_type (VideoViewType v) {
1056                 maybe_set (_video_view_type, v);
1057         }
1058
1059         void set_respect_kdm_validity_periods (bool r) {
1060                 maybe_set (_respect_kdm_validity_periods, r);
1061         }
1062
1063         void set_player_debug_log_file (boost::filesystem::path p) {
1064                 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1065         }
1066
1067         void unset_player_debug_log_file () {
1068                 if (!_player_debug_log_file) {
1069                         return;
1070                 }
1071                 _player_debug_log_file = boost::none;
1072                 changed (PLAYER_DEBUG_LOG);
1073         }
1074
1075         void set_player_content_directory (boost::filesystem::path p) {
1076                 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1077         }
1078
1079         void unset_player_content_directory () {
1080                 if (!_player_content_directory) {
1081                         return;
1082                 }
1083                 _player_content_directory = boost::none;
1084                 changed (PLAYER_CONTENT_DIRECTORY);
1085         }
1086
1087         void set_player_playlist_directory (boost::filesystem::path p) {
1088                 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1089         }
1090
1091         void unset_player_playlist_directory () {
1092                 if (!_player_playlist_directory) {
1093                         return;
1094                 }
1095                 _player_playlist_directory = boost::none;
1096                 changed (PLAYER_PLAYLIST_DIRECTORY);
1097         }
1098
1099         void set_player_kdm_directory (boost::filesystem::path p) {
1100                 maybe_set (_player_kdm_directory, p);
1101         }
1102
1103         void unset_player_kdm_directory () {
1104                 if (!_player_kdm_directory) {
1105                         return;
1106                 }
1107                 _player_kdm_directory = boost::none;
1108                 changed ();
1109         }
1110
1111         void set_audio_mapping (AudioMapping m);
1112         void set_audio_mapping_to_default ();
1113
1114         void add_custom_language (dcp::LanguageTag tag);
1115
1116         void set_add_files_path (boost::filesystem::path p) {
1117                 _add_files_path = p;
1118                 changed ();
1119         }
1120
1121         void set_use_isdcf_name_by_default (bool use) {
1122                 maybe_set (_use_isdcf_name_by_default, use);
1123         }
1124
1125         void set_write_kdms_to_disk (bool write) {
1126                 maybe_set (_write_kdms_to_disk, write);
1127         }
1128
1129         void set_email_kdms (bool email) {
1130                 maybe_set (_email_kdms, email);
1131         }
1132
1133         void set_default_kdm_type (dcp::Formulation type) {
1134                 maybe_set (_default_kdm_type, type);
1135         }
1136
1137         void set_default_kdm_duration (RoughDuration duration) {
1138                 maybe_set (_default_kdm_duration, duration);
1139         }
1140
1141         void set_auto_crop_threshold (double threshold) {
1142                 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1143         }
1144
1145         void set_last_release_notes_version (std::string version) {
1146                 maybe_set (_last_release_notes_version, version);
1147         }
1148
1149         void unset_last_release_notes_version() {
1150                 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1151         }
1152
1153         ExportConfig& export_config() {
1154                 return _export;
1155         }
1156
1157         void set_main_divider_sash_position(int position) {
1158                 maybe_set(_main_divider_sash_position, position);
1159         }
1160
1161         void set_main_content_divider_sash_position(int position) {
1162                 maybe_set(_main_content_divider_sash_position, position);
1163         }
1164
1165         void changed (Property p = OTHER);
1166         boost::signals2::signal<void (Property)> Changed;
1167         /** Emitted if read() failed on an existing Config file.  There is nothing
1168             a listener can do about it: this is just for information.
1169         */
1170         enum class LoadFailure {
1171                 CONFIG,
1172                 CINEMAS,
1173                 DKDM_RECIPIENTS
1174         };
1175         static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1176         /** Emitted if read() issued a warning which the user might want to know about */
1177         static boost::signals2::signal<void (std::string)> Warning;
1178         /** Emitted if there is a something wrong the contents of our config.  Handler can call
1179          *  true to ask Config to solve the problem (by discarding and recreating the bad thing)
1180          */
1181         enum BadReason {
1182                 BAD_SIGNER_UTF8_STRINGS,      ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1183                 BAD_SIGNER_INCONSISTENT,      ///< signer chain is somehow inconsistent
1184                 BAD_DECRYPTION_INCONSISTENT,  ///< KDM decryption chain is somehow inconsistent
1185                 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1186         };
1187
1188         static boost::signals2::signal<bool (BadReason)> Bad;
1189
1190         void write () const override;
1191         void write_config () const;
1192         void write_cinemas () const;
1193         void write_dkdm_recipients () const;
1194         void link (boost::filesystem::path new_file) const;
1195         void copy_and_link (boost::filesystem::path new_file) const;
1196         bool have_write_permission () const;
1197
1198         void save_template (std::shared_ptr<const Film> film, std::string name) const;
1199         bool existing_template (std::string name) const;
1200         std::list<std::string> templates () const;
1201         boost::filesystem::path template_read_path (std::string name) const;
1202         boost::filesystem::path template_write_path (std::string name) const;
1203         void rename_template (std::string old_name, std::string new_name) const;
1204         void delete_template (std::string name) const;
1205
1206         boost::optional<BadReason> check_certificates () const;
1207
1208         static Config* instance ();
1209         static void drop ();
1210         static void restore_defaults ();
1211         static bool have_existing (std::string);
1212         static boost::filesystem::path config_read_file ();
1213         static boost::filesystem::path config_write_file ();
1214
1215         template <class T>
1216         void maybe_set (T& member, T new_value, Property prop = OTHER) {
1217                 if (member == new_value) {
1218                         return;
1219                 }
1220                 member = new_value;
1221                 changed (prop);
1222         }
1223
1224         template <class T>
1225         void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1226                 if (member && member.get() == new_value) {
1227                         return;
1228                 }
1229                 member = new_value;
1230                 changed (prop);
1231         }
1232
1233 private:
1234         Config ();
1235         void read () override;
1236         void read_config();
1237         void read_cinemas();
1238         void read_dkdm_recipients();
1239         void set_defaults ();
1240         void set_kdm_email_to_default ();
1241         void set_notification_email_to_default ();
1242         void set_cover_sheet_to_default ();
1243         void read_cinemas (cxml::Document const & f);
1244         void read_dkdm_recipients (cxml::Document const & f);
1245         std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1246         boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1247         void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1248         void clean_history_internal (std::vector<boost::filesystem::path>& h);
1249         void backup ();
1250
1251         /** number of threads which a master DoM should use for J2K encoding on the local machine */
1252         int _master_encoding_threads;
1253         /** number of threads which a server should use for J2K encoding on the local machine */
1254         int _server_encoding_threads;
1255         /** default directory to put new films in */
1256         boost::optional<boost::filesystem::path> _default_directory;
1257         /** base port number to use for J2K encoding servers;
1258          *  this port and the two above it will be used.
1259          */
1260         int _server_port_base;
1261         /** true to broadcast on the `any' address to look for servers */
1262         bool _use_any_servers;
1263         /** J2K encoding servers that should definitely be used */
1264         std::vector<std::string> _servers;
1265         bool _only_servers_encode;
1266         FileTransferProtocol _tms_protocol;
1267         bool _tms_passive;
1268         /** The IP address of a TMS that we can copy DCPs to */
1269         std::string _tms_ip;
1270         /** The path on a TMS that we should write DCPs to */
1271         std::string _tms_path;
1272         /** User name to log into the TMS with */
1273         std::string _tms_user;
1274         /** Password to log into the TMS with */
1275         std::string _tms_password;
1276         /** The list of possible DCP frame rates that DCP-o-matic will use */
1277         std::list<int> _allowed_dcp_frame_rates;
1278         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1279         bool _allow_any_dcp_frame_rate;
1280         /** Allow any container ratio, not just the standard ones.  GDC SX-2001 will not play Flat
1281             DCPs at 25fps but will play 16:9, so this is very useful for some users.
1282             https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1283         */
1284         bool _allow_any_container;
1285         bool _allow_96khz_audio;
1286         bool _use_all_audio_channels;
1287         /** Offer the upmixers in the audio processor settings */
1288         bool _show_experimental_audio_processors;
1289         boost::optional<std::string> _language;
1290         /** Default length of still image content (seconds) */
1291         int _default_still_length;
1292         Ratio const * _default_container;
1293         DCPContentType const * _default_dcp_content_type;
1294         int _default_dcp_audio_channels;
1295         std::string _dcp_issuer;
1296         std::string _dcp_creator;
1297         std::string _dcp_company_name;
1298         std::string _dcp_product_name;
1299         std::string _dcp_product_version;
1300         std::string _dcp_j2k_comment;
1301         int _default_j2k_bandwidth;
1302         int _default_audio_delay;
1303         bool _default_interop;
1304         std::map<std::string, std::string> _default_metadata;
1305         /** Default directory to offer to write KDMs to; if it's not set,
1306             the home directory will be offered.
1307         */
1308         boost::optional<boost::filesystem::path> _default_kdm_directory;
1309         bool _upload_after_make_dcp;
1310         std::list<std::shared_ptr<Cinema>> _cinemas;
1311         std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1312         std::string _mail_server;
1313         int _mail_port;
1314         EmailProtocol _mail_protocol;
1315         std::string _mail_user;
1316         std::string _mail_password;
1317         std::string _kdm_subject;
1318         std::string _kdm_from;
1319         std::vector<std::string> _kdm_cc;
1320         std::string _kdm_bcc;
1321         std::string _kdm_email;
1322         std::string _notification_subject;
1323         std::string _notification_from;
1324         std::string _notification_to;
1325         std::vector<std::string> _notification_cc;
1326         std::string _notification_bcc;
1327         std::string _notification_email;
1328         std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1329         /** Chain used to decrypt KDMs; the leaf of this chain is the target
1330          *  certificate for making KDMs given to DCP-o-matic.
1331          */
1332         std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1333         /** true to check for updates on startup */
1334         bool _check_for_updates;
1335         bool _check_for_test_updates;
1336         /** maximum allowed J2K bandwidth in bits per second */
1337         int _maximum_j2k_bandwidth;
1338         int _log_types;
1339         bool _analyse_ebur128;
1340         bool _automatic_audio_analysis;
1341 #ifdef DCPOMATIC_WINDOWS
1342         bool _win32_console;
1343 #endif
1344         std::vector<boost::filesystem::path> _history;
1345         std::vector<boost::filesystem::path> _player_history;
1346         std::shared_ptr<DKDMGroup> _dkdms;
1347         boost::filesystem::path _cinemas_file;
1348         boost::filesystem::path _dkdm_recipients_file;
1349         bool _show_hints_before_make_dcp;
1350         bool _confirm_kdm_email;
1351         dcp::NameFormat _kdm_filename_format;
1352         dcp::NameFormat _dkdm_filename_format;
1353         dcp::NameFormat _kdm_container_name_format;
1354         dcp::NameFormat _dcp_metadata_filename_format;
1355         dcp::NameFormat _dcp_asset_filename_format;
1356         bool _jump_to_selected;
1357         bool _nagged[NAG_COUNT];
1358         bool _sound;
1359         /** name of a specific sound output stream to use, or empty to use the default */
1360         boost::optional<std::string> _sound_output;
1361         std::string _cover_sheet;
1362         boost::optional<boost::filesystem::path> _last_player_load_directory;
1363         boost::optional<KDMWriteType> _last_kdm_write_type;
1364         boost::optional<DKDMWriteType> _last_dkdm_write_type;
1365         int _frames_in_memory_multiplier;
1366         boost::optional<int> _decode_reduction;
1367         bool _default_notify;
1368         bool _notification[NOTIFICATION_COUNT];
1369         boost::optional<std::string> _barco_username;
1370         boost::optional<std::string> _barco_password;
1371         boost::optional<std::string> _christie_username;
1372         boost::optional<std::string> _christie_password;
1373         boost::optional<std::string> _gdc_username;
1374         boost::optional<std::string> _gdc_password;
1375         PlayerMode _player_mode;
1376         int _image_display;
1377         VideoViewType _video_view_type;
1378         bool _respect_kdm_validity_periods;
1379         /** Log file containing debug information for the player */
1380         boost::optional<boost::filesystem::path> _player_debug_log_file;
1381         /** A directory containing DCPs whose contents are presented to the user
1382             in the dual-screen player mode.  DCPs on the list can be loaded
1383             for playback.
1384         */
1385         boost::optional<boost::filesystem::path> _player_content_directory;
1386         boost::optional<boost::filesystem::path> _player_playlist_directory;
1387         boost::optional<boost::filesystem::path> _player_kdm_directory;
1388         boost::optional<AudioMapping> _audio_mapping;
1389         std::vector<dcp::LanguageTag> _custom_languages;
1390         boost::optional<boost::filesystem::path> _add_files_path;
1391         bool _use_isdcf_name_by_default;
1392         bool _write_kdms_to_disk;
1393         bool _email_kdms;
1394         dcp::Formulation _default_kdm_type;
1395         RoughDuration _default_kdm_duration;
1396         double _auto_crop_threshold;
1397         boost::optional<std::string> _last_release_notes_version;
1398         boost::optional<int> _main_divider_sash_position;
1399         boost::optional<int> _main_content_divider_sash_position;
1400
1401         ExportConfig _export;
1402
1403         static int const _current_version;
1404
1405         /** Singleton instance, or 0 */
1406         static Config* _instance;
1407 };
1408
1409
1410 #endif