2 Copyright (C) 2012-2022 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.
26 #ifndef DCPOMATIC_CONFIG_H
27 #define DCPOMATIC_CONFIG_H
30 #include "audio_mapping.h"
31 #include "export_config.h"
32 #include "rough_duration.h"
34 #include <dcp/name_format.h>
35 #include <dcp/certificate_chain.h>
36 #include <dcp/encrypted_kdm.h>
37 #include <dcp/language_tag.h>
38 #include <boost/signals2.hpp>
39 #include <boost/filesystem.hpp>
44 class CinemaSoundProcessor;
52 extern void save_all_config_as_zip (boost::filesystem::path zip_file);
56 * @brief A singleton class holding configuration.
58 class Config : public State
61 /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
62 int master_encoding_threads () const {
63 return _master_encoding_threads;
66 /** @return number of threads which a server should use for J2K encoding on the local machine */
67 int server_encoding_threads () const {
68 return _server_encoding_threads;
71 boost::optional<boost::filesystem::path> default_directory () const {
72 return _default_directory;
75 boost::optional<boost::filesystem::path> default_kdm_directory () const {
76 return _default_kdm_directory;
79 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
80 boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
89 PLAYER_CONTENT_DIRECTORY,
90 PLAYER_PLAYLIST_DIRECTORY,
93 SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
99 /** @return base port number to use for J2K encoding servers */
100 int server_port_base () const {
101 return _server_port_base;
104 void set_use_any_servers (bool u) {
105 _use_any_servers = u;
106 changed (USE_ANY_SERVERS);
109 bool use_any_servers () const {
110 return _use_any_servers;
113 /** @param s New list of servers */
114 void set_servers (std::vector<std::string> s) {
119 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
120 std::vector<std::string> servers () const {
124 bool only_servers_encode () const {
125 return _only_servers_encode;
128 FileTransferProtocol tms_protocol () const {
129 return _tms_protocol;
132 bool tms_passive() const {
136 /** @return The IP address of a TMS that we can copy DCPs to */
137 std::string tms_ip () const {
141 /** @return The path on a TMS that we should changed DCPs to */
142 std::string tms_path () const {
146 /** @return User name to log into the TMS with */
147 std::string tms_user () const {
151 /** @return Password to log into the TMS with */
152 std::string tms_password () const {
153 return _tms_password;
156 std::list<std::shared_ptr<Cinema>> cinemas () const {
160 std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
161 return _dkdm_recipients;
164 std::list<int> allowed_dcp_frame_rates () const {
165 return _allowed_dcp_frame_rates;
168 bool allow_any_dcp_frame_rate () const {
169 return _allow_any_dcp_frame_rate;
172 bool allow_any_container () const {
173 return _allow_any_container;
176 bool allow_96khz_audio () const {
177 return _allow_96khz_audio;
180 bool use_all_audio_channels () const {
181 return _use_all_audio_channels;
184 bool show_experimental_audio_processors () const {
185 return _show_experimental_audio_processors;
188 boost::optional<std::string> language () const {
192 int default_still_length () const {
193 return _default_still_length;
196 DCPContentType const * default_dcp_content_type () const {
197 return _default_dcp_content_type;
200 int default_dcp_audio_channels () const {
201 return _default_dcp_audio_channels;
204 std::string dcp_issuer () const {
208 std::string dcp_creator () const {
212 std::string dcp_company_name () const {
213 return _dcp_company_name;
216 std::string dcp_product_name () const {
217 return _dcp_product_name;
220 std::string dcp_product_version () const {
221 return _dcp_product_version;
224 std::string dcp_j2k_comment () const {
225 return _dcp_j2k_comment;
228 int default_j2k_bandwidth () const {
229 return _default_j2k_bandwidth;
232 int default_audio_delay () const {
233 return _default_audio_delay;
236 bool default_interop () const {
237 return _default_interop;
240 boost::optional<dcp::LanguageTag> default_audio_language() const {
241 return _default_audio_language;
244 boost::optional<dcp::LanguageTag::RegionSubtag> default_territory() const {
245 return _default_territory;
248 std::map<std::string, std::string> default_metadata () const {
249 return _default_metadata;
252 bool upload_after_make_dcp () {
253 return _upload_after_make_dcp;
256 void set_default_kdm_directory (boost::filesystem::path d) {
257 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
260 _default_kdm_directory = d;
264 std::string mail_server () const {
268 int mail_port () const {
272 EmailProtocol mail_protocol () const {
273 return _mail_protocol;
276 std::string mail_user () const {
280 std::string mail_password () const {
281 return _mail_password;
284 std::string kdm_subject () const {
288 std::string kdm_from () const {
292 std::vector<std::string> kdm_cc () const {
296 std::string kdm_bcc () const {
300 std::string kdm_email () const {
304 std::string notification_subject () const {
305 return _notification_subject;
308 std::string notification_from () const {
309 return _notification_from;
312 std::string notification_to () const {
313 return _notification_to;
316 std::vector<std::string> notification_cc () const {
317 return _notification_cc;
320 std::string notification_bcc () const {
321 return _notification_bcc;
324 std::string notification_email () const {
325 return _notification_email;
328 std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
329 return _signer_chain;
332 std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
333 return _decryption_chain;
336 bool check_for_updates () const {
337 return _check_for_updates;
340 bool check_for_test_updates () const {
341 return _check_for_test_updates;
344 int maximum_j2k_bandwidth () const {
345 return _maximum_j2k_bandwidth;
348 int log_types () const {
352 bool analyse_ebur128 () const {
353 return _analyse_ebur128;
356 bool automatic_audio_analysis () const {
357 return _automatic_audio_analysis;
360 #ifdef DCPOMATIC_WINDOWS
361 bool win32_console () const {
362 return _win32_console;
366 std::vector<boost::filesystem::path> history () const {
370 std::vector<boost::filesystem::path> player_history () const {
371 return _player_history;
374 std::shared_ptr<DKDMGroup> dkdms () const {
378 boost::filesystem::path cinemas_file () const {
379 return _cinemas_file;
382 boost::filesystem::path dkdm_recipients_file () const {
383 return _dkdm_recipients_file;
386 bool show_hints_before_make_dcp () const {
387 return _show_hints_before_make_dcp;
390 bool confirm_kdm_email () const {
391 return _confirm_kdm_email;
394 dcp::NameFormat kdm_container_name_format () const {
395 return _kdm_container_name_format;
398 dcp::NameFormat kdm_filename_format () const {
399 return _kdm_filename_format;
402 dcp::NameFormat dkdm_filename_format () const {
403 return _dkdm_filename_format;
406 dcp::NameFormat dcp_metadata_filename_format () const {
407 return _dcp_metadata_filename_format;
410 dcp::NameFormat dcp_asset_filename_format () const {
411 return _dcp_asset_filename_format;
414 bool jump_to_selected () const {
415 return _jump_to_selected;
418 /* This could be an enum class but we use the enum a lot to index _nagged
419 * so it means a lot of casts.
423 NAG_ENCRYPTED_METADATA,
424 NAG_ALTER_DECRYPTION_CHAIN,
425 NAG_BAD_SIGNER_CHAIN_UTF8,
426 NAG_IMPORT_DECRYPTION_CHAIN,
429 NAG_TOO_MANY_DROPPED_FRAMES,
430 NAG_BAD_SIGNER_CHAIN_VALIDITY,
434 bool nagged (Nag nag) const {
438 bool sound () const {
442 std::string cover_sheet () const {
446 boost::optional<std::string> sound_output () const {
447 return _sound_output;
450 boost::optional<boost::filesystem::path> last_player_load_directory () const {
451 return _last_player_load_directory;
460 boost::optional<KDMWriteType> last_kdm_write_type () const {
461 return _last_kdm_write_type;
469 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
470 return _last_dkdm_write_type;
473 int frames_in_memory_multiplier () const {
474 return _frames_in_memory_multiplier;
477 boost::optional<int> decode_reduction () const {
478 return _decode_reduction;
481 bool default_notify () const {
482 return _default_notify;
491 bool notification (Notification n) const {
492 return _notification[n];
495 boost::optional<std::string> barco_username () const {
496 return _barco_username;
499 boost::optional<std::string> barco_password () const {
500 return _barco_password;
503 boost::optional<std::string> christie_username () const {
504 return _christie_username;
507 boost::optional<std::string> christie_password () const {
508 return _christie_password;
511 boost::optional<std::string> gdc_username () const {
512 return _gdc_username;
515 boost::optional<std::string> gdc_password () const {
516 return _gdc_password;
520 PLAYER_MODE_WINDOW, ///< one window containing image and controls
521 PLAYER_MODE_FULL, ///< just the image filling the screen
522 PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
525 PlayerMode player_mode () const {
529 int image_display () const {
530 return _image_display;
538 VideoViewType video_view_type () const {
539 return _video_view_type;
542 bool respect_kdm_validity_periods () const {
543 return _respect_kdm_validity_periods;
546 boost::optional<boost::filesystem::path> player_debug_log_file () const {
547 return _player_debug_log_file;
550 boost::optional<boost::filesystem::path> player_content_directory () const {
551 return _player_content_directory;
554 boost::optional<boost::filesystem::path> player_playlist_directory () const {
555 return _player_playlist_directory;
558 boost::optional<boost::filesystem::path> player_kdm_directory () const {
559 return _player_kdm_directory;
562 AudioMapping audio_mapping (int output_channels);
564 std::vector<dcp::LanguageTag> custom_languages () const {
565 return _custom_languages;
568 boost::optional<boost::filesystem::path> add_files_path () const {
569 return _add_files_path;
572 bool use_isdcf_name_by_default () const {
573 return _use_isdcf_name_by_default;
576 bool write_kdms_to_disk () const {
577 return _write_kdms_to_disk;
580 bool email_kdms () const {
584 dcp::Formulation default_kdm_type () const {
585 return _default_kdm_type;
588 RoughDuration default_kdm_duration () const {
589 return _default_kdm_duration;
592 double auto_crop_threshold () const {
593 return _auto_crop_threshold;
596 boost::optional<std::string> last_release_notes_version () const {
597 return _last_release_notes_version;
600 boost::optional<int> main_divider_sash_position() const {
601 return _main_divider_sash_position;
604 boost::optional<int> main_content_divider_sash_position() const {
605 return _main_content_divider_sash_position;
610 void set_master_encoding_threads (int n) {
611 maybe_set (_master_encoding_threads, n);
614 void set_server_encoding_threads (int n) {
615 maybe_set (_server_encoding_threads, n);
618 void set_default_directory (boost::filesystem::path d) {
619 if (_default_directory && *_default_directory == d) {
622 _default_directory = d;
626 /** @param p New server port */
627 void set_server_port_base (int p) {
628 maybe_set (_server_port_base, p);
631 void set_only_servers_encode (bool o) {
632 maybe_set (_only_servers_encode, o);
635 void set_tms_protocol (FileTransferProtocol p) {
636 maybe_set (_tms_protocol, p);
639 void set_tms_passive(bool passive) {
640 maybe_set(_tms_passive, passive);
643 /** @param i IP address of a TMS that we can copy DCPs to */
644 void set_tms_ip (std::string i) {
645 maybe_set (_tms_ip, i);
648 /** @param p Path on a TMS that we should changed DCPs to */
649 void set_tms_path (std::string p) {
650 maybe_set (_tms_path, p);
653 /** @param u User name to log into the TMS with */
654 void set_tms_user (std::string u) {
655 maybe_set (_tms_user, u);
658 /** @param p Password to log into the TMS with */
659 void set_tms_password (std::string p) {
660 maybe_set (_tms_password, p);
663 void add_cinema (std::shared_ptr<Cinema> c) {
664 _cinemas.push_back (c);
668 void remove_cinema (std::shared_ptr<Cinema> c) {
673 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
674 _dkdm_recipients.push_back (c);
675 changed (DKDM_RECIPIENTS);
678 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
679 _dkdm_recipients.remove (c);
680 changed (DKDM_RECIPIENTS);
683 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
684 maybe_set (_allowed_dcp_frame_rates, r);
687 void set_allow_any_dcp_frame_rate (bool a) {
688 maybe_set (_allow_any_dcp_frame_rate, a);
691 void set_allow_any_container (bool a) {
692 maybe_set (_allow_any_container, a);
695 void set_allow_96hhz_audio (bool a) {
696 maybe_set (_allow_96khz_audio, a);
699 void set_use_all_audio_channels (bool a) {
700 maybe_set (_use_all_audio_channels, a);
703 void set_show_experimental_audio_processors (bool e) {
704 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
707 void set_language (std::string l) {
708 if (_language && _language.get() == l) {
715 void unset_language () {
720 _language = boost::none;
724 void set_default_still_length (int s) {
725 maybe_set (_default_still_length, s);
728 void set_default_dcp_content_type (DCPContentType const * t) {
729 maybe_set (_default_dcp_content_type, t);
732 void set_default_dcp_audio_channels (int c) {
733 maybe_set (_default_dcp_audio_channels, c);
736 void set_dcp_issuer (std::string i) {
737 maybe_set (_dcp_issuer, i);
740 void set_dcp_creator (std::string c) {
741 maybe_set (_dcp_creator, c);
744 void set_dcp_company_name (std::string c) {
745 maybe_set (_dcp_company_name, c);
748 void set_dcp_product_name (std::string c) {
749 maybe_set (_dcp_product_name, c);
752 void set_dcp_product_version (std::string c) {
753 maybe_set (_dcp_product_version, c);
756 void set_dcp_j2k_comment (std::string c) {
757 maybe_set (_dcp_j2k_comment, c);
760 void set_default_j2k_bandwidth (int b) {
761 maybe_set (_default_j2k_bandwidth, b);
764 void set_default_audio_delay (int d) {
765 maybe_set (_default_audio_delay, d);
768 void set_default_interop (bool i) {
769 maybe_set (_default_interop, i);
772 void set_default_audio_language(dcp::LanguageTag tag) {
773 maybe_set(_default_audio_language, tag);
776 void unset_default_audio_language() {
777 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
780 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
781 maybe_set(_default_territory, tag);
784 void unset_default_territory() {
785 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
788 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
789 maybe_set (_default_metadata, metadata);
792 void set_upload_after_make_dcp (bool u) {
793 maybe_set (_upload_after_make_dcp, u);
796 void set_mail_server (std::string s) {
797 maybe_set (_mail_server, s);
800 void set_mail_port (int p) {
801 maybe_set (_mail_port, p);
804 void set_mail_protocol (EmailProtocol p) {
805 maybe_set (_mail_protocol, p);
808 void set_mail_user (std::string u) {
809 maybe_set (_mail_user, u);
812 void set_mail_password (std::string p) {
813 maybe_set (_mail_password, p);
816 void set_kdm_subject (std::string s) {
817 maybe_set (_kdm_subject, s);
820 void set_kdm_from (std::string f) {
821 maybe_set (_kdm_from, f);
824 void set_kdm_cc (std::vector<std::string> f) {
825 maybe_set (_kdm_cc, f);
828 void set_kdm_bcc (std::string f) {
829 maybe_set (_kdm_bcc, f);
832 void set_kdm_email (std::string e) {
833 maybe_set (_kdm_email, e);
836 void reset_kdm_email ();
838 void set_notification_subject (std::string s) {
839 maybe_set (_notification_subject, s);
842 void set_notification_from (std::string f) {
843 maybe_set (_notification_from, f);
846 void set_notification_to (std::string t) {
847 maybe_set (_notification_to, t);
850 void set_notification_cc (std::vector<std::string> f) {
851 maybe_set (_notification_cc, f);
854 void set_notification_bcc (std::string f) {
855 maybe_set (_notification_bcc, f);
858 void set_notification_email (std::string e) {
859 maybe_set (_notification_email, e);
862 void reset_notification_email ();
864 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
865 maybe_set (_signer_chain, s);
868 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
869 maybe_set (_decryption_chain, c);
872 void set_check_for_updates (bool c) {
873 maybe_set (_check_for_updates, c);
875 set_check_for_test_updates (false);
879 void set_check_for_test_updates (bool c) {
880 maybe_set (_check_for_test_updates, c);
883 void set_maximum_j2k_bandwidth (int b) {
884 maybe_set (_maximum_j2k_bandwidth, b);
887 void set_log_types (int t) {
888 maybe_set (_log_types, t);
891 void set_analyse_ebur128 (bool a) {
892 maybe_set (_analyse_ebur128, a);
895 void set_automatic_audio_analysis (bool a) {
896 maybe_set (_automatic_audio_analysis, a);
899 #ifdef DCPOMATIC_WINDOWS
900 void set_win32_console (bool c) {
901 maybe_set (_win32_console, c);
905 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
910 void set_cinemas_file (boost::filesystem::path file);
912 void set_show_hints_before_make_dcp (bool s) {
913 maybe_set (_show_hints_before_make_dcp, s);
916 void set_confirm_kdm_email (bool s) {
917 maybe_set (_confirm_kdm_email, s);
920 void set_sound (bool s) {
921 maybe_set (_sound, s, SOUND);
924 void set_sound_output (std::string o) {
925 maybe_set (_sound_output, o, SOUND_OUTPUT);
928 void set_last_player_load_directory (boost::filesystem::path d) {
929 maybe_set (_last_player_load_directory, d);
932 void set_last_kdm_write_type (KDMWriteType t) {
933 maybe_set (_last_kdm_write_type, t);
936 void set_last_dkdm_write_type (DKDMWriteType t) {
937 maybe_set (_last_dkdm_write_type, t);
940 void unset_sound_output () {
941 if (!_sound_output) {
945 _sound_output = boost::none;
949 void set_kdm_container_name_format (dcp::NameFormat n) {
950 maybe_set (_kdm_container_name_format, n);
953 void set_kdm_filename_format (dcp::NameFormat n) {
954 maybe_set (_kdm_filename_format, n);
957 void set_dkdm_filename_format (dcp::NameFormat n) {
958 maybe_set (_dkdm_filename_format, n);
961 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
962 maybe_set (_dcp_metadata_filename_format, n);
965 void set_dcp_asset_filename_format (dcp::NameFormat n) {
966 maybe_set (_dcp_asset_filename_format, n);
969 void set_frames_in_memory_multiplier (int m) {
970 maybe_set (_frames_in_memory_multiplier, m);
973 void set_decode_reduction (boost::optional<int> r) {
974 maybe_set (_decode_reduction, r);
977 void set_default_notify (bool n) {
978 maybe_set (_default_notify, n);
981 void clear_history () {
986 void clear_player_history () {
987 _player_history.clear ();
991 void add_to_history (boost::filesystem::path p);
992 void clean_history ();
993 void add_to_player_history (boost::filesystem::path p);
994 void clean_player_history ();
996 void set_jump_to_selected (bool j) {
997 maybe_set (_jump_to_selected, j);
1000 void set_nagged (Nag nag, bool nagged) {
1001 maybe_set (_nagged[nag], nagged);
1004 void set_cover_sheet (std::string s) {
1005 maybe_set (_cover_sheet, s);
1008 void reset_cover_sheet ();
1010 void set_notification (Notification n, bool v) {
1011 maybe_set (_notification[n], v);
1014 void set_barco_username (std::string u) {
1015 maybe_set (_barco_username, u);
1018 void unset_barco_username () {
1019 maybe_set (_barco_username, boost::optional<std::string>());
1022 void set_barco_password (std::string p) {
1023 maybe_set (_barco_password, p);
1026 void unset_barco_password () {
1027 maybe_set (_barco_password, boost::optional<std::string>());
1030 void set_christie_username (std::string u) {
1031 maybe_set (_christie_username, u);
1034 void unset_christie_username () {
1035 maybe_set (_christie_username, boost::optional<std::string>());
1038 void set_christie_password (std::string p) {
1039 maybe_set (_christie_password, p);
1042 void unset_christie_password () {
1043 maybe_set (_christie_password, boost::optional<std::string>());
1046 void set_gdc_username (std::string u) {
1047 maybe_set (_gdc_username, u);
1050 void unset_gdc_username () {
1051 maybe_set (_gdc_username, boost::optional<std::string>());
1054 void set_gdc_password (std::string p) {
1055 maybe_set (_gdc_password, p);
1058 void unset_gdc_password () {
1059 maybe_set (_gdc_password, boost::optional<std::string>());
1062 void set_player_mode (PlayerMode m) {
1063 maybe_set (_player_mode, m);
1066 void set_image_display (int n) {
1067 maybe_set (_image_display, n);
1070 void set_video_view_type (VideoViewType v) {
1071 maybe_set (_video_view_type, v);
1074 void set_respect_kdm_validity_periods (bool r) {
1075 maybe_set (_respect_kdm_validity_periods, r);
1078 void set_player_debug_log_file (boost::filesystem::path p) {
1079 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1082 void unset_player_debug_log_file () {
1083 if (!_player_debug_log_file) {
1086 _player_debug_log_file = boost::none;
1087 changed (PLAYER_DEBUG_LOG);
1090 void set_player_content_directory (boost::filesystem::path p) {
1091 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1094 void unset_player_content_directory () {
1095 if (!_player_content_directory) {
1098 _player_content_directory = boost::none;
1099 changed (PLAYER_CONTENT_DIRECTORY);
1102 void set_player_playlist_directory (boost::filesystem::path p) {
1103 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1106 void unset_player_playlist_directory () {
1107 if (!_player_playlist_directory) {
1110 _player_playlist_directory = boost::none;
1111 changed (PLAYER_PLAYLIST_DIRECTORY);
1114 void set_player_kdm_directory (boost::filesystem::path p) {
1115 maybe_set (_player_kdm_directory, p);
1118 void unset_player_kdm_directory () {
1119 if (!_player_kdm_directory) {
1122 _player_kdm_directory = boost::none;
1126 void set_audio_mapping (AudioMapping m);
1127 void set_audio_mapping_to_default ();
1129 void add_custom_language (dcp::LanguageTag tag);
1131 void set_add_files_path (boost::filesystem::path p) {
1132 _add_files_path = p;
1136 void set_use_isdcf_name_by_default (bool use) {
1137 maybe_set (_use_isdcf_name_by_default, use);
1140 void set_write_kdms_to_disk (bool write) {
1141 maybe_set (_write_kdms_to_disk, write);
1144 void set_email_kdms (bool email) {
1145 maybe_set (_email_kdms, email);
1148 void set_default_kdm_type (dcp::Formulation type) {
1149 maybe_set (_default_kdm_type, type);
1152 void set_default_kdm_duration (RoughDuration duration) {
1153 maybe_set (_default_kdm_duration, duration);
1156 void set_auto_crop_threshold (double threshold) {
1157 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1160 void set_last_release_notes_version (std::string version) {
1161 maybe_set (_last_release_notes_version, version);
1164 void unset_last_release_notes_version() {
1165 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1168 ExportConfig& export_config() {
1172 void set_main_divider_sash_position(int position) {
1173 maybe_set(_main_divider_sash_position, position);
1176 void set_main_content_divider_sash_position(int position) {
1177 maybe_set(_main_content_divider_sash_position, position);
1180 void changed (Property p = OTHER);
1181 boost::signals2::signal<void (Property)> Changed;
1182 /** Emitted if read() failed on an existing Config file. There is nothing
1183 a listener can do about it: this is just for information.
1185 enum class LoadFailure {
1190 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1191 /** Emitted if read() issued a warning which the user might want to know about */
1192 static boost::signals2::signal<void (std::string)> Warning;
1193 /** Emitted if there is a something wrong the contents of our config. Handler can call
1194 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1197 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1198 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1199 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1200 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1203 static boost::signals2::signal<bool (BadReason)> Bad;
1205 void write () const override;
1206 void write_config () const;
1207 void write_cinemas () const;
1208 void write_dkdm_recipients () const;
1209 void link (boost::filesystem::path new_file) const;
1210 void copy_and_link (boost::filesystem::path new_file) const;
1211 bool have_write_permission () const;
1213 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1214 bool existing_template (std::string name) const;
1215 std::list<std::string> templates () const;
1216 boost::filesystem::path template_read_path (std::string name) const;
1217 boost::filesystem::path template_write_path (std::string name) const;
1218 void rename_template (std::string old_name, std::string new_name) const;
1219 void delete_template (std::string name) const;
1221 boost::optional<BadReason> check_certificates () const;
1223 static Config* instance ();
1224 static void drop ();
1225 static void restore_defaults ();
1226 static bool have_existing (std::string);
1227 static boost::filesystem::path config_read_file ();
1228 static boost::filesystem::path config_write_file ();
1231 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1232 if (member == new_value) {
1240 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1241 if (member && member.get() == new_value) {
1250 void read () override;
1252 void read_cinemas();
1253 void read_dkdm_recipients();
1254 void set_defaults ();
1255 void set_kdm_email_to_default ();
1256 void set_notification_email_to_default ();
1257 void set_cover_sheet_to_default ();
1258 void read_cinemas (cxml::Document const & f);
1259 void read_dkdm_recipients (cxml::Document const & f);
1260 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1261 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1262 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1263 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1266 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1267 int _master_encoding_threads;
1268 /** number of threads which a server should use for J2K encoding on the local machine */
1269 int _server_encoding_threads;
1270 /** default directory to put new films in */
1271 boost::optional<boost::filesystem::path> _default_directory;
1272 /** base port number to use for J2K encoding servers;
1273 * this port and the two above it will be used.
1275 int _server_port_base;
1276 /** true to broadcast on the `any' address to look for servers */
1277 bool _use_any_servers;
1278 /** J2K encoding servers that should definitely be used */
1279 std::vector<std::string> _servers;
1280 bool _only_servers_encode;
1281 FileTransferProtocol _tms_protocol;
1283 /** The IP address of a TMS that we can copy DCPs to */
1284 std::string _tms_ip;
1285 /** The path on a TMS that we should write DCPs to */
1286 std::string _tms_path;
1287 /** User name to log into the TMS with */
1288 std::string _tms_user;
1289 /** Password to log into the TMS with */
1290 std::string _tms_password;
1291 /** The list of possible DCP frame rates that DCP-o-matic will use */
1292 std::list<int> _allowed_dcp_frame_rates;
1293 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1294 bool _allow_any_dcp_frame_rate;
1295 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1296 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1297 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1299 bool _allow_any_container;
1300 bool _allow_96khz_audio;
1301 bool _use_all_audio_channels;
1302 /** Offer the upmixers in the audio processor settings */
1303 bool _show_experimental_audio_processors;
1304 boost::optional<std::string> _language;
1305 /** Default length of still image content (seconds) */
1306 int _default_still_length;
1307 DCPContentType const * _default_dcp_content_type;
1308 int _default_dcp_audio_channels;
1309 std::string _dcp_issuer;
1310 std::string _dcp_creator;
1311 std::string _dcp_company_name;
1312 std::string _dcp_product_name;
1313 std::string _dcp_product_version;
1314 std::string _dcp_j2k_comment;
1315 int _default_j2k_bandwidth;
1316 int _default_audio_delay;
1317 bool _default_interop;
1318 boost::optional<dcp::LanguageTag> _default_audio_language;
1319 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1320 std::map<std::string, std::string> _default_metadata;
1321 /** Default directory to offer to write KDMs to; if it's not set,
1322 the home directory will be offered.
1324 boost::optional<boost::filesystem::path> _default_kdm_directory;
1325 bool _upload_after_make_dcp;
1326 std::list<std::shared_ptr<Cinema>> _cinemas;
1327 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1328 std::string _mail_server;
1330 EmailProtocol _mail_protocol;
1331 std::string _mail_user;
1332 std::string _mail_password;
1333 std::string _kdm_subject;
1334 std::string _kdm_from;
1335 std::vector<std::string> _kdm_cc;
1336 std::string _kdm_bcc;
1337 std::string _kdm_email;
1338 std::string _notification_subject;
1339 std::string _notification_from;
1340 std::string _notification_to;
1341 std::vector<std::string> _notification_cc;
1342 std::string _notification_bcc;
1343 std::string _notification_email;
1344 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1345 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1346 * certificate for making KDMs given to DCP-o-matic.
1348 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1349 /** true to check for updates on startup */
1350 bool _check_for_updates;
1351 bool _check_for_test_updates;
1352 /** maximum allowed J2K bandwidth in bits per second */
1353 int _maximum_j2k_bandwidth;
1355 bool _analyse_ebur128;
1356 bool _automatic_audio_analysis;
1357 #ifdef DCPOMATIC_WINDOWS
1358 bool _win32_console;
1360 std::vector<boost::filesystem::path> _history;
1361 std::vector<boost::filesystem::path> _player_history;
1362 std::shared_ptr<DKDMGroup> _dkdms;
1363 boost::filesystem::path _cinemas_file;
1364 boost::filesystem::path _dkdm_recipients_file;
1365 bool _show_hints_before_make_dcp;
1366 bool _confirm_kdm_email;
1367 dcp::NameFormat _kdm_filename_format;
1368 dcp::NameFormat _dkdm_filename_format;
1369 dcp::NameFormat _kdm_container_name_format;
1370 dcp::NameFormat _dcp_metadata_filename_format;
1371 dcp::NameFormat _dcp_asset_filename_format;
1372 bool _jump_to_selected;
1373 bool _nagged[NAG_COUNT];
1375 /** name of a specific sound output stream to use, or empty to use the default */
1376 boost::optional<std::string> _sound_output;
1377 std::string _cover_sheet;
1378 boost::optional<boost::filesystem::path> _last_player_load_directory;
1379 boost::optional<KDMWriteType> _last_kdm_write_type;
1380 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1381 int _frames_in_memory_multiplier;
1382 boost::optional<int> _decode_reduction;
1383 bool _default_notify;
1384 bool _notification[NOTIFICATION_COUNT];
1385 boost::optional<std::string> _barco_username;
1386 boost::optional<std::string> _barco_password;
1387 boost::optional<std::string> _christie_username;
1388 boost::optional<std::string> _christie_password;
1389 boost::optional<std::string> _gdc_username;
1390 boost::optional<std::string> _gdc_password;
1391 PlayerMode _player_mode;
1393 VideoViewType _video_view_type;
1394 bool _respect_kdm_validity_periods;
1395 /** Log file containing debug information for the player */
1396 boost::optional<boost::filesystem::path> _player_debug_log_file;
1397 /** A directory containing DCPs whose contents are presented to the user
1398 in the dual-screen player mode. DCPs on the list can be loaded
1401 boost::optional<boost::filesystem::path> _player_content_directory;
1402 boost::optional<boost::filesystem::path> _player_playlist_directory;
1403 boost::optional<boost::filesystem::path> _player_kdm_directory;
1404 boost::optional<AudioMapping> _audio_mapping;
1405 std::vector<dcp::LanguageTag> _custom_languages;
1406 boost::optional<boost::filesystem::path> _add_files_path;
1407 bool _use_isdcf_name_by_default;
1408 bool _write_kdms_to_disk;
1410 dcp::Formulation _default_kdm_type;
1411 RoughDuration _default_kdm_duration;
1412 double _auto_crop_threshold;
1413 boost::optional<std::string> _last_release_notes_version;
1414 boost::optional<int> _main_divider_sash_position;
1415 boost::optional<int> _main_content_divider_sash_position;
1417 ExportConfig _export;
1419 static int const _current_version;
1421 /** Singleton instance, or 0 */
1422 static Config* _instance;