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
  35 class Scaler;
  36 class Filter;
  37 class SoundProcessor;
  38 class DCPContentType;
  39 class Ratio;
  40 class Cinema;
  41
  42 /** @class Config
  43  *  @brief A singleton class holding configuration.
  44  */
  45 class Config : public boost::noncopyable
  46 {
  47 public:
  48
  49         /** @return number of threads to use for J2K encoding on the local machine */
  50         int num_local_encoding_threads () const {
  51                 return _num_local_encoding_threads;
  52         }
  53
  54         boost::filesystem::path default_directory () const {
  55                 return _default_directory;
  56         }
  57
  58         boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
  59
  60         /** @return base port number to use for J2K encoding servers */
  61         int server_port_base () const {
  62                 return _server_port_base;
  63         }
  64
  65         /** @return The IP address of a TMS that we can copy DCPs to */
  66         std::string tms_ip () const {
  67                 return _tms_ip;
  68         }
  69
  70         /** @return The path on a TMS that we should write DCPs to */
  71         std::string tms_path () const {
  72                 return _tms_path;
  73         }
  74
  75         /** @return User name to log into the TMS with */
  76         std::string tms_user () const {
  77                 return _tms_user;
  78         }
  79
  80         /** @return Password to log into the TMS with */
  81         std::string tms_password () const {
  82                 return _tms_password;
  83         }
  84
  85         /** @return The sound processor that we are using */
  86         SoundProcessor const * sound_processor () const {
  87                 return _sound_processor;
  88         }
  89
  90         std::list<boost::shared_ptr<Cinema> > cinemas () const {
  91                 return _cinemas;
  92         }
  93
  94         std::list<int> allowed_dcp_frame_rates () const {
  95                 return _allowed_dcp_frame_rates;
  96         }
  97
  98         DCIMetadata default_dci_metadata () const {
  99                 return _default_dci_metadata;
 100         }
 101
 102         boost::optional<std::string> language () const {
 103                 return _language;
 104         }
 105
 106         int default_still_length () const {
 107                 return _default_still_length;
 108         }
 109
 110         Ratio const * default_container () const {
 111                 return _default_container;
 112         }
 113
 114         DCPContentType const * default_dcp_content_type () const {
 115                 return _default_dcp_content_type;
 116         }
 117
 118         libdcp::XMLMetadata dcp_metadata () const {
 119                 return _dcp_metadata;
 120         }
 121
 122         int default_j2k_bandwidth () const {
 123                 return _default_j2k_bandwidth;
 124         }
 125
 126         std::vector<PresetColourConversion> colour_conversions () const {
 127                 return _colour_conversions;
 128         }
 129
 130         std::string mail_server () const {
 131                 return _mail_server;
 132         }
 133
 134         std::string kdm_from () const {
 135                 return _kdm_from;
 136         }
 137
 138         std::string kdm_email () const {
 139                 return _kdm_email;
 140         }
 141
 142         /** @param n New number of local encoding threads */
 143         void set_num_local_encoding_threads (int n) {
 144                 _num_local_encoding_threads = n;
 145         }
 146
 147         void set_default_directory (boost::filesystem::path d) {
 148                 _default_directory = d;
 149         }
 150
 151         /** @param p New server port */
 152         void set_server_port_base (int p) {
 153                 _server_port_base = p;
 154         }
 155
 156         void set_reference_scaler (Scaler const * s) {
 157                 _reference_scaler = s;
 158         }
 159
 160         void set_reference_filters (std::vector<Filter const *> const & f) {
 161                 _reference_filters = f;
 162         }
 163
 164         /** @param i IP address of a TMS that we can copy DCPs to */
 165         void set_tms_ip (std::string i) {
 166                 _tms_ip = i;
 167         }
 168
 169         /** @param p Path on a TMS that we should write DCPs to */
 170         void set_tms_path (std::string p) {
 171                 _tms_path = p;
 172         }
 173
 174         /** @param u User name to log into the TMS with */
 175         void set_tms_user (std::string u) {
 176                 _tms_user = u;
 177         }
 178
 179         /** @param p Password to log into the TMS with */
 180         void set_tms_password (std::string p) {
 181                 _tms_password = p;
 182         }
 183
 184         void add_cinema (boost::shared_ptr<Cinema> c) {
 185                 _cinemas.push_back (c);
 186         }
 187
 188         void remove_cinema (boost::shared_ptr<Cinema> c) {
 189                 _cinemas.remove (c);
 190         }
 191
 192         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
 193                 _allowed_dcp_frame_rates = r;
 194         }
 195
 196         void set_default_dci_metadata (DCIMetadata d) {
 197                 _default_dci_metadata = d;
 198         }
 199
 200         void set_language (std::string l) {
 201                 _language = l;
 202         }
 203
 204         void unset_language () {
 205                 _language = boost::none;
 206         }
 207
 208         void set_default_still_length (int s) {
 209                 _default_still_length = s;
 210         }
 211
 212         void set_default_container (Ratio const * c) {
 213                 _default_container = c;
 214         }
 215
 216         void set_default_dcp_content_type (DCPContentType const * t) {
 217                 _default_dcp_content_type = t;
 218         }
 219
 220         void set_dcp_metadata (libdcp::XMLMetadata m) {
 221                 _dcp_metadata = m;
 222         }
 223
 224         void set_default_j2k_bandwidth (int b) {
 225                 _default_j2k_bandwidth = b;
 226         }
 227
 228         void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
 229                 _colour_conversions = c;
 230         }
 231
 232         void set_mail_server (std::string s) {
 233                 _mail_server = s;
 234         }
 235
 236         void set_kdm_from (std::string f) {
 237                 _kdm_from = f;
 238         }
 239
 240         void set_kdm_email (std::string e) {
 241                 _kdm_email = e;
 242         }
 243
 244         void write () const;
 245
 246         boost::filesystem::path signer_chain_directory () const;
 247
 248         static Config* instance ();
 249         static void drop ();
 250
 251 private:
 252         Config ();
 253         boost::filesystem::path file (bool) const;
 254         void read ();
 255         void read_old_metadata ();
 256
 257         /** number of threads to use for J2K encoding on the local machine */
 258         int _num_local_encoding_threads;
 259         /** default directory to put new films in */
 260         boost::filesystem::path _default_directory;
 261         /** base port number to use for J2K encoding servers;
 262          *  this port and the one above it will be used.
 263          */
 264         int _server_port_base;
 265         /** Scaler to use for the "A" part of A/B comparisons */
 266         Scaler const * _reference_scaler;
 267         /** Filters to use for the "A" part of A/B comparisons */
 268         std::vector<Filter const *> _reference_filters;
 269         /** The IP address of a TMS that we can copy DCPs to */
 270         std::string _tms_ip;
 271         /** The path on a TMS that we should write DCPs to */
 272         std::string _tms_path;
 273         /** User name to log into the TMS with */
 274         std::string _tms_user;
 275         /** Password to log into the TMS with */
 276         std::string _tms_password;
 277         /** Our sound processor */
 278         SoundProcessor const * _sound_processor;
 279         std::list<int> _allowed_dcp_frame_rates;
 280         /** Default DCI metadata for newly-created Films */
 281         DCIMetadata _default_dci_metadata;
 282         boost::optional<std::string> _language;
 283         int _default_still_length;
 284         Ratio const * _default_container;
 285         DCPContentType const * _default_dcp_content_type;
 286         libdcp::XMLMetadata _dcp_metadata;
 287         int _default_j2k_bandwidth;
 288         std::vector<PresetColourConversion> _colour_conversions;
 289         std::list<boost::shared_ptr<Cinema> > _cinemas;
 290         std::string _mail_server;
 291         std::string _kdm_from;
 292         std::string _kdm_email;
 293
 294         /** Singleton instance, or 0 */
 295         static Config* _instance;
 296 };
 297
 298 #endif