X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=957a846665c8045dc67fe25fc70f4cea744a9ec4;hp=1e16fc840a607814bd8fcef1891151cb2918a569;hb=dd9be86db6cde0afa5da0d1d1ac43b42e05dca26;hpb=8449388da769c45ef8a441bccdeb062bc96d27ae diff --git a/src/lib/config.h b/src/lib/config.h index 1e16fc840..957a84666 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,10 +27,12 @@ #include "isdcf_metadata.h" #include "types.h" +#include "state.h" +#include "edid.h" +#include "audio_mapping.h" #include #include #include -#include #include #include #include @@ -41,11 +43,12 @@ class Ratio; class Cinema; class Film; class DKDMGroup; +class DKDMRecipient; /** @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 */ @@ -73,8 +76,15 @@ public: USE_ANY_SERVERS, SERVERS, CINEMAS, + DKDM_RECIPIENTS, SOUND, SOUND_OUTPUT, + PLAYER_CONTENT_DIRECTORY, + PLAYER_PLAYLIST_DIRECTORY, + PLAYER_DEBUG_LOG, + HISTORY, + SHOW_EXPERIMENTAL_AUDIO_PROCESSORS, + AUDIO_MAPPING, OTHER }; @@ -107,7 +117,7 @@ public: return _only_servers_encode; } - Protocol tms_protocol () const { + FileTransferProtocol tms_protocol () const { return _tms_protocol; } @@ -131,13 +141,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 { @@ -148,6 +157,14 @@ public: return _allow_any_dcp_frame_rate; } + bool allow_any_container () const { + return _allow_any_container; + } + + bool show_experimental_audio_processors () const { + return _show_experimental_audio_processors; + } + ISDCFMetadata default_isdcf_metadata () const { return _default_isdcf_metadata; } @@ -164,10 +181,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; } @@ -184,6 +197,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; } @@ -196,8 +225,8 @@ public: return _default_interop; } - bool default_upload_after_make_dcp () { - return _default_upload_after_make_dcp; + bool upload_after_make_dcp () { + return _upload_after_make_dcp; } void set_default_kdm_directory (boost::filesystem::path d) { @@ -216,6 +245,10 @@ public: return _mail_port; } + EmailProtocol mail_protocol () const { + return _mail_protocol; + } + std::string mail_user () const { return _mail_user; } @@ -244,11 +277,35 @@ public: return _kdm_email; } - boost::shared_ptr signer_chain () const { + std::string notification_subject () const { + return _notification_subject; + } + + std::string notification_from () const { + return _notification_from; + } + + std::string notification_to () const { + return _notification_to; + } + + std::vector notification_cc () const { + return _notification_cc; + } + + std::string notification_bcc () const { + return _notification_bcc; + } + + std::string notification_email () const { + return _notification_email; + } + + std::shared_ptr signer_chain () const { return _signer_chain; } - boost::shared_ptr decryption_chain () const { + std::shared_ptr decryption_chain () const { return _decryption_chain; } @@ -290,7 +347,7 @@ public: return _player_history; } - boost::shared_ptr dkdms () const { + std::shared_ptr dkdms () const { return _dkdms; } @@ -298,6 +355,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; } @@ -314,6 +375,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; } @@ -329,8 +394,11 @@ public: enum Nag { NAG_DKDM_CONFIG, NAG_ENCRYPTED_METADATA, - NAG_REMAKE_DECRYPTION_CHAIN, + NAG_ALTER_DECRYPTION_CHAIN, NAG_BAD_SIGNER_CHAIN, + NAG_IMPORT_DECRYPTION_CHAIN, + NAG_DELETE_DKDM, + NAG_32_ON_64, NAG_COUNT }; @@ -385,6 +453,89 @@ public: return _default_notify; } + enum Notification { + MESSAGE_BOX, + EMAIL, + NOTIFICATION_COUNT + }; + + bool notification (Notification n) const { + return _notification[n]; + } + + boost::optional barco_username () const { + return _barco_username; + } + + boost::optional barco_password () const { + return _barco_password; + } + + boost::optional christie_username () const { + return _christie_username; + } + + boost::optional christie_password () const { + return _christie_password; + } + + boost::optional gdc_username () const { + return _gdc_username; + } + + boost::optional gdc_password () const { + return _gdc_password; + } + + 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); + /* SET (mostly) */ void set_master_encoding_threads (int n) { @@ -412,7 +563,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); } @@ -436,16 +587,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); } @@ -454,6 +615,14 @@ public: maybe_set (_allow_any_dcp_frame_rate, a); } + void set_allow_any_container (bool a) { + 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); } @@ -483,10 +652,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); } @@ -503,6 +668,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); } @@ -515,8 +696,8 @@ 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_upload_after_make_dcp (bool u) { + maybe_set (_upload_after_make_dcp, u); } void set_mail_server (std::string s) { @@ -527,6 +708,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); } @@ -557,11 +742,37 @@ public: void reset_kdm_email (); - void set_signer_chain (boost::shared_ptr s) { + void set_notification_subject (std::string s) { + maybe_set (_notification_subject, s); + } + + void set_notification_from (std::string f) { + maybe_set (_notification_from, f); + } + + void set_notification_to (std::string t) { + maybe_set (_notification_to, t); + } + + void set_notification_cc (std::vector f) { + maybe_set (_notification_cc, f); + } + + void set_notification_bcc (std::string f) { + maybe_set (_notification_bcc, f); + } + + void set_notification_email (std::string e) { + maybe_set (_notification_email, e); + } + + void reset_notification_email (); + + 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); } @@ -598,13 +809,15 @@ 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); } @@ -650,6 +863,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); } @@ -681,7 +898,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); @@ -697,6 +916,137 @@ public: void reset_cover_sheet (); + void set_notification (Notification n, bool v) { + maybe_set (_notification[n], v); + } + + void set_barco_username (std::string u) { + maybe_set (_barco_username, u); + } + + void unset_barco_username () { + maybe_set (_barco_username, boost::optional()); + } + + void set_barco_password (std::string p) { + maybe_set (_barco_password, p); + } + + void unset_barco_password () { + maybe_set (_barco_password, boost::optional()); + } + + void set_christie_username (std::string u) { + maybe_set (_christie_username, u); + } + + void unset_christie_username () { + maybe_set (_christie_username, boost::optional()); + } + + void set_christie_password (std::string p) { + maybe_set (_christie_password, p); + } + + void unset_christie_password () { + maybe_set (_christie_password, boost::optional()); + } + + void set_gdc_username (std::string u) { + maybe_set (_gdc_username, u); + } + + void unset_gdc_username () { + maybe_set (_gdc_username, boost::optional()); + } + + void set_gdc_password (std::string p) { + maybe_set (_gdc_password, p); + } + + void unset_gdc_password () { + maybe_set (_gdc_password, boost::optional()); + } + + 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 (); + void changed (Property p = OTHER); boost::signals2::signal Changed; /** Emitted if read() failed on an existing Config file. There is nothing @@ -705,18 +1055,26 @@ 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 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; @@ -729,20 +1087,19 @@ 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 (); + 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 (); + 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 (); template @@ -778,7 +1135,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 */ @@ -787,22 +1144,31 @@ 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; + /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat + DCPs at 25fps but will play 16:9, so this is very useful for some users. + 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; /** 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; @@ -810,10 +1176,12 @@ private: 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; @@ -821,11 +1189,17 @@ private: std::vector _kdm_cc; std::string _kdm_bcc; std::string _kdm_email; - boost::shared_ptr _signer_chain; + std::string _notification_subject; + std::string _notification_from; + std::string _notification_to; + std::vector _notification_cc; + std::string _notification_bcc; + std::string _notification_email; + 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; @@ -839,11 +1213,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; @@ -859,6 +1235,31 @@ private: int _frames_in_memory_multiplier; boost::optional _decode_reduction; bool _default_notify; + bool _notification[NOTIFICATION_COUNT]; + boost::optional _barco_username; + boost::optional _barco_password; + boost::optional _christie_username; + boost::optional _christie_password; + boost::optional _gdc_username; + boost::optional _gdc_password; + 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; static int const _current_version;