src/lib/config.h

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