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