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