Add some missing override labels.
[dcpomatic.git] / src / lib / config.h
index 0a48a00e1dfc8a71ac66e77ca26a07d73610e2c4..e9b3ec203af95e762f6271ef66aa501f36ab5a1d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2022 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
  *  @brief Class holding configuration.
  */
 
+
 #ifndef DCPOMATIC_CONFIG_H
 #define DCPOMATIC_CONFIG_H
 
-#include "isdcf_metadata.h"
-#include "types.h"
-#include "state.h"
-#include "edid.h"
+
 #include "audio_mapping.h"
+#include "state.h"
+#include "types.h"
 #include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
 #include <dcp/encrypted_kdm.h>
 #include <boost/filesystem.hpp>
 #include <vector>
 
+
+class Cinema;
 class CinemaSoundProcessor;
 class DCPContentType;
-class Ratio;
-class Cinema;
-class Film;
 class DKDMGroup;
 class DKDMRecipient;
+class Film;
+class Ratio;
+
+
+extern void save_all_config_as_zip (boost::filesystem::path zip_file);
+
 
 /** @class Config
  *  @brief A singleton class holding configuration.
@@ -142,11 +147,11 @@ public:
                return _tms_password;
        }
 
-       std::list<std::shared_ptr<Cinema> > cinemas () const {
+       std::list<std::shared_ptr<Cinema>> cinemas () const {
                return _cinemas;
        }
 
-       std::list<std::shared_ptr<DKDMRecipient> > dkdm_recipients () const {
+       std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
                return _dkdm_recipients;
        }
 
@@ -166,10 +171,6 @@ public:
                return _show_experimental_audio_processors;
        }
 
-       ISDCFMetadata default_isdcf_metadata () const {
-               return _default_isdcf_metadata;
-       }
-
        boost::optional<std::string> language () const {
                return _language;
        }
@@ -226,6 +227,10 @@ public:
                return _default_interop;
        }
 
+       std::map<std::string, std::string> default_metadata () const {
+               return _default_metadata;
+       }
+
        bool upload_after_make_dcp () {
                return _upload_after_make_dcp;
        }
@@ -399,11 +404,12 @@ public:
                NAG_DKDM_CONFIG,
                NAG_ENCRYPTED_METADATA,
                NAG_ALTER_DECRYPTION_CHAIN,
-               NAG_BAD_SIGNER_CHAIN,
+               NAG_BAD_SIGNER_CHAIN_UTF8,
                NAG_IMPORT_DECRYPTION_CHAIN,
                NAG_DELETE_DKDM,
                NAG_32_ON_64,
                NAG_TOO_MANY_DROPPED_FRAMES,
+               NAG_BAD_SIGNER_CHAIN_VALIDITY,
                NAG_COUNT
        };
 
@@ -519,10 +525,6 @@ public:
                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;
        }
@@ -541,14 +543,31 @@ public:
 
        AudioMapping audio_mapping (int output_channels);
 
-       int minimum_frame_size () const {
-               return _minimum_frame_size;
-       }
-
        std::vector<dcp::LanguageTag> custom_languages () const {
                return _custom_languages;
        }
 
+       boost::optional<boost::filesystem::path> add_files_path () const {
+               return _add_files_path;
+       }
+
+       bool use_isdcf_name_by_default () const {
+               return _use_isdcf_name_by_default;
+       }
+
+       bool write_kdms_to_disk () const {
+               return _write_kdms_to_disk;
+       }
+
+       bool email_kdms () const {
+               return _email_kdms;
+       }
+
+       dcp::Formulation default_kdm_type () const {
+               return _default_kdm_type;
+       }
+
+
        /* SET (mostly) */
 
        void set_master_encoding_threads (int n) {
@@ -636,10 +655,6 @@ public:
                maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
        }
 
-       void set_default_isdcf_metadata (ISDCFMetadata d) {
-               maybe_set (_default_isdcf_metadata, d);
-       }
-
        void set_language (std::string l) {
                if (_language && _language.get() == l) {
                        return;
@@ -709,6 +724,10 @@ public:
                maybe_set (_default_interop, i);
        }
 
+       void set_default_metadata (std::map<std::string, std::string> const& metadata) {
+               maybe_set (_default_metadata, metadata);
+       }
+
        void set_upload_after_make_dcp (bool u) {
                maybe_set (_upload_after_make_dcp, u);
        }
@@ -829,8 +848,6 @@ public:
 
        void set_cinemas_file (boost::filesystem::path file);
 
-       void set_dkdm_recipients_file (boost::filesystem::path file);
-
        void set_show_hints_before_make_dcp (bool s) {
                maybe_set (_show_hints_before_make_dcp, s);
        }
@@ -997,18 +1014,6 @@ public:
                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);
        }
