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