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> initial_path(std::string id) const;
570 bool use_isdcf_name_by_default () const {
571 return _use_isdcf_name_by_default;
574 bool write_kdms_to_disk () const {
575 return _write_kdms_to_disk;
578 bool email_kdms () const {
582 dcp::Formulation default_kdm_type () const {
583 return _default_kdm_type;
586 RoughDuration default_kdm_duration () const {
587 return _default_kdm_duration;
590 double auto_crop_threshold () const {
591 return _auto_crop_threshold;
594 boost::optional<std::string> last_release_notes_version () const {
595 return _last_release_notes_version;
598 boost::optional<int> main_divider_sash_position() const {
599 return _main_divider_sash_position;
602 boost::optional<int> main_content_divider_sash_position() const {
603 return _main_content_divider_sash_position;
606 enum class DefaultAddFileLocation {
611 DefaultAddFileLocation default_add_file_location() const {
612 return _default_add_file_location;
617 void set_master_encoding_threads (int n) {
618 maybe_set (_master_encoding_threads, n);
621 void set_server_encoding_threads (int n) {
622 maybe_set (_server_encoding_threads, n);
625 void set_default_directory (boost::filesystem::path d) {
626 if (_default_directory && *_default_directory == d) {
629 _default_directory = d;
633 /** @param p New server port */
634 void set_server_port_base (int p) {
635 maybe_set (_server_port_base, p);
638 void set_only_servers_encode (bool o) {
639 maybe_set (_only_servers_encode, o);
642 void set_tms_protocol (FileTransferProtocol p) {
643 maybe_set (_tms_protocol, p);
646 void set_tms_passive(bool passive) {
647 maybe_set(_tms_passive, passive);
650 /** @param i IP address of a TMS that we can copy DCPs to */
651 void set_tms_ip (std::string i) {
652 maybe_set (_tms_ip, i);
655 /** @param p Path on a TMS that we should changed DCPs to */
656 void set_tms_path (std::string p) {
657 maybe_set (_tms_path, p);
660 /** @param u User name to log into the TMS with */
661 void set_tms_user (std::string u) {
662 maybe_set (_tms_user, u);
665 /** @param p Password to log into the TMS with */
666 void set_tms_password (std::string p) {
667 maybe_set (_tms_password, p);
670 void add_cinema (std::shared_ptr<Cinema> c) {
671 _cinemas.push_back (c);
675 void remove_cinema (std::shared_ptr<Cinema> c) {
680 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
681 _dkdm_recipients.push_back (c);
682 changed (DKDM_RECIPIENTS);
685 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
686 _dkdm_recipients.remove (c);
687 changed (DKDM_RECIPIENTS);
690 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
691 maybe_set (_allowed_dcp_frame_rates, r);
694 void set_allow_any_dcp_frame_rate (bool a) {
695 maybe_set (_allow_any_dcp_frame_rate, a);
698 void set_allow_any_container (bool a) {
699 maybe_set (_allow_any_container, a);
702 void set_allow_96hhz_audio (bool a) {
703 maybe_set (_allow_96khz_audio, a);
706 void set_use_all_audio_channels (bool a) {
707 maybe_set (_use_all_audio_channels, a);
710 void set_show_experimental_audio_processors (bool e) {
711 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
714 void set_language (std::string l) {
715 if (_language && _language.get() == l) {
722 void unset_language () {
727 _language = boost::none;
731 void set_default_still_length (int s) {
732 maybe_set (_default_still_length, s);
735 void set_default_dcp_content_type (DCPContentType const * t) {
736 maybe_set (_default_dcp_content_type, t);
739 void set_default_dcp_audio_channels (int c) {
740 maybe_set (_default_dcp_audio_channels, c);
743 void set_dcp_issuer (std::string i) {
744 maybe_set (_dcp_issuer, i);
747 void set_dcp_creator (std::string c) {
748 maybe_set (_dcp_creator, c);
751 void set_dcp_company_name (std::string c) {
752 maybe_set (_dcp_company_name, c);
755 void set_dcp_product_name (std::string c) {
756 maybe_set (_dcp_product_name, c);
759 void set_dcp_product_version (std::string c) {
760 maybe_set (_dcp_product_version, c);
763 void set_dcp_j2k_comment (std::string c) {
764 maybe_set (_dcp_j2k_comment, c);
767 void set_default_j2k_bandwidth (int b) {
768 maybe_set (_default_j2k_bandwidth, b);
771 void set_default_audio_delay (int d) {
772 maybe_set (_default_audio_delay, d);
775 void set_default_interop (bool i) {
776 maybe_set (_default_interop, i);
779 void set_default_audio_language(dcp::LanguageTag tag) {
780 maybe_set(_default_audio_language, tag);
783 void unset_default_audio_language() {
784 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
787 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
788 maybe_set(_default_territory, tag);
791 void unset_default_territory() {
792 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
795 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
796 maybe_set (_default_metadata, metadata);
799 void set_upload_after_make_dcp (bool u) {
800 maybe_set (_upload_after_make_dcp, u);
803 void set_mail_server (std::string s) {
804 maybe_set (_mail_server, s);
807 void set_mail_port (int p) {
808 maybe_set (_mail_port, p);
811 void set_mail_protocol (EmailProtocol p) {
812 maybe_set (_mail_protocol, p);
815 void set_mail_user (std::string u) {
816 maybe_set (_mail_user, u);
819 void set_mail_password (std::string p) {
820 maybe_set (_mail_password, p);
823 void set_kdm_subject (std::string s) {
824 maybe_set (_kdm_subject, s);
827 void set_kdm_from (std::string f) {
828 maybe_set (_kdm_from, f);
831 void set_kdm_cc (std::vector<std::string> f) {
832 maybe_set (_kdm_cc, f);
835 void set_kdm_bcc (std::string f) {
836 maybe_set (_kdm_bcc, f);
839 void set_kdm_email (std::string e) {
840 maybe_set (_kdm_email, e);
843 void reset_kdm_email ();
845 void set_notification_subject (std::string s) {
846 maybe_set (_notification_subject, s);
849 void set_notification_from (std::string f) {
850 maybe_set (_notification_from, f);
853 void set_notification_to (std::string t) {
854 maybe_set (_notification_to, t);
857 void set_notification_cc (std::vector<std::string> f) {
858 maybe_set (_notification_cc, f);
861 void set_notification_bcc (std::string f) {
862 maybe_set (_notification_bcc, f);
865 void set_notification_email (std::string e) {
866 maybe_set (_notification_email, e);
869 void reset_notification_email ();
871 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
872 maybe_set (_signer_chain, s);
875 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
876 maybe_set (_decryption_chain, c);
879 void set_check_for_updates (bool c) {
880 maybe_set (_check_for_updates, c);
882 set_check_for_test_updates (false);
886 void set_check_for_test_updates (bool c) {
887 maybe_set (_check_for_test_updates, c);
890 void set_maximum_j2k_bandwidth (int b) {
891 maybe_set (_maximum_j2k_bandwidth, b);
894 void set_log_types (int t) {
895 maybe_set (_log_types, t);
898 void set_analyse_ebur128 (bool a) {
899 maybe_set (_analyse_ebur128, a);
902 void set_automatic_audio_analysis (bool a) {
903 maybe_set (_automatic_audio_analysis, a);
906 #ifdef DCPOMATIC_WINDOWS
907 void set_win32_console (bool c) {
908 maybe_set (_win32_console, c);
912 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
917 void set_cinemas_file (boost::filesystem::path file);
919 void set_show_hints_before_make_dcp (bool s) {
920 maybe_set (_show_hints_before_make_dcp, s);
923 void set_confirm_kdm_email (bool s) {
924 maybe_set (_confirm_kdm_email, s);
927 void set_sound (bool s) {
928 maybe_set (_sound, s, SOUND);
931 void set_sound_output (std::string o) {
932 maybe_set (_sound_output, o, SOUND_OUTPUT);
935 void set_last_player_load_directory (boost::filesystem::path d) {
936 maybe_set (_last_player_load_directory, d);
939 void set_last_kdm_write_type (KDMWriteType t) {
940 maybe_set (_last_kdm_write_type, t);
943 void set_last_dkdm_write_type (DKDMWriteType t) {
944 maybe_set (_last_dkdm_write_type, t);
947 void unset_sound_output () {
948 if (!_sound_output) {
952 _sound_output = boost::none;
956 void set_kdm_container_name_format (dcp::NameFormat n) {
957 maybe_set (_kdm_container_name_format, n);
960 void set_kdm_filename_format (dcp::NameFormat n) {
961 maybe_set (_kdm_filename_format, n);
964 void set_dkdm_filename_format (dcp::NameFormat n) {
965 maybe_set (_dkdm_filename_format, n);
968 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
969 maybe_set (_dcp_metadata_filename_format, n);
972 void set_dcp_asset_filename_format (dcp::NameFormat n) {
973 maybe_set (_dcp_asset_filename_format, n);
976 void set_frames_in_memory_multiplier (int m) {
977 maybe_set (_frames_in_memory_multiplier, m);
980 void set_decode_reduction (boost::optional<int> r) {
981 maybe_set (_decode_reduction, r);
984 void set_default_notify (bool n) {
985 maybe_set (_default_notify, n);
988 void clear_history () {
993 void clear_player_history () {
994 _player_history.clear ();
998 void add_to_history (boost::filesystem::path p);
999 void clean_history ();
1000 void add_to_player_history (boost::filesystem::path p);
1001 void clean_player_history ();
1003 void set_jump_to_selected (bool j) {
1004 maybe_set (_jump_to_selected, j);
1007 void set_nagged (Nag nag, bool nagged) {
1008 maybe_set (_nagged[nag], nagged);
1011 void set_cover_sheet (std::string s) {
1012 maybe_set (_cover_sheet, s);
1015 void reset_cover_sheet ();
1017 void set_notification (Notification n, bool v) {
1018 maybe_set (_notification[n], v);
1021 void set_barco_username (std::string u) {
1022 maybe_set (_barco_username, u);
1025 void unset_barco_username () {
1026 maybe_set (_barco_username, boost::optional<std::string>());
1029 void set_barco_password (std::string p) {
1030 maybe_set (_barco_password, p);
1033 void unset_barco_password () {
1034 maybe_set (_barco_password, boost::optional<std::string>());
1037 void set_christie_username (std::string u) {
1038 maybe_set (_christie_username, u);
1041 void unset_christie_username () {
1042 maybe_set (_christie_username, boost::optional<std::string>());
1045 void set_christie_password (std::string p) {
1046 maybe_set (_christie_password, p);
1049 void unset_christie_password () {
1050 maybe_set (_christie_password, boost::optional<std::string>());
1053 void set_gdc_username (std::string u) {
1054 maybe_set (_gdc_username, u);
1057 void unset_gdc_username () {
1058 maybe_set (_gdc_username, boost::optional<std::string>());
1061 void set_gdc_password (std::string p) {
1062 maybe_set (_gdc_password, p);
1065 void unset_gdc_password () {
1066 maybe_set (_gdc_password, boost::optional<std::string>());
1069 void set_player_mode (PlayerMode m) {
1070 maybe_set (_player_mode, m);
1073 void set_image_display (int n) {
1074 maybe_set (_image_display, n);
1077 void set_video_view_type (VideoViewType v) {
1078 maybe_set (_video_view_type, v);
1081 void set_respect_kdm_validity_periods (bool r) {
1082 maybe_set (_respect_kdm_validity_periods, r);
1085 void set_player_debug_log_file (boost::filesystem::path p) {
1086 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1089 void unset_player_debug_log_file () {
1090 if (!_player_debug_log_file) {
1093 _player_debug_log_file = boost::none;
1094 changed (PLAYER_DEBUG_LOG);
1097 void set_player_content_directory (boost::filesystem::path p) {
1098 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1101 void unset_player_content_directory () {
1102 if (!_player_content_directory) {
1105 _player_content_directory = boost::none;
1106 changed (PLAYER_CONTENT_DIRECTORY);
1109 void set_player_playlist_directory (boost::filesystem::path p) {
1110 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1113 void unset_player_playlist_directory () {
1114 if (!_player_playlist_directory) {
1117 _player_playlist_directory = boost::none;
1118 changed (PLAYER_PLAYLIST_DIRECTORY);
1121 void set_player_kdm_directory (boost::filesystem::path p) {
1122 maybe_set (_player_kdm_directory, p);
1125 void unset_player_kdm_directory () {
1126 if (!_player_kdm_directory) {
1129 _player_kdm_directory = boost::none;
1133 void set_audio_mapping (AudioMapping m);
1134 void set_audio_mapping_to_default ();
1136 void add_custom_language (dcp::LanguageTag tag);
1138 void set_initial_path(std::string id, boost::filesystem::path path);
1140 void set_use_isdcf_name_by_default (bool use) {
1141 maybe_set (_use_isdcf_name_by_default, use);
1144 void set_write_kdms_to_disk (bool write) {
1145 maybe_set (_write_kdms_to_disk, write);
1148 void set_email_kdms (bool email) {
1149 maybe_set (_email_kdms, email);
1152 void set_default_kdm_type (dcp::Formulation type) {
1153 maybe_set (_default_kdm_type, type);
1156 void set_default_kdm_duration (RoughDuration duration) {
1157 maybe_set (_default_kdm_duration, duration);
1160 void set_auto_crop_threshold (double threshold) {
1161 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1164 void set_last_release_notes_version (std::string version) {
1165 maybe_set (_last_release_notes_version, version);
1168 void unset_last_release_notes_version() {
1169 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1172 ExportConfig& export_config() {
1176 void set_main_divider_sash_position(int position) {
1177 maybe_set(_main_divider_sash_position, position);
1180 void set_main_content_divider_sash_position(int position) {
1181 maybe_set(_main_content_divider_sash_position, position);
1184 void set_default_add_file_location(DefaultAddFileLocation location) {
1185 maybe_set(_default_add_file_location, location);
1188 void changed (Property p = OTHER);
1189 boost::signals2::signal<void (Property)> Changed;
1190 /** Emitted if read() failed on an existing Config file. There is nothing
1191 a listener can do about it: this is just for information.
1193 enum class LoadFailure {
1198 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1199 /** Emitted if read() issued a warning which the user might want to know about */
1200 static boost::signals2::signal<void (std::string)> Warning;
1201 /** Emitted if there is a something wrong the contents of our config. Handler can call
1202 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1205 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1206 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1207 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1208 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1211 static boost::signals2::signal<bool (BadReason)> Bad;
1213 void write () const override;
1214 void write_config () const;
1215 void write_cinemas () const;
1216 void write_dkdm_recipients () const;
1217 void link (boost::filesystem::path new_file) const;
1218 void copy_and_link (boost::filesystem::path new_file) const;
1219 bool have_write_permission () const;
1221 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1222 bool existing_template (std::string name) const;
1223 std::list<std::string> templates () const;
1224 boost::filesystem::path template_read_path (std::string name) const;
1225 boost::filesystem::path template_write_path (std::string name) const;
1226 void rename_template (std::string old_name, std::string new_name) const;
1227 void delete_template (std::string name) const;
1229 boost::optional<BadReason> check_certificates () const;
1231 static Config* instance ();
1232 static void drop ();
1233 static void restore_defaults ();
1234 static bool have_existing (std::string);
1235 static boost::filesystem::path config_read_file ();
1236 static boost::filesystem::path config_write_file ();
1239 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1240 if (member == new_value) {
1248 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1249 if (member && member.get() == new_value) {
1258 void read () override;
1260 void read_cinemas();
1261 void read_dkdm_recipients();
1262 void set_defaults ();
1263 void set_kdm_email_to_default ();
1264 void set_notification_email_to_default ();
1265 void set_cover_sheet_to_default ();
1266 void read_cinemas (cxml::Document const & f);
1267 void read_dkdm_recipients (cxml::Document const & f);
1268 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1269 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1270 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1271 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1274 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1275 int _master_encoding_threads;
1276 /** number of threads which a server should use for J2K encoding on the local machine */
1277 int _server_encoding_threads;
1278 /** default directory to put new films in */
1279 boost::optional<boost::filesystem::path> _default_directory;
1280 /** base port number to use for J2K encoding servers;
1281 * this port and the two above it will be used.
1283 int _server_port_base;
1284 /** true to broadcast on the `any' address to look for servers */
1285 bool _use_any_servers;
1286 /** J2K encoding servers that should definitely be used */
1287 std::vector<std::string> _servers;
1288 bool _only_servers_encode;
1289 FileTransferProtocol _tms_protocol;
1291 /** The IP address of a TMS that we can copy DCPs to */
1292 std::string _tms_ip;
1293 /** The path on a TMS that we should write DCPs to */
1294 std::string _tms_path;
1295 /** User name to log into the TMS with */
1296 std::string _tms_user;
1297 /** Password to log into the TMS with */
1298 std::string _tms_password;
1299 /** The list of possible DCP frame rates that DCP-o-matic will use */
1300 std::list<int> _allowed_dcp_frame_rates;
1301 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1302 bool _allow_any_dcp_frame_rate;
1303 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1304 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1305 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1307 bool _allow_any_container;
1308 bool _allow_96khz_audio;
1309 bool _use_all_audio_channels;
1310 /** Offer the upmixers in the audio processor settings */
1311 bool _show_experimental_audio_processors;
1312 boost::optional<std::string> _language;
1313 /** Default length of still image content (seconds) */
1314 int _default_still_length;
1315 DCPContentType const * _default_dcp_content_type;
1316 int _default_dcp_audio_channels;
1317 std::string _dcp_issuer;
1318 std::string _dcp_creator;
1319 std::string _dcp_company_name;
1320 std::string _dcp_product_name;
1321 std::string _dcp_product_version;
1322 std::string _dcp_j2k_comment;
1323 int _default_j2k_bandwidth;
1324 int _default_audio_delay;
1325 bool _default_interop;
1326 boost::optional<dcp::LanguageTag> _default_audio_language;
1327 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1328 std::map<std::string, std::string> _default_metadata;
1329 /** Default directory to offer to write KDMs to; if it's not set,
1330 the home directory will be offered.
1332 boost::optional<boost::filesystem::path> _default_kdm_directory;
1333 bool _upload_after_make_dcp;
1334 std::list<std::shared_ptr<Cinema>> _cinemas;
1335 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1336 std::string _mail_server;
1338 EmailProtocol _mail_protocol;
1339 std::string _mail_user;
1340 std::string _mail_password;
1341 std::string _kdm_subject;
1342 std::string _kdm_from;
1343 std::vector<std::string> _kdm_cc;
1344 std::string _kdm_bcc;
1345 std::string _kdm_email;
1346 std::string _notification_subject;
1347 std::string _notification_from;
1348 std::string _notification_to;
1349 std::vector<std::string> _notification_cc;
1350 std::string _notification_bcc;
1351 std::string _notification_email;
1352 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1353 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1354 * certificate for making KDMs given to DCP-o-matic.
1356 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1357 /** true to check for updates on startup */
1358 bool _check_for_updates;
1359 bool _check_for_test_updates;
1360 /** maximum allowed J2K bandwidth in bits per second */
1361 int _maximum_j2k_bandwidth;
1363 bool _analyse_ebur128;
1364 bool _automatic_audio_analysis;
1365 #ifdef DCPOMATIC_WINDOWS
1366 bool _win32_console;
1368 std::vector<boost::filesystem::path> _history;
1369 std::vector<boost::filesystem::path> _player_history;
1370 std::shared_ptr<DKDMGroup> _dkdms;
1371 boost::filesystem::path _cinemas_file;
1372 boost::filesystem::path _dkdm_recipients_file;
1373 bool _show_hints_before_make_dcp;
1374 bool _confirm_kdm_email;
1375 dcp::NameFormat _kdm_filename_format;
1376 dcp::NameFormat _dkdm_filename_format;
1377 dcp::NameFormat _kdm_container_name_format;
1378 dcp::NameFormat _dcp_metadata_filename_format;
1379 dcp::NameFormat _dcp_asset_filename_format;
1380 bool _jump_to_selected;
1381 bool _nagged[NAG_COUNT];
1383 /** name of a specific sound output stream to use, or empty to use the default */
1384 boost::optional<std::string> _sound_output;
1385 std::string _cover_sheet;
1386 boost::optional<boost::filesystem::path> _last_player_load_directory;
1387 boost::optional<KDMWriteType> _last_kdm_write_type;
1388 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1389 int _frames_in_memory_multiplier;
1390 boost::optional<int> _decode_reduction;
1391 bool _default_notify;
1392 bool _notification[NOTIFICATION_COUNT];
1393 boost::optional<std::string> _barco_username;
1394 boost::optional<std::string> _barco_password;
1395 boost::optional<std::string> _christie_username;
1396 boost::optional<std::string> _christie_password;
1397 boost::optional<std::string> _gdc_username;
1398 boost::optional<std::string> _gdc_password;
1399 PlayerMode _player_mode;
1401 VideoViewType _video_view_type;
1402 bool _respect_kdm_validity_periods;
1403 /** Log file containing debug information for the player */
1404 boost::optional<boost::filesystem::path> _player_debug_log_file;
1405 /** A directory containing DCPs whose contents are presented to the user
1406 in the dual-screen player mode. DCPs on the list can be loaded
1409 boost::optional<boost::filesystem::path> _player_content_directory;
1410 boost::optional<boost::filesystem::path> _player_playlist_directory;
1411 boost::optional<boost::filesystem::path> _player_kdm_directory;
1412 boost::optional<AudioMapping> _audio_mapping;
1413 std::vector<dcp::LanguageTag> _custom_languages;
1414 std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
1415 bool _use_isdcf_name_by_default;
1416 bool _write_kdms_to_disk;
1418 dcp::Formulation _default_kdm_type;
1419 RoughDuration _default_kdm_duration;
1420 double _auto_crop_threshold;
1421 boost::optional<std::string> _last_release_notes_version;
1422 boost::optional<int> _main_divider_sash_position;
1423 boost::optional<int> _main_content_divider_sash_position;
1424 DefaultAddFileLocation _default_add_file_location;
1426 ExportConfig _export;
1428 static int const _current_version;
1430 /** Singleton instance, or 0 */
1431 static Config* _instance;