2 Copyright (C) 2012-2015 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"
30 #include <dcp/certificate_chain.h>
31 #include <dcp/encrypted_kdm.h>
32 #include <boost/shared_ptr.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/filesystem.hpp>
37 class CinemaSoundProcessor;
43 * @brief A singleton class holding configuration.
45 class Config : public boost::noncopyable
48 /** @return number of threads to use for J2K encoding on the local machine */
49 int num_local_encoding_threads () const {
50 return _num_local_encoding_threads;
53 boost::filesystem::path default_directory () const {
54 return _default_directory;
57 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
65 /** @return base port number to use for J2K encoding servers */
66 int server_port_base () const {
67 return _server_port_base;
70 void set_use_any_servers (bool u) {
72 changed (USE_ANY_SERVERS);
75 bool use_any_servers () const {
76 return _use_any_servers;
79 /** @param s New list of servers */
80 void set_servers (std::vector<std::string> s) {
85 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
86 std::vector<std::string> servers () const {
90 bool only_servers_encode () const {
91 return _only_servers_encode;
94 Protocol tms_protocol () const {
98 /** @return The IP address of a TMS that we can copy DCPs to */
99 std::string tms_ip () const {
103 /** @return The path on a TMS that we should changed DCPs to */
104 std::string tms_path () const {
108 /** @return User name to log into the TMS with */
109 std::string tms_user () const {
113 /** @return Password to log into the TMS with */
114 std::string tms_password () const {
115 return _tms_password;
118 /** @return The cinema sound processor that we are using */
119 CinemaSoundProcessor const * cinema_sound_processor () const {
120 return _cinema_sound_processor;
123 std::list<boost::shared_ptr<Cinema> > cinemas () const {
127 std::list<int> allowed_dcp_frame_rates () const {
128 return _allowed_dcp_frame_rates;
131 bool allow_any_dcp_frame_rate () const {
132 return _allow_any_dcp_frame_rate;
135 ISDCFMetadata default_isdcf_metadata () const {
136 return _default_isdcf_metadata;
139 boost::optional<std::string> language () const {
143 int default_still_length () const {
144 return _default_still_length;
147 Ratio const * default_container () const {
148 return _default_container;
151 DCPContentType const * default_dcp_content_type () const {
152 return _default_dcp_content_type;
155 std::string dcp_issuer () const {
159 std::string dcp_creator () const {
163 int default_j2k_bandwidth () const {
164 return _default_j2k_bandwidth;
167 int default_audio_delay () const {
168 return _default_audio_delay;
171 bool default_interop () const {
172 return _default_interop;
175 std::string mail_server () const {
179 int mail_port () const {
183 std::string mail_user () const {
187 std::string mail_password () const {
188 return _mail_password;
191 std::string kdm_subject () const {
195 std::string kdm_from () const {
199 std::vector<std::string> kdm_cc () const {
203 std::string kdm_bcc () const {
207 std::string kdm_email () const {
211 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
212 return _signer_chain;
215 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
216 return _decryption_chain;
219 bool check_for_updates () const {
220 return _check_for_updates;
223 bool check_for_test_updates () const {
224 return _check_for_test_updates;
227 int maximum_j2k_bandwidth () const {
228 return _maximum_j2k_bandwidth;
231 int log_types () const {
235 bool analyse_ebur128 () const {
236 return _analyse_ebur128;
239 bool automatic_audio_analysis () const {
240 return _automatic_audio_analysis;
243 #ifdef DCPOMATIC_WINDOWS
244 bool win32_console () const {
245 return _win32_console;
249 std::vector<boost::filesystem::path> history () const {
253 std::vector<dcp::EncryptedKDM> dkdms () const {
257 boost::filesystem::path cinemas_file () const {
258 return _cinemas_file;
261 /** @param n New number of local encoding threads */
262 void set_num_local_encoding_threads (int n) {
263 maybe_set (_num_local_encoding_threads, n);
266 void set_default_directory (boost::filesystem::path d) {
267 maybe_set (_default_directory, d);
270 /** @param p New server port */
271 void set_server_port_base (int p) {
272 maybe_set (_server_port_base, p);
275 void set_only_servers_encode (bool o) {
276 maybe_set (_only_servers_encode, o);
279 void set_tms_protocol (Protocol p) {
280 maybe_set (_tms_protocol, p);
283 /** @param i IP address of a TMS that we can copy DCPs to */
284 void set_tms_ip (std::string i) {
285 maybe_set (_tms_ip, i);
288 /** @param p Path on a TMS that we should changed DCPs to */
289 void set_tms_path (std::string p) {
290 maybe_set (_tms_path, p);
293 /** @param u User name to log into the TMS with */
294 void set_tms_user (std::string u) {
295 maybe_set (_tms_user, u);
298 /** @param p Password to log into the TMS with */
299 void set_tms_password (std::string p) {
300 maybe_set (_tms_password, p);
303 void add_cinema (boost::shared_ptr<Cinema> c) {
304 _cinemas.push_back (c);
308 void remove_cinema (boost::shared_ptr<Cinema> c) {
313 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
314 maybe_set (_allowed_dcp_frame_rates, r);
317 void set_allow_any_dcp_frame_rate (bool a) {
318 maybe_set (_allow_any_dcp_frame_rate, a);
321 void set_default_isdcf_metadata (ISDCFMetadata d) {
322 maybe_set (_default_isdcf_metadata, d);
325 void set_language (std::string l) {
326 if (_language && _language.get() == l) {
333 void unset_language () {
338 _language = boost::none;
342 void set_default_still_length (int s) {
343 maybe_set (_default_still_length, s);
346 void set_default_container (Ratio const * c) {
347 maybe_set (_default_container, c);
350 void set_default_dcp_content_type (DCPContentType const * t) {
351 maybe_set (_default_dcp_content_type, t);
354 void set_dcp_issuer (std::string i) {
355 maybe_set (_dcp_issuer, i);
358 void set_dcp_creator (std::string c) {
359 maybe_set (_dcp_creator, c);
362 void set_default_j2k_bandwidth (int b) {
363 maybe_set (_default_j2k_bandwidth, b);
366 void set_default_audio_delay (int d) {
367 maybe_set (_default_audio_delay, d);
370 void set_default_interop (bool i) {
371 maybe_set (_default_interop, i);
374 void set_mail_server (std::string s) {
375 maybe_set (_mail_server, s);
378 void set_mail_port (int p) {
379 maybe_set (_mail_port, p);
382 void set_mail_user (std::string u) {
383 maybe_set (_mail_user, u);
386 void set_mail_password (std::string p) {
387 maybe_set (_mail_password, p);
390 void set_kdm_subject (std::string s) {
391 maybe_set (_kdm_subject, s);
394 void set_kdm_from (std::string f) {
395 maybe_set (_kdm_from, f);
398 void set_kdm_cc (std::vector<std::string> f) {
399 maybe_set (_kdm_cc, f);
402 void set_kdm_bcc (std::string f) {
403 maybe_set (_kdm_bcc, f);
406 void set_kdm_email (std::string e) {
407 maybe_set (_kdm_email, e);
410 void reset_kdm_email ();
412 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
413 maybe_set (_signer_chain, s);
416 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
417 maybe_set (_decryption_chain, c);
420 void set_check_for_updates (bool c) {
421 maybe_set (_check_for_updates, c);
423 set_check_for_test_updates (false);
427 void set_check_for_test_updates (bool c) {
428 maybe_set (_check_for_test_updates, c);
431 void set_maximum_j2k_bandwidth (int b) {
432 maybe_set (_maximum_j2k_bandwidth, b);
435 void set_log_types (int t) {
436 maybe_set (_log_types, t);
439 void set_analyse_ebur128 (bool a) {
440 maybe_set (_analyse_ebur128, a);
443 void set_automatic_audio_analysis (bool a) {
444 maybe_set (_automatic_audio_analysis, a);
447 #ifdef DCPOMATIC_WINDOWS
448 void set_win32_console (bool c) {
449 maybe_set (_win32_console, c);
453 void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms)
459 void set_cinemas_file (boost::filesystem::path file);
461 void clear_history () {
466 void add_to_history (boost::filesystem::path p);
468 void changed (Property p = OTHER);
469 boost::signals2::signal<void (Property)> Changed;
473 static Config* instance ();
475 static void restore_defaults ();
476 static bool have_existing (std::string);
480 static boost::filesystem::path path (std::string file, bool create_directories = true);
482 void set_defaults ();
483 void set_kdm_email_to_default ();
484 void write_config_xml () const;
485 void write_cinemas_xml () const;
486 void read_cinemas (cxml::Document const & f);
487 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
490 void maybe_set (T& member, T new_value) {
491 if (member == new_value) {
498 /** number of threads to use for J2K encoding on the local machine */
499 int _num_local_encoding_threads;
500 /** default directory to put new films in */
501 boost::filesystem::path _default_directory;
502 /** base port number to use for J2K encoding servers;
503 * this port and the two above it will be used.
505 int _server_port_base;
506 /** true to broadcast on the `any' address to look for servers */
507 bool _use_any_servers;
508 /** J2K encoding servers that should definitely be used */
509 std::vector<std::string> _servers;
510 bool _only_servers_encode;
511 Protocol _tms_protocol;
512 /** The IP address of a TMS that we can copy DCPs to */
514 /** The path on a TMS that we should write DCPs to */
515 std::string _tms_path;
516 /** User name to log into the TMS with */
517 std::string _tms_user;
518 /** Password to log into the TMS with */
519 std::string _tms_password;
520 /** Our cinema sound processor */
521 CinemaSoundProcessor const * _cinema_sound_processor;
522 std::list<int> _allowed_dcp_frame_rates;
523 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
524 bool _allow_any_dcp_frame_rate;
525 /** Default ISDCF metadata for newly-created Films */
526 ISDCFMetadata _default_isdcf_metadata;
527 boost::optional<std::string> _language;
528 /** Default length of still image content (seconds) */
529 int _default_still_length;
530 Ratio const * _default_container;
531 DCPContentType const * _default_dcp_content_type;
532 std::string _dcp_issuer;
533 std::string _dcp_creator;
534 int _default_j2k_bandwidth;
535 int _default_audio_delay;
536 bool _default_interop;
537 std::list<boost::shared_ptr<Cinema> > _cinemas;
538 std::string _mail_server;
540 std::string _mail_user;
541 std::string _mail_password;
542 std::string _kdm_subject;
543 std::string _kdm_from;
544 std::vector<std::string> _kdm_cc;
545 std::string _kdm_bcc;
546 std::string _kdm_email;
547 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
548 /** Chain used to decrypt KDMs; the leaf of this chain is the target
549 * certificate for making KDMs given to DCP-o-matic.
551 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
552 /** true to check for updates on startup */
553 bool _check_for_updates;
554 bool _check_for_test_updates;
555 /** maximum allowed J2K bandwidth in bits per second */
556 int _maximum_j2k_bandwidth;
558 bool _analyse_ebur128;
559 bool _automatic_audio_analysis;
560 #ifdef DCPOMATIC_WINDOWS
563 std::vector<boost::filesystem::path> _history;
564 std::vector<dcp::EncryptedKDM> _dkdms;
565 boost::filesystem::path _cinemas_file;
567 /** Singleton instance, or 0 */
568 static Config* _instance;