2 Copyright (C) 2012-2015 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
27 #include "isdcf_metadata.h"
28 #include "video_content.h"
29 #include <dcp/metadata.h>
30 #include <dcp/certificates.h>
31 #include <dcp/signer.h>
32 #include <boost/shared_ptr.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/filesystem.hpp>
37 class ServerDescription;
40 class CinemaSoundProcessor;
46 * @brief A singleton class holding configuration.
48 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;
68 /** @return base port number to use for J2K encoding servers */
69 int server_port_base () const {
70 return _server_port_base;
73 void set_use_any_servers (bool u) {
75 changed (USE_ANY_SERVERS);
78 bool use_any_servers () const {
79 return _use_any_servers;
82 /** @param s New list of servers */
83 void set_servers (std::vector<std::string> s) {
88 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
89 std::vector<std::string> servers () const {
93 Protocol tms_protocol () const {
97 /** @return The IP address of a TMS that we can copy DCPs to */
98 std::string tms_ip () const {
102 /** @return The path on a TMS that we should changed DCPs to */
103 std::string tms_path () const {
107 /** @return User name to log into the TMS with */
108 std::string tms_user () const {
112 /** @return Password to log into the TMS with */
113 std::string tms_password () const {
114 return _tms_password;
117 /** @return The cinema sound processor that we are using */
118 CinemaSoundProcessor const * cinema_sound_processor () const {
119 return _cinema_sound_processor;
122 std::list<boost::shared_ptr<Cinema> > cinemas () const {
126 std::list<int> allowed_dcp_frame_rates () const {
127 return _allowed_dcp_frame_rates;
130 bool allow_any_dcp_frame_rate () const {
131 return _allow_any_dcp_frame_rate;
134 ISDCFMetadata default_isdcf_metadata () const {
135 return _default_isdcf_metadata;
138 boost::optional<std::string> language () const {
142 int default_still_length () const {
143 return _default_still_length;
146 Ratio const * default_container () const {
147 return _default_container;
150 DCPContentType const * default_dcp_content_type () const {
151 return _default_dcp_content_type;
154 std::string dcp_issuer () const {
158 int default_j2k_bandwidth () const {
159 return _default_j2k_bandwidth;
162 int default_audio_delay () const {
163 return _default_audio_delay;
166 std::string mail_server () const {
170 int mail_port () const {
174 std::string mail_user () const {
178 std::string mail_password () const {
179 return _mail_password;
182 std::string kdm_subject () const {
186 std::string kdm_from () const {
190 std::string kdm_cc () const {
194 std::string kdm_bcc () const {
198 std::string kdm_email () const {
202 boost::shared_ptr<const dcp::Signer> signer () const {
206 dcp::Certificate decryption_certificate () const {
207 return _decryption_certificate;
210 std::string decryption_private_key () const {
211 return _decryption_private_key;
214 bool check_for_updates () const {
215 return _check_for_updates;
218 bool check_for_test_updates () const {
219 return _check_for_test_updates;
222 int maximum_j2k_bandwidth () const {
223 return _maximum_j2k_bandwidth;
226 int log_types () const {
230 #ifdef DCPOMATIC_WINDOWS
231 bool win32_console () const {
232 return _win32_console;
236 std::vector<boost::filesystem::path> history () const {
240 /** @param n New number of local encoding threads */
241 void set_num_local_encoding_threads (int n) {
242 maybe_set (_num_local_encoding_threads, n);
245 void set_default_directory (boost::filesystem::path d) {
246 maybe_set (_default_directory, d);
249 /** @param p New server port */
250 void set_server_port_base (int p) {
251 maybe_set (_server_port_base, p);
254 void set_tms_protocol (Protocol p) {
255 maybe_set (_tms_protocol, p);
258 /** @param i IP address of a TMS that we can copy DCPs to */
259 void set_tms_ip (std::string i) {
260 maybe_set (_tms_ip, i);
263 /** @param p Path on a TMS that we should changed DCPs to */
264 void set_tms_path (std::string p) {
265 maybe_set (_tms_path, p);
268 /** @param u User name to log into the TMS with */
269 void set_tms_user (std::string u) {
270 maybe_set (_tms_user, u);
273 /** @param p Password to log into the TMS with */
274 void set_tms_password (std::string p) {
275 maybe_set (_tms_password, p);
278 void add_cinema (boost::shared_ptr<Cinema> c) {
279 _cinemas.push_back (c);
283 void remove_cinema (boost::shared_ptr<Cinema> c) {
288 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
289 maybe_set (_allowed_dcp_frame_rates, r);
292 void set_allow_any_dcp_frame_rate (bool a) {
293 maybe_set (_allow_any_dcp_frame_rate, a);
296 void set_default_isdcf_metadata (ISDCFMetadata d) {
297 maybe_set (_default_isdcf_metadata, d);
300 void set_language (std::string l) {
301 if (_language && _language.get() == l) {
308 void unset_language () {
313 _language = boost::none;
317 void set_default_still_length (int s) {
318 maybe_set (_default_still_length, s);
321 void set_default_container (Ratio const * c) {
322 maybe_set (_default_container, c);
325 void set_default_dcp_content_type (DCPContentType const * t) {
326 maybe_set (_default_dcp_content_type, t);
329 void set_dcp_issuer (std::string i) {
330 maybe_set (_dcp_issuer, i);
333 void set_default_j2k_bandwidth (int b) {
334 maybe_set (_default_j2k_bandwidth, b);
337 void set_default_audio_delay (int d) {
338 maybe_set (_default_audio_delay, d);
341 void set_mail_server (std::string s) {
342 maybe_set (_mail_server, s);
345 void set_mail_port (int p) {
346 maybe_set (_mail_port, p);
349 void set_mail_user (std::string u) {
350 maybe_set (_mail_user, u);
353 void set_mail_password (std::string p) {
354 maybe_set (_mail_password, p);
357 void set_kdm_subject (std::string s) {
358 maybe_set (_kdm_subject, s);
361 void set_kdm_from (std::string f) {
362 maybe_set (_kdm_from, f);
365 void set_kdm_cc (std::string f) {
366 maybe_set (_kdm_cc, f);
369 void set_kdm_bcc (std::string f) {
370 maybe_set (_kdm_bcc, f);
373 void set_kdm_email (std::string e) {
374 maybe_set (_kdm_email, e);
377 void reset_kdm_email ();
379 void set_signer (boost::shared_ptr<const dcp::Signer> s) {
380 maybe_set (_signer, s);
383 void set_decryption_certificate (dcp::Certificate c) {
384 maybe_set (_decryption_certificate, c);
387 void set_decryption_private_key (std::string k) {
388 maybe_set (_decryption_private_key, k);
391 void set_check_for_updates (bool c) {
392 maybe_set (_check_for_updates, c);
395 void set_check_for_test_updates (bool c) {
396 maybe_set (_check_for_test_updates, c);
399 void set_maximum_j2k_bandwidth (int b) {
400 maybe_set (_maximum_j2k_bandwidth, b);
403 void set_log_types (int t) {
404 maybe_set (_log_types, t);
407 #ifdef DCPOMATIC_WINDOWS
408 void set_win32_console (bool c) {
409 maybe_set (_win32_console, c);
413 void clear_history () {
418 void add_to_history (boost::filesystem::path p);
420 void changed (Property p = OTHER);
421 boost::signals2::signal<void (Property)> Changed;
425 static Config* instance ();
427 static void restore_defaults ();
431 boost::filesystem::path file () const;
433 void make_decryption_keys ();
434 void set_defaults ();
435 void set_kdm_email_to_default ();
438 void maybe_set (T& member, T new_value) {
439 if (member == new_value) {
446 /** number of threads to use for J2K encoding on the local machine */
447 int _num_local_encoding_threads;
448 /** default directory to put new films in */
449 boost::filesystem::path _default_directory;
450 /** base port number to use for J2K encoding servers;
451 * this port and the one above it will be used.
453 int _server_port_base;
454 /** true to broadcast on the `any' address to look for servers */
455 bool _use_any_servers;
456 /** J2K encoding servers that should definitely be used */
457 std::vector<std::string> _servers;
458 Protocol _tms_protocol;
459 /** The IP address of a TMS that we can copy DCPs to */
461 /** The path on a TMS that we should write DCPs to */
462 std::string _tms_path;
463 /** User name to log into the TMS with */
464 std::string _tms_user;
465 /** Password to log into the TMS with */
466 std::string _tms_password;
467 /** Our cinema sound processor */
468 CinemaSoundProcessor const * _cinema_sound_processor;
469 std::list<int> _allowed_dcp_frame_rates;
470 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
471 bool _allow_any_dcp_frame_rate;
472 /** Default ISDCF metadata for newly-created Films */
473 ISDCFMetadata _default_isdcf_metadata;
474 boost::optional<std::string> _language;
475 /** Default length of still image content (seconds) */
476 int _default_still_length;
477 Ratio const * _default_container;
478 DCPContentType const * _default_dcp_content_type;
479 std::string _dcp_issuer;
480 int _default_j2k_bandwidth;
481 int _default_audio_delay;
482 std::list<boost::shared_ptr<Cinema> > _cinemas;
483 std::string _mail_server;
485 std::string _mail_user;
486 std::string _mail_password;
487 std::string _kdm_subject;
488 std::string _kdm_from;
490 std::string _kdm_bcc;
491 std::string _kdm_email;
492 boost::shared_ptr<const dcp::Signer> _signer;
493 dcp::Certificate _decryption_certificate;
494 std::string _decryption_private_key;
495 /** true to check for updates on startup */
496 bool _check_for_updates;
497 bool _check_for_test_updates;
498 /** maximum allowed J2K bandwidth in bits per second */
499 int _maximum_j2k_bandwidth;
501 #ifdef DCPOMATIC_WINDOWS
504 std::vector<boost::filesystem::path> _history;
506 /** Singleton instance, or 0 */
507 static Config* _instance;