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