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