Accessor for ClosedCaptionsDialog.
[dcpomatic.git] / src / lib / config.h
index 7d21964a42df051125ce084150c3171018a3041d..061d6ee7c59045b721529b9a5c9fdd40d94bc8fe 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -27,7 +27,9 @@
 
 #include "isdcf_metadata.h"
 #include "types.h"
+#include "state.h"
 #include "edid.h"
+#include "audio_mapping.h"
 #include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
 #include <dcp/encrypted_kdm.h>
@@ -46,7 +48,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 */
@@ -81,6 +83,8 @@ public:
                PLAYER_PLAYLIST_DIRECTORY,
                PLAYER_DEBUG_LOG,
                HISTORY,
+               SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
+               AUDIO_MAPPING,
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                PLAYER_BACKGROUND_IMAGE,
 #endif
@@ -116,7 +120,7 @@ public:
                return _only_servers_encode;
        }
 
-       Protocol tms_protocol () const {
+       FileTransferProtocol tms_protocol () const {
                return _tms_protocol;
        }
 
@@ -140,11 +144,6 @@ public:
                return _tms_password;
        }
 
-       /** @return The cinema sound processor that we are using */
-       CinemaSoundProcessor const * cinema_sound_processor () const {
-               return _cinema_sound_processor;
-       }
-
        std::list<boost::shared_ptr<Cinema> > cinemas () const {
                return _cinemas;
        }
@@ -161,6 +160,10 @@ public:
                return _allow_any_container;
        }
 
+       bool show_experimental_audio_processors () const {
+               return _show_experimental_audio_processors;
+       }
+
        ISDCFMetadata default_isdcf_metadata () const {
                return _default_isdcf_metadata;
        }
@@ -229,6 +232,10 @@ public:
                return _mail_port;
        }
 
+       EmailProtocol mail_protocol () const {
+               return _mail_protocol;
+       }
+
        std::string mail_user () const {
                return _mail_user;
        }
@@ -371,6 +378,8 @@ public:
                /* Not really a nag but it's the same idea */
                NAG_INITIAL_SETUP,
                NAG_IMPORT_DECRYPTION_CHAIN,
+               NAG_DELETE_DKDM,
+               NAG_32_ON_64,
                NAG_COUNT
        };
 
@@ -482,6 +491,15 @@ public:
                return _image_display;
        }
 
+       enum VideoViewType {
+               VIDEO_VIEW_SIMPLE,
+               VIDEO_VIEW_OPENGL
+       };
+
+       VideoViewType video_view_type () const {
+               return _video_view_type;
+       }
+
        bool respect_kdm_validity_periods () const {
                return _respect_kdm_validity_periods;
        }
@@ -506,6 +524,8 @@ public:
                return _player_kdm_directory;
        }
 
+       AudioMapping audio_mapping (int output_channels);
+
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        boost::optional<boost::filesystem::path> player_background_image () const {
                return _player_background_image;
@@ -563,7 +583,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);
        }
 
@@ -609,6 +629,10 @@ public:
                maybe_set (_allow_any_container, a);
        }
 
+       void set_show_experimental_audio_processors (bool e) {
+               maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
+       }
+
        void set_default_isdcf_metadata (ISDCFMetadata d) {
                maybe_set (_default_isdcf_metadata, d);
        }
@@ -682,6 +706,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);
        }
@@ -944,6 +972,10 @@ public:
                maybe_set (_image_display, n);
        }
 
+       void set_video_view_type (VideoViewType v) {
+               maybe_set (_video_view_type, v);
+       }
+
        void set_respect_kdm_validity_periods (bool r) {
                maybe_set (_respect_kdm_validity_periods, r);
        }
@@ -1008,6 +1040,9 @@ public:
                changed ();
        }
 
+       void set_audio_mapping (AudioMapping m);
+       void set_audio_mapping_to_default ();
+
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        void set_player_background_image (boost::filesystem::path p) {
                maybe_set (_player_background_image, p, PLAYER_BACKGROUND_IMAGE);
@@ -1062,10 +1097,16 @@ public:
        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.
+       /** Emitted if there is a something wrong the contents of our config.  Handler can call
+        *  true to ask Config to solve the problem (by discarding and recreating the bad thing)
         */
-       static boost::signals2::signal<bool (void)> BadSignerChain;
+       enum BadReason {
+               BAD_SIGNER_UTF8_STRINGS,     ///< signer chain contains UTF-8 strings (not PRINTABLESTRING)
+               BAD_SIGNER_INCONSISTENT,     ///< signer chain is somehow inconsistent
+               BAD_DECRYPTION_INCONSISTENT, ///< KDM decryption chain is somehow inconsistent
+       };
+
+       static boost::signals2::signal<bool (BadReason)> Bad;
 
        void write () const;
        void write_config () const;
@@ -1086,10 +1127,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 ();
@@ -1138,7 +1175,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 */
@@ -1147,8 +1184,6 @@ private:
        std::string _tms_user;
        /** Password to log into the TMS with */
        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 */
@@ -1158,6 +1193,8 @@ private:
            https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
        */
        bool _allow_any_container;
+       /** Offer the upmixers in the audio processor settings */
+       bool _show_experimental_audio_processors;
        /** Default ISDCF metadata for newly-created Films */
        ISDCFMetadata _default_isdcf_metadata;
        boost::optional<std::string> _language;
@@ -1180,6 +1217,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;
@@ -1247,6 +1285,7 @@ private:
        Interface _interface_complexity;
        PlayerMode _player_mode;
        int _image_display;
+       VideoViewType _video_view_type;
        bool _respect_kdm_validity_periods;
        /** Log file containing things the player does (e.g. started, stopped, loaded
            playlist etc.)  Does not contain debugging information.
@@ -1261,6 +1300,7 @@ private:
        boost::optional<boost::filesystem::path> _player_content_directory;
        boost::optional<boost::filesystem::path> _player_playlist_directory;
        boost::optional<boost::filesystem::path> _player_kdm_directory;
+       boost::optional<AudioMapping> _audio_mapping;
 #ifdef DCPOMATIC_VARIANT_SWAROOP
        boost::optional<boost::filesystem::path> _player_background_image;
        std::string _kdm_server_url;