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"
31 #include <dcp/name_format.h>
32 #include <dcp/certificate_chain.h>
33 #include <dcp/encrypted_kdm.h>
34 #include <boost/shared_ptr.hpp>
35 #include <boost/signals2.hpp>
36 #include <boost/filesystem.hpp>
39 class CinemaSoundProcessor;
47 * @brief A singleton class holding configuration.
49 class Config : public boost::noncopyable
52 /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
53 int master_encoding_threads () const {
54 return _master_encoding_threads;
57 /** @return number of threads which a server should use for J2K encoding on the local machine */
58 int server_encoding_threads () const {
59 return _server_encoding_threads;
62 boost::optional<boost::filesystem::path> default_directory () const {
63 return _default_directory;
66 boost::optional<boost::filesystem::path> default_kdm_directory () const {
67 return _default_kdm_directory;
70 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
71 boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
80 PLAYER_CONTENT_DIRECTORY,
81 PLAYER_PLAYLIST_DIRECTORY,
84 #ifdef DCPOMATIC_VARIANT_SWAROOP
85 PLAYER_BACKGROUND_IMAGE,
90 /** @return base port number to use for J2K encoding servers */
91 int server_port_base () const {
92 return _server_port_base;
95 void set_use_any_servers (bool u) {
97 changed (USE_ANY_SERVERS);
100 bool use_any_servers () const {
101 return _use_any_servers;
104 /** @param s New list of servers */
105 void set_servers (std::vector<std::string> s) {
110 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
111 std::vector<std::string> servers () const {
115 bool only_servers_encode () const {
116 return _only_servers_encode;
119 Protocol tms_protocol () const {
120 return _tms_protocol;
123 /** @return The IP address of a TMS that we can copy DCPs to */
124 std::string tms_ip () const {
128 /** @return The path on a TMS that we should changed DCPs to */
129 std::string tms_path () const {
133 /** @return User name to log into the TMS with */
134 std::string tms_user () const {
138 /** @return Password to log into the TMS with */
139 std::string tms_password () const {
140 return _tms_password;
143 /** @return The cinema sound processor that we are using */
144 CinemaSoundProcessor const * cinema_sound_processor () const {
145 return _cinema_sound_processor;
148 std::list<boost::shared_ptr<Cinema> > cinemas () const {
152 std::list<int> allowed_dcp_frame_rates () const {
153 return _allowed_dcp_frame_rates;
156 bool allow_any_dcp_frame_rate () const {
157 return _allow_any_dcp_frame_rate;
160 bool allow_any_container () const {
161 return _allow_any_container;
164 ISDCFMetadata default_isdcf_metadata () const {
165 return _default_isdcf_metadata;
168 boost::optional<std::string> language () const {
172 int default_still_length () const {
173 return _default_still_length;
176 Ratio const * default_container () const {
177 return _default_container;
180 Ratio const * default_scale_to () const {
181 return _default_scale_to;
184 DCPContentType const * default_dcp_content_type () const {
185 return _default_dcp_content_type;
188 int default_dcp_audio_channels () const {
189 return _default_dcp_audio_channels;
192 std::string dcp_issuer () const {
196 std::string dcp_creator () const {
200 int default_j2k_bandwidth () const {
201 return _default_j2k_bandwidth;
204 int default_audio_delay () const {
205 return _default_audio_delay;
208 bool default_interop () const {
209 return _default_interop;
212 bool default_upload_after_make_dcp () {
213 return _default_upload_after_make_dcp;
216 void set_default_kdm_directory (boost::filesystem::path d) {
217 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
220 _default_kdm_directory = d;
224 std::string mail_server () const {
228 int mail_port () const {
232 std::string mail_user () const {
236 std::string mail_password () const {
237 return _mail_password;
240 std::string kdm_subject () const {
244 std::string kdm_from () const {
248 std::vector<std::string> kdm_cc () const {
252 std::string kdm_bcc () const {
256 std::string kdm_email () const {
260 std::string notification_subject () const {
261 return _notification_subject;
264 std::string notification_from () const {
265 return _notification_from;
268 std::string notification_to () const {
269 return _notification_to;
272 std::vector<std::string> notification_cc () const {
273 return _notification_cc;
276 std::string notification_bcc () const {
277 return _notification_bcc;
280 std::string notification_email () const {
281 return _notification_email;
284 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
285 return _signer_chain;
288 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
289 return _decryption_chain;
292 bool check_for_updates () const {
293 return _check_for_updates;
296 bool check_for_test_updates () const {
297 return _check_for_test_updates;
300 int maximum_j2k_bandwidth () const {
301 return _maximum_j2k_bandwidth;
304 int log_types () const {
308 bool analyse_ebur128 () const {
309 return _analyse_ebur128;
312 bool automatic_audio_analysis () const {
313 return _automatic_audio_analysis;
316 #ifdef DCPOMATIC_WINDOWS
317 bool win32_console () const {
318 return _win32_console;
322 std::vector<boost::filesystem::path> history () const {
326 std::vector<boost::filesystem::path> player_history () const {
327 return _player_history;
330 boost::shared_ptr<DKDMGroup> dkdms () const {
334 boost::filesystem::path cinemas_file () const {
335 return _cinemas_file;
338 bool show_hints_before_make_dcp () const {
339 return _show_hints_before_make_dcp;
342 bool confirm_kdm_email () const {
343 return _confirm_kdm_email;
346 dcp::NameFormat kdm_container_name_format () const {
347 return _kdm_container_name_format;
350 dcp::NameFormat kdm_filename_format () const {
351 return _kdm_filename_format;
354 dcp::NameFormat dcp_metadata_filename_format () const {
355 return _dcp_metadata_filename_format;
358 dcp::NameFormat dcp_asset_filename_format () const {
359 return _dcp_asset_filename_format;
362 bool jump_to_selected () const {
363 return _jump_to_selected;
368 NAG_ENCRYPTED_METADATA,
369 NAG_REMAKE_DECRYPTION_CHAIN,
370 NAG_BAD_SIGNER_CHAIN,
371 /* Not really a nag but it's the same idea */
376 bool nagged (Nag nag) const {
380 bool sound () const {
384 std::string cover_sheet () const {
388 boost::optional<std::string> sound_output () const {
389 return _sound_output;
392 boost::optional<boost::filesystem::path> last_player_load_directory () const {
393 return _last_player_load_directory;
402 boost::optional<KDMWriteType> last_kdm_write_type () const {
403 return _last_kdm_write_type;
411 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
412 return _last_dkdm_write_type;
415 int frames_in_memory_multiplier () const {
416 return _frames_in_memory_multiplier;
419 boost::optional<int> decode_reduction () const {
420 return _decode_reduction;
423 bool default_notify () const {
424 return _default_notify;
433 bool notification (Notification n) const {
434 return _notification[n];
437 boost::optional<std::string> barco_username () const {
438 return _barco_username;
441 boost::optional<std::string> barco_password () const {
442 return _barco_password;
445 boost::optional<std::string> christie_username () const {
446 return _christie_username;
449 boost::optional<std::string> christie_password () const {
450 return _christie_password;
453 boost::optional<std::string> gdc_username () const {
454 return _gdc_username;
457 boost::optional<std::string> gdc_password () const {
458 return _gdc_password;
466 Interface interface_complexity () const {
467 return _interface_complexity;
476 PlayerMode player_mode () const {
480 int image_display () const {
481 return _image_display;
484 bool respect_kdm_validity_periods () const {
485 return _respect_kdm_validity_periods;
488 boost::optional<boost::filesystem::path> player_activity_log_file () const {
489 return _player_activity_log_file;
492 boost::optional<boost::filesystem::path> player_debug_log_file () const {
493 return _player_debug_log_file;
496 boost::optional<boost::filesystem::path> player_content_directory () const {
497 return _player_content_directory;
500 boost::optional<boost::filesystem::path> player_playlist_directory () const {
501 return _player_playlist_directory;
504 boost::optional<boost::filesystem::path> player_kdm_directory () const {
505 return _player_kdm_directory;
508 #ifdef DCPOMATIC_VARIANT_SWAROOP
509 boost::optional<boost::filesystem::path> player_background_image () const {
510 return _player_background_image;
513 std::string kdm_server_url () const {
514 return _kdm_server_url;
517 std::string player_watermark_theatre () const {
518 return _player_watermark_theatre;
521 int player_watermark_period () const {
522 return _player_watermark_period;
525 int player_watermark_duration () const {
526 return _player_watermark_duration;
529 std::vector<Monitor> required_monitors () const {
530 return _required_monitors;
533 boost::optional<boost::filesystem::path> player_lock_file () const {
534 return _player_lock_file;
540 void set_master_encoding_threads (int n) {
541 maybe_set (_master_encoding_threads, n);
544 void set_server_encoding_threads (int n) {
545 maybe_set (_server_encoding_threads, n);
548 void set_default_directory (boost::filesystem::path d) {
549 if (_default_directory && *_default_directory == d) {
552 _default_directory = d;
556 /** @param p New server port */
557 void set_server_port_base (int p) {
558 maybe_set (_server_port_base, p);
561 void set_only_servers_encode (bool o) {
562 maybe_set (_only_servers_encode, o);
565 void set_tms_protocol (Protocol p) {
566 maybe_set (_tms_protocol, p);
569 /** @param i IP address of a TMS that we can copy DCPs to */
570 void set_tms_ip (std::string i) {
571 maybe_set (_tms_ip, i);
574 /** @param p Path on a TMS that we should changed DCPs to */
575 void set_tms_path (std::string p) {
576 maybe_set (_tms_path, p);
579 /** @param u User name to log into the TMS with */
580 void set_tms_user (std::string u) {
581 maybe_set (_tms_user, u);
584 /** @param p Password to log into the TMS with */
585 void set_tms_password (std::string p) {
586 maybe_set (_tms_password, p);
589 void add_cinema (boost::shared_ptr<Cinema> c) {
590 _cinemas.push_back (c);
594 void remove_cinema (boost::shared_ptr<Cinema> c) {
599 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
600 maybe_set (_allowed_dcp_frame_rates, r);
603 void set_allow_any_dcp_frame_rate (bool a) {
604 maybe_set (_allow_any_dcp_frame_rate, a);
607 void set_allow_any_container (bool a) {
608 maybe_set (_allow_any_container, a);
611 void set_default_isdcf_metadata (ISDCFMetadata d) {
612 maybe_set (_default_isdcf_metadata, d);
615 void set_language (std::string l) {
616 if (_language && _language.get() == l) {
623 void unset_language () {
628 _language = boost::none;
632 void set_default_still_length (int s) {
633 maybe_set (_default_still_length, s);
636 void set_default_container (Ratio const * c) {
637 maybe_set (_default_container, c);
640 void set_default_scale_to (Ratio const * c) {
641 maybe_set (_default_scale_to, c);
644 void set_default_dcp_content_type (DCPContentType const * t) {
645 maybe_set (_default_dcp_content_type, t);
648 void set_default_dcp_audio_channels (int c) {
649 maybe_set (_default_dcp_audio_channels, c);
652 void set_dcp_issuer (std::string i) {
653 maybe_set (_dcp_issuer, i);
656 void set_dcp_creator (std::string c) {
657 maybe_set (_dcp_creator, c);
660 void set_default_j2k_bandwidth (int b) {
661 maybe_set (_default_j2k_bandwidth, b);
664 void set_default_audio_delay (int d) {
665 maybe_set (_default_audio_delay, d);
668 void set_default_interop (bool i) {
669 maybe_set (_default_interop, i);
672 void set_default_upload_after_make_dcp (bool u) {
673 maybe_set (_default_upload_after_make_dcp, u);
676 void set_mail_server (std::string s) {
677 maybe_set (_mail_server, s);
680 void set_mail_port (int p) {
681 maybe_set (_mail_port, p);
684 void set_mail_user (std::string u) {
685 maybe_set (_mail_user, u);
688 void set_mail_password (std::string p) {
689 maybe_set (_mail_password, p);
692 void set_kdm_subject (std::string s) {
693 maybe_set (_kdm_subject, s);
696 void set_kdm_from (std::string f) {
697 maybe_set (_kdm_from, f);
700 void set_kdm_cc (std::vector<std::string> f) {
701 maybe_set (_kdm_cc, f);
704 void set_kdm_bcc (std::string f) {
705 maybe_set (_kdm_bcc, f);
708 void set_kdm_email (std::string e) {
709 maybe_set (_kdm_email, e);
712 void reset_kdm_email ();
714 void set_notification_subject (std::string s) {
715 maybe_set (_notification_subject, s);
718 void set_notification_from (std::string f) {
719 maybe_set (_notification_from, f);
722 void set_notification_to (std::string t) {
723 maybe_set (_notification_to, t);
726 void set_notification_cc (std::vector<std::string> f) {
727 maybe_set (_notification_cc, f);
730 void set_notification_bcc (std::string f) {
731 maybe_set (_notification_bcc, f);
734 void set_notification_email (std::string e) {
735 maybe_set (_notification_email, e);
738 void reset_notification_email ();
740 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
741 maybe_set (_signer_chain, s);
744 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
745 maybe_set (_decryption_chain, c);
748 void set_check_for_updates (bool c) {
749 maybe_set (_check_for_updates, c);
751 set_check_for_test_updates (false);
755 void set_check_for_test_updates (bool c) {
756 maybe_set (_check_for_test_updates, c);
759 void set_maximum_j2k_bandwidth (int b) {
760 maybe_set (_maximum_j2k_bandwidth, b);
763 void set_log_types (int t) {
764 maybe_set (_log_types, t);
767 void set_analyse_ebur128 (bool a) {
768 maybe_set (_analyse_ebur128, a);
771 void set_automatic_audio_analysis (bool a) {
772 maybe_set (_automatic_audio_analysis, a);
775 #ifdef DCPOMATIC_WINDOWS
776 void set_win32_console (bool c) {
777 maybe_set (_win32_console, c);
781 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
786 void set_cinemas_file (boost::filesystem::path file);
788 void set_show_hints_before_make_dcp (bool s) {
789 maybe_set (_show_hints_before_make_dcp, s);
792 void set_confirm_kdm_email (bool s) {
793 maybe_set (_confirm_kdm_email, s);
796 void set_sound (bool s) {
797 maybe_set (_sound, s, SOUND);
800 void set_sound_output (std::string o) {
801 maybe_set (_sound_output, o, SOUND_OUTPUT);
804 void set_last_player_load_directory (boost::filesystem::path d) {
805 maybe_set (_last_player_load_directory, d);
808 void set_last_kdm_write_type (KDMWriteType t) {
809 maybe_set (_last_kdm_write_type, t);
812 void set_last_dkdm_write_type (DKDMWriteType t) {
813 maybe_set (_last_dkdm_write_type, t);
816 void unset_sound_output () {
817 if (!_sound_output) {
821 _sound_output = boost::none;
825 void set_kdm_container_name_format (dcp::NameFormat n) {
826 maybe_set (_kdm_container_name_format, n);
829 void set_kdm_filename_format (dcp::NameFormat n) {
830 maybe_set (_kdm_filename_format, n);
833 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
834 maybe_set (_dcp_metadata_filename_format, n);
837 void set_dcp_asset_filename_format (dcp::NameFormat n) {
838 maybe_set (_dcp_asset_filename_format, n);
841 void set_frames_in_memory_multiplier (int m) {
842 maybe_set (_frames_in_memory_multiplier, m);
845 void set_decode_reduction (boost::optional<int> r) {
846 maybe_set (_decode_reduction, r);
849 void set_default_notify (bool n) {
850 maybe_set (_default_notify, n);
853 void clear_history () {
858 void clear_player_history () {
859 _player_history.clear ();
863 void add_to_history (boost::filesystem::path p);
864 void clean_history ();
865 void add_to_player_history (boost::filesystem::path p);
866 void clean_player_history ();
868 void set_jump_to_selected (bool j) {
869 maybe_set (_jump_to_selected, j);
872 void set_nagged (Nag nag, bool nagged) {
873 maybe_set (_nagged[nag], nagged);
876 void set_cover_sheet (std::string s) {
877 maybe_set (_cover_sheet, s);
880 void reset_cover_sheet ();
882 void set_notification (Notification n, bool v) {
883 maybe_set (_notification[n], v);
886 void set_barco_username (std::string u) {
887 maybe_set (_barco_username, u);
890 void unset_barco_username () {
891 maybe_set (_barco_username, boost::optional<std::string>());
894 void set_barco_password (std::string p) {
895 maybe_set (_barco_password, p);
898 void unset_barco_password () {
899 maybe_set (_barco_password, boost::optional<std::string>());
902 void set_christie_username (std::string u) {
903 maybe_set (_christie_username, u);
906 void unset_christie_username () {
907 maybe_set (_christie_username, boost::optional<std::string>());
910 void set_christie_password (std::string p) {
911 maybe_set (_christie_password, p);
914 void unset_christie_password () {
915 maybe_set (_christie_password, boost::optional<std::string>());
918 void set_gdc_username (std::string u) {
919 maybe_set (_gdc_username, u);
922 void unset_gdc_username () {
923 maybe_set (_gdc_username, boost::optional<std::string>());
926 void set_gdc_password (std::string p) {
927 maybe_set (_gdc_password, p);
930 void unset_gdc_password () {
931 maybe_set (_gdc_password, boost::optional<std::string>());
934 void set_interface_complexity (Interface i) {
935 maybe_set (_interface_complexity, i, INTERFACE_COMPLEXITY);
938 void set_player_mode (PlayerMode m) {
939 maybe_set (_player_mode, m);
942 void set_image_display (int n) {
943 maybe_set (_image_display, n);
946 void set_respect_kdm_validity_periods (bool r) {
947 maybe_set (_respect_kdm_validity_periods, r);
950 void set_player_activity_log_file (boost::filesystem::path p) {
951 maybe_set (_player_activity_log_file, p);
954 void unset_player_activity_log_file () {
955 if (!_player_activity_log_file) {
958 _player_activity_log_file = boost::none;
962 void set_player_debug_log_file (boost::filesystem::path p) {
963 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
966 void unset_player_debug_log_file () {
967 if (!_player_debug_log_file) {
970 _player_debug_log_file = boost::none;
971 changed (PLAYER_DEBUG_LOG);
974 void set_player_content_directory (boost::filesystem::path p) {
975 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
978 void unset_player_content_directory () {
979 if (!_player_content_directory) {
982 _player_content_directory = boost::none;
983 changed (PLAYER_CONTENT_DIRECTORY);
986 void set_player_playlist_directory (boost::filesystem::path p) {
987 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
990 void unset_player_playlist_directory () {
991 if (!_player_playlist_directory) {
994 _player_playlist_directory = boost::none;
995 changed (PLAYER_PLAYLIST_DIRECTORY);
998 void set_player_kdm_directory (boost::filesystem::path p) {
999 maybe_set (_player_kdm_directory, p);
1002 void unset_player_kdm_directory () {
1003 if (!_player_kdm_directory) {
1006 _player_kdm_directory = boost::none;
1010 #ifdef DCPOMATIC_VARIANT_SWAROOP
1011 void set_player_background_image (boost::filesystem::path p) {
1012 maybe_set (_player_background_image, p, PLAYER_BACKGROUND_IMAGE);
1015 void unset_player_background_image () {
1016 if (!_player_background_image) {
1019 _player_background_image = boost::none;
1020 changed (PLAYER_BACKGROUND_IMAGE);
1023 void set_kdm_server_url (std::string s) {
1024 maybe_set (_kdm_server_url, s);
1027 void set_player_watermark_theatre (std::string p) {
1028 maybe_set (_player_watermark_theatre, p);
1031 void set_player_watermark_period (int minutes) {
1032 maybe_set (_player_watermark_period, minutes);
1035 void set_player_watermark_duration (int milliseconds) {
1036 maybe_set (_player_watermark_duration, milliseconds);
1039 void set_required_monitors (std::vector<Monitor> monitors) {
1040 maybe_set (_required_monitors, monitors);
1043 void set_player_lock_file (boost::filesystem::path p) {
1044 maybe_set (_player_lock_file, p);
1047 void unset_player_lock_file () {
1048 if (!_player_lock_file) {
1051 _player_lock_file = boost::none;
1056 void changed (Property p = OTHER);
1057 boost::signals2::signal<void (Property)> Changed;
1058 /** Emitted if read() failed on an existing Config file. There is nothing
1059 a listener can do about it: this is just for information.
1061 static boost::signals2::signal<void ()> FailedToLoad;
1062 /** Emitted if read() issued a warning which the user might want to know about */
1063 static boost::signals2::signal<void (std::string)> Warning;
1064 /** Emitted if there is a bad certificate in the signer chain. Handler can call
1065 * true to ask Config to re-create the chain.
1067 static boost::signals2::signal<bool (void)> BadSignerChain;
1069 void write () const;
1070 void write_config () const;
1071 void write_cinemas () const;
1072 void link (boost::filesystem::path new_file) const;
1073 void copy_and_link (boost::filesystem::path new_file) const;
1074 bool have_write_permission () const;
1076 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
1077 bool existing_template (std::string name) const;
1078 std::list<std::string> templates () const;
1079 boost::filesystem::path template_path (std::string name) const;
1080 void rename_template (std::string old_name, std::string new_name) const;
1081 void delete_template (std::string name) const;
1083 static Config* instance ();
1084 static void drop ();
1085 static void restore_defaults ();
1086 static bool have_existing (std::string);
1087 static boost::filesystem::path config_file ();
1088 static boost::filesystem::path path (std::string file, bool create_directories = true);
1090 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
1091 static boost::optional<boost::filesystem::path> override_path;
1096 void set_defaults ();
1097 void set_kdm_email_to_default ();
1098 void set_notification_email_to_default ();
1099 void set_cover_sheet_to_default ();
1100 void read_cinemas (cxml::Document const & f);
1101 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1102 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1103 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1104 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1108 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1109 if (member == new_value) {
1117 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1118 if (member && member.get() == new_value) {
1125 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1126 int _master_encoding_threads;
1127 /** number of threads which a server should use for J2K encoding on the local machine */
1128 int _server_encoding_threads;
1129 /** default directory to put new films in */
1130 boost::optional<boost::filesystem::path> _default_directory;
1131 /** base port number to use for J2K encoding servers;
1132 * this port and the two above it will be used.
1134 int _server_port_base;
1135 /** true to broadcast on the `any' address to look for servers */
1136 bool _use_any_servers;
1137 /** J2K encoding servers that should definitely be used */
1138 std::vector<std::string> _servers;
1139 bool _only_servers_encode;
1140 Protocol _tms_protocol;
1141 /** The IP address of a TMS that we can copy DCPs to */
1142 std::string _tms_ip;
1143 /** The path on a TMS that we should write DCPs to */
1144 std::string _tms_path;
1145 /** User name to log into the TMS with */
1146 std::string _tms_user;
1147 /** Password to log into the TMS with */
1148 std::string _tms_password;
1149 /** Our cinema sound processor */
1150 CinemaSoundProcessor const * _cinema_sound_processor;
1151 /** The list of possible DCP frame rates that DCP-o-matic will use */
1152 std::list<int> _allowed_dcp_frame_rates;
1153 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1154 bool _allow_any_dcp_frame_rate;
1155 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1156 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1157 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1159 bool _allow_any_container;
1160 /** Default ISDCF metadata for newly-created Films */
1161 ISDCFMetadata _default_isdcf_metadata;
1162 boost::optional<std::string> _language;
1163 /** Default length of still image content (seconds) */
1164 int _default_still_length;
1165 Ratio const * _default_container;
1166 Ratio const * _default_scale_to;
1167 DCPContentType const * _default_dcp_content_type;
1168 int _default_dcp_audio_channels;
1169 std::string _dcp_issuer;
1170 std::string _dcp_creator;
1171 int _default_j2k_bandwidth;
1172 int _default_audio_delay;
1173 bool _default_interop;
1174 /** Default directory to offer to write KDMs to; if it's not set,
1175 the home directory will be offered.
1177 boost::optional<boost::filesystem::path> _default_kdm_directory;
1178 bool _default_upload_after_make_dcp;
1179 std::list<boost::shared_ptr<Cinema> > _cinemas;
1180 std::string _mail_server;
1182 std::string _mail_user;
1183 std::string _mail_password;
1184 std::string _kdm_subject;
1185 std::string _kdm_from;
1186 std::vector<std::string> _kdm_cc;
1187 std::string _kdm_bcc;
1188 std::string _kdm_email;
1189 std::string _notification_subject;
1190 std::string _notification_from;
1191 std::string _notification_to;
1192 std::vector<std::string> _notification_cc;
1193 std::string _notification_bcc;
1194 std::string _notification_email;
1195 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
1196 #ifdef DCPOMATIC_VARIANT_SWAROOP
1197 boost::filesystem::path _signer_chain_path;
1199 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1200 * certificate for making KDMs given to DCP-o-matic.
1202 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1203 #ifdef DCPOMATIC_VARIANT_SWAROOP
1204 boost::filesystem::path _decryption_chain_path;
1206 /** true to check for updates on startup */
1207 bool _check_for_updates;
1208 bool _check_for_test_updates;
1209 /** maximum allowed J2K bandwidth in bits per second */
1210 int _maximum_j2k_bandwidth;
1212 bool _analyse_ebur128;
1213 bool _automatic_audio_analysis;
1214 #ifdef DCPOMATIC_WINDOWS
1215 bool _win32_console;
1217 std::vector<boost::filesystem::path> _history;
1218 std::vector<boost::filesystem::path> _player_history;
1219 boost::shared_ptr<DKDMGroup> _dkdms;
1220 boost::filesystem::path _cinemas_file;
1221 bool _show_hints_before_make_dcp;
1222 bool _confirm_kdm_email;
1223 dcp::NameFormat _kdm_filename_format;
1224 dcp::NameFormat _kdm_container_name_format;
1225 dcp::NameFormat _dcp_metadata_filename_format;
1226 dcp::NameFormat _dcp_asset_filename_format;
1227 bool _jump_to_selected;
1228 bool _nagged[NAG_COUNT];
1230 /** name of a specific sound output stream to use, or empty to use the default */
1231 boost::optional<std::string> _sound_output;
1232 std::string _cover_sheet;
1233 boost::optional<boost::filesystem::path> _last_player_load_directory;
1234 boost::optional<KDMWriteType> _last_kdm_write_type;
1235 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1236 int _frames_in_memory_multiplier;
1237 boost::optional<int> _decode_reduction;
1238 bool _default_notify;
1239 bool _notification[NOTIFICATION_COUNT];
1240 boost::optional<std::string> _barco_username;
1241 boost::optional<std::string> _barco_password;
1242 boost::optional<std::string> _christie_username;
1243 boost::optional<std::string> _christie_password;
1244 boost::optional<std::string> _gdc_username;
1245 boost::optional<std::string> _gdc_password;
1246 Interface _interface_complexity;
1247 PlayerMode _player_mode;
1249 bool _respect_kdm_validity_periods;
1250 /** Log file containing things the player does (e.g. started, stopped, loaded
1251 playlist etc.) Does not contain debugging information.
1253 boost::optional<boost::filesystem::path> _player_activity_log_file;
1254 /** Log file containing debug information for the player */
1255 boost::optional<boost::filesystem::path> _player_debug_log_file;
1256 /** A directory containing DCPs whose contents are presented to the user
1257 in the dual-screen player mode. DCPs on the list can be loaded
1260 boost::optional<boost::filesystem::path> _player_content_directory;
1261 boost::optional<boost::filesystem::path> _player_playlist_directory;
1262 boost::optional<boost::filesystem::path> _player_kdm_directory;
1263 #ifdef DCPOMATIC_VARIANT_SWAROOP
1264 boost::optional<boost::filesystem::path> _player_background_image;
1265 std::string _kdm_server_url;
1266 std::string _player_watermark_theatre;
1267 /** watermark period in minutes */
1268 int _player_watermark_period;
1269 /** watermark duration in milliseconds */
1270 int _player_watermark_duration;
1271 std::vector<Monitor> _required_monitors;
1272 /** a file which, if specified, must be present for the player to work */
1273 boost::optional<boost::filesystem::path> _player_lock_file;
1276 static int const _current_version;
1278 /** Singleton instance, or 0 */
1279 static Config* _instance;