src/lib/config.h

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