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