src/lib/config.h

   1 /*
   2     Copyright (C) 2012 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 "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         }
  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         }
  79
  80         /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
  81         std::vector<std::string> servers () const {
  82                 return _servers;
  83         }
  84
  85         /** @return The IP address of a TMS that we can copy DCPs to */
  86         std::string tms_ip () const {
  87                 return _tms_ip;
  88         }
  89
  90         /** @return The path on a TMS that we should write DCPs to */
  91         std::string tms_path () const {
  92                 return _tms_path;
  93         }
  94
  95         /** @return User name to log into the TMS with */
  96         std::string tms_user () const {
  97                 return _tms_user;
  98         }
  99
 100         /** @return Password to log into the TMS with */
 101         std::string tms_password () const {
 102                 return _tms_password;
 103         }
 104
 105         /** @return The sound processor that we are using */
 106         SoundProcessor const * sound_processor () const {
 107                 return _sound_processor;
 108         }
 109
 110         std::list<boost::shared_ptr<Cinema> > cinemas () const {
 111                 return _cinemas;
 112         }
 113
 114         std::list<int> allowed_dcp_frame_rates () const {
 115                 return _allowed_dcp_frame_rates;
 116         }
 117
 118         DCIMetadata default_dci_metadata () const {
 119                 return _default_dci_metadata;
 120         }
 121
 122         boost::optional<std::string> language () const {
 123                 return _language;
 124         }
 125
 126         int default_still_length () const {
 127                 return _default_still_length;
 128         }
 129
 130         Ratio const * default_container () const {
 131                 return _default_container;
 132         }
 133
 134         DCPContentType const * default_dcp_content_type () const {
 135                 return _default_dcp_content_type;
 136         }
 137
 138         libdcp::XMLMetadata dcp_metadata () const {
 139                 return _dcp_metadata;
 140         }
 141
 142         int default_j2k_bandwidth () const {
 143                 return _default_j2k_bandwidth;
 144         }
 145
 146         int default_audio_delay () const {
 147                 return _default_audio_delay;
 148         }
 149
 150         std::vector<PresetColourConversion> colour_conversions () const {
 151                 return _colour_conversions;
 152         }
 153
 154         std::string mail_server () const {
 155                 return _mail_server;
 156         }
 157
 158         std::string mail_user () const {
 159                 return _mail_user;
 160         }
 161
 162         std::string mail_password () const {
 163                 return _mail_password;
 164         }
 165
 166         std::string kdm_from () const {
 167                 return _kdm_from;
 168         }
 169
 170         std::string kdm_email () const {
 171                 return _kdm_email;
 172         }
 173
 174         bool check_for_updates () const {
 175                 return _check_for_updates;
 176         }
 177
 178         bool check_for_test_updates () const {
 179                 return _check_for_test_updates;
 180         }
 181
 182         /** @param n New number of local encoding threads */
 183         void set_num_local_encoding_threads (int n) {
 184                 _num_local_encoding_threads = n;
 185         }
 186
 187         void set_default_directory (boost::filesystem::path d) {
 188                 _default_directory = d;
 189         }
 190
 191         /** @param p New server port */
 192         void set_server_port_base (int p) {
 193                 _server_port_base = p;
 194         }
 195
 196         void set_reference_scaler (Scaler const * s) {
 197                 _reference_scaler = s;
 198         }
 199
 200         void set_reference_filters (std::vector<Filter const *> const & f) {
 201                 _reference_filters = f;
 202         }
 203
 204         /** @param i IP address of a TMS that we can copy DCPs to */
 205         void set_tms_ip (std::string i) {
 206                 _tms_ip = i;
 207         }
 208
 209         /** @param p Path on a TMS that we should write DCPs to */
 210         void set_tms_path (std::string p) {
 211                 _tms_path = p;
 212         }
 213
 214         /** @param u User name to log into the TMS with */
 215         void set_tms_user (std::string u) {
 216                 _tms_user = u;
 217         }
 218
 219         /** @param p Password to log into the TMS with */
 220         void set_tms_password (std::string p) {
 221                 _tms_password = p;
 222         }
 223
 224         void add_cinema (boost::shared_ptr<Cinema> c) {
 225                 _cinemas.push_back (c);
 226         }
 227
 228         void remove_cinema (boost::shared_ptr<Cinema> c) {
 229                 _cinemas.remove (c);
 230         }
 231
 232         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 233                 _allowed_dcp_frame_rates = r;
 234         }
 235
 236         void set_default_dci_metadata (DCIMetadata d) {
 237                 _default_dci_metadata = d;
 238         }
 239
 240         void set_language (std::string l) {
 241                 _language = l;
 242         }
 243
 244         void unset_language () {
 245                 _language = boost::none;
 246         }
 247
 248         void set_default_still_length (int s) {
 249                 _default_still_length = s;
 250         }
 251
 252         void set_default_container (Ratio const * c) {
 253                 _default_container = c;
 254         }
 255
 256         void set_default_dcp_content_type (DCPContentType const * t) {
 257                 _default_dcp_content_type = t;
 258         }
 259
 260         void set_dcp_metadata (libdcp::XMLMetadata m) {
 261                 _dcp_metadata = m;
 262         }
 263
 264         void set_default_j2k_bandwidth (int b) {
 265                 _default_j2k_bandwidth = b;
 266         }
 267
 268         void set_default_audio_delay (int d) {
 269                 _default_audio_delay = d;
 270         }
 271
 272         void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
 273                 _colour_conversions = c;
 274         }
 275
 276         void set_mail_server (std::string s) {
 277                 _mail_server = s;
 278         }
 279
 280         void set_mail_user (std::string u) {
 281                 _mail_user = u;
 282         }
 283
 284         void set_mail_password (std::string p) {
 285                 _mail_password = p;
 286         }
 287
 288         void set_kdm_from (std::string f) {
 289                 _kdm_from = f;
 290         }
 291
 292         void set_kdm_email (std::string e) {
 293                 _kdm_email = e;
 294         }
 295
 296         void set_check_for_updates (bool c) {
 297                 _check_for_updates = c;
 298         }
 299
 300         void set_check_for_test_updates (bool c) {
 301                 _check_for_test_updates = c;
 302         }
 303
 304         void write () const;
 305
 306         boost::filesystem::path signer_chain_directory () const;
 307
 308         static Config* instance ();
 309         static void drop ();
 310
 311 private:
 312         Config ();
 313         boost::filesystem::path file (bool) const;
 314         void read ();
 315         void read_old_metadata ();
 316
 317         /** number of threads to use for J2K encoding on the local machine */
 318         int _num_local_encoding_threads;
 319         /** default directory to put new films in */
 320         boost::filesystem::path _default_directory;
 321         /** base port number to use for J2K encoding servers;
 322          *  this port and the one above it will be used.
 323          */
 324         int _server_port_base;
 325         /** true to broadcast on the `any' address to look for servers */
 326         bool _use_any_servers;
 327         /** J2K encoding servers that should definitely be used */
 328         std::vector<std::string> _servers;
 329         /** Scaler to use for the "A" part of A/B comparisons */
 330         Scaler const * _reference_scaler;
 331         /** Filters to use for the "A" part of A/B comparisons */
 332         std::vector<Filter const *> _reference_filters;
 333         /** The IP address of a TMS that we can copy DCPs to */
 334         std::string _tms_ip;
 335         /** The path on a TMS that we should write DCPs to */
 336         std::string _tms_path;
 337         /** User name to log into the TMS with */
 338         std::string _tms_user;
 339         /** Password to log into the TMS with */
 340         std::string _tms_password;
 341         /** Our sound processor */
 342         SoundProcessor const * _sound_processor;
 343         std::list<int> _allowed_dcp_frame_rates;
 344         /** Default DCI metadata for newly-created Films */
 345         DCIMetadata _default_dci_metadata;
 346         boost::optional<std::string> _language;
 347         int _default_still_length;
 348         Ratio const * _default_container;
 349         DCPContentType const * _default_dcp_content_type;
 350         libdcp::XMLMetadata _dcp_metadata;
 351         int _default_j2k_bandwidth;
 352         int _default_audio_delay;
 353         std::vector<PresetColourConversion> _colour_conversions;
 354         std::list<boost::shared_ptr<Cinema> > _cinemas;
 355         std::string _mail_server;
 356         std::string _mail_user;
 357         std::string _mail_password;
 358         std::string _kdm_from;
 359         std::string _kdm_email;
 360         /** true to check for updates on startup */
 361         bool _check_for_updates;
 362         bool _check_for_test_updates;
 363
 364         /** Singleton instance, or 0 */
 365         static Config* _instance;
 366 };
 367
 368 #endif