/*
- Copyright (C) 2012-2020 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 "export_config.h"
+#include "rough_duration.h"
+#include "state.h"
#include <dcp/name_format.h>
#include <dcp/certificate_chain.h>
#include <dcp/encrypted_kdm.h>
-#include <boost/shared_ptr.hpp>
+#include <dcp/language_tag.h>
#include <boost/signals2.hpp>
#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.
boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
+ void load_from_zip(boost::filesystem::path zip_file);
+
enum Property {
USE_ANY_SERVERS,
SERVERS,
HISTORY,
SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
AUDIO_MAPPING,
+ AUTO_CROP_THRESHOLD,
+ ALLOW_SMPTE_BV20,
+ ISDCF_NAME_PART_LENGTH,
OTHER
};
return _tms_protocol;
}
+ bool tms_passive() const {
+ return _tms_passive;
+ }
+
/** @return The IP address of a TMS that we can copy DCPs to */
std::string tms_ip () const {
return _tms_ip;
return _tms_password;
}
- std::list<boost::shared_ptr<Cinema> > cinemas () const {
+ std::list<std::shared_ptr<Cinema>> cinemas () const {
return _cinemas;
}
- std::list<boost::shared_ptr<DKDMRecipient> > dkdm_recipients () const {
+ std::list<std::shared_ptr<DKDMRecipient>> dkdm_recipients () const {
return _dkdm_recipients;
}
return _allow_any_container;
}
- bool show_experimental_audio_processors () const {
- return _show_experimental_audio_processors;
+ bool allow_96khz_audio () const {
+ return _allow_96khz_audio;
}
- ISDCFMetadata default_isdcf_metadata () const {
- return _default_isdcf_metadata;
+ bool use_all_audio_channels () const {
+ return _use_all_audio_channels;
+ }
+
+ bool show_experimental_audio_processors () const {
+ return _show_experimental_audio_processors;
}
boost::optional<std::string> language () const {
return _default_still_length;
}
- Ratio const * default_container () const {
- return _default_container;
- }
-
DCPContentType const * default_dcp_content_type () const {
return _default_dcp_content_type;
}
return _default_interop;
}
+ boost::optional<dcp::LanguageTag> default_audio_language() const {
+ return _default_audio_language;
+ }
+
+ boost::optional<dcp::LanguageTag::RegionSubtag> default_territory() const {
+ return _default_territory;
+ }
+
+ std::map<std::string, std::string> default_metadata () const {
+ return _default_metadata;
+ }
+
bool upload_after_make_dcp () {
return _upload_after_make_dcp;
}
return _notification_email;
}
- boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
+ std::shared_ptr<const dcp::CertificateChain> signer_chain () const {
return _signer_chain;
}
- boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
+ std::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
return _decryption_chain;
}
return _player_history;
}
- boost::shared_ptr<DKDMGroup> dkdms () const {
+ std::shared_ptr<DKDMGroup> dkdms () const {
return _dkdms;
}
return _jump_to_selected;
}
+ /* This could be an enum class but we use the enum a lot to index _nagged
+ * so it means a lot of casts.
+ */
enum Nag {
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_BAD_SIGNER_DN_QUALIFIER,
NAG_COUNT
};
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;
}
AudioMapping audio_mapping (int output_channels);
+ std::vector<dcp::LanguageTag> custom_languages () const {
+ return _custom_languages;
+ }
+
+ boost::optional<boost::filesystem::path> initial_path(std::string id) const;
+
+ 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;
+ }
+
+ boost::optional<int> main_divider_sash_position() const {
+ return _main_divider_sash_position;
+ }
+
+ boost::optional<int> main_content_divider_sash_position() const {
+ return _main_content_divider_sash_position;
+ }
+
+ enum class DefaultAddFileLocation {
+ SAME_AS_LAST_TIME,
+ SAME_AS_PROJECT
+ };
+
+ DefaultAddFileLocation default_add_file_location() const {
+ return _default_add_file_location;
+ }
+
+ bool allow_smpte_bv20() const {
+ return _allow_smpte_bv20;
+ }
+
+ int isdcf_name_part_length() const {
+ return _isdcf_name_part_length;
+ }
+
/* SET (mostly) */
void set_master_encoding_threads (int n) {
maybe_set (_tms_protocol, p);
}
+ void set_tms_passive(bool passive) {
+ maybe_set(_tms_passive, passive);
+ }
+
/** @param i IP address of a TMS that we can copy DCPs to */
void set_tms_ip (std::string i) {
maybe_set (_tms_ip, i);
maybe_set (_tms_password, p);
}
- void add_cinema (boost::shared_ptr<Cinema> c) {
+ void add_cinema (std::shared_ptr<Cinema> c) {
_cinemas.push_back (c);
changed (CINEMAS);
}
- void remove_cinema (boost::shared_ptr<Cinema> c) {
+ void remove_cinema (std::shared_ptr<Cinema> c) {
_cinemas.remove (c);
changed (CINEMAS);
}
- void add_dkdm_recipient (boost::shared_ptr<DKDMRecipient> c) {
+ void add_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
_dkdm_recipients.push_back (c);
changed (DKDM_RECIPIENTS);
}
- void remove_dkdm_recipient (boost::shared_ptr<DKDMRecipient> c) {
+ void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
_dkdm_recipients.remove (c);
changed (DKDM_RECIPIENTS);
}
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_allow_96hhz_audio (bool a) {
+ maybe_set (_allow_96khz_audio, a);
}
- void set_default_isdcf_metadata (ISDCFMetadata d) {
- maybe_set (_default_isdcf_metadata, d);
+ 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);
}
void set_language (std::string l) {
maybe_set (_default_still_length, s);
}
- void set_default_container (Ratio const * c) {
- maybe_set (_default_container, c);
- }
-
void set_default_dcp_content_type (DCPContentType const * t) {
maybe_set (_default_dcp_content_type, t);
}
maybe_set (_default_interop, i);
}
+ void set_default_audio_language(dcp::LanguageTag tag) {
+ maybe_set(_default_audio_language, tag);
+ }
+
+ void unset_default_audio_language() {
+ maybe_set(_default_audio_language, boost::optional<dcp::LanguageTag>());
+ }
+
+ void set_default_territory(dcp::LanguageTag::RegionSubtag tag) {
+ maybe_set(_default_territory, tag);
+ }
+
+ void unset_default_territory() {
+ maybe_set(_default_territory, boost::optional<dcp::LanguageTag::RegionSubtag>());
+ }
+
+ 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);
}
void reset_notification_email ();
- void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
+ void set_signer_chain (std::shared_ptr<const dcp::CertificateChain> s) {
maybe_set (_signer_chain, s);
}
- void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
+ void set_decryption_chain (std::shared_ptr<const dcp::CertificateChain> c) {
maybe_set (_decryption_chain, c);
}
}
#endif
- void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
+ void set_dkdms (std::shared_ptr<DKDMGroup> dkdms) {
_dkdms = dkdms;
changed ();
}
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);
}
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 set_audio_mapping (AudioMapping m);
void set_audio_mapping_to_default ();
+ void add_custom_language (dcp::LanguageTag tag);
+
+ void set_initial_path(std::string id, boost::filesystem::path path);
+
+ 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);
+ }
+
+ void unset_last_release_notes_version() {
+ maybe_set(_last_release_notes_version, boost::optional<std::string>());
+ }
+
+ ExportConfig& export_config() {
+ return _export;
+ }
+
+ void set_main_divider_sash_position(int position) {
+ maybe_set(_main_divider_sash_position, position);
+ }
+
+ void set_main_content_divider_sash_position(int position) {
+ maybe_set(_main_content_divider_sash_position, position);
+ }
+
+ void set_default_add_file_location(DefaultAddFileLocation location) {
+ maybe_set(_default_add_file_location, location);
+ }
+
+ void set_allow_smpte_bv20(bool allow) {
+ maybe_set(_allow_smpte_bv20, allow, ALLOW_SMPTE_BV20);
+ }
+
+ void set_isdcf_name_part_length(int length) {
+ maybe_set(_isdcf_name_part_length, length, ISDCF_NAME_PART_LENGTH);
+ }
+
void changed (Property p = OTHER);
boost::signals2::signal<void (Property)> Changed;
/** Emitted if read() failed on an existing Config file. There is nothing
a listener can do about it: this is just for information.
*/
- static boost::signals2::signal<void ()> FailedToLoad;
+ enum class LoadFailure {
+ CONFIG,
+ CINEMAS,
+ DKDM_RECIPIENTS
+ };
+ static boost::signals2::signal<void (LoadFailure)> 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 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)
*/
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
+ BAD_SIGNER_DN_QUALIFIER, ///< some signer certificate has a bad dnQualifier (DoM #2716).
};
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;
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;
+ 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 ();
-
-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);
- 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 ();
+ static boost::filesystem::path config_read_file ();
+ static boost::filesystem::path config_write_file ();
template <class T>
void maybe_set (T& member, T new_value, Property prop = OTHER) {
changed (prop);
}
+private:
+ Config ();
+ void read () override;
+ void read_config();
+ void read_cinemas();
+ void read_dkdm_recipients();
+ 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 */
std::vector<std::string> _servers;
bool _only_servers_encode;
FileTransferProtocol _tms_protocol;
+ bool _tms_passive;
/** 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 */
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;
- /** 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;
- Ratio const * _default_container;
DCPContentType const * _default_dcp_content_type;
int _default_dcp_audio_channels;
std::string _dcp_issuer;
int _default_j2k_bandwidth;
int _default_audio_delay;
bool _default_interop;
+ boost::optional<dcp::LanguageTag> _default_audio_language;
+ boost::optional<dcp::LanguageTag::RegionSubtag> _default_territory;
+ 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<boost::shared_ptr<Cinema> > _cinemas;
- std::list<boost::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;
std::vector<std::string> _notification_cc;
std::string _notification_bcc;
std::string _notification_email;
- boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
+ std::shared_ptr<const dcp::CertificateChain> _signer_chain;
/** 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;
+ std::shared_ptr<const dcp::CertificateChain> _decryption_chain;
/** true to check for updates on startup */
bool _check_for_updates;
bool _check_for_test_updates;
#endif
std::vector<boost::filesystem::path> _history;
std::vector<boost::filesystem::path> _player_history;
- boost::shared_ptr<DKDMGroup> _dkdms;
+ std::shared_ptr<DKDMGroup> _dkdms;
boost::filesystem::path _cinemas_file;
boost::filesystem::path _dkdm_recipients_file;
bool _show_hints_before_make_dcp;
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
boost::optional<boost::filesystem::path> _player_playlist_directory;
boost::optional<boost::filesystem::path> _player_kdm_directory;
boost::optional<AudioMapping> _audio_mapping;
+ std::vector<dcp::LanguageTag> _custom_languages;
+ std::map<std::string, boost::optional<boost::filesystem::path>> _initial_paths;
+ 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;
+ boost::optional<int> _main_divider_sash_position;
+ boost::optional<int> _main_content_divider_sash_position;
+ DefaultAddFileLocation _default_add_file_location;
+ bool _allow_smpte_bv20;
+ int _isdcf_name_part_length;
+
+ ExportConfig _export;
static int const _current_version;
static Config* _instance;
};
+
#endif
projects / dcpomatic.git / blobdiff