/*
- Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
This file is part of DCP-o-matic.
#ifndef DCPOMATIC_CONFIG_H
#define DCPOMATIC_CONFIG_H
-#include "isdcf_metadata.h"
#include "types.h"
-#include "edid.h"
+#include "state.h"
+#include "audio_mapping.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 Film;
class DKDMGroup;
+class DKDMRecipient;
/** @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 */
USE_ANY_SERVERS,
SERVERS,
CINEMAS,
+ DKDM_RECIPIENTS,
SOUND,
SOUND_OUTPUT,
- INTERFACE_COMPLEXITY,
PLAYER_CONTENT_DIRECTORY,
PLAYER_PLAYLIST_DIRECTORY,
+ PLAYER_DEBUG_LOG,
HISTORY,
-#ifdef DCPOMATIC_VARIANT_SWAROOP
- PLAYER_BACKGROUND_IMAGE,
-#endif
+ SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
+ AUDIO_MAPPING,
OTHER
};
return _only_servers_encode;
}
- Protocol tms_protocol () const {
+ FileTransferProtocol tms_protocol () const {
return _tms_protocol;
}
return _tms_password;
}
- /** @return The cinema sound processor that we are using */
- CinemaSoundProcessor const * cinema_sound_processor () const {
- return _cinema_sound_processor;
+ std::list<std::shared_ptr<Cinema> > cinemas () const {
+ return _cinemas;
}
- std::list<boost::shared_ptr<Cinema> > cinemas () const {
- return _cinemas;
+ std::list<std::shared_ptr<DKDMRecipient> > dkdm_recipients () const {
+ return _dkdm_recipients;
}
std::list<int> allowed_dcp_frame_rates () const {
return _allow_any_container;
}
- ISDCFMetadata default_isdcf_metadata () const {
- return _default_isdcf_metadata;
+ bool show_experimental_audio_processors () const {
+ return _show_experimental_audio_processors;
}
boost::optional<std::string> language () const {
return _default_container;
}
- Ratio const * default_scale_to () const {
- return _default_scale_to;
- }
-
DCPContentType const * default_dcp_content_type () const {
return _default_dcp_content_type;
}
return _dcp_creator;
}
+ std::string dcp_company_name () const {
+ return _dcp_company_name;
+ }
+
+ std::string dcp_product_name () const {
+ return _dcp_product_name;
+ }
+
+ std::string dcp_product_version () const {
+ return _dcp_product_version;
+ }
+
+ std::string dcp_j2k_comment () const {
+ return _dcp_j2k_comment;
+ }
+
int default_j2k_bandwidth () const {
return _default_j2k_bandwidth;
}
return _default_interop;
}
- bool default_upload_after_make_dcp () {
- return _default_upload_after_make_dcp;
+ bool upload_after_make_dcp () {
+ return _upload_after_make_dcp;
}
void set_default_kdm_directory (boost::filesystem::path d) {
return _mail_port;
}
+ EmailProtocol mail_protocol () const {
+ return _mail_protocol;
+ }
+
std::string mail_user () const {
return _mail_user;
}
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 _cinemas_file;
}
+ boost::filesystem::path dkdm_recipients_file () const {
+ return _dkdm_recipients_file;
+ }
+
bool show_hints_before_make_dcp () const {
return _show_hints_before_make_dcp;
}
return _kdm_filename_format;
}
+ dcp::NameFormat dkdm_filename_format () const {
+ return _dkdm_filename_format;
+ }
+
dcp::NameFormat dcp_metadata_filename_format () const {
return _dcp_metadata_filename_format;
}
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_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_DELETE_DKDM,
+ NAG_32_ON_64,
+ NAG_TOO_MANY_DROPPED_FRAMES,
NAG_COUNT
};
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
+ PLAYER_MODE_WINDOW, ///< one window containing image and controls
+ PLAYER_MODE_FULL, ///< just the image filling the screen
+ PLAYER_MODE_DUAL ///< image on one monitor and extended controls on the other
};
PlayerMode player_mode () const {
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;
}
- boost::optional<boost::filesystem::path> player_log_file () const {
- return _player_log_file;
+ 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_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;
- }
+ AudioMapping audio_mapping (int output_channels);
- std::vector<Monitor> required_monitors () const {
- return _required_monitors;
+ std::vector<dcp::LanguageTag> custom_languages () const {
+ return _custom_languages;
}
- boost::optional<boost::filesystem::path> player_lock_file () const {
- return _player_lock_file;
+ boost::optional<boost::filesystem::path> add_files_path () const {
+ return _add_files_path;
}
-#endif
/* SET (mostly) */
maybe_set (_only_servers_encode, o);
}
- void set_tms_protocol (Protocol p) {
+ void set_tms_protocol (FileTransferProtocol p) {
maybe_set (_tms_protocol, p);
}
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 (std::shared_ptr<DKDMRecipient> c) {
+ _dkdm_recipients.push_back (c);
+ changed (DKDM_RECIPIENTS);
+ }
+
+ void remove_dkdm_recipient (std::shared_ptr<DKDMRecipient> c) {
+ _dkdm_recipients.remove (c);
+ changed (DKDM_RECIPIENTS);
+ }
+
void set_allowed_dcp_frame_rates (std::list<int> const & r) {
maybe_set (_allowed_dcp_frame_rates, r);
}
maybe_set (_allow_any_container, a);
}
- void set_default_isdcf_metadata (ISDCFMetadata d) {
- maybe_set (_default_isdcf_metadata, d);
+ 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_container, c);
}
- void set_default_scale_to (Ratio const * c) {
- maybe_set (_default_scale_to, c);
- }
-
void set_default_dcp_content_type (DCPContentType const * t) {
maybe_set (_default_dcp_content_type, t);
}
maybe_set (_dcp_creator, c);
}
+ void set_dcp_company_name (std::string c) {
+ maybe_set (_dcp_company_name, c);
+ }
+
+ void set_dcp_product_name (std::string c) {
+ maybe_set (_dcp_product_name, c);
+ }
+
+ void set_dcp_product_version (std::string c) {
+ maybe_set (_dcp_product_version, c);
+ }
+
+ void set_dcp_j2k_comment (std::string c) {
+ maybe_set (_dcp_j2k_comment, c);
+ }
+
void set_default_j2k_bandwidth (int b) {
maybe_set (_default_j2k_bandwidth, b);
}
maybe_set (_default_interop, i);
}
- void set_default_upload_after_make_dcp (bool u) {
- maybe_set (_default_upload_after_make_dcp, u);
+ void set_upload_after_make_dcp (bool u) {
+ maybe_set (_upload_after_make_dcp, u);
}
void set_mail_server (std::string s) {
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);
}
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 (_kdm_filename_format, n);
}
+ void set_dkdm_filename_format (dcp::NameFormat n) {
+ maybe_set (_dkdm_filename_format, n);
+ }
+
void set_dcp_metadata_filename_format (dcp::NameFormat n) {
maybe_set (_dcp_metadata_filename_format, n);
}
}
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);
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);
}
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);
}
- void set_player_log_file (boost::filesystem::path p) {
- maybe_set (_player_log_file, p);
+ void set_player_activity_log_file (boost::filesystem::path p) {
+ maybe_set (_player_activity_log_file, p);
}
- void unset_player_log_file () {
- if (!_player_log_file) {
+ void unset_player_activity_log_file () {
+ if (!_player_activity_log_file) {
return;
}
- _player_log_file = boost::none;
+ _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);
}
changed ();
}
-#ifdef DCPOMATIC_VARIANT_SWAROOP
- void set_player_background_image (boost::filesystem::path p) {
- maybe_set (_player_background_image, p, PLAYER_BACKGROUND_IMAGE);
- }
+ void set_audio_mapping (AudioMapping m);
+ void set_audio_mapping_to_default ();
- 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 add_custom_language (dcp::LanguageTag tag);
- 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;
+ void set_add_files_path (boost::filesystem::path p) {
+ _add_files_path = p;
changed ();
}
-#endif
void changed (Property p = OTHER);
boost::signals2::signal<void (Property)> Changed;
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;
void write_cinemas () const;
+ void write_dkdm_recipients () 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;
+ 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;
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 ();
void set_notification_email_to_default ();
void set_cover_sheet_to_default ();
void read_cinemas (cxml::Document const & f);
- boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
+ 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>
/** 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 */
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 */
bool _allow_any_dcp_frame_rate;
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;
+ /** Offer the upmixers in the audio processor settings */
+ bool _show_experimental_audio_processors;
boost::optional<std::string> _language;
/** Default length of still image content (seconds) */
int _default_still_length;
Ratio const * _default_container;
- Ratio const * _default_scale_to;
DCPContentType const * _default_dcp_content_type;
int _default_dcp_audio_channels;
std::string _dcp_issuer;
std::string _dcp_creator;
+ std::string _dcp_company_name;
+ std::string _dcp_product_name;
+ std::string _dcp_product_version;
+ std::string _dcp_j2k_comment;
int _default_j2k_bandwidth;
int _default_audio_delay;
bool _default_interop;
the home directory will be offered.
*/
boost::optional<boost::filesystem::path> _default_kdm_directory;
- bool _default_upload_after_make_dcp;
- std::list<boost::shared_ptr<Cinema> > _cinemas;
+ bool _upload_after_make_dcp;
+ 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::string _mail_user;
std::string _mail_password;
std::string _kdm_subject;
std::vector<std::string> _notification_cc;
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
+ 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;
-#ifdef DCPOMATIC_VARIANT_SWAROOP
- boost::filesystem::path _decryption_chain_path;
-#endif
+ 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;
bool _confirm_kdm_email;
dcp::NameFormat _kdm_filename_format;
+ dcp::NameFormat _dkdm_filename_format;
dcp::NameFormat _kdm_container_name_format;
dcp::NameFormat _dcp_metadata_filename_format;
dcp::NameFormat _dcp_asset_filename_format;
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;
+ VideoViewType _video_view_type;
bool _respect_kdm_validity_periods;
- boost::optional<boost::filesystem::path> _player_log_file;
+ /** 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
+ boost::optional<AudioMapping> _audio_mapping;
+ std::vector<dcp::LanguageTag> _custom_languages;
+ boost::optional<boost::filesystem::path> _add_files_path;
static int const _current_version;
projects / dcpomatic.git / blobdiff