2 Copyright (C) 2012-2018 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;
46 * @brief A singleton class holding configuration.
48 class Config : public boost::noncopyable
51 /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
52 int master_encoding_threads () const {
53 return _master_encoding_threads;
56 /** @return number of threads which a server should use for J2K encoding on the local machine */
57 int server_encoding_threads () const {
58 return _server_encoding_threads;
61 boost::optional<boost::filesystem::path> default_directory () const {
62 return _default_directory;
65 boost::optional<boost::filesystem::path> default_kdm_directory () const {
66 return _default_kdm_directory;
69 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
70 boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
82 /** @return base port number to use for J2K encoding servers */
83 int server_port_base () const {
84 return _server_port_base;
87 void set_use_any_servers (bool u) {
89 changed (USE_ANY_SERVERS);
92 bool use_any_servers () const {
93 return _use_any_servers;
96 /** @param s New list of servers */
97 void set_servers (std::vector<std::string> s) {
102 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
103 std::vector<std::string> servers () const {
107 bool only_servers_encode () const {
108 return _only_servers_encode;
111 Protocol tms_protocol () const {
112 return _tms_protocol;
115 /** @return The IP address of a TMS that we can copy DCPs to */
116 std::string tms_ip () const {
120 /** @return The path on a TMS that we should changed DCPs to */
121 std::string tms_path () const {
125 /** @return User name to log into the TMS with */
126 std::string tms_user () const {
130 /** @return Password to log into the TMS with */
131 std::string tms_password () const {
132 return _tms_password;
135 /** @return The cinema sound processor that we are using */
136 CinemaSoundProcessor const * cinema_sound_processor () const {
137 return _cinema_sound_processor;
140 std::list<boost::shared_ptr<Cinema> > cinemas () const {
144 std::list<int> allowed_dcp_frame_rates () const {
145 return _allowed_dcp_frame_rates;
148 bool allow_any_dcp_frame_rate () const {
149 return _allow_any_dcp_frame_rate;
152 bool allow_any_container () const {
153 return _allow_any_container;
156 ISDCFMetadata default_isdcf_metadata () const {
157 return _default_isdcf_metadata;
160 boost::optional<std::string> language () const {
164 int default_still_length () const {
165 return _default_still_length;
168 Ratio const * default_container () const {
169 return _default_container;
172 Ratio const * default_scale_to () const {
173 return _default_scale_to;
176 DCPContentType const * default_dcp_content_type () const {
177 return _default_dcp_content_type;
180 int default_dcp_audio_channels () const {
181 return _default_dcp_audio_channels;
184 std::string dcp_issuer () const {
188 std::string dcp_creator () const {
192 int default_j2k_bandwidth () const {
193 return _default_j2k_bandwidth;
196 int default_audio_delay () const {
197 return _default_audio_delay;
200 bool default_interop () const {
201 return _default_interop;
204 bool default_upload_after_make_dcp () {
205 return _default_upload_after_make_dcp;
208 void set_default_kdm_directory (boost::filesystem::path d) {
209 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
212 _default_kdm_directory = d;
216 std::string mail_server () const {
220 int mail_port () const {
224 std::string mail_user () const {
228 std::string mail_password () const {
229 return _mail_password;
232 std::string kdm_subject () const {
236 std::string kdm_from () const {
240 std::vector<std::string> kdm_cc () const {
244 std::string kdm_bcc () const {
248 std::string kdm_email () const {
252 std::string notification_subject () const {
253 return _notification_subject;
256 std::string notification_from () const {
257 return _notification_from;
260 std::string notification_to () const {
261 return _notification_to;
264 std::vector<std::string> notification_cc () const {
265 return _notification_cc;
268 std::string notification_bcc () const {
269 return _notification_bcc;
272 std::string notification_email () const {
273 return _notification_email;
276 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
277 return _signer_chain;
280 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
281 return _decryption_chain;
284 bool check_for_updates () const {
285 return _check_for_updates;
288 bool check_for_test_updates () const {
289 return _check_for_test_updates;
292 int maximum_j2k_bandwidth () const {
293 return _maximum_j2k_bandwidth;
296 int log_types () const {
300 bool analyse_ebur128 () const {
301 return _analyse_ebur128;
304 bool automatic_audio_analysis () const {
305 return _automatic_audio_analysis;
308 #ifdef DCPOMATIC_WINDOWS
309 bool win32_console () const {
310 return _win32_console;
314 std::vector<boost::filesystem::path> history () const {
318 std::vector<boost::filesystem::path> player_history () const {
319 return _player_history;
322 boost::shared_ptr<DKDMGroup> dkdms () const {
326 boost::filesystem::path cinemas_file () const {
327 return _cinemas_file;
330 bool show_hints_before_make_dcp () const {
331 return _show_hints_before_make_dcp;
334 bool confirm_kdm_email () const {
335 return _confirm_kdm_email;
338 dcp::NameFormat kdm_container_name_format () const {
339 return _kdm_container_name_format;
342 dcp::NameFormat kdm_filename_format () const {
343 return _kdm_filename_format;
346 dcp::NameFormat dcp_metadata_filename_format () const {
347 return _dcp_metadata_filename_format;
350 dcp::NameFormat dcp_asset_filename_format () const {
351 return _dcp_asset_filename_format;
354 bool jump_to_selected () const {
355 return _jump_to_selected;
360 NAG_ENCRYPTED_METADATA,
361 NAG_REMAKE_DECRYPTION_CHAIN,
362 NAG_BAD_SIGNER_CHAIN,
363 /* Not really a nag but it's the same idea */
368 bool nagged (Nag nag) const {
372 bool sound () const {
376 std::string cover_sheet () const {
380 boost::optional<std::string> sound_output () const {
381 return _sound_output;
384 boost::optional<boost::filesystem::path> last_player_load_directory () const {
385 return _last_player_load_directory;
394 boost::optional<KDMWriteType> last_kdm_write_type () const {
395 return _last_kdm_write_type;
403 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
404 return _last_dkdm_write_type;
407 int frames_in_memory_multiplier () const {
408 return _frames_in_memory_multiplier;
411 boost::optional<int> decode_reduction () const {
412 return _decode_reduction;
415 bool default_notify () const {
416 return _default_notify;
425 bool notification (Notification n) const {
426 return _notification[n];
429 boost::optional<std::string> barco_username () const {
430 return _barco_username;
433 boost::optional<std::string> barco_password () const {
434 return _barco_password;
437 boost::optional<std::string> christie_username () const {
438 return _christie_username;
441 boost::optional<std::string> christie_password () const {
442 return _christie_password;
445 boost::optional<std::string> gdc_username () const {
446 return _gdc_username;
449 boost::optional<std::string> gdc_password () const {
450 return _gdc_password;
458 Interface interface_complexity () const {
459 return _interface_complexity;
464 void set_master_encoding_threads (int n) {
465 maybe_set (_master_encoding_threads, n);
468 void set_server_encoding_threads (int n) {
469 maybe_set (_server_encoding_threads, n);
472 void set_default_directory (boost::filesystem::path d) {
473 if (_default_directory && *_default_directory == d) {
476 _default_directory = d;
480 /** @param p New server port */
481 void set_server_port_base (int p) {
482 maybe_set (_server_port_base, p);
485 void set_only_servers_encode (bool o) {
486 maybe_set (_only_servers_encode, o);
489 void set_tms_protocol (Protocol p) {
490 maybe_set (_tms_protocol, p);
493 /** @param i IP address of a TMS that we can copy DCPs to */
494 void set_tms_ip (std::string i) {
495 maybe_set (_tms_ip, i);
498 /** @param p Path on a TMS that we should changed DCPs to */
499 void set_tms_path (std::string p) {
500 maybe_set (_tms_path, p);
503 /** @param u User name to log into the TMS with */
504 void set_tms_user (std::string u) {
505 maybe_set (_tms_user, u);
508 /** @param p Password to log into the TMS with */
509 void set_tms_password (std::string p) {
510 maybe_set (_tms_password, p);
513 void add_cinema (boost::shared_ptr<Cinema> c) {
514 _cinemas.push_back (c);
518 void remove_cinema (boost::shared_ptr<Cinema> c) {
523 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
524 maybe_set (_allowed_dcp_frame_rates, r);
527 void set_allow_any_dcp_frame_rate (bool a) {
528 maybe_set (_allow_any_dcp_frame_rate, a);
531 void set_allow_any_container (bool a) {
532 maybe_set (_allow_any_container, a);
535 void set_default_isdcf_metadata (ISDCFMetadata d) {
536 maybe_set (_default_isdcf_metadata, d);
539 void set_language (std::string l) {
540 if (_language && _language.get() == l) {
547 void unset_language () {
552 _language = boost::none;
556 void set_default_still_length (int s) {
557 maybe_set (_default_still_length, s);
560 void set_default_container (Ratio const * c) {
561 maybe_set (_default_container, c);
564 void set_default_scale_to (Ratio const * c) {
565 maybe_set (_default_scale_to, c);
568 void set_default_dcp_content_type (DCPContentType const * t) {
569 maybe_set (_default_dcp_content_type, t);
572 void set_default_dcp_audio_channels (int c) {
573 maybe_set (_default_dcp_audio_channels, c);
576 void set_dcp_issuer (std::string i) {
577 maybe_set (_dcp_issuer, i);
580 void set_dcp_creator (std::string c) {
581 maybe_set (_dcp_creator, c);
584 void set_default_j2k_bandwidth (int b) {
585 maybe_set (_default_j2k_bandwidth, b);
588 void set_default_audio_delay (int d) {
589 maybe_set (_default_audio_delay, d);
592 void set_default_interop (bool i) {
593 maybe_set (_default_interop, i);
596 void set_default_upload_after_make_dcp (bool u) {
597 maybe_set (_default_upload_after_make_dcp, u);
600 void set_mail_server (std::string s) {
601 maybe_set (_mail_server, s);
604 void set_mail_port (int p) {
605 maybe_set (_mail_port, p);
608 void set_mail_user (std::string u) {
609 maybe_set (_mail_user, u);
612 void set_mail_password (std::string p) {
613 maybe_set (_mail_password, p);
616 void set_kdm_subject (std::string s) {
617 maybe_set (_kdm_subject, s);
620 void set_kdm_from (std::string f) {
621 maybe_set (_kdm_from, f);
624 void set_kdm_cc (std::vector<std::string> f) {
625 maybe_set (_kdm_cc, f);
628 void set_kdm_bcc (std::string f) {
629 maybe_set (_kdm_bcc, f);
632 void set_kdm_email (std::string e) {
633 maybe_set (_kdm_email, e);
636 void reset_kdm_email ();
638 void set_notification_subject (std::string s) {
639 maybe_set (_notification_subject, s);
642 void set_notification_from (std::string f) {
643 maybe_set (_notification_from, f);
646 void set_notification_to (std::string t) {
647 maybe_set (_notification_to, t);
650 void set_notification_cc (std::vector<std::string> f) {
651 maybe_set (_notification_cc, f);
654 void set_notification_bcc (std::string f) {
655 maybe_set (_notification_bcc, f);
658 void set_notification_email (std::string e) {
659 maybe_set (_notification_email, e);
662 void reset_notification_email ();
664 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
665 maybe_set (_signer_chain, s);
668 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
669 maybe_set (_decryption_chain, c);
672 void set_check_for_updates (bool c) {
673 maybe_set (_check_for_updates, c);
675 set_check_for_test_updates (false);
679 void set_check_for_test_updates (bool c) {
680 maybe_set (_check_for_test_updates, c);
683 void set_maximum_j2k_bandwidth (int b) {
684 maybe_set (_maximum_j2k_bandwidth, b);
687 void set_log_types (int t) {
688 maybe_set (_log_types, t);
691 void set_analyse_ebur128 (bool a) {
692 maybe_set (_analyse_ebur128, a);
695 void set_automatic_audio_analysis (bool a) {
696 maybe_set (_automatic_audio_analysis, a);
699 #ifdef DCPOMATIC_WINDOWS
700 void set_win32_console (bool c) {
701 maybe_set (_win32_console, c);
705 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
710 void set_cinemas_file (boost::filesystem::path file);
712 void set_show_hints_before_make_dcp (bool s) {
713 maybe_set (_show_hints_before_make_dcp, s);
716 void set_confirm_kdm_email (bool s) {
717 maybe_set (_confirm_kdm_email, s);
720 void set_sound (bool s) {
721 maybe_set (_sound, s, SOUND);
724 void set_sound_output (std::string o) {
725 maybe_set (_sound_output, o, SOUND_OUTPUT);
728 void set_last_player_load_directory (boost::filesystem::path d) {
729 maybe_set (_last_player_load_directory, d);
732 void set_last_kdm_write_type (KDMWriteType t) {
733 maybe_set (_last_kdm_write_type, t);
736 void set_last_dkdm_write_type (DKDMWriteType t) {
737 maybe_set (_last_dkdm_write_type, t);
740 void unset_sound_output () {
741 if (!_sound_output) {
745 _sound_output = boost::none;
749 void set_kdm_container_name_format (dcp::NameFormat n) {
750 maybe_set (_kdm_container_name_format, n);
753 void set_kdm_filename_format (dcp::NameFormat n) {
754 maybe_set (_kdm_filename_format, n);
757 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
758 maybe_set (_dcp_metadata_filename_format, n);
761 void set_dcp_asset_filename_format (dcp::NameFormat n) {
762 maybe_set (_dcp_asset_filename_format, n);
765 void set_frames_in_memory_multiplier (int m) {
766 maybe_set (_frames_in_memory_multiplier, m);
769 void set_decode_reduction (boost::optional<int> r) {
770 maybe_set (_decode_reduction, r);
773 void set_default_notify (bool n) {
774 maybe_set (_default_notify, n);
777 void clear_history () {
782 void clear_player_history () {
783 _player_history.clear ();
787 void add_to_history (boost::filesystem::path p);
788 void add_to_player_history (boost::filesystem::path p);
790 void set_jump_to_selected (bool j) {
791 maybe_set (_jump_to_selected, j);
794 void set_nagged (Nag nag, bool nagged) {
795 maybe_set (_nagged[nag], nagged);
798 void set_cover_sheet (std::string s) {
799 maybe_set (_cover_sheet, s);
802 void reset_cover_sheet ();
804 void set_notification (Notification n, bool v) {
805 maybe_set (_notification[n], v);
808 void set_barco_username (std::string u) {
809 maybe_set (_barco_username, u);
812 void unset_barco_username () {
813 maybe_set (_barco_username, boost::optional<std::string>());
816 void set_barco_password (std::string p) {
817 maybe_set (_barco_password, p);
820 void unset_barco_password () {
821 maybe_set (_barco_password, boost::optional<std::string>());
824 void set_christie_username (std::string u) {
825 maybe_set (_christie_username, u);
828 void unset_christie_username () {
829 maybe_set (_christie_username, boost::optional<std::string>());
832 void set_christie_password (std::string p) {
833 maybe_set (_christie_password, p);
836 void unset_christie_password () {
837 maybe_set (_christie_password, boost::optional<std::string>());
840 void set_gdc_username (std::string u) {
841 maybe_set (_gdc_username, u);
844 void unset_gdc_username () {
845 maybe_set (_gdc_username, boost::optional<std::string>());
848 void set_gdc_password (std::string p) {
849 maybe_set (_gdc_password, p);
852 void unset_gdc_password () {
853 maybe_set (_gdc_password, boost::optional<std::string>());
856 void set_interface_complexity (Interface i) {
857 maybe_set (_interface_complexity, i, INTERFACE_COMPLEXITY);
860 void changed (Property p = OTHER);
861 boost::signals2::signal<void (Property)> Changed;
862 /** Emitted if read() failed on an existing Config file. There is nothing
863 a listener can do about it: this is just for information.
865 static boost::signals2::signal<void ()> FailedToLoad;
866 /** Emitted if read() issued a warning which the user might want to know about */
867 static boost::signals2::signal<void (std::string)> Warning;
868 /** Emitted if there is a bad certificate in the signer chain. Handler can call
869 * true to ask Config to re-create the chain.
871 static boost::signals2::signal<bool (void)> BadSignerChain;
874 void write_config () const;
875 void write_cinemas () const;
876 void link (boost::filesystem::path new_file) const;
877 void copy_and_link (boost::filesystem::path new_file) const;
879 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
880 bool existing_template (std::string name) const;
881 std::list<std::string> templates () const;
882 boost::filesystem::path template_path (std::string name) const;
883 void rename_template (std::string old_name, std::string new_name) const;
884 void delete_template (std::string name) const;
886 static Config* instance ();
888 static void restore_defaults ();
889 static bool have_existing (std::string);
890 static boost::filesystem::path config_file ();
892 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
893 static boost::optional<boost::filesystem::path> override_path;
897 static boost::filesystem::path path (std::string file, bool create_directories = true);
899 void set_defaults ();
900 void set_kdm_email_to_default ();
901 void set_notification_email_to_default ();
902 void set_cover_sheet_to_default ();
903 void read_cinemas (cxml::Document const & f);
904 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
905 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
906 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
910 void maybe_set (T& member, T new_value, Property prop = OTHER) {
911 if (member == new_value) {
919 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
920 if (member && member.get() == new_value) {
927 /** number of threads which a master DoM should use for J2K encoding on the local machine */
928 int _master_encoding_threads;
929 /** number of threads which a server should use for J2K encoding on the local machine */
930 int _server_encoding_threads;
931 /** default directory to put new films in */
932 boost::optional<boost::filesystem::path> _default_directory;
933 /** base port number to use for J2K encoding servers;
934 * this port and the two above it will be used.
936 int _server_port_base;
937 /** true to broadcast on the `any' address to look for servers */
938 bool _use_any_servers;
939 /** J2K encoding servers that should definitely be used */
940 std::vector<std::string> _servers;
941 bool _only_servers_encode;
942 Protocol _tms_protocol;
943 /** The IP address of a TMS that we can copy DCPs to */
945 /** The path on a TMS that we should write DCPs to */
946 std::string _tms_path;
947 /** User name to log into the TMS with */
948 std::string _tms_user;
949 /** Password to log into the TMS with */
950 std::string _tms_password;
951 /** Our cinema sound processor */
952 CinemaSoundProcessor const * _cinema_sound_processor;
953 std::list<int> _allowed_dcp_frame_rates;
954 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
955 bool _allow_any_dcp_frame_rate;
956 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
957 DCPs at 25fps but will play 16:9, so this is very useful for some users.
958 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
960 bool _allow_any_container;
961 /** Default ISDCF metadata for newly-created Films */
962 ISDCFMetadata _default_isdcf_metadata;
963 boost::optional<std::string> _language;
964 /** Default length of still image content (seconds) */
965 int _default_still_length;
966 Ratio const * _default_container;
967 Ratio const * _default_scale_to;
968 DCPContentType const * _default_dcp_content_type;
969 int _default_dcp_audio_channels;
970 std::string _dcp_issuer;
971 std::string _dcp_creator;
972 int _default_j2k_bandwidth;
973 int _default_audio_delay;
974 bool _default_interop;
975 /** Default directory to offer to write KDMs to; if it's not set,
976 the home directory will be offered.
978 boost::optional<boost::filesystem::path> _default_kdm_directory;
979 bool _default_upload_after_make_dcp;
980 std::list<boost::shared_ptr<Cinema> > _cinemas;
981 std::string _mail_server;
983 std::string _mail_user;
984 std::string _mail_password;
985 std::string _kdm_subject;
986 std::string _kdm_from;
987 std::vector<std::string> _kdm_cc;
988 std::string _kdm_bcc;
989 std::string _kdm_email;
990 std::string _notification_subject;
991 std::string _notification_from;
992 std::string _notification_to;
993 std::vector<std::string> _notification_cc;
994 std::string _notification_bcc;
995 std::string _notification_email;
996 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
997 /** Chain used to decrypt KDMs; the leaf of this chain is the target
998 * certificate for making KDMs given to DCP-o-matic.
1000 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1001 /** true to check for updates on startup */
1002 bool _check_for_updates;
1003 bool _check_for_test_updates;
1004 /** maximum allowed J2K bandwidth in bits per second */
1005 int _maximum_j2k_bandwidth;
1007 bool _analyse_ebur128;
1008 bool _automatic_audio_analysis;
1009 #ifdef DCPOMATIC_WINDOWS
1010 bool _win32_console;
1012 std::vector<boost::filesystem::path> _history;
1013 std::vector<boost::filesystem::path> _player_history;
1014 boost::shared_ptr<DKDMGroup> _dkdms;
1015 boost::filesystem::path _cinemas_file;
1016 bool _show_hints_before_make_dcp;
1017 bool _confirm_kdm_email;
1018 dcp::NameFormat _kdm_filename_format;
1019 dcp::NameFormat _kdm_container_name_format;
1020 dcp::NameFormat _dcp_metadata_filename_format;
1021 dcp::NameFormat _dcp_asset_filename_format;
1022 bool _jump_to_selected;
1023 bool _nagged[NAG_COUNT];
1025 /** name of a specific sound output stream to use, or empty to use the default */
1026 boost::optional<std::string> _sound_output;
1027 std::string _cover_sheet;
1028 boost::optional<boost::filesystem::path> _last_player_load_directory;
1029 boost::optional<KDMWriteType> _last_kdm_write_type;
1030 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1031 int _frames_in_memory_multiplier;
1032 boost::optional<int> _decode_reduction;
1033 bool _default_notify;
1034 bool _notification[NOTIFICATION_COUNT];
1035 boost::optional<std::string> _barco_username;
1036 boost::optional<std::string> _barco_password;
1037 boost::optional<std::string> _christie_username;
1038 boost::optional<std::string> _christie_password;
1039 boost::optional<std::string> _gdc_username;
1040 boost::optional<std::string> _gdc_password;
1041 Interface _interface_complexity;
1043 static int const _current_version;
1045 /** Singleton instance, or 0 */
1046 static Config* _instance;