2 Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
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.
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.
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.
20 /** @file src/config.h
21 * @brief Class holding configuration.
24 #ifndef DCPOMATIC_CONFIG_H
25 #define DCPOMATIC_CONFIG_H
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"
36 class ServerDescription;
45 * @brief A singleton class holding configuration.
47 class Config : public boost::noncopyable
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;
56 boost::filesystem::path default_directory () const {
57 return _default_directory;
60 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
62 /** @return base port number to use for J2K encoding servers */
63 int server_port_base () const {
64 return _server_port_base;
67 void set_use_any_servers (bool u) {
71 bool use_any_servers () const {
72 return _use_any_servers;
75 /** @param s New list of servers */
76 void set_servers (std::vector<std::string> s) {
80 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
81 std::vector<std::string> servers () const {
85 /** @return The IP address of a TMS that we can copy DCPs to */
86 std::string tms_ip () const {
90 /** @return The path on a TMS that we should write DCPs to */
91 std::string tms_path () const {
95 /** @return User name to log into the TMS with */
96 std::string tms_user () const {
100 /** @return Password to log into the TMS with */
101 std::string tms_password () const {
102 return _tms_password;
105 /** @return The sound processor that we are using */
106 SoundProcessor const * sound_processor () const {
107 return _sound_processor;
110 std::list<boost::shared_ptr<Cinema> > cinemas () const {
114 std::list<int> allowed_dcp_frame_rates () const {
115 return _allowed_dcp_frame_rates;
118 DCIMetadata default_dci_metadata () const {
119 return _default_dci_metadata;
122 boost::optional<std::string> language () const {
126 int default_still_length () const {
127 return _default_still_length;
130 Ratio const * default_container () const {
131 return _default_container;
134 DCPContentType const * default_dcp_content_type () const {
135 return _default_dcp_content_type;
138 libdcp::XMLMetadata dcp_metadata () const {
139 return _dcp_metadata;
142 int default_j2k_bandwidth () const {
143 return _default_j2k_bandwidth;
146 std::vector<PresetColourConversion> colour_conversions () const {
147 return _colour_conversions;
150 std::string mail_server () const {
154 std::string kdm_from () const {
158 std::string kdm_email () const {
162 /** @param n New number of local encoding threads */
163 void set_num_local_encoding_threads (int n) {
164 _num_local_encoding_threads = n;
167 void set_default_directory (boost::filesystem::path d) {
168 _default_directory = d;
171 /** @param p New server port */
172 void set_server_port_base (int p) {
173 _server_port_base = p;
176 void set_reference_scaler (Scaler const * s) {
177 _reference_scaler = s;
180 void set_reference_filters (std::vector<Filter const *> const & f) {
181 _reference_filters = f;
184 /** @param i IP address of a TMS that we can copy DCPs to */
185 void set_tms_ip (std::string i) {
189 /** @param p Path on a TMS that we should write DCPs to */
190 void set_tms_path (std::string p) {
194 /** @param u User name to log into the TMS with */
195 void set_tms_user (std::string u) {
199 /** @param p Password to log into the TMS with */
200 void set_tms_password (std::string p) {
204 void add_cinema (boost::shared_ptr<Cinema> c) {
205 _cinemas.push_back (c);
208 void remove_cinema (boost::shared_ptr<Cinema> c) {
212 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
213 _allowed_dcp_frame_rates = r;
216 void set_default_dci_metadata (DCIMetadata d) {
217 _default_dci_metadata = d;
220 void set_language (std::string l) {
224 void unset_language () {
225 _language = boost::none;
228 void set_default_still_length (int s) {
229 _default_still_length = s;
232 void set_default_container (Ratio const * c) {
233 _default_container = c;
236 void set_default_dcp_content_type (DCPContentType const * t) {
237 _default_dcp_content_type = t;
240 void set_dcp_metadata (libdcp::XMLMetadata m) {
244 void set_default_j2k_bandwidth (int b) {
245 _default_j2k_bandwidth = b;
248 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
249 _colour_conversions = c;
252 void set_mail_server (std::string s) {
256 void set_kdm_from (std::string f) {
260 void set_kdm_email (std::string e) {
266 boost::filesystem::path signer_chain_directory () const;
268 static Config* instance ();
273 boost::filesystem::path file (bool) const;
275 void read_old_metadata ();
277 /** number of threads to use for J2K encoding on the local machine */
278 int _num_local_encoding_threads;
279 /** default directory to put new films in */
280 boost::filesystem::path _default_directory;
281 /** base port number to use for J2K encoding servers;
282 * this port and the one above it will be used.
284 int _server_port_base;
285 /** true to broadcast on the `any' address to look for servers */
286 bool _use_any_servers;
287 /** J2K encoding servers that should definitely be used */
288 std::vector<std::string> _servers;
289 /** Scaler to use for the "A" part of A/B comparisons */
290 Scaler const * _reference_scaler;
291 /** Filters to use for the "A" part of A/B comparisons */
292 std::vector<Filter const *> _reference_filters;
293 /** The IP address of a TMS that we can copy DCPs to */
295 /** The path on a TMS that we should write DCPs to */
296 std::string _tms_path;
297 /** User name to log into the TMS with */
298 std::string _tms_user;
299 /** Password to log into the TMS with */
300 std::string _tms_password;
301 /** Our sound processor */
302 SoundProcessor const * _sound_processor;
303 std::list<int> _allowed_dcp_frame_rates;
304 /** Default DCI metadata for newly-created Films */
305 DCIMetadata _default_dci_metadata;
306 boost::optional<std::string> _language;
307 int _default_still_length;
308 Ratio const * _default_container;
309 DCPContentType const * _default_dcp_content_type;
310 libdcp::XMLMetadata _dcp_metadata;
311 int _default_j2k_bandwidth;
312 std::vector<PresetColourConversion> _colour_conversions;
313 std::list<boost::shared_ptr<Cinema> > _cinemas;
314 std::string _mail_server;
315 std::string _kdm_from;
316 std::string _kdm_email;
318 /** Singleton instance, or 0 */
319 static Config* _instance;