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,
100 /** @return base port number to use for J2K encoding servers */
101 int server_port_base () const {
102 return _server_port_base;
105 void set_use_any_servers (bool u) {
106 _use_any_servers = u;
107 changed (USE_ANY_SERVERS);
110 bool use_any_servers () const {
111 return _use_any_servers;
114 /** @param s New list of servers */
115 void set_servers (std::vector<std::string> s) {
120 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
121 std::vector<std::string> servers () const {
125 bool only_servers_encode () const {
126 return _only_servers_encode;
129 FileTransferProtocol tms_protocol () const {
130 return _tms_protocol;
133 bool tms_passive() const {
137 /** @return The IP address of a TMS that we can copy DCPs to */
138 std::string tms_ip () const {
142 /** @return The path on a TMS that we should changed DCPs to */
143 std::string tms_path () const {
147 /** @return User name to log into the TMS with */
148 std::string tms_user () const {
152 /** @return Password to log into the TMS with */
153 std::string tms_password () const {
154 return _tms_password;
157 std::list<std::shared_ptr<Cinema>> cinemas () const {
161 std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
162 return _dkdm_recipients;
165 std::list<int> allowed_dcp_frame_rates () const {
166 return _allowed_dcp_frame_rates;
169 bool allow_any_dcp_frame_rate () const {
170 return _allow_any_dcp_frame_rate;
173 bool allow_any_container () const {
174 return _allow_any_container;
177 bool allow_96khz_audio () const {
178 return _allow_96khz_audio;
181 bool use_all_audio_channels () const {
182 return _use_all_audio_channels;
185 bool show_experimental_audio_processors () const {
186 return _show_experimental_audio_processors;
189 boost::optional<std::string> language () const {
193 int default_still_length () const {
194 return _default_still_length;
197 DCPContentType const * default_dcp_content_type () const {
198 return _default_dcp_content_type;
201 int default_dcp_audio_channels () const {
202 return _default_dcp_audio_channels;
205 std::string dcp_issuer () const {
209 std::string dcp_creator () const {
213 std::string dcp_company_name () const {
214 return _dcp_company_name;
217 std::string dcp_product_name () const {
218 return _dcp_product_name;
221 std::string dcp_product_version () const {
222 return _dcp_product_version;
225 std::string dcp_j2k_comment () const {
226 return _dcp_j2k_comment;
229 int default_j2k_bandwidth () const {
230 return _default_j2k_bandwidth;
233 int default_audio_delay () const {
234 return _default_audio_delay;
237 bool default_interop () const {
238 return _default_interop;
241 boost::optional<dcp::LanguageTag> default_audio_language() const {
242 return _default_audio_language;
245 boost::optional<dcp::LanguageTag::RegionSubtag> default_territory() const {
246 return _default_territory;
249 std::map<std::string, std::string> default_metadata () const {
250 return _default_metadata;
253 bool upload_after_make_dcp () {
254 return _upload_after_make_dcp;
257 void set_default_kdm_directory (boost::filesystem::path d) {
258 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
261 _default_kdm_directory = d;
265 std::string mail_server () const {
269 int mail_port () const {
273 EmailProtocol mail_protocol () const {
274 return _mail_protocol;
277 std::string mail_user () const {
281 std::string mail_password () const {
282 return _mail_password;
285 std::string kdm_subject () const {
289 std::string kdm_from () const {
293 std::vector<std::string> kdm_cc () const {
297 std::string kdm_bcc () const {
301 std::string kdm_email () const {
305 std::string notification_subject () const {
306 return _notification_subject;
309 std::string notification_from () const {
310 return _notification_from;
313 std::string notification_to () const {
314 return _notification_to;
317 std::vector<std::string> notification_cc () const {
318 return _notification_cc;
321 std::string notification_bcc () const {
322 return _notification_bcc;
325 std::string notification_email () const {
326 return _notification_email;
329 std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
330 return _signer_chain;
333 std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
334 return _decryption_chain;
337 bool check_for_updates () const {
338 return _check_for_updates;
341 bool check_for_test_updates () const {
342 return _check_for_test_updates;
345 int maximum_j2k_bandwidth () const {
346 return _maximum_j2k_bandwidth;
349 int log_types () const {
353 bool analyse_ebur128 () const {
354 return _analyse_ebur128;
357 bool automatic_audio_analysis () const {
358 return _automatic_audio_analysis;
361 #ifdef DCPOMATIC_WINDOWS
362 bool win32_console () const {
363 return _win32_console;
367 std::vector<boost::filesystem::path> history () const {
371 std::vector<boost::filesystem::path> player_history () const {
372 return _player_history;
375 std::shared_ptr<DKDMGroup> dkdms () const {
379 boost::filesystem::path cinemas_file () const {
380 return _cinemas_file;
383 boost::filesystem::path dkdm_recipients_file () const {
384 return _dkdm_recipients_file;
387 bool show_hints_before_make_dcp () const {
388 return _show_hints_before_make_dcp;
391 bool confirm_kdm_email () const {
392 return _confirm_kdm_email;
395 dcp::NameFormat kdm_container_name_format () const {
396 return _kdm_container_name_format;
399 dcp::NameFormat kdm_filename_format () const {
400 return _kdm_filename_format;
403 dcp::NameFormat dkdm_filename_format () const {
404 return _dkdm_filename_format;
407 dcp::NameFormat dcp_metadata_filename_format () const {
408 return _dcp_metadata_filename_format;
411 dcp::NameFormat dcp_asset_filename_format () const {
412 return _dcp_asset_filename_format;
415 bool jump_to_selected () const {
416 return _jump_to_selected;
419 /* This could be an enum class but we use the enum a lot to index _nagged
420 * so it means a lot of casts.
424 NAG_ENCRYPTED_METADATA,
425 NAG_ALTER_DECRYPTION_CHAIN,
426 NAG_BAD_SIGNER_CHAIN_UTF8,
427 NAG_IMPORT_DECRYPTION_CHAIN,
430 NAG_TOO_MANY_DROPPED_FRAMES,
431 NAG_BAD_SIGNER_CHAIN_VALIDITY,
435 bool nagged (Nag nag) const {
439 bool sound () const {
443 std::string cover_sheet () const {
447 boost::optional<std::string> sound_output () const {
448 return _sound_output;
451 boost::optional<boost::filesystem::path> last_player_load_directory () const {
452 return _last_player_load_directory;
461 boost::optional<KDMWriteType> last_kdm_write_type () const {
462 return _last_kdm_write_type;
470 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
471 return _last_dkdm_write_type;
474 int frames_in_memory_multiplier () const {
475 return _frames_in_memory_multiplier;
478 boost::optional<int> decode_reduction () const {
479 return _decode_reduction;
482 bool default_notify () const {
483 return _default_notify;
492 bool notification (Notification n) const {
493 return _notification[n];
496 boost::optional<std::string> barco_username () const {
497 return _barco_username;
500 boost::optional<std::string> barco_password () const {
501 return _barco_password;
504 boost::optional<std::string> christie_username () const {
505 return _christie_username;
508 boost::optional<std::string> christie_password () const {
509 return _christie_password;
512 boost::optional<std::string> gdc_username () const {
513 return _gdc_username;
516 boost::optional<std::string> gdc_password () const {
517 return _gdc_password;
521 PLAYER_MODE_WINDOW, ///< one window containing image and controls
522 PLAYER_MODE_FULL, ///< just the image filling the screen
523 PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
526 PlayerMode player_mode () const {
530 int image_display () const {
531 return _image_display;
539 VideoViewType video_view_type () const {
540 return _video_view_type;
543 bool respect_kdm_validity_periods () const {
544 return _respect_kdm_validity_periods;
547 boost::optional<boost::filesystem::path> player_debug_log_file () const {
548 return _player_debug_log_file;
551 boost::optional<boost::filesystem::path> player_content_directory () const {
552 return _player_content_directory;
555 boost::optional<boost::filesystem::path> player_playlist_directory () const {
556 return _player_playlist_directory;
559 boost::optional<boost::filesystem::path> player_kdm_directory () const {
560 return _player_kdm_directory;
563 AudioMapping audio_mapping (int output_channels);
565 std::vector<dcp::LanguageTag> custom_languages () const {
566 return _custom_languages;
569 boost::optional<boost::filesystem::path> initial_path(std::string id) const;
571 bool use_isdcf_name_by_default () const {
572 return _use_isdcf_name_by_default;
575 bool write_kdms_to_disk () const {
576 return _write_kdms_to_disk;
579 bool email_kdms () const {
583 dcp::Formulation default_kdm_type () const {
584 return _default_kdm_type;
587 RoughDuration default_kdm_duration () const {
588 return _default_kdm_duration;
591 double auto_crop_threshold () const {
592 return _auto_crop_threshold;
595 boost::optional<std::string> last_release_notes_version () const {
596 return _last_release_notes_version;
599 boost::optional<int> main_divider_sash_position() const {
600 return _main_divider_sash_position;
603 boost::optional<int> main_content_divider_sash_position() const {
604 return _main_content_divider_sash_position;
607 enum class DefaultAddFileLocation {
612 DefaultAddFileLocation default_add_file_location() const {
613 return _default_add_file_location;
616 bool allow_smpte_bv20() const {
617 return _allow_smpte_bv20;
622 void set_master_encoding_threads (int n) {
623 maybe_set (_master_encoding_threads, n);
626 void set_server_encoding_threads (int n) {
627 maybe_set (_server_encoding_threads, n);
630 void set_default_directory (boost::filesystem::path d) {
631 if (_default_directory && *_default_directory == d) {
634 _default_directory = d;
638 /** @param p New server port */
639 void set_server_port_base (int p) {
640 maybe_set (_server_port_base, p);
643 void set_only_servers_encode (bool o) {
644 maybe_set (_only_servers_encode, o);
647 void set_tms_protocol (FileTransferProtocol p) {
648 maybe_set (_tms_protocol, p);
651 void set_tms_passive(bool passive) {
652 maybe_set(_tms_passive, passive);
655 /** @param i IP address of a TMS that we can copy DCPs to */
656 void set_tms_ip (std::string i) {
657 maybe_set (_tms_ip, i);
660 /** @param p Path on a TMS that we should changed DCPs to */
661 void set_tms_path (std::string p) {
662 maybe_set (_tms_path, p);
665 /** @param u User name to log into the TMS with */
666 void set_tms_user (std::string u) {
667 maybe_set (_tms_user, u);
670 /** @param p Password to log into the TMS with */
671 void set_tms_password (std::string p) {
672 maybe_set (_tms_password, p);
675 void add_cinema (std::shared_ptr<Cinema> c) {
676 _cinemas.push_back (c);
680 void remove_cinema (std::shared_ptr<Cinema> c) {
685 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
686 _dkdm_recipients.push_back (c);
687 changed (DKDM_RECIPIENTS);
690 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
691 _dkdm_recipients.remove (c);
692 changed (DKDM_RECIPIENTS);
695 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
696 maybe_set (_allowed_dcp_frame_rates, r);
699 void set_allow_any_dcp_frame_rate (bool a) {
700 maybe_set (_allow_any_dcp_frame_rate, a);
703 void set_allow_any_container (bool a) {
704 maybe_set (_allow_any_container, a);
707 void set_allow_96hhz_audio (bool a) {
708 maybe_set (_allow_96khz_audio, a);
711 void set_use_all_audio_channels (bool a) {
712 maybe_set (_use_all_audio_channels, a);
715 void set_show_experimental_audio_processors (bool e) {
716 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
719 void set_language (std::string l) {
720 if (_language && _language.get() == l) {
727 void unset_language () {
732 _language = boost::none;
736 void set_default_still_length (int s) {
737 maybe_set (_default_still_length, s);
740 void set_default_dcp_content_type (DCPContentType const * t) {
741 maybe_set (_default_dcp_content_type, t);
744 void set_default_dcp_audio_channels (int c) {
745 maybe_set (_default_dcp_audio_channels, c);
748 void set_dcp_issuer (std::string i) {
749 maybe_set (_dcp_issuer, i);
752 void set_dcp_creator (std::string c) {
753 maybe_set (_dcp_creator, c);
756 void set_dcp_company_name (std::string c) {
757 maybe_set (_dcp_company_name, c);
760 void set_dcp_product_name (std::string c) {
761 maybe_set (_dcp_product_name, c);
764 void set_dcp_product_version (std::string c) {
765 maybe_set (_dcp_product_version, c);
768 void set_dcp_j2k_comment (std::string c) {
769 maybe_set (_dcp_j2k_comment, c);
772 void set_default_j2k_bandwidth (int b) {
773 maybe_set (_default_j2k_bandwidth, b);
776 void set_default_audio_delay (int d) {
777 maybe_set (_default_audio_delay, d);
780 void set_default_interop (bool i) {
781 maybe_set (_default_interop, i);
784 void set_default_audio_language(dcp::LanguageTag tag) {
785 maybe_set(_default_audio_language, tag);
788 void unset_default_audio_language() {
789 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
792 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
793 maybe_set(_default_territory, tag);
796 void unset_default_territory() {
797 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
800 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
801 maybe_set (_default_metadata, metadata);
804 void set_upload_after_make_dcp (bool u) {
805 maybe_set (_upload_after_make_dcp, u);
808 void set_mail_server (std::string s) {
809 maybe_set (_mail_server, s);
812 void set_mail_port (int p) {
813 maybe_set (_mail_port, p);
816 void set_mail_protocol (EmailProtocol p) {
817 maybe_set (_mail_protocol, p);
820 void set_mail_user (std::string u) {
821 maybe_set (_mail_user, u);
824 void set_mail_password (std::string p) {
825 maybe_set (_mail_password, p);
828 void set_kdm_subject (std::string s) {
829 maybe_set (_kdm_subject, s);
832 void set_kdm_from (std::string f) {
833 maybe_set (_kdm_from, f);
836 void set_kdm_cc (std::vector<std::string> f) {
837 maybe_set (_kdm_cc, f);
840 void set_kdm_bcc (std::string f) {
841 maybe_set (_kdm_bcc, f);
844 void set_kdm_email (std::string e) {
845 maybe_set (_kdm_email, e);
848 void reset_kdm_email ();
850 void set_notification_subject (std::string s) {
851 maybe_set (_notification_subject, s);
854 void set_notification_from (std::string f) {
855 maybe_set (_notification_from, f);
858 void set_notification_to (std::string t) {
859 maybe_set (_notification_to, t);
862 void set_notification_cc (std::vector<std::string> f) {
863 maybe_set (_notification_cc, f);
866 void set_notification_bcc (std::string f) {
867 maybe_set (_notification_bcc, f);
870 void set_notification_email (std::string e) {
871 maybe_set (_notification_email, e);
874 void reset_notification_email ();
876 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
877 maybe_set (_signer_chain, s);
880 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
881 maybe_set (_decryption_chain, c);
884 void set_check_for_updates (bool c) {
885 maybe_set (_check_for_updates, c);
887 set_check_for_test_updates (false);
891 void set_check_for_test_updates (bool c) {
892 maybe_set (_check_for_test_updates, c);
895 void set_maximum_j2k_bandwidth (int b) {
896 maybe_set (_maximum_j2k_bandwidth, b);
899 void set_log_types (int t) {
900 maybe_set (_log_types, t);
903 void set_analyse_ebur128 (bool a) {
904 maybe_set (_analyse_ebur128, a);
907 void set_automatic_audio_analysis (bool a) {
908 maybe_set (_automatic_audio_analysis, a);
911 #ifdef DCPOMATIC_WINDOWS
912 void set_win32_console (bool c) {
913 maybe_set (_win32_console, c);
917 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
922 void set_cinemas_file (boost::filesystem::path file);
924 void set_show_hints_before_make_dcp (bool s) {
925 maybe_set (_show_hints_before_make_dcp, s);
928 void set_confirm_kdm_email (bool s) {
929 maybe_set (_confirm_kdm_email, s);
932 void set_sound (bool s) {
933 maybe_set (_sound, s, SOUND);
936 void set_sound_output (std::string o) {
937 maybe_set (_sound_output, o, SOUND_OUTPUT);
940 void set_last_player_load_directory (boost::filesystem::path d) {
941 maybe_set (_last_player_load_directory, d);
944 void set_last_kdm_write_type (KDMWriteType t) {
945 maybe_set (_last_kdm_write_type, t);
948 void set_last_dkdm_write_type (DKDMWriteType t) {
949 maybe_set (_last_dkdm_write_type, t);
952 void unset_sound_output () {
953 if (!_sound_output) {
957 _sound_output = boost::none;
961 void set_kdm_container_name_format (dcp::NameFormat n) {
962 maybe_set (_kdm_container_name_format, n);
965 void set_kdm_filename_format (dcp::NameFormat n) {
966 maybe_set (_kdm_filename_format, n);
969 void set_dkdm_filename_format (dcp::NameFormat n) {
970 maybe_set (_dkdm_filename_format, n);
973 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
974 maybe_set (_dcp_metadata_filename_format, n);
977 void set_dcp_asset_filename_format (dcp::NameFormat n) {
978 maybe_set (_dcp_asset_filename_format, n);
981 void set_frames_in_memory_multiplier (int m) {
982 maybe_set (_frames_in_memory_multiplier, m);
985 void set_decode_reduction (boost::optional<int> r) {
986 maybe_set (_decode_reduction, r);
989 void set_default_notify (bool n) {
990 maybe_set (_default_notify, n);
993 void clear_history () {
998 void clear_player_history () {
999 _player_history.clear ();
1003 void add_to_history (boost::filesystem::path p);
1004 void clean_history ();
1005 void add_to_player_history (boost::filesystem::path p);
1006 void clean_player_history ();
1008 void set_jump_to_selected (bool j) {
1009 maybe_set (_jump_to_selected, j);
1012 void set_nagged (Nag nag, bool nagged) {
1013 maybe_set (_nagged[nag], nagged);
1016 void set_cover_sheet (std::string s) {
1017 maybe_set (_cover_sheet, s);
1020 void reset_cover_sheet ();
1022 void set_notification (Notification n, bool v) {
1023 maybe_set (_notification[n], v);
1026 void set_barco_username (std::string u) {
1027 maybe_set (_barco_username, u);
1030 void unset_barco_username () {
1031 maybe_set (_barco_username, boost::optional<std::string>());
1034 void set_barco_password (std::string p) {
1035 maybe_set (_barco_password, p);
1038 void unset_barco_password () {
1039 maybe_set (_barco_password, boost::optional<std::string>());
1042 void set_christie_username (std::string u) {
1043 maybe_set (_christie_username, u);
1046 void unset_christie_username () {
1047 maybe_set (_christie_username, boost::optional<std::string>());
1050 void set_christie_password (std::string p) {
1051 maybe_set (_christie_password, p);
1054 void unset_christie_password () {
1055 maybe_set (_christie_password, boost::optional<std::string>());
1058 void set_gdc_username (std::string u) {
1059 maybe_set (_gdc_username, u);
1062 void unset_gdc_username () {
1063 maybe_set (_gdc_username, boost::optional<std::string>());
1066 void set_gdc_password (std::string p) {
1067 maybe_set (_gdc_password, p);
1070 void unset_gdc_password () {
1071 maybe_set (_gdc_password, boost::optional<std::string>());
1074 void set_player_mode (PlayerMode m) {
1075 maybe_set (_player_mode, m);
1078 void set_image_display (int n) {
1079 maybe_set (_image_display, n);
1082 void set_video_view_type (VideoViewType v) {
1083 maybe_set (_video_view_type, v);
1086 void set_respect_kdm_validity_periods (bool r) {
1087 maybe_set (_respect_kdm_validity_periods, r);
1090 void set_player_debug_log_file (boost::filesystem::path p) {
1091 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1094 void unset_player_debug_log_file () {
1095 if (!_player_debug_log_file) {
1098 _player_debug_log_file = boost::none;
1099 changed (PLAYER_DEBUG_LOG);
1102 void set_player_content_directory (boost::filesystem::path p) {
1103 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1106 void unset_player_content_directory () {
1107 if (!_player_content_directory) {
1110 _player_content_directory = boost::none;
1111 changed (PLAYER_CONTENT_DIRECTORY);
1114 void set_player_playlist_directory (boost::filesystem::path p) {
1115 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1118 void unset_player_playlist_directory () {
1119 if (!_player_playlist_directory) {
1122 _player_playlist_directory = boost::none;
1123 changed (PLAYER_PLAYLIST_DIRECTORY);
1126 void set_player_kdm_directory (boost::filesystem::path p) {
1127 maybe_set (_player_kdm_directory, p);
1130 void unset_player_kdm_directory () {
1131 if (!_player_kdm_directory) {
1134 _player_kdm_directory = boost::none;
1138 void set_audio_mapping (AudioMapping m);
1139 void set_audio_mapping_to_default ();
1141 void add_custom_language (dcp::LanguageTag tag);
1143 void set_initial_path(std::string id, boost::filesystem::path path);
1145 void set_use_isdcf_name_by_default (bool use) {
1146 maybe_set (_use_isdcf_name_by_default, use);
1149 void set_write_kdms_to_disk (bool write) {
1150 maybe_set (_write_kdms_to_disk, write);
1153 void set_email_kdms (bool email) {
1154 maybe_set (_email_kdms, email);
1157 void set_default_kdm_type (dcp::Formulation type) {
1158 maybe_set (_default_kdm_type, type);
1161 void set_default_kdm_duration (RoughDuration duration) {
1162 maybe_set (_default_kdm_duration, duration);
1165 void set_auto_crop_threshold (double threshold) {
1166 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1169 void set_last_release_notes_version (std::string version) {
1170 maybe_set (_last_release_notes_version, version);
1173 void unset_last_release_notes_version() {
1174 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1177 ExportConfig& export_config() {
1181 void set_main_divider_sash_position(int position) {
1182 maybe_set(_main_divider_sash_position, position);
1185 void set_main_content_divider_sash_position(int position) {
1186 maybe_set(_main_content_divider_sash_position, position);
1189 void set_default_add_file_location(DefaultAddFileLocation location) {
1190 maybe_set(_default_add_file_location, location);
1193 void set_allow_smpte_bv20(bool allow) {
1194 maybe_set(_allow_smpte_bv20, allow, ALLOW_SMPTE_BV20);
1197 void changed (Property p = OTHER);
1198 boost::signals2::signal<void (Property)> Changed;
1199 /** Emitted if read() failed on an existing Config file. There is nothing
1200 a listener can do about it: this is just for information.
1202 enum class LoadFailure {
1207 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1208 /** Emitted if read() issued a warning which the user might want to know about */
1209 static boost::signals2::signal<void (std::string)> Warning;
1210 /** Emitted if there is a something wrong the contents of our config. Handler can call
1211 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1214 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1215 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1216 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1217 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1220 static boost::signals2::signal<bool (BadReason)> Bad;
1222 void write () const override;
1223 void write_config () const;
1224 void write_cinemas () const;
1225 void write_dkdm_recipients () const;
1226 void link (boost::filesystem::path new_file) const;
1227 void copy_and_link (boost::filesystem::path new_file) const;
1228 bool have_write_permission () const;
1230 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1231 bool existing_template (std::string name) const;
1232 std::list<std::string> templates () const;
1233 boost::filesystem::path template_read_path (std::string name) const;
1234 boost::filesystem::path template_write_path (std::string name) const;
1235 void rename_template (std::string old_name, std::string new_name) const;
1236 void delete_template (std::string name) const;
1238 boost::optional<BadReason> check_certificates () const;
1240 static Config* instance ();
1241 static void drop ();
1242 static void restore_defaults ();
1243 static bool have_existing (std::string);
1244 static boost::filesystem::path config_read_file ();
1245 static boost::filesystem::path config_write_file ();
1248 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1249 if (member == new_value) {
1257 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1258 if (member && member.get() == new_value) {
1267 void read () override;
1269 void read_cinemas();
1270 void read_dkdm_recipients();
1271 void set_defaults ();
1272 void set_kdm_email_to_default ();
1273 void set_notification_email_to_default ();
1274 void set_cover_sheet_to_default ();
1275 void read_cinemas (cxml::Document const & f);
1276 void read_dkdm_recipients (cxml::Document const & f);
1277 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1278 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1279 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1280 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1283 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1284 int _master_encoding_threads;
1285 /** number of threads which a server should use for J2K encoding on the local machine */
1286 int _server_encoding_threads;
1287 /** default directory to put new films in */
1288 boost::optional<boost::filesystem::path> _default_directory;
1289 /** base port number to use for J2K encoding servers;
1290 * this port and the two above it will be used.
1292 int _server_port_base;
1293 /** true to broadcast on the `any' address to look for servers */
1294 bool _use_any_servers;
1295 /** J2K encoding servers that should definitely be used */
1296 std::vector<std::string> _servers;
1297 bool _only_servers_encode;
1298 FileTransferProtocol _tms_protocol;
1300 /** The IP address of a TMS that we can copy DCPs to */
1301 std::string _tms_ip;
1302 /** The path on a TMS that we should write DCPs to */
1303 std::string _tms_path;
1304 /** User name to log into the TMS with */
1305 std::string _tms_user;
1306 /** Password to log into the TMS with */
1307 std::string _tms_password;
1308 /** The list of possible DCP frame rates that DCP-o-matic will use */
1309 std::list<int> _allowed_dcp_frame_rates;
1310 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1311 bool _allow_any_dcp_frame_rate;
1312 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1313 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1314 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1316 bool _allow_any_container;
1317 bool _allow_96khz_audio;
1318 bool _use_all_audio_channels;
1319 /** Offer the upmixers in the audio processor settings */
1320 bool _show_experimental_audio_processors;
1321 boost::optional<std::string> _language;
1322 /** Default length of still image content (seconds) */
1323 int _default_still_length;
1324 DCPContentType const * _default_dcp_content_type;
1325 int _default_dcp_audio_channels;
1326 std::string _dcp_issuer;
1327 std::string _dcp_creator;
1328 std::string _dcp_company_name;
1329 std::string _dcp_product_name;
1330 std::string _dcp_product_version;
1331 std::string _dcp_j2k_comment;
1332 int _default_j2k_bandwidth;
1333 int _default_audio_delay;
1334 bool _default_interop;
1335 boost::optional<dcp::LanguageTag> _default_audio_language;
1336 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1337 std::map<std::string, std::string> _default_metadata;
1338 /** Default directory to offer to write KDMs to; if it's not set,
1339 the home directory will be offered.
1341 boost::optional<boost::filesystem::path> _default_kdm_directory;
1342 bool _upload_after_make_dcp;
1343 std::list<std::shared_ptr<Cinema>> _cinemas;
1344 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1345 std::string _mail_server;
1347 EmailProtocol _mail_protocol;
1348 std::string _mail_user;
1349 std::string _mail_password;
1350 std::string _kdm_subject;
1351 std::string _kdm_from;
1352 std::vector<std::string> _kdm_cc;
1353 std::string _kdm_bcc;
1354 std::string _kdm_email;
1355 std::string _notification_subject;
1356 std::string _notification_from;
1357 std::string _notification_to;
1358 std::vector<std::string> _notification_cc;
1359 std::string _notification_bcc;
1360 std::string _notification_email;
1361 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1362 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1363 * certificate for making KDMs given to DCP-o-matic.
1365 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1366 /** true to check for updates on startup */
1367 bool _check_for_updates;
1368 bool _check_for_test_updates;
1369 /** maximum allowed J2K bandwidth in bits per second */
1370 int _maximum_j2k_bandwidth;
1372 bool _analyse_ebur128;
1373 bool _automatic_audio_analysis;
1374 #ifdef DCPOMATIC_WINDOWS
1375 bool _win32_console;
1377 std::vector<boost::filesystem::path> _history;
1378 std::vector<boost::filesystem::path> _player_history;
1379 std::shared_ptr<DKDMGroup> _dkdms;
1380 boost::filesystem::path _cinemas_file;
1381 boost::filesystem::path _dkdm_recipients_file;
1382 bool _show_hints_before_make_dcp;
1383 bool _confirm_kdm_email;
1384 dcp::NameFormat _kdm_filename_format;
1385 dcp::NameFormat _dkdm_filename_format;
1386 dcp::NameFormat _kdm_container_name_format;
1387 dcp::NameFormat _dcp_metadata_filename_format;
1388 dcp::NameFormat _dcp_asset_filename_format;
1389 bool _jump_to_selected;
1390 bool _nagged[NAG_COUNT];
1392 /** name of a specific sound output stream to use, or empty to use the default */
1393 boost::optional<std::string> _sound_output;
1394 std::string _cover_sheet;
1395 boost::optional<boost::filesystem::path> _last_player_load_directory;
1396 boost::optional<KDMWriteType> _last_kdm_write_type;
1397 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1398 int _frames_in_memory_multiplier;
1399 boost::optional<int> _decode_reduction;
1400 bool _default_notify;
1401 bool _notification[NOTIFICATION_COUNT];
1402 boost::optional<std::string> _barco_username;
1403 boost::optional<std::string> _barco_password;
1404 boost::optional<std::string> _christie_username;
1405 boost::optional<std::string> _christie_password;
1406 boost::optional<std::string> _gdc_username;
1407 boost::optional<std::string> _gdc_password;
1408 PlayerMode _player_mode;
1410 VideoViewType _video_view_type;
1411 bool _respect_kdm_validity_periods;
1412 /** Log file containing debug information for the player */
1413 boost::optional<boost::filesystem::path> _player_debug_log_file;
1414 /** A directory containing DCPs whose contents are presented to the user
1415 in the dual-screen player mode. DCPs on the list can be loaded
1418 boost::optional<boost::filesystem::path> _player_content_directory;
1419 boost::optional<boost::filesystem::path> _player_playlist_directory;
1420 boost::optional<boost::filesystem::path> _player_kdm_directory;
1421 boost::optional<AudioMapping> _audio_mapping;
1422 std::vector<dcp::LanguageTag> _custom_languages;
1423 std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
1424 bool _use_isdcf_name_by_default;
1425 bool _write_kdms_to_disk;
1427 dcp::Formulation _default_kdm_type;
1428 RoughDuration _default_kdm_duration;
1429 double _auto_crop_threshold;
1430 boost::optional<std::string> _last_release_notes_version;
1431 boost::optional<int> _main_divider_sash_position;
1432 boost::optional<int> _main_content_divider_sash_position;
1433 DefaultAddFileLocation _default_add_file_location;
1434 bool _allow_smpte_bv20;
1436 ExportConfig _export;
1438 static int const _current_version;
1440 /** Singleton instance, or 0 */
1441 static Config* _instance;