2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/config.h
21 * @brief Class holding configuration.
24 #ifndef DCPOMATIC_CONFIG_H
25 #define DCPOMATIC_CONFIG_H
27 #include "isdcf_metadata.h"
28 #include "video_content.h"
29 #include <dcp/metadata.h>
30 #include <dcp/certificates.h>
31 #include <dcp/signer.h>
32 #include <boost/shared_ptr.hpp>
33 #include <boost/signals2.hpp>
34 #include <boost/filesystem.hpp>
37 class ServerDescription;
40 class CinemaSoundProcessor;
46 * @brief A singleton class holding configuration.
48 class Config : public boost::noncopyable
51 /** @return number of threads to use for J2K encoding on the local machine */
52 int num_local_encoding_threads () const {
53 return _num_local_encoding_threads;
56 boost::filesystem::path default_directory () const {
57 return _default_directory;
60 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
62 /** @return base port number to use for J2K encoding servers */
63 int server_port_base () const {
64 return _server_port_base;
67 void set_use_any_servers (bool u) {
72 bool use_any_servers () const {
73 return _use_any_servers;
76 /** @param s New list of servers */
77 void set_servers (std::vector<std::string> s) {
82 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
83 std::vector<std::string> servers () const {
87 /** @return The IP address of a TMS that we can copy DCPs to */
88 std::string tms_ip () const {
92 /** @return The path on a TMS that we should changed DCPs to */
93 std::string tms_path () const {
97 /** @return User name to log into the TMS with */
98 std::string tms_user () const {
102 /** @return Password to log into the TMS with */
103 std::string tms_password () const {
104 return _tms_password;
107 /** @return The cinema sound processor that we are using */
108 CinemaSoundProcessor const * cinema_sound_processor () const {
109 return _cinema_sound_processor;
112 std::list<boost::shared_ptr<Cinema> > cinemas () const {
116 std::list<int> allowed_dcp_frame_rates () const {
117 return _allowed_dcp_frame_rates;
120 bool allow_any_dcp_frame_rate () const {
121 return _allow_any_dcp_frame_rate;
124 ISDCFMetadata default_isdcf_metadata () const {
125 return _default_isdcf_metadata;
128 boost::optional<std::string> language () const {
132 int default_still_length () const {
133 return _default_still_length;
136 Ratio const * default_container () const {
137 return _default_container;
140 DCPContentType const * default_dcp_content_type () const {
141 return _default_dcp_content_type;
144 std::string dcp_issuer () const {
148 int default_j2k_bandwidth () const {
149 return _default_j2k_bandwidth;
152 int default_audio_delay () const {
153 return _default_audio_delay;
156 std::string mail_server () const {
160 int mail_port () const {
164 std::string mail_user () const {
168 std::string mail_password () const {
169 return _mail_password;
172 std::string kdm_subject () const {
176 std::string kdm_from () const {
180 std::string kdm_cc () const {
184 std::string kdm_bcc () const {
188 std::string kdm_email () const {
192 boost::shared_ptr<const dcp::Signer> signer () const {
196 dcp::Certificate decryption_certificate () const {
197 return _decryption_certificate;
200 std::string decryption_private_key () const {
201 return _decryption_private_key;
204 bool check_for_updates () const {
205 return _check_for_updates;
208 bool check_for_test_updates () const {
209 return _check_for_test_updates;
212 int maximum_j2k_bandwidth () const {
213 return _maximum_j2k_bandwidth;
216 int log_types () const {
220 #ifdef DCPOMATIC_WINDOWS
221 bool win32_console () const {
222 return _win32_console;
226 std::vector<boost::filesystem::path> history () const {
230 /** @param n New number of local encoding threads */
231 void set_num_local_encoding_threads (int n) {
232 maybe_set (_num_local_encoding_threads, n);
235 void set_default_directory (boost::filesystem::path d) {
236 maybe_set (_default_directory, d);
239 /** @param p New server port */
240 void set_server_port_base (int p) {
241 maybe_set (_server_port_base, p);
244 /** @param i IP address of a TMS that we can copy DCPs to */
245 void set_tms_ip (std::string i) {
246 maybe_set (_tms_ip, i);
249 /** @param p Path on a TMS that we should changed DCPs to */
250 void set_tms_path (std::string p) {
251 maybe_set (_tms_path, p);
254 /** @param u User name to log into the TMS with */
255 void set_tms_user (std::string u) {
256 maybe_set (_tms_user, u);
259 /** @param p Password to log into the TMS with */
260 void set_tms_password (std::string p) {
261 maybe_set (_tms_password, p);
264 void add_cinema (boost::shared_ptr<Cinema> c) {
265 _cinemas.push_back (c);
269 void remove_cinema (boost::shared_ptr<Cinema> c) {
274 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
275 maybe_set (_allowed_dcp_frame_rates, r);
278 void set_allow_any_dcp_frame_rate (bool a) {
279 maybe_set (_allow_any_dcp_frame_rate, a);
282 void set_default_isdcf_metadata (ISDCFMetadata d) {
283 maybe_set (_default_isdcf_metadata, d);
286 void set_language (std::string l) {
287 if (_language && _language.get() == l) {
294 void unset_language () {
299 _language = boost::none;
303 void set_default_still_length (int s) {
304 maybe_set (_default_still_length, s);
307 void set_default_container (Ratio const * c) {
308 maybe_set (_default_container, c);
311 void set_default_dcp_content_type (DCPContentType const * t) {
312 maybe_set (_default_dcp_content_type, t);
315 void set_dcp_issuer (std::string i) {
316 maybe_set (_dcp_issuer, i);
319 void set_default_j2k_bandwidth (int b) {
320 maybe_set (_default_j2k_bandwidth, b);
323 void set_default_audio_delay (int d) {
324 maybe_set (_default_audio_delay, d);
327 void set_mail_server (std::string s) {
328 maybe_set (_mail_server, s);
331 void set_mail_port (int p) {
332 maybe_set (_mail_port, p);
335 void set_mail_user (std::string u) {
336 maybe_set (_mail_user, u);
339 void set_mail_password (std::string p) {
340 maybe_set (_mail_password, p);
343 void set_kdm_subject (std::string s) {
344 maybe_set (_kdm_subject, s);
347 void set_kdm_from (std::string f) {
348 maybe_set (_kdm_from, f);
351 void set_kdm_cc (std::string f) {
352 maybe_set (_kdm_cc, f);
355 void set_kdm_bcc (std::string f) {
356 maybe_set (_kdm_bcc, f);
359 void set_kdm_email (std::string e) {
360 maybe_set (_kdm_email, e);
363 void reset_kdm_email ();
365 void set_signer (boost::shared_ptr<const dcp::Signer> s) {
366 maybe_set (_signer, s);
369 void set_decryption_certificate (dcp::Certificate c) {
370 maybe_set (_decryption_certificate, c);
373 void set_decryption_private_key (std::string k) {
374 maybe_set (_decryption_private_key, k);
377 void set_check_for_updates (bool c) {
378 maybe_set (_check_for_updates, c);
381 void set_check_for_test_updates (bool c) {
382 maybe_set (_check_for_test_updates, c);
385 void set_maximum_j2k_bandwidth (int b) {
386 maybe_set (_maximum_j2k_bandwidth, b);
389 void set_log_types (int t) {
390 maybe_set (_log_types, t);
393 #ifdef DCPOMATIC_WINDOWS
394 void set_win32_console (bool c) {
395 maybe_set (_win32_console, c);
399 void clear_history () {
404 void add_to_history (boost::filesystem::path p);
407 boost::signals2::signal<void ()> Changed;
411 static Config* instance ();
413 static void restore_defaults ();
417 boost::filesystem::path file () const;
419 void make_decryption_keys ();
420 void set_defaults ();
421 void set_kdm_email_to_default ();
424 void maybe_set (T& member, T new_value) {
425 if (member == new_value) {
432 /** number of threads to use for J2K encoding on the local machine */
433 int _num_local_encoding_threads;
434 /** default directory to put new films in */
435 boost::filesystem::path _default_directory;
436 /** base port number to use for J2K encoding servers;
437 * this port and the one above it will be used.
439 int _server_port_base;
440 /** true to broadcast on the `any' address to look for servers */
441 bool _use_any_servers;
442 /** J2K encoding servers that should definitely be used */
443 std::vector<std::string> _servers;
444 /** The IP address of a TMS that we can copy DCPs to */
446 /** The path on a TMS that we should write DCPs to */
447 std::string _tms_path;
448 /** User name to log into the TMS with */
449 std::string _tms_user;
450 /** Password to log into the TMS with */
451 std::string _tms_password;
452 /** Our cinema sound processor */
453 CinemaSoundProcessor const * _cinema_sound_processor;
454 std::list<int> _allowed_dcp_frame_rates;
455 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
456 bool _allow_any_dcp_frame_rate;
457 /** Default ISDCF metadata for newly-created Films */
458 ISDCFMetadata _default_isdcf_metadata;
459 boost::optional<std::string> _language;
460 /** Default length of still image content (seconds) */
461 int _default_still_length;
462 Ratio const * _default_container;
463 DCPContentType const * _default_dcp_content_type;
464 std::string _dcp_issuer;
465 int _default_j2k_bandwidth;
466 int _default_audio_delay;
467 std::list<boost::shared_ptr<Cinema> > _cinemas;
468 std::string _mail_server;
470 std::string _mail_user;
471 std::string _mail_password;
472 std::string _kdm_subject;
473 std::string _kdm_from;
475 std::string _kdm_bcc;
476 std::string _kdm_email;
477 boost::shared_ptr<const dcp::Signer> _signer;
478 dcp::Certificate _decryption_certificate;
479 std::string _decryption_private_key;
480 /** true to check for updates on startup */
481 bool _check_for_updates;
482 bool _check_for_test_updates;
483 /** maximum allowed J2K bandwidth in bits per second */
484 int _maximum_j2k_bandwidth;
486 #ifdef DCPOMATIC_WINDOWS
489 std::vector<boost::filesystem::path> _history;
491 /** Singleton instance, or 0 */
492 static Config* _instance;