@@ -1060,11 +1065,28 @@ public:
        void set_audio_mapping (AudioMapping m);
        void set_audio_mapping_to_default ();
 
-       void set_minimum_frame_size (int size) {
-               maybe_set (_minimum_frame_size, size);
+       void add_custom_language (dcp::LanguageTag tag);
+
+       void set_add_files_path (boost::filesystem::path p) {
+               _add_files_path = p;
+               changed ();
        }
 
-       void add_custom_language (dcp::LanguageTag tag);
+       void set_use_isdcf_name_by_default (bool use) {
+               maybe_set (_use_isdcf_name_by_default, use);
+       }
+
+       void set_write_kdms_to_disk (bool write) {
+               maybe_set (_write_kdms_to_disk, write);
+       }
+
+       void set_email_kdms (bool email) {
+               maybe_set (_email_kdms, email);
+       }
+
+       void set_default_kdm_type (dcp::Formulation type) {
+               maybe_set (_default_kdm_type, type);
+       }
 
        void changed (Property p = OTHER);
        boost::signals2::signal<void (Property)> Changed;
@@ -1078,14 +1100,15 @@ public:
         *  true to ask Config to solve the problem (by discarding and recreating the bad thing)
         */
        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
+               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
+               BAD_SIGNER_VALIDITY_TOO_LONG, ///< signer certificate validity periods are >10 years
        };
 
        static boost::signals2::signal<bool (BadReason)> Bad;
 
-       void write () const;
+       void write () const override;
        void write_config () const;
        void write_cinemas () const;
        void write_dkdm_recipients () const;
@@ -1096,19 +1119,23 @@ public:
        void save_template (std::shared_ptr<const Film> film, std::string name) const;
        bool existing_template (std::string name) const;
        std::list<std::string> templates () const;
-       boost::filesystem::path template_path (std::string name) const;
+       boost::filesystem::path template_read_path (std::string name) const;
+       boost::filesystem::path template_write_path (std::string name) const;
        void rename_template (std::string old_name, std::string new_name) const;
        void delete_template (std::string name) const;
 
+       boost::optional<BadReason> check_certificates () const;
+
        static Config* instance ();
        static void drop ();
        static void restore_defaults ();
        static bool have_existing (std::string);
-       static boost::filesystem::path config_file ();
+       static boost::filesystem::path config_read_file ();
+       static boost::filesystem::path config_write_file ();
 
 private:
        Config ();
-       void read ();
+       void read () override;
        void set_defaults ();
        void set_kdm_email_to_default ();
        void set_notification_email_to_default ();
@@ -1174,8 +1201,6 @@ private:
        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;
        /** Default length of still image content (seconds) */
        int _default_still_length;
@@ -1191,13 +1216,14 @@ private:
        int _default_j2k_bandwidth;
        int _default_audio_delay;
        bool _default_interop;
+       std::map<std::string, std::string> _default_metadata;
        /** Default directory to offer to write KDMs to; if it's not set,
            the home directory will be offered.
        */
        boost::optional<boost::filesystem::path> _default_kdm_directory;
        bool _upload_after_make_dcp;
-       std::list<std::shared_ptr<Cinema> > _cinemas;
-       std::list<std::shared_ptr<DKDMRecipient> > _dkdm_recipients;
+       std::list<std::shared_ptr<Cinema>> _cinemas;
+       std::list<std::shared_ptr<DKDMRecipient>> _dkdm_recipients;
        std::string _mail_server;
        int _mail_port;
        EmailProtocol _mail_protocol;
@@ -1265,10 +1291,6 @@ private:
        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.
-       */
-       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
@@ -1279,8 +1301,12 @@ private:
        boost::optional<boost::filesystem::path> _player_playlist_directory;
        boost::optional<boost::filesystem::path> _player_kdm_directory;
        boost::optional<AudioMapping> _audio_mapping;
-       int _minimum_frame_size;
        std::vector<dcp::LanguageTag> _custom_languages;
+       boost::optional<boost::filesystem::path> _add_files_path;
+       bool _use_isdcf_name_by_default;
+       bool _write_kdms_to_disk;
+       bool _email_kdms;
+       dcp::Formulation _default_kdm_type;
 
        static int const _current_version;