X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=9727bac1a16f0fc03398fa54c3643e0f3f255d57;hp=7f8dd0cd4be183b5259009fc1cc0d6c65f4243ce;hb=f706bbb9afd10472e81a051cd5db601d6404377c;hpb=627cf204ede4204b58c385c30e82561cfc93d28c diff --git a/src/lib/config.h b/src/lib/config.h index 7f8dd0cd4..9727bac1a 100644 --- a/src/lib/config.h +++ b/src/lib/config.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2018 Carl Hetherington + Copyright (C) 2012-2022 Carl Hetherington This file is part of DCP-o-matic. @@ -22,31 +22,41 @@ * @brief Class holding configuration. */ + #ifndef DCPOMATIC_CONFIG_H #define DCPOMATIC_CONFIG_H -#include "isdcf_metadata.h" + +#include "audio_mapping.h" +#include "export_config.h" +#include "rough_duration.h" +#include "state.h" #include "types.h" -#include "edid.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. */ -class Config : public boost::noncopyable +class Config : public State { public: /** @return number of threads which a master DoM should use for J2K encoding on the local machine */ @@ -74,16 +84,16 @@ public: USE_ANY_SERVERS, SERVERS, CINEMAS, + DKDM_RECIPIENTS, SOUND, SOUND_OUTPUT, - INTERFACE_COMPLEXITY, PLAYER_CONTENT_DIRECTORY, PLAYER_PLAYLIST_DIRECTORY, PLAYER_DEBUG_LOG, HISTORY, -#ifdef DCPOMATIC_VARIANT_SWAROOP - PLAYER_BACKGROUND_IMAGE, -#endif + SHOW_EXPERIMENTAL_AUDIO_PROCESSORS, + AUDIO_MAPPING, + AUTO_CROP_THRESHOLD, OTHER }; @@ -116,7 +126,7 @@ public: return _only_servers_encode; } - Protocol tms_protocol () const { + FileTransferProtocol tms_protocol () const { return _tms_protocol; } @@ -140,13 +150,12 @@ public: return _tms_password; } - /** @return The cinema sound processor that we are using */ - CinemaSoundProcessor const * cinema_sound_processor () const { - return _cinema_sound_processor; + std::list> cinemas () const { + return _cinemas; } - std::list > cinemas () const { - return _cinemas; + std::list> dkdm_recipients () const { + return _dkdm_recipients; } std::list allowed_dcp_frame_rates () const { @@ -161,8 +170,16 @@ public: return _allow_any_container; } - ISDCFMetadata default_isdcf_metadata () const { - return _default_isdcf_metadata; + bool allow_96khz_audio () const { + return _allow_96khz_audio; + } + + bool use_all_audio_channels () const { + return _use_all_audio_channels; + } + + bool show_experimental_audio_processors () const { + return _show_experimental_audio_processors; } boost::optional language () const { @@ -177,10 +194,6 @@ public: return _default_container; } - Ratio const * default_scale_to () const { - return _default_scale_to; - } - DCPContentType const * default_dcp_content_type () const { return _default_dcp_content_type; } @@ -197,6 +210,22 @@ public: return _dcp_creator; } + std::string dcp_company_name () const { + return _dcp_company_name; + } + + std::string dcp_product_name () const { + return _dcp_product_name; + } + + std::string dcp_product_version () const { + return _dcp_product_version; + } + + std::string dcp_j2k_comment () const { + return _dcp_j2k_comment; + } + int default_j2k_bandwidth () const { return _default_j2k_bandwidth; } @@ -209,8 +238,12 @@ public: return _default_interop; } - bool default_upload_after_make_dcp () { - return _default_upload_after_make_dcp; + std::map default_metadata () const { + return _default_metadata; + } + + bool upload_after_make_dcp () { + return _upload_after_make_dcp; } void set_default_kdm_directory (boost::filesystem::path d) { @@ -229,6 +262,10 @@ public: return _mail_port; } + EmailProtocol mail_protocol () const { + return _mail_protocol; + } + std::string mail_user () const { return _mail_user; } @@ -281,11 +318,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; } @@ -327,7 +364,7 @@ public: return _player_history; } - boost::shared_ptr dkdms () const { + std::shared_ptr dkdms () const { return _dkdms; } @@ -335,6 +372,10 @@ public: return _cinemas_file; } + boost::filesystem::path dkdm_recipients_file () const { + return _dkdm_recipients_file; + } + bool show_hints_before_make_dcp () const { return _show_hints_before_make_dcp; } @@ -351,6 +392,10 @@ public: return _kdm_filename_format; } + dcp::NameFormat dkdm_filename_format () const { + return _dkdm_filename_format; + } + dcp::NameFormat dcp_metadata_filename_format () const { return _dcp_metadata_filename_format; } @@ -363,14 +408,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_REMAKE_DECRYPTION_CHAIN, - NAG_BAD_SIGNER_CHAIN, - /* Not really a nag but it's the same idea */ - NAG_INITIAL_SETUP, + NAG_ALTER_DECRYPTION_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 }; @@ -459,19 +509,10 @@ public: return _gdc_password; } - enum Interface { - INTERFACE_SIMPLE, - INTERFACE_FULL - }; - - Interface interface_complexity () const { - return _interface_complexity; - } - enum PlayerMode { - PLAYER_MODE_WINDOW, - PLAYER_MODE_FULL, - PLAYER_MODE_DUAL + PLAYER_MODE_WINDOW, ///< one window containing image and controls + PLAYER_MODE_FULL, ///< just the image filling the screen + PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other }; PlayerMode player_mode () const { @@ -482,12 +523,17 @@ public: return _image_display; } - bool respect_kdm_validity_periods () const { - return _respect_kdm_validity_periods; + enum VideoViewType { + VIDEO_VIEW_SIMPLE, + VIDEO_VIEW_OPENGL + }; + + VideoViewType video_view_type () const { + return _video_view_type; } - boost::optional player_activity_log_file () const { - return _player_activity_log_file; + bool respect_kdm_validity_periods () const { + return _respect_kdm_validity_periods; } boost::optional player_debug_log_file () const { @@ -506,35 +552,43 @@ public: return _player_kdm_directory; } -#ifdef DCPOMATIC_VARIANT_SWAROOP - boost::optional player_background_image () const { - return _player_background_image; + AudioMapping audio_mapping (int output_channels); + + std::vector custom_languages () const { + return _custom_languages; } - std::string kdm_server_url () const { - return _kdm_server_url; + boost::optional add_files_path () const { + return _add_files_path; } - std::string player_watermark_theatre () const { - return _player_watermark_theatre; + bool use_isdcf_name_by_default () const { + return _use_isdcf_name_by_default; } - int player_watermark_period () const { - return _player_watermark_period; + bool write_kdms_to_disk () const { + return _write_kdms_to_disk; } - int player_watermark_duration () const { - return _player_watermark_duration; + bool email_kdms () const { + return _email_kdms; } - std::vector required_monitors () const { - return _required_monitors; + dcp::Formulation default_kdm_type () const { + return _default_kdm_type; } - boost::optional player_lock_file () const { - return _player_lock_file; + RoughDuration default_kdm_duration () const { + return _default_kdm_duration; + } + + double auto_crop_threshold () const { + return _auto_crop_threshold; + } + + boost::optional last_release_notes_version () const { + return _last_release_notes_version; } -#endif /* SET (mostly) */ @@ -563,7 +617,7 @@ public: maybe_set (_only_servers_encode, o); } - void set_tms_protocol (Protocol p) { + void set_tms_protocol (FileTransferProtocol p) { maybe_set (_tms_protocol, p); } @@ -587,16 +641,26 @@ 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 (std::shared_ptr c) { + _dkdm_recipients.push_back (c); + changed (DKDM_RECIPIENTS); + } + + void remove_dkdm_recipient (std::shared_ptr c) { + _dkdm_recipients.remove (c); + changed (DKDM_RECIPIENTS); + } + void set_allowed_dcp_frame_rates (std::list const & r) { maybe_set (_allowed_dcp_frame_rates, r); } @@ -609,8 +673,16 @@ public: maybe_set (_allow_any_container, a); } - void set_default_isdcf_metadata (ISDCFMetadata d) { - maybe_set (_default_isdcf_metadata, d); + void set_allow_96hhz_audio (bool a) { + maybe_set (_allow_96khz_audio, a); + } + + void set_use_all_audio_channels (bool a) { + maybe_set (_use_all_audio_channels, a); + } + + 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) { @@ -638,10 +710,6 @@ public: maybe_set (_default_container, c); } - void set_default_scale_to (Ratio const * c) { - maybe_set (_default_scale_to, c); - } - void set_default_dcp_content_type (DCPContentType const * t) { maybe_set (_default_dcp_content_type, t); } @@ -658,6 +726,22 @@ public: maybe_set (_dcp_creator, c); } + void set_dcp_company_name (std::string c) { + maybe_set (_dcp_company_name, c); + } + + void set_dcp_product_name (std::string c) { + maybe_set (_dcp_product_name, c); + } + + void set_dcp_product_version (std::string c) { + maybe_set (_dcp_product_version, c); + } + + void set_dcp_j2k_comment (std::string c) { + maybe_set (_dcp_j2k_comment, c); + } + void set_default_j2k_bandwidth (int b) { maybe_set (_default_j2k_bandwidth, b); } @@ -670,8 +754,12 @@ public: maybe_set (_default_interop, i); } - void set_default_upload_after_make_dcp (bool u) { - maybe_set (_default_upload_after_make_dcp, u); + 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); } void set_mail_server (std::string s) { @@ -682,6 +770,10 @@ public: maybe_set (_mail_port, p); } + void set_mail_protocol (EmailProtocol p) { + maybe_set (_mail_protocol, p); + } + void set_mail_user (std::string u) { maybe_set (_mail_user, u); } @@ -738,11 +830,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); } @@ -779,7 +871,7 @@ public: } #endif - void set_dkdms (boost::shared_ptr dkdms) { + void set_dkdms (std::shared_ptr dkdms) { _dkdms = dkdms; changed (); } @@ -831,6 +923,10 @@ public: maybe_set (_kdm_filename_format, n); } + void set_dkdm_filename_format (dcp::NameFormat n) { + maybe_set (_dkdm_filename_format, n); + } + void set_dcp_metadata_filename_format (dcp::NameFormat n) { maybe_set (_dcp_metadata_filename_format, n); } @@ -932,10 +1028,6 @@ public: maybe_set (_gdc_password, boost::optional()); } - void set_interface_complexity (Interface i) { - maybe_set (_interface_complexity, i, INTERFACE_COMPLEXITY); - } - void set_player_mode (PlayerMode m) { maybe_set (_player_mode, m); } @@ -944,20 +1036,12 @@ public: maybe_set (_image_display, n); } - void set_respect_kdm_validity_periods (bool r) { - maybe_set (_respect_kdm_validity_periods, r); + void set_video_view_type (VideoViewType v) { + maybe_set (_video_view_type, v); } - 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_respect_kdm_validity_periods (bool r) { + maybe_set (_respect_kdm_validity_periods, r); } void set_player_debug_log_file (boost::filesystem::path p) { @@ -1008,51 +1092,47 @@ public: changed (); } -#ifdef DCPOMATIC_VARIANT_SWAROOP - void set_player_background_image (boost::filesystem::path p) { - maybe_set (_player_background_image, p, PLAYER_BACKGROUND_IMAGE); + 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 unset_player_background_image () { - if (!_player_background_image) { - return; - } - _player_background_image = boost::none; - changed (PLAYER_BACKGROUND_IMAGE); + void set_use_isdcf_name_by_default (bool use) { + maybe_set (_use_isdcf_name_by_default, use); } - void set_kdm_server_url (std::string s) { - maybe_set (_kdm_server_url, s); + void set_write_kdms_to_disk (bool write) { + maybe_set (_write_kdms_to_disk, write); } - void set_player_watermark_theatre (std::string p) { - maybe_set (_player_watermark_theatre, p); + void set_email_kdms (bool email) { + maybe_set (_email_kdms, email); } - void set_player_watermark_period (int minutes) { - maybe_set (_player_watermark_period, minutes); + void set_default_kdm_type (dcp::Formulation type) { + maybe_set (_default_kdm_type, type); } - void set_player_watermark_duration (int milliseconds) { - maybe_set (_player_watermark_duration, milliseconds); + void set_default_kdm_duration (RoughDuration duration) { + maybe_set (_default_kdm_duration, duration); } - void set_required_monitors (std::vector monitors) { - maybe_set (_required_monitors, monitors); + void set_auto_crop_threshold (double threshold) { + maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD); } - void set_player_lock_file (boost::filesystem::path p) { - maybe_set (_player_lock_file, p); + void set_last_release_notes_version (std::string version) { + maybe_set (_last_release_notes_version, version); } - void unset_player_lock_file () { - if (!_player_lock_file) { - return; - } - _player_lock_file = boost::none; - changed (); + ExportConfig& export_config() { + return _export; } -#endif void changed (Property p = OTHER); boost::signals2::signal Changed; @@ -1062,48 +1142,42 @@ public: static boost::signals2::signal FailedToLoad; /** Emitted if read() issued a warning which the user might want to know about */ static boost::signals2::signal Warning; - /** Emitted if there is a bad certificate in the signer chain. Handler can call - * true to ask Config to re-create the chain. + /** Emitted if there is a something wrong the contents of our config. Handler can call + * true to ask Config to solve the problem (by discarding and recreating the bad thing) */ - static boost::signals2::signal BadSignerChain; + 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_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years + }; - void write () const; + static boost::signals2::signal Bad; + + void write () const override; void write_config () const; void write_cinemas () const; + void write_dkdm_recipients () const; void link (boost::filesystem::path new_file) const; 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 (); - static boost::filesystem::path path (std::string file, bool create_directories = true); - - /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */ - static boost::optional override_path; - -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); - 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) { @@ -1123,6 +1197,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 */ @@ -1138,7 +1227,7 @@ private: /** J2K encoding servers that should definitely be used */ std::vector _servers; bool _only_servers_encode; - Protocol _tms_protocol; + FileTransferProtocol _tms_protocol; /** The IP address of a TMS that we can copy DCPs to */ std::string _tms_ip; /** The path on a TMS that we should write DCPs to */ @@ -1147,8 +1236,6 @@ private: std::string _tms_user; /** Password to log into the TMS with */ std::string _tms_password; - /** Our cinema sound processor */ - CinemaSoundProcessor const * _cinema_sound_processor; /** The list of possible DCP frame rates that DCP-o-matic will use */ std::list _allowed_dcp_frame_rates; /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */ @@ -1158,28 +1245,36 @@ private: https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468 */ bool _allow_any_container; - /** Default ISDCF metadata for newly-created Films */ - ISDCFMetadata _default_isdcf_metadata; + bool _allow_96khz_audio; + bool _use_all_audio_channels; + /** Offer the upmixers in the audio processor settings */ + bool _show_experimental_audio_processors; boost::optional _language; /** Default length of still image content (seconds) */ int _default_still_length; Ratio const * _default_container; - Ratio const * _default_scale_to; DCPContentType const * _default_dcp_content_type; int _default_dcp_audio_channels; std::string _dcp_issuer; std::string _dcp_creator; + std::string _dcp_company_name; + std::string _dcp_product_name; + std::string _dcp_product_version; + std::string _dcp_j2k_comment; 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 _default_upload_after_make_dcp; - std::list > _cinemas; + bool _upload_after_make_dcp; + std::list> _cinemas; + std::list> _dkdm_recipients; std::string _mail_server; int _mail_port; + EmailProtocol _mail_protocol; std::string _mail_user; std::string _mail_password; std::string _kdm_subject; @@ -1193,17 +1288,11 @@ private: std::vector _notification_cc; std::string _notification_bcc; std::string _notification_email; - boost::shared_ptr _signer_chain; -#ifdef DCPOMATIC_VARIANT_SWAROOP - boost::filesystem::path _signer_chain_path; -#endif + 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; -#ifdef DCPOMATIC_VARIANT_SWAROOP - boost::filesystem::path _decryption_chain_path; -#endif + std::shared_ptr _decryption_chain; /** true to check for updates on startup */ bool _check_for_updates; bool _check_for_test_updates; @@ -1217,11 +1306,13 @@ 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; bool _confirm_kdm_email; dcp::NameFormat _kdm_filename_format; + dcp::NameFormat _dkdm_filename_format; dcp::NameFormat _kdm_container_name_format; dcp::NameFormat _dcp_metadata_filename_format; dcp::NameFormat _dcp_asset_filename_format; @@ -1244,14 +1335,10 @@ private: boost::optional _christie_password; boost::optional _gdc_username; boost::optional _gdc_password; - Interface _interface_complexity; PlayerMode _player_mode; 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,18 +1348,18 @@ private: boost::optional _player_content_directory; boost::optional _player_playlist_directory; boost::optional _player_kdm_directory; -#ifdef DCPOMATIC_VARIANT_SWAROOP - boost::optional _player_background_image; - std::string _kdm_server_url; - std::string _player_watermark_theatre; - /** watermark period in minutes */ - int _player_watermark_period; - /** watermark duration in milliseconds */ - int _player_watermark_duration; - std::vector _required_monitors; - /** a file which, if specified, must be present for the player to work */ - boost::optional _player_lock_file; -#endif + 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; + boost::optional _last_release_notes_version; + + ExportConfig _export; static int const _current_version; @@ -1280,4 +1367,5 @@ private: static Config* _instance; }; + #endif