2 Copyright (C) 2012-2017 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/config.h
22 * @brief Class holding configuration.
25 #ifndef DCPOMATIC_CONFIG_H
26 #define DCPOMATIC_CONFIG_H
28 #include "isdcf_metadata.h"
30 #include <dcp/name_format.h>
31 #include <dcp/certificate_chain.h>
32 #include <dcp/encrypted_kdm.h>
33 #include <boost/shared_ptr.hpp>
34 #include <boost/signals2.hpp>
35 #include <boost/filesystem.hpp>
38 class CinemaSoundProcessor;
46 * @brief A singleton class holding configuration.
48 class Config : public boost::noncopyable
51 /** @return number of threads which a master DoM should use for J2K encoding on the local machine */
52 int master_encoding_threads () const {
53 return _master_encoding_threads;
56 /** @return number of threads which a server should use for J2K encoding on the local machine */
57 int server_encoding_threads () const {
58 return _server_encoding_threads;
61 boost::optional<boost::filesystem::path> default_directory () const {
62 return _default_directory;
65 boost::optional<boost::filesystem::path> default_kdm_directory () const {
66 return _default_kdm_directory;
69 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
70 boost::filesystem::path default_kdm_directory_or (boost::filesystem::path a) const;
81 /** @return base port number to use for J2K encoding servers */
82 int server_port_base () const {
83 return _server_port_base;
86 void set_use_any_servers (bool u) {
88 changed (USE_ANY_SERVERS);
91 bool use_any_servers () const {
92 return _use_any_servers;
95 /** @param s New list of servers */
96 void set_servers (std::vector<std::string> s) {
101 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
102 std::vector<std::string> servers () const {
106 bool only_servers_encode () const {
107 return _only_servers_encode;
110 Protocol tms_protocol () const {
111 return _tms_protocol;
114 /** @return The IP address of a TMS that we can copy DCPs to */
115 std::string tms_ip () const {
119 /** @return The path on a TMS that we should changed DCPs to */
120 std::string tms_path () const {
124 /** @return User name to log into the TMS with */
125 std::string tms_user () const {
129 /** @return Password to log into the TMS with */
130 std::string tms_password () const {
131 return _tms_password;
134 /** @return The cinema sound processor that we are using */
135 CinemaSoundProcessor const * cinema_sound_processor () const {
136 return _cinema_sound_processor;
139 std::list<boost::shared_ptr<Cinema> > cinemas () const {
143 std::list<int> allowed_dcp_frame_rates () const {
144 return _allowed_dcp_frame_rates;
147 bool allow_any_dcp_frame_rate () const {
148 return _allow_any_dcp_frame_rate;
151 ISDCFMetadata default_isdcf_metadata () const {
152 return _default_isdcf_metadata;
155 boost::optional<std::string> language () const {
159 int default_still_length () const {
160 return _default_still_length;
163 Ratio const * default_container () const {
164 return _default_container;
167 Ratio const * default_scale_to () const {
168 return _default_scale_to;
171 DCPContentType const * default_dcp_content_type () const {
172 return _default_dcp_content_type;
175 int default_dcp_audio_channels () const {
176 return _default_dcp_audio_channels;
179 std::string dcp_issuer () const {
183 std::string dcp_creator () const {
187 int default_j2k_bandwidth () const {
188 return _default_j2k_bandwidth;
191 int default_audio_delay () const {
192 return _default_audio_delay;
195 bool default_interop () const {
196 return _default_interop;
199 void set_default_kdm_directory (boost::filesystem::path d) {
200 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
203 _default_kdm_directory = d;
207 std::string mail_server () const {
211 int mail_port () const {
215 std::string mail_user () const {
219 std::string mail_password () const {
220 return _mail_password;
223 std::string kdm_subject () const {
227 std::string kdm_from () const {
231 std::vector<std::string> kdm_cc () const {
235 std::string kdm_bcc () const {
239 std::string kdm_email () const {
243 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
244 return _signer_chain;
247 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
248 return _decryption_chain;
251 bool check_for_updates () const {
252 return _check_for_updates;
255 bool check_for_test_updates () const {
256 return _check_for_test_updates;
259 int maximum_j2k_bandwidth () const {
260 return _maximum_j2k_bandwidth;
263 int log_types () const {
267 bool analyse_ebur128 () const {
268 return _analyse_ebur128;
271 bool automatic_audio_analysis () const {
272 return _automatic_audio_analysis;
275 #ifdef DCPOMATIC_WINDOWS
276 bool win32_console () const {
277 return _win32_console;
281 std::vector<boost::filesystem::path> history () const {
285 boost::shared_ptr<DKDMGroup> dkdms () const {
289 boost::filesystem::path cinemas_file () const {
290 return _cinemas_file;
293 bool show_hints_before_make_dcp () const {
294 return _show_hints_before_make_dcp;
297 bool confirm_kdm_email () const {
298 return _confirm_kdm_email;
301 dcp::NameFormat kdm_container_name_format () const {
302 return _kdm_container_name_format;
305 dcp::NameFormat kdm_filename_format () const {
306 return _kdm_filename_format;
309 dcp::NameFormat dcp_metadata_filename_format () const {
310 return _dcp_metadata_filename_format;
313 dcp::NameFormat dcp_asset_filename_format () const {
314 return _dcp_asset_filename_format;
317 bool jump_to_selected () const {
318 return _jump_to_selected;
323 NAG_ENCRYPTED_METADATA,
324 NAG_REMAKE_DECRYPTION_CHAIN,
328 bool nagged (Nag nag) const {
332 bool preview_sound () const {
333 return _preview_sound;
336 std::string cover_sheet () const {
340 boost::optional<std::string> preview_sound_output () const {
341 return _preview_sound_output;
344 void set_master_encoding_threads (int n) {
345 maybe_set (_master_encoding_threads, n);
348 void set_server_encoding_threads (int n) {
349 maybe_set (_server_encoding_threads, n);
352 void set_default_directory (boost::filesystem::path d) {
353 if (_default_directory && *_default_directory == d) {
356 _default_directory = d;
360 /** @param p New server port */
361 void set_server_port_base (int p) {
362 maybe_set (_server_port_base, p);
365 void set_only_servers_encode (bool o) {
366 maybe_set (_only_servers_encode, o);
369 void set_tms_protocol (Protocol p) {
370 maybe_set (_tms_protocol, p);
373 /** @param i IP address of a TMS that we can copy DCPs to */
374 void set_tms_ip (std::string i) {
375 maybe_set (_tms_ip, i);
378 /** @param p Path on a TMS that we should changed DCPs to */
379 void set_tms_path (std::string p) {
380 maybe_set (_tms_path, p);
383 /** @param u User name to log into the TMS with */
384 void set_tms_user (std::string u) {
385 maybe_set (_tms_user, u);
388 /** @param p Password to log into the TMS with */
389 void set_tms_password (std::string p) {
390 maybe_set (_tms_password, p);
393 void add_cinema (boost::shared_ptr<Cinema> c) {
394 _cinemas.push_back (c);
398 void remove_cinema (boost::shared_ptr<Cinema> c) {
403 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
404 maybe_set (_allowed_dcp_frame_rates, r);
407 void set_allow_any_dcp_frame_rate (bool a) {
408 maybe_set (_allow_any_dcp_frame_rate, a);
411 void set_default_isdcf_metadata (ISDCFMetadata d) {
412 maybe_set (_default_isdcf_metadata, d);
415 void set_language (std::string l) {
416 if (_language && _language.get() == l) {
423 void unset_language () {
428 _language = boost::none;
432 void set_default_still_length (int s) {
433 maybe_set (_default_still_length, s);
436 void set_default_container (Ratio const * c) {
437 maybe_set (_default_container, c);
440 void set_default_scale_to (Ratio const * c) {
441 maybe_set (_default_scale_to, c);
444 void set_default_dcp_content_type (DCPContentType const * t) {
445 maybe_set (_default_dcp_content_type, t);
448 void set_default_dcp_audio_channels (int c) {
449 maybe_set (_default_dcp_audio_channels, c);
452 void set_dcp_issuer (std::string i) {
453 maybe_set (_dcp_issuer, i);
456 void set_dcp_creator (std::string c) {
457 maybe_set (_dcp_creator, c);
460 void set_default_j2k_bandwidth (int b) {
461 maybe_set (_default_j2k_bandwidth, b);
464 void set_default_audio_delay (int d) {
465 maybe_set (_default_audio_delay, d);
468 void set_default_interop (bool i) {
469 maybe_set (_default_interop, i);
472 void set_mail_server (std::string s) {
473 maybe_set (_mail_server, s);
476 void set_mail_port (int p) {
477 maybe_set (_mail_port, p);
480 void set_mail_user (std::string u) {
481 maybe_set (_mail_user, u);
484 void set_mail_password (std::string p) {
485 maybe_set (_mail_password, p);
488 void set_kdm_subject (std::string s) {
489 maybe_set (_kdm_subject, s);
492 void set_kdm_from (std::string f) {
493 maybe_set (_kdm_from, f);
496 void set_kdm_cc (std::vector<std::string> f) {
497 maybe_set (_kdm_cc, f);
500 void set_kdm_bcc (std::string f) {
501 maybe_set (_kdm_bcc, f);
504 void set_kdm_email (std::string e) {
505 maybe_set (_kdm_email, e);
508 void reset_kdm_email ();
510 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
511 maybe_set (_signer_chain, s);
514 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
515 maybe_set (_decryption_chain, c);
518 void set_check_for_updates (bool c) {
519 maybe_set (_check_for_updates, c);
521 set_check_for_test_updates (false);
525 void set_check_for_test_updates (bool c) {
526 maybe_set (_check_for_test_updates, c);
529 void set_maximum_j2k_bandwidth (int b) {
530 maybe_set (_maximum_j2k_bandwidth, b);
533 void set_log_types (int t) {
534 maybe_set (_log_types, t);
537 void set_analyse_ebur128 (bool a) {
538 maybe_set (_analyse_ebur128, a);
541 void set_automatic_audio_analysis (bool a) {
542 maybe_set (_automatic_audio_analysis, a);
545 #ifdef DCPOMATIC_WINDOWS
546 void set_win32_console (bool c) {
547 maybe_set (_win32_console, c);
551 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
556 void set_cinemas_file (boost::filesystem::path file);
558 void set_show_hints_before_make_dcp (bool s) {
559 maybe_set (_show_hints_before_make_dcp, s);
562 void set_confirm_kdm_email (bool s) {
563 maybe_set (_confirm_kdm_email, s);
566 void set_preview_sound (bool s) {
567 maybe_set (_preview_sound, s, PREVIEW_SOUND);
570 void set_preview_sound_output (std::string o)
572 maybe_set (_preview_sound_output, o, PREVIEW_SOUND_OUTPUT);
575 void unset_preview_sound_output ()
577 if (!_preview_sound_output) {
581 _preview_sound_output = boost::none;
585 void set_kdm_container_name_format (dcp::NameFormat n) {
586 maybe_set (_kdm_container_name_format, n);
589 void set_kdm_filename_format (dcp::NameFormat n) {
590 maybe_set (_kdm_filename_format, n);
593 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
594 maybe_set (_dcp_metadata_filename_format, n);
597 void set_dcp_asset_filename_format (dcp::NameFormat n) {
598 maybe_set (_dcp_asset_filename_format, n);
601 void clear_history () {
606 void add_to_history (boost::filesystem::path p);
608 void set_jump_to_selected (bool j) {
609 maybe_set (_jump_to_selected, j);
612 void set_nagged (Nag nag, bool nagged) {
613 maybe_set (_nagged[nag], nagged);
616 void set_cover_sheet (std::string s) {
617 maybe_set (_cover_sheet, s);
620 void reset_cover_sheet ();
622 void changed (Property p = OTHER);
623 boost::signals2::signal<void (Property)> Changed;
624 /** Emitted if read() failed on an existing Config file. There is nothing
625 a listener can do about it: this is just for information.
627 static boost::signals2::signal<void ()> FailedToLoad;
630 void write_config () const;
631 void write_cinemas () const;
633 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
634 bool existing_template (std::string name) const;
635 std::list<std::string> templates () const;
636 boost::filesystem::path template_path (std::string name) const;
637 void rename_template (std::string old_name, std::string new_name) const;
638 void delete_template (std::string name) const;
640 static Config* instance ();
642 static void restore_defaults ();
643 static bool have_existing (std::string);
644 static boost::filesystem::path config_path ();
648 static boost::filesystem::path path (std::string file, bool create_directories = true);
650 void set_defaults ();
651 void set_kdm_email_to_default ();
652 void set_cover_sheet_to_default ();
653 void read_cinemas (cxml::Document const & f);
654 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
655 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
658 void maybe_set (T& member, T new_value, Property prop = OTHER) {
659 if (member == new_value) {
667 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
668 if (member && member.get() == new_value) {
675 /** number of threads which a master DoM should use for J2K encoding on the local machine */
676 int _master_encoding_threads;
677 /** number of threads which a server should use for J2K encoding on the local machine */
678 int _server_encoding_threads;
679 /** default directory to put new films in */
680 boost::optional<boost::filesystem::path> _default_directory;
681 /** base port number to use for J2K encoding servers;
682 * this port and the two above it will be used.
684 int _server_port_base;
685 /** true to broadcast on the `any' address to look for servers */
686 bool _use_any_servers;
687 /** J2K encoding servers that should definitely be used */
688 std::vector<std::string> _servers;
689 bool _only_servers_encode;
690 Protocol _tms_protocol;
691 /** The IP address of a TMS that we can copy DCPs to */
693 /** The path on a TMS that we should write DCPs to */
694 std::string _tms_path;
695 /** User name to log into the TMS with */
696 std::string _tms_user;
697 /** Password to log into the TMS with */
698 std::string _tms_password;
699 /** Our cinema sound processor */
700 CinemaSoundProcessor const * _cinema_sound_processor;
701 std::list<int> _allowed_dcp_frame_rates;
702 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
703 bool _allow_any_dcp_frame_rate;
704 /** Default ISDCF metadata for newly-created Films */
705 ISDCFMetadata _default_isdcf_metadata;
706 boost::optional<std::string> _language;
707 /** Default length of still image content (seconds) */
708 int _default_still_length;
709 Ratio const * _default_container;
710 Ratio const * _default_scale_to;
711 DCPContentType const * _default_dcp_content_type;
712 int _default_dcp_audio_channels;
713 std::string _dcp_issuer;
714 std::string _dcp_creator;
715 int _default_j2k_bandwidth;
716 int _default_audio_delay;
717 bool _default_interop;
718 /** Default directory to offer to write KDMs to; if it's not set,
719 the home directory will be offered.
721 boost::optional<boost::filesystem::path> _default_kdm_directory;
722 std::list<boost::shared_ptr<Cinema> > _cinemas;
723 std::string _mail_server;
725 std::string _mail_user;
726 std::string _mail_password;
727 std::string _kdm_subject;
728 std::string _kdm_from;
729 std::vector<std::string> _kdm_cc;
730 std::string _kdm_bcc;
731 std::string _kdm_email;
732 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
733 /** Chain used to decrypt KDMs; the leaf of this chain is the target
734 * certificate for making KDMs given to DCP-o-matic.
736 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
737 /** true to check for updates on startup */
738 bool _check_for_updates;
739 bool _check_for_test_updates;
740 /** maximum allowed J2K bandwidth in bits per second */
741 int _maximum_j2k_bandwidth;
743 bool _analyse_ebur128;
744 bool _automatic_audio_analysis;
745 #ifdef DCPOMATIC_WINDOWS
748 std::vector<boost::filesystem::path> _history;
749 boost::shared_ptr<DKDMGroup> _dkdms;
750 boost::filesystem::path _cinemas_file;
751 bool _show_hints_before_make_dcp;
752 bool _confirm_kdm_email;
753 dcp::NameFormat _kdm_filename_format;
754 dcp::NameFormat _kdm_container_name_format;
755 dcp::NameFormat _dcp_metadata_filename_format;
756 dcp::NameFormat _dcp_asset_filename_format;
757 bool _jump_to_selected;
758 bool _nagged[NAG_COUNT];
760 /** name of a specific sound output stream to use for preview, or empty to use the default */
761 boost::optional<std::string> _preview_sound_output;
762 std::string _cover_sheet;
764 /** Singleton instance, or 0 */
765 static Config* _instance;