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;
82 void load_from_zip(boost::filesystem::path zip_file);
91 PLAYER_CONTENT_DIRECTORY,
92 PLAYER_PLAYLIST_DIRECTORY,
95 SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
99 ISDCF_NAME_PART_LENGTH,
103 /** @return base port number to use for J2K encoding servers */
104 int server_port_base () const {
105 return _server_port_base;
108 void set_use_any_servers (bool u) {
109 _use_any_servers = u;
110 changed (USE_ANY_SERVERS);
113 bool use_any_servers () const {
114 return _use_any_servers;
117 /** @param s New list of servers */
118 void set_servers (std::vector<std::string> s) {
123 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
124 std::vector<std::string> servers () const {
128 bool only_servers_encode () const {
129 return _only_servers_encode;
132 FileTransferProtocol tms_protocol () const {
133 return _tms_protocol;
136 bool tms_passive() const {
140 /** @return The IP address of a TMS that we can copy DCPs to */
141 std::string tms_ip () const {
145 /** @return The path on a TMS that we should changed DCPs to */
146 std::string tms_path () const {
150 /** @return User name to log into the TMS with */
151 std::string tms_user () const {
155 /** @return Password to log into the TMS with */
156 std::string tms_password () const {
157 return _tms_password;
160 std::list<std::shared_ptr<Cinema>> cinemas () const {
164 std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
165 return _dkdm_recipients;
168 std::list<int> allowed_dcp_frame_rates () const {
169 return _allowed_dcp_frame_rates;
172 bool allow_any_dcp_frame_rate () const {
173 return _allow_any_dcp_frame_rate;
176 bool allow_any_container () const {
177 return _allow_any_container;
180 bool allow_96khz_audio () const {
181 return _allow_96khz_audio;
184 bool use_all_audio_channels () const {
185 return _use_all_audio_channels;
188 bool show_experimental_audio_processors () const {
189 return _show_experimental_audio_processors;
192 boost::optional<std::string> language () const {
196 int default_still_length () const {
197 return _default_still_length;
200 DCPContentType const * default_dcp_content_type () const {
201 return _default_dcp_content_type;
204 int default_dcp_audio_channels () const {
205 return _default_dcp_audio_channels;
208 std::string dcp_issuer () const {
212 std::string dcp_creator () const {
216 std::string dcp_company_name () const {
217 return _dcp_company_name;
220 std::string dcp_product_name () const {
221 return _dcp_product_name;
224 std::string dcp_product_version () const {
225 return _dcp_product_version;
228 std::string dcp_j2k_comment () const {
229 return _dcp_j2k_comment;
232 int default_j2k_bandwidth () const {
233 return _default_j2k_bandwidth;
236 int default_audio_delay () const {
237 return _default_audio_delay;
240 bool default_interop () const {
241 return _default_interop;
244 boost::optional<dcp::LanguageTag> default_audio_language() const {
245 return _default_audio_language;
248 boost::optional<dcp::LanguageTag::RegionSubtag> default_territory() const {
249 return _default_territory;
252 std::map<std::string, std::string> default_metadata () const {
253 return _default_metadata;
256 bool upload_after_make_dcp () {
257 return _upload_after_make_dcp;
260 void set_default_kdm_directory (boost::filesystem::path d) {
261 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
264 _default_kdm_directory = d;
268 std::string mail_server () const {
272 int mail_port () const {
276 EmailProtocol mail_protocol () const {
277 return _mail_protocol;
280 std::string mail_user () const {
284 std::string mail_password () const {
285 return _mail_password;
288 std::string kdm_subject () const {
292 std::string kdm_from () const {
296 std::vector<std::string> kdm_cc () const {
300 std::string kdm_bcc () const {
304 std::string kdm_email () const {
308 std::string notification_subject () const {
309 return _notification_subject;
312 std::string notification_from () const {
313 return _notification_from;
316 std::string notification_to () const {
317 return _notification_to;
320 std::vector<std::string> notification_cc () const {
321 return _notification_cc;
324 std::string notification_bcc () const {
325 return _notification_bcc;
328 std::string notification_email () const {
329 return _notification_email;
332 std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
333 return _signer_chain;
336 std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
337 return _decryption_chain;
340 bool check_for_updates () const {
341 return _check_for_updates;
344 bool check_for_test_updates () const {
345 return _check_for_test_updates;
348 int maximum_j2k_bandwidth () const {
349 return _maximum_j2k_bandwidth;
352 int log_types () const {
356 bool analyse_ebur128 () const {
357 return _analyse_ebur128;
360 bool automatic_audio_analysis () const {
361 return _automatic_audio_analysis;
364 #ifdef DCPOMATIC_WINDOWS
365 bool win32_console () const {
366 return _win32_console;
370 std::vector<boost::filesystem::path> history () const {
374 std::vector<boost::filesystem::path> player_history () const {
375 return _player_history;
378 std::shared_ptr<DKDMGroup> dkdms () const {
382 boost::filesystem::path cinemas_file () const {
383 return _cinemas_file;
386 boost::filesystem::path dkdm_recipients_file () const {
387 return _dkdm_recipients_file;
390 bool show_hints_before_make_dcp () const {
391 return _show_hints_before_make_dcp;
394 bool confirm_kdm_email () const {
395 return _confirm_kdm_email;
398 dcp::NameFormat kdm_container_name_format () const {
399 return _kdm_container_name_format;
402 dcp::NameFormat kdm_filename_format () const {
403 return _kdm_filename_format;
406 dcp::NameFormat dkdm_filename_format () const {
407 return _dkdm_filename_format;
410 dcp::NameFormat dcp_metadata_filename_format () const {
411 return _dcp_metadata_filename_format;
414 dcp::NameFormat dcp_asset_filename_format () const {
415 return _dcp_asset_filename_format;
418 bool jump_to_selected () const {
419 return _jump_to_selected;
422 /* This could be an enum class but we use the enum a lot to index _nagged
423 * so it means a lot of casts.
427 NAG_ENCRYPTED_METADATA,
428 NAG_ALTER_DECRYPTION_CHAIN,
429 NAG_BAD_SIGNER_CHAIN_UTF8,
430 NAG_IMPORT_DECRYPTION_CHAIN,
433 NAG_TOO_MANY_DROPPED_FRAMES,
434 NAG_BAD_SIGNER_CHAIN_VALIDITY,
435 NAG_BAD_SIGNER_DN_QUALIFIER,
439 bool nagged (Nag nag) const {
443 bool sound () const {
447 std::string cover_sheet () const {
451 boost::optional<std::string> sound_output () const {
452 return _sound_output;
455 boost::optional<boost::filesystem::path> last_player_load_directory () const {
456 return _last_player_load_directory;
465 boost::optional<KDMWriteType> last_kdm_write_type () const {
466 return _last_kdm_write_type;
474 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
475 return _last_dkdm_write_type;
478 int frames_in_memory_multiplier () const {
479 return _frames_in_memory_multiplier;
482 boost::optional<int> decode_reduction () const {
483 return _decode_reduction;
486 bool default_notify () const {
487 return _default_notify;
496 bool notification (Notification n) const {
497 return _notification[n];
500 boost::optional<std::string> barco_username () const {
501 return _barco_username;
504 boost::optional<std::string> barco_password () const {
505 return _barco_password;
508 boost::optional<std::string> christie_username () const {
509 return _christie_username;
512 boost::optional<std::string> christie_password () const {
513 return _christie_password;
516 boost::optional<std::string> gdc_username () const {
517 return _gdc_username;
520 boost::optional<std::string> gdc_password () const {
521 return _gdc_password;
525 PLAYER_MODE_WINDOW, ///< one window containing image and controls
526 PLAYER_MODE_FULL, ///< just the image filling the screen
527 PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
530 PlayerMode player_mode () const {
534 int image_display () const {
535 return _image_display;
543 VideoViewType video_view_type () const {
544 return _video_view_type;
547 bool respect_kdm_validity_periods () const {
548 return _respect_kdm_validity_periods;
551 boost::optional<boost::filesystem::path> player_debug_log_file () const {
552 return _player_debug_log_file;
555 boost::optional<boost::filesystem::path> player_content_directory () const {
556 return _player_content_directory;
559 boost::optional<boost::filesystem::path> player_playlist_directory () const {
560 return _player_playlist_directory;
563 boost::optional<boost::filesystem::path> player_kdm_directory () const {
564 return _player_kdm_directory;
567 AudioMapping audio_mapping (int output_channels);
569 std::vector<dcp::LanguageTag> custom_languages () const {
570 return _custom_languages;
573 boost::optional<boost::filesystem::path> initial_path(std::string id) const;
575 bool use_isdcf_name_by_default () const {
576 return _use_isdcf_name_by_default;
579 bool write_kdms_to_disk () const {
580 return _write_kdms_to_disk;
583 bool email_kdms () const {
587 dcp::Formulation default_kdm_type () const {
588 return _default_kdm_type;
591 RoughDuration default_kdm_duration () const {
592 return _default_kdm_duration;
595 double auto_crop_threshold () const {
596 return _auto_crop_threshold;
599 boost::optional<std::string> last_release_notes_version () const {
600 return _last_release_notes_version;
603 boost::optional<int> main_divider_sash_position() const {
604 return _main_divider_sash_position;
607 boost::optional<int> main_content_divider_sash_position() const {
608 return _main_content_divider_sash_position;
611 enum class DefaultAddFileLocation {
616 DefaultAddFileLocation default_add_file_location() const {
617 return _default_add_file_location;
620 bool allow_smpte_bv20() const {
621 return _allow_smpte_bv20;
624 int isdcf_name_part_length() const {
625 return _isdcf_name_part_length;
630 void set_master_encoding_threads (int n) {
631 maybe_set (_master_encoding_threads, n);
634 void set_server_encoding_threads (int n) {
635 maybe_set (_server_encoding_threads, n);
638 void set_default_directory (boost::filesystem::path d) {
639 if (_default_directory && *_default_directory == d) {
642 _default_directory = d;
646 /** @param p New server port */
647 void set_server_port_base (int p) {
648 maybe_set (_server_port_base, p);
651 void set_only_servers_encode (bool o) {
652 maybe_set (_only_servers_encode, o);
655 void set_tms_protocol (FileTransferProtocol p) {
656 maybe_set (_tms_protocol, p);
659 void set_tms_passive(bool passive) {
660 maybe_set(_tms_passive, passive);
663 /** @param i IP address of a TMS that we can copy DCPs to */
664 void set_tms_ip (std::string i) {
665 maybe_set (_tms_ip, i);
668 /** @param p Path on a TMS that we should changed DCPs to */
669 void set_tms_path (std::string p) {
670 maybe_set (_tms_path, p);
673 /** @param u User name to log into the TMS with */
674 void set_tms_user (std::string u) {
675 maybe_set (_tms_user, u);
678 /** @param p Password to log into the TMS with */
679 void set_tms_password (std::string p) {
680 maybe_set (_tms_password, p);
683 void add_cinema (std::shared_ptr<Cinema> c) {
684 _cinemas.push_back (c);
688 void remove_cinema (std::shared_ptr<Cinema> c) {
693 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
694 _dkdm_recipients.push_back (c);
695 changed (DKDM_RECIPIENTS);
698 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
699 _dkdm_recipients.remove (c);
700 changed (DKDM_RECIPIENTS);
703 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
704 maybe_set (_allowed_dcp_frame_rates, r);
707 void set_allow_any_dcp_frame_rate (bool a) {
708 maybe_set (_allow_any_dcp_frame_rate, a);
711 void set_allow_any_container (bool a) {
712 maybe_set (_allow_any_container, a);
715 void set_allow_96hhz_audio (bool a) {
716 maybe_set (_allow_96khz_audio, a);
719 void set_use_all_audio_channels (bool a) {
720 maybe_set (_use_all_audio_channels, a);
723 void set_show_experimental_audio_processors (bool e) {
724 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
727 void set_language (std::string l) {
728 if (_language && _language.get() == l) {
735 void unset_language () {
740 _language = boost::none;
744 void set_default_still_length (int s) {
745 maybe_set (_default_still_length, s);
748 void set_default_dcp_content_type (DCPContentType const * t) {
749 maybe_set (_default_dcp_content_type, t);
752 void set_default_dcp_audio_channels (int c) {
753 maybe_set (_default_dcp_audio_channels, c);
756 void set_dcp_issuer (std::string i) {
757 maybe_set (_dcp_issuer, i);
760 void set_dcp_creator (std::string c) {
761 maybe_set (_dcp_creator, c);
764 void set_dcp_company_name (std::string c) {
765 maybe_set (_dcp_company_name, c);
768 void set_dcp_product_name (std::string c) {
769 maybe_set (_dcp_product_name, c);
772 void set_dcp_product_version (std::string c) {
773 maybe_set (_dcp_product_version, c);
776 void set_dcp_j2k_comment (std::string c) {
777 maybe_set (_dcp_j2k_comment, c);
780 void set_default_j2k_bandwidth (int b) {
781 maybe_set (_default_j2k_bandwidth, b);
784 void set_default_audio_delay (int d) {
785 maybe_set (_default_audio_delay, d);
788 void set_default_interop (bool i) {
789 maybe_set (_default_interop, i);
792 void set_default_audio_language(dcp::LanguageTag tag) {
793 maybe_set(_default_audio_language, tag);
796 void unset_default_audio_language() {
797 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
800 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
801 maybe_set(_default_territory, tag);
804 void unset_default_territory() {
805 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
808 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
809 maybe_set (_default_metadata, metadata);
812 void set_upload_after_make_dcp (bool u) {
813 maybe_set (_upload_after_make_dcp, u);
816 void set_mail_server (std::string s) {
817 maybe_set (_mail_server, s);
820 void set_mail_port (int p) {
821 maybe_set (_mail_port, p);
824 void set_mail_protocol (EmailProtocol p) {
825 maybe_set (_mail_protocol, p);
828 void set_mail_user (std::string u) {
829 maybe_set (_mail_user, u);
832 void set_mail_password (std::string p) {
833 maybe_set (_mail_password, p);
836 void set_kdm_subject (std::string s) {
837 maybe_set (_kdm_subject, s);
840 void set_kdm_from (std::string f) {
841 maybe_set (_kdm_from, f);
844 void set_kdm_cc (std::vector<std::string> f) {
845 maybe_set (_kdm_cc, f);
848 void set_kdm_bcc (std::string f) {
849 maybe_set (_kdm_bcc, f);
852 void set_kdm_email (std::string e) {
853 maybe_set (_kdm_email, e);
856 void reset_kdm_email ();
858 void set_notification_subject (std::string s) {
859 maybe_set (_notification_subject, s);
862 void set_notification_from (std::string f) {
863 maybe_set (_notification_from, f);
866 void set_notification_to (std::string t) {
867 maybe_set (_notification_to, t);
870 void set_notification_cc (std::vector<std::string> f) {
871 maybe_set (_notification_cc, f);
874 void set_notification_bcc (std::string f) {
875 maybe_set (_notification_bcc, f);
878 void set_notification_email (std::string e) {
879 maybe_set (_notification_email, e);
882 void reset_notification_email ();
884 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
885 maybe_set (_signer_chain, s);
888 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
889 maybe_set (_decryption_chain, c);
892 void set_check_for_updates (bool c) {
893 maybe_set (_check_for_updates, c);
895 set_check_for_test_updates (false);
899 void set_check_for_test_updates (bool c) {
900 maybe_set (_check_for_test_updates, c);
903 void set_maximum_j2k_bandwidth (int b) {
904 maybe_set (_maximum_j2k_bandwidth, b);
907 void set_log_types (int t) {
908 maybe_set (_log_types, t);
911 void set_analyse_ebur128 (bool a) {
912 maybe_set (_analyse_ebur128, a);
915 void set_automatic_audio_analysis (bool a) {
916 maybe_set (_automatic_audio_analysis, a);
919 #ifdef DCPOMATIC_WINDOWS
920 void set_win32_console (bool c) {
921 maybe_set (_win32_console, c);
925 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
930 void set_cinemas_file (boost::filesystem::path file);
932 void set_show_hints_before_make_dcp (bool s) {
933 maybe_set (_show_hints_before_make_dcp, s);
936 void set_confirm_kdm_email (bool s) {
937 maybe_set (_confirm_kdm_email, s);
940 void set_sound (bool s) {
941 maybe_set (_sound, s, SOUND);
944 void set_sound_output (std::string o) {
945 maybe_set (_sound_output, o, SOUND_OUTPUT);
948 void set_last_player_load_directory (boost::filesystem::path d) {
949 maybe_set (_last_player_load_directory, d);
952 void set_last_kdm_write_type (KDMWriteType t) {
953 maybe_set (_last_kdm_write_type, t);
956 void set_last_dkdm_write_type (DKDMWriteType t) {
957 maybe_set (_last_dkdm_write_type, t);
960 void unset_sound_output () {
961 if (!_sound_output) {
965 _sound_output = boost::none;
969 void set_kdm_container_name_format (dcp::NameFormat n) {
970 maybe_set (_kdm_container_name_format, n);
973 void set_kdm_filename_format (dcp::NameFormat n) {
974 maybe_set (_kdm_filename_format, n);
977 void set_dkdm_filename_format (dcp::NameFormat n) {
978 maybe_set (_dkdm_filename_format, n);
981 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
982 maybe_set (_dcp_metadata_filename_format, n);
985 void set_dcp_asset_filename_format (dcp::NameFormat n) {
986 maybe_set (_dcp_asset_filename_format, n);
989 void set_frames_in_memory_multiplier (int m) {
990 maybe_set (_frames_in_memory_multiplier, m);
993 void set_decode_reduction (boost::optional<int> r) {
994 maybe_set (_decode_reduction, r);
997 void set_default_notify (bool n) {
998 maybe_set (_default_notify, n);
1001 void clear_history () {
1006 void clear_player_history () {
1007 _player_history.clear ();
1011 void add_to_history (boost::filesystem::path p);
1012 void clean_history ();
1013 void add_to_player_history (boost::filesystem::path p);
1014 void clean_player_history ();
1016 void set_jump_to_selected (bool j) {
1017 maybe_set (_jump_to_selected, j);
1020 void set_nagged (Nag nag, bool nagged) {
1021 maybe_set (_nagged[nag], nagged);
1024 void set_cover_sheet (std::string s) {
1025 maybe_set (_cover_sheet, s);
1028 void reset_cover_sheet ();
1030 void set_notification (Notification n, bool v) {
1031 maybe_set (_notification[n], v);
1034 void set_barco_username (std::string u) {
1035 maybe_set (_barco_username, u);
1038 void unset_barco_username () {
1039 maybe_set (_barco_username, boost::optional<std::string>());
1042 void set_barco_password (std::string p) {
1043 maybe_set (_barco_password, p);
1046 void unset_barco_password () {
1047 maybe_set (_barco_password, boost::optional<std::string>());
1050 void set_christie_username (std::string u) {
1051 maybe_set (_christie_username, u);
1054 void unset_christie_username () {
1055 maybe_set (_christie_username, boost::optional<std::string>());
1058 void set_christie_password (std::string p) {
1059 maybe_set (_christie_password, p);
1062 void unset_christie_password () {
1063 maybe_set (_christie_password, boost::optional<std::string>());
1066 void set_gdc_username (std::string u) {
1067 maybe_set (_gdc_username, u);
1070 void unset_gdc_username () {
1071 maybe_set (_gdc_username, boost::optional<std::string>());
1074 void set_gdc_password (std::string p) {
1075 maybe_set (_gdc_password, p);
1078 void unset_gdc_password () {
1079 maybe_set (_gdc_password, boost::optional<std::string>());
1082 void set_player_mode (PlayerMode m) {
1083 maybe_set (_player_mode, m);
1086 void set_image_display (int n) {
1087 maybe_set (_image_display, n);
1090 void set_video_view_type (VideoViewType v) {
1091 maybe_set (_video_view_type, v);
1094 void set_respect_kdm_validity_periods (bool r) {
1095 maybe_set (_respect_kdm_validity_periods, r);
1098 void set_player_debug_log_file (boost::filesystem::path p) {
1099 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1102 void unset_player_debug_log_file () {
1103 if (!_player_debug_log_file) {
1106 _player_debug_log_file = boost::none;
1107 changed (PLAYER_DEBUG_LOG);
1110 void set_player_content_directory (boost::filesystem::path p) {
1111 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1114 void unset_player_content_directory () {
1115 if (!_player_content_directory) {
1118 _player_content_directory = boost::none;
1119 changed (PLAYER_CONTENT_DIRECTORY);
1122 void set_player_playlist_directory (boost::filesystem::path p) {
1123 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1126 void unset_player_playlist_directory () {
1127 if (!_player_playlist_directory) {
1130 _player_playlist_directory = boost::none;
1131 changed (PLAYER_PLAYLIST_DIRECTORY);
1134 void set_player_kdm_directory (boost::filesystem::path p) {
1135 maybe_set (_player_kdm_directory, p);
1138 void unset_player_kdm_directory () {
1139 if (!_player_kdm_directory) {
1142 _player_kdm_directory = boost::none;
1146 void set_audio_mapping (AudioMapping m);
1147 void set_audio_mapping_to_default ();
1149 void add_custom_language (dcp::LanguageTag tag);
1151 void set_initial_path(std::string id, boost::filesystem::path path);
1153 void set_use_isdcf_name_by_default (bool use) {
1154 maybe_set (_use_isdcf_name_by_default, use);
1157 void set_write_kdms_to_disk (bool write) {
1158 maybe_set (_write_kdms_to_disk, write);
1161 void set_email_kdms (bool email) {
1162 maybe_set (_email_kdms, email);
1165 void set_default_kdm_type (dcp::Formulation type) {
1166 maybe_set (_default_kdm_type, type);
1169 void set_default_kdm_duration (RoughDuration duration) {
1170 maybe_set (_default_kdm_duration, duration);
1173 void set_auto_crop_threshold (double threshold) {
1174 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1177 void set_last_release_notes_version (std::string version) {
1178 maybe_set (_last_release_notes_version, version);
1181 void unset_last_release_notes_version() {
1182 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1185 ExportConfig& export_config() {
1189 void set_main_divider_sash_position(int position) {
1190 maybe_set(_main_divider_sash_position, position);
1193 void set_main_content_divider_sash_position(int position) {
1194 maybe_set(_main_content_divider_sash_position, position);
1197 void set_default_add_file_location(DefaultAddFileLocation location) {
1198 maybe_set(_default_add_file_location, location);
1201 void set_allow_smpte_bv20(bool allow) {
1202 maybe_set(_allow_smpte_bv20, allow, ALLOW_SMPTE_BV20);
1205 void set_isdcf_name_part_length(int length) {
1206 maybe_set(_isdcf_name_part_length, length, ISDCF_NAME_PART_LENGTH);
1209 void changed (Property p = OTHER);
1210 boost::signals2::signal<void (Property)> Changed;
1211 /** Emitted if read() failed on an existing Config file. There is nothing
1212 a listener can do about it: this is just for information.
1214 enum class LoadFailure {
1219 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1220 /** Emitted if read() issued a warning which the user might want to know about */
1221 static boost::signals2::signal<void (std::string)> Warning;
1222 /** Emitted if there is a something wrong the contents of our config. Handler can call
1223 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1226 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1227 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1228 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1229 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1230 BAD_SIGNER_DN_QUALIFIER, ///< some signer certificate has a bad dnQualifier (DoM #2716).
1233 static boost::signals2::signal<bool (BadReason)> Bad;
1235 void write () const override;
1236 void write_config () const;
1237 void write_cinemas () const;
1238 void write_dkdm_recipients () const;
1239 void link (boost::filesystem::path new_file) const;
1240 void copy_and_link (boost::filesystem::path new_file) const;
1241 bool have_write_permission () const;
1243 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1244 bool existing_template (std::string name) const;
1245 std::list<std::string> templates () const;
1246 boost::filesystem::path template_read_path (std::string name) const;
1247 boost::filesystem::path template_write_path (std::string name) const;
1248 void rename_template (std::string old_name, std::string new_name) const;
1249 void delete_template (std::string name) const;
1251 boost::optional<BadReason> check_certificates () const;
1253 static Config* instance ();
1254 static void drop ();
1255 static void restore_defaults ();
1256 static bool have_existing (std::string);
1257 static boost::filesystem::path config_read_file ();
1258 static boost::filesystem::path config_write_file ();
1261 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1262 if (member == new_value) {
1270 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1271 if (member && member.get() == new_value) {
1280 void read () override;
1282 void read_cinemas();
1283 void read_dkdm_recipients();
1284 void set_defaults ();
1285 void set_kdm_email_to_default ();
1286 void set_notification_email_to_default ();
1287 void set_cover_sheet_to_default ();
1288 void read_cinemas (cxml::Document const & f);
1289 void read_dkdm_recipients (cxml::Document const & f);
1290 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1291 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1292 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1293 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1296 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1297 int _master_encoding_threads;
1298 /** number of threads which a server should use for J2K encoding on the local machine */
1299 int _server_encoding_threads;
1300 /** default directory to put new films in */
1301 boost::optional<boost::filesystem::path> _default_directory;
1302 /** base port number to use for J2K encoding servers;
1303 * this port and the two above it will be used.
1305 int _server_port_base;
1306 /** true to broadcast on the `any' address to look for servers */
1307 bool _use_any_servers;
1308 /** J2K encoding servers that should definitely be used */
1309 std::vector<std::string> _servers;
1310 bool _only_servers_encode;
1311 FileTransferProtocol _tms_protocol;
1313 /** The IP address of a TMS that we can copy DCPs to */
1314 std::string _tms_ip;
1315 /** The path on a TMS that we should write DCPs to */
1316 std::string _tms_path;
1317 /** User name to log into the TMS with */
1318 std::string _tms_user;
1319 /** Password to log into the TMS with */
1320 std::string _tms_password;
1321 /** The list of possible DCP frame rates that DCP-o-matic will use */
1322 std::list<int> _allowed_dcp_frame_rates;
1323 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1324 bool _allow_any_dcp_frame_rate;
1325 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1326 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1327 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1329 bool _allow_any_container;
1330 bool _allow_96khz_audio;
1331 bool _use_all_audio_channels;
1332 /** Offer the upmixers in the audio processor settings */
1333 bool _show_experimental_audio_processors;
1334 boost::optional<std::string> _language;
1335 /** Default length of still image content (seconds) */
1336 int _default_still_length;
1337 DCPContentType const * _default_dcp_content_type;
1338 int _default_dcp_audio_channels;
1339 std::string _dcp_issuer;
1340 std::string _dcp_creator;
1341 std::string _dcp_company_name;
1342 std::string _dcp_product_name;
1343 std::string _dcp_product_version;
1344 std::string _dcp_j2k_comment;
1345 int _default_j2k_bandwidth;
1346 int _default_audio_delay;
1347 bool _default_interop;
1348 boost::optional<dcp::LanguageTag> _default_audio_language;
1349 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1350 std::map<std::string, std::string> _default_metadata;
1351 /** Default directory to offer to write KDMs to; if it's not set,
1352 the home directory will be offered.
1354 boost::optional<boost::filesystem::path> _default_kdm_directory;
1355 bool _upload_after_make_dcp;
1356 std::list<std::shared_ptr<Cinema>> _cinemas;
1357 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1358 std::string _mail_server;
1360 EmailProtocol _mail_protocol;
1361 std::string _mail_user;
1362 std::string _mail_password;
1363 std::string _kdm_subject;
1364 std::string _kdm_from;
1365 std::vector<std::string> _kdm_cc;
1366 std::string _kdm_bcc;
1367 std::string _kdm_email;
1368 std::string _notification_subject;
1369 std::string _notification_from;
1370 std::string _notification_to;
1371 std::vector<std::string> _notification_cc;
1372 std::string _notification_bcc;
1373 std::string _notification_email;
1374 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1375 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1376 * certificate for making KDMs given to DCP-o-matic.
1378 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1379 /** true to check for updates on startup */
1380 bool _check_for_updates;
1381 bool _check_for_test_updates;
1382 /** maximum allowed J2K bandwidth in bits per second */
1383 int _maximum_j2k_bandwidth;
1385 bool _analyse_ebur128;
1386 bool _automatic_audio_analysis;
1387 #ifdef DCPOMATIC_WINDOWS
1388 bool _win32_console;
1390 std::vector<boost::filesystem::path> _history;
1391 std::vector<boost::filesystem::path> _player_history;
1392 std::shared_ptr<DKDMGroup> _dkdms;
1393 boost::filesystem::path _cinemas_file;
1394 boost::filesystem::path _dkdm_recipients_file;
1395 bool _show_hints_before_make_dcp;
1396 bool _confirm_kdm_email;
1397 dcp::NameFormat _kdm_filename_format;
1398 dcp::NameFormat _dkdm_filename_format;
1399 dcp::NameFormat _kdm_container_name_format;
1400 dcp::NameFormat _dcp_metadata_filename_format;
1401 dcp::NameFormat _dcp_asset_filename_format;
1402 bool _jump_to_selected;
1403 bool _nagged[NAG_COUNT];
1405 /** name of a specific sound output stream to use, or empty to use the default */
1406 boost::optional<std::string> _sound_output;
1407 std::string _cover_sheet;
1408 boost::optional<boost::filesystem::path> _last_player_load_directory;
1409 boost::optional<KDMWriteType> _last_kdm_write_type;
1410 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1411 int _frames_in_memory_multiplier;
1412 boost::optional<int> _decode_reduction;
1413 bool _default_notify;
1414 bool _notification[NOTIFICATION_COUNT];
1415 boost::optional<std::string> _barco_username;
1416 boost::optional<std::string> _barco_password;
1417 boost::optional<std::string> _christie_username;
1418 boost::optional<std::string> _christie_password;
1419 boost::optional<std::string> _gdc_username;
1420 boost::optional<std::string> _gdc_password;
1421 PlayerMode _player_mode;
1423 VideoViewType _video_view_type;
1424 bool _respect_kdm_validity_periods;
1425 /** Log file containing debug information for the player */
1426 boost::optional<boost::filesystem::path> _player_debug_log_file;
1427 /** A directory containing DCPs whose contents are presented to the user
1428 in the dual-screen player mode. DCPs on the list can be loaded
1431 boost::optional<boost::filesystem::path> _player_content_directory;
1432 boost::optional<boost::filesystem::path> _player_playlist_directory;
1433 boost::optional<boost::filesystem::path> _player_kdm_directory;
1434 boost::optional<AudioMapping> _audio_mapping;
1435 std::vector<dcp::LanguageTag> _custom_languages;
1436 std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
1437 bool _use_isdcf_name_by_default;
1438 bool _write_kdms_to_disk;
1440 dcp::Formulation _default_kdm_type;
1441 RoughDuration _default_kdm_duration;
1442 double _auto_crop_threshold;
1443 boost::optional<std::string> _last_release_notes_version;
1444 boost::optional<int> _main_divider_sash_position;
1445 boost::optional<int> _main_content_divider_sash_position;
1446 DefaultAddFileLocation _default_add_file_location;
1447 bool _allow_smpte_bv20;
1448 int _isdcf_name_part_length;
1450 ExportConfig _export;
1452 static int const _current_version;
1454 /** Singleton instance, or 0 */
1455 static Config* _instance;