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