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