src/lib/config.h

   1 /*
   2     Copyright (C) 2012-2014 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/certificates.h>
  31 #include <dcp/signer.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         /** @return base port number to use for J2K encoding servers */
  63         int server_port_base () const {
  64                 return _server_port_base;
  65         }
  66
  67         void set_use_any_servers (bool u) {
  68                 _use_any_servers = u;
  69                 changed ();
  70         }
  71
  72         bool use_any_servers () const {
  73                 return _use_any_servers;
  74         }
  75
  76         /** @param s New list of servers */
  77         void set_servers (std::vector<std::string> s) {
  78                 _servers = s;
  79                 changed ();
  80         }
  81
  82         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
  83         std::vector<std::string> servers () const {
  84                 return _servers;
  85         }
  86
  87         /** @return The IP address of a TMS that we can copy DCPs to */
  88         std::string tms_ip () const {
  89                 return _tms_ip;
  90         }
  91
  92         /** @return The path on a TMS that we should changed DCPs to */
  93         std::string tms_path () const {
  94                 return _tms_path;
  95         }
  96
  97         /** @return User name to log into the TMS with */
  98         std::string tms_user () const {
  99                 return _tms_user;
 100         }
 101
 102         /** @return Password to log into the TMS with */
 103         std::string tms_password () const {
 104                 return _tms_password;
 105         }
 106
 107         /** @return The cinema sound processor that we are using */
 108         CinemaSoundProcessor const * cinema_sound_processor () const {
 109                 return _cinema_sound_processor;
 110         }
 111
 112         std::list<boost::shared_ptr<Cinema> > cinemas () const {
 113                 return _cinemas;
 114         }
 115
 116         std::list<int> allowed_dcp_frame_rates () const {
 117                 return _allowed_dcp_frame_rates;
 118         }
 119
 120         bool allow_any_dcp_frame_rate () const {
 121                 return _allow_any_dcp_frame_rate;
 122         }
 123
 124         ISDCFMetadata default_isdcf_metadata () const {
 125                 return _default_isdcf_metadata;
 126         }
 127
 128         boost::optional<std::string> language () const {
 129                 return _language;
 130         }
 131
 132         int default_still_length () const {
 133                 return _default_still_length;
 134         }
 135
 136         Ratio const * default_container () const {
 137                 return _default_container;
 138         }
 139
 140         DCPContentType const * default_dcp_content_type () const {
 141                 return _default_dcp_content_type;
 142         }
 143
 144         std::string dcp_issuer () const {
 145                 return _dcp_issuer;
 146         }
 147
 148         int default_j2k_bandwidth () const {
 149                 return _default_j2k_bandwidth;
 150         }
 151
 152         int default_audio_delay () const {
 153                 return _default_audio_delay;
 154         }
 155
 156         std::string mail_server () const {
 157                 return _mail_server;
 158         }
 159
 160         std::string mail_user () const {
 161                 return _mail_user;
 162         }
 163
 164         std::string mail_password () const {
 165                 return _mail_password;
 166         }
 167
 168         std::string kdm_subject () const {
 169                 return _kdm_subject;
 170         }
 171
 172         std::string kdm_from () const {
 173                 return _kdm_from;
 174         }
 175
 176         std::string kdm_cc () const {
 177                 return _kdm_cc;
 178         }
 179
 180         std::string kdm_bcc () const {
 181                 return _kdm_bcc;
 182         }
 183
 184         std::string kdm_email () const {
 185                 return _kdm_email;
 186         }
 187
 188         boost::shared_ptr<const dcp::Signer> signer () const {
 189                 return _signer;
 190         }
 191
 192         dcp::Certificate decryption_certificate () const {
 193                 return _decryption_certificate;
 194         }
 195
 196         std::string decryption_private_key () const {
 197                 return _decryption_private_key;
 198         }
 199
 200         bool check_for_updates () const {
 201                 return _check_for_updates;
 202         }
 203
 204         bool check_for_test_updates () const {
 205                 return _check_for_test_updates;
 206         }
 207
 208         int maximum_j2k_bandwidth () const {
 209                 return _maximum_j2k_bandwidth;
 210         }
 211
 212         int log_types () const {
 213                 return _log_types;
 214         }
 215
 216 #ifdef DCPOMATIC_WINDOWS
 217         bool win32_console () const {
 218                 return _win32_console;
 219         }
 220 #endif
 221
 222         std::vector<boost::filesystem::path> history () const {
 223                 return _history;
 224         }
 225
 226         /** @param n New number of local encoding threads */
 227         void set_num_local_encoding_threads (int n) {
 228                 maybe_set (_num_local_encoding_threads, n);
 229         }
 230
 231         void set_default_directory (boost::filesystem::path d) {
 232                 maybe_set (_default_directory, d);
 233         }
 234
 235         /** @param p New server port */
 236         void set_server_port_base (int p) {
 237                 maybe_set (_server_port_base, p);
 238         }
 239
 240         /** @param i IP address of a TMS that we can copy DCPs to */
 241         void set_tms_ip (std::string i) {
 242                 maybe_set (_tms_ip, i);
 243         }
 244
 245         /** @param p Path on a TMS that we should changed DCPs to */
 246         void set_tms_path (std::string p) {
 247                 maybe_set (_tms_path, p);
 248         }
 249
 250         /** @param u User name to log into the TMS with */
 251         void set_tms_user (std::string u) {
 252                 maybe_set (_tms_user, u);
 253         }
 254
 255         /** @param p Password to log into the TMS with */
 256         void set_tms_password (std::string p) {
 257                 maybe_set (_tms_password, p);
 258         }
 259
 260         void add_cinema (boost::shared_ptr<Cinema> c) {
 261                 _cinemas.push_back (c);
 262                 changed ();
 263         }
 264
 265         void remove_cinema (boost::shared_ptr<Cinema> c) {
 266                 _cinemas.remove (c);
 267                 changed ();
 268         }
 269
 270         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 271                 maybe_set (_allowed_dcp_frame_rates, r);
 272         }
 273
 274         void set_allow_any_dcp_frame_rate (bool a) {
 275                 maybe_set (_allow_any_dcp_frame_rate, a);
 276         }
 277
 278         void set_default_isdcf_metadata (ISDCFMetadata d) {
 279                 maybe_set (_default_isdcf_metadata, d);
 280         }
 281
 282         void set_language (std::string l) {
 283                 if (_language && _language.get() == l) {
 284                         return;
 285                 }
 286                 _language = l;
 287                 changed ();
 288         }
 289
 290         void unset_language () {
 291                 if (!_language) {
 292                         return;
 293                 }
 294
 295                 _language = boost::none;
 296                 changed ();
 297         }
 298
 299         void set_default_still_length (int s) {
 300                 maybe_set (_default_still_length, s);
 301         }
 302
 303         void set_default_container (Ratio const * c) {
 304                 maybe_set (_default_container, c);
 305         }
 306
 307         void set_default_dcp_content_type (DCPContentType const * t) {
 308                 maybe_set (_default_dcp_content_type, t);
 309         }
 310
 311         void set_dcp_issuer (std::string i) {
 312                 maybe_set (_dcp_issuer, i);
 313         }
 314
 315         void set_default_j2k_bandwidth (int b) {
 316                 maybe_set (_default_j2k_bandwidth, b);
 317         }
 318
 319         void set_default_audio_delay (int d) {
 320                 maybe_set (_default_audio_delay, d);
 321         }
 322
 323         void set_mail_server (std::string s) {
 324                 maybe_set (_mail_server, s);
 325         }
 326
 327         void set_mail_user (std::string u) {
 328                 maybe_set (_mail_user, u);
 329         }
 330
 331         void set_mail_password (std::string p) {
 332                 maybe_set (_mail_password, p);
 333         }
 334
 335         void set_kdm_subject (std::string s) {
 336                 maybe_set (_kdm_subject, s);
 337         }
 338
 339         void set_kdm_from (std::string f) {
 340                 maybe_set (_kdm_from, f);
 341         }
 342
 343         void set_kdm_cc (std::string f) {
 344                 maybe_set (_kdm_cc, f);
 345         }
 346
 347         void set_kdm_bcc (std::string f) {
 348                 maybe_set (_kdm_bcc, f);
 349         }
 350
 351         void set_kdm_email (std::string e) {
 352                 maybe_set (_kdm_email, e);
 353         }
 354
 355         void reset_kdm_email ();
 356
 357         void set_signer (boost::shared_ptr<const dcp::Signer> s) {
 358                 maybe_set (_signer, s);
 359         }
 360
 361         void set_decryption_certificate (dcp::Certificate c) {
 362                 maybe_set (_decryption_certificate, c);
 363         }
 364
 365         void set_decryption_private_key (std::string k) {
 366                 maybe_set (_decryption_private_key, k);
 367         }
 368
 369         void set_check_for_updates (bool c) {
 370                 maybe_set (_check_for_updates, c);
 371         }
 372
 373         void set_check_for_test_updates (bool c) {
 374                 maybe_set (_check_for_test_updates, c);
 375         }
 376
 377         void set_maximum_j2k_bandwidth (int b) {
 378                 maybe_set (_maximum_j2k_bandwidth, b);
 379         }
 380
 381         void set_log_types (int t) {
 382                 maybe_set (_log_types, t);
 383         }
 384
 385 #ifdef DCPOMATIC_WINDOWS
 386         void set_win32_console (bool c) {
 387                 maybe_set (_win32_console, c);
 388         }
 389 #endif
 390
 391         void clear_history () {
 392                 _history.clear ();
 393                 changed ();
 394         }
 395
 396         void add_to_history (boost::filesystem::path p);
 397
 398         void changed ();
 399         boost::signals2::signal<void ()> Changed;
 400
 401         void write () const;
 402
 403         static Config* instance ();
 404         static void drop ();
 405         static void restore_defaults ();
 406
 407 private:
 408         Config ();
 409         boost::filesystem::path file () const;
 410         void read ();
 411         void make_decryption_keys ();
 412         void set_defaults ();
 413         void set_kdm_email_to_default ();
 414
 415         template <class T>
 416         void maybe_set (T& member, T new_value) {
 417                 if (member == new_value) {
 418                         return;
 419                 }
 420                 member = new_value;
 421                 changed ();
 422         }
 423
 424         /** number of threads to use for J2K encoding on the local machine */
 425         int _num_local_encoding_threads;
 426         /** default directory to put new films in */
 427         boost::filesystem::path _default_directory;
 428         /** base port number to use for J2K encoding servers;
 429          *  this port and the one above it will be used.
 430          */
 431         int _server_port_base;
 432         /** true to broadcast on the `any' address to look for servers */
 433         bool _use_any_servers;
 434         /** J2K encoding servers that should definitely be used */
 435         std::vector<std::string> _servers;
 436         /** The IP address of a TMS that we can copy DCPs to */
 437         std::string _tms_ip;
 438         /** The path on a TMS that we should write DCPs to */
 439         std::string _tms_path;
 440         /** User name to log into the TMS with */
 441         std::string _tms_user;
 442         /** Password to log into the TMS with */
 443         std::string _tms_password;
 444         /** Our cinema sound processor */
 445         CinemaSoundProcessor const * _cinema_sound_processor;
 446         std::list<int> _allowed_dcp_frame_rates;
 447         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 448         bool _allow_any_dcp_frame_rate;
 449         /** Default ISDCF metadata for newly-created Films */
 450         ISDCFMetadata _default_isdcf_metadata;
 451         boost::optional<std::string> _language;
 452         /** Default length of still image content (seconds) */
 453         int _default_still_length;
 454         Ratio const * _default_container;
 455         DCPContentType const * _default_dcp_content_type;
 456         std::string _dcp_issuer;
 457         int _default_j2k_bandwidth;
 458         int _default_audio_delay;
 459         std::list<boost::shared_ptr<Cinema> > _cinemas;
 460         std::string _mail_server;
 461         std::string _mail_user;
 462         std::string _mail_password;
 463         std::string _kdm_subject;
 464         std::string _kdm_from;
 465         std::string _kdm_cc;
 466         std::string _kdm_bcc;
 467         std::string _kdm_email;
 468         boost::shared_ptr<const dcp::Signer> _signer;
 469         dcp::Certificate _decryption_certificate;
 470         std::string _decryption_private_key;
 471         /** true to check for updates on startup */
 472         bool _check_for_updates;
 473         bool _check_for_test_updates;
 474         /** maximum allowed J2K bandwidth in bits per second */
 475         int _maximum_j2k_bandwidth;
 476         int _log_types;
 477 #ifdef DCPOMATIC_WINDOWS
 478         bool _win32_console;
 479 #endif
 480         std::vector<boost::filesystem::path> _history;
 481
 482         /** Singleton instance, or 0 */
 483         static Config* _instance;
 484 };
 485
 486 #endif