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 port to use for J2K encoding servers */
63 int server_port () const {
67 /** @return J2K encoding servers to use */
68 std::vector<ServerDescription> servers () const {
72 /** @return The IP address of a TMS that we can copy DCPs to */
73 std::string tms_ip () const {
77 /** @return The path on a TMS that we should write DCPs to */
78 std::string tms_path () const {
82 /** @return User name to log into the TMS with */
83 std::string tms_user () const {
87 /** @return Password to log into the TMS with */
88 std::string tms_password () const {
92 /** @return The sound processor that we are using */
93 SoundProcessor const * sound_processor () const {
94 return _sound_processor;
97 std::list<boost::shared_ptr<Cinema> > cinemas () const {
101 std::list<int> allowed_dcp_frame_rates () const {
102 return _allowed_dcp_frame_rates;
105 DCIMetadata default_dci_metadata () const {
106 return _default_dci_metadata;
109 boost::optional<std::string> language () const {
113 int default_still_length () const {
114 return _default_still_length;
117 Ratio const * default_container () const {
118 return _default_container;
121 DCPContentType const * default_dcp_content_type () const {
122 return _default_dcp_content_type;
125 libdcp::XMLMetadata dcp_metadata () const {
126 return _dcp_metadata;
129 int default_j2k_bandwidth () const {
130 return _default_j2k_bandwidth;
133 std::vector<PresetColourConversion> colour_conversions () const {
134 return _colour_conversions;
137 std::string mail_server () const {
141 std::string kdm_from () const {
145 std::string kdm_email () const {
149 /** @param n New number of local encoding threads */
150 void set_num_local_encoding_threads (int n) {
151 _num_local_encoding_threads = n;
154 void set_default_directory (boost::filesystem::path d) {
155 _default_directory = d;
158 /** @param p New server port */
159 void set_server_port (int p) {
163 /** @param s New list of servers */
164 void set_servers (std::vector<ServerDescription> s) {
168 void set_reference_scaler (Scaler const * s) {
169 _reference_scaler = s;
172 void set_reference_filters (std::vector<Filter const *> const & f) {
173 _reference_filters = f;
176 /** @param i IP address of a TMS that we can copy DCPs to */
177 void set_tms_ip (std::string i) {
181 /** @param p Path on a TMS that we should write DCPs to */
182 void set_tms_path (std::string p) {
186 /** @param u User name to log into the TMS with */
187 void set_tms_user (std::string u) {
191 /** @param p Password to log into the TMS with */
192 void set_tms_password (std::string p) {
196 void add_cinema (boost::shared_ptr<Cinema> c) {
197 _cinemas.push_back (c);
200 void remove_cinema (boost::shared_ptr<Cinema> c) {
204 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
205 _allowed_dcp_frame_rates = r;
208 void set_default_dci_metadata (DCIMetadata d) {
209 _default_dci_metadata = d;
212 void set_language (std::string l) {
216 void unset_language () {
217 _language = boost::none;
220 void set_default_still_length (int s) {
221 _default_still_length = s;
224 void set_default_container (Ratio const * c) {
225 _default_container = c;
228 void set_default_dcp_content_type (DCPContentType const * t) {
229 _default_dcp_content_type = t;
232 void set_dcp_metadata (libdcp::XMLMetadata m) {
236 void set_default_j2k_bandwidth (int b) {
237 _default_j2k_bandwidth = b;
240 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
241 _colour_conversions = c;
244 void set_mail_server (std::string s) {
248 void set_kdm_from (std::string f) {
252 void set_kdm_email (std::string e) {
258 boost::filesystem::path signer_chain_directory () const;
260 static Config* instance ();
265 boost::filesystem::path file (bool) const;
267 void read_old_metadata ();
269 /** number of threads to use for J2K encoding on the local machine */
270 int _num_local_encoding_threads;
271 /** default directory to put new films in */
272 boost::filesystem::path _default_directory;
273 /** port to use for J2K encoding servers */
276 /** J2K encoding servers to use */
277 std::vector<ServerDescription> _servers;
278 /** Scaler to use for the "A" part of A/B comparisons */
279 Scaler const * _reference_scaler;
280 /** Filters to use for the "A" part of A/B comparisons */
281 std::vector<Filter const *> _reference_filters;
282 /** The IP address of a TMS that we can copy DCPs to */
284 /** The path on a TMS that we should write DCPs to */
285 std::string _tms_path;
286 /** User name to log into the TMS with */
287 std::string _tms_user;
288 /** Password to log into the TMS with */
289 std::string _tms_password;
290 /** Our sound processor */
291 SoundProcessor const * _sound_processor;
292 std::list<int> _allowed_dcp_frame_rates;
293 /** Default DCI metadata for newly-created Films */
294 DCIMetadata _default_dci_metadata;
295 boost::optional<std::string> _language;
296 int _default_still_length;
297 Ratio const * _default_container;
298 DCPContentType const * _default_dcp_content_type;
299 libdcp::XMLMetadata _dcp_metadata;
300 int _default_j2k_bandwidth;
301 std::vector<PresetColourConversion> _colour_conversions;
302 std::list<boost::shared_ptr<Cinema> > _cinemas;
303 std::string _mail_server;
304 std::string _kdm_from;
305 std::string _kdm_email;
307 /** Singleton instance, or 0 */
308 static Config* _instance;