X-Git-Url: https://main.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=11ca36b855742eea81a065ffce6bbd3ddc4650ff;hp=dae1924a86c50ea1948e65878f2cf1432a19d511;hb=44da1840ca17d0945cb1886bb17218990850894c;hpb=0ca36c0d2b238a9e2165b5d113c22f144835a672 diff --git a/src/lib/config.h b/src/lib/config.h index dae1924a8..11ca36b85 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 @@ -41,11 +44,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 +77,18 @@ 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, +#ifdef DCPOMATIC_VARIANT_SWAROOP + PLAYER_BACKGROUND_IMAGE, +#endif OTHER }; @@ -107,7 +121,7 @@ public: return _only_servers_encode; } - Protocol tms_protocol () const { + FileTransferProtocol tms_protocol () const { return _tms_protocol; } @@ -131,15 +145,14 @@ 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 > dkdm_recipients () const { + return _dkdm_recipients; + } + std::list allowed_dcp_frame_rates () const { return _allowed_dcp_frame_rates; } @@ -148,6 +161,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 +185,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 +201,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 +229,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 +249,10 @@ public: return _mail_port; } + EmailProtocol mail_protocol () const { + return _mail_protocol; + } + std::string mail_user () const { return _mail_user; } @@ -244,6 +281,30 @@ public: return _kdm_email; } + 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; + } + boost::shared_ptr signer_chain () const { return _signer_chain; } @@ -286,6 +347,10 @@ public: return _history; } + std::vector player_history () const { + return _player_history; + } + boost::shared_ptr dkdms () const { return _dkdms; } @@ -294,6 +359,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; } @@ -310,6 +379,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; } @@ -325,7 +398,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 }; @@ -359,10 +436,142 @@ public: return _last_kdm_write_type; } + enum DKDMWriteType { + DKDM_WRITE_INTERNAL, + DKDM_WRITE_FILE + }; + + boost::optional last_dkdm_write_type () const { + return _last_dkdm_write_type; + } + int frames_in_memory_multiplier () const { return _frames_in_memory_multiplier; } + boost::optional decode_reduction () const { + return _decode_reduction; + } + + bool default_notify () const { + 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); + +#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) { maybe_set (_master_encoding_threads, n); } @@ -388,7 +597,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); } @@ -422,6 +631,16 @@ public: changed (CINEMAS); } + void add_dkdm_recipient (boost::shared_ptr c) { + _dkdm_recipients.push_back (c); + changed (DKDM_RECIPIENTS); + } + + void remove_dkdm_recipient (boost::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); } @@ -430,6 +649,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); } @@ -459,10 +686,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); } @@ -479,6 +702,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); } @@ -491,8 +730,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) { @@ -503,6 +742,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); } @@ -533,6 +776,32 @@ public: void reset_kdm_email (); + 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 (boost::shared_ptr s) { maybe_set (_signer_chain, s); } @@ -581,6 +850,8 @@ public: 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); } @@ -605,6 +876,10 @@ public: maybe_set (_last_kdm_write_type, t); } + void set_last_dkdm_write_type (DKDMWriteType t) { + maybe_set (_last_dkdm_write_type, t); + } + void unset_sound_output () { if (!_sound_output) { return; @@ -622,6 +897,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); } @@ -634,12 +913,28 @@ public: maybe_set (_frames_in_memory_multiplier, m); } + void set_decode_reduction (boost::optional r) { + maybe_set (_decode_reduction, r); + } + + void set_default_notify (bool n) { + maybe_set (_default_notify, n); + } + void clear_history () { _history.clear (); changed (); } + void clear_player_history () { + _player_history.clear (); + changed (); + } + 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); @@ -655,6 +950,183 @@ 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 (); + +#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 @@ -663,12 +1135,24 @@ 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 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) + */ + 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; bool existing_template (std::string name) const; @@ -683,18 +1167,20 @@ public: static bool have_existing (std::string); static boost::filesystem::path config_file (); - static boost::optional test_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); + 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 (); template void maybe_set (T& member, T new_value, Property prop = OTHER) { @@ -729,7 +1215,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 */ @@ -738,22 +1224,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; @@ -761,10 +1256,12 @@ private: the home directory will be offered. */ boost::optional _default_kdm_directory; - bool _default_upload_after_make_dcp; + 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; @@ -772,11 +1269,23 @@ private: std::vector _kdm_cc; std::string _kdm_bcc; std::string _kdm_email; + std::string _notification_subject; + std::string _notification_from; + std::string _notification_to; + 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 /** 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; @@ -789,11 +1298,14 @@ private: bool _win32_console; #endif std::vector _history; + std::vector _player_history; boost::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; @@ -805,7 +1317,49 @@ private: std::string _cover_sheet; boost::optional _last_player_load_directory; boost::optional _last_kdm_write_type; + boost::optional _last_dkdm_write_type; 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; +#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; /** Singleton instance, or 0 */ static Config* _instance;