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