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 bool allow_any_container () const {
152 return _allow_any_container;
155 ISDCFMetadata default_isdcf_metadata () const {
156 return _default_isdcf_metadata;
159 boost::optional<std::string> language () const {
163 int default_still_length () const {
164 return _default_still_length;
167 Ratio const * default_container () const {
168 return _default_container;
171 Ratio const * default_scale_to () const {
172 return _default_scale_to;
175 DCPContentType const * default_dcp_content_type () const {
176 return _default_dcp_content_type;
179 int default_dcp_audio_channels () const {
180 return _default_dcp_audio_channels;
183 std::string dcp_issuer () const {
187 std::string dcp_creator () const {
191 int default_j2k_bandwidth () const {
192 return _default_j2k_bandwidth;
195 int default_audio_delay () const {
196 return _default_audio_delay;
199 bool default_interop () const {
200 return _default_interop;
203 bool default_upload_after_make_dcp () {
204 return _default_upload_after_make_dcp;
207 void set_default_kdm_directory (boost::filesystem::path d) {
208 if (_default_kdm_directory && _default_kdm_directory.get() == d) {
211 _default_kdm_directory = d;
215 std::string mail_server () const {
219 int mail_port () const {
223 std::string mail_user () const {
227 std::string mail_password () const {
228 return _mail_password;
231 std::string kdm_subject () const {
235 std::string kdm_from () const {
239 std::vector<std::string> kdm_cc () const {
243 std::string kdm_bcc () const {
247 std::string kdm_email () const {
251 std::string notification_subject () const {
252 return _notification_subject;
255 std::string notification_from () const {
256 return _notification_from;
259 std::string notification_to () const {
260 return _notification_to;
263 std::vector<std::string> notification_cc () const {
264 return _notification_cc;
267 std::string notification_bcc () const {
268 return _notification_bcc;
271 std::string notification_email () const {
272 return _notification_email;
275 boost::shared_ptr<const dcp::CertificateChain> signer_chain () const {
276 return _signer_chain;
279 boost::shared_ptr<const dcp::CertificateChain> decryption_chain () const {
280 return _decryption_chain;
283 bool check_for_updates () const {
284 return _check_for_updates;
287 bool check_for_test_updates () const {
288 return _check_for_test_updates;
291 int maximum_j2k_bandwidth () const {
292 return _maximum_j2k_bandwidth;
295 int log_types () const {
299 bool analyse_ebur128 () const {
300 return _analyse_ebur128;
303 bool automatic_audio_analysis () const {
304 return _automatic_audio_analysis;
307 #ifdef DCPOMATIC_WINDOWS
308 bool win32_console () const {
309 return _win32_console;
313 std::vector<boost::filesystem::path> history () const {
317 std::vector<boost::filesystem::path> player_history () const {
318 return _player_history;
321 boost::shared_ptr<DKDMGroup> dkdms () const {
325 boost::filesystem::path cinemas_file () const {
326 return _cinemas_file;
329 bool show_hints_before_make_dcp () const {
330 return _show_hints_before_make_dcp;
333 bool confirm_kdm_email () const {
334 return _confirm_kdm_email;
337 dcp::NameFormat kdm_container_name_format () const {
338 return _kdm_container_name_format;
341 dcp::NameFormat kdm_filename_format () const {
342 return _kdm_filename_format;
345 dcp::NameFormat dcp_metadata_filename_format () const {
346 return _dcp_metadata_filename_format;
349 dcp::NameFormat dcp_asset_filename_format () const {
350 return _dcp_asset_filename_format;
353 bool jump_to_selected () const {
354 return _jump_to_selected;
359 NAG_ENCRYPTED_METADATA,
360 NAG_REMAKE_DECRYPTION_CHAIN,
361 NAG_BAD_SIGNER_CHAIN,
365 bool nagged (Nag nag) const {
369 bool sound () const {
373 std::string cover_sheet () const {
377 boost::optional<std::string> sound_output () const {
378 return _sound_output;
381 boost::optional<boost::filesystem::path> last_player_load_directory () const {
382 return _last_player_load_directory;
391 boost::optional<KDMWriteType> last_kdm_write_type () const {
392 return _last_kdm_write_type;
400 boost::optional<DKDMWriteType> last_dkdm_write_type () const {
401 return _last_dkdm_write_type;
404 int frames_in_memory_multiplier () const {
405 return _frames_in_memory_multiplier;
408 boost::optional<int> decode_reduction () const {
409 return _decode_reduction;
412 bool default_notify () const {
413 return _default_notify;
422 bool notification (Notification n) const {
423 return _notification[n];
428 void set_master_encoding_threads (int n) {
429 maybe_set (_master_encoding_threads, n);
432 void set_server_encoding_threads (int n) {
433 maybe_set (_server_encoding_threads, n);
436 void set_default_directory (boost::filesystem::path d) {
437 if (_default_directory && *_default_directory == d) {
440 _default_directory = d;
444 /** @param p New server port */
445 void set_server_port_base (int p) {
446 maybe_set (_server_port_base, p);
449 void set_only_servers_encode (bool o) {
450 maybe_set (_only_servers_encode, o);
453 void set_tms_protocol (Protocol p) {
454 maybe_set (_tms_protocol, p);
457 /** @param i IP address of a TMS that we can copy DCPs to */
458 void set_tms_ip (std::string i) {
459 maybe_set (_tms_ip, i);
462 /** @param p Path on a TMS that we should changed DCPs to */
463 void set_tms_path (std::string p) {
464 maybe_set (_tms_path, p);
467 /** @param u User name to log into the TMS with */
468 void set_tms_user (std::string u) {
469 maybe_set (_tms_user, u);
472 /** @param p Password to log into the TMS with */
473 void set_tms_password (std::string p) {
474 maybe_set (_tms_password, p);
477 void add_cinema (boost::shared_ptr<Cinema> c) {
478 _cinemas.push_back (c);
482 void remove_cinema (boost::shared_ptr<Cinema> c) {
487 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
488 maybe_set (_allowed_dcp_frame_rates, r);
491 void set_allow_any_dcp_frame_rate (bool a) {
492 maybe_set (_allow_any_dcp_frame_rate, a);
495 void set_allow_any_container (bool a) {
496 maybe_set (_allow_any_container, a);
499 void set_default_isdcf_metadata (ISDCFMetadata d) {
500 maybe_set (_default_isdcf_metadata, d);
503 void set_language (std::string l) {
504 if (_language && _language.get() == l) {
511 void unset_language () {
516 _language = boost::none;
520 void set_default_still_length (int s) {
521 maybe_set (_default_still_length, s);
524 void set_default_container (Ratio const * c) {
525 maybe_set (_default_container, c);
528 void set_default_scale_to (Ratio const * c) {
529 maybe_set (_default_scale_to, c);
532 void set_default_dcp_content_type (DCPContentType const * t) {
533 maybe_set (_default_dcp_content_type, t);
536 void set_default_dcp_audio_channels (int c) {
537 maybe_set (_default_dcp_audio_channels, c);
540 void set_dcp_issuer (std::string i) {
541 maybe_set (_dcp_issuer, i);
544 void set_dcp_creator (std::string c) {
545 maybe_set (_dcp_creator, c);
548 void set_default_j2k_bandwidth (int b) {
549 maybe_set (_default_j2k_bandwidth, b);
552 void set_default_audio_delay (int d) {
553 maybe_set (_default_audio_delay, d);
556 void set_default_interop (bool i) {
557 maybe_set (_default_interop, i);
560 void set_default_upload_after_make_dcp (bool u) {
561 maybe_set (_default_upload_after_make_dcp, u);
564 void set_mail_server (std::string s) {
565 maybe_set (_mail_server, s);
568 void set_mail_port (int p) {
569 maybe_set (_mail_port, p);
572 void set_mail_user (std::string u) {
573 maybe_set (_mail_user, u);
576 void set_mail_password (std::string p) {
577 maybe_set (_mail_password, p);
580 void set_kdm_subject (std::string s) {
581 maybe_set (_kdm_subject, s);
584 void set_kdm_from (std::string f) {
585 maybe_set (_kdm_from, f);
588 void set_kdm_cc (std::vector<std::string> f) {
589 maybe_set (_kdm_cc, f);
592 void set_kdm_bcc (std::string f) {
593 maybe_set (_kdm_bcc, f);
596 void set_kdm_email (std::string e) {
597 maybe_set (_kdm_email, e);
600 void reset_kdm_email ();
602 void set_notification_subject (std::string s) {
603 maybe_set (_notification_subject, s);
606 void set_notification_from (std::string f) {
607 maybe_set (_notification_from, f);
610 void set_notification_to (std::string t) {
611 maybe_set (_notification_to, t);
614 void set_notification_cc (std::vector<std::string> f) {
615 maybe_set (_notification_cc, f);
618 void set_notification_bcc (std::string f) {
619 maybe_set (_notification_bcc, f);
622 void set_notification_email (std::string e) {
623 maybe_set (_notification_email, e);
626 void reset_notification_email ();
628 void set_signer_chain (boost::shared_ptr<const dcp::CertificateChain> s) {
629 maybe_set (_signer_chain, s);
632 void set_decryption_chain (boost::shared_ptr<const dcp::CertificateChain> c) {
633 maybe_set (_decryption_chain, c);
636 void set_check_for_updates (bool c) {
637 maybe_set (_check_for_updates, c);
639 set_check_for_test_updates (false);
643 void set_check_for_test_updates (bool c) {
644 maybe_set (_check_for_test_updates, c);
647 void set_maximum_j2k_bandwidth (int b) {
648 maybe_set (_maximum_j2k_bandwidth, b);
651 void set_log_types (int t) {
652 maybe_set (_log_types, t);
655 void set_analyse_ebur128 (bool a) {
656 maybe_set (_analyse_ebur128, a);
659 void set_automatic_audio_analysis (bool a) {
660 maybe_set (_automatic_audio_analysis, a);
663 #ifdef DCPOMATIC_WINDOWS
664 void set_win32_console (bool c) {
665 maybe_set (_win32_console, c);
669 void set_dkdms (boost::shared_ptr<DKDMGroup> dkdms) {
674 void set_cinemas_file (boost::filesystem::path file);
676 void set_show_hints_before_make_dcp (bool s) {
677 maybe_set (_show_hints_before_make_dcp, s);
680 void set_confirm_kdm_email (bool s) {
681 maybe_set (_confirm_kdm_email, s);
684 void set_sound (bool s) {
685 maybe_set (_sound, s, SOUND);
688 void set_sound_output (std::string o) {
689 maybe_set (_sound_output, o, SOUND_OUTPUT);
692 void set_last_player_load_directory (boost::filesystem::path d) {
693 maybe_set (_last_player_load_directory, d);
696 void set_last_kdm_write_type (KDMWriteType t) {
697 maybe_set (_last_kdm_write_type, t);
700 void set_last_dkdm_write_type (DKDMWriteType t) {
701 maybe_set (_last_dkdm_write_type, t);
704 void unset_sound_output () {
705 if (!_sound_output) {
709 _sound_output = boost::none;
713 void set_kdm_container_name_format (dcp::NameFormat n) {
714 maybe_set (_kdm_container_name_format, n);
717 void set_kdm_filename_format (dcp::NameFormat n) {
718 maybe_set (_kdm_filename_format, n);
721 void set_dcp_metadata_filename_format (dcp::NameFormat n) {
722 maybe_set (_dcp_metadata_filename_format, n);
725 void set_dcp_asset_filename_format (dcp::NameFormat n) {
726 maybe_set (_dcp_asset_filename_format, n);
729 void set_frames_in_memory_multiplier (int m) {
730 maybe_set (_frames_in_memory_multiplier, m);
733 void set_decode_reduction (boost::optional<int> r) {
734 maybe_set (_decode_reduction, r);
737 void set_default_notify (bool n) {
738 maybe_set (_default_notify, n);
741 void clear_history () {
746 void clear_player_history () {
747 _player_history.clear ();
751 void add_to_history (boost::filesystem::path p);
752 void add_to_player_history (boost::filesystem::path p);
754 void set_jump_to_selected (bool j) {
755 maybe_set (_jump_to_selected, j);
758 void set_nagged (Nag nag, bool nagged) {
759 maybe_set (_nagged[nag], nagged);
762 void set_cover_sheet (std::string s) {
763 maybe_set (_cover_sheet, s);
766 void reset_cover_sheet ();
768 void set_notification (Notification n, bool v) {
769 maybe_set (_notification[n], v);
772 void changed (Property p = OTHER);
773 boost::signals2::signal<void (Property)> Changed;
774 /** Emitted if read() failed on an existing Config file. There is nothing
775 a listener can do about it: this is just for information.
777 static boost::signals2::signal<void ()> FailedToLoad;
778 /** Emitted if read() issued a warning which the user might want to know about */
779 static boost::signals2::signal<void (std::string)> Warning;
780 /** Emitted if there is a bad certificate in the signer chain. Handler can call
781 * true to ask Config to re-create the chain.
783 static boost::signals2::signal<bool (void)> BadSignerChain;
786 void write_config () const;
787 void write_cinemas () const;
788 void link (boost::filesystem::path new_file) const;
789 void copy_and_link (boost::filesystem::path new_file) const;
791 void save_template (boost::shared_ptr<const Film> film, std::string name) const;
792 bool existing_template (std::string name) const;
793 std::list<std::string> templates () const;
794 boost::filesystem::path template_path (std::string name) const;
795 void rename_template (std::string old_name, std::string new_name) const;
796 void delete_template (std::string name) const;
798 static Config* instance ();
800 static void restore_defaults ();
801 static bool have_existing (std::string);
802 static boost::filesystem::path config_file ();
804 /** If set, this overrides the standard path (in home, Library, AppData or wherever) for config.xml and cinemas.xml */
805 static boost::optional<boost::filesystem::path> override_path;
809 static boost::filesystem::path path (std::string file, bool create_directories = true);
811 void set_defaults ();
812 void set_kdm_email_to_default ();
813 void set_notification_email_to_default ();
814 void set_cover_sheet_to_default ();
815 void read_cinemas (cxml::Document const & f);
816 boost::shared_ptr<dcp::CertificateChain> create_certificate_chain ();
817 boost::filesystem::path directory_or (boost::optional<boost::filesystem::path> dir, boost::filesystem::path a) const;
818 void add_to_history_internal (std::vector<boost::filesystem::path>& h, boost::filesystem::path p);
822 void maybe_set (T& member, T new_value, Property prop = OTHER) {
823 if (member == new_value) {
831 void maybe_set (boost::optional<T>& member, T new_value, Property prop = OTHER) {
832 if (member && member.get() == new_value) {
839 /** number of threads which a master DoM should use for J2K encoding on the local machine */
840 int _master_encoding_threads;
841 /** number of threads which a server should use for J2K encoding on the local machine */
842 int _server_encoding_threads;
843 /** default directory to put new films in */
844 boost::optional<boost::filesystem::path> _default_directory;
845 /** base port number to use for J2K encoding servers;
846 * this port and the two above it will be used.
848 int _server_port_base;
849 /** true to broadcast on the `any' address to look for servers */
850 bool _use_any_servers;
851 /** J2K encoding servers that should definitely be used */
852 std::vector<std::string> _servers;
853 bool _only_servers_encode;
854 Protocol _tms_protocol;
855 /** The IP address of a TMS that we can copy DCPs to */
857 /** The path on a TMS that we should write DCPs to */
858 std::string _tms_path;
859 /** User name to log into the TMS with */
860 std::string _tms_user;
861 /** Password to log into the TMS with */
862 std::string _tms_password;
863 /** Our cinema sound processor */
864 CinemaSoundProcessor const * _cinema_sound_processor;
865 std::list<int> _allowed_dcp_frame_rates;
866 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
867 bool _allow_any_dcp_frame_rate;
868 /** Allow any container ratio, not just the standard ones. GDC SX-2001 will not play Flat
869 DCPs at 25fps but will play 16:9, so this is very useful for some users.
870 https://www.dcpomatic.com/forum/viewtopic.php?f=2&t=1119&p=4468
872 bool _allow_any_container;
873 /** Default ISDCF metadata for newly-created Films */
874 ISDCFMetadata _default_isdcf_metadata;
875 boost::optional<std::string> _language;
876 /** Default length of still image content (seconds) */
877 int _default_still_length;
878 Ratio const * _default_container;
879 Ratio const * _default_scale_to;
880 DCPContentType const * _default_dcp_content_type;
881 int _default_dcp_audio_channels;
882 std::string _dcp_issuer;
883 std::string _dcp_creator;
884 int _default_j2k_bandwidth;
885 int _default_audio_delay;
886 bool _default_interop;
887 /** Default directory to offer to write KDMs to; if it's not set,
888 the home directory will be offered.
890 boost::optional<boost::filesystem::path> _default_kdm_directory;
891 bool _default_upload_after_make_dcp;
892 std::list<boost::shared_ptr<Cinema> > _cinemas;
893 std::string _mail_server;
895 std::string _mail_user;
896 std::string _mail_password;
897 std::string _kdm_subject;
898 std::string _kdm_from;
899 std::vector<std::string> _kdm_cc;
900 std::string _kdm_bcc;
901 std::string _kdm_email;
902 std::string _notification_subject;
903 std::string _notification_from;
904 std::string _notification_to;
905 std::vector<std::string> _notification_cc;
906 std::string _notification_bcc;
907 std::string _notification_email;
908 boost::shared_ptr<const dcp::CertificateChain> _signer_chain;
909 /** Chain used to decrypt KDMs; the leaf of this chain is the target
910 * certificate for making KDMs given to DCP-o-matic.
912 boost::shared_ptr<const dcp::CertificateChain> _decryption_chain;
913 /** true to check for updates on startup */
914 bool _check_for_updates;
915 bool _check_for_test_updates;
916 /** maximum allowed J2K bandwidth in bits per second */
917 int _maximum_j2k_bandwidth;
919 bool _analyse_ebur128;
920 bool _automatic_audio_analysis;
921 #ifdef DCPOMATIC_WINDOWS
924 std::vector<boost::filesystem::path> _history;
925 std::vector<boost::filesystem::path> _player_history;
926 boost::shared_ptr<DKDMGroup> _dkdms;
927 boost::filesystem::path _cinemas_file;
928 bool _show_hints_before_make_dcp;
929 bool _confirm_kdm_email;
930 dcp::NameFormat _kdm_filename_format;
931 dcp::NameFormat _kdm_container_name_format;
932 dcp::NameFormat _dcp_metadata_filename_format;
933 dcp::NameFormat _dcp_asset_filename_format;
934 bool _jump_to_selected;
935 bool _nagged[NAG_COUNT];
937 /** name of a specific sound output stream to use, or empty to use the default */
938 boost::optional<std::string> _sound_output;
939 std::string _cover_sheet;
940 boost::optional<boost::filesystem::path> _last_player_load_directory;
941 boost::optional<KDMWriteType> _last_kdm_write_type;
942 boost::optional<DKDMWriteType> _last_dkdm_write_type;
943 int _frames_in_memory_multiplier;
944 boost::optional<int> _decode_reduction;
945 bool _default_notify;
946 bool _notification[NOTIFICATION_COUNT];
948 static int const _current_version;
950 /** Singleton instance, or 0 */
951 static Config* _instance;