Add configuration options for DKDMs.
[dcpomatic.git] / src / lib / config.h
index 29511b1fe80c47e150d4b9669b1e55686de15386..f54ca3814043abf5c8fa51c619c975cf87591113 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
     This file is part of DCP-o-matic.
 
@@ -29,6 +29,7 @@
 #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>
@@ -43,6 +44,7 @@ class Ratio;
 class Cinema;
 class Film;
 class DKDMGroup;
+class DKDMRecipient;
 
 /** @class Config
  *  @brief A singleton class holding configuration.
@@ -75,6 +77,7 @@ public:
                USE_ANY_SERVERS,
                SERVERS,
                CINEMAS,
+               DKDM_RECIPIENTS,
                SOUND,
                SOUND_OUTPUT,
                INTERFACE_COMPLEXITY,
@@ -82,6 +85,8 @@ public:
                PLAYER_PLAYLIST_DIRECTORY,
                PLAYER_DEBUG_LOG,
                HISTORY,
+               SHOW_EXPERIMENTAL_AUDIO_PROCESSORS,
+               AUDIO_MAPPING,
 #ifdef DCPOMATIC_VARIANT_SWAROOP
                PLAYER_BACKGROUND_IMAGE,
 #endif
@@ -141,15 +146,14 @@ 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;
        }
 
+       std::list<boost::shared_ptr<DKDMRecipient> > dkdm_recipients () const {
+               return _dkdm_recipients;
+       }
+
        std::list<int> allowed_dcp_frame_rates () const {
                return _allowed_dcp_frame_rates;
        }
@@ -162,6 +166,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;
        }
@@ -340,6 +348,10 @@ public:
                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;
        }
@@ -356,6 +368,10 @@ public:
                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;
        }
@@ -476,9 +492,9 @@ public:
        }
 
        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 {
@@ -522,6 +538,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;
@@ -613,6 +631,16 @@ public:
                changed (CINEMAS);
        }
 
+       void add_dkdm_recipient (boost::shared_ptr<DKDMRecipient> c) {
+               _dkdm_recipients.push_back (c);
+               changed (DKDM_RECIPIENTS);
+       }
+
+       void remove_dkdm_recipient (boost::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);
        }
@@ -625,6 +653,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);
        }
@@ -806,6 +838,8 @@ 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);
        }
@@ -851,6 +885,10 @@ public:
                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);
        }
@@ -1032,6 +1070,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);
@@ -1100,6 +1141,7 @@ public:
        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;
@@ -1125,6 +1167,7 @@ private:
        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);
@@ -1173,8 +1216,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 */
@@ -1184,6 +1225,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;
@@ -1204,6 +1247,7 @@ private:
        boost::optional<boost::filesystem::path> _default_kdm_directory;
        bool _default_upload_after_make_dcp;
        std::list<boost::shared_ptr<Cinema> > _cinemas;
+       std::list<boost::shared_ptr<DKDMRecipient> > _dkdm_recipients;
        std::string _mail_server;
        int _mail_port;
        EmailProtocol _mail_protocol;
@@ -1246,9 +1290,11 @@ private:
        std::vector<boost::filesystem::path> _player_history;
        boost::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;
@@ -1289,6 +1335,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;