X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Fconfig.h;h=80bb48d32cfb3a15d68acfb786721fca71ba7143;hb=1f1661f36ffd7a5662847f0642c7a7ebdcadc0f0;hp=abfdba3dd56cd2347022a7aaf4d47e12acfcbecb;hpb=fe99d14e3047e9302e94db372923c92291016f1c;p=dcpomatic.git diff --git a/src/lib/config.h b/src/lib/config.h index abfdba3dd..80bb48d32 100644 --- a/src/lib/config.h +++ b/src/lib/config.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2016 Carl Hetherington + Copyright (C) 2012-2018 Carl Hetherington This file is part of DCP-o-matic. @@ -40,6 +40,7 @@ class DCPContentType; class Ratio; class Cinema; class Film; +class DKDMGroup; /** @class Config * @brief A singleton class holding configuration. @@ -47,9 +48,14 @@ class Film; class Config : public boost::noncopyable { public: - /** @return number of threads to use for J2K encoding on the local machine */ - int num_local_encoding_threads () const { - return _num_local_encoding_threads; + /** @return number of threads which a master DoM should use for J2K encoding on the local machine */ + int master_encoding_threads () const { + return _master_encoding_threads; + } + + /** @return number of threads which a server should use for J2K encoding on the local machine */ + int server_encoding_threads () const { + return _server_encoding_threads; } boost::optional default_directory () const { @@ -67,7 +73,14 @@ public: USE_ANY_SERVERS, SERVERS, CINEMAS, + SOUND, SOUND_OUTPUT, + INTERFACE_COMPLEXITY, + PLAYER_DCP_DIRECTORY, +#ifdef DCPOMATIC_VARIANT_SWAROOP + PLAYER_BACKGROUND_IMAGE, + PLAYER_WATERMARK, +#endif OTHER }; @@ -141,6 +154,10 @@ public: return _allow_any_dcp_frame_rate; } + bool allow_any_container () const { + return _allow_any_container; + } + ISDCFMetadata default_isdcf_metadata () const { return _default_isdcf_metadata; } @@ -157,6 +174,10 @@ 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; } @@ -185,6 +206,10 @@ public: return _default_interop; } + bool default_upload_after_make_dcp () { + return _default_upload_after_make_dcp; + } + void set_default_kdm_directory (boost::filesystem::path d) { if (_default_kdm_directory && _default_kdm_directory.get() == d) { return; @@ -229,6 +254,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; } @@ -271,7 +320,11 @@ public: return _history; } - std::vector dkdms () const { + std::vector player_history () const { + return _player_history; + } + + boost::shared_ptr dkdms () const { return _dkdms; } @@ -307,13 +360,162 @@ public: return _jump_to_selected; } + 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_COUNT + }; + + bool nagged (Nag nag) const { + return _nagged[nag]; + } + + bool sound () const { + return _sound; + } + + std::string cover_sheet () const { + return _cover_sheet; + } + boost::optional sound_output () const { return _sound_output; } - /** @param n New number of local encoding threads */ - void set_num_local_encoding_threads (int n) { - maybe_set (_num_local_encoding_threads, n); + boost::optional last_player_load_directory () const { + return _last_player_load_directory; + } + + enum KDMWriteType { + KDM_WRITE_FLAT, + KDM_WRITE_FOLDER, + KDM_WRITE_ZIP + }; + + boost::optional last_kdm_write_type () const { + 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 Interface { + INTERFACE_SIMPLE, + INTERFACE_FULL + }; + + Interface interface_complexity () const { + return _interface_complexity; + } + + enum PlayerMode { + PLAYER_MODE_WINDOW, + PLAYER_MODE_FULL, + PLAYER_MODE_DUAL + }; + + PlayerMode player_mode () const { + return _player_mode; + } + + int image_display () const { + return _image_display; + } + + bool respect_kdm_validity_periods () const { + return _respect_kdm_validity_periods; + } + + boost::optional player_log_file () const { + return _player_log_file; + } + + boost::optional player_dcp_directory () const { + return _player_dcp_directory; + } + + boost::optional player_kdm_directory () const { + return _player_kdm_directory; + } + +#ifdef DCPOMATIC_VARIANT_SWAROOP + boost::optional player_background_image () const { + return _player_background_image; + } + + std::string kdm_server_url () const { + return _kdm_server_url; + } + + boost::optional player_watermark () const { + return _player_watermark; + } +#endif + + /* SET (mostly) */ + + void set_master_encoding_threads (int n) { + maybe_set (_master_encoding_threads, n); + } + + void set_server_encoding_threads (int n) { + maybe_set (_server_encoding_threads, n); } void set_default_directory (boost::filesystem::path d) { @@ -375,6 +577,10 @@ public: maybe_set (_allow_any_dcp_frame_rate, a); } + void set_allow_any_container (bool a) { + maybe_set (_allow_any_container, a); + } + void set_default_isdcf_metadata (ISDCFMetadata d) { maybe_set (_default_isdcf_metadata, d); } @@ -404,6 +610,10 @@ 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); } @@ -432,6 +642,10 @@ 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_mail_server (std::string s) { maybe_set (_mail_server, s); } @@ -470,6 +684,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); } @@ -511,7 +751,7 @@ public: } #endif - void set_dkdms (std::vector dkdms) { + void set_dkdms (boost::shared_ptr dkdms) { _dkdms = dkdms; changed (); } @@ -526,13 +766,27 @@ public: maybe_set (_confirm_kdm_email, s); } - void set_sound_output (std::string o) - { + void set_sound (bool s) { + maybe_set (_sound, s, SOUND); + } + + void set_sound_output (std::string o) { maybe_set (_sound_output, o, SOUND_OUTPUT); } - void unset_sound_output () - { + void set_last_player_load_directory (boost::filesystem::path d) { + maybe_set (_last_player_load_directory, d); + } + + void set_last_kdm_write_type (KDMWriteType t) { + 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; } @@ -557,27 +811,198 @@ public: maybe_set (_dcp_asset_filename_format, n); } + void set_frames_in_memory_multiplier (int m) { + 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 add_to_player_history (boost::filesystem::path p); void set_jump_to_selected (bool j) { maybe_set (_jump_to_selected, j); } + void set_nagged (Nag nag, bool nagged) { + maybe_set (_nagged[nag], nagged); + } + + void set_cover_sheet (std::string s) { + maybe_set (_cover_sheet, s); + } + + 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_interface_complexity (Interface i) { + 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_respect_kdm_validity_periods (bool r) { + maybe_set (_respect_kdm_validity_periods, r); + } + + void set_player_log_file (boost::filesystem::path p) { + maybe_set (_player_log_file, p); + } + + void unset_player_log_file () { + if (!_player_log_file) { + return; + } + _player_log_file = boost::none; + changed (); + } + + void set_player_dcp_directory (boost::filesystem::path p) { + maybe_set (_player_dcp_directory, p, PLAYER_DCP_DIRECTORY); + } + + void unset_player_dcp_directory () { + if (!_player_dcp_directory) { + return; + } + _player_dcp_directory = boost::none; + changed (PLAYER_DCP_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 (); + } + +#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 (boost::filesystem::path p) { + maybe_set (_player_watermark, p, PLAYER_WATERMARK); + } + + void unset_player_watermark () { + if (!_player_watermark) { + return; + } + _player_watermark = boost::none; + changed (PLAYER_WATERMARK); + } +#endif + void changed (Property p = OTHER); boost::signals2::signal Changed; /** Emitted if read() failed on an existing Config file. There is nothing a listener can do about it: this is just for information. */ 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. + */ + static boost::signals2::signal BadSignerChain; 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; @@ -590,6 +1015,10 @@ public: static void drop (); static void restore_defaults (); 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 (); @@ -597,9 +1026,13 @@ private: 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 backup (); template void maybe_set (T& member, T new_value, Property prop = OTHER) { @@ -619,8 +1052,10 @@ private: changed (prop); } - /** number of threads to use for J2K encoding on the local machine */ - int _num_local_encoding_threads; + /** 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 */ + int _server_encoding_threads; /** default directory to put new films in */ boost::optional _default_directory; /** base port number to use for J2K encoding servers; @@ -646,12 +1081,18 @@ private: 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; /** 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; @@ -663,6 +1104,7 @@ private: the home directory will be offered. */ boost::optional _default_kdm_directory; + bool _default_upload_after_make_dcp; std::list > _cinemas; std::string _mail_server; int _mail_port; @@ -673,6 +1115,12 @@ 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; /** Chain used to decrypt KDMs; the leaf of this chain is the target * certificate for making KDMs given to DCP-o-matic. @@ -690,7 +1138,8 @@ private: bool _win32_console; #endif std::vector _history; - std::vector _dkdms; + std::vector _player_history; + boost::shared_ptr _dkdms; boost::filesystem::path _cinemas_file; bool _show_hints_before_make_dcp; bool _confirm_kdm_email; @@ -698,12 +1147,43 @@ private: dcp::NameFormat _kdm_container_name_format; dcp::NameFormat _dcp_metadata_filename_format; dcp::NameFormat _dcp_asset_filename_format; -<<<<<<< 8de6a5d1d054bab25ab0d86bc48442d9d6adb849 bool _jump_to_selected; -======= - /** name of a specific sound output stream to use for preview */ + bool _nagged[NAG_COUNT]; + bool _sound; + /** name of a specific sound output stream to use, or empty to use the default */ boost::optional _sound_output; ->>>>>>> First bits of audio support. + 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; + Interface _interface_complexity; + PlayerMode _player_mode; + int _image_display; + bool _respect_kdm_validity_periods; + boost::optional _player_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_dcp_directory; + boost::optional _player_kdm_directory; +#ifdef DCPOMATIC_VARIANT_SWAROOP + boost::optional _player_background_image; + std::string _kdm_server_url; + boost::optional _player_watermark; +#endif + + static int const _current_version; /** Singleton instance, or 0 */ static Config* _instance;