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,
436 bool nagged (Nag nag) const {
440 bool sound () const {
444 std::string cover_sheet () const {
448 boost::optional<std::string> sound_output () const {
449 return _sound_output;
452 boost::optional<boost::filesystem::path> last_player_load_directory () const {
453 return _last_player_load_directory;
462 boost::optional<KDMWriteType> last_kdm_write_type () const {
463 return _last_kdm_write_type;
471 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
472 return _last_dkdm_write_type;
475 int frames_in_memory_multiplier () const {
476 return _frames_in_memory_multiplier;
479 boost::optional<int> decode_reduction () const {
480 return _decode_reduction;
483 bool default_notify () const {
484 return _default_notify;
493 bool notification (Notification n) const {
494 return _notification[n];
497 boost::optional<std::string> barco_username () const {
498 return _barco_username;
501 boost::optional<std::string> barco_password () const {
502 return _barco_password;
505 boost::optional<std::string> christie_username () const {
506 return _christie_username;
509 boost::optional<std::string> christie_password () const {
510 return _christie_password;
513 boost::optional<std::string> gdc_username () const {
514 return _gdc_username;
517 boost::optional<std::string> gdc_password () const {
518 return _gdc_password;
522 PLAYER_MODE_WINDOW, ///< one window containing image and controls
523 PLAYER_MODE_FULL, ///< just the image filling the screen
524 PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
527 PlayerMode player_mode () const {
531 int image_display () const {
532 return _image_display;
540 VideoViewType video_view_type () const {
541 return _video_view_type;
544 bool respect_kdm_validity_periods () const {
545 return _respect_kdm_validity_periods;
548 boost::optional<boost::filesystem::path> player_debug_log_file () const {
549 return _player_debug_log_file;
552 boost::optional<boost::filesystem::path> player_content_directory () const {
553 return _player_content_directory;
556 boost::optional<boost::filesystem::path> player_playlist_directory () const {
557 return _player_playlist_directory;
560 boost::optional<boost::filesystem::path> player_kdm_directory () const {
561 return _player_kdm_directory;
564 AudioMapping audio_mapping (int output_channels);
566 std::vector<dcp::LanguageTag> custom_languages () const {
567 return _custom_languages;
570 boost::optional<boost::filesystem::path> initial_path(std::string id) const;
572 bool use_isdcf_name_by_default () const {
573 return _use_isdcf_name_by_default;
576 bool write_kdms_to_disk () const {
577 return _write_kdms_to_disk;
580 bool email_kdms () const {
584 dcp::Formulation default_kdm_type () const {
585 return _default_kdm_type;
588 RoughDuration default_kdm_duration () const {
589 return _default_kdm_duration;
592 double auto_crop_threshold () const {
593 return _auto_crop_threshold;
596 boost::optional<std::string> last_release_notes_version () const {
597 return _last_release_notes_version;
600 boost::optional<int> main_divider_sash_position() const {
601 return _main_divider_sash_position;
604 boost::optional<int> main_content_divider_sash_position() const {
605 return _main_content_divider_sash_position;
608 enum class DefaultAddFileLocation {
613 DefaultAddFileLocation default_add_file_location() const {
614 return _default_add_file_location;
617 bool allow_smpte_bv20() const {
618 return _allow_smpte_bv20;
621 int isdcf_name_part_length() const {
622 return _isdcf_name_part_length;
627 void set_master_encoding_threads (int n) {
628 maybe_set (_master_encoding_threads, n);
631 void set_server_encoding_threads (int n) {
632 maybe_set (_server_encoding_threads, n);
635 void set_default_directory (boost::filesystem::path d) {
636 if (_default_directory && *_default_directory == d) {
639 _default_directory = d;
643 /** @param p New server port */
644 void set_server_port_base (int p) {
645 maybe_set (_server_port_base, p);
648 void set_only_servers_encode (bool o) {
649 maybe_set (_only_servers_encode, o);
652 void set_tms_protocol (FileTransferProtocol p) {
653 maybe_set (_tms_protocol, p);
656 void set_tms_passive(bool passive) {
657 maybe_set(_tms_passive, passive);
660 /** @param i IP address of a TMS that we can copy DCPs to */
661 void set_tms_ip (std::string i) {
662 maybe_set (_tms_ip, i);
665 /** @param p Path on a TMS that we should changed DCPs to */
666 void set_tms_path (std::string p) {
667 maybe_set (_tms_path, p);
670 /** @param u User name to log into the TMS with */
671 void set_tms_user (std::string u) {
672 maybe_set (_tms_user, u);
675 /** @param p Password to log into the TMS with */
676 void set_tms_password (std::string p) {
677 maybe_set (_tms_password, p);
680 void add_cinema (std::shared_ptr<Cinema> c) {
681 _cinemas.push_back (c);
685 void remove_cinema (std::shared_ptr<Cinema> c) {
690 void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
691 _dkdm_recipients.push_back (c);
692 changed (DKDM_RECIPIENTS);
695 void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
696 _dkdm_recipients.remove (c);
697 changed (DKDM_RECIPIENTS);
700 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
701 maybe_set (_allowed_dcp_frame_rates, r);
704 void set_allow_any_dcp_frame_rate (bool a) {
705 maybe_set (_allow_any_dcp_frame_rate, a);
708 void set_allow_any_container (bool a) {
709 maybe_set (_allow_any_container, a);
712 void set_allow_96hhz_audio (bool a) {
713 maybe_set (_allow_96khz_audio, a);
716 void set_use_all_audio_channels (bool a) {
717 maybe_set (_use_all_audio_channels, a);
720 void set_show_experimental_audio_processors (bool e) {
721 maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
724 void set_language (std::string l) {
725 if (_language && _language.get() == l) {
732 void unset_language () {
737 _language = boost::none;
741 void set_default_still_length (int s) {
742 maybe_set (_default_still_length, s);
745 void set_default_dcp_content_type (DCPContentType const * t) {
746 maybe_set (_default_dcp_content_type, t);
749 void set_default_dcp_audio_channels (int c) {
750 maybe_set (_default_dcp_audio_channels, c);
753 void set_dcp_issuer (std::string i) {
754 maybe_set (_dcp_issuer, i);
757 void set_dcp_creator (std::string c) {
758 maybe_set (_dcp_creator, c);
761 void set_dcp_company_name (std::string c) {
762 maybe_set (_dcp_company_name, c);
765 void set_dcp_product_name (std::string c) {
766 maybe_set (_dcp_product_name, c);
769 void set_dcp_product_version (std::string c) {
770 maybe_set (_dcp_product_version, c);
773 void set_dcp_j2k_comment (std::string c) {
774 maybe_set (_dcp_j2k_comment, c);
777 void set_default_j2k_bandwidth (int b) {
778 maybe_set (_default_j2k_bandwidth, b);
781 void set_default_audio_delay (int d) {
782 maybe_set (_default_audio_delay, d);
785 void set_default_interop (bool i) {
786 maybe_set (_default_interop, i);
789 void set_default_audio_language(dcp::LanguageTag tag) {
790 maybe_set(_default_audio_language, tag);
793 void unset_default_audio_language() {
794 maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
797 void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
798 maybe_set(_default_territory, tag);
801 void unset_default_territory() {
802 maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
805 void set_default_metadata (std::map<std::string, std::string> const& metadata) {
806 maybe_set (_default_metadata, metadata);
809 void set_upload_after_make_dcp (bool u) {
810 maybe_set (_upload_after_make_dcp, u);
813 void set_mail_server (std::string s) {
814 maybe_set (_mail_server, s);
817 void set_mail_port (int p) {
818 maybe_set (_mail_port, p);
821 void set_mail_protocol (EmailProtocol p) {
822 maybe_set (_mail_protocol, p);
825 void set_mail_user (std::string u) {
826 maybe_set (_mail_user, u);
829 void set_mail_password (std::string p) {
830 maybe_set (_mail_password, p);
833 void set_kdm_subject (std::string s) {
834 maybe_set (_kdm_subject, s);
837 void set_kdm_from (std::string f) {
838 maybe_set (_kdm_from, f);
841 void set_kdm_cc (std::vector<std::string> f) {
842 maybe_set (_kdm_cc, f);
845 void set_kdm_bcc (std::string f) {
846 maybe_set (_kdm_bcc, f);
849 void set_kdm_email (std::string e) {
850 maybe_set (_kdm_email, e);
853 void reset_kdm_email ();
855 void set_notification_subject (std::string s) {
856 maybe_set (_notification_subject, s);
859 void set_notification_from (std::string f) {
860 maybe_set (_notification_from, f);
863 void set_notification_to (std::string t) {
864 maybe_set (_notification_to, t);
867 void set_notification_cc (std::vector<std::string> f) {
868 maybe_set (_notification_cc, f);
871 void set_notification_bcc (std::string f) {
872 maybe_set (_notification_bcc, f);
875 void set_notification_email (std::string e) {
876 maybe_set (_notification_email, e);
879 void reset_notification_email ();
881 void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
882 maybe_set (_signer_chain, s);
885 void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
886 maybe_set (_decryption_chain, c);
889 void set_check_for_updates (bool c) {
890 maybe_set (_check_for_updates, c);
892 set_check_for_test_updates (false);
896 void set_check_for_test_updates (bool c) {
897 maybe_set (_check_for_test_updates, c);
900 void set_maximum_j2k_bandwidth (int b) {
901 maybe_set (_maximum_j2k_bandwidth, b);
904 void set_log_types (int t) {
905 maybe_set (_log_types, t);
908 void set_analyse_ebur128 (bool a) {
909 maybe_set (_analyse_ebur128, a);
912 void set_automatic_audio_analysis (bool a) {
913 maybe_set (_automatic_audio_analysis, a);
916 #ifdef DCPOMATIC_WINDOWS
917 void set_win32_console (bool c) {
918 maybe_set (_win32_console, c);
922 void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
927 void set_cinemas_file (boost::filesystem::path file);
929 void set_show_hints_before_make_dcp (bool s) {
930 maybe_set (_show_hints_before_make_dcp, s);
933 void set_confirm_kdm_email (bool s) {
934 maybe_set (_confirm_kdm_email, s);
937 void set_sound (bool s) {
938 maybe_set (_sound, s, SOUND);
941 void set_sound_output (std::string o) {
942 maybe_set (_sound_output, o, SOUND_OUTPUT);
945 void set_last_player_load_directory (boost::filesystem::path d) {
946 maybe_set (_last_player_load_directory, d);
949 void set_last_kdm_write_type (KDMWriteType t) {
950 maybe_set (_last_kdm_write_type, t);
953 void set_last_dkdm_write_type (DKDMWriteType t) {
954 maybe_set (_last_dkdm_write_type, t);
957 void unset_sound_output () {
958 if (!_sound_output) {
962 _sound_output = boost::none;
966 void set_kdm_container_name_format (dcp::NameFormat n) {
967 maybe_set (_kdm_container_name_format, n);
970 void set_kdm_filename_format (dcp::NameFormat n) {
971 maybe_set (_kdm_filename_format, n);
974 void set_dkdm_filename_format (dcp::NameFormat n) {
975 maybe_set (_dkdm_filename_format, n);
978 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
979 maybe_set (_dcp_metadata_filename_format, n);
982 void set_dcp_asset_filename_format (dcp::NameFormat n) {
983 maybe_set (_dcp_asset_filename_format, n);
986 void set_frames_in_memory_multiplier (int m) {
987 maybe_set (_frames_in_memory_multiplier, m);
990 void set_decode_reduction (boost::optional<int> r) {
991 maybe_set (_decode_reduction, r);
994 void set_default_notify (bool n) {
995 maybe_set (_default_notify, n);
998 void clear_history () {
1003 void clear_player_history () {
1004 _player_history.clear ();
1008 void add_to_history (boost::filesystem::path p);
1009 void clean_history ();
1010 void add_to_player_history (boost::filesystem::path p);
1011 void clean_player_history ();
1013 void set_jump_to_selected (bool j) {
1014 maybe_set (_jump_to_selected, j);
1017 void set_nagged (Nag nag, bool nagged) {
1018 maybe_set (_nagged[nag], nagged);
1021 void set_cover_sheet (std::string s) {
1022 maybe_set (_cover_sheet, s);
1025 void reset_cover_sheet ();
1027 void set_notification (Notification n, bool v) {
1028 maybe_set (_notification[n], v);
1031 void set_barco_username (std::string u) {
1032 maybe_set (_barco_username, u);
1035 void unset_barco_username () {
1036 maybe_set (_barco_username, boost::optional<std::string>());
1039 void set_barco_password (std::string p) {
1040 maybe_set (_barco_password, p);
1043 void unset_barco_password () {
1044 maybe_set (_barco_password, boost::optional<std::string>());
1047 void set_christie_username (std::string u) {
1048 maybe_set (_christie_username, u);
1051 void unset_christie_username () {
1052 maybe_set (_christie_username, boost::optional<std::string>());
1055 void set_christie_password (std::string p) {
1056 maybe_set (_christie_password, p);
1059 void unset_christie_password () {
1060 maybe_set (_christie_password, boost::optional<std::string>());
1063 void set_gdc_username (std::string u) {
1064 maybe_set (_gdc_username, u);
1067 void unset_gdc_username () {
1068 maybe_set (_gdc_username, boost::optional<std::string>());
1071 void set_gdc_password (std::string p) {
1072 maybe_set (_gdc_password, p);
1075 void unset_gdc_password () {
1076 maybe_set (_gdc_password, boost::optional<std::string>());
1079 void set_player_mode (PlayerMode m) {
1080 maybe_set (_player_mode, m);
1083 void set_image_display (int n) {
1084 maybe_set (_image_display, n);
1087 void set_video_view_type (VideoViewType v) {
1088 maybe_set (_video_view_type, v);
1091 void set_respect_kdm_validity_periods (bool r) {
1092 maybe_set (_respect_kdm_validity_periods, r);
1095 void set_player_debug_log_file (boost::filesystem::path p) {
1096 maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG);
1099 void unset_player_debug_log_file () {
1100 if (!_player_debug_log_file) {
1103 _player_debug_log_file = boost::none;
1104 changed (PLAYER_DEBUG_LOG);
1107 void set_player_content_directory (boost::filesystem::path p) {
1108 maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY);
1111 void unset_player_content_directory () {
1112 if (!_player_content_directory) {
1115 _player_content_directory = boost::none;
1116 changed (PLAYER_CONTENT_DIRECTORY);
1119 void set_player_playlist_directory (boost::filesystem::path p) {
1120 maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY);
1123 void unset_player_playlist_directory () {
1124 if (!_player_playlist_directory) {
1127 _player_playlist_directory = boost::none;
1128 changed (PLAYER_PLAYLIST_DIRECTORY);
1131 void set_player_kdm_directory (boost::filesystem::path p) {
1132 maybe_set (_player_kdm_directory, p);
1135 void unset_player_kdm_directory () {
1136 if (!_player_kdm_directory) {
1139 _player_kdm_directory = boost::none;
1143 void set_audio_mapping (AudioMapping m);
1144 void set_audio_mapping_to_default ();
1146 void add_custom_language (dcp::LanguageTag tag);
1148 void set_initial_path(std::string id, boost::filesystem::path path);
1150 void set_use_isdcf_name_by_default (bool use) {
1151 maybe_set (_use_isdcf_name_by_default, use);
1154 void set_write_kdms_to_disk (bool write) {
1155 maybe_set (_write_kdms_to_disk, write);
1158 void set_email_kdms (bool email) {
1159 maybe_set (_email_kdms, email);
1162 void set_default_kdm_type (dcp::Formulation type) {
1163 maybe_set (_default_kdm_type, type);
1166 void set_default_kdm_duration (RoughDuration duration) {
1167 maybe_set (_default_kdm_duration, duration);
1170 void set_auto_crop_threshold (double threshold) {
1171 maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
1174 void set_last_release_notes_version (std::string version) {
1175 maybe_set (_last_release_notes_version, version);
1178 void unset_last_release_notes_version() {
1179 maybe_set(_last_release_notes_version, boost::optional<std::string>());
1182 ExportConfig& export_config() {
1186 void set_main_divider_sash_position(int position) {
1187 maybe_set(_main_divider_sash_position, position);
1190 void set_main_content_divider_sash_position(int position) {
1191 maybe_set(_main_content_divider_sash_position, position);
1194 void set_default_add_file_location(DefaultAddFileLocation location) {
1195 maybe_set(_default_add_file_location, location);
1198 void set_allow_smpte_bv20(bool allow) {
1199 maybe_set(_allow_smpte_bv20, allow, ALLOW_SMPTE_BV20);
1202 void set_isdcf_name_part_length(int length) {
1203 maybe_set(_isdcf_name_part_length, length, ISDCF_NAME_PART_LENGTH);
1206 void changed (Property p = OTHER);
1207 boost::signals2::signal<void (Property)> Changed;
1208 /** Emitted if read() failed on an existing Config file. There is nothing
1209 a listener can do about it: this is just for information.
1211 enum class LoadFailure {
1216 static boost::signals2::signal<void (LoadFailure)> FailedToLoad;
1217 /** Emitted if read() issued a warning which the user might want to know about */
1218 static boost::signals2::signal<void (std::string)> Warning;
1219 /** Emitted if there is a something wrong the contents of our config. Handler can call
1220 * true to ask Config to solve the problem (by discarding and recreating the bad thing)
1223 BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
1224 BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent
1225 BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
1226 BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
1229 static boost::signals2::signal<bool (BadReason)> Bad;
1231 void write () const override;
1232 void write_config () const;
1233 void write_cinemas () const;
1234 void write_dkdm_recipients () const;
1235 void link (boost::filesystem::path new_file) const;
1236 void copy_and_link (boost::filesystem::path new_file) const;
1237 bool have_write_permission () const;
1239 void save_template (std::shared_ptr<const Film> film, std::string name) const;
1240 bool existing_template (std::string name) const;
1241 std::list<std::string> templates () const;
1242 boost::filesystem::path template_read_path (std::string name) const;
1243 boost::filesystem::path template_write_path (std::string name) const;
1244 void rename_template (std::string old_name, std::string new_name) const;
1245 void delete_template (std::string name) const;
1247 boost::optional<BadReason> check_certificates () const;
1249 static Config* instance ();
1250 static void drop ();
1251 static void restore_defaults ();
1252 static bool have_existing (std::string);
1253 static boost::filesystem::path config_read_file ();
1254 static boost::filesystem::path config_write_file ();
1257 void maybe_set (T& member, T new_value, Property prop = OTHER) {
1258 if (member == new_value) {
1266 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
1267 if (member && member.get() == new_value) {
1276 void read () override;
1278 void read_cinemas();
1279 void read_dkdm_recipients();
1280 void set_defaults ();
1281 void set_kdm_email_to_default ();
1282 void set_notification_email_to_default ();
1283 void set_cover_sheet_to_default ();
1284 void read_cinemas (cxml::Document const & f);
1285 void read_dkdm_recipients (cxml::Document const & f);
1286 std::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
1287 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
1288 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
1289 void clean_history_internal (std::vector<boost::filesystem::path>& h);
1292 /** number of threads which a master DoM should use for J2K encoding on the local machine */
1293 int _master_encoding_threads;
1294 /** number of threads which a server should use for J2K encoding on the local machine */
1295 int _server_encoding_threads;
1296 /** default directory to put new films in */
1297 boost::optional<boost::filesystem::path> _default_directory;
1298 /** base port number to use for J2K encoding servers;
1299 * this port and the two above it will be used.
1301 int _server_port_base;
1302 /** true to broadcast on the `any' address to look for servers */
1303 bool _use_any_servers;
1304 /** J2K encoding servers that should definitely be used */
1305 std::vector<std::string> _servers;
1306 bool _only_servers_encode;
1307 FileTransferProtocol _tms_protocol;
1309 /** The IP address of a TMS that we can copy DCPs to */
1310 std::string _tms_ip;
1311 /** The path on a TMS that we should write DCPs to */
1312 std::string _tms_path;
1313 /** User name to log into the TMS with */
1314 std::string _tms_user;
1315 /** Password to log into the TMS with */
1316 std::string _tms_password;
1317 /** The list of possible DCP frame rates that DCP-o-matic will use */
1318 std::list<int> _allowed_dcp_frame_rates;
1319 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
1320 bool _allow_any_dcp_frame_rate;
1321 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
1322 DCPs at 25fps but will play 16:9, so this is very useful for some users.
1323 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
1325 bool _allow_any_container;
1326 bool _allow_96khz_audio;
1327 bool _use_all_audio_channels;
1328 /** Offer the upmixers in the audio processor settings */
1329 bool _show_experimental_audio_processors;
1330 boost::optional<std::string> _language;
1331 /** Default length of still image content (seconds) */
1332 int _default_still_length;
1333 DCPContentType const * _default_dcp_content_type;
1334 int _default_dcp_audio_channels;
1335 std::string _dcp_issuer;
1336 std::string _dcp_creator;
1337 std::string _dcp_company_name;
1338 std::string _dcp_product_name;
1339 std::string _dcp_product_version;
1340 std::string _dcp_j2k_comment;
1341 int _default_j2k_bandwidth;
1342 int _default_audio_delay;
1343 bool _default_interop;
1344 boost::optional<dcp::LanguageTag> _default_audio_language;
1345 boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
1346 std::map<std::string, std::string> _default_metadata;
1347 /** Default directory to offer to write KDMs to; if it's not set,
1348 the home directory will be offered.
1350 boost::optional<boost::filesystem::path> _default_kdm_directory;
1351 bool _upload_after_make_dcp;
1352 std::list<std::shared_ptr<Cinema>> _cinemas;
1353 std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
1354 std::string _mail_server;
1356 EmailProtocol _mail_protocol;
1357 std::string _mail_user;
1358 std::string _mail_password;
1359 std::string _kdm_subject;
1360 std::string _kdm_from;
1361 std::vector<std::string> _kdm_cc;
1362 std::string _kdm_bcc;
1363 std::string _kdm_email;
1364 std::string _notification_subject;
1365 std::string _notification_from;
1366 std::string _notification_to;
1367 std::vector<std::string> _notification_cc;
1368 std::string _notification_bcc;
1369 std::string _notification_email;
1370 std::shared_ptr<const dcp::CertificateChain> _signer_chain;
1371 /** Chain used to decrypt KDMs; the leaf of this chain is the target
1372 * certificate for making KDMs given to DCP-o-matic.
1374 std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
1375 /** true to check for updates on startup */
1376 bool _check_for_updates;
1377 bool _check_for_test_updates;
1378 /** maximum allowed J2K bandwidth in bits per second */
1379 int _maximum_j2k_bandwidth;
1381 bool _analyse_ebur128;
1382 bool _automatic_audio_analysis;
1383 #ifdef DCPOMATIC_WINDOWS
1384 bool _win32_console;
1386 std::vector<boost::filesystem::path> _history;
1387 std::vector<boost::filesystem::path> _player_history;
1388 std::shared_ptr<DKDMGroup> _dkdms;
1389 boost::filesystem::path _cinemas_file;
1390 boost::filesystem::path _dkdm_recipients_file;
1391 bool _show_hints_before_make_dcp;
1392 bool _confirm_kdm_email;
1393 dcp::NameFormat _kdm_filename_format;
1394 dcp::NameFormat _dkdm_filename_format;
1395 dcp::NameFormat _kdm_container_name_format;
1396 dcp::NameFormat _dcp_metadata_filename_format;
1397 dcp::NameFormat _dcp_asset_filename_format;
1398 bool _jump_to_selected;
1399 bool _nagged[NAG_COUNT];
1401 /** name of a specific sound output stream to use, or empty to use the default */
1402 boost::optional<std::string> _sound_output;
1403 std::string _cover_sheet;
1404 boost::optional<boost::filesystem::path> _last_player_load_directory;
1405 boost::optional<KDMWriteType> _last_kdm_write_type;
1406 boost::optional<DKDMWriteType> _last_dkdm_write_type;
1407 int _frames_in_memory_multiplier;
1408 boost::optional<int> _decode_reduction;
1409 bool _default_notify;
1410 bool _notification[NOTIFICATION_COUNT];
1411 boost::optional<std::string> _barco_username;
1412 boost::optional<std::string> _barco_password;
1413 boost::optional<std::string> _christie_username;
1414 boost::optional<std::string> _christie_password;
1415 boost::optional<std::string> _gdc_username;
1416 boost::optional<std::string> _gdc_password;
1417 PlayerMode _player_mode;
1419 VideoViewType _video_view_type;
1420 bool _respect_kdm_validity_periods;
1421 /** Log file containing debug information for the player */
1422 boost::optional<boost::filesystem::path> _player_debug_log_file;
1423 /** A directory containing DCPs whose contents are presented to the user
1424 in the dual-screen player mode. DCPs on the list can be loaded
1427 boost::optional<boost::filesystem::path> _player_content_directory;
1428 boost::optional<boost::filesystem::path> _player_playlist_directory;
1429 boost::optional<boost::filesystem::path> _player_kdm_directory;
1430 boost::optional<AudioMapping> _audio_mapping;
1431 std::vector<dcp::LanguageTag> _custom_languages;
1432 std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
1433 bool _use_isdcf_name_by_default;
1434 bool _write_kdms_to_disk;
1436 dcp::Formulation _default_kdm_type;
1437 RoughDuration _default_kdm_duration;
1438 double _auto_crop_threshold;
1439 boost::optional<std::string> _last_release_notes_version;
1440 boost::optional<int> _main_divider_sash_position;
1441 boost::optional<int> _main_content_divider_sash_position;
1442 DefaultAddFileLocation _default_add_file_location;
1443 bool _allow_smpte_bv20;
1444 int _isdcf_name_part_length;
1446 ExportConfig _export;
1448 static int const _current_version;
1450 /** Singleton instance, or 0 */
1451 static Config* _instance;