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