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 "isdcf_metadata.h"
  33 #include "colour_conversion.h"
  34
  35 class ServerDescription;
  36 class Scaler;
  37 class Filter;
  38 class CinemaSoundProcessor;
  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 cinema sound processor that we are using */
 107         CinemaSoundProcessor const * cinema_sound_processor () const {
 108                 return _cinema_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_container () const {
 136                 return _default_container;
 137         }
 138
 139         DCPContentType const * default_dcp_content_type () const {
 140                 return _default_dcp_content_type;
 141         }
 142
 143         dcp::XMLMetadata dcp_metadata () const {
 144                 return _dcp_metadata;
 145         }
 146
 147         int default_j2k_bandwidth () const {
 148                 return _default_j2k_bandwidth;
 149         }
 150
 151         int default_audio_delay () const {
 152                 return _default_audio_delay;
 153         }
 154
 155         std::vector<PresetColourConversion> colour_conversions () const {
 156                 return _colour_conversions;
 157         }
 158
 159         std::string mail_server () const {
 160                 return _mail_server;
 161         }
 162
 163         std::string mail_user () const {
 164                 return _mail_user;
 165         }
 166
 167         std::string mail_password () const {
 168                 return _mail_password;
 169         }
 170
 171         std::string kdm_subject () const {
 172                 return _kdm_subject;
 173         }
 174
 175         std::string kdm_from () const {
 176                 return _kdm_from;
 177         }
 178
 179         std::string kdm_cc () const {
 180                 return _kdm_cc;
 181         }
 182
 183         std::string kdm_email () const {
 184                 return _kdm_email;
 185         }
 186
 187         bool check_for_updates () const {
 188                 return _check_for_updates;
 189         }
 190
 191         bool check_for_test_updates () const {
 192                 return _check_for_test_updates;
 193         }
 194
 195         int maximum_j2k_bandwidth () const {
 196                 return _maximum_j2k_bandwidth;
 197         }
 198
 199         int log_types () const {
 200                 return _log_types;
 201         }
 202
 203         /** @param n New number of local encoding threads */
 204         void set_num_local_encoding_threads (int n) {
 205                 _num_local_encoding_threads = n;
 206                 changed ();
 207         }
 208
 209         void set_default_directory (boost::filesystem::path d) {
 210                 _default_directory = d;
 211                 changed ();
 212         }
 213
 214         /** @param p New server port */
 215         void set_server_port_base (int p) {
 216                 _server_port_base = p;
 217                 changed ();
 218         }
 219
 220         /** @param i IP address of a TMS that we can copy DCPs to */
 221         void set_tms_ip (std::string i) {
 222                 _tms_ip = i;
 223                 changed ();
 224         }
 225
 226         /** @param p Path on a TMS that we should changed DCPs to */
 227         void set_tms_path (std::string p) {
 228                 _tms_path = p;
 229                 changed ();
 230         }
 231
 232         /** @param u User name to log into the TMS with */
 233         void set_tms_user (std::string u) {
 234                 _tms_user = u;
 235                 changed ();
 236         }
 237
 238         /** @param p Password to log into the TMS with */
 239         void set_tms_password (std::string p) {
 240                 _tms_password = p;
 241                 changed ();
 242         }
 243
 244         void add_cinema (boost::shared_ptr<Cinema> c) {
 245                 _cinemas.push_back (c);
 246                 changed ();
 247         }
 248
 249         void remove_cinema (boost::shared_ptr<Cinema> c) {
 250                 _cinemas.remove (c);
 251                 changed ();
 252         }
 253
 254         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 255                 _allowed_dcp_frame_rates = r;
 256                 changed ();
 257         }
 258
 259         void set_allow_any_dcp_frame_rate (bool a) {
 260                 _allow_any_dcp_frame_rate = a;
 261                 changed ();
 262         }
 263
 264         void set_default_isdcf_metadata (ISDCFMetadata d) {
 265                 _default_isdcf_metadata = d;
 266                 changed ();
 267         }
 268
 269         void set_language (std::string l) {
 270                 _language = l;
 271                 changed ();
 272         }
 273
 274         void unset_language () {
 275                 _language = boost::none;
 276                 changed ();
 277         }
 278
 279         void set_default_still_length (int s) {
 280                 _default_still_length = s;
 281                 changed ();
 282         }
 283
 284         void set_default_container (Ratio const * c) {
 285                 _default_container = c;
 286                 changed ();
 287         }
 288
 289         void set_default_dcp_content_type (DCPContentType const * t) {
 290                 _default_dcp_content_type = t;
 291                 changed ();
 292         }
 293
 294         void set_dcp_metadata (dcp::XMLMetadata m) {
 295                 _dcp_metadata = m;
 296                 changed ();
 297         }
 298
 299         void set_default_j2k_bandwidth (int b) {
 300                 _default_j2k_bandwidth = b;
 301                 changed ();
 302         }
 303
 304         void set_default_audio_delay (int d) {
 305                 _default_audio_delay = d;
 306                 changed ();
 307         }
 308
 309         void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
 310                 _colour_conversions = c;
 311                 changed ();
 312         }
 313
 314         void set_mail_server (std::string s) {
 315                 _mail_server = s;
 316                 changed ();
 317         }
 318
 319         void set_mail_user (std::string u) {
 320                 _mail_user = u;
 321                 changed ();
 322         }
 323
 324         void set_mail_password (std::string p) {
 325                 _mail_password = p;
 326                 changed ();
 327         }
 328
 329         void set_kdm_subject (std::string s) {
 330                 _kdm_subject = s;
 331                 changed ();
 332         }
 333
 334         void set_kdm_from (std::string f) {
 335                 _kdm_from = f;
 336                 changed ();
 337         }
 338
 339         void set_kdm_cc (std::string f) {
 340                 _kdm_cc = f;
 341                 changed ();
 342         }
 343
 344         void set_kdm_email (std::string e) {
 345                 _kdm_email = e;
 346                 changed ();
 347         }
 348
 349         void reset_kdm_email ();
 350
 351         void set_check_for_updates (bool c) {
 352                 _check_for_updates = c;
 353                 changed ();
 354         }
 355
 356         void set_check_for_test_updates (bool c) {
 357                 _check_for_test_updates = c;
 358                 changed ();
 359         }
 360
 361         void set_maximum_j2k_bandwidth (int b) {
 362                 _maximum_j2k_bandwidth = b;
 363                 changed ();
 364         }
 365
 366         void set_log_types (int t) {
 367                 _log_types = t;
 368                 changed ();
 369         }
 370
 371         boost::filesystem::path signer_chain_directory () const;
 372
 373         void changed ();
 374         boost::signals2::signal<void ()> Changed;
 375
 376         static Config* instance ();
 377         static void drop ();
 378
 379 private:
 380         Config ();
 381         boost::filesystem::path file (bool) const;
 382         void read ();
 383         void write () const;
 384
 385         /** number of threads to use for J2K encoding on the local machine */
 386         int _num_local_encoding_threads;
 387         /** default directory to put new films in */
 388         boost::filesystem::path _default_directory;
 389         /** base port number to use for J2K encoding servers;
 390          *  this port and the one above it will be used.
 391          */
 392         int _server_port_base;
 393         /** true to broadcast on the `any' address to look for servers */
 394         bool _use_any_servers;
 395         /** J2K encoding servers that should definitely be used */
 396         std::vector<std::string> _servers;
 397         /** The IP address of a TMS that we can copy DCPs to */
 398         std::string _tms_ip;
 399         /** The path on a TMS that we should write DCPs to */
 400         std::string _tms_path;
 401         /** User name to log into the TMS with */
 402         std::string _tms_user;
 403         /** Password to log into the TMS with */
 404         std::string _tms_password;
 405         /** Our cinema sound processor */
 406         CinemaSoundProcessor const * _cinema_sound_processor;
 407         std::list<int> _allowed_dcp_frame_rates;
 408         /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
 409         bool _allow_any_dcp_frame_rate;
 410         /** Default ISDCF metadata for newly-created Films */
 411         ISDCFMetadata _default_isdcf_metadata;
 412         boost::optional<std::string> _language;
 413         int _default_still_length;
 414         Ratio const * _default_container;
 415         DCPContentType const * _default_dcp_content_type;
 416         dcp::XMLMetadata _dcp_metadata;
 417         int _default_j2k_bandwidth;
 418         int _default_audio_delay;
 419         std::vector<PresetColourConversion> _colour_conversions;
 420         std::list<boost::shared_ptr<Cinema> > _cinemas;
 421         std::string _mail_server;
 422         std::string _mail_user;
 423         std::string _mail_password;
 424         std::string _kdm_subject;
 425         std::string _kdm_from;
 426         std::string _kdm_cc;
 427         std::string _kdm_email;
 428         /** true to check for updates on startup */
 429         bool _check_for_updates;
 430         bool _check_for_test_updates;
 431         /** maximum allowed J2K bandwidth in bits per second */
 432         int _maximum_j2k_bandwidth;
 433         int _log_types;
 434
 435         /** Singleton instance, or 0 */
 436         static Config* _instance;
 437 };
 438
 439 #endif