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"
30 #include <dcp/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;
45 * @brief A singleton class holding configuration.
47 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;
67 /** @return base port number to use for J2K encoding servers */
68 int server_port_base () const {
69 return _server_port_base;
72 void set_use_any_servers (bool u) {
74 changed (USE_ANY_SERVERS);
77 bool use_any_servers () const {
78 return _use_any_servers;
81 /** @param s New list of servers */
82 void set_servers (std::vector<std::string> s) {
87 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
88 std::vector<std::string> servers () const {
92 bool only_servers_encode () const {
93 return _only_servers_encode;
96 Protocol tms_protocol () const {
100 /** @return The IP address of a TMS that we can copy DCPs to */
101 std::string tms_ip () const {
105 /** @return The path on a TMS that we should changed DCPs to */
106 std::string tms_path () const {
110 /** @return User name to log into the TMS with */
111 std::string tms_user () const {
115 /** @return Password to log into the TMS with */
116 std::string tms_password () const {
117 return _tms_password;
120 /** @return The cinema sound processor that we are using */
121 CinemaSoundProcessor const * cinema_sound_processor () const {
122 return _cinema_sound_processor;
125 std::list<boost::shared_ptr<Cinema> > cinemas () const {
129 std::list<int> allowed_dcp_frame_rates () const {
130 return _allowed_dcp_frame_rates;
133 bool allow_any_dcp_frame_rate () const {
134 return _allow_any_dcp_frame_rate;
137 ISDCFMetadata default_isdcf_metadata () const {
138 return _default_isdcf_metadata;
141 boost::optional<std::string> language () const {
145 int default_still_length () const {
146 return _default_still_length;
149 Ratio const * default_container () const {
150 return _default_container;
153 DCPContentType const * default_dcp_content_type () const {
154 return _default_dcp_content_type;
157 int default_dcp_audio_channels () const {
158 return _default_dcp_audio_channels;
161 std::string dcp_issuer () const {
165 std::string dcp_creator () const {
169 int default_j2k_bandwidth () const {
170 return _default_j2k_bandwidth;
173 int default_audio_delay () const {
174 return _default_audio_delay;
177 bool default_interop () const {
178 return _default_interop;
181 std::string mail_server () const {
185 int mail_port () const {
189 std::string mail_user () const {
193 std::string mail_password () const {
194 return _mail_password;
197 std::string kdm_subject () const {
201 std::string kdm_from () const {
205 std::vector<std::string> kdm_cc () const {
209 std::string kdm_bcc () const {
213 std::string kdm_email () const {
217 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
218 return _signer_chain;
221 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
222 return _decryption_chain;
225 bool check_for_updates () const {
226 return _check_for_updates;
229 bool check_for_test_updates () const {
230 return _check_for_test_updates;
233 int maximum_j2k_bandwidth () const {
234 return _maximum_j2k_bandwidth;
237 int log_types () const {
241 bool analyse_ebur128 () const {
242 return _analyse_ebur128;
245 bool automatic_audio_analysis () const {
246 return _automatic_audio_analysis;
249 #ifdef DCPOMATIC_WINDOWS
250 bool win32_console () const {
251 return _win32_console;
255 std::vector<boost::filesystem::path> history () const {
259 std::vector<dcp::EncryptedKDM> dkdms () const {
263 boost::filesystem::path cinemas_file () const {
264 return _cinemas_file;
267 bool show_hints_before_make_dcp () const {
268 return _show_hints_before_make_dcp;
271 bool confirm_kdm_email () const {
272 return _confirm_kdm_email;
275 dcp::NameFormat kdm_filename_format () const {
276 return _kdm_filename_format;
279 dcp::NameFormat dcp_metadata_filename_format () const {
280 return _dcp_metadata_filename_format;
283 dcp::NameFormat dcp_asset_filename_format () const {
284 return _dcp_asset_filename_format;
287 /** @param n New number of local encoding threads */
288 void set_num_local_encoding_threads (int n) {
289 maybe_set (_num_local_encoding_threads, n);
292 void set_default_directory (boost::filesystem::path d) {
293 maybe_set (_default_directory, d);
296 /** @param p New server port */
297 void set_server_port_base (int p) {
298 maybe_set (_server_port_base, p);
301 void set_only_servers_encode (bool o) {
302 maybe_set (_only_servers_encode, o);
305 void set_tms_protocol (Protocol p) {
306 maybe_set (_tms_protocol, p);
309 /** @param i IP address of a TMS that we can copy DCPs to */
310 void set_tms_ip (std::string i) {
311 maybe_set (_tms_ip, i);
314 /** @param p Path on a TMS that we should changed DCPs to */
315 void set_tms_path (std::string p) {
316 maybe_set (_tms_path, p);
319 /** @param u User name to log into the TMS with */
320 void set_tms_user (std::string u) {
321 maybe_set (_tms_user, u);
324 /** @param p Password to log into the TMS with */
325 void set_tms_password (std::string p) {
326 maybe_set (_tms_password, p);
329 void add_cinema (boost::shared_ptr<Cinema> c) {
330 _cinemas.push_back (c);
334 void remove_cinema (boost::shared_ptr<Cinema> c) {
339 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
340 maybe_set (_allowed_dcp_frame_rates, r);
343 void set_allow_any_dcp_frame_rate (bool a) {
344 maybe_set (_allow_any_dcp_frame_rate, a);
347 void set_default_isdcf_metadata (ISDCFMetadata d) {
348 maybe_set (_default_isdcf_metadata, d);
351 void set_language (std::string l) {
352 if (_language && _language.get() == l) {
359 void unset_language () {
364 _language = boost::none;
368 void set_default_still_length (int s) {
369 maybe_set (_default_still_length, s);
372 void set_default_container (Ratio const * c) {
373 maybe_set (_default_container, c);
376 void set_default_dcp_content_type (DCPContentType const * t) {
377 maybe_set (_default_dcp_content_type, t);
380 void set_default_dcp_audio_channels (int c) {
381 maybe_set (_default_dcp_audio_channels, c);
384 void set_dcp_issuer (std::string i) {
385 maybe_set (_dcp_issuer, i);
388 void set_dcp_creator (std::string c) {
389 maybe_set (_dcp_creator, c);
392 void set_default_j2k_bandwidth (int b) {
393 maybe_set (_default_j2k_bandwidth, b);
396 void set_default_audio_delay (int d) {
397 maybe_set (_default_audio_delay, d);
400 void set_default_interop (bool i) {
401 maybe_set (_default_interop, i);
404 void set_mail_server (std::string s) {
405 maybe_set (_mail_server, s);
408 void set_mail_port (int p) {
409 maybe_set (_mail_port, p);
412 void set_mail_user (std::string u) {
413 maybe_set (_mail_user, u);
416 void set_mail_password (std::string p) {
417 maybe_set (_mail_password, p);
420 void set_kdm_subject (std::string s) {
421 maybe_set (_kdm_subject, s);
424 void set_kdm_from (std::string f) {
425 maybe_set (_kdm_from, f);
428 void set_kdm_cc (std::vector<std::string> f) {
429 maybe_set (_kdm_cc, f);
432 void set_kdm_bcc (std::string f) {
433 maybe_set (_kdm_bcc, f);
436 void set_kdm_email (std::string e) {
437 maybe_set (_kdm_email, e);
440 void reset_kdm_email ();
442 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
443 maybe_set (_signer_chain, s);
446 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
447 maybe_set (_decryption_chain, c);
450 void set_check_for_updates (bool c) {
451 maybe_set (_check_for_updates, c);
453 set_check_for_test_updates (false);
457 void set_check_for_test_updates (bool c) {
458 maybe_set (_check_for_test_updates, c);
461 void set_maximum_j2k_bandwidth (int b) {
462 maybe_set (_maximum_j2k_bandwidth, b);
465 void set_log_types (int t) {
466 maybe_set (_log_types, t);
469 void set_analyse_ebur128 (bool a) {
470 maybe_set (_analyse_ebur128, a);
473 void set_automatic_audio_analysis (bool a) {
474 maybe_set (_automatic_audio_analysis, a);
477 #ifdef DCPOMATIC_WINDOWS
478 void set_win32_console (bool c) {
479 maybe_set (_win32_console, c);
483 void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms) {
488 void set_cinemas_file (boost::filesystem::path file);
490 void set_show_hints_before_make_dcp (bool s) {
491 maybe_set (_show_hints_before_make_dcp, s);
494 void set_confirm_kdm_email (bool s) {
495 maybe_set (_confirm_kdm_email, s);
498 void set_kdm_filename_format (dcp::NameFormat n) {
499 maybe_set (_kdm_filename_format, n);
502 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
503 maybe_set (_dcp_metadata_filename_format, n);
506 void set_dcp_asset_filename_format (dcp::NameFormat n) {
507 maybe_set (_dcp_asset_filename_format, n);
510 void clear_history () {
515 void add_to_history (boost::filesystem::path p);
517 void changed (Property p = OTHER);
518 boost::signals2::signal<void (Property)> Changed;
519 /** Emitted if ::read() failed on an existing Config file. There is nothing
520 a listener can do about it: this is just for information.
522 static boost::signals2::signal<void ()> FailedToLoad;
526 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
527 bool existing_template (std::string name) const;
528 std::list<std::string> templates () const;
529 boost::filesystem::path template_path (std::string name) const;
530 void rename_template (std::string old_name, std::string new_name) const;
531 void delete_template (std::string name) const;
533 static Config* instance ();
535 static void restore_defaults ();
536 static bool have_existing (std::string);
540 static boost::filesystem::path path (std::string file, bool create_directories = true);
542 void set_defaults ();
543 void set_kdm_email_to_default ();
544 void write_config_xml () const;
545 void write_cinemas_xml () const;
546 void read_cinemas (cxml::Document const & f);
547 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
550 void maybe_set (T& member, T new_value) {
551 if (member == new_value) {
558 /** number of threads to use for J2K encoding on the local machine */
559 int _num_local_encoding_threads;
560 /** default directory to put new films in */
561 boost::filesystem::path _default_directory;
562 /** base port number to use for J2K encoding servers;
563 * this port and the two above it will be used.
565 int _server_port_base;
566 /** true to broadcast on the `any' address to look for servers */
567 bool _use_any_servers;
568 /** J2K encoding servers that should definitely be used */
569 std::vector<std::string> _servers;
570 bool _only_servers_encode;
571 Protocol _tms_protocol;
572 /** The IP address of a TMS that we can copy DCPs to */
574 /** The path on a TMS that we should write DCPs to */
575 std::string _tms_path;
576 /** User name to log into the TMS with */
577 std::string _tms_user;
578 /** Password to log into the TMS with */
579 std::string _tms_password;
580 /** Our cinema sound processor */
581 CinemaSoundProcessor const * _cinema_sound_processor;
582 std::list<int> _allowed_dcp_frame_rates;
583 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
584 bool _allow_any_dcp_frame_rate;
585 /** Default ISDCF metadata for newly-created Films */
586 ISDCFMetadata _default_isdcf_metadata;
587 boost::optional<std::string> _language;
588 /** Default length of still image content (seconds) */
589 int _default_still_length;
590 Ratio const * _default_container;
591 DCPContentType const * _default_dcp_content_type;
592 int _default_dcp_audio_channels;
593 std::string _dcp_issuer;
594 std::string _dcp_creator;
595 int _default_j2k_bandwidth;
596 int _default_audio_delay;
597 bool _default_interop;
598 std::list<boost::shared_ptr<Cinema> > _cinemas;
599 std::string _mail_server;
601 std::string _mail_user;
602 std::string _mail_password;
603 std::string _kdm_subject;
604 std::string _kdm_from;
605 std::vector<std::string> _kdm_cc;
606 std::string _kdm_bcc;
607 std::string _kdm_email;
608 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
609 /** Chain used to decrypt KDMs; the leaf of this chain is the target
610 * certificate for making KDMs given to DCP-o-matic.
612 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
613 /** true to check for updates on startup */
614 bool _check_for_updates;
615 bool _check_for_test_updates;
616 /** maximum allowed J2K bandwidth in bits per second */
617 int _maximum_j2k_bandwidth;
619 bool _analyse_ebur128;
620 bool _automatic_audio_analysis;
621 #ifdef DCPOMATIC_WINDOWS
624 std::vector<boost::filesystem::path> _history;
625 std::vector<dcp::EncryptedKDM> _dkdms;
626 boost::filesystem::path _cinemas_file;
627 bool _show_hints_before_make_dcp;
628 bool _confirm_kdm_email;
629 dcp::NameFormat _kdm_filename_format;
630 dcp::NameFormat _dcp_metadata_filename_format;
631 dcp::NameFormat _dcp_asset_filename_format;
633 /** Singleton instance, or 0 */
634 static Config* _instance;