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 std::string notification_subject () const {
248 return _notification_subject;
251 std::string notification_from () const {
252 return _notification_from;
255 std::string notification_to () const {
256 return _notification_to;
259 std::vector<std::string> notification_cc () const {
260 return _notification_cc;
263 std::string notification_bcc () const {
264 return _notification_bcc;
267 std::string notification_email () const {
268 return _notification_email;
271 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
272 return _signer_chain;
275 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
276 return _decryption_chain;
279 bool check_for_updates () const {
280 return _check_for_updates;
283 bool check_for_test_updates () const {
284 return _check_for_test_updates;
287 int maximum_j2k_bandwidth () const {
288 return _maximum_j2k_bandwidth;
291 int log_types () const {
295 bool analyse_ebur128 () const {
296 return _analyse_ebur128;
299 bool automatic_audio_analysis () const {
300 return _automatic_audio_analysis;
303 #ifdef DCPOMATIC_WINDOWS
304 bool win32_console () const {
305 return _win32_console;
309 std::vector<boost::filesystem::path> history () const {
313 std::vector<boost::filesystem::path> player_history () const {
314 return _player_history;
317 boost::shared_ptr<DKDMGroup> dkdms () const {
321 boost::filesystem::path cinemas_file () const {
322 return _cinemas_file;
325 bool show_hints_before_make_dcp () const {
326 return _show_hints_before_make_dcp;
329 bool confirm_kdm_email () const {
330 return _confirm_kdm_email;
333 dcp::NameFormat kdm_container_name_format () const {
334 return _kdm_container_name_format;
337 dcp::NameFormat kdm_filename_format () const {
338 return _kdm_filename_format;
341 dcp::NameFormat dcp_metadata_filename_format () const {
342 return _dcp_metadata_filename_format;
345 dcp::NameFormat dcp_asset_filename_format () const {
346 return _dcp_asset_filename_format;
349 bool jump_to_selected () const {
350 return _jump_to_selected;
355 NAG_ENCRYPTED_METADATA,
356 NAG_REMAKE_DECRYPTION_CHAIN,
357 NAG_BAD_SIGNER_CHAIN,
361 bool nagged (Nag nag) const {
365 bool sound () const {
369 std::string cover_sheet () const {
373 boost::optional<std::string> sound_output () const {
374 return _sound_output;
377 boost::optional<boost::filesystem::path> last_player_load_directory () const {
378 return _last_player_load_directory;
387 boost::optional<KDMWriteType> last_kdm_write_type () const {
388 return _last_kdm_write_type;
396 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
397 return _last_dkdm_write_type;
400 int frames_in_memory_multiplier () const {
401 return _frames_in_memory_multiplier;
404 boost::optional<int> decode_reduction () const {
405 return _decode_reduction;
408 bool default_notify () const {
409 return _default_notify;
418 bool notification (Notification n) const {
419 return _notification[n];
424 void set_master_encoding_threads (int n) {
425 maybe_set (_master_encoding_threads, n);
428 void set_server_encoding_threads (int n) {
429 maybe_set (_server_encoding_threads, n);
432 void set_default_directory (boost::filesystem::path d) {
433 if (_default_directory && *_default_directory == d) {
436 _default_directory = d;
440 /** @param p New server port */
441 void set_server_port_base (int p) {
442 maybe_set (_server_port_base, p);
445 void set_only_servers_encode (bool o) {
446 maybe_set (_only_servers_encode, o);
449 void set_tms_protocol (Protocol p) {
450 maybe_set (_tms_protocol, p);
453 /** @param i IP address of a TMS that we can copy DCPs to */
454 void set_tms_ip (std::string i) {
455 maybe_set (_tms_ip, i);
458 /** @param p Path on a TMS that we should changed DCPs to */
459 void set_tms_path (std::string p) {
460 maybe_set (_tms_path, p);
463 /** @param u User name to log into the TMS with */
464 void set_tms_user (std::string u) {
465 maybe_set (_tms_user, u);
468 /** @param p Password to log into the TMS with */
469 void set_tms_password (std::string p) {
470 maybe_set (_tms_password, p);
473 void add_cinema (boost::shared_ptr<Cinema> c) {
474 _cinemas.push_back (c);
478 void remove_cinema (boost::shared_ptr<Cinema> c) {
483 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
484 maybe_set (_allowed_dcp_frame_rates, r);
487 void set_allow_any_dcp_frame_rate (bool a) {
488 maybe_set (_allow_any_dcp_frame_rate, a);
491 void set_default_isdcf_metadata (ISDCFMetadata d) {
492 maybe_set (_default_isdcf_metadata, d);
495 void set_language (std::string l) {
496 if (_language && _language.get() == l) {
503 void unset_language () {
508 _language = boost::none;
512 void set_default_still_length (int s) {
513 maybe_set (_default_still_length, s);
516 void set_default_container (Ratio const * c) {
517 maybe_set (_default_container, c);
520 void set_default_scale_to (Ratio const * c) {
521 maybe_set (_default_scale_to, c);
524 void set_default_dcp_content_type (DCPContentType const * t) {
525 maybe_set (_default_dcp_content_type, t);
528 void set_default_dcp_audio_channels (int c) {
529 maybe_set (_default_dcp_audio_channels, c);
532 void set_dcp_issuer (std::string i) {
533 maybe_set (_dcp_issuer, i);
536 void set_dcp_creator (std::string c) {
537 maybe_set (_dcp_creator, c);
540 void set_default_j2k_bandwidth (int b) {
541 maybe_set (_default_j2k_bandwidth, b);
544 void set_default_audio_delay (int d) {
545 maybe_set (_default_audio_delay, d);
548 void set_default_interop (bool i) {
549 maybe_set (_default_interop, i);
552 void set_default_upload_after_make_dcp (bool u) {
553 maybe_set (_default_upload_after_make_dcp, u);
556 void set_mail_server (std::string s) {
557 maybe_set (_mail_server, s);
560 void set_mail_port (int p) {
561 maybe_set (_mail_port, p);
564 void set_mail_user (std::string u) {
565 maybe_set (_mail_user, u);
568 void set_mail_password (std::string p) {
569 maybe_set (_mail_password, p);
572 void set_kdm_subject (std::string s) {
573 maybe_set (_kdm_subject, s);
576 void set_kdm_from (std::string f) {
577 maybe_set (_kdm_from, f);
580 void set_kdm_cc (std::vector<std::string> f) {
581 maybe_set (_kdm_cc, f);
584 void set_kdm_bcc (std::string f) {
585 maybe_set (_kdm_bcc, f);
588 void set_kdm_email (std::string e) {
589 maybe_set (_kdm_email, e);
592 void reset_kdm_email ();
594 void set_notification_subject (std::string s) {
595 maybe_set (_notification_subject, s);
598 void set_notification_from (std::string f) {
599 maybe_set (_notification_from, f);
602 void set_notification_to (std::string t) {
603 maybe_set (_notification_to, t);
606 void set_notification_cc (std::vector<std::string> f) {
607 maybe_set (_notification_cc, f);
610 void set_notification_bcc (std::string f) {
611 maybe_set (_notification_bcc, f);
614 void set_notification_email (std::string e) {
615 maybe_set (_notification_email, e);
618 void reset_notification_email ();
620 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
621 maybe_set (_signer_chain, s);
624 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
625 maybe_set (_decryption_chain, c);
628 void set_check_for_updates (bool c) {
629 maybe_set (_check_for_updates, c);
631 set_check_for_test_updates (false);
635 void set_check_for_test_updates (bool c) {
636 maybe_set (_check_for_test_updates, c);
639 void set_maximum_j2k_bandwidth (int b) {
640 maybe_set (_maximum_j2k_bandwidth, b);
643 void set_log_types (int t) {
644 maybe_set (_log_types, t);
647 void set_analyse_ebur128 (bool a) {
648 maybe_set (_analyse_ebur128, a);
651 void set_automatic_audio_analysis (bool a) {
652 maybe_set (_automatic_audio_analysis, a);
655 #ifdef DCPOMATIC_WINDOWS
656 void set_win32_console (bool c) {
657 maybe_set (_win32_console, c);
661 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
666 void set_cinemas_file (boost::filesystem::path file);
668 void set_show_hints_before_make_dcp (bool s) {
669 maybe_set (_show_hints_before_make_dcp, s);
672 void set_confirm_kdm_email (bool s) {
673 maybe_set (_confirm_kdm_email, s);
676 void set_sound (bool s) {
677 maybe_set (_sound, s, SOUND);
680 void set_sound_output (std::string o) {
681 maybe_set (_sound_output, o, SOUND_OUTPUT);
684 void set_last_player_load_directory (boost::filesystem::path d) {
685 maybe_set (_last_player_load_directory, d);
688 void set_last_kdm_write_type (KDMWriteType t) {
689 maybe_set (_last_kdm_write_type, t);
692 void set_last_dkdm_write_type (DKDMWriteType t) {
693 maybe_set (_last_dkdm_write_type, t);
696 void unset_sound_output () {
697 if (!_sound_output) {
701 _sound_output = boost::none;
705 void set_kdm_container_name_format (dcp::NameFormat n) {
706 maybe_set (_kdm_container_name_format, n);
709 void set_kdm_filename_format (dcp::NameFormat n) {
710 maybe_set (_kdm_filename_format, n);
713 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
714 maybe_set (_dcp_metadata_filename_format, n);
717 void set_dcp_asset_filename_format (dcp::NameFormat n) {
718 maybe_set (_dcp_asset_filename_format, n);
721 void set_frames_in_memory_multiplier (int m) {
722 maybe_set (_frames_in_memory_multiplier, m);
725 void set_decode_reduction (boost::optional<int> r) {
726 maybe_set (_decode_reduction, r);
729 void set_default_notify (bool n) {
730 maybe_set (_default_notify, n);
733 void clear_history () {
738 void clear_player_history () {
739 _player_history.clear ();
743 void add_to_history (boost::filesystem::path p);
744 void add_to_player_history (boost::filesystem::path p);
746 void set_jump_to_selected (bool j) {
747 maybe_set (_jump_to_selected, j);
750 void set_nagged (Nag nag, bool nagged) {
751 maybe_set (_nagged[nag], nagged);
754 void set_cover_sheet (std::string s) {
755 maybe_set (_cover_sheet, s);
758 void reset_cover_sheet ();
760 void set_notification (Notification n, bool v) {
761 maybe_set (_notification[n], v);
764 void changed (Property p = OTHER);
765 boost::signals2::signal<void (Property)> Changed;
766 /** Emitted if read() failed on an existing Config file. There is nothing
767 a listener can do about it: this is just for information.
769 static boost::signals2::signal<void ()> FailedToLoad;
770 /** Emitted if read() issued a warning which the user might want to know about */
771 static boost::signals2::signal<void (std::string)> Warning;
772 /** Emitted if there is a bad certificate in the signer chain. Handler can call
773 * true to ask Config to re-create the chain.
775 static boost::signals2::signal<bool (void)> BadSignerChain;
778 void write_config () const;
779 void write_cinemas () const;
780 void link (boost::filesystem::path new_file) const;
781 void copy_and_link (boost::filesystem::path new_file) const;
783 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
784 bool existing_template (std::string name) const;
785 std::list<std::string> templates () const;
786 boost::filesystem::path template_path (std::string name) const;
787 void rename_template (std::string old_name, std::string new_name) const;
788 void delete_template (std::string name) const;
790 static Config* instance ();
792 static void restore_defaults ();
793 static bool have_existing (std::string);
794 static boost::filesystem::path config_file ();
796 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
797 static boost::optional<boost::filesystem::path> override_path;
801 static boost::filesystem::path path (std::string file, bool create_directories = true);
803 void set_defaults ();
804 void set_kdm_email_to_default ();
805 void set_notification_email_to_default ();
806 void set_cover_sheet_to_default ();
807 void read_cinemas (cxml::Document const & f);
808 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
809 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
810 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
814 void maybe_set (T& member, T new_value, Property prop = OTHER) {
815 if (member == new_value) {
823 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
824 if (member && member.get() == new_value) {
831 /** number of threads which a master DoM should use for J2K encoding on the local machine */
832 int _master_encoding_threads;
833 /** number of threads which a server should use for J2K encoding on the local machine */
834 int _server_encoding_threads;
835 /** default directory to put new films in */
836 boost::optional<boost::filesystem::path> _default_directory;
837 /** base port number to use for J2K encoding servers;
838 * this port and the two above it will be used.
840 int _server_port_base;
841 /** true to broadcast on the `any' address to look for servers */
842 bool _use_any_servers;
843 /** J2K encoding servers that should definitely be used */
844 std::vector<std::string> _servers;
845 bool _only_servers_encode;
846 Protocol _tms_protocol;
847 /** The IP address of a TMS that we can copy DCPs to */
849 /** The path on a TMS that we should write DCPs to */
850 std::string _tms_path;
851 /** User name to log into the TMS with */
852 std::string _tms_user;
853 /** Password to log into the TMS with */
854 std::string _tms_password;
855 /** Our cinema sound processor */
856 CinemaSoundProcessor const * _cinema_sound_processor;
857 std::list<int> _allowed_dcp_frame_rates;
858 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
859 bool _allow_any_dcp_frame_rate;
860 /** Default ISDCF metadata for newly-created Films */
861 ISDCFMetadata _default_isdcf_metadata;
862 boost::optional<std::string> _language;
863 /** Default length of still image content (seconds) */
864 int _default_still_length;
865 Ratio const * _default_container;
866 Ratio const * _default_scale_to;
867 DCPContentType const * _default_dcp_content_type;
868 int _default_dcp_audio_channels;
869 std::string _dcp_issuer;
870 std::string _dcp_creator;
871 int _default_j2k_bandwidth;
872 int _default_audio_delay;
873 bool _default_interop;
874 /** Default directory to offer to write KDMs to; if it's not set,
875 the home directory will be offered.
877 boost::optional<boost::filesystem::path> _default_kdm_directory;
878 bool _default_upload_after_make_dcp;
879 std::list<boost::shared_ptr<Cinema> > _cinemas;
880 std::string _mail_server;
882 std::string _mail_user;
883 std::string _mail_password;
884 std::string _kdm_subject;
885 std::string _kdm_from;
886 std::vector<std::string> _kdm_cc;
887 std::string _kdm_bcc;
888 std::string _kdm_email;
889 std::string _notification_subject;
890 std::string _notification_from;
891 std::string _notification_to;
892 std::vector<std::string> _notification_cc;
893 std::string _notification_bcc;
894 std::string _notification_email;
895 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
896 /** Chain used to decrypt KDMs; the leaf of this chain is the target
897 * certificate for making KDMs given to DCP-o-matic.
899 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
900 /** true to check for updates on startup */
901 bool _check_for_updates;
902 bool _check_for_test_updates;
903 /** maximum allowed J2K bandwidth in bits per second */
904 int _maximum_j2k_bandwidth;
906 bool _analyse_ebur128;
907 bool _automatic_audio_analysis;
908 #ifdef DCPOMATIC_WINDOWS
911 std::vector<boost::filesystem::path> _history;
912 std::vector<boost::filesystem::path> _player_history;
913 boost::shared_ptr<DKDMGroup> _dkdms;
914 boost::filesystem::path _cinemas_file;
915 bool _show_hints_before_make_dcp;
916 bool _confirm_kdm_email;
917 dcp::NameFormat _kdm_filename_format;
918 dcp::NameFormat _kdm_container_name_format;
919 dcp::NameFormat _dcp_metadata_filename_format;
920 dcp::NameFormat _dcp_asset_filename_format;
921 bool _jump_to_selected;
922 bool _nagged[NAG_COUNT];
924 /** name of a specific sound output stream to use, or empty to use the default */
925 boost::optional<std::string> _sound_output;
926 std::string _cover_sheet;
927 boost::optional<boost::filesystem::path> _last_player_load_directory;
928 boost::optional<KDMWriteType> _last_kdm_write_type;
929 boost::optional<DKDMWriteType> _last_dkdm_write_type;
930 int _frames_in_memory_multiplier;
931 boost::optional<int> _decode_reduction;
932 bool _default_notify;
933 bool _notification[NOTIFICATION_COUNT];
935 static int const _current_version;
937 /** Singleton instance, or 0 */
938 static Config* _instance;