Basic template support (#485).
[dcpomatic.git] / src / lib / config.h
index 40b65534211439c5a29b19a22a2d417292e57856..213c13a83db81beeee4e3b85957fed6f67914431 100644 (file)
@@ -1,19 +1,20 @@
 /*
-    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    DCP-o-matic is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
 
 */
 
 #define DCPOMATIC_CONFIG_H
 
 #include "isdcf_metadata.h"
-#include "video_content.h"
-#include <dcp/metadata.h>
-#include <dcp/certificate.h>
+#include "types.h"
+#include <dcp/name_format.h>
 #include <dcp/certificate_chain.h>
+#include <dcp/encrypted_kdm.h>
 #include <boost/shared_ptr.hpp>
 #include <boost/signals2.hpp>
 #include <boost/filesystem.hpp>
 #include <vector>
 
-class ServerDescription;
-class Scaler;
-class Filter;
 class CinemaSoundProcessor;
 class DCPContentType;
 class Ratio;
 class Cinema;
+class Film;
 
 /** @class Config
  *  @brief A singleton class holding configuration.
@@ -90,6 +89,10 @@ public:
                return _servers;
        }
 
+       bool only_servers_encode () const {
+               return _only_servers_encode;
+       }
+
        Protocol tms_protocol () const {
                return _tms_protocol;
        }
@@ -151,6 +154,10 @@ public:
                return _default_dcp_content_type;
        }
 
+       int default_dcp_audio_channels () const {
+               return _default_dcp_audio_channels;
+       }
+
        std::string dcp_issuer () const {
                return _dcp_issuer;
        }
@@ -167,6 +174,10 @@ public:
                return _default_audio_delay;
        }
 
+       bool default_interop () const {
+               return _default_interop;
+       }
+
        std::string mail_server () const {
                return _mail_server;
        }
@@ -191,7 +202,7 @@ public:
                return _kdm_from;
        }
 
-       std::string kdm_cc () const {
+       std::vector<std::string> kdm_cc () const {
                return _kdm_cc;
        }
 
@@ -227,6 +238,14 @@ public:
                return _log_types;
        }
 
+       bool analyse_ebur128 () const {
+               return _analyse_ebur128;
+       }
+
+       bool automatic_audio_analysis () const {
+               return _automatic_audio_analysis;
+       }
+
 #ifdef DCPOMATIC_WINDOWS
        bool win32_console () const {
                return _win32_console;
@@ -237,6 +256,30 @@ public:
                return _history;
        }
 
+       std::vector<dcp::EncryptedKDM> dkdms () const {
+               return _dkdms;
+       }
+
+       boost::filesystem::path cinemas_file () const {
+               return _cinemas_file;
+       }
+
+       bool show_hints_before_make_dcp () const {
+               return _show_hints_before_make_dcp;
+       }
+
+       dcp::NameFormat kdm_filename_format () const {
+               return _kdm_filename_format;
+       }
+
+       dcp::NameFormat dcp_metadata_filename_format () const {
+               return _dcp_metadata_filename_format;
+       }
+
+       dcp::NameFormat dcp_asset_filename_format () const {
+               return _dcp_asset_filename_format;
+       }
+
        /** @param n New number of local encoding threads */
        void set_num_local_encoding_threads (int n) {
                maybe_set (_num_local_encoding_threads, n);
@@ -251,6 +294,10 @@ public:
                maybe_set (_server_port_base, p);
        }
 
+       void set_only_servers_encode (bool o) {
+               maybe_set (_only_servers_encode, o);
+       }
+
        void set_tms_protocol (Protocol p) {
                maybe_set (_tms_protocol, p);
        }
@@ -326,6 +373,10 @@ public:
                maybe_set (_default_dcp_content_type, t);
        }
 
+       void set_default_dcp_audio_channels (int c) {
+               maybe_set (_default_dcp_audio_channels, c);
+       }
+
        void set_dcp_issuer (std::string i) {
                maybe_set (_dcp_issuer, i);
        }
@@ -342,6 +393,10 @@ public:
                maybe_set (_default_audio_delay, d);
        }
 
+       void set_default_interop (bool i) {
+               maybe_set (_default_interop, i);
+       }
+
        void set_mail_server (std::string s) {
                maybe_set (_mail_server, s);
        }
@@ -366,7 +421,7 @@ public:
                maybe_set (_kdm_from, f);
        }
 
