2 Copyright (C) 2012-2014 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 "isdcf_metadata.h"
33 #include "colour_conversion.h"
35 class ServerDescription;
38 class CinemaSoundProcessor;
44 * @brief A singleton class holding configuration.
46 class Config : public boost::noncopyable
50 /** @return number of threads to use for J2K encoding on the local machine */
51 int num_local_encoding_threads () const {
52 return _num_local_encoding_threads;
55 boost::filesystem::path default_directory () const {
56 return _default_directory;
59 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
61 /** @return base port number to use for J2K encoding servers */
62 int server_port_base () const {
63 return _server_port_base;
66 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) {
81 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
82 std::vector<std::string> servers () const {
86 /** @return The IP address of a TMS that we can copy DCPs to */
87 std::string tms_ip () const {
91 /** @return The path on a TMS that we should changed DCPs to */
92 std::string tms_path () const {
96 /** @return User name to log into the TMS with */
97 std::string tms_user () const {
101 /** @return Password to log into the TMS with */
102 std::string tms_password () const {
103 return _tms_password;
106 /** @return The cinema sound processor that we are using */
107 CinemaSoundProcessor const * cinema_sound_processor () const {
108 return _cinema_sound_processor;
111 std::list<boost::shared_ptr<Cinema> > cinemas () const {
115 std::list<int> allowed_dcp_frame_rates () const {
116 return _allowed_dcp_frame_rates;
119 bool allow_any_dcp_frame_rate () const {
120 return _allow_any_dcp_frame_rate;
123 ISDCFMetadata default_isdcf_metadata () const {
124 return _default_isdcf_metadata;
127 boost::optional<std::string> language () const {
131 int default_still_length () const {
132 return _default_still_length;
135 Ratio const * default_scale () const {
136 return _default_scale;
139 Ratio const * default_container () const {
140 return _default_container;
143 DCPContentType const * default_dcp_content_type () const {
144 return _default_dcp_content_type;
147 dcp::XMLMetadata dcp_metadata () const {
148 return _dcp_metadata;
151 int default_j2k_bandwidth () const {
152 return _default_j2k_bandwidth;
155 int default_audio_delay () const {
156 return _default_audio_delay;
159 std::vector<PresetColourConversion> colour_conversions () const {
160 return _colour_conversions;
163 std::string mail_server () const {
167 std::string mail_user () const {
171 std::string mail_password () const {
172 return _mail_password;
175 std::string kdm_subject () const {
179 std::string kdm_from () const {
183 std::string kdm_cc () const {
187 std::string kdm_email () const {
191 bool check_for_updates () const {
192 return _check_for_updates;
195 bool check_for_test_updates () const {
196 return _check_for_test_updates;
199 int maximum_j2k_bandwidth () const {
200 return _maximum_j2k_bandwidth;
203 int log_types () const {
207 /** @param n New number of local encoding threads */
208 void set_num_local_encoding_threads (int n) {
209 _num_local_encoding_threads = n;
213 void set_default_directory (boost::filesystem::path d) {
214 _default_directory = d;
218 /** @param p New server port */
219 void set_server_port_base (int p) {
220 _server_port_base = p;
224 /** @param i IP address of a TMS that we can copy DCPs to */
225 void set_tms_ip (std::string i) {
230 /** @param p Path on a TMS that we should changed DCPs to */
231 void set_tms_path (std::string p) {
236 /** @param u User name to log into the TMS with */
237 void set_tms_user (std::string u) {
242 /** @param p Password to log into the TMS with */
243 void set_tms_password (std::string p) {
248 void add_cinema (boost::shared_ptr<Cinema> c) {
249 _cinemas.push_back (c);
253 void remove_cinema (boost::shared_ptr<Cinema> c) {
258 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
259 _allowed_dcp_frame_rates = r;
263 void set_allow_any_dcp_frame_rate (bool a) {
264 _allow_any_dcp_frame_rate = a;
268 void set_default_isdcf_metadata (ISDCFMetadata d) {
269 _default_isdcf_metadata = d;
273 void set_language (std::string l) {
278 void unset_language () {
279 _language = boost::none;
283 void set_default_still_length (int s) {
284 _default_still_length = s;
288 void set_default_scale (Ratio const * s) {
293 void set_default_container (Ratio const * c) {
294 _default_container = c;
298 void set_default_dcp_content_type (DCPContentType const * t) {
299 _default_dcp_content_type = t;
303 void set_dcp_metadata (dcp::XMLMetadata m) {
308 void set_default_j2k_bandwidth (int b) {
309 _default_j2k_bandwidth = b;
313 void set_default_audio_delay (int d) {
314 _default_audio_delay = d;
318 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
319 _colour_conversions = c;
323 void set_mail_server (std::string s) {
328 void set_mail_user (std::string u) {
333 void set_mail_password (std::string p) {
338 void set_kdm_subject (std::string s) {
343 void set_kdm_from (std::string f) {
348 void set_kdm_cc (std::string f) {
353 void set_kdm_email (std::string e) {
358 void reset_kdm_email ();
360 void set_check_for_updates (bool c) {
361 _check_for_updates = c;
365 void set_check_for_test_updates (bool c) {
366 _check_for_test_updates = c;
370 void set_maximum_j2k_bandwidth (int b) {
371 _maximum_j2k_bandwidth = b;
375 void set_log_types (int t) {
380 boost::filesystem::path signer_chain_directory () const;
383 boost::signals2::signal<void ()> Changed;
385 static Config* instance ();
390 boost::filesystem::path file (bool) const;
394 /** number of threads to use for J2K encoding on the local machine */
395 int _num_local_encoding_threads;
396 /** default directory to put new films in */
397 boost::filesystem::path _default_directory;
398 /** base port number to use for J2K encoding servers;
399 * this port and the one above it will be used.
401 int _server_port_base;
402 /** true to broadcast on the `any' address to look for servers */
403 bool _use_any_servers;
404 /** J2K encoding servers that should definitely be used */
405 std::vector<std::string> _servers;
406 /** The IP address of a TMS that we can copy DCPs to */
408 /** The path on a TMS that we should write DCPs to */
409 std::string _tms_path;
410 /** User name to log into the TMS with */
411 std::string _tms_user;
412 /** Password to log into the TMS with */
413 std::string _tms_password;
414 /** Our cinema sound processor */
415 CinemaSoundProcessor const * _cinema_sound_processor;
416 std::list<int> _allowed_dcp_frame_rates;
417 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
418 bool _allow_any_dcp_frame_rate;
419 /** Default ISDCF metadata for newly-created Films */
420 ISDCFMetadata _default_isdcf_metadata;
421 boost::optional<std::string> _language;
422 int _default_still_length;
423 Ratio const * _default_scale;
424 Ratio const * _default_container;
425 DCPContentType const * _default_dcp_content_type;
426 dcp::XMLMetadata _dcp_metadata;
427 int _default_j2k_bandwidth;
428 int _default_audio_delay;
429 std::vector<PresetColourConversion> _colour_conversions;
430 std::list<boost::shared_ptr<Cinema> > _cinemas;
431 std::string _mail_server;
432 std::string _mail_user;
433 std::string _mail_password;
434 std::string _kdm_subject;
435 std::string _kdm_from;
437 std::string _kdm_email;
438 /** true to check for updates on startup */
439 bool _check_for_updates;
440 bool _check_for_test_updates;
441 /** maximum allowed J2K bandwidth in bits per second */
442 int _maximum_j2k_bandwidth;
445 /** Singleton instance, or 0 */
446 static Config* _instance;