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