More player debugging for butler video-full states.
[dcpomatic.git] / src / lib / config.h
index 8ddc0367de9b9a0290b09b3058b60e8c8ec2a8ca..21463fdb5bc44500ca16827acbfc6f766ee06b7c 100644 (file)
@@ -27,6 +27,7 @@
 
 #include "isdcf_metadata.h"
 #include "types.h"
+#include "edid.h"
 #include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
 #include <dcp/encrypted_kdm.h>
@@ -76,7 +77,10 @@ public:
                SOUND,
                SOUND_OUTPUT,
                INTERFACE_COMPLEXITY,
-               PLAYER_DCP_DIRECTORY,
+               PLAYER_CONTENT_DIRECTORY,
+               PLAYER_PLAYLIST_DIRECTORY,
+               PLAYER_DEBUG_LOG,
+               HISTORY,
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                PLAYER_BACKGROUND_IMAGE,
 #endif
@@ -481,12 +485,20 @@ 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_dcp_directory () const {
-               return _player_dcp_directory;
+       boost::optional<boost::filesystem::path> player_debug_log_file () const {
+               return _player_debug_log_file;
+       }
+
+       boost::optional<boost::filesystem::path> player_content_directory () const {
+               return _player_content_directory;
+       }
+
+       boost::optional<boost::filesystem::path> player_playlist_directory () const {
+               return _player_playlist_directory;
        }
 
        boost::optional<boost::filesystem::path> player_kdm_directory () const {
@@ -513,6 +525,14 @@ public:
        int player_watermark_duration () const {
                return _player_watermark_duration;
        }
+
+       std::vector<Monitor> required_monitors () const {
+               return _required_monitors;
+       }
+
+       boost::optional<boost::filesystem::path> player_lock_file () const {
+               return _player_lock_file;
+       }
 #endif
 
        /* SET (mostly) */
@@ -925,28 +945,52 @@ 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_dcp_directory (boost::filesystem::path p) {
-               maybe_set (_player_dcp_directory, p, PLAYER_DCP_DIRECTORY);
+       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_dcp_directory () {
-               if (!_player_dcp_directory) {
+       void unset_player_playlist_directory () {
+               if (!_player_playlist_directory) {
                        return;
                }
-               _player_dcp_directory = boost::none;
-               changed (PLAYER_DCP_DIRECTORY);
+               _player_playlist_directory = boost::none;
+               changed (PLAYER_PLAYLIST_DIRECTORY);
        }
 
        void set_player_kdm_directory (boost::filesystem::path p) {
@@ -989,6 +1033,22 @@ public:
        void set_player_watermark_duration (int milliseconds) {
                maybe_set (_player_watermark_duration, milliseconds);
        }
+
+       void set_required_monitors (std::vector<Monitor> 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);
@@ -1023,13 +1083,13 @@ 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 ();
-       static boost::filesystem::path path (std::string file, bool create_directories = true);
        void read ();
        void set_defaults ();
        void set_kdm_email_to_default ();
@@ -1085,6 +1145,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;
@@ -1129,10 +1190,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;
@@ -1177,19 +1244,30 @@ 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.
        */
-       boost::optional<boost::filesystem::path> _player_dcp_directory;
+       boost::optional<boost::filesystem::path> _player_content_directory;
+       boost::optional<boost::filesystem::path> _player_playlist_directory;
        boost::optional<boost::filesystem::path> _player_kdm_directory;
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        boost::optional<boost::filesystem::path> _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<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
 
        static int const _current_version;