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 <dcp/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) {
72 bool use_any_servers () const {
73 return _use_any_servers;
76 /** @param s New list of servers */
77 void set_servers (std::vector<std::string> s) {
82 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
83 std::vector<std::string> servers () const {
87 /** @return The IP address of a TMS that we can copy DCPs to */
88 std::string tms_ip () const {
92 /** @return The path on a TMS that we should write DCPs to */
93 std::string tms_path () const {
97 /** @return User name to log into the TMS with */
98 std::string tms_user () const {
102 /** @return Password to log into the TMS with */
103 std::string tms_password () const {
104 return _tms_password;
107 /** @return The sound processor that we are using */
108 SoundProcessor const * sound_processor () const {
109 return _sound_processor;
112 std::list<boost::shared_ptr<Cinema> > cinemas () const {
116 std::list<int> allowed_dcp_frame_rates () const {
117 return _allowed_dcp_frame_rates;
120 DCIMetadata default_dci_metadata () const {
121 return _default_dci_metadata;
124 boost::optional<std::string> language () const {
128 int default_still_length () const {
129 return _default_still_length;
132 Ratio const * default_container () const {
133 return _default_container;
136 DCPContentType const * default_dcp_content_type () const {
137 return _default_dcp_content_type;
140 dcp::XMLMetadata dcp_metadata () const {
141 return _dcp_metadata;
144 int default_j2k_bandwidth () const {
145 return _default_j2k_bandwidth;
148 int default_audio_delay () const {
149 return _default_audio_delay;
152 std::vector<PresetColourConversion> colour_conversions () const {
153 return _colour_conversions;
156 std::string mail_server () const {
160 std::string mail_user () const {
164 std::string mail_password () const {
165 return _mail_password;
168 std::string kdm_from () const {
172 std::string kdm_email () const {
176 bool check_for_updates () const {
177 return _check_for_updates;
180 bool check_for_test_updates () const {
181 return _check_for_test_updates;
184 /** @param n New number of local encoding threads */
185 void set_num_local_encoding_threads (int n) {
186 _num_local_encoding_threads = n;
190 void set_default_directory (boost::filesystem::path d) {
191 _default_directory = d;
195 /** @param p New server port */
196 void set_server_port_base (int p) {
197 _server_port_base = p;
201 /** @param i IP address of a TMS that we can copy DCPs to */
202 void set_tms_ip (std::string i) {
207 /** @param p Path on a TMS that we should write DCPs to */
208 void set_tms_path (std::string p) {
213 /** @param u User name to log into the TMS with */
214 void set_tms_user (std::string u) {
219 /** @param p Password to log into the TMS with */
220 void set_tms_password (std::string p) {
225 void add_cinema (boost::shared_ptr<Cinema> c) {
226 _cinemas.push_back (c);
229 void remove_cinema (boost::shared_ptr<Cinema> c) {
233 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
234 _allowed_dcp_frame_rates = r;
238 void set_default_dci_metadata (DCIMetadata d) {
239 _default_dci_metadata = d;
243 void set_language (std::string l) {
248 void unset_language () {
249 _language = boost::none;
253 void set_default_still_length (int s) {
254 _default_still_length = s;
258 void set_default_container (Ratio const * c) {
259 _default_container = c;
263 void set_default_dcp_content_type (DCPContentType const * t) {
264 _default_dcp_content_type = t;
268 void set_dcp_metadata (dcp::XMLMetadata m) {
273 void set_default_j2k_bandwidth (int b) {
274 _default_j2k_bandwidth = b;
278 void set_default_audio_delay (int d) {
279 _default_audio_delay = d;
283 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
284 _colour_conversions = c;
288 void set_mail_server (std::string s) {
293 void set_mail_user (std::string u) {
298 void set_mail_password (std::string p) {
303 void set_kdm_from (std::string f) {
308 void set_kdm_email (std::string e) {
313 void set_check_for_updates (bool c) {
314 _check_for_updates = c;
318 void set_check_for_test_updates (bool c) {
319 _check_for_test_updates = c;
325 boost::filesystem::path signer_chain_directory () const;
327 static Config* instance ();
332 boost::filesystem::path file (bool) const;
334 void read_old_metadata ();
336 /** number of threads to use for J2K encoding on the local machine */
337 int _num_local_encoding_threads;
338 /** default directory to put new films in */
339 boost::filesystem::path _default_directory;
340 /** base port number to use for J2K encoding servers;
341 * this port and the one above it will be used.
343 int _server_port_base;
344 /** true to broadcast on the `any' address to look for servers */
345 bool _use_any_servers;
346 /** J2K encoding servers that should definitely be used */
347 std::vector<std::string> _servers;
348 /** The IP address of a TMS that we can copy DCPs to */
350 /** The path on a TMS that we should write DCPs to */
351 std::string _tms_path;
352 /** User name to log into the TMS with */
353 std::string _tms_user;
354 /** Password to log into the TMS with */
355 std::string _tms_password;
356 /** Our sound processor */
357 SoundProcessor const * _sound_processor;
358 std::list<int> _allowed_dcp_frame_rates;
359 /** Default DCI metadata for newly-created Films */
360 DCIMetadata _default_dci_metadata;
361 boost::optional<std::string> _language;
362 int _default_still_length;
363 Ratio const * _default_container;
364 DCPContentType const * _default_dcp_content_type;
365 dcp::XMLMetadata _dcp_metadata;
366 int _default_j2k_bandwidth;
367 int _default_audio_delay;
368 std::vector<PresetColourConversion> _colour_conversions;
369 std::list<boost::shared_ptr<Cinema> > _cinemas;
370 std::string _mail_server;
371 std::string _mail_user;
372 std::string _mail_password;
373 std::string _kdm_from;
374 std::string _kdm_email;
375 /** true to check for updates on startup */
376 bool _check_for_updates;
377 bool _check_for_test_updates;
379 /** Singleton instance, or 0 */
380 static Config* _instance;