-       void set_kdm_cc (std::string f) {
+       void set_kdm_cc (std::vector<std::string> f) {
                maybe_set (_kdm_cc, f);
        }
 
@@ -390,6 +445,9 @@ public:
 
        void set_check_for_updates (bool c) {
                maybe_set (_check_for_updates, c);
+               if (!c) {
+                       set_check_for_test_updates (false);
+               }
        }
 
        void set_check_for_test_updates (bool c) {
@@ -404,12 +462,43 @@ public:
                maybe_set (_log_types, t);
        }
 
+       void set_analyse_ebur128 (bool a) {
+               maybe_set (_analyse_ebur128, a);
+       }
+
+       void set_automatic_audio_analysis (bool a) {
+               maybe_set (_automatic_audio_analysis, a);
+       }
+
 #ifdef DCPOMATIC_WINDOWS
        void set_win32_console (bool c) {
                maybe_set (_win32_console, c);
        }
 #endif
 
+       void set_dkdms (std::vector<dcp::EncryptedKDM> dkdms) {
+               _dkdms = dkdms;
+               changed ();
+       }
+
+       void set_cinemas_file (boost::filesystem::path file);
+
+       void set_show_hints_before_make_dcp (bool s) {
+               maybe_set (_show_hints_before_make_dcp, s);
+       }
+
+       void set_kdm_filename_format (dcp::NameFormat n) {
+               maybe_set (_kdm_filename_format, n);
+       }
+
+       void set_dcp_metadata_filename_format (dcp::NameFormat n) {
+               maybe_set (_dcp_metadata_filename_format, n);
+       }
+
+       void set_dcp_asset_filename_format (dcp::NameFormat n) {
+               maybe_set (_dcp_asset_filename_format, n);
+       }
+
        void clear_history () {
                _history.clear ();
                changed ();
@@ -419,20 +508,33 @@ public:
 
        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;
 
        void write () const;
 
+       void save_template (boost::shared_ptr<const Film> film, std::string name) const;
+       bool existing_template (std::string name) const;
+       std::list<std::string> template_names () const;
+       boost::filesystem::path template_path (std::string name) const;
+
        static Config* instance ();
        static void drop ();
        static void restore_defaults ();
-       static bool have_existing ();
+       static bool have_existing (std::string);
 
 private:
        Config ();
-       static boost::filesystem::path file ();
+       static boost::filesystem::path path (std::string file, bool create_directories = true);
        void read ();
        void set_defaults ();
        void set_kdm_email_to_default ();
+       void write_config_xml () const;
+       void write_cinemas_xml () const;
+       void read_cinemas (cxml::Document const & f);
+       boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
 
        template <class T>
        void maybe_set (T& member, T new_value) {
@@ -448,13 +550,14 @@ private:
        /** default directory to put new films in */
        boost::filesystem::path _default_directory;
        /** base port number to use for J2K encoding servers;
-        *  this port and the one above it will be used.
+        *  this port and the two above it will be used.
         */
        int _server_port_base;
        /** true to broadcast on the `any' address to look for servers */
        bool _use_any_servers;
        /** J2K encoding servers that should definitely be used */
        std::vector<std::string> _servers;
+       bool _only_servers_encode;
        Protocol _tms_protocol;
        /** The IP address of a TMS that we can copy DCPs to */
        std::string _tms_ip;
@@ -476,10 +579,12 @@ private:
        int _default_still_length;
        Ratio const * _default_container;
        DCPContentType const * _default_dcp_content_type;
+       int _default_dcp_audio_channels;
        std::string _dcp_issuer;
        std::string _dcp_creator;
        int _default_j2k_bandwidth;
        int _default_audio_delay;
+       bool _default_interop;
        std::list<boost::shared_ptr<Cinema> > _cinemas;
        std::string _mail_server;
        int _mail_port;
@@ -487,7 +592,7 @@ private:
        std::string _mail_password;
        std::string _kdm_subject;
        std::string _kdm_from;
-       std::string _kdm_cc;
+       std::vector<std::string> _kdm_cc;
        std::string _kdm_bcc;
        std::string _kdm_email;
        boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
@@ -501,10 +606,18 @@ private:
        /** maximum allowed J2K bandwidth in bits per second */
        int _maximum_j2k_bandwidth;
        int _log_types;
+       bool _analyse_ebur128;
+       bool _automatic_audio_analysis;
 #ifdef DCPOMATIC_WINDOWS
        bool _win32_console;
 #endif
        std::vector<boost::filesystem::path> _history;
+       std::vector<dcp::EncryptedKDM> _dkdms;
+       boost::filesystem::path _cinemas_file;
+       bool _show_hints_before_make_dcp;
+       dcp::NameFormat _kdm_filename_format;
+       dcp::NameFormat _dcp_metadata_filename_format;
+       dcp::NameFormat _dcp_asset_filename_format;
 
        /** Singleton instance, or 0 */
        static Config* _instance;