2 Copyright (C) 2012-2017 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 which a master DoM should use for J2K encoding on the local machine */
51 int master_encoding_threads () const {
52 return _master_encoding_threads;
55 /** @return number of threads which a server should use for J2K encoding on the local machine */
56 int server_encoding_threads () const {
57 return _server_encoding_threads;
60 boost::optional<boost::filesystem::path> default_directory () const {
61 return _default_directory;
64 boost::optional<boost::filesystem::path> default_kdm_directory () const {
65 return _default_kdm_directory;
68 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
69 boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
80 /** @return base port number to use for J2K encoding servers */
81 int server_port_base () const {
82 return _server_port_base;
85 void set_use_any_servers (bool u) {
87 changed (USE_ANY_SERVERS);
90 bool use_any_servers () const {
91 return _use_any_servers;
94 /** @param s New list of servers */
95 void set_servers (std::vector<std::string> s) {
100 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
101 std::vector<std::string> servers () const {
105 bool only_servers_encode () const {
106 return _only_servers_encode;
109 Protocol tms_protocol () const {
110 return _tms_protocol;
113 /** @return The IP address of a TMS that we can copy DCPs to */
114 std::string tms_ip () const {
118 /** @return The path on a TMS that we should changed DCPs to */
119 std::string tms_path () const {
123 /** @return User name to log into the TMS with */
124 std::string tms_user () const {
128 /** @return Password to log into the TMS with */
129 std::string tms_password () const {
130 return _tms_password;
133 /** @return The cinema sound processor that we are using */
134 CinemaSoundProcessor const * cinema_sound_processor () const {
135 return _cinema_sound_processor;
138 std::list<boost::shared_ptr<Cinema> > cinemas () const {
142 std::list<int> allowed_dcp_frame_rates () const {
143 return _allowed_dcp_frame_rates;
146 bool allow_any_dcp_frame_rate () const {
147 return _allow_any_dcp_frame_rate;
150 ISDCFMetadata default_isdcf_metadata () const {
151 return _default_isdcf_metadata;
154 boost::optional<std::string> language () const {
158 int default_still_length () const {
159 return _default_still_length;
162 Ratio const * default_container () const {
163 return _default_container;
166 DCPContentType const * default_dcp_content_type () const {
167 return _default_dcp_content_type;
170 int default_dcp_audio_channels () const {
171 return _default_dcp_audio_channels;
174 std::string dcp_issuer () const {
178 std::string dcp_creator () const {
182 int default_j2k_bandwidth () const {
183 return _default_j2k_bandwidth;
186 int default_audio_delay () const {
187 return _default_audio_delay;
190 bool default_interop () const {
191 return _default_interop;
194 void set_default_kdm_directory (boost::filesystem::path d) {
195 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
198 _default_kdm_directory = d;
202 std::string mail_server () const {
206 int mail_port () const {
210 std::string mail_user () const {
214 std::string mail_password () const {
215 return _mail_password;
218 std::string kdm_subject () const {
222 std::string kdm_from () const {
226 std::vector<std::string> kdm_cc () const {
230 std::string kdm_bcc () const {
234 std::string kdm_email () const {
238 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
239 return _signer_chain;
242 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
243 return _decryption_chain;
246 bool check_for_updates () const {
247 return _check_for_updates;
250 bool check_for_test_updates () const {
251 return _check_for_test_updates;
254 int maximum_j2k_bandwidth () const {
255 return _maximum_j2k_bandwidth;
258 int log_types () const {
262 bool analyse_ebur128 () const {
263 return _analyse_ebur128;
266 bool automatic_audio_analysis () const {
267 return _automatic_audio_analysis;
270 #ifdef DCPOMATIC_WINDOWS
271 bool win32_console () const {
272 return _win32_console;
276 std::vector<boost::filesystem::path> history () const {
280 std::vector<dcp::EncryptedKDM> dkdms () const {
284 boost::filesystem::path cinemas_file () const {
285 return _cinemas_file;
288 bool show_hints_before_make_dcp () const {
289 return _show_hints_before_make_dcp;
292 bool confirm_kdm_email () const {
293 return _confirm_kdm_email;
296 dcp::NameFormat kdm_container_name_format () const {
297 return _kdm_container_name_format;
300 dcp::NameFormat kdm_filename_format () const {
301 return _kdm_filename_format;
304 dcp::NameFormat dcp_metadata_filename_format () const {
305 return _dcp_metadata_filename_format;
308 dcp::NameFormat dcp_asset_filename_format () const {
309 return _dcp_asset_filename_format;
312 bool jump_to_selected () const {
313 return _jump_to_selected;
316 bool preview_sound () const {
317 return _preview_sound;
320 boost::optional<std::string> preview_sound_output () const {
321 return _preview_sound_output;
324 void set_master_encoding_threads (int n) {
325 maybe_set (_master_encoding_threads, n);
328 void set_server_encoding_threads (int n) {
329 maybe_set (_server_encoding_threads, n);
332 void set_default_directory (boost::filesystem::path d) {
333 if (_default_directory && *_default_directory == d) {
336 _default_directory = d;
340 /** @param p New server port */
341 void set_server_port_base (int p) {
342 maybe_set (_server_port_base, p);
345 void set_only_servers_encode (bool o) {
346 maybe_set (_only_servers_encode, o);
349 void set_tms_protocol (Protocol p) {
350 maybe_set (_tms_protocol, p);
353 /** @param i IP address of a TMS that we can copy DCPs to */
354 void set_tms_ip (std::string i) {
355 maybe_set (_tms_ip, i);
358 /** @param p Path on a TMS that we should changed DCPs to */
359 void set_tms_path (std::string p) {
360 maybe_set (_tms_path, p);
363 /** @param u User name to log into the TMS with */
364 void set_tms_user (std::string u) {
365 maybe_set (_tms_user, u);
368 /** @param p Password to log into the TMS with */
369 void set_tms_password (std::string p) {
370 maybe_set (_tms_password, p);
373 void add_cinema (boost::shared_ptr<Cinema> c) {
374 _cinemas.push_back (c);
378 void remove_cinema (boost::shared_ptr<Cinema> c) {
383 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
384 maybe_set (_allowed_dcp_frame_rates, r);
387 void set_allow_any_dcp_frame_rate (bool a) {
388 maybe_set (_allow_any_dcp_frame_rate, a);
391 void set_default_isdcf_metadata (ISDCFMetadata d) {
392 maybe_set (_default_isdcf_metadata, d);
395 void set_language (std::string l) {
396 if (_language && _language.get() == l) {
403 void unset_language () {
408 _language = boost::none;
412 void set_default_still_length (int s) {
413 maybe_set (_default_still_length, s);
416 void set_default_container (Ratio const * c) {
417 maybe_set (_default_container, c);
420 void set_default_dcp_content_type (DCPContentType const * t) {
421 maybe_set (_default_dcp_content_type, t);
424 void set_default_dcp_audio_channels (int c) {
425 maybe_set (_default_dcp_audio_channels, c);
428 void set_dcp_issuer (std::string i) {
429 maybe_set (_dcp_issuer, i);
432 void set_dcp_creator (std::string c) {
433 maybe_set (_dcp_creator, c);
436 void set_default_j2k_bandwidth (int b) {
437 maybe_set (_default_j2k_bandwidth, b);
440 void set_default_audio_delay (int d) {
441 maybe_set (_default_audio_delay, d);
444 void set_default_interop (bool i) {
445 maybe_set (_default_interop, i);
448 void set_mail_server (std::string s) {
449 maybe_set (_mail_server, s);
452 void set_mail_port (int p) {
453 maybe_set (_mail_port, p);
456 void set_mail_user (std::string u) {
457 maybe_set (_mail_user, u);
460 void set_mail_password (std::string p) {
461 maybe_set (_mail_password, p);
464 void set_kdm_subject (std::string s) {
465 maybe_set (_kdm_subject, s);
468 void set_kdm_from (std::string f) {
469 maybe_set (_kdm_from, f);
472 void set_kdm_cc (std::vector<std::string> f) {
473 maybe_set (_kdm_cc, f);
476 void set_kdm_bcc (std::string f) {
477 maybe_set (_kdm_bcc, f);
480 void set_kdm_email (std::string e) {
481 maybe_set (_kdm_email, e);
484 void reset_kdm_email ();
486 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
487 maybe_set (_signer_chain, s);
490 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
491 maybe_set (_decryption_chain, c);
494 void set_check_for_updates (bool c) {
495 maybe_set (_check_for_updates, c);
497 set_check_for_test_updates (false);
501 void set_check_for_test_updates (bool c) {
502 maybe_set (_check_for_test_updates, c);
505 void set_maximum_j2k_bandwidth (int b) {
506 maybe_set (_maximum_j2k_bandwidth, b);
509 void set_log_types (int t) {
510 maybe_set (_log_types, t);
513 void set_analyse_ebur128 (bool a) {
514 maybe_set (_analyse_ebur128, a);
517 void set_automatic_audio_analysis (bool a) {
518 maybe_set (_automatic_audio_analysis, a);
521 #ifdef DCPOMATIC_WINDOWS
522 void set_win32_console (bool c) {
523 maybe_set (_win32_console, c);
527 void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms) {
532 void set_cinemas_file (boost::filesystem::path file);
534 void set_show_hints_before_make_dcp (bool s) {
535 maybe_set (_show_hints_before_make_dcp, s);
538 void set_confirm_kdm_email (bool s) {
539 maybe_set (_confirm_kdm_email, s);
542 void set_preview_sound (bool s) {
543 maybe_set (_preview_sound, s, PREVIEW_SOUND);
546 void set_preview_sound_output (std::string o)
548 maybe_set (_preview_sound_output, o, PREVIEW_SOUND_OUTPUT);
551 void unset_preview_sound_output ()
553 if (!_preview_sound_output) {
557 _preview_sound_output = boost::none;
561 void set_kdm_container_name_format (dcp::NameFormat n) {
562 maybe_set (_kdm_container_name_format, n);
565 void set_kdm_filename_format (dcp::NameFormat n) {
566 maybe_set (_kdm_filename_format, n);
569 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
570 maybe_set (_dcp_metadata_filename_format, n);
573 void set_dcp_asset_filename_format (dcp::NameFormat n) {
574 maybe_set (_dcp_asset_filename_format, n);
577 void clear_history () {
582 void add_to_history (boost::filesystem::path p);
584 void set_jump_to_selected (bool j) {
585 maybe_set (_jump_to_selected, j);
588 void changed (Property p = OTHER);
589 boost::signals2::signal<void (Property)> Changed;
590 /** Emitted if read() failed on an existing Config file. There is nothing
591 a listener can do about it: this is just for information.
593 static boost::signals2::signal<void ()> FailedToLoad;
596 void write_config () const;
597 void write_cinemas () const;
599 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
600 bool existing_template (std::string name) const;
601 std::list<std::string> templates () const;
602 boost::filesystem::path template_path (std::string name) const;
603 void rename_template (std::string old_name, std::string new_name) const;
604 void delete_template (std::string name) const;
606 static Config* instance ();
608 static void restore_defaults ();
609 static bool have_existing (std::string);
613 static boost::filesystem::path path (std::string file, bool create_directories = true);
615 void set_defaults ();
616 void set_kdm_email_to_default ();
617 void read_cinemas (cxml::Document const & f);
618 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
619 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
622 void maybe_set (T& member, T new_value, Property prop = OTHER) {
623 if (member == new_value) {
631 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
632 if (member && member.get() == new_value) {
639 /** number of threads which a master DoM should use for J2K encoding on the local machine */
640 int _master_encoding_threads;
641 /** number of threads which a server should use for J2K encoding on the local machine */
642 int _server_encoding_threads;
643 /** default directory to put new films in */
644 boost::optional<boost::filesystem::path> _default_directory;
645 /** base port number to use for J2K encoding servers;
646 * this port and the two above it will be used.
648 int _server_port_base;
649 /** true to broadcast on the `any' address to look for servers */
650 bool _use_any_servers;
651 /** J2K encoding servers that should definitely be used */
652 std::vector<std::string> _servers;
653 bool _only_servers_encode;
654 Protocol _tms_protocol;
655 /** The IP address of a TMS that we can copy DCPs to */
657 /** The path on a TMS that we should write DCPs to */
658 std::string _tms_path;
659 /** User name to log into the TMS with */
660 std::string _tms_user;
661 /** Password to log into the TMS with */
662 std::string _tms_password;
663 /** Our cinema sound processor */
664 CinemaSoundProcessor const * _cinema_sound_processor;
665 std::list<int> _allowed_dcp_frame_rates;
666 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
667 bool _allow_any_dcp_frame_rate;
668 /** Default ISDCF metadata for newly-created Films */
669 ISDCFMetadata _default_isdcf_metadata;
670 boost::optional<std::string> _language;
671 /** Default length of still image content (seconds) */
672 int _default_still_length;
673 Ratio const * _default_container;
674 DCPContentType const * _default_dcp_content_type;
675 int _default_dcp_audio_channels;
676 std::string _dcp_issuer;
677 std::string _dcp_creator;
678 int _default_j2k_bandwidth;
679 int _default_audio_delay;
680 bool _default_interop;
681 /** Default directory to offer to write KDMs to; if it's not set,
682 the home directory will be offered.
684 boost::optional<boost::filesystem::path> _default_kdm_directory;
685 std::list<boost::shared_ptr<Cinema> > _cinemas;
686 std::string _mail_server;
688 std::string _mail_user;
689 std::string _mail_password;
690 std::string _kdm_subject;
691 std::string _kdm_from;
692 std::vector<std::string> _kdm_cc;
693 std::string _kdm_bcc;
694 std::string _kdm_email;
695 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
696 /** Chain used to decrypt KDMs; the leaf of this chain is the target
697 * certificate for making KDMs given to DCP-o-matic.
699 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
700 /** true to check for updates on startup */
701 bool _check_for_updates;
702 bool _check_for_test_updates;
703 /** maximum allowed J2K bandwidth in bits per second */
704 int _maximum_j2k_bandwidth;
706 bool _analyse_ebur128;
707 bool _automatic_audio_analysis;
708 #ifdef DCPOMATIC_WINDOWS
711 std::vector<boost::filesystem::path> _history;
712 std::vector<dcp::EncryptedKDM> _dkdms;
713 boost::filesystem::path _cinemas_file;
714 bool _show_hints_before_make_dcp;
715 bool _confirm_kdm_email;
716 dcp::NameFormat _kdm_filename_format;
717 dcp::NameFormat _kdm_container_name_format;
718 dcp::NameFormat _dcp_metadata_filename_format;
719 dcp::NameFormat _dcp_asset_filename_format;
720 bool _jump_to_selected;
722 /** name of a specific sound output stream to use for preview, or empty to use the default */
723 boost::optional<std::string> _preview_sound_output;
725 /** Singleton instance, or 0 */
726 static Config* _instance;