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         VideoContentScale default_scale () const {
 139                 return _default_scale;
 140         }
 141
 142         Ratio const * default_container () const {
 143                 return _default_container;
 144         }
 145
 146         DCPContentType const * default_dcp_content_type () const {
 147                 return _default_dcp_content_type;
 148         }
 149
 150         std::string dcp_issuer () const {
 151                 return _dcp_issuer;
 152         }
 153
 154         int default_j2k_bandwidth () const {
 155                 return _default_j2k_bandwidth;
 156         }
 157
 158         int default_audio_delay () const {
 159                 return _default_audio_delay;
 160         }
 161
 162         std::vector<PresetColourConversion> colour_conversions () const {
 163                 return _colour_conversions;
 164         }
 165
 166         std::string mail_server () const {
 167                 return _mail_server;
 168         }
 169
 170         std::string mail_user () const {
 171                 return _mail_user;
 172         }
 173
 174         std::string mail_password () const {
 175                 return _mail_password;
 176         }
 177
 178         std::string kdm_subject () const {
 179                 return _kdm_subject;
 180         }
 181
 182         std::string kdm_from () const {
 183                 return _kdm_from;
 184         }
 185
 186         std::string kdm_cc () const {
 187                 return _kdm_cc;
 188         }
 189
 190         std::string kdm_bcc () const {
 191                 return _kdm_bcc;
 192         }
 193
 194         std::string kdm_email () const {
 195                 return _kdm_email;
 196         }
 197
 198         boost::shared_ptr<const dcp::Signer> signer () const {
 199                 return _signer;
 200         }
 201
 202         dcp::Certificate decryption_certificate () const {
 203                 return _decryption_certificate;
 204         }
 205
 206         std::string decryption_private_key () const {
 207                 return _decryption_private_key;
 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         std::vector<boost::filesystem::path> history () const {
 227                 return _history;
 228         }
 229
 230         /** @param n New number of local encoding threads */
 231         void set_num_local_encoding_threads (int n) {
 232                 _num_local_encoding_threads = n;
 233                 changed ();
 234         }
 235
 236         void set_default_directory (boost::filesystem::path d) {
 237                 _default_directory = d;
 238                 changed ();
 239         }
 240
 241         /** @param p New server port */
 242         void set_server_port_base (int p) {
 243                 _server_port_base = p;
 244                 changed ();
 245         }
 246
 247         /** @param i IP address of a TMS that we can copy DCPs to */
 248         void set_tms_ip (std::string i) {
 249                 _tms_ip = i;
 250                 changed ();
 251         }
 252
 253         /** @param p Path on a TMS that we should changed DCPs to */
 254         void set_tms_path (std::string p) {
 255                 _tms_path = p;
 256                 changed ();
 257         }
 258
 259         /** @param u User name to log into the TMS with */
 260         void set_tms_user (std::string u) {
 261                 _tms_user = u;
 262                 changed ();
 263         }
 264
 265         /** @param p Password to log into the TMS with */
 266         void set_tms_password (std::string p) {
 267                 _tms_password = p;
 268                 changed ();
 269         }
 270
 271         void add_cinema (boost::shared_ptr<Cinema> c) {
 272                 _cinemas.push_back (c);
 273                 changed ();
 274         }
 275
 276         void remove_cinema (boost::shared_ptr<Cinema> c) {
 277                 _cinemas.remove (c);
 278                 changed ();
 279         }
 280
 281         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 282                 _allowed_dcp_frame_rates = r;
 283                 changed ();
 284         }
 285
 286         void set_allow_any_dcp_frame_rate (bool a) {
 287                 _allow_any_dcp_frame_rate = a;
 288                 changed ();
 289         }
 290
 291         void set_default_isdcf_metadata (ISDCFMetadata d) {
 292                 _default_isdcf_metadata = d;
 293                 changed ();
 294         }
 295
 296         void set_language (std::string l) {
 297                 _language = l;
 298                 changed ();
 299         }
 300
 301         void unset_language () {
 302                 _language = boost::none;
 303                 changed ();
 304         }
 305
 306         void set_default_still_length (int s) {
 307                 _default_still_length = s;
 308                 changed ();
 309         }
 310
 311         void set_default_scale (VideoContentScale s) {
 312                 _default_scale = s;
 313                 changed ();
 314         }
 315
 316         void set_default_container (Ratio const * c) {
 317                 _default_container = c;
 318                 changed ();
 319         }
 320
 321         void set_default_dcp_content_type (DCPContentType const * t) {
 322                 _default_dcp_content_type = t;
 323                 changed ();
 324         }
 325
 326         void set_dcp_issuer (std::string i) {
 327                 _dcp_issuer = i;
 328                 changed ();
 329         }
 330
 331         void set_default_j2k_bandwidth (int b) {
 332                 _default_j2k_bandwidth = b;
 333                 changed ();
 334         }
 335
 336         void set_default_audio_delay (int d) {
 337                 _default_audio_delay = d;
 338                 changed ();
 339         }
 340
 341         void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
 342                 _colour_conversions = c;
 343                 changed ();
 344         }
 345
 346         void set_mail_server (std::string s) {
 347                 _mail_server = s;
 348                 changed ();
 349         }
 350
 351         void set_mail_user (std::string u) {
 352                 _mail_user = u;
 353                 changed ();
 354         }
 355
 356         void set_mail_password (std::string p) {
 357                 _mail_password = p;
 358                 changed ();
 359         }
 360
 361         void set_kdm_subject (std::string s) {
 362                 _kdm_subject = s;
 363                 changed ();
 364         }
 365
 366         void set_kdm_from (std::string f) {
 367                 _kdm_from = f;
 368                 changed ();
 369         }
 370
 371         void set_kdm_cc (std::string f) {
 372                 _kdm_cc = f;
 373                 changed ();
 374         }
 375
 376         void set_kdm_bcc (std::string f) {
 377                 _kdm_bcc = f;
 378                 changed ();
 379         }
 380
 381         void set_kdm_email (std::string e) {
 382                 _kdm_email = e;
 383                 changed ();
 384         }
 385
 386         void reset_kdm_email ();
 387
 388         void set_signer (boost::shared_ptr<const dcp::Signer> s) {
 389                 _signer = s;
 390                 changed ();
 391         }
 392
 393         void set_decryption_certificate (dcp::Certificate c) {
 394                 _decryption_certificate = c;
 395                 changed ();
 396         }
 397
 398         void set_decryption_private_key (std::string k) {
 399                 _decryption_private_key = k;
 400                 changed ();
 401         }
 402
 403         void set_check_for_updates (bool c) {
 404                 _check_for_updates = c;
 405                 changed ();
 406         }
 407
 408         void set_check_for_test_updates (bool c) {
 409                 _check_for_test_updates = c;
 410                 changed ();
 411         }
 412
 413         void set_maximum_j2k_bandwidth (int b) {
 414                 _maximum_j2k_bandwidth = b;
 415                 changed ();
 416         }
 417
 418         void set_log_types (int t) {
 419                 _log_types = t;
 420                 changed ();
 421         }
 422
 423         void clear_history () {
 424                 _history.clear ();
 425                 changed ();
 426         }
 427
 428         void add_to_history (boost::filesystem::path p);
 429
 430         void changed ();
 431         boost::signals2::signal<void ()> Changed;
 432
 433         static Config* instance ();
 434         static void drop ();
 435
 436 private:
 437         Config ();
 438         boost::filesystem::path file (bool) const;
 439         void read ();
 440         void write () const;
 441         void make_decryption_keys ();
 442
 443         /** number of threads to use for J2K encoding on the local machine */
 444         int _num_local_encoding_threads;
 445         /** default directory to put new films in */
 446         boost::filesystem::path _default_directory;
 447         /** base port number to use for J2K encoding servers;
 448          *  this port and the one above it will be used.
 449          */
 450         int _server_port_base;
 451         /** true to broadcast on the `any' address to look for servers */
 452         bool _use_any_servers;
 453         /** J2K encoding servers that should definitely be used */
 454         std::vector<std::string> _servers;
 455         /** The IP address of a TMS that we can copy DCPs to */
 456         std::string _tms_ip;
 457         /** The path on a TMS that we should write DCPs to */
 458         std::string _tms_path;
 459         /** User name to log into the TMS with */
 460         std::string _tms_user;
 461         /** Password to log into the TMS with */
 462         std::string _tms_password;
 463         /** Our cinema sound processor */
 464         CinemaSoundProcessor const * _cinema_sound_processor;
 465         std::list<int> _allowed_dcp_frame_rates;
 466         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 467         bool _allow_any_dcp_frame_rate;
 468         /** Default ISDCF metadata for newly-created Films */
 469         ISDCFMetadata _default_isdcf_metadata;
 470         boost::optional<std::string> _language;
 471         int _default_still_length;
 472         VideoContentScale _default_scale;
 473         Ratio const * _default_container;
 474         DCPContentType const * _default_dcp_content_type;
 475         std::string _dcp_issuer;
 476         int _default_j2k_bandwidth;
 477         int _default_audio_delay;
 478         std::vector<PresetColourConversion> _colour_conversions;
 479         std::list<boost::shared_ptr<Cinema> > _cinemas;
 480         std::string _mail_server;
 481         std::string _mail_user;
 482         std::string _mail_password;
 483         std::string _kdm_subject;
 484         std::string _kdm_from;
 485         std::string _kdm_cc;
 486         std::string _kdm_bcc;
 487         std::string _kdm_email;
 488         boost::shared_ptr<const dcp::Signer> _signer;
 489         dcp::Certificate _decryption_certificate;
 490         std::string _decryption_private_key;
 491         /** true to check for updates on startup */
 492         bool _check_for_updates;
 493         bool _check_for_test_updates;
 494         /** maximum allowed J2K bandwidth in bits per second */
 495         int _maximum_j2k_bandwidth;
 496         int _log_types;
 497         std::vector<boost::filesystem::path> _history;
 498
 499         /** Singleton instance, or 0 */
 500         static Config* _instance;
 501 };
 502
 503 #endif