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;
81 /** @return base port number to use for J2K encoding servers */
82 int server_port_base () const {
83 return _server_port_base;
86 void set_use_any_servers (bool u) {
88 changed (USE_ANY_SERVERS);
91 bool use_any_servers () const {
92 return _use_any_servers;
95 /** @param s New list of servers */
96 void set_servers (std::vector<std::string> s) {
101 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
102 std::vector<std::string> servers () const {
106 bool only_servers_encode () const {
107 return _only_servers_encode;
110 Protocol tms_protocol () const {
111 return _tms_protocol;
114 /** @return The IP address of a TMS that we can copy DCPs to */
115 std::string tms_ip () const {
119 /** @return The path on a TMS that we should changed DCPs to */
120 std::string tms_path () const {
124 /** @return User name to log into the TMS with */
125 std::string tms_user () const {
129 /** @return Password to log into the TMS with */
130 std::string tms_password () const {
131 return _tms_password;
134 /** @return The cinema sound processor that we are using */
135 CinemaSoundProcessor const * cinema_sound_processor () const {
136 return _cinema_sound_processor;
139 std::list<boost::shared_ptr<Cinema> > cinemas () const {
143 std::list<int> allowed_dcp_frame_rates () const {
144 return _allowed_dcp_frame_rates;
147 bool allow_any_dcp_frame_rate () const {
148 return _allow_any_dcp_frame_rate;
151 bool allow_any_container () const {
152 return _allow_any_container;
155 ISDCFMetadata default_isdcf_metadata () const {
156 return _default_isdcf_metadata;
159 boost::optional<std::string> language () const {
163 int default_still_length () const {
164 return _default_still_length;
167 Ratio const * default_container () const {
168 return _default_container;
171 Ratio const * default_scale_to () const {
172 return _default_scale_to;
175 DCPContentType const * default_dcp_content_type () const {
176 return _default_dcp_content_type;
179 int default_dcp_audio_channels () const {
180 return _default_dcp_audio_channels;
183 std::string dcp_issuer () const {
187 std::string dcp_creator () const {
191 int default_j2k_bandwidth () const {
192 return _default_j2k_bandwidth;
195 int default_audio_delay () const {
196 return _default_audio_delay;
199 bool default_interop () const {
200 return _default_interop;
203 bool default_upload_after_make_dcp () {
204 return _default_upload_after_make_dcp;
207 void set_default_kdm_directory (boost::filesystem::path d) {
208 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
211 _default_kdm_directory = d;
215 std::string mail_server () const {
219 int mail_port () const {
223 std::string mail_user () const {
227 std::string mail_password () const {
228 return _mail_password;
231 std::string kdm_subject () const {
235 std::string kdm_from () const {
239 std::vector<std::string> kdm_cc () const {
243 std::string kdm_bcc () const {
247 std::string kdm_email () const {
251 std::string notification_subject () const {
252 return _notification_subject;
255 std::string notification_from () const {
256 return _notification_from;
259 std::string notification_to () const {
260 return _notification_to;
263 std::vector<std::string> notification_cc () const {
264 return _notification_cc;
267 std::string notification_bcc () const {
268 return _notification_bcc;
271 std::string notification_email () const {
272 return _notification_email;
275 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
276 return _signer_chain;
279 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
280 return _decryption_chain;
283 bool check_for_updates () const {
284 return _check_for_updates;
287 bool check_for_test_updates () const {
288 return _check_for_test_updates;
291 int maximum_j2k_bandwidth () const {
292 return _maximum_j2k_bandwidth;
295 int log_types () const {
299 bool analyse_ebur128 () const {
300 return _analyse_ebur128;
303 bool automatic_audio_analysis () const {
304 return _automatic_audio_analysis;
307 #ifdef DCPOMATIC_WINDOWS
308 bool win32_console () const {
309 return _win32_console;
313 std::vector<boost::filesystem::path> history () const {
317 std::vector<boost::filesystem::path> player_history () const {
318 return _player_history;
321 boost::shared_ptr<DKDMGroup> dkdms () const {
325 boost::filesystem::path cinemas_file () const {
326 return _cinemas_file;
329 bool show_hints_before_make_dcp () const {
330 return _show_hints_before_make_dcp;
333 bool confirm_kdm_email () const {
334 return _confirm_kdm_email;
337 dcp::NameFormat kdm_container_name_format () const {
338 return _kdm_container_name_format;
341 dcp::NameFormat kdm_filename_format () const {
342 return _kdm_filename_format;
345 dcp::NameFormat dcp_metadata_filename_format () const {
346 return _dcp_metadata_filename_format;
349 dcp::NameFormat dcp_asset_filename_format () const {
350 return _dcp_asset_filename_format;
353 bool jump_to_selected () const {
354 return _jump_to_selected;
359 NAG_ENCRYPTED_METADATA,
360 NAG_REMAKE_DECRYPTION_CHAIN,
361 NAG_BAD_SIGNER_CHAIN,
365 bool nagged (Nag nag) const {
369 bool sound () const {
373 std::string cover_sheet () const {
377 boost::optional<std::string> sound_output () const {
378 return _sound_output;
381 boost::optional<boost::filesystem::path> last_player_load_directory () const {
382 return _last_player_load_directory;
391 boost::optional<KDMWriteType> last_kdm_write_type () const {
392 return _last_kdm_write_type;
400 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
401 return _last_dkdm_write_type;
404 int frames_in_memory_multiplier () const {
405 return _frames_in_memory_multiplier;
408 boost::optional<int> decode_reduction () const {
409 return _decode_reduction;
412 bool default_notify () const {
413 return _default_notify;
422 bool notification (Notification n) const {
423 return _notification[n];
426 boost::optional<std::string> barco_username () const {
427 return _barco_username;
430 boost::optional<std::string> barco_password () const {
431 return _barco_password;
434 boost::optional<std::string> christie_username () const {
435 return _christie_username;
438 boost::optional<std::string> christie_password () const {
439 return _christie_password;
442 boost::optional<std::string> gdc_username () const {
443 return _gdc_username;
446 boost::optional<std::string> gdc_password () const {
447 return _gdc_password;
452 void set_master_encoding_threads (int n) {
453 maybe_set (_master_encoding_threads, n);
456 void set_server_encoding_threads (int n) {
457 maybe_set (_server_encoding_threads, n);
460 void set_default_directory (boost::filesystem::path d) {
461 if (_default_directory && *_default_directory == d) {
464 _default_directory = d;
468 /** @param p New server port */
469 void set_server_port_base (int p) {
470 maybe_set (_server_port_base, p);
473 void set_only_servers_encode (bool o) {
474 maybe_set (_only_servers_encode, o);
477 void set_tms_protocol (Protocol p) {
478 maybe_set (_tms_protocol, p);
481 /** @param i IP address of a TMS that we can copy DCPs to */
482 void set_tms_ip (std::string i) {
483 maybe_set (_tms_ip, i);
486 /** @param p Path on a TMS that we should changed DCPs to */
487 void set_tms_path (std::string p) {
488 maybe_set (_tms_path, p);
491 /** @param u User name to log into the TMS with */
492 void set_tms_user (std::string u) {
493 maybe_set (_tms_user, u);
496 /** @param p Password to log into the TMS with */
497 void set_tms_password (std::string p) {
498 maybe_set (_tms_password, p);
501 void add_cinema (boost::shared_ptr<Cinema> c) {
502 _cinemas.push_back (c);
506 void remove_cinema (boost::shared_ptr<Cinema> c) {
511 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
512 maybe_set (_allowed_dcp_frame_rates, r);
515 void set_allow_any_dcp_frame_rate (bool a) {
516 maybe_set (_allow_any_dcp_frame_rate, a);
519 void set_allow_any_container (bool a) {
520 maybe_set (_allow_any_container, a);
523 void set_default_isdcf_metadata (ISDCFMetadata d) {
524 maybe_set (_default_isdcf_metadata, d);
527 void set_language (std::string l) {
528 if (_language && _language.get() == l) {
535 void unset_language () {
540 _language = boost::none;
544 void set_default_still_length (int s) {
545 maybe_set (_default_still_length, s);
548 void set_default_container (Ratio const * c) {
549 maybe_set (_default_container, c);
552 void set_default_scale_to (Ratio const * c) {
553 maybe_set (_default_scale_to, c);
556 void set_default_dcp_content_type (DCPContentType const * t) {
557 maybe_set (_default_dcp_content_type, t);
560 void set_default_dcp_audio_channels (int c) {
561 maybe_set (_default_dcp_audio_channels, c);
564 void set_dcp_issuer (std::string i) {
565 maybe_set (_dcp_issuer, i);
568 void set_dcp_creator (std::string c) {
569 maybe_set (_dcp_creator, c);
572 void set_default_j2k_bandwidth (int b) {
573 maybe_set (_default_j2k_bandwidth, b);
576 void set_default_audio_delay (int d) {
577 maybe_set (_default_audio_delay, d);
580 void set_default_interop (bool i) {
581 maybe_set (_default_interop, i);
584 void set_default_upload_after_make_dcp (bool u) {
585 maybe_set (_default_upload_after_make_dcp, u);
588 void set_mail_server (std::string s) {
589 maybe_set (_mail_server, s);
592 void set_mail_port (int p) {
593 maybe_set (_mail_port, p);
596 void set_mail_user (std::string u) {
597 maybe_set (_mail_user, u);
600 void set_mail_password (std::string p) {
601 maybe_set (_mail_password, p);
604 void set_kdm_subject (std::string s) {
605 maybe_set (_kdm_subject, s);
608 void set_kdm_from (std::string f) {
609 maybe_set (_kdm_from, f);
612 void set_kdm_cc (std::vector<std::string> f) {
613 maybe_set (_kdm_cc, f);
616 void set_kdm_bcc (std::string f) {
617 maybe_set (_kdm_bcc, f);
620 void set_kdm_email (std::string e) {
621 maybe_set (_kdm_email, e);
624 void reset_kdm_email ();
626 void set_notification_subject (std::string s) {
627 maybe_set (_notification_subject, s);
630 void set_notification_from (std::string f) {
631 maybe_set (_notification_from, f);
634 void set_notification_to (std::string t) {
635 maybe_set (_notification_to, t);
638 void set_notification_cc (std::vector<std::string> f) {
639 maybe_set (_notification_cc, f);
642 void set_notification_bcc (std::string f) {
643 maybe_set (_notification_bcc, f);
646 void set_notification_email (std::string e) {
647 maybe_set (_notification_email, e);
650 void reset_notification_email ();
652 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
653 maybe_set (_signer_chain, s);
656 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
657 maybe_set (_decryption_chain, c);
660 void set_check_for_updates (bool c) {
661 maybe_set (_check_for_updates, c);
663 set_check_for_test_updates (false);
667 void set_check_for_test_updates (bool c) {
668 maybe_set (_check_for_test_updates, c);
671 void set_maximum_j2k_bandwidth (int b) {
672 maybe_set (_maximum_j2k_bandwidth, b);
675 void set_log_types (int t) {
676 maybe_set (_log_types, t);
679 void set_analyse_ebur128 (bool a) {
680 maybe_set (_analyse_ebur128, a);
683 void set_automatic_audio_analysis (bool a) {
684 maybe_set (_automatic_audio_analysis, a);
687 #ifdef DCPOMATIC_WINDOWS
688 void set_win32_console (bool c) {
689 maybe_set (_win32_console, c);
693 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
698 void set_cinemas_file (boost::filesystem::path file);
700 void set_show_hints_before_make_dcp (bool s) {
701 maybe_set (_show_hints_before_make_dcp, s);
704 void set_confirm_kdm_email (bool s) {
705 maybe_set (_confirm_kdm_email, s);
708 void set_sound (bool s) {
709 maybe_set (_sound, s, SOUND);
712 void set_sound_output (std::string o) {
713 maybe_set (_sound_output, o, SOUND_OUTPUT);
716 void set_last_player_load_directory (boost::filesystem::path d) {
717 maybe_set (_last_player_load_directory, d);
720 void set_last_kdm_write_type (KDMWriteType t) {
721 maybe_set (_last_kdm_write_type, t);
724 void set_last_dkdm_write_type (DKDMWriteType t) {
725 maybe_set (_last_dkdm_write_type, t);
728 void unset_sound_output () {
729 if (!_sound_output) {
733 _sound_output = boost::none;
737 void set_kdm_container_name_format (dcp::NameFormat n) {
738 maybe_set (_kdm_container_name_format, n);
741 void set_kdm_filename_format (dcp::NameFormat n) {
742 maybe_set (_kdm_filename_format, n);
745 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
746 maybe_set (_dcp_metadata_filename_format, n);
749 void set_dcp_asset_filename_format (dcp::NameFormat n) {
750 maybe_set (_dcp_asset_filename_format, n);
753 void set_frames_in_memory_multiplier (int m) {
754 maybe_set (_frames_in_memory_multiplier, m);
757 void set_decode_reduction (boost::optional<int> r) {
758 maybe_set (_decode_reduction, r);
761 void set_default_notify (bool n) {
762 maybe_set (_default_notify, n);
765 void clear_history () {
770 void clear_player_history () {
771 _player_history.clear ();
775 void add_to_history (boost::filesystem::path p);
776 void add_to_player_history (boost::filesystem::path p);
778 void set_jump_to_selected (bool j) {
779 maybe_set (_jump_to_selected, j);
782 void set_nagged (Nag nag, bool nagged) {
783 maybe_set (_nagged[nag], nagged);
786 void set_cover_sheet (std::string s) {
787 maybe_set (_cover_sheet, s);
790 void reset_cover_sheet ();
792 void set_notification (Notification n, bool v) {
793 maybe_set (_notification[n], v);
796 void set_barco_username (std::string u) {
797 maybe_set (_barco_username, u);
800 void unset_barco_username () {
801 maybe_set (_barco_username, boost::optional<std::string>());
804 void set_barco_password (std::string p) {
805 maybe_set (_barco_password, p);
808 void unset_barco_password () {
809 maybe_set (_barco_password, boost::optional<std::string>());
812 void set_christie_username (std::string u) {
813 maybe_set (_christie_username, u);
816 void unset_christie_username () {
817 maybe_set (_christie_username, boost::optional<std::string>());
820 void set_christie_password (std::string p) {
821 maybe_set (_christie_password, p);
824 void unset_christie_password () {
825 maybe_set (_christie_password, boost::optional<std::string>());
828 void set_gdc_username (std::string u) {
829 maybe_set (_gdc_username, u);
832 void unset_gdc_username () {
833 maybe_set (_gdc_username, boost::optional<std::string>());
836 void set_gdc_password (std::string p) {
837 maybe_set (_gdc_password, p);
840 void unset_gdc_password () {
841 maybe_set (_gdc_password, boost::optional<std::string>());
844 void changed (Property p = OTHER);
845 boost::signals2::signal<void (Property)> Changed;
846 /** Emitted if read() failed on an existing Config file. There is nothing
847 a listener can do about it: this is just for information.
849 static boost::signals2::signal<void ()> FailedToLoad;
850 /** Emitted if read() issued a warning which the user might want to know about */
851 static boost::signals2::signal<void (std::string)> Warning;
852 /** Emitted if there is a bad certificate in the signer chain. Handler can call
853 * true to ask Config to re-create the chain.
855 static boost::signals2::signal<bool (void)> BadSignerChain;
858 void write_config () const;
859 void write_cinemas () const;
860 void link (boost::filesystem::path new_file) const;
861 void copy_and_link (boost::filesystem::path new_file) const;
863 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
864 bool existing_template (std::string name) const;
865 std::list<std::string> templates () const;
866 boost::filesystem::path template_path (std::string name) const;
867 void rename_template (std::string old_name, std::string new_name) const;
868 void delete_template (std::string name) const;
870 static Config* instance ();
872 static void restore_defaults ();
873 static bool have_existing (std::string);
874 static boost::filesystem::path config_file ();
876 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
877 static boost::optional<boost::filesystem::path> override_path;
881 static boost::filesystem::path path (std::string file, bool create_directories = true);
883 void set_defaults ();
884 void set_kdm_email_to_default ();
885 void set_notification_email_to_default ();
886 void set_cover_sheet_to_default ();
887 void read_cinemas (cxml::Document const & f);
888 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
889 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
890 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
894 void maybe_set (T& member, T new_value, Property prop = OTHER) {
895 if (member == new_value) {
903 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
904 if (member && member.get() == new_value) {
911 /** number of threads which a master DoM should use for J2K encoding on the local machine */
912 int _master_encoding_threads;
913 /** number of threads which a server should use for J2K encoding on the local machine */
914 int _server_encoding_threads;
915 /** default directory to put new films in */
916 boost::optional<boost::filesystem::path> _default_directory;
917 /** base port number to use for J2K encoding servers;
918 * this port and the two above it will be used.
920 int _server_port_base;
921 /** true to broadcast on the `any' address to look for servers */
922 bool _use_any_servers;
923 /** J2K encoding servers that should definitely be used */
924 std::vector<std::string> _servers;
925 bool _only_servers_encode;
926 Protocol _tms_protocol;
927 /** The IP address of a TMS that we can copy DCPs to */
929 /** The path on a TMS that we should write DCPs to */
930 std::string _tms_path;
931 /** User name to log into the TMS with */
932 std::string _tms_user;
933 /** Password to log into the TMS with */
934 std::string _tms_password;
935 /** Our cinema sound processor */
936 CinemaSoundProcessor const * _cinema_sound_processor;
937 std::list<int> _allowed_dcp_frame_rates;
938 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
939 bool _allow_any_dcp_frame_rate;
940 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
941 DCPs at 25fps but will play 16:9, so this is very useful for some users.
942 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
944 bool _allow_any_container;
945 /** Default ISDCF metadata for newly-created Films */
946 ISDCFMetadata _default_isdcf_metadata;
947 boost::optional<std::string> _language;
948 /** Default length of still image content (seconds) */
949 int _default_still_length;
950 Ratio const * _default_container;
951 Ratio const * _default_scale_to;
952 DCPContentType const * _default_dcp_content_type;
953 int _default_dcp_audio_channels;
954 std::string _dcp_issuer;
955 std::string _dcp_creator;
956 int _default_j2k_bandwidth;
957 int _default_audio_delay;
958 bool _default_interop;
959 /** Default directory to offer to write KDMs to; if it's not set,
960 the home directory will be offered.
962 boost::optional<boost::filesystem::path> _default_kdm_directory;
963 bool _default_upload_after_make_dcp;
964 std::list<boost::shared_ptr<Cinema> > _cinemas;
965 std::string _mail_server;
967 std::string _mail_user;
968 std::string _mail_password;
969 std::string _kdm_subject;
970 std::string _kdm_from;
971 std::vector<std::string> _kdm_cc;
972 std::string _kdm_bcc;
973 std::string _kdm_email;
974 std::string _notification_subject;
975 std::string _notification_from;
976 std::string _notification_to;
977 std::vector<std::string> _notification_cc;
978 std::string _notification_bcc;
979 std::string _notification_email;
980 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
981 /** Chain used to decrypt KDMs; the leaf of this chain is the target
982 * certificate for making KDMs given to DCP-o-matic.
984 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
985 /** true to check for updates on startup */
986 bool _check_for_updates;
987 bool _check_for_test_updates;
988 /** maximum allowed J2K bandwidth in bits per second */
989 int _maximum_j2k_bandwidth;
991 bool _analyse_ebur128;
992 bool _automatic_audio_analysis;
993 #ifdef DCPOMATIC_WINDOWS
996 std::vector<boost::filesystem::path> _history;
997 std::vector<boost::filesystem::path> _player_history;
998 boost::shared_ptr<DKDMGroup> _dkdms;
999 boost::filesystem::path _cinemas_file;
1000 bool _show_hints_before_make_dcp;
1001 bool _confirm_kdm_email;
1002 dcp::NameFormat _kdm_filename_format;
1003 dcp::NameFormat _kdm_container_name_format;
1004 dcp::NameFormat _dcp_metadata_filename_format;
1005 dcp::NameFormat _dcp_asset_filename_format;
1006 bool _jump_to_selected;
1007 bool _nagged[NAG_COUNT];
1009 /** name of a specific sound output stream to use, or empty to use the default */
1010 boost::optional<std::string> _sound_output;
1011 std::string _cover_sheet;
1012 boost::optional<boost::filesystem::path> _last_player_load_directory;
1013 boost::optional<KDMWriteType> _last_kdm_write_type;
1014 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1015 int _frames_in_memory_multiplier;
1016 boost::optional<int> _decode_reduction;
1017 bool _default_notify;
1018 bool _notification[NOTIFICATION_COUNT];
1019 boost::optional<std::string> _barco_username;
1020 boost::optional<std::string> _barco_password;
1021 boost::optional<std::string> _christie_username;
1022 boost::optional<std::string> _christie_password;
1023 boost::optional<std::string> _gdc_username;
1024 boost::optional<std::string> _gdc_password;
1026 static int const _current_version;
1028 /** Singleton instance, or 0 */
1029 static Config* _instance;