X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=9c3650f8d00af1d8cfb0f6f2b2ad1cf33136942a;hb=fcba100f0dfd1d4214291abb76f22ebd696c24d4;hp=87afcbba829bac3944a04494f55ca9e62f29fc26;hpb=a332bd6be323f03dad5b180fb237afe54f1bf81e;p=dcpomatic.git diff --git a/src/lib/config.h b/src/lib/config.h index 87afcbba8..9c3650f8d 100644 --- a/src/lib/config.h +++ b/src/lib/config.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2020 Carl Hetherington + Copyright (C) 2012-2022 Carl Hetherington This file is part of DCP-o-matic. @@ -22,29 +22,36 @@ * @brief Class holding configuration. */ + #ifndef DCPOMATIC_CONFIG_H #define DCPOMATIC_CONFIG_H -#include "isdcf_metadata.h" -#include "types.h" -#include "state.h" -#include "edid.h" + #include "audio_mapping.h" +#include "export_config.h" +#include "rough_duration.h" +#include "state.h" +#include "types.h" #include #include #include -#include +#include #include #include #include + +class Cinema; class CinemaSoundProcessor; class DCPContentType; -class Ratio; -class Cinema; -class Film; class DKDMGroup; class DKDMRecipient; +class Film; +class Ratio; + + +extern void save_all_config_as_zip (boost::filesystem::path zip_file); + /** @class Config * @brief A singleton class holding configuration. @@ -86,6 +93,7 @@ public: HISTORY, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS, AUDIO_MAPPING, + AUTO_CROP_THRESHOLD, OTHER }; @@ -142,11 +150,11 @@ public: return _tms_password; } - std::list > cinemas () const { + std::list> cinemas () const { return _cinemas; } - std::list > dkdm_recipients () const { + std::list> dkdm_recipients () const { return _dkdm_recipients; } @@ -162,12 +170,12 @@ public: return _allow_any_container; } - bool show_experimental_audio_processors () const { - return _show_experimental_audio_processors; + bool allow_96khz_audio () const { + return _allow_96khz_audio; } - ISDCFMetadata default_isdcf_metadata () const { - return _default_isdcf_metadata; + bool show_experimental_audio_processors () const { + return _show_experimental_audio_processors; } boost::optional language () const { @@ -226,6 +234,10 @@ public: return _default_interop; } + std::map default_metadata () const { + return _default_metadata; + } + bool upload_after_make_dcp () { return _upload_after_make_dcp; } @@ -302,11 +314,11 @@ public: return _notification_email; } - boost::shared_ptr signer_chain () const { + std::shared_ptr signer_chain () const { return _signer_chain; } - boost::shared_ptr decryption_chain () const { + std::shared_ptr decryption_chain () const { return _decryption_chain; } @@ -348,7 +360,7 @@ public: return _player_history; } - boost::shared_ptr dkdms () const { + std::shared_ptr dkdms () const { return _dkdms; } @@ -392,14 +404,19 @@ public: return _jump_to_selected; } + /* This could be an enum class but we use the enum a lot to index _nagged + * so it means a lot of casts. + */ enum Nag { NAG_DKDM_CONFIG, NAG_ENCRYPTED_METADATA, NAG_ALTER_DECRYPTION_CHAIN, - NAG_BAD_SIGNER_CHAIN, + NAG_BAD_SIGNER_CHAIN_UTF8, NAG_IMPORT_DECRYPTION_CHAIN, NAG_DELETE_DKDM, NAG_32_ON_64, + NAG_TOO_MANY_DROPPED_FRAMES, + NAG_BAD_SIGNER_CHAIN_VALIDITY, NAG_COUNT }; @@ -515,10 +532,6 @@ public: return _respect_kdm_validity_periods; } - boost::optional player_activity_log_file () const { - return _player_activity_log_file; - } - boost::optional player_debug_log_file () const { return _player_debug_log_file; } @@ -537,6 +550,38 @@ public: AudioMapping audio_mapping (int output_channels); + std::vector custom_languages () const { + return _custom_languages; + } + + boost::optional add_files_path () const { + return _add_files_path; + } + + bool use_isdcf_name_by_default () const { + return _use_isdcf_name_by_default; + } + + bool write_kdms_to_disk () const { + return _write_kdms_to_disk; + } + + bool email_kdms () const { + return _email_kdms; + } + + dcp::Formulation default_kdm_type () const { + return _default_kdm_type; + } + + RoughDuration default_kdm_duration () const { + return _default_kdm_duration; + } + + double auto_crop_threshold () const { + return _auto_crop_threshold; + } + /* SET (mostly) */ void set_master_encoding_threads (int n) { @@ -588,22 +633,22 @@ public: maybe_set (_tms_password, p); } - void add_cinema (boost::shared_ptr c) { + void add_cinema (std::shared_ptr c) { _cinemas.push_back (c); changed (CINEMAS); } - void remove_cinema (boost::shared_ptr c) { + void remove_cinema (std::shared_ptr c) { _cinemas.remove (c); changed (CINEMAS); } - void add_dkdm_recipient (boost::shared_ptr c) { + void add_dkdm_recipient (std::shared_ptr c) { _dkdm_recipients.push_back (c); changed (DKDM_RECIPIENTS); } - void remove_dkdm_recipient (boost::shared_ptr c) { + void remove_dkdm_recipient (std::shared_ptr c) { _dkdm_recipients.remove (c); changed (DKDM_RECIPIENTS); } @@ -620,12 +665,12 @@ public: maybe_set (_allow_any_container, a); } - void set_show_experimental_audio_processors (bool e) { - maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS); + void set_allow_96hhz_audio (bool a) { + maybe_set (_allow_96khz_audio, a); } - void set_default_isdcf_metadata (ISDCFMetadata d) { - maybe_set (_default_isdcf_metadata, d); + void set_show_experimental_audio_processors (bool e) { + maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS); } void set_language (std::string l) { @@ -697,6 +742,10 @@ public: maybe_set (_default_interop, i); } + void set_default_metadata (std::map const& metadata) { + maybe_set (_default_metadata, metadata); + } + void set_upload_after_make_dcp (bool u) { maybe_set (_upload_after_make_dcp, u); } @@ -769,11 +818,11 @@ public: void reset_notification_email (); - void set_signer_chain (boost::shared_ptr s) { + void set_signer_chain (std::shared_ptr s) { maybe_set (_signer_chain, s); } - void set_decryption_chain (boost::shared_ptr c) { + void set_decryption_chain (std::shared_ptr c) { maybe_set (_decryption_chain, c); } @@ -810,15 +859,13 @@ public: } #endif - void set_dkdms (boost::shared_ptr dkdms) { + void set_dkdms (std::shared_ptr dkdms) { _dkdms = dkdms; changed (); } void set_cinemas_file (boost::filesystem::path file); - void set_dkdm_recipients_file (boost::filesystem::path file); - void set_show_hints_before_make_dcp (bool s) { maybe_set (_show_hints_before_make_dcp, s); } @@ -985,18 +1032,6 @@ public: maybe_set (_respect_kdm_validity_periods, r); } - void set_player_activity_log_file (boost::filesystem::path p) { - maybe_set (_player_activity_log_file, p); - } - - void unset_player_activity_log_file () { - if (!_player_activity_log_file) { - return; - } - _player_activity_log_file = boost::none; - changed (); - } - void set_player_debug_log_file (boost::filesystem::path p) { maybe_set (_player_debug_log_file, p, PLAYER_DEBUG_LOG); } @@ -1048,6 +1083,41 @@ public: void set_audio_mapping (AudioMapping m); void set_audio_mapping_to_default (); + void add_custom_language (dcp::LanguageTag tag); + + void set_add_files_path (boost::filesystem::path p) { + _add_files_path = p; + changed (); + } + + void set_use_isdcf_name_by_default (bool use) { + maybe_set (_use_isdcf_name_by_default, use); + } + + void set_write_kdms_to_disk (bool write) { + maybe_set (_write_kdms_to_disk, write); + } + + void set_email_kdms (bool email) { + maybe_set (_email_kdms, email); + } + + void set_default_kdm_type (dcp::Formulation type) { + maybe_set (_default_kdm_type, type); + } + + void set_default_kdm_duration (RoughDuration duration) { + maybe_set (_default_kdm_duration, duration); + } + + void set_auto_crop_threshold (double threshold) { + maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD); + } + + ExportConfig& export_config() { + return _export; + } + void changed (Property p = OTHER); boost::signals2::signal Changed; /** Emitted if read() failed on an existing Config file. There is nothing @@ -1060,14 +1130,15 @@ public: * true to ask Config to solve the problem (by discarding and recreating the bad thing) */ enum BadReason { - BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING) - BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent - BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent + BAD_SIGNER_UTF8_STRINGS, ///< signer chain contains UTF-8 strings (not PRINTABLESTRING) + BAD_SIGNER_INCONSISTENT, ///< signer chain is somehow inconsistent + BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent + BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years }; static boost::signals2::signal Bad; - void write () const; + void write () const override; void write_config () const; void write_cinemas () const; void write_dkdm_recipients () const; @@ -1075,33 +1146,22 @@ public: void copy_and_link (boost::filesystem::path new_file) const; bool have_write_permission () const; - void save_template (boost::shared_ptr film, std::string name) const; + void save_template (std::shared_ptr film, std::string name) const; bool existing_template (std::string name) const; std::list templates () const; - boost::filesystem::path template_path (std::string name) const; + boost::filesystem::path template_read_path (std::string name) const; + boost::filesystem::path template_write_path (std::string name) const; void rename_template (std::string old_name, std::string new_name) const; void delete_template (std::string name) const; + boost::optional check_certificates () const; + static Config* instance (); static void drop (); static void restore_defaults (); static bool have_existing (std::string); - static boost::filesystem::path config_file (); - -private: - Config (); - void read (); - void set_defaults (); - void set_kdm_email_to_default (); - void set_notification_email_to_default (); - void set_cover_sheet_to_default (); - void read_cinemas (cxml::Document const & f); - void read_dkdm_recipients (cxml::Document const & f); - boost::shared_ptr create_certificate_chain (); - boost::filesystem::path directory_or (boost::optional dir, boost::filesystem::path a) const; - void add_to_history_internal (std::vector& h, boost::filesystem::path p); - void clean_history_internal (std::vector& h); - void backup (); + static boost::filesystem::path config_read_file (); + static boost::filesystem::path config_write_file (); template void maybe_set (T& member, T new_value, Property prop = OTHER) { @@ -1121,6 +1181,21 @@ private: changed (prop); } +private: + Config (); + void read () override; + void set_defaults (); + void set_kdm_email_to_default (); + void set_notification_email_to_default (); + void set_cover_sheet_to_default (); + void read_cinemas (cxml::Document const & f); + void read_dkdm_recipients (cxml::Document const & f); + std::shared_ptr create_certificate_chain (); + boost::filesystem::path directory_or (boost::optional dir, boost::filesystem::path a) const; + void add_to_history_internal (std::vector& h, boost::filesystem::path p); + void clean_history_internal (std::vector& h); + void backup (); + /** number of threads which a master DoM should use for J2K encoding on the local machine */ int _master_encoding_threads; /** number of threads which a server should use for J2K encoding on the local machine */ @@ -1154,10 +1229,9 @@ private: https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468 */ bool _allow_any_container; + bool _allow_96khz_audio; /** Offer the upmixers in the audio processor settings */ bool _show_experimental_audio_processors; - /** Default ISDCF metadata for newly-created Films */ - ISDCFMetadata _default_isdcf_metadata; boost::optional _language; /** Default length of still image content (seconds) */ int _default_still_length; @@ -1173,13 +1247,14 @@ private: int _default_j2k_bandwidth; int _default_audio_delay; bool _default_interop; + std::map _default_metadata; /** Default directory to offer to write KDMs to; if it's not set, the home directory will be offered. */ boost::optional _default_kdm_directory; bool _upload_after_make_dcp; - std::list > _cinemas; - std::list > _dkdm_recipients; + std::list> _cinemas; + std::list> _dkdm_recipients; std::string _mail_server; int _mail_port; EmailProtocol _mail_protocol; @@ -1196,11 +1271,11 @@ private: std::vector _notification_cc; std::string _notification_bcc; std::string _notification_email; - boost::shared_ptr _signer_chain; + std::shared_ptr _signer_chain; /** Chain used to decrypt KDMs; the leaf of this chain is the target * certificate for making KDMs given to DCP-o-matic. */ - boost::shared_ptr _decryption_chain; + std::shared_ptr _decryption_chain; /** true to check for updates on startup */ bool _check_for_updates; bool _check_for_test_updates; @@ -1214,7 +1289,7 @@ private: #endif std::vector _history; std::vector _player_history; - boost::shared_ptr _dkdms; + std::shared_ptr _dkdms; boost::filesystem::path _cinemas_file; boost::filesystem::path _dkdm_recipients_file; bool _show_hints_before_make_dcp; @@ -1247,10 +1322,6 @@ private: int _image_display; VideoViewType _video_view_type; bool _respect_kdm_validity_periods; - /** Log file containing things the player does (e.g. started, stopped, loaded - playlist etc.) Does not contain debugging information. - */ - boost::optional _player_activity_log_file; /** Log file containing debug information for the player */ boost::optional _player_debug_log_file; /** A directory containing DCPs whose contents are presented to the user @@ -1261,6 +1332,16 @@ private: boost::optional _player_playlist_directory; boost::optional _player_kdm_directory; boost::optional _audio_mapping; + std::vector _custom_languages; + boost::optional _add_files_path; + bool _use_isdcf_name_by_default; + bool _write_kdms_to_disk; + bool _email_kdms; + dcp::Formulation _default_kdm_type; + RoughDuration _default_kdm_duration; + double _auto_crop_threshold; + + ExportConfig _export; static int const _current_version; @@ -1268,4 +1349,5 @@ private: static Config* _instance; }; + #endif