Store successful DCP encodes.
[dcpomatic.git] / src / lib / config.h
index a162750febf9cd59a12cc02e28b075c3b8098e32..8cc25d7377d6d132e6a8e3934260111e93215083 100644 (file)
@@ -27,6 +27,7 @@
 
 #include "isdcf_metadata.h"
 #include "types.h"
+#include "state.h"
 #include "edid.h"
 #include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
@@ -46,7 +47,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 */
@@ -79,6 +80,7 @@ public:
                INTERFACE_COMPLEXITY,
                PLAYER_CONTENT_DIRECTORY,
                PLAYER_PLAYLIST_DIRECTORY,
+               PLAYER_DEBUG_LOG,
                HISTORY,
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                PLAYER_BACKGROUND_IMAGE,
@@ -115,7 +117,7 @@ public:
                return _only_servers_encode;
        }
 
-       Protocol tms_protocol () const {
+       FileTransferProtocol tms_protocol () const {
                return _tms_protocol;
        }
 
@@ -228,6 +230,10 @@ public:
                return _mail_port;
        }
 
+       EmailProtocol mail_protocol () const {
+               return _mail_protocol;
+       }
+
        std::string mail_user () const {
                return _mail_user;
        }
@@ -365,10 +371,11 @@ 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_COUNT
        };
 
@@ -484,8 +491,12 @@ public:
                return _respect_kdm_validity_periods;
        }
 
-       boost::optional<boost::filesystem::path> player_log_file () const {
-               return _player_log_file;
+       boost::optional<boost::filesystem::path> player_activity_log_file () const {
+               return _player_activity_log_file;
+       }
+
+       boost::optional<boost::filesystem::path> player_debug_log_file () const {
+               return _player_debug_log_file;
        }
 
        boost::optional<boost::filesystem::path> player_content_directory () const {
@@ -524,11 +535,11 @@ public:
        std::vector<Monitor> required_monitors () const {
                return _required_monitors;
        }
-#endif
 
-       bool allow_spl_editing () const {
-               return _allow_spl_editing;
+       boost::optional<boost::filesystem::path> player_lock_file () const {
+               return _player_lock_file;
        }
+#endif
 
        /* SET (mostly) */
 
@@ -557,7 +568,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);
        }
 
@@ -676,6 +687,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);
        }
@@ -856,7 +871,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);
@@ -940,18 +957,30 @@ public:
                maybe_set (_respect_kdm_validity_periods, r);
        }
 
-       void set_player_log_file (boost::filesystem::path p) {
-               maybe_set (_player_log_file, p);
+       void set_player_activity_log_file (boost::filesystem::path p) {
+               maybe_set (_player_activity_log_file, p);
        }
 
-       void unset_player_log_file () {
-               if (!_player_log_file) {
+       void unset_player_activity_log_file () {
+               if (!_player_activity_log_file) {
                        return;
                }
-               _player_log_file = boost::none;
+               _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);
        }
@@ -1020,12 +1049,20 @@ public:
        void set_required_monitors (std::vector<Monitor> monitors) {
                maybe_set (_required_monitors, monitors);
        }
-#endif
 
-       void set_allow_spl_editing (bool s) {
-               maybe_set (_allow_spl_editing, s);
+       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<void (Property)> Changed;
        /** Emitted if read() failed on an existing Config file.  There is nothing
@@ -1058,10 +1095,6 @@ public:
        static void restore_defaults ();
        static bool have_existing (std::string);
        static boost::filesystem::path config_file ();
-       static boost::filesystem::path path (std::string file, bool create_directories = true);
-
-       /** 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 ();
@@ -1074,6 +1107,7 @@ private:
        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 clean_history_internal (std::vector<boost::filesystem::path>& h);
        void backup ();
 
        template <class T>
@@ -1109,7 +1143,7 @@ private:
        /** J2K encoding servers that should definitely be used */
        std::vector<std::string> _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 */
@@ -1120,6 +1154,7 @@ private:
        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<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;
@@ -1150,6 +1185,7 @@ private:
        std::list<boost::shared_ptr<Cinema> > _cinemas;
        std::string _mail_server;
        int _mail_port;
+       EmailProtocol _mail_protocol;
        std::string _mail_user;
        std::string _mail_password;
        std::string _kdm_subject;
@@ -1164,10 +1200,16 @@ private:
        std::string _notification_bcc;
        std::string _notification_email;
        boost::shared_ptr<const dcp::CertificateChain> _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<const dcp::CertificateChain> _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;
@@ -1212,7 +1254,12 @@ private:
        PlayerMode _player_mode;
        int _image_display;
        bool _respect_kdm_validity_periods;
-       boost::optional<boost::filesystem::path> _player_log_file;
+       /** Log file containing things the player does (e.g. started, stopped, loaded
+           playlist etc.)  Does not contain debugging information.
+       */
+       boost::optional<boost::filesystem::path> _player_activity_log_file;
+       /** Log file containing debug information for the player */
+       boost::optional<boost::filesystem::path> _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.
@@ -1229,8 +1276,9 @@ private:
        /** watermark duration in milliseconds */
        int _player_watermark_duration;
        std::vector<Monitor> _required_monitors;
+       /** a file which, if specified, must be present for the player to work */
+       boost::optional<boost::filesystem::path> _player_lock_file;
 #endif
-       bool _allow_spl_editing;
 
        static int const _current_version;