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,
97 ISDCF_NAME_PART_LENGTH,
101 /** @return base port number to use for J2K encoding servers */
102 int server_port_base () const {
103 return _server_port_base;
106 void set_use_any_servers (bool u) {
107 _use_any_servers = u;
108 changed (USE_ANY_SERVERS);
111 bool use_any_servers () const {
112 return _use_any_servers;
115 /** @param s New list of servers */
116 void set_servers (std::vector<std::string> s) {
121 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
122 std::vector<std::string> servers () const {
126 bool only_servers_encode () const {
127 return _only_servers_encode;
130 FileTransferProtocol tms_protocol () const {
131 return _tms_protocol;
134 bool tms_passive() const {
138 /** @return The IP address of a TMS that we can copy DCPs to */
139 std::string tms_ip () const {
143 /** @return The path on a TMS that we should changed DCPs to */
144 std::string tms_path () const {
148 /** @return User name to log into the TMS with */
149 std::string tms_user () const {
153 /** @return Password to log into the TMS with */
154 std::string tms_password () const {
155 return _tms_password;
158 std::list<std::shared_ptr<Cinema>> cinemas () const {
162 std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
163 return _dkdm_recipients;
166 std::list<int> allowed_dcp_frame_rates () const {
167 return _allowed_dcp_frame_rates;
170 bool allow_any_dcp_frame_rate () const {
171 return _allow_any_dcp_frame_rate;
174 bool allow_any_container () const {
175 return _allow_any_container;
178 bool allow_96khz_audio () const {
179 return _allow_96khz_audio;
182 bool use_all_audio_channels () const {
183 return _use_all_audio_channels;
186 bool show_experimental_audio_processors () const {
187 return _show_experimental_audio_processors;
190 boost::optional<std::string> language () const {
194 int default_still_length () const {
195 return _default_still_length;
198 DCPContentType const * default_dcp_content_type () const {
199 return _default_dcp_content_type;
202 int default_dcp_audio_channels () const {
203 return _default_dcp_audio_channels;
206 std::string dcp_issuer () const {
210 std::string dcp_creator () const {
214 std::string dcp_company_name () const {
215 return _dcp_company_name;
218 std::string dcp_product_name () const {
219 return _dcp_product_name;
222 std::string dcp_product_version () const {
223 return _dcp_product_version;
226 std::string dcp_j2k_comment () const {
227 return _dcp_j2k_comment;
230 int default_j2k_bandwidth () const {
231 return _default_j2k_bandwidth;
234 int default_audio_delay () const {
235 return _default_audio_delay;
238 bool default_interop () const {
239 return _default_interop;
242 boost::optional<dcp::LanguageTag> default_audio_language() const {
243 return _default_audio_language;
246 boost::optional<dcp::LanguageTag::RegionSubtag> default_territory() const {
247 return _default_territory;
250 std::map<std::string, std::string> default_metadata () const {
251 return _default_metadata;
254 bool upload_after_make_dcp () {
255 return _upload_after_make_dcp;
258 void set_default_kdm_directory (boost::filesystem::path d) {
259 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
262 _default_kdm_directory = d;
266 std::string mail_server () const {
270 int mail_port () const {
274 EmailProtocol mail_protocol () const {
275 return _mail_protocol;
278 std::string mail_user () const {
282 std::string mail_password () const {
283 return _mail_password;
286 std::string kdm_subject () const {
290 std::string kdm_from () const {
294 std::vector<std::string> kdm_cc () const {
298 std::string kdm_bcc () const {
302 std::string kdm_email () const {
306 std::string notification_subject () const {
307 return _notification_subject;
310 std::string notification_from () const {
311 return _notification_from;
314 std::string notification_to () const {
315 return _notification_to;
318 std::vector<std::string> notification_cc () const {
319 return _notification_cc;
322 std::string notification_bcc () const {
323 return _notification_bcc;
326 std::string notification_email () const {
327 return _notification_email;
330 std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
331 return _signer_chain;
334 std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
335 return _decryption_chain;
338 bool check_for_updates () const {
339 return _check_for_updates;
342 bool check_for_test_updates () const {
343 return _check_for_test_updates;
346 int maximum_j2k_bandwidth () const {
347 return _maximum_j2k_bandwidth;
350 int log_types () const {
354 bool analyse_ebur128 () const {
355 return _analyse_ebur128;
358 bool automatic_audio_analysis () const {
359 return _automatic_audio_analysis;
362 #ifdef DCPOMATIC_WINDOWS
363 bool win32_console () const {
364 return _win32_console;
368 std::vector<boost::filesystem::path> history () const {
372 std::vector<boost::filesystem::path> player_history () const {
373 return _player_history;
376 std::shared_ptr<DKDMGroup> dkdms () const {
380 boost::filesystem::path cinemas_file () const {
381 return _cinemas_file;
384 boost::filesystem::path dkdm_recipients_file () const {
385 return _dkdm_recipients_file;
388 bool show_hints_before_make_dcp () const {
389 return _show_hints_before_make_dcp;
392 bool confirm_kdm_email () const {
393 return _confirm_kdm_email;
396 dcp::NameFormat kdm_container_name_format () const {
397 return _kdm_container_name_format;
400 dcp::NameFormat kdm_filename_format () const {
401 return _kdm_filename_format;
404 dcp::NameFormat dkdm_filename_format () const {
405 return _dkdm_filename_format;
408 dcp::NameFormat dcp_metadata_filename_format () const {
409 return _dcp_metadata_filename_format;
412 dcp::NameFormat dcp_asset_filename_format () const {
413 return _dcp_asset_filename_format;
416 bool jump_to_selected () const {
417 return _jump_to_selected;
420 /* This could be an enum class but we use the enum a lot to index _nagged
421 * so it means a lot of casts.
425 NAG_ENCRYPTED_METADATA,
426 NAG_ALTER_DECRYPTION_CHAIN,
427 NAG_BAD_SIGNER_CHAIN_UTF8,
428 NAG_IMPORT_DECRYPTION_CHAIN,
431 NAG_TOO_MANY_DROPPED_FRAMES,
432 NAG_BAD_SIGNER_CHAIN_VALIDITY,
433 NAG_BAD_SIGNER_DN_QUALIFIER,
437 bool nagged (Nag nag) const {
441 bool sound () const {
445 std::string cover_sheet () const {
449 boost::optional<std::string> sound_output () const {
450 return _sound_output;
453 boost::optional<boost::filesystem::path> last_player_load_directory () const {
454 return _last_player_load_directory;
463 boost::optional<KDMWriteType> last_kdm_write_type () const {
464 return _last_kdm_write_type;
472 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
473 return _last_dkdm_write_type;
476 int frames_in_memory_multiplier () const {
477 return _frames_in_memory_multiplier;
480 boost::optional<int> decode_reduction () const {
481 return _decode_reduction;
484 bool default_notify () const {
485 return _default_notify;
494 bool notification (Notification n) const {
495 return _notification[n];
498 boost::optional<std::string> barco_username () const {
499 return _barco_username;
502 boost::optional<std::string> barco_password () const {
503 return _barco_password;
506 boost::optional<std::string> christie_username () const {
507 return _christie_username;
510 boost::optional<std::string> christie_password () const {
511 return _christie_password;
514 boost::optional<std::string> gdc_username () const {
515 return _gdc_username;
518 boost::optional<std::string> gdc_password () const {
519 return _gdc_password;
523 PLAYER_MODE_WINDOW, ///< one window containing image and controls
524 PLAYER_MODE_FULL, ///< just the image filling the screen
525 PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
528 PlayerMode player_mode () const {
532 int image_display () const {
533 return _image_display;
541 VideoViewType video_view_type () const {
542 return _video_view_type;
545 bool respect_kdm_validity_periods () const {
546 return _respect_kdm_validity_periods;
549 boost::optional<boost::filesystem::path> player_debug_log_file () const {
550 return _player_debug_log_file;
553 boost::optional<boost::filesystem::path> player_content_directory () const {
554 return _player_content_directory;
557 boost::optional<boost::filesystem::path> player_playlist_directory () const {
558 return _player_playlist_directory;
561 boost::optional<boost::filesystem::path> player_kdm_directory () const {
562 return _player_kdm_directory;
565 AudioMapping audio_mapping (int output_channels);
567 std::vector<dcp::LanguageTag> custom_languages () const {
568 return _custom_languages;
571 boost::optional<boost::filesystem::path> initial_path(std::string id) const;
573 bool use_isdcf_name_by_default () const {
574 return _use_isdcf_name_by_default;
577 bool write_kdms_to_disk () const {
578 return _write_kdms_to_disk;
581 bool email_kdms () const {
585 dcp::Formulation default_kdm_type () const {
586 return _default_kdm_type;
589 RoughDuration default_kdm_duration () const {
590 return _default_kdm_duration;
593 double auto_crop_threshold () const {
594 return _auto_crop_threshold;
597 boost::optional<std::string> last_release_notes_version () const {
598 return _last_release_notes_version;
601 boost::optional<int> main_divider_sash_position() const {
602 return _main_divider_sash_position;
605 boost::optional<int> main_content_divider_sash_position() const {
606 return _main_content_divider_sash_position;
609 enum class DefaultAddFileLocation {
614 DefaultAddFileLocation default_add_file_location() const {
615 return _default_add_file_location;
618 bool allow_smpte_bv20() const {
619 return _allow_smpte_bv20;
622 boost::filesystem::path gpu_binary_location() const {
623 return _gpu_binary_location;
626 bool enable_gpu () const {
630 int selected_gpu () const {
631 return _selected_gpu;
633 std::string gpu_license_server () const {
634 return _gpu_license_server;
637 int gpu_license_port () const {
638 return _gpu_license_port;
640 std::string gpu_license () const {
644 int isdcf_name_part_length() const {
645 return _isdcf_name_part_length;
650 void set_master_encoding_threads (int n) {
651 maybe_set (_master_encoding_threads, n);
654 void set_server_encoding_threads (int n) {
655 maybe_set (_server_encoding_threads, n);
658 void set_default_directory (boost::filesystem::path d) {
659 if (_default_directory && *_default_directory == d) {
662 _default_directory = d;
666 /** @param p New server port */
667 void set_server_port_base (int p) {
668 maybe_set (_server_port_base, p);
671 void set_only_servers_encode (bool o) {
672 maybe_set (_only_servers_encode, o);
675 void set_tms_protocol (FileTransferProtocol p) {
676 maybe_set (_tms_protocol, p);
679 void set_tms_passive(bool passive) {
680 maybe_set(_tms_passive, passive);
683 /** @param i IP address of a TMS that we can copy DCPs to */
684 void set_tms_ip (std::string i) {
685 maybe_set (_tms_ip, i);
688 /** @param p Path on a TMS that we should changed DCPs to */
689 void set_tms_path (std::string p) {
690 maybe_set (_tms_path, p);
693 /** @param u User name to log into the TMS with */
694 void set_tms_user (std::string u) {
695 maybe_set (_tms_user, u);
698 /** @param p Password to log into the TMS with */
699 void set_tms_password (std::string p) {
700 maybe_set (_tms_password, p);
703 void add_cinema (std::shared_ptr<Cinema> c) {
704 _cinemas.push_back (c);
708 void remove_cinema (std::shared_ptr<Cinema> c) {
713 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
714 _dkdm_recipients.push_back (c);
715 changed (DKDM_RECIPIENTS);
718 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
719 _dkdm_recipients.remove (c);
720 changed (DKDM_RECIPIENTS);
723 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
724 maybe_set (_allowed_dcp_frame_rates, r);
727 void set_allow_any_dcp_frame_rate (bool a) {
728 maybe_set (_allow_any_dcp_frame_rate, a);
731 void set_allow_any_container (bool a) {
732 maybe_set (_allow_any_container, a);
735 void set_allow_96hhz_audio (bool a) {
736 maybe_set (_allow_96khz_audio, a);
739 void set_use_all_audio_channels (bool a) {
740 maybe_set (_use_all_audio_channels, a);
743 void set_show_experimental_audio_processors (bool e) {
744 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
747 void set_language (std::string l) {
748 if (_language && _language.get() == l) {
755 void unset_language () {
760 _language = boost::none;
764 void set_default_still_length (int s) {
765 maybe_set (_default_still_length, s);
768 void set_default_dcp_content_type (DCPContentType const * t) {
769 maybe_set (_default_dcp_content_type, t);
772 void set_default_dcp_audio_channels (int c) {
773 maybe_set (_default_dcp_audio_channels, c);
776 void set_dcp_issuer (std::string i) {
777 maybe_set (_dcp_issuer, i);
780 void set_dcp_creator (std::string c) {
781 maybe_set (_dcp_creator, c);
784 void set_dcp_company_name (std::string c) {
785 maybe_set (_dcp_company_name, c);
788 void set_dcp_product_name (std::string c) {
789 maybe_set (_dcp_product_name, c);
792 void set_dcp_product_version (std::string c) {
793 maybe_set (_dcp_product_version, c);
796 void set_dcp_j2k_comment (std::string c) {
797 maybe_set (_dcp_j2k_comment, c);
800 void set_default_j2k_bandwidth (int b) {
801 maybe_set (_default_j2k_bandwidth, b);
804 void set_default_audio_delay (int d) {
805 maybe_set (_default_audio_delay, d);
808 void set_default_interop (bool i) {
809 maybe_set (_default_interop, i);
812 void set_default_audio_language(dcp::LanguageTag tag) {
813 maybe_set(_default_audio_language, tag);
816 void unset_default_audio_language() {
817 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
820 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
821 maybe_set(_default_territory, tag);
824 void unset_default_territory() {
825 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
828 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
829 maybe_set (_default_metadata, metadata);
832 void set_upload_after_make_dcp (bool u) {
833 maybe_set (_upload_after_make_dcp, u);
836 void set_mail_server (std::string s) {
837 maybe_set (_mail_server, s);
840 void set_mail_port (int p) {
841 maybe_set (_mail_port, p);
844 void set_mail_protocol (EmailProtocol p) {
845 maybe_set (_mail_protocol, p);
848 void set_mail_user (std::string u) {
849 maybe_set (_mail_user, u);
852 void set_mail_password (std::string p) {
853 maybe_set (_mail_password, p);
856 void set_kdm_subject (std::string s) {
857 maybe_set (_kdm_subject, s);
860 void set_kdm_from (std::string f) {
861 maybe_set (_kdm_from, f);
864 void set_kdm_cc (std::vector<std::string> f) {
865 maybe_set (_kdm_cc, f);
868 void set_kdm_bcc (std::string f) {
869 maybe_set (_kdm_bcc, f);
872 void set_kdm_email (std::string e) {
873 maybe_set (_kdm_email, e);
876 void reset_kdm_email ();
878 void set_notification_subject (std::string s) {
879 maybe_set (_notification_subject, s);
882 void set_notification_from (std::string f) {
883 maybe_set (_notification_from, f);
886 void set_notification_to (std::string t) {
887 maybe_set (_notification_to, t);
890 void set_notification_cc (std::vector<std::string> f) {
891 maybe_set (_notification_cc, f);
894 void set_notification_bcc (std::string f) {
895 maybe_set (_notification_bcc, f);
898 void set_notification_email (std::string e) {
899 maybe_set (_notification_email, e);
902 void reset_notification_email ();
904 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
905 maybe_set (_signer_chain, s);
908 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
909 maybe_set (_decryption_chain, c);
912 void set_check_for_updates (bool c) {
913 maybe_set (_check_for_updates, c);
915 set_check_for_test_updates (false);
919 void set_check_for_test_updates (bool c) {
920 maybe_set (_check_for_test_updates, c);
923 void set_maximum_j2k_bandwidth (int b) {
924 maybe_set (_maximum_j2k_bandwidth, b);
927 void set_log_types (int t) {
928 maybe_set (_log_types, t);
931 void set_analyse_ebur128 (bool a) {
932 maybe_set (_analyse_ebur128, a);
935 void set_automatic_audio_analysis (bool a) {
936 maybe_set (_automatic_audio_analysis, a);
939 #ifdef DCPOMATIC_WINDOWS
940 void set_win32_console (bool c) {
941 maybe_set (_win32_console, c);
945 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
950 void set_cinemas_file (boost::filesystem::path file);
952 void set_show_hints_before_make_dcp (bool s) {
953 maybe_set (_show_hints_before_make_dcp, s);
956 void set_confirm_kdm_email (bool s) {
957 maybe_set (_confirm_kdm_email, s);
960 void set_sound (bool s) {
961 maybe_set (_sound, s, SOUND);
964 void set_sound_output (std::string o) {
965 maybe_set (_sound_output, o, SOUND_OUTPUT);
968 void set_last_player_load_directory (boost::filesystem::path d) {
969 maybe_set (_last_player_load_directory, d);
972 void set_last_kdm_write_type (KDMWriteType t) {
973 maybe_set (_last_kdm_write_type, t);
976 void set_last_dkdm_write_type (DKDMWriteType t) {
977 maybe_set (_last_dkdm_write_type, t);
980 void unset_sound_output () {
981 if (!_sound_output) {
985 _sound_output = boost::none;
989 void set_kdm_container_name_format (dcp::NameFormat n) {
990 maybe_set (_kdm_container_name_format, n);
993 void set_kdm_filename_format (dcp::NameFormat n) {
994 maybe_set (_kdm_filename_format, n);
997 void set_dkdm_filename_format (dcp::NameFormat n) {
998 maybe_set (_dkdm_filename_format, n);
1001 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
1002 maybe_set (_dcp_metadata_filename_format, n);
1005 void set_dcp_asset_filename_format (dcp::NameFormat n) {
1006 maybe_set (_dcp_asset_filename_format, n);
1009 void set_frames_in_memory_multiplier (int m) {
1010 maybe_set (_frames_in_memory_multiplier, m);
1013 void set_decode_reduction (boost::optional<int> r) {
1014 maybe_set (_decode_reduction, r);
1017 void set_default_notify (bool n) {
1018 maybe_set (_default_notify, n);
1021 void clear_history () {
1026 void clear_player_history () {
1027 _player_history.clear ();
1031 void add_to_history (boost::filesystem::path p);
1032 void clean_history ();
1033 void add_to_player_history (boost::filesystem::path p);
1034 void clean_player_history ();
1036 void set_jump_to_selected (bool j) {
1037 maybe_set (_jump_to_selected, j);
1040 void set_nagged (Nag nag, bool nagged) {
1041 maybe_set (_nagged[nag], nagged);
1044 void set_cover_sheet (std::string s) {
1045 maybe_set (_cover_sheet, s);
1048 void reset_cover_sheet ();
1050 void set_notification (Notification n, bool v) {
1051 maybe_set (_notification[n], v);
1054 void set_barco_username (std::string u) {
1055 maybe_set (_barco_username, u);
1058 void unset_barco_username () {
1059 maybe_set (_barco_username, boost::optional<std::string>());
1062 void set_barco_password (std::string p) {
1063 maybe_set (_barco_password, p);
1066 void unset_barco_password () {
1067 maybe_set (_barco_password, boost::optional<std::string>());
1070 void set_christie_username (std::string u) {
1071 maybe_set (_christie_username, u);
1074 void unset_christie_username () {
1075 maybe_set (_christie_username, boost::optional<std::string>());
1078 void set_christie_password (std::string p) {
1079 maybe_set (_christie_password, p);
1082 void unset_christie_password () {
1083 maybe_set (_christie_password, boost::optional<std::string>());
1086 void set_gdc_username (std::string u) {
1087 maybe_set (_gdc_username, u);
1090 void unset_gdc_username () {
1091 maybe_set (_gdc_username, boost::optional<std::string>());
1094 void set_gdc_password (std::string p) {
1095 maybe_set (_gdc_password, p);
1098 void unset_gdc_password () {
1099 maybe_set (_gdc_password, boost::optional<std::string>());
1102 void set_player_mode (PlayerMode m) {
1103 maybe_set (_player_mode, m);
1106 void set_image_display (int n) {
1107 maybe_set (_image_display, n);
1110 void set_video_view_type (VideoViewType v) {
1111 maybe_set (_video_view_type, v);
1114 void set_respect_kdm_validity_periods (bool r) {
1115 maybe_set (_respect_kdm_validity_periods, r);
1118 void set_player_debug_log_file (boost::filesystem::path p) {
1119 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1122 void unset_player_debug_log_file () {
1123 if (!_player_debug_log_file) {
1126 _player_debug_log_file = boost::none;
1127 changed (PLAYER_DEBUG_LOG);
1130 void set_player_content_directory (boost::filesystem::path p) {
1131 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1134 void unset_player_content_directory () {
1135 if (!_player_content_directory) {
1138 _player_content_directory = boost::none;
1139 changed (PLAYER_CONTENT_DIRECTORY);
1142 void set_player_playlist_directory (boost::filesystem::path p) {
1143 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1146 void unset_player_playlist_directory () {
1147 if (!_player_playlist_directory) {
1150 _player_playlist_directory = boost::none;
1151 changed (PLAYER_PLAYLIST_DIRECTORY);
1154 void set_player_kdm_directory (boost::filesystem::path p) {
1155 maybe_set (_player_kdm_directory, p);
1158 void unset_player_kdm_directory () {
1159 if (!_player_kdm_directory) {
1162 _player_kdm_directory = boost::none;
1166 void set_audio_mapping (AudioMapping m);
1167 void set_audio_mapping_to_default ();
1169 void add_custom_language (dcp::LanguageTag tag);
1171 void set_initial_path(std::string id, boost::filesystem::path path);
1173 void set_use_isdcf_name_by_default (bool use) {
1174 maybe_set (_use_isdcf_name_by_default, use);
1177 void set_write_kdms_to_disk (bool write) {
1178 maybe_set (_write_kdms_to_disk, write);
1181 void set_email_kdms (bool email) {
1182 maybe_set (_email_kdms, email);
1185 void set_default_kdm_type (dcp::Formulation type) {
1186 maybe_set (_default_kdm_type, type);
1189 void set_default_kdm_duration (RoughDuration duration) {
1190 maybe_set (_default_kdm_duration, duration);
1193 void set_auto_crop_threshold (double threshold) {
1194 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1197 void set_last_release_notes_version (std::string version) {
1198 maybe_set (_last_release_notes_version, version);
1201 void unset_last_release_notes_version() {
1202 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1205 ExportConfig& export_config() {
1209 void set_main_divider_sash_position(int position) {
1210 maybe_set(_main_divider_sash_position, position);
1213 void set_main_content_divider_sash_position(int position) {
1214 maybe_set(_main_content_divider_sash_position, position);
1217 void set_default_add_file_location(DefaultAddFileLocation location) {
1218 maybe_set(_default_add_file_location, location);
1221 void set_allow_smpte_bv20(bool allow) {
1222 maybe_set(_allow_smpte_bv20, allow, ALLOW_SMPTE_BV20);
1225 void set_gpu_binary_location(boost::filesystem::path location) {
1226 maybe_set (_gpu_binary_location, location);
1229 void set_enable_gpu (bool enable) {
1230 maybe_set (_enable_gpu, enable);
1233 void set_selected_gpu (int selected) {
1234 maybe_set (_selected_gpu, selected);
1237 void set_gpu_license_server (std::string s) {
1238 maybe_set (_gpu_license_server, s);
1241 void set_gpu_license_port (int p) {
1242 maybe_set (_gpu_license_port, p);
1245 void set_gpu_license (std::string p) {
1246 maybe_set (_gpu_license, p);
1249 void set_isdcf_name_part_length(int length) {
1250 maybe_set(_isdcf_name_part_length, length, ISDCF_NAME_PART_LENGTH);
1254 void changed (Property p = OTHER);
1255 boost::signals2::signal<void (Property)> Changed;
1256 /** Emitted if read() failed on an existing Config file. There is nothing
1257 a listener can do about it: this is just for information.
1259 enum class LoadFailure {
1264 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1265 /** Emitted if read() issued a warning which the user might want to know about */
1266 static boost::signals2::signal<void (std::string)> Warning;
1267 /** Emitted if there is a something wrong the contents of our config. Handler can call
1268 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1271 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1272 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1273 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1274 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1275 BAD_SIGNER_DN_QUALIFIER, ///< some signer certificate has a bad dnQualifier (DoM #2716).
1278 static boost::signals2::signal<bool (BadReason)> Bad;
1280 void write () const override;
1281 void write_config () const;
1282 void write_cinemas () const;
1283 void write_dkdm_recipients () const;
1284 void link (boost::filesystem::path new_file) const;
1285 void copy_and_link (boost::filesystem::path new_file) const;
1286 bool have_write_permission () const;
1288 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1289 bool existing_template (std::string name) const;
1290 std::list<std::string> templates () const;
1291 boost::filesystem::path template_read_path (std::string name) const;
1292 boost::filesystem::path template_write_path (std::string name) const;
1293 void rename_template (std::string old_name, std::string new_name) const;
1294 void delete_template (std::string name) const;
1296 boost::optional<BadReason> check_certificates () const;
1298 static Config* instance ();
1299 static void drop ();
1300 static void restore_defaults ();
1301 static bool have_existing (std::string);
1302 static boost::filesystem::path config_read_file ();
1303 static boost::filesystem::path config_write_file ();
1306 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1307 if (member == new_value) {
1315 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1316 if (member && member.get() == new_value) {
1325 void read () override;
1327 void read_cinemas();
1328 void read_dkdm_recipients();
1329 void set_defaults ();
1330 void set_kdm_email_to_default ();
1331 void set_notification_email_to_default ();
1332 void set_cover_sheet_to_default ();
1333 void read_cinemas (cxml::Document const & f);
1334 void read_dkdm_recipients (cxml::Document const & f);
1335 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1336 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1337 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1338 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1341 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1342 int _master_encoding_threads;
1343 /** number of threads which a server should use for J2K encoding on the local machine */
1344 int _server_encoding_threads;
1345 /** default directory to put new films in */
1346 boost::optional<boost::filesystem::path> _default_directory;
1347 /** base port number to use for J2K encoding servers;
1348 * this port and the two above it will be used.
1350 int _server_port_base;
1351 /** true to broadcast on the `any' address to look for servers */
1352 bool _use_any_servers;
1353 /** J2K encoding servers that should definitely be used */
1354 std::vector<std::string> _servers;
1355 bool _only_servers_encode;
1356 FileTransferProtocol _tms_protocol;
1358 /** The IP address of a TMS that we can copy DCPs to */
1359 std::string _tms_ip;
1360 /** The path on a TMS that we should write DCPs to */
1361 std::string _tms_path;
1362 /** User name to log into the TMS with */
1363 std::string _tms_user;
1364 /** Password to log into the TMS with */
1365 std::string _tms_password;
1366 /** The list of possible DCP frame rates that DCP-o-matic will use */
1367 std::list<int> _allowed_dcp_frame_rates;
1368 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1369 bool _allow_any_dcp_frame_rate;
1370 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1371 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1372 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1374 bool _allow_any_container;
1375 bool _allow_96khz_audio;
1376 bool _use_all_audio_channels;
1377 /** Offer the upmixers in the audio processor settings */
1378 bool _show_experimental_audio_processors;
1379 boost::optional<std::string> _language;
1380 /** Default length of still image content (seconds) */
1381 int _default_still_length;
1382 DCPContentType const * _default_dcp_content_type;
1383 int _default_dcp_audio_channels;
1384 std::string _dcp_issuer;
1385 std::string _dcp_creator;
1386 std::string _dcp_company_name;
1387 std::string _dcp_product_name;
1388 std::string _dcp_product_version;
1389 std::string _dcp_j2k_comment;
1390 int _default_j2k_bandwidth;
1391 int _default_audio_delay;
1392 bool _default_interop;
1393 boost::optional<dcp::LanguageTag> _default_audio_language;
1394 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1395 std::map<std::string, std::string> _default_metadata;
1396 /** Default directory to offer to write KDMs to; if it's not set,
1397 the home directory will be offered.
1399 boost::optional<boost::filesystem::path> _default_kdm_directory;
1400 bool _upload_after_make_dcp;
1401 std::list<std::shared_ptr<Cinema>> _cinemas;
1402 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1403 std::string _mail_server;
1405 EmailProtocol _mail_protocol;
1406 std::string _mail_user;
1407 std::string _mail_password;
1408 std::string _kdm_subject;
1409 std::string _kdm_from;
1410 std::vector<std::string> _kdm_cc;
1411 std::string _kdm_bcc;
1412 std::string _kdm_email;
1413 std::string _notification_subject;
1414 std::string _notification_from;
1415 std::string _notification_to;
1416 std::vector<std::string> _notification_cc;
1417 std::string _notification_bcc;
1418 std::string _notification_email;
1419 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1420 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1421 * certificate for making KDMs given to DCP-o-matic.
1423 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1424 /** true to check for updates on startup */
1425 bool _check_for_updates;
1426 bool _check_for_test_updates;
1427 /** maximum allowed J2K bandwidth in bits per second */
1428 int _maximum_j2k_bandwidth;
1430 bool _analyse_ebur128;
1431 bool _automatic_audio_analysis;
1432 #ifdef DCPOMATIC_WINDOWS
1433 bool _win32_console;
1435 std::vector<boost::filesystem::path> _history;
1436 std::vector<boost::filesystem::path> _player_history;
1437 std::shared_ptr<DKDMGroup> _dkdms;
1438 boost::filesystem::path _cinemas_file;
1439 boost::filesystem::path _dkdm_recipients_file;
1440 bool _show_hints_before_make_dcp;
1441 bool _confirm_kdm_email;
1442 dcp::NameFormat _kdm_filename_format;
1443 dcp::NameFormat _dkdm_filename_format;
1444 dcp::NameFormat _kdm_container_name_format;
1445 dcp::NameFormat _dcp_metadata_filename_format;
1446 dcp::NameFormat _dcp_asset_filename_format;
1447 bool _jump_to_selected;
1448 bool _nagged[NAG_COUNT];
1450 /** name of a specific sound output stream to use, or empty to use the default */
1451 boost::optional<std::string> _sound_output;
1452 std::string _cover_sheet;
1453 boost::optional<boost::filesystem::path> _last_player_load_directory;
1454 boost::optional<KDMWriteType> _last_kdm_write_type;
1455 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1456 int _frames_in_memory_multiplier;
1457 boost::optional<int> _decode_reduction;
1458 bool _default_notify;
1459 bool _notification[NOTIFICATION_COUNT];
1460 boost::optional<std::string> _barco_username;
1461 boost::optional<std::string> _barco_password;
1462 boost::optional<std::string> _christie_username;
1463 boost::optional<std::string> _christie_password;
1464 boost::optional<std::string> _gdc_username;
1465 boost::optional<std::string> _gdc_password;
1466 PlayerMode _player_mode;
1468 VideoViewType _video_view_type;
1469 bool _respect_kdm_validity_periods;
1470 /** Log file containing debug information for the player */
1471 boost::optional<boost::filesystem::path> _player_debug_log_file;
1472 /** A directory containing DCPs whose contents are presented to the user
1473 in the dual-screen player mode. DCPs on the list can be loaded
1476 boost::optional<boost::filesystem::path> _player_content_directory;
1477 boost::optional<boost::filesystem::path> _player_playlist_directory;
1478 boost::optional<boost::filesystem::path> _player_kdm_directory;
1479 boost::optional<AudioMapping> _audio_mapping;
1480 std::vector<dcp::LanguageTag> _custom_languages;
1481 std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
1482 bool _use_isdcf_name_by_default;
1483 bool _write_kdms_to_disk;
1485 dcp::Formulation _default_kdm_type;
1486 RoughDuration _default_kdm_duration;
1487 double _auto_crop_threshold;
1488 boost::optional<std::string> _last_release_notes_version;
1489 boost::optional<int> _main_divider_sash_position;
1490 boost::optional<int> _main_content_divider_sash_position;
1491 DefaultAddFileLocation _default_add_file_location;
1492 bool _allow_smpte_bv20;
1493 int _isdcf_name_part_length;
1497 boost::filesystem::path _gpu_binary_location;
1499 std::string _gpu_license_server;
1500 int _gpu_license_port;
1501 std::string _gpu_license;
1503 ExportConfig _export;
1505 static int const _current_version;
1507 /** Singleton instance, or 0 */
1508 static Config* _instance;