Basic release notes support (#2282).
[dcpomatic.git] / src / lib / config.h
index e01eab780e8c9ce4dfabd2aee89caa7675d1845e..9727bac1a16f0fc03398fa54c3643e0f3f255d57 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 "types.h"
-#include "state.h"
+
 #include "audio_mapping.h"
+#include "export_config.h"
+#include "rough_duration.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.
@@ -84,6 +93,7 @@ public:
                HISTORY,
                SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
                AUDIO_MAPPING,
+               AUTO_CROP_THRESHOLD,
                OTHER
        };
 
@@ -140,11 +150,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;
        }
 
@@ -160,6 +170,14 @@ public:
                return _allow_any_container;
        }
 
+       bool allow_96khz_audio () const {
+               return _allow_96khz_audio;
+       }
+
+       bool use_all_audio_channels () const {
+               return _use_all_audio_channels;
+       }
+
        bool show_experimental_audio_processors () const {
                return _show_experimental_audio_processors;
        }
@@ -544,6 +562,34 @@ public:
                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;
+       }
+
+       RoughDuration default_kdm_duration () const {
+               return _default_kdm_duration;
+       }
+
+       double auto_crop_threshold () const {
+               return _auto_crop_threshold;
+       }
+
+       boost::optional<std::string> last_release_notes_version () const {
+               return _last_release_notes_version;
+       }
+
        /* SET (mostly) */
 
        void set_master_encoding_threads (int n) {
@@ -627,6 +673,14 @@ public:
                maybe_set (_allow_any_container, a);
        }
 
+       void set_allow_96hhz_audio (bool a) {
+               maybe_set (_allow_96khz_audio, a);
+       }
+
+       void set_use_all_audio_channels (bool a) {
+               maybe_set (_use_all_audio_channels, a);
+       }
+
        void set_show_experimental_audio_processors (bool e) {
                maybe_set (_show_experimental_audio_processors, e, SHOW_EXPERIMENTAL_AUDIO_PROCESSORS);
        }
@@ -1048,6 +1102,38 @@ public:
                changed ();
        }
 
+       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 set_default_kdm_duration (RoughDuration duration) {
+               maybe_set (_default_kdm_duration, duration);
+       }
+
+       void set_auto_crop_threshold (double threshold) {
+               maybe_set (_auto_crop_threshold, threshold, AUTO_CROP_THRESHOLD);
+       }
+
+       void set_last_release_notes_version (std::string version) {
+               maybe_set (_last_release_notes_version, version);
+       }
+
+       ExportConfig& export_config() {
+               return _export;
+       }
+
        void changed (Property p = OTHER);
        boost::signals2::signal<void (Property)> Changed;
        /** Emitted if read() failed on an existing Config file.  There is nothing
@@ -1068,7 +1154,7 @@ public:
 
        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;
@@ -1093,21 +1179,6 @@ public:
        static boost::filesystem::path config_read_file ();
        static boost::filesystem::path config_write_file ();
 
-private:
-       Config ();
-       void read ();
-       void set_defaults ();
-       void set_kdm_email_to_default ();
-       void set_notification_email_to_default ();
-       void set_cover_sheet_to_default ();
-       void read_cinemas (cxml::Document const & f);
-       void read_dkdm_recipients (cxml::Document const & f);
-       std::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>
        void maybe_set (T& member, T new_value, Property prop = OTHER) {
                if (member == new_value) {
@@ -1126,6 +1197,21 @@ private:
                changed (prop);
        }
 
+private:
+       Config ();
+       void read () override;
+       void set_defaults ();
+       void set_kdm_email_to_default ();
+       void set_notification_email_to_default ();
+       void set_cover_sheet_to_default ();
+       void read_cinemas (cxml::Document const & f);
+       void read_dkdm_recipients (cxml::Document const & f);
+       std::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 ();
+
        /** number of threads which a master DoM should use for J2K encoding on the local machine */
        int _master_encoding_threads;
        /** number of threads which a server should use for J2K encoding on the local machine */
@@ -1159,6 +1245,8 @@ private:
            https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
        */
        bool _allow_any_container;
+       bool _allow_96khz_audio;
+       bool _use_all_audio_channels;
        /** Offer the upmixers in the audio processor settings */
        bool _show_experimental_audio_processors;
        boost::optional<std::string> _language;
@@ -1182,8 +1270,8 @@ private:
        */
        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;
@@ -1263,6 +1351,15 @@ private:
        boost::optional<AudioMapping> _audio_mapping;
        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;
+       RoughDuration _default_kdm_duration;
+       double _auto_crop_threshold;
+       boost::optional<std::string> _last_release_notes_version;
+
+       ExportConfig _export;
 
        static int const _current_version;
 
@@ -1270,4 +1367,5 @@ private:
        static Config* _instance;
 };
 
+
 #endif