2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/config.h
22 * @brief Class holding configuration.
25 #ifndef DCPOMATIC_CONFIG_H
26 #define DCPOMATIC_CONFIG_H
28 #include "isdcf_metadata.h"
29 #include "kdm_name_format.h"
31 #include <dcp/certificate_chain.h>
32 #include <dcp/encrypted_kdm.h>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/signals2.hpp>
35 #include <boost/filesystem.hpp>
38 class CinemaSoundProcessor;
44 * @brief A singleton class holding configuration.
46 class Config : public boost::noncopyable
49 /** @return number of threads to use for J2K encoding on the local machine */
50 int num_local_encoding_threads () const {
51 return _num_local_encoding_threads;
54 boost::filesystem::path default_directory () const {
55 return _default_directory;
58 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
66 /** @return base port number to use for J2K encoding servers */
67 int server_port_base () const {
68 return _server_port_base;
71 void set_use_any_servers (bool u) {
73 changed (USE_ANY_SERVERS);
76 bool use_any_servers () const {
77 return _use_any_servers;
80 /** @param s New list of servers */
81 void set_servers (std::vector<std::string> s) {
86 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
87 std::vector<std::string> servers () const {
91 bool only_servers_encode () const {
92 return _only_servers_encode;
95 Protocol tms_protocol () const {
99 /** @return The IP address of a TMS that we can copy DCPs to */
100 std::string tms_ip () const {
104 /** @return The path on a TMS that we should changed DCPs to */
105 std::string tms_path () const {
109 /** @return User name to log into the TMS with */
110 std::string tms_user () const {
114 /** @return Password to log into the TMS with */
115 std::string tms_password () const {
116 return _tms_password;
119 /** @return The cinema sound processor that we are using */
120 CinemaSoundProcessor const * cinema_sound_processor () const {
121 return _cinema_sound_processor;
124 std::list<boost::shared_ptr<Cinema> > cinemas () const {
128 std::list<int> allowed_dcp_frame_rates () const {
129 return _allowed_dcp_frame_rates;
132 bool allow_any_dcp_frame_rate () const {
133 return _allow_any_dcp_frame_rate;
136 ISDCFMetadata default_isdcf_metadata () const {
137 return _default_isdcf_metadata;
140 boost::optional<std::string> language () const {
144 int default_still_length () const {
145 return _default_still_length;
148 Ratio const * default_container () const {
149 return _default_container;
152 DCPContentType const * default_dcp_content_type () const {
153 return _default_dcp_content_type;
156 int default_dcp_audio_channels () const {
157 return _default_dcp_audio_channels;
160 std::string dcp_issuer () const {
164 std::string dcp_creator () const {
168 int default_j2k_bandwidth () const {
169 return _default_j2k_bandwidth;
172 int default_audio_delay () const {
173 return _default_audio_delay;
176 bool default_interop () const {
177 return _default_interop;
180 std::string mail_server () const {
184 int mail_port () const {
188 std::string mail_user () const {
192 std::string mail_password () const {
193 return _mail_password;
196 std::string kdm_subject () const {
200 std::string kdm_from () const {
204 std::vector<std::string> kdm_cc () const {
208 std::string kdm_bcc () const {
212 std::string kdm_email () const {
216 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
217 return _signer_chain;
220 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
221 return _decryption_chain;
224 bool check_for_updates () const {
225 return _check_for_updates;
228 bool check_for_test_updates () const {
229 return _check_for_test_updates;
232 int maximum_j2k_bandwidth () const {
233 return _maximum_j2k_bandwidth;
236 int log_types () const {
240 bool analyse_ebur128 () const {
241 return _analyse_ebur128;
244 bool automatic_audio_analysis () const {
245 return _automatic_audio_analysis;
248 #ifdef DCPOMATIC_WINDOWS
249 bool win32_console () const {
250 return _win32_console;
254 std::vector<boost::filesystem::path> history () const {
258 std::vector<dcp::EncryptedKDM> dkdms () const {
262 boost::filesystem::path cinemas_file () const {
263 return _cinemas_file;
266 bool show_hints_before_make_dcp () const {
267 return _show_hints_before_make_dcp;
270 KDMNameFormat kdm_filename_format () const {
271 return _kdm_filename_format;
274 /** @param n New number of local encoding threads */
275 void set_num_local_encoding_threads (int n) {
276 maybe_set (_num_local_encoding_threads, n);
279 void set_default_directory (boost::filesystem::path d) {
280 maybe_set (_default_directory, d);
283 /** @param p New server port */
284 void set_server_port_base (int p) {
285 maybe_set (_server_port_base, p);
288 void set_only_servers_encode (bool o) {
289 maybe_set (_only_servers_encode, o);
292 void set_tms_protocol (Protocol p) {
293 maybe_set (_tms_protocol, p);
296 /** @param i IP address of a TMS that we can copy DCPs to */
297 void set_tms_ip (std::string i) {
298 maybe_set (_tms_ip, i);
301 /** @param p Path on a TMS that we should changed DCPs to */
302 void set_tms_path (std::string p) {
303 maybe_set (_tms_path, p);
306 /** @param u User name to log into the TMS with */
307 void set_tms_user (std::string u) {
308 maybe_set (_tms_user, u);
311 /** @param p Password to log into the TMS with */
312 void set_tms_password (std::string p) {
313 maybe_set (_tms_password, p);
316 void add_cinema (boost::shared_ptr<Cinema> c) {
317 _cinemas.push_back (c);
321 void remove_cinema (boost::shared_ptr<Cinema> c) {
326 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
327 maybe_set (_allowed_dcp_frame_rates, r);
330 void set_allow_any_dcp_frame_rate (bool a) {
331 maybe_set (_allow_any_dcp_frame_rate, a);
334 void set_default_isdcf_metadata (ISDCFMetadata d) {
335 maybe_set (_default_isdcf_metadata, d);
338 void set_language (std::string l) {
339 if (_language && _language.get() == l) {
346 void unset_language () {
351 _language = boost::none;
355 void set_default_still_length (int s) {
356 maybe_set (_default_still_length, s);
359 void set_default_container (Ratio const * c) {
360 maybe_set (_default_container, c);
363 void set_default_dcp_content_type (DCPContentType const * t) {
364 maybe_set (_default_dcp_content_type, t);
367 void set_default_dcp_audio_channels (int c) {
368 maybe_set (_default_dcp_audio_channels, c);
371 void set_dcp_issuer (std::string i) {
372 maybe_set (_dcp_issuer, i);
375 void set_dcp_creator (std::string c) {
376 maybe_set (_dcp_creator, c);
379 void set_default_j2k_bandwidth (int b) {
380 maybe_set (_default_j2k_bandwidth, b);
383 void set_default_audio_delay (int d) {
384 maybe_set (_default_audio_delay, d);
387 void set_default_interop (bool i) {
388 maybe_set (_default_interop, i);
391 void set_mail_server (std::string s) {
392 maybe_set (_mail_server, s);
395 void set_mail_port (int p) {
396 maybe_set (_mail_port, p);
399 void set_mail_user (std::string u) {
400 maybe_set (_mail_user, u);
403 void set_mail_password (std::string p) {
404 maybe_set (_mail_password, p);
407 void set_kdm_subject (std::string s) {
408 maybe_set (_kdm_subject, s);
411 void set_kdm_from (std::string f) {
412 maybe_set (_kdm_from, f);
415 void set_kdm_cc (std::vector<std::string> f) {
416 maybe_set (_kdm_cc, f);
419 void set_kdm_bcc (std::string f) {
420 maybe_set (_kdm_bcc, f);
423 void set_kdm_email (std::string e) {
424 maybe_set (_kdm_email, e);
427 void reset_kdm_email ();
429 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
430 maybe_set (_signer_chain, s);
433 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
434 maybe_set (_decryption_chain, c);
437 void set_check_for_updates (bool c) {
438 maybe_set (_check_for_updates, c);
440 set_check_for_test_updates (false);
444 void set_check_for_test_updates (bool c) {
445 maybe_set (_check_for_test_updates, c);
448 void set_maximum_j2k_bandwidth (int b) {
449 maybe_set (_maximum_j2k_bandwidth, b);
452 void set_log_types (int t) {
453 maybe_set (_log_types, t);
456 void set_analyse_ebur128 (bool a) {
457 maybe_set (_analyse_ebur128, a);
460 void set_automatic_audio_analysis (bool a) {
461 maybe_set (_automatic_audio_analysis, a);
464 #ifdef DCPOMATIC_WINDOWS
465 void set_win32_console (bool c) {
466 maybe_set (_win32_console, c);
470 void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms)
476 void set_cinemas_file (boost::filesystem::path file);
478 void set_show_hints_before_make_dcp (bool s) {
479 maybe_set (_show_hints_before_make_dcp, s);
482 void set_kdm_filename_format (KDMNameFormat n) {
483 maybe_set (_kdm_filename_format, n);
486 void clear_history () {
491 void add_to_history (boost::filesystem::path p);
493 void changed (Property p = OTHER);
494 boost::signals2::signal<void (Property)> Changed;
495 /** Emitted if ::read() failed on an existing Config file. There is nothing
496 a listener can do about it: this is just for information.
498 static boost::signals2::signal<void ()> FailedToLoad;
502 static Config* instance ();
504 static void restore_defaults ();
505 static bool have_existing (std::string);
509 static boost::filesystem::path path (std::string file, bool create_directories = true);
511 void set_defaults ();
512 void set_kdm_email_to_default ();
513 void write_config_xml () const;
514 void write_cinemas_xml () const;
515 void read_cinemas (cxml::Document const & f);
516 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
519 void maybe_set (T& member, T new_value) {
520 if (member == new_value) {
527 /** number of threads to use for J2K encoding on the local machine */
528 int _num_local_encoding_threads;
529 /** default directory to put new films in */
530 boost::filesystem::path _default_directory;
531 /** base port number to use for J2K encoding servers;
532 * this port and the two above it will be used.
534 int _server_port_base;
535 /** true to broadcast on the `any' address to look for servers */
536 bool _use_any_servers;
537 /** J2K encoding servers that should definitely be used */
538 std::vector<std::string> _servers;
539 bool _only_servers_encode;
540 Protocol _tms_protocol;
541 /** The IP address of a TMS that we can copy DCPs to */
543 /** The path on a TMS that we should write DCPs to */
544 std::string _tms_path;
545 /** User name to log into the TMS with */
546 std::string _tms_user;
547 /** Password to log into the TMS with */
548 std::string _tms_password;
549 /** Our cinema sound processor */
550 CinemaSoundProcessor const * _cinema_sound_processor;
551 std::list<int> _allowed_dcp_frame_rates;
552 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
553 bool _allow_any_dcp_frame_rate;
554 /** Default ISDCF metadata for newly-created Films */
555 ISDCFMetadata _default_isdcf_metadata;
556 boost::optional<std::string> _language;
557 /** Default length of still image content (seconds) */
558 int _default_still_length;
559 Ratio const * _default_container;
560 DCPContentType const * _default_dcp_content_type;
561 int _default_dcp_audio_channels;
562 std::string _dcp_issuer;
563 std::string _dcp_creator;
564 int _default_j2k_bandwidth;
565 int _default_audio_delay;
566 bool _default_interop;
567 std::list<boost::shared_ptr<Cinema> > _cinemas;
568 std::string _mail_server;
570 std::string _mail_user;
571 std::string _mail_password;
572 std::string _kdm_subject;
573 std::string _kdm_from;
574 std::vector<std::string> _kdm_cc;
575 std::string _kdm_bcc;
576 std::string _kdm_email;
577 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
578 /** Chain used to decrypt KDMs; the leaf of this chain is the target
579 * certificate for making KDMs given to DCP-o-matic.
581 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
582 /** true to check for updates on startup */
583 bool _check_for_updates;
584 bool _check_for_test_updates;
585 /** maximum allowed J2K bandwidth in bits per second */
586 int _maximum_j2k_bandwidth;
588 bool _analyse_ebur128;
589 bool _automatic_audio_analysis;
590 #ifdef DCPOMATIC_WINDOWS
593 std::vector<boost::filesystem::path> _history;
594 std::vector<dcp::EncryptedKDM> _dkdms;
595 boost::filesystem::path _cinemas_file;
596 bool _show_hints_before_make_dcp;
597 KDMNameFormat _kdm_filename_format;
599 /** Singleton instance, or 0 */
600 static Config* _instance;