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