src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2017 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                 PREVIEW_SOUND,
  77                 PREVIEW_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         ISDCFMetadata default_isdcf_metadata () const {
 152                 return _default_isdcf_metadata;
 153         }
 154
 155         boost::optional<std::string> language () const {
 156                 return _language;
 157         }
 158
 159         int default_still_length () const {
 160                 return _default_still_length;
 161         }
 162
 163         Ratio const * default_container () const {
 164                 return _default_container;
 165         }
 166
 167         Ratio const * default_scale_to () const {
 168                 return _default_scale_to;
 169         }
 170
 171         DCPContentType const * default_dcp_content_type () const {
 172                 return _default_dcp_content_type;
 173         }
 174
 175         int default_dcp_audio_channels () const {
 176                 return _default_dcp_audio_channels;
 177         }
 178
 179         std::string dcp_issuer () const {
 180                 return _dcp_issuer;
 181         }
 182
 183         std::string dcp_creator () const {
 184                 return _dcp_creator;
 185         }
 186
 187         int default_j2k_bandwidth () const {
 188                 return _default_j2k_bandwidth;
 189         }
 190
 191         int default_audio_delay () const {
 192                 return _default_audio_delay;
 193         }
 194
 195         bool default_interop () const {
 196                 return _default_interop;
 197         }
 198
 199         void set_default_kdm_directory (boost::filesystem::path d) {
 200                 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
 201                         return;
 202                 }
 203                 _default_kdm_directory = d;
 204                 changed ();
 205         }
 206
 207         std::string mail_server () const {
 208                 return _mail_server;
 209         }
 210
 211         int mail_port () const {
 212                 return _mail_port;
 213         }
 214
 215         std::string mail_user () const {
 216                 return _mail_user;
 217         }
 218
 219         std::string mail_password () const {
 220                 return _mail_password;
 221         }
 222
 223         std::string kdm_subject () const {
 224                 return _kdm_subject;
 225         }
 226
 227         std::string kdm_from () const {
 228                 return _kdm_from;
 229         }
 230
 231         std::vector<std::string> kdm_cc () const {
 232                 return _kdm_cc;
 233         }
 234
 235         std::string kdm_bcc () const {
 236                 return _kdm_bcc;
 237         }
 238
 239         std::string kdm_email () const {
 240                 return _kdm_email;
 241         }
 242
 243         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 244                 return _signer_chain;
 245         }
 246
 247         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 248                 return _decryption_chain;
 249         }
 250
 251         bool check_for_updates () const {
 252                 return _check_for_updates;
 253         }
 254
 255         bool check_for_test_updates () const {
 256                 return _check_for_test_updates;
 257         }
 258
 259         int maximum_j2k_bandwidth () const {
 260                 return _maximum_j2k_bandwidth;
 261         }
 262
 263         int log_types () const {
 264                 return _log_types;
 265         }
 266
 267         bool analyse_ebur128 () const {
 268                 return _analyse_ebur128;
 269         }
 270
 271         bool automatic_audio_analysis () const {
 272                 return _automatic_audio_analysis;
 273         }
 274
 275 #ifdef DCPOMATIC_WINDOWS
 276         bool win32_console () const {
 277                 return _win32_console;
 278         }
 279 #endif
 280
 281         std::vector<boost::filesystem::path> history () const {
 282                 return _history;
 283         }
 284
 285         boost::shared_ptr<DKDMGroup> dkdms () const {
 286                 return _dkdms;
 287         }
 288
 289         boost::filesystem::path cinemas_file () const {
 290                 return _cinemas_file;
 291         }
 292
 293         bool show_hints_before_make_dcp () const {
 294                 return _show_hints_before_make_dcp;
 295         }
 296
 297         bool confirm_kdm_email () const {
 298                 return _confirm_kdm_email;
 299         }
 300
 301         dcp::NameFormat kdm_container_name_format () const {
 302                 return _kdm_container_name_format;
 303         }
 304
 305         dcp::NameFormat kdm_filename_format () const {
 306                 return _kdm_filename_format;
 307         }
 308
 309         dcp::NameFormat dcp_metadata_filename_format () const {
 310                 return _dcp_metadata_filename_format;
 311         }
 312
 313         dcp::NameFormat dcp_asset_filename_format () const {
 314                 return _dcp_asset_filename_format;
 315         }
 316
 317         bool jump_to_selected () const {
 318                 return _jump_to_selected;
 319         }
 320
 321         enum Nag {
 322                 NAG_DKDM_CONFIG,
 323                 NAG_ENCRYPTED_METADATA,
 324                 NAG_REMAKE_DECRYPTION_CHAIN,
 325                 NAG_COUNT
 326         };
 327
 328         bool nagged (Nag nag) const {
 329                 return _nagged[nag];
 330         }
 331
 332         bool preview_sound () const {
 333                 return _preview_sound;
 334         }
 335
 336         std::string cover_sheet () const {
 337                 return _cover_sheet;
 338         }
 339
 340         boost::optional<std::string> preview_sound_output () const {
 341                 return _preview_sound_output;
 342         }
 343
 344         void set_master_encoding_threads (int n) {
 345                 maybe_set (_master_encoding_threads, n);
 346         }
 347
 348         void set_server_encoding_threads (int n) {
 349                 maybe_set (_server_encoding_threads, n);
 350         }
 351
 352         void set_default_directory (boost::filesystem::path d) {
 353                 if (_default_directory && *_default_directory == d) {
 354                         return;
 355                 }
 356                 _default_directory = d;
 357                 changed ();
 358         }
 359
 360         /** @param p New server port */
 361         void set_server_port_base (int p) {
 362                 maybe_set (_server_port_base, p);
 363         }
 364
 365         void set_only_servers_encode (bool o) {
 366                 maybe_set (_only_servers_encode, o);
 367         }
 368
 369         void set_tms_protocol (Protocol p) {
 370                 maybe_set (_tms_protocol, p);
 371         }
 372
 373         /** @param i IP address of a TMS that we can copy DCPs to */
 374         void set_tms_ip (std::string i) {
 375                 maybe_set (_tms_ip, i);
 376         }
 377
 378         /** @param p Path on a TMS that we should changed DCPs to */
 379         void set_tms_path (std::string p) {
 380                 maybe_set (_tms_path, p);
 381         }
 382
 383         /** @param u User name to log into the TMS with */
 384         void set_tms_user (std::string u) {
 385                 maybe_set (_tms_user, u);
 386         }
 387
 388         /** @param p Password to log into the TMS with */
 389         void set_tms_password (std::string p) {
 390                 maybe_set (_tms_password, p);
 391         }
 392
 393         void add_cinema (boost::shared_ptr<Cinema> c) {
 394                 _cinemas.push_back (c);
 395                 changed (CINEMAS);
 396         }
 397
 398         void remove_cinema (boost::shared_ptr<Cinema> c) {
 399                 _cinemas.remove (c);
 400                 changed (CINEMAS);
 401         }
 402
 403         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 404                 maybe_set (_allowed_dcp_frame_rates, r);
 405         }
 406
 407         void set_allow_any_dcp_frame_rate (bool a) {
 408                 maybe_set (_allow_any_dcp_frame_rate, a);
 409         }
 410
 411         void set_default_isdcf_metadata (ISDCFMetadata d) {
 412                 maybe_set (_default_isdcf_metadata, d);
 413         }
 414
 415         void set_language (std::string l) {
 416                 if (_language && _language.get() == l) {
 417                         return;
 418                 }
 419                 _language = l;
 420                 changed ();
 421         }
 422
 423         void unset_language () {
 424                 if (!_language) {
 425                         return;
 426                 }
 427
 428                 _language = boost::none;
 429                 changed ();
 430         }
 431
 432         void set_default_still_length (int s) {
 433                 maybe_set (_default_still_length, s);
 434         }
 435
 436         void set_default_container (Ratio const * c) {
 437                 maybe_set (_default_container, c);
 438         }
 439
 440         void set_default_scale_to (Ratio const * c) {
 441                 maybe_set (_default_scale_to, c);
 442         }
 443
 444         void set_default_dcp_content_type (DCPContentType const * t) {
 445                 maybe_set (_default_dcp_content_type, t);
 446         }
 447
 448         void set_default_dcp_audio_channels (int c) {
 449                 maybe_set (_default_dcp_audio_channels, c);
 450         }
 451
 452         void set_dcp_issuer (std::string i) {
 453                 maybe_set (_dcp_issuer, i);
 454         }
 455
 456         void set_dcp_creator (std::string c) {
 457                 maybe_set (_dcp_creator, c);
 458         }
 459
 460         void set_default_j2k_bandwidth (int b) {
 461                 maybe_set (_default_j2k_bandwidth, b);
 462         }
 463
 464         void set_default_audio_delay (int d) {
 465                 maybe_set (_default_audio_delay, d);
 466         }
 467
 468         void set_default_interop (bool i) {
 469                 maybe_set (_default_interop, i);
 470         }
 471
 472         void set_mail_server (std::string s) {
 473                 maybe_set (_mail_server, s);
 474         }
 475
 476         void set_mail_port (int p) {
 477                 maybe_set (_mail_port, p);
 478         }
 479
 480         void set_mail_user (std::string u) {
 481                 maybe_set (_mail_user, u);
 482         }
 483
 484         void set_mail_password (std::string p) {
 485                 maybe_set (_mail_password, p);
 486         }
 487
 488         void set_kdm_subject (std::string s) {
 489                 maybe_set (_kdm_subject, s);
 490         }
 491
 492         void set_kdm_from (std::string f) {
 493                 maybe_set (_kdm_from, f);
 494         }
 495
 496         void set_kdm_cc (std::vector<std::string> f) {
 497                 maybe_set (_kdm_cc, f);
 498         }
 499
 500         void set_kdm_bcc (std::string f) {
 501                 maybe_set (_kdm_bcc, f);
 502         }
 503
 504         void set_kdm_email (std::string e) {
 505                 maybe_set (_kdm_email, e);
 506         }
 507
 508         void reset_kdm_email ();
 509
 510         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
 511                 maybe_set (_signer_chain, s);
 512         }
 513
 514         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
 515                 maybe_set (_decryption_chain, c);
 516         }
 517
 518         void set_check_for_updates (bool c) {
 519                 maybe_set (_check_for_updates, c);
 520                 if (!c) {
 521                         set_check_for_test_updates (false);
 522                 }
 523         }
 524
 525         void set_check_for_test_updates (bool c) {
 526                 maybe_set (_check_for_test_updates, c);
 527         }
 528
 529         void set_maximum_j2k_bandwidth (int b) {
 530                 maybe_set (_maximum_j2k_bandwidth, b);
 531         }
 532
 533         void set_log_types (int t) {
 534                 maybe_set (_log_types, t);
 535         }
 536
 537         void set_analyse_ebur128 (bool a) {
 538                 maybe_set (_analyse_ebur128, a);
 539         }
 540
 541         void set_automatic_audio_analysis (bool a) {
 542                 maybe_set (_automatic_audio_analysis, a);
 543         }
 544
 545 #ifdef DCPOMATIC_WINDOWS
 546         void set_win32_console (bool c) {
 547                 maybe_set (_win32_console, c);
 548         }
 549 #endif
 550
 551         void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
 552                 _dkdms = dkdms;
 553                 changed ();
 554         }
 555
 556         void set_cinemas_file (boost::filesystem::path file);
 557
 558         void set_show_hints_before_make_dcp (bool s) {
 559                 maybe_set (_show_hints_before_make_dcp, s);
 560         }
 561
 562         void set_confirm_kdm_email (bool s) {
 563                 maybe_set (_confirm_kdm_email, s);
 564         }
 565
 566         void set_preview_sound (bool s) {
 567                 maybe_set (_preview_sound, s, PREVIEW_SOUND);
 568         }
 569
 570         void set_preview_sound_output (std::string o)
 571         {
 572                 maybe_set (_preview_sound_output, o, PREVIEW_SOUND_OUTPUT);
 573         }
 574
 575         void unset_preview_sound_output ()
 576         {
 577                 if (!_preview_sound_output) {
 578                         return;
 579                 }
 580
 581                 _preview_sound_output = boost::none;
 582                 changed ();
 583         }
 584
 585         void set_kdm_container_name_format (dcp::NameFormat n) {
 586                 maybe_set (_kdm_container_name_format, n);
 587         }
 588
 589         void set_kdm_filename_format (dcp::NameFormat n) {
 590                 maybe_set (_kdm_filename_format, n);
 591         }
 592
 593         void set_dcp_metadata_filename_format (dcp::NameFormat n) {
 594                 maybe_set (_dcp_metadata_filename_format, n);
 595         }
 596
 597         void set_dcp_asset_filename_format (dcp::NameFormat n) {
 598                 maybe_set (_dcp_asset_filename_format, n);
 599         }
 600
 601         void clear_history () {
 602                 _history.clear ();
 603                 changed ();
 604         }
 605
 606         void add_to_history (boost::filesystem::path p);
 607
 608         void set_jump_to_selected (bool j) {
 609                 maybe_set (_jump_to_selected, j);
 610         }
 611
 612         void set_nagged (Nag nag, bool nagged) {
 613                 maybe_set (_nagged[nag], nagged);
 614         }
 615
 616         void set_cover_sheet (std::string s) {
 617                 maybe_set (_cover_sheet, s);
 618         }
 619
 620         void reset_cover_sheet ();
 621
 622         void changed (Property p = OTHER);
 623         boost::signals2::signal<void (Property)> Changed;
 624         /** Emitted if read() failed on an existing Config file.  There is nothing
 625             a listener can do about it: this is just for information.
 626         */
 627         static boost::signals2::signal<void ()> FailedToLoad;
 628
 629         void write () const;
 630         void write_config () const;
 631         void write_cinemas () const;
 632
 633         void save_template (boost::shared_ptr<const Film> film, std::string name) const;
 634         bool existing_template (std::string name) const;
 635         std::list<std::string> templates () const;
 636         boost::filesystem::path template_path (std::string name) const;
 637         void rename_template (std::string old_name, std::string new_name) const;
 638         void delete_template (std::string name) const;
 639
 640         static Config* instance ();
 641         static void drop ();
 642         static void restore_defaults ();
 643         static bool have_existing (std::string);
 644         static boost::filesystem::path config_path ();
 645
 646 private:
 647         Config ();
 648         static boost::filesystem::path path (std::string file, bool create_directories = true);
 649         static boost::filesystem::path target (boost::filesystem::path file);
 650         void read ();
 651         void set_defaults ();
 652         void set_kdm_email_to_default ();
 653         void set_cover_sheet_to_default ();
 654         void read_cinemas (cxml::Document const & f);
 655         boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
 656         boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
 657
 658         template <class T>
 659         void maybe_set (T& member, T new_value, Property prop = OTHER) {
 660                 if (member == new_value) {
 661                         return;
 662                 }
 663                 member = new_value;
 664                 changed (prop);
 665         }
 666
 667         template <class T>
 668         void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
 669                 if (member && member.get() == new_value) {
 670                         return;
 671                 }
 672                 member = new_value;
 673                 changed (prop);
 674         }
 675
 676         /** number of threads which a master DoM should use for J2K encoding on the local machine */
 677         int _master_encoding_threads;
 678         /** number of threads which a server should use for J2K encoding on the local machine */
 679         int _server_encoding_threads;
 680         /** default directory to put new films in */
 681         boost::optional<boost::filesystem::path> _default_directory;
 682         /** base port number to use for J2K encoding servers;
 683          *  this port and the two above it will be used.
 684          */
 685         int _server_port_base;
 686         /** true to broadcast on the `any' address to look for servers */
 687         bool _use_any_servers;
 688         /** J2K encoding servers that should definitely be used */
 689         std::vector<std::string> _servers;
 690         bool _only_servers_encode;
 691         Protocol _tms_protocol;
 692         /** The IP address of a TMS that we can copy DCPs to */
 693         std::string _tms_ip;
 694         /** The path on a TMS that we should write DCPs to */
 695         std::string _tms_path;
 696         /** User name to log into the TMS with */
 697         std::string _tms_user;
 698         /** Password to log into the TMS with */
 699         std::string _tms_password;
 700         /** Our cinema sound processor */
 701         CinemaSoundProcessor const * _cinema_sound_processor;
 702         std::list<int> _allowed_dcp_frame_rates;
 703         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 704         bool _allow_any_dcp_frame_rate;
 705         /** Default ISDCF metadata for newly-created Films */
 706         ISDCFMetadata _default_isdcf_metadata;
 707         boost::optional<std::string> _language;
 708         /** Default length of still image content (seconds) */
 709         int _default_still_length;
 710         Ratio const * _default_container;
 711         Ratio const * _default_scale_to;
 712         DCPContentType const * _default_dcp_content_type;
 713         int _default_dcp_audio_channels;
 714         std::string _dcp_issuer;
 715         std::string _dcp_creator;
 716         int _default_j2k_bandwidth;
 717         int _default_audio_delay;
 718         bool _default_interop;
 719         /** Default directory to offer to write KDMs to; if it's not set,
 720             the home directory will be offered.
 721         */
 722         boost::optional<boost::filesystem::path> _default_kdm_directory;
 723         std::list<boost::shared_ptr<Cinema> > _cinemas;
 724         std::string _mail_server;
 725         int _mail_port;
 726         std::string _mail_user;
 727         std::string _mail_password;
 728         std::string _kdm_subject;
 729         std::string _kdm_from;
 730         std::vector<std::string> _kdm_cc;
 731         std::string _kdm_bcc;
 732         std::string _kdm_email;
 733         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
 734         /** Chain used to decrypt KDMs; the leaf of this chain is the target
 735          *  certificate for making KDMs given to DCP-o-matic.
 736          */
 737         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
 738         /** true to check for updates on startup */
 739         bool _check_for_updates;
 740         bool _check_for_test_updates;
 741         /** maximum allowed J2K bandwidth in bits per second */
 742         int _maximum_j2k_bandwidth;
 743         int _log_types;
 744         bool _analyse_ebur128;
 745         bool _automatic_audio_analysis;
 746 #ifdef DCPOMATIC_WINDOWS
 747         bool _win32_console;
 748 #endif
 749         std::vector<boost::filesystem::path> _history;
 750         boost::shared_ptr<DKDMGroup> _dkdms;
 751         boost::filesystem::path _cinemas_file;
 752         bool _show_hints_before_make_dcp;
 753         bool _confirm_kdm_email;
 754         dcp::NameFormat _kdm_filename_format;
 755         dcp::NameFormat _kdm_container_name_format;
 756         dcp::NameFormat _dcp_metadata_filename_format;
 757         dcp::NameFormat _dcp_asset_filename_format;
 758         bool _jump_to_selected;
 759         bool _nagged[NAG_COUNT];
 760         bool _preview_sound;
 761         /** name of a specific sound output stream to use for preview, or empty to use the default */
 762         boost::optional<std::string> _preview_sound_output;
 763         std::string _cover_sheet;
 764
 765         /** Singleton instance, or 0 */
 766         static Config* _instance;
 767 };
 768
 769 #endif