src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/config.h
  21  *  @brief Class holding configuration.
  22  */
  23
  24 #ifndef DCPOMATIC_CONFIG_H
  25 #define DCPOMATIC_CONFIG_H
  26
  27 #include "isdcf_metadata.h"
  28 #include "video_content.h"
  29 #include <dcp/metadata.h>
  30 #include <dcp/certificate.h>
  31 #include <dcp/certificate_chain.h>
  32 #include <boost/shared_ptr.hpp>
  33 #include <boost/signals2.hpp>
  34 #include <boost/filesystem.hpp>
  35 #include <vector>
  36
  37 class ServerDescription;
  38 class Scaler;
  39 class Filter;
  40 class CinemaSoundProcessor;
  41 class DCPContentType;
  42 class Ratio;
  43 class Cinema;
  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 to use for J2K encoding on the local machine */
  52         int num_local_encoding_threads () const {
  53                 return _num_local_encoding_threads;
  54         }
  55
  56         boost::filesystem::path default_directory () const {
  57                 return _default_directory;
  58         }
  59
  60         boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
  61
  62         enum Property {
  63                 USE_ANY_SERVERS,
  64                 SERVERS,
  65                 OTHER
  66         };
  67
  68         /** @return base port number to use for J2K encoding servers */
  69         int server_port_base () const {
  70                 return _server_port_base;
  71         }
  72
  73         void set_use_any_servers (bool u) {
  74                 _use_any_servers = u;
  75                 changed (USE_ANY_SERVERS);
  76         }
  77
  78         bool use_any_servers () const {
  79                 return _use_any_servers;
  80         }
  81
  82         /** @param s New list of servers */
  83         void set_servers (std::vector<std::string> s) {
  84                 _servers = s;
  85                 changed (SERVERS);
  86         }
  87
  88         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
  89         std::vector<std::string> servers () const {
  90                 return _servers;
  91         }
  92
  93         Protocol tms_protocol () const {
  94                 return _tms_protocol;
  95         }
  96
  97         /** @return The IP address of a TMS that we can copy DCPs to */
  98         std::string tms_ip () const {
  99                 return _tms_ip;
 100         }
 101
 102         /** @return The path on a TMS that we should changed DCPs to */
 103         std::string tms_path () const {
 104                 return _tms_path;
 105         }
 106
 107         /** @return User name to log into the TMS with */
 108         std::string tms_user () const {
 109                 return _tms_user;
 110         }
 111
 112         /** @return Password to log into the TMS with */
 113         std::string tms_password () const {
 114                 return _tms_password;
 115         }
 116
 117         /** @return The cinema sound processor that we are using */
 118         CinemaSoundProcessor const * cinema_sound_processor () const {
 119                 return _cinema_sound_processor;
 120         }
 121
 122         std::list<boost::shared_ptr<Cinema> > cinemas () const {
 123                 return _cinemas;
 124         }
 125
 126         std::list<int> allowed_dcp_frame_rates () const {
 127                 return _allowed_dcp_frame_rates;
 128         }
 129
 130         bool allow_any_dcp_frame_rate () const {
 131                 return _allow_any_dcp_frame_rate;
 132         }
 133
 134         ISDCFMetadata default_isdcf_metadata () const {
 135                 return _default_isdcf_metadata;
 136         }
 137
 138         boost::optional<std::string> language () const {
 139                 return _language;
 140         }
 141
 142         int default_still_length () const {
 143                 return _default_still_length;
 144         }
 145
 146         Ratio const * default_container () const {
 147                 return _default_container;
 148         }
 149
 150         DCPContentType const * default_dcp_content_type () const {
 151                 return _default_dcp_content_type;
 152         }
 153
 154         std::string dcp_issuer () const {
 155                 return _dcp_issuer;
 156         }
 157
 158         int default_j2k_bandwidth () const {
 159                 return _default_j2k_bandwidth;
 160         }
 161
 162         int default_audio_delay () const {
 163                 return _default_audio_delay;
 164         }
 165
 166         std::string mail_server () const {
 167                 return _mail_server;
 168         }
 169
 170         int mail_port () const {
 171                 return _mail_port;
 172         }
 173
 174         std::string mail_user () const {
 175                 return _mail_user;
 176         }
 177
 178         std::string mail_password () const {
 179                 return _mail_password;
 180         }
 181
 182         std::string kdm_subject () const {
 183                 return _kdm_subject;
 184         }
 185
 186         std::string kdm_from () const {
 187                 return _kdm_from;
 188         }
 189
 190         std::string kdm_cc () const {
 191                 return _kdm_cc;
 192         }
 193
 194         std::string kdm_bcc () const {
 195                 return _kdm_bcc;
 196         }
 197
 198         std::string kdm_email () const {
 199                 return _kdm_email;
 200         }
 201
 202         boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
 203                 return _signer_chain;
 204         }
 205
 206         boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
 207                 return _decryption_chain;
 208         }
 209
 210         bool check_for_updates () const {
 211                 return _check_for_updates;
 212         }
 213
 214         bool check_for_test_updates () const {
 215                 return _check_for_test_updates;
 216         }
 217
 218         int maximum_j2k_bandwidth () const {
 219                 return _maximum_j2k_bandwidth;
 220         }
 221
 222         int log_types () const {
 223                 return _log_types;
 224         }
 225
 226 #ifdef DCPOMATIC_WINDOWS
 227         bool win32_console () const {
 228                 return _win32_console;
 229         }
 230 #endif
 231
 232         std::vector<boost::filesystem::path> history () const {
 233                 return _history;
 234         }
 235
 236         /** @param n New number of local encoding threads */
 237         void set_num_local_encoding_threads (int n) {
 238                 maybe_set (_num_local_encoding_threads, n);
 239         }
 240
 241         void set_default_directory (boost::filesystem::path d) {
 242                 maybe_set (_default_directory, d);
 243         }
 244
 245         /** @param p New server port */
 246         void set_server_port_base (int p) {
 247                 maybe_set (_server_port_base, p);
 248         }
 249
 250         void set_tms_protocol (Protocol p) {
 251                 maybe_set (_tms_protocol, p);
 252         }
 253
 254         /** @param i IP address of a TMS that we can copy DCPs to */
 255         void set_tms_ip (std::string i) {
 256                 maybe_set (_tms_ip, i);
 257         }
 258
 259         /** @param p Path on a TMS that we should changed DCPs to */
 260         void set_tms_path (std::string p) {
 261                 maybe_set (_tms_path, p);
 262         }
 263
 264         /** @param u User name to log into the TMS with */
 265         void set_tms_user (std::string u) {
 266                 maybe_set (_tms_user, u);
 267         }
 268
 269         /** @param p Password to log into the TMS with */
 270         void set_tms_password (std::string p) {
 271                 maybe_set (_tms_password, p);
 272         }
 273
 274         void add_cinema (boost::shared_ptr<Cinema> c) {
 275                 _cinemas.push_back (c);
 276                 changed ();
 277         }
 278
 279         void remove_cinema (boost::shared_ptr<Cinema> c) {
 280                 _cinemas.remove (c);
 281                 changed ();
 282         }
 283
 284         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 285                 maybe_set (_allowed_dcp_frame_rates, r);
 286         }
 287
 288         void set_allow_any_dcp_frame_rate (bool a) {
 289                 maybe_set (_allow_any_dcp_frame_rate, a);
 290         }
 291
 292         void set_default_isdcf_metadata (ISDCFMetadata d) {
 293                 maybe_set (_default_isdcf_metadata, d);
 294         }
 295
 296         void set_language (std::string l) {
 297                 if (_language && _language.get() == l) {
 298                         return;
 299                 }
 300                 _language = l;
 301                 changed ();
 302         }
 303
 304         void unset_language () {
 305                 if (!_language) {
 306                         return;
 307                 }
 308
 309                 _language = boost::none;
 310                 changed ();
 311         }
 312
 313         void set_default_still_length (int s) {
 314                 maybe_set (_default_still_length, s);
 315         }
 316
 317         void set_default_container (Ratio const * c) {
 318                 maybe_set (_default_container, c);
 319         }
 320
 321         void set_default_dcp_content_type (DCPContentType const * t) {
 322                 maybe_set (_default_dcp_content_type, t);
 323         }
 324
 325         void set_dcp_issuer (std::string i) {
 326                 maybe_set (_dcp_issuer, i);
 327         }
 328
 329         void set_default_j2k_bandwidth (int b) {
 330                 maybe_set (_default_j2k_bandwidth, b);
 331         }
 332
 333         void set_default_audio_delay (int d) {
 334                 maybe_set (_default_audio_delay, d);
 335         }
 336
 337         void set_mail_server (std::string s) {
 338                 maybe_set (_mail_server, s);
 339         }
 340
 341         void set_mail_port (int p) {
 342                 maybe_set (_mail_port, p);
 343         }
 344
 345         void set_mail_user (std::string u) {
 346                 maybe_set (_mail_user, u);
 347         }
 348
 349         void set_mail_password (std::string p) {
 350                 maybe_set (_mail_password, p);
 351         }
 352
 353         void set_kdm_subject (std::string s) {
 354                 maybe_set (_kdm_subject, s);
 355         }
 356
 357         void set_kdm_from (std::string f) {
 358                 maybe_set (_kdm_from, f);
 359         }
 360
 361         void set_kdm_cc (std::string f) {
 362                 maybe_set (_kdm_cc, f);
 363         }
 364
 365         void set_kdm_bcc (std::string f) {
 366                 maybe_set (_kdm_bcc, f);
 367         }
 368
 369         void set_kdm_email (std::string e) {
 370                 maybe_set (_kdm_email, e);
 371         }
 372
 373         void reset_kdm_email ();
 374
 375         void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
 376                 maybe_set (_signer_chain, s);
 377         }
 378
 379         void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
 380                 maybe_set (_decryption_chain, c);
 381         }
 382
 383         void set_check_for_updates (bool c) {
 384                 maybe_set (_check_for_updates, c);
 385         }
 386
 387         void set_check_for_test_updates (bool c) {
 388                 maybe_set (_check_for_test_updates, c);
 389         }
 390
 391         void set_maximum_j2k_bandwidth (int b) {
 392                 maybe_set (_maximum_j2k_bandwidth, b);
 393         }
 394
 395         void set_log_types (int t) {
 396                 maybe_set (_log_types, t);
 397         }
 398
 399 #ifdef DCPOMATIC_WINDOWS
 400         void set_win32_console (bool c) {
 401                 maybe_set (_win32_console, c);
 402         }
 403 #endif
 404
 405         void clear_history () {
 406                 _history.clear ();
 407                 changed ();
 408         }
 409
 410         void add_to_history (boost::filesystem::path p);
 411
 412         void changed (Property p = OTHER);
 413         boost::signals2::signal<void (Property)> Changed;
 414
 415         void write () const;
 416
 417         static Config* instance ();
 418         static void drop ();
 419         static void restore_defaults ();
 420
 421 private:
 422         Config ();
 423         boost::filesystem::path file () const;
 424         void read ();
 425         void set_defaults ();
 426         void set_kdm_email_to_default ();
 427
 428         template <class T>
 429         void maybe_set (T& member, T new_value) {
 430                 if (member == new_value) {
 431                         return;
 432                 }
 433                 member = new_value;
 434                 changed ();
 435         }
 436
 437         /** number of threads to use for J2K encoding on the local machine */
 438         int _num_local_encoding_threads;
 439         /** default directory to put new films in */
 440         boost::filesystem::path _default_directory;
 441         /** base port number to use for J2K encoding servers;
 442          *  this port and the one above it will be used.
 443          */
 444         int _server_port_base;
 445         /** true to broadcast on the `any' address to look for servers */
 446         bool _use_any_servers;
 447         /** J2K encoding servers that should definitely be used */
 448         std::vector<std::string> _servers;
 449         Protocol _tms_protocol;
 450         /** The IP address of a TMS that we can copy DCPs to */
 451         std::string _tms_ip;
 452         /** The path on a TMS that we should write DCPs to */
 453         std::string _tms_path;
 454         /** User name to log into the TMS with */
 455         std::string _tms_user;
 456         /** Password to log into the TMS with */
 457         std::string _tms_password;
 458         /** Our cinema sound processor */
 459         CinemaSoundProcessor const * _cinema_sound_processor;
 460         std::list<int> _allowed_dcp_frame_rates;
 461         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 462         bool _allow_any_dcp_frame_rate;
 463         /** Default ISDCF metadata for newly-created Films */
 464         ISDCFMetadata _default_isdcf_metadata;
 465         boost::optional<std::string> _language;
 466         /** Default length of still image content (seconds) */
 467         int _default_still_length;
 468         Ratio const * _default_container;
 469         DCPContentType const * _default_dcp_content_type;
 470         std::string _dcp_issuer;
 471         int _default_j2k_bandwidth;
 472         int _default_audio_delay;
 473         std::list<boost::shared_ptr<Cinema> > _cinemas;
 474         std::string _mail_server;
 475         int _mail_port;
 476         std::string _mail_user;
 477         std::string _mail_password;
 478         std::string _kdm_subject;
 479         std::string _kdm_from;
 480         std::string _kdm_cc;
 481         std::string _kdm_bcc;
 482         std::string _kdm_email;
 483         boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
 484         /** Chain used to decrypt KDMs; the leaf of this chain is the target
 485          *  certificate for making KDMs given to DCP-o-matic.
 486          */
 487         boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
 488         /** true to check for updates on startup */
 489         bool _check_for_updates;
 490         bool _check_for_test_updates;
 491         /** maximum allowed J2K bandwidth in bits per second */
 492         int _maximum_j2k_bandwidth;
 493         int _log_types;
 494 #ifdef DCPOMATIC_WINDOWS
 495         bool _win32_console;
 496 #endif
 497         std::vector<boost::filesystem::path> _history;
 498
 499         /** Singleton instance, or 0 */
 500         static Config* _instance;
 501 };
 502
 503 #endif