Make terminate_threads() less likely to leave _threads containing invalid pointers.
[dcpomatic.git] / src / lib / config.h
index 4c24e816bb80ed315c529bd897a1055f246ebb6c..8cc25d7377d6d132e6a8e3934260111e93215083 100644 (file)
@@ -27,6 +27,8 @@
 
 #include "isdcf_metadata.h"
 #include "types.h"
+#include "state.h"
+#include "edid.h"
 #include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
 #include <dcp/encrypted_kdm.h>
@@ -45,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 */
@@ -75,6 +77,14 @@ public:
                CINEMAS,
                SOUND,
                SOUND_OUTPUT,
+               INTERFACE_COMPLEXITY,
+               PLAYER_CONTENT_DIRECTORY,
+               PLAYER_PLAYLIST_DIRECTORY,
+               PLAYER_DEBUG_LOG,
+               HISTORY,
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+               PLAYER_BACKGROUND_IMAGE,
+#endif
                OTHER
        };
 
@@ -107,7 +117,7 @@ public:
                return _only_servers_encode;
        }
 
-       Protocol tms_protocol () const {
+       FileTransferProtocol tms_protocol () const {
                return _tms_protocol;
        }
 
@@ -148,6 +158,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;
        }
@@ -216,6 +230,10 @@ public:
                return _mail_port;
        }
 
+       EmailProtocol mail_protocol () const {
+               return _mail_protocol;
+       }
+
        std::string mail_user () const {
                return _mail_user;
        }
@@ -353,8 +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
        };
 
@@ -419,6 +440,107 @@ public:
                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;
+       }
+
+       int image_display () const {
+               return _image_display;
+       }
+
+       bool respect_kdm_validity_periods () const {
+               return _respect_kdm_validity_periods;
+       }
+
+       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 {
+               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 {
+               return _player_kdm_directory;
+       }
+
+#ifdef DCPOMATIC_VARIANT_SWAROOP
+       boost::optional<boost::filesystem::path> 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<Monitor> required_monitors () const {
+               return _required_monitors;
+       }
+
+       boost::optional<boost::filesystem::path> player_lock_file () const {
+               return _player_lock_file;
+       }
+#endif
+
        /* SET (mostly) */
 
        void set_master_encoding_threads (int n) {
@@ -446,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);
        }
 
@@ -488,6 +610,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);
        }
@@ -561,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);
        }
@@ -741,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);
@@ -761,6 +893,176 @@ public:
                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_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_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 ();
+       }
+
+#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<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);
        boost::signals2::signal<void (Property)> Changed;
        /** Emitted if read() failed on an existing Config file.  There is nothing
@@ -779,6 +1081,7 @@ public:
        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<const Film> film, std::string name) const;
        bool existing_template (std::string name) const;
@@ -793,12 +1096,8 @@ public:
        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<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 ();
@@ -808,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>
@@ -843,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 */
@@ -854,9 +1154,15 @@ 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;
+       /** 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;
@@ -879,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;
@@ -893,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;
@@ -931,6 +1244,41 @@ private:
        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;
+       int _image_display;
+       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<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_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;