Basic and rather clumsy option to respect KDM validity windows.
[dcpomatic.git] / src / lib / config.h
index 44708a24fc231b561dcebe0efb84e2ade175fb9d..c8ae32efd7bf02de3c66c252a971044b4722df49 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -73,8 +73,9 @@ public:
                USE_ANY_SERVERS,
                SERVERS,
                CINEMAS,
-               PREVIEW_SOUND,
-               PREVIEW_SOUND_OUTPUT,
+               SOUND,
+               SOUND_OUTPUT,
+               INTERFACE_COMPLEXITY,
                OTHER
        };
 
@@ -148,6 +149,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;
        }
@@ -196,6 +201,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;
@@ -240,6 +249,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<std::string> 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<const dcp::CertificateChain> signer_chain () const {
                return _signer_chain;
        }
@@ -282,6 +315,10 @@ public:
                return _history;
        }
 
+       std::vector<boost::filesystem::path> player_history () const {
+               return _player_history;
+       }
+
        boost::shared_ptr<DKDMGroup> dkdms () const {
                return _dkdms;
        }
@@ -321,6 +358,10 @@ public:
        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
        };
 
@@ -328,18 +369,112 @@ public:
                return _nagged[nag];
        }
 
-       bool preview_sound () const {
-               return _preview_sound;
+       bool sound () const {
+               return _sound;
        }
 
        std::string cover_sheet () const {
                return _cover_sheet;
        }
 
-       boost::optional<std::string> preview_sound_output () const {
-               return _preview_sound_output;
+       boost::optional<std::string> sound_output () const {
+               return _sound_output;
+       }
+
+       boost::optional<boost::filesystem::path> last_player_load_directory () const {
+               return _last_player_load_directory;
+       }
+
+       enum KDMWriteType {
+               KDM_WRITE_FLAT,
+               KDM_WRITE_FOLDER,
+               KDM_WRITE_ZIP
+       };
+
+       boost::optional<KDMWriteType> last_kdm_write_type () const {
+               return _last_kdm_write_type;
+       }
+
+       enum DKDMWriteType {
+               DKDM_WRITE_INTERNAL,
+               DKDM_WRITE_FILE
+       };
+
+       boost::optional<DKDMWriteType> last_dkdm_write_type () const {
+               return _last_dkdm_write_type;
+       }
+
+       int frames_in_memory_multiplier () const {
+               return _frames_in_memory_multiplier;
+       }
+
+       boost::optional<int> 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<std::string> barco_username () const {
+               return _barco_username;
+       }
+
+       boost::optional<std::string> barco_password () const {
+               return _barco_password;
+       }
+
+       boost::optional<std::string> christie_username () const {
+               return _christie_username;
+       }
+
+       boost::optional<std::string> christie_password () const {
+               return _christie_password;
+       }
+
+       boost::optional<std::string> gdc_username () const {
+               return _gdc_username;
+       }
+
+       boost::optional<std::string> 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;
+       }
+
+       bool respect_kdm_validity_periods () const {
+               return _respect_kdm_validity_periods;
+       }
+
+       /* SET (mostly) */
+
        void set_master_encoding_threads (int n) {
                maybe_set (_master_encoding_threads, n);
        }
@@ -407,6 +542,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);
        }
@@ -468,6 +607,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);
        }
@@ -506,6 +649,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<std::string> 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<const dcp::CertificateChain> s) {
                maybe_set (_signer_chain, s);
        }
@@ -562,22 +731,32 @@ public:
                maybe_set (_confirm_kdm_email, s);
        }
 
