2 Copyright (C) 2012-2018 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 bool default_upload_after_make_dcp () {
200 return _default_upload_after_make_dcp;
203 void set_default_kdm_directory (boost::filesystem::path d) {
204 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
207 _default_kdm_directory = d;
211 std::string mail_server () const {
215 int mail_port () const {
219 std::string mail_user () const {
223 std::string mail_password () const {
224 return _mail_password;
227 std::string kdm_subject () const {
231 std::string kdm_from () const {
235 std::vector<std::string> kdm_cc () const {
239 std::string kdm_bcc () const {
243 std::string kdm_email () const {
247 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
248 return _signer_chain;
251 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
252 return _decryption_chain;
255 bool check_for_updates () const {
256 return _check_for_updates;
259 bool check_for_test_updates () const {
260 return _check_for_test_updates;
263 int maximum_j2k_bandwidth () const {
264 return _maximum_j2k_bandwidth;
267 int log_types () const {
271 bool analyse_ebur128 () const {
272 return _analyse_ebur128;
275 bool automatic_audio_analysis () const {
276 return _automatic_audio_analysis;
279 #ifdef DCPOMATIC_WINDOWS
280 bool win32_console () const {
281 return _win32_console;
285 std::vector<boost::filesystem::path> history () const {
289 std::vector<boost::filesystem::path> player_history () const {
290 return _player_history;
293 boost::shared_ptr<DKDMGroup> dkdms () const {
297 boost::filesystem::path cinemas_file () const {
298 return _cinemas_file;
301 bool show_hints_before_make_dcp () const {
302 return _show_hints_before_make_dcp;
305 bool confirm_kdm_email () const {
306 return _confirm_kdm_email;
309 dcp::NameFormat kdm_container_name_format () const {
310 return _kdm_container_name_format;
313 dcp::NameFormat kdm_filename_format () const {
314 return _kdm_filename_format;
317 dcp::NameFormat dcp_metadata_filename_format () const {
318 return _dcp_metadata_filename_format;
321 dcp::NameFormat dcp_asset_filename_format () const {
322 return _dcp_asset_filename_format;
325 bool jump_to_selected () const {
326 return _jump_to_selected;
331 NAG_ENCRYPTED_METADATA,
332 NAG_REMAKE_DECRYPTION_CHAIN,
333 NAG_BAD_SIGNER_CHAIN,
337 bool nagged (Nag nag) const {
341 bool sound () const {
345 std::string cover_sheet () const {
349 boost::optional<std::string> sound_output () const {
350 return _sound_output;
353 boost::optional<boost::filesystem::path> last_player_load_directory () const {
354 return _last_player_load_directory;
363 boost::optional<KDMWriteType> last_kdm_write_type () const {
364 return _last_kdm_write_type;
372 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
373 return _last_dkdm_write_type;
376 int frames_in_memory_multiplier () const {
377 return _frames_in_memory_multiplier;
380 boost::optional<int> decode_reduction () const {
381 return _decode_reduction;
386 void set_master_encoding_threads (int n) {
387 maybe_set (_master_encoding_threads, n);
390 void set_server_encoding_threads (int n) {
391 maybe_set (_server_encoding_threads, n);
394 void set_default_directory (boost::filesystem::path d) {
395 if (_default_directory && *_default_directory == d) {
398 _default_directory = d;
402 /** @param p New server port */
403 void set_server_port_base (int p) {
404 maybe_set (_server_port_base, p);
407 void set_only_servers_encode (bool o) {
408 maybe_set (_only_servers_encode, o);
411 void set_tms_protocol (Protocol p) {
412 maybe_set (_tms_protocol, p);
415 /** @param i IP address of a TMS that we can copy DCPs to */
416 void set_tms_ip (std::string i) {
417 maybe_set (_tms_ip, i);
420 /** @param p Path on a TMS that we should changed DCPs to */
421 void set_tms_path (std::string p) {
422 maybe_set (_tms_path, p);
425 /** @param u User name to log into the TMS with */
426 void set_tms_user (std::string u) {
427 maybe_set (_tms_user, u);
430 /** @param p Password to log into the TMS with */
431 void set_tms_password (std::string p) {
432 maybe_set (_tms_password, p);
435 void add_cinema (boost::shared_ptr<Cinema> c) {
436 _cinemas.push_back (c);
440 void remove_cinema (boost::shared_ptr<Cinema> c) {
445 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
446 maybe_set (_allowed_dcp_frame_rates, r);
449 void set_allow_any_dcp_frame_rate (bool a) {
450 maybe_set (_allow_any_dcp_frame_rate, a);
453 void set_default_isdcf_metadata (ISDCFMetadata d) {
454 maybe_set (_default_isdcf_metadata, d);
457 void set_language (std::string l) {
458 if (_language && _language.get() == l) {
465 void unset_language () {
470 _language = boost::none;
474 void set_default_still_length (int s) {
475 maybe_set (_default_still_length, s);
478 void set_default_container (Ratio const * c) {
479 maybe_set (_default_container, c);
482 void set_default_scale_to (Ratio const * c) {
483 maybe_set (_default_scale_to, c);
486 void set_default_dcp_content_type (DCPContentType const * t) {
487 maybe_set (_default_dcp_content_type, t);
490 void set_default_dcp_audio_channels (int c) {
491 maybe_set (_default_dcp_audio_channels, c);
494 void set_dcp_issuer (std::string i) {
495 maybe_set (_dcp_issuer, i);
498 void set_dcp_creator (std::string c) {
499 maybe_set (_dcp_creator, c);
502 void set_default_j2k_bandwidth (int b) {
503 maybe_set (_default_j2k_bandwidth, b);
506 void set_default_audio_delay (int d) {
507 maybe_set (_default_audio_delay, d);
510 void set_default_interop (bool i) {
511 maybe_set (_default_interop, i);
514 void set_default_upload_after_make_dcp (bool u) {
515 maybe_set (_default_upload_after_make_dcp, u);
518 void set_mail_server (std::string s) {
519 maybe_set (_mail_server, s);
522 void set_mail_port (int p) {
523 maybe_set (_mail_port, p);
526 void set_mail_user (std::string u) {
527 maybe_set (_mail_user, u);
530 void set_mail_password (std::string p) {
531 maybe_set (_mail_password, p);
534 void set_kdm_subject (std::string s) {
535 maybe_set (_kdm_subject, s);
538 void set_kdm_from (std::string f) {
539 maybe_set (_kdm_from, f);
542 void set_kdm_cc (std::vector<std::string> f) {
543 maybe_set (_kdm_cc, f);
546 void set_kdm_bcc (std::string f) {
547 maybe_set (_kdm_bcc, f);
550 void set_kdm_email (std::string e) {
551 maybe_set (_kdm_email, e);
554 void reset_kdm_email ();
556 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
557 maybe_set (_signer_chain, s);
560 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
561 maybe_set (_decryption_chain, c);
564 void set_check_for_updates (bool c) {
565 maybe_set (_check_for_updates, c);
567 set_check_for_test_updates (false);
571 void set_check_for_test_updates (bool c) {
572 maybe_set (_check_for_test_updates, c);
575 void set_maximum_j2k_bandwidth (int b) {
576 maybe_set (_maximum_j2k_bandwidth, b);
579 void set_log_types (int t) {
580 maybe_set (_log_types, t);
583 void set_analyse_ebur128 (bool a) {
584 maybe_set (_analyse_ebur128, a);
587 void set_automatic_audio_analysis (bool a) {
588 maybe_set (_automatic_audio_analysis, a);
591 #ifdef DCPOMATIC_WINDOWS
592 void set_win32_console (bool c) {
593 maybe_set (_win32_console, c);
597 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
602 void set_cinemas_file (boost::filesystem::path file);
604 void set_show_hints_before_make_dcp (bool s) {
605 maybe_set (_show_hints_before_make_dcp, s);
608 void set_confirm_kdm_email (bool s) {
609 maybe_set (_confirm_kdm_email, s);
612 void set_sound (bool s) {
613 maybe_set (_sound, s, SOUND);
616 void set_sound_output (std::string o) {
617 maybe_set (_sound_output, o, SOUND_OUTPUT);
620 void set_last_player_load_directory (boost::filesystem::path d) {
621 maybe_set (_last_player_load_directory, d);
624 void set_last_kdm_write_type (KDMWriteType t) {
625 maybe_set (_last_kdm_write_type, t);
628 void set_last_dkdm_write_type (DKDMWriteType t) {
629 maybe_set (_last_dkdm_write_type, t);
632 void unset_sound_output () {
633 if (!_sound_output) {
637 _sound_output = boost::none;
641 void set_kdm_container_name_format (dcp::NameFormat n) {
642 maybe_set (_kdm_container_name_format, n);
645 void set_kdm_filename_format (dcp::NameFormat n) {
646 maybe_set (_kdm_filename_format, n);
649 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
650 maybe_set (_dcp_metadata_filename_format, n);
653 void set_dcp_asset_filename_format (dcp::NameFormat n) {
654 maybe_set (_dcp_asset_filename_format, n);
657 void set_frames_in_memory_multiplier (int m) {
658 maybe_set (_frames_in_memory_multiplier, m);
661 void set_decode_reduction (boost::optional<int> r) {
662 maybe_set (_decode_reduction, r);
665 void clear_history () {
670 void clear_player_history () {
671 _player_history.clear ();
675 void add_to_history (boost::filesystem::path p);
676 void add_to_player_history (boost::filesystem::path p);
678 void set_jump_to_selected (bool j) {
679 maybe_set (_jump_to_selected, j);
682 void set_nagged (Nag nag, bool nagged) {
683 maybe_set (_nagged[nag], nagged);
686 void set_cover_sheet (std::string s) {
687 maybe_set (_cover_sheet, s);
690 void reset_cover_sheet ();
692 void changed (Property p = OTHER);
693 boost::signals2::signal<void (Property)> Changed;
694 /** Emitted if read() failed on an existing Config file. There is nothing
695 a listener can do about it: this is just for information.
697 static boost::signals2::signal<void ()> FailedToLoad;
698 /** Emitted if read() issued a warning which the user might want to know about */
699 static boost::signals2::signal<void (std::string)> Warning;
700 /** Emitted if there is a bad certificate in the signer chain. Handler can call
701 * true to ask Config to re-create the chain.
703 static boost::signals2::signal<bool (void)> BadSignerChain;
706 void write_config () const;
707 void write_cinemas () const;
708 void link (boost::filesystem::path new_file) const;
709 void copy_and_link (boost::filesystem::path new_file) const;
711 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
712 bool existing_template (std::string name) const;
713 std::list<std::string> templates () const;
714 boost::filesystem::path template_path (std::string name) const;
715 void rename_template (std::string old_name, std::string new_name) const;
716 void delete_template (std::string name) const;
718 static Config* instance ();
720 static void restore_defaults ();
721 static bool have_existing (std::string);
722 static boost::filesystem::path config_file ();
724 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
725 static boost::optional<boost::filesystem::path> override_path;
729 static boost::filesystem::path path (std::string file, bool create_directories = true);
731 void set_defaults ();
732 void set_kdm_email_to_default ();
733 void set_cover_sheet_to_default ();
734 void read_cinemas (cxml::Document const & f);
735 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
736 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
737 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
741 void maybe_set (T& member, T new_value, Property prop = OTHER) {
742 if (member == new_value) {
750 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
751 if (member && member.get() == new_value) {
758 /** number of threads which a master DoM should use for J2K encoding on the local machine */
759 int _master_encoding_threads;
760 /** number of threads which a server should use for J2K encoding on the local machine */
761 int _server_encoding_threads;
762 /** default directory to put new films in */
763 boost::optional<boost::filesystem::path> _default_directory;
764 /** base port number to use for J2K encoding servers;
765 * this port and the two above it will be used.
767 int _server_port_base;
768 /** true to broadcast on the `any' address to look for servers */
769 bool _use_any_servers;
770 /** J2K encoding servers that should definitely be used */
771 std::vector<std::string> _servers;
772 bool _only_servers_encode;
773 Protocol _tms_protocol;
774 /** The IP address of a TMS that we can copy DCPs to */
776 /** The path on a TMS that we should write DCPs to */
777 std::string _tms_path;
778 /** User name to log into the TMS with */
779 std::string _tms_user;
780 /** Password to log into the TMS with */
781 std::string _tms_password;
782 /** Our cinema sound processor */
783 CinemaSoundProcessor const * _cinema_sound_processor;
784 std::list<int> _allowed_dcp_frame_rates;
785 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
786 bool _allow_any_dcp_frame_rate;
787 /** Default ISDCF metadata for newly-created Films */
788 ISDCFMetadata _default_isdcf_metadata;
789 boost::optional<std::string> _language;
790 /** Default length of still image content (seconds) */
791 int _default_still_length;
792 Ratio const * _default_container;
793 Ratio const * _default_scale_to;
794 DCPContentType const * _default_dcp_content_type;
795 int _default_dcp_audio_channels;
796 std::string _dcp_issuer;
797 std::string _dcp_creator;
798 int _default_j2k_bandwidth;
799 int _default_audio_delay;
800 bool _default_interop;
801 /** Default directory to offer to write KDMs to; if it's not set,
802 the home directory will be offered.
804 boost::optional<boost::filesystem::path> _default_kdm_directory;
805 bool _default_upload_after_make_dcp;
806 std::list<boost::shared_ptr<Cinema> > _cinemas;
807 std::string _mail_server;
809 std::string _mail_user;
810 std::string _mail_password;
811 std::string _kdm_subject;
812 std::string _kdm_from;
813 std::vector<std::string> _kdm_cc;
814 std::string _kdm_bcc;
815 std::string _kdm_email;
816 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
817 /** Chain used to decrypt KDMs; the leaf of this chain is the target
818 * certificate for making KDMs given to DCP-o-matic.
820 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
821 /** true to check for updates on startup */
822 bool _check_for_updates;
823 bool _check_for_test_updates;
824 /** maximum allowed J2K bandwidth in bits per second */
825 int _maximum_j2k_bandwidth;
827 bool _analyse_ebur128;
828 bool _automatic_audio_analysis;
829 #ifdef DCPOMATIC_WINDOWS
832 std::vector<boost::filesystem::path> _history;
833 std::vector<boost::filesystem::path> _player_history;
834 boost::shared_ptr<DKDMGroup> _dkdms;
835 boost::filesystem::path _cinemas_file;
836 bool _show_hints_before_make_dcp;
837 bool _confirm_kdm_email;
838 dcp::NameFormat _kdm_filename_format;
839 dcp::NameFormat _kdm_container_name_format;
840 dcp::NameFormat _dcp_metadata_filename_format;
841 dcp::NameFormat _dcp_asset_filename_format;
842 bool _jump_to_selected;
843 bool _nagged[NAG_COUNT];
845 /** name of a specific sound output stream to use, or empty to use the default */
846 boost::optional<std::string> _sound_output;
847 std::string _cover_sheet;
848 boost::optional<boost::filesystem::path> _last_player_load_directory;
849 boost::optional<KDMWriteType> _last_kdm_write_type;
850 boost::optional<DKDMWriteType> _last_dkdm_write_type;
851 int _frames_in_memory_multiplier;
852 boost::optional<int> _decode_reduction;
854 static int const _current_version;
856 /** Singleton instance, or 0 */
857 static Config* _instance;