X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=7494074036c0fb01772d0c25cb4a0749a1b3ed50;hp=58db9c2802175a728c29caa73e2f3c6a719534d7;hb=8f12e84009d7c2685bb2eeb32665876463d4e6e5;hpb=33a2c1355cc52372565835638bea0dab1e3f85a1 diff --git a/src/lib/config.h b/src/lib/config.h index 58db9c280..749407403 100644 --- a/src/lib/config.h +++ b/src/lib/config.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2018 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington This file is part of DCP-o-matic. @@ -27,6 +27,9 @@ #include "isdcf_metadata.h" #include "types.h" +#include "state.h" +#include "edid.h" +#include "audio_mapping.h" #include #include #include @@ -45,7 +48,7 @@ class DKDMGroup; /** @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 */ @@ -76,6 +79,15 @@ public: SOUND, SOUND_OUTPUT, INTERFACE_COMPLEXITY, + PLAYER_CONTENT_DIRECTORY, + PLAYER_PLAYLIST_DIRECTORY, + PLAYER_DEBUG_LOG, + HISTORY, + SHOW_EXPERIMENTAL_AUDIO_PROCESSORS, + AUDIO_MAPPING, +#ifdef DCPOMATIC_VARIANT_SWAROOP + PLAYER_BACKGROUND_IMAGE, +#endif OTHER }; @@ -108,7 +120,7 @@ public: return _only_servers_encode; } - Protocol tms_protocol () const { + FileTransferProtocol tms_protocol () const { return _tms_protocol; } @@ -132,11 +144,6 @@ 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; } @@ -153,6 +160,10 @@ public: return _allow_any_container; } + bool show_experimental_audio_processors () const { + return _show_experimental_audio_processors; + } + ISDCFMetadata default_isdcf_metadata () const { return _default_isdcf_metadata; } @@ -221,6 +232,10 @@ public: return _mail_port; } + EmailProtocol mail_protocol () const { + return _mail_protocol; + } + std::string mail_user () const { return _mail_user; } @@ -358,8 +373,13 @@ public: enum Nag { NAG_DKDM_CONFIG, NAG_ENCRYPTED_METADATA, - NAG_REMAKE_DECRYPTION_CHAIN, + NAG_ALTER_DECRYPTION_CHAIN, NAG_BAD_SIGNER_CHAIN, + /* Not really a nag but it's the same idea */ + NAG_INITIAL_SETUP, + NAG_IMPORT_DECRYPTION_CHAIN, + NAG_DELETE_DKDM, + NAG_32_ON_64, NAG_COUNT }; @@ -457,6 +477,85 @@ public: return _interface_complexity; } + enum PlayerMode { + 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 { + return _player_mode; + } + + int image_display () const { + return _image_display; + } + + enum VideoViewType { + VIDEO_VIEW_SIMPLE, + VIDEO_VIEW_OPENGL + }; + + VideoViewType video_view_type () const { + return _video_view_type; + } + + bool respect_kdm_validity_periods () const { + 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; + } + + boost::optional player_content_directory () const { + return _player_content_directory; + } + + boost::optional player_playlist_directory () const { + return _player_playlist_directory; + } + + boost::optional player_kdm_directory () const { + return _player_kdm_directory; + } + + AudioMapping audio_mapping (int output_channels); + +#ifdef DCPOMATIC_VARIANT_SWAROOP + boost::optional player_background_image () const { + return _player_background_image; + } + + std::string kdm_server_url () const { + return _kdm_server_url; + } + + std::string player_watermark_theatre () const { + return _player_watermark_theatre; + } + + int player_watermark_period () const { + return _player_watermark_period; + } + + int player_watermark_duration () const { + return _player_watermark_duration; + } + + std::vector required_monitors () const { + return _required_monitors; + } + + boost::optional player_lock_file () const { + return _player_lock_file; + } +#endif + /* SET (mostly) */ void set_master_encoding_threads (int n) { @@ -484,7 +583,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); } @@ -530,6 +629,10 @@ 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_default_isdcf_metadata (ISDCFMetadata d) { maybe_set (_default_isdcf_metadata, d); } @@ -603,6 +706,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); } @@ -783,7 +890,9 @@ public: } void add_to_history (boost::filesystem::path p); + void clean_history (); void add_to_player_history (boost::filesystem::path p); + void clean_player_history (); void set_jump_to_selected (bool j) { maybe_set (_jump_to_selected, j); @@ -855,6 +964,131 @@ public: maybe_set (_interface_complexity, i, INTERFACE_COMPLEXITY); } + void set_player_mode (PlayerMode m) { + maybe_set (_player_mode, m); + } + + void set_image_display (int n) { + maybe_set (_image_display, n); + } + + void set_video_view_type (VideoViewType v) { + maybe_set (_video_view_type, v); + } + + void set_respect_kdm_validity_periods (bool r) { + 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); + } + + void unset_player_debug_log_file () { + if (!_player_debug_log_file) { + return; + } + _player_debug_log_file = boost::none; + changed (PLAYER_DEBUG_LOG); + } + + void set_player_content_directory (boost::filesystem::path p) { + maybe_set (_player_content_directory, p, PLAYER_CONTENT_DIRECTORY); + } + + void unset_player_content_directory () { + if (!_player_content_directory) { + return; + } + _player_content_directory = boost::none; + changed (PLAYER_CONTENT_DIRECTORY); + } + + void set_player_playlist_directory (boost::filesystem::path p) { + maybe_set (_player_playlist_directory, p, PLAYER_PLAYLIST_DIRECTORY); + } + + void unset_player_playlist_directory () { + if (!_player_playlist_directory) { + return; + } + _player_playlist_directory = boost::none; + changed (PLAYER_PLAYLIST_DIRECTORY); + } + + void set_player_kdm_directory (boost::filesystem::path p) { + maybe_set (_player_kdm_directory, p); + } + + void unset_player_kdm_directory () { + if (!_player_kdm_directory) { + return; + } + _player_kdm_directory = boost::none; + changed (); + } + + void set_audio_mapping (AudioMapping m); + void set_audio_mapping_to_default (); + +#ifdef DCPOMATIC_VARIANT_SWAROOP + void set_player_background_image (boost::filesystem::path p) { + maybe_set (_player_background_image, p, PLAYER_BACKGROUND_IMAGE); + } + + void unset_player_background_image () { + if (!_player_background_image) { + return; + } + _player_background_image = boost::none; + changed (PLAYER_BACKGROUND_IMAGE); + } + + void set_kdm_server_url (std::string s) { + maybe_set (_kdm_server_url, s); + } + + void set_player_watermark_theatre (std::string p) { + maybe_set (_player_watermark_theatre, p); + } + + void set_player_watermark_period (int minutes) { + maybe_set (_player_watermark_period, minutes); + } + + void set_player_watermark_duration (int milliseconds) { + maybe_set (_player_watermark_duration, milliseconds); + } + + void set_required_monitors (std::vector monitors) { + maybe_set (_required_monitors, monitors); + } + + void set_player_lock_file (boost::filesystem::path p) { + maybe_set (_player_lock_file, p); + } + + void unset_player_lock_file () { + if (!_player_lock_file) { + return; + } + _player_lock_file = boost::none; + changed (); + } +#endif + void changed (Property p = OTHER); boost::signals2::signal Changed; /** Emitted if read() failed on an existing Config file. There is nothing @@ -863,16 +1097,23 @@ 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 + }; + + static boost::signals2::signal Bad; void write () const; void write_config () const; void write_cinemas () 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; bool existing_template (std::string name) const; @@ -887,12 +1128,8 @@ public: static bool have_existing (std::string); static boost::filesystem::path config_file (); - /** 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 (); - static boost::filesystem::path path (std::string file, bool create_directories = true); void read (); void set_defaults (); void set_kdm_email_to_default (); @@ -902,6 +1139,7 @@ private: 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 (); template @@ -937,7 +1175,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 */ @@ -946,8 +1184,7 @@ 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 */ bool _allow_any_dcp_frame_rate; @@ -956,6 +1193,8 @@ private: https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468 */ bool _allow_any_container; + /** 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; @@ -978,6 +1217,7 @@ private: std::list > _cinemas; std::string _mail_server; int _mail_port; + EmailProtocol _mail_protocol; std::string _mail_user; std::string _mail_password; std::string _kdm_subject; @@ -992,10 +1232,16 @@ private: std::string _notification_bcc; std::string _notification_email; boost::shared_ptr _signer_chain; +#ifdef DCPOMATIC_VARIANT_SWAROOP + boost::filesystem::path _signer_chain_path; +#endif /** 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 /** true to check for updates on startup */ bool _check_for_updates; bool _check_for_test_updates; @@ -1037,6 +1283,36 @@ private: 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 + in the dual-screen player mode. DCPs on the list can be loaded + for playback. + */ + boost::optional _player_content_directory; + boost::optional _player_playlist_directory; + boost::optional _player_kdm_directory; + boost::optional _audio_mapping; +#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 static int const _current_version;