-       void set_preview_sound (bool s) {
-               maybe_set (_preview_sound, s, PREVIEW_SOUND);
+       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 set_preview_sound_output (std::string o)
-       {
-               maybe_set (_preview_sound_output, o, PREVIEW_SOUND_OUTPUT);
+       void set_last_player_load_directory (boost::filesystem::path d) {
+               maybe_set (_last_player_load_directory, d);
        }
 
-       void unset_preview_sound_output ()
-       {
-               if (!_preview_sound_output) {
+       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;
                }
 
-               _preview_sound_output = boost::none;
+               _sound_output = boost::none;
                changed ();
        }
 
@@ -597,12 +776,30 @@ 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<int> 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);
@@ -618,16 +815,88 @@ 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<std::string>());
+       }
+
+       void set_barco_password (std::string p) {
+               maybe_set (_barco_password, p);
+       }
+
+       void unset_barco_password () {
+               maybe_set (_barco_password, boost::optional<std::string>());
+       }
+
+       void set_christie_username (std::string u) {
+               maybe_set (_christie_username, u);
+       }
+
+       void unset_christie_username () {
+               maybe_set (_christie_username, boost::optional<std::string>());
+       }
+
+       void set_christie_password (std::string p) {
+               maybe_set (_christie_password, p);
+       }
+
+       void unset_christie_password () {
+               maybe_set (_christie_password, boost::optional<std::string>());
+       }
+
+       void set_gdc_username (std::string u) {
+               maybe_set (_gdc_username, u);
+       }
+
+       void unset_gdc_username () {
+               maybe_set (_gdc_username, boost::optional<std::string>());
+       }
+
+       void set_gdc_password (std::string p) {
+               maybe_set (_gdc_password, p);
+       }
+
+       void unset_gdc_password () {
+               maybe_set (_gdc_password, boost::optional<std::string>());
+       }
+
+       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_respect_kdm_validity_periods (bool r) {
+               maybe_set (_respect_kdm_validity_periods, r);
+       }
+
        void changed (Property p = OTHER);
        boost::signals2::signal<void (Property)> 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<void ()> FailedToLoad;
+       /** Emitted if read() issued a warning which the user might want to know about */
+       static boost::signals2::signal<void (std::string)> 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<bool (void)> 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;
 
        void save_template (boost::shared_ptr<const Film> film, std::string name) const;
        bool existing_template (std::string name) const;
@@ -640,7 +909,10 @@ public:
        static void drop ();
        static void restore_defaults ();
        static bool have_existing (std::string);
-       static boost::filesystem::path config_path ();
+       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<boost::filesystem::path> override_path;
 
 private:
        Config ();
@@ -648,10 +920,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<dcp::CertificateChain> create_certificate_chain ();
        boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
+       void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
+       void backup ();
 
        template <class T>
        void maybe_set (T& member, T new_value, Property prop = OTHER) {
@@ -700,6 +975,11 @@ private:
        std::list<int> _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<std::string> _language;
@@ -718,6 +998,7 @@ private:
            the home directory will be offered.
        */
        boost::optional<boost::filesystem::path> _default_kdm_directory;
+       bool _default_upload_after_make_dcp;
        std::list<boost::shared_ptr<Cinema> > _cinemas;
        std::string _mail_server;
        int _mail_port;
@@ -728,6 +1009,12 @@ private:
        std::vector<std::string> _kdm_cc;
        std::string _kdm_bcc;
        std::string _kdm_email;
+       std::string _notification_subject;
+       std::string _notification_from;
+       std::string _notification_to;
+       std::vector<std::string> _notification_cc;
+       std::string _notification_bcc;
+       std::string _notification_email;
        boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
        /** Chain used to decrypt KDMs; the leaf of this chain is the target
         *  certificate for making KDMs given to DCP-o-matic.
@@ -745,6 +1032,7 @@ private:
        bool _win32_console;
 #endif
        std::vector<boost::filesystem::path> _history;
+       std::vector<boost::filesystem::path> _player_history;
        boost::shared_ptr<DKDMGroup> _dkdms;
        boost::filesystem::path _cinemas_file;
        bool _show_hints_before_make_dcp;
@@ -755,10 +1043,28 @@ private:
        dcp::NameFormat _dcp_asset_filename_format;
        bool _jump_to_selected;
        bool _nagged[NAG_COUNT];
-       bool _preview_sound;
-       /** name of a specific sound output stream to use for preview, or empty to use the default */
-       boost::optional<std::string> _preview_sound_output;
+       bool _sound;
+       /** name of a specific sound output stream to use, or empty to use the default */
+       boost::optional<std::string> _sound_output;
        std::string _cover_sheet;
+       boost::optional<boost::filesystem::path> _last_player_load_directory;
+       boost::optional<KDMWriteType> _last_kdm_write_type;
+       boost::optional<DKDMWriteType> _last_dkdm_write_type;
+       int _frames_in_memory_multiplier;
+       boost::optional<int> _decode_reduction;
+       bool _default_notify;
+       bool _notification[NOTIFICATION_COUNT];
+       boost::optional<std::string> _barco_username;
+       boost::optional<std::string> _barco_password;
+       boost::optional<std::string> _christie_username;
+       boost::optional<std::string> _christie_password;
+       boost::optional<std::string> _gdc_username;
+       boost::optional<std::string> _gdc_password;
+       Interface _interface_complexity;
+       PlayerMode _player_mode;
+       bool _respect_kdm_validity_periods;
+
+       static int const _current_version;
 
        /** Singleton instance, or 0 */
        static Config* _instance;