2 Copyright (C) 2012-2014 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
28 #include <boost/shared_ptr.hpp>
29 #include <boost/signals2.hpp>
30 #include <boost/filesystem.hpp>
31 #include <dcp/metadata.h>
32 #include <dcp/certificates.h>
33 #include <dcp/signer.h>
34 #include "isdcf_metadata.h"
35 #include "colour_conversion.h"
36 #include "video_content.h"
38 class ServerDescription;
41 class CinemaSoundProcessor;
47 * @brief A singleton class holding configuration.
49 class Config : public boost::noncopyable
53 /** @return number of threads to use for J2K encoding on the local machine */
54 int num_local_encoding_threads () const {
55 return _num_local_encoding_threads;
58 boost::filesystem::path default_directory () const {
59 return _default_directory;
62 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
64 /** @return base port number to use for J2K encoding servers */
65 int server_port_base () const {
66 return _server_port_base;
69 void set_use_any_servers (bool u) {
74 bool use_any_servers () const {
75 return _use_any_servers;
78 /** @param s New list of servers */
79 void set_servers (std::vector<std::string> s) {
84 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
85 std::vector<std::string> servers () const {
89 /** @return The IP address of a TMS that we can copy DCPs to */
90 std::string tms_ip () const {
94 /** @return The path on a TMS that we should changed DCPs to */
95 std::string tms_path () const {
99 /** @return User name to log into the TMS with */
100 std::string tms_user () const {
104 /** @return Password to log into the TMS with */
105 std::string tms_password () const {
106 return _tms_password;
109 /** @return The cinema sound processor that we are using */
110 CinemaSoundProcessor const * cinema_sound_processor () const {
111 return _cinema_sound_processor;
114 std::list<boost::shared_ptr<Cinema> > cinemas () const {
118 std::list<int> allowed_dcp_frame_rates () const {
119 return _allowed_dcp_frame_rates;
122 bool allow_any_dcp_frame_rate () const {
123 return _allow_any_dcp_frame_rate;
126 ISDCFMetadata default_isdcf_metadata () const {
127 return _default_isdcf_metadata;
130 boost::optional<std::string> language () const {
134 int default_still_length () const {
135 return _default_still_length;
138 VideoContentScale default_scale () const {
139 return _default_scale;
142 Ratio const * default_container () const {
143 return _default_container;
146 DCPContentType const * default_dcp_content_type () const {
147 return _default_dcp_content_type;
150 std::string dcp_issuer () const {
154 int default_j2k_bandwidth () const {
155 return _default_j2k_bandwidth;
158 int default_audio_delay () const {
159 return _default_audio_delay;
162 std::vector<PresetColourConversion> colour_conversions () const {
163 return _colour_conversions;
166 std::string mail_server () const {
170 std::string mail_user () const {
174 std::string mail_password () const {
175 return _mail_password;
178 std::string kdm_subject () const {
182 std::string kdm_from () const {
186 std::string kdm_cc () const {
190 std::string kdm_bcc () const {
194 std::string kdm_email () const {
198 boost::shared_ptr<const dcp::Signer> signer () const {
202 dcp::Certificate decryption_certificate () const {
203 return _decryption_certificate;
206 std::string decryption_private_key () const {
207 return _decryption_private_key;
210 bool check_for_updates () const {
211 return _check_for_updates;
214 bool check_for_test_updates () const {
215 return _check_for_test_updates;
218 int maximum_j2k_bandwidth () const {
219 return _maximum_j2k_bandwidth;
222 int log_types () const {
226 #ifdef DCPOMATIC_WINDOWS
227 bool win32_console () const {
228 return _win32_console;
232 std::vector<boost::filesystem::path> history () const {
236 /** @param n New number of local encoding threads */
237 void set_num_local_encoding_threads (int n) {
238 _num_local_encoding_threads = n;
242 void set_default_directory (boost::filesystem::path d) {
243 _default_directory = d;
247 /** @param p New server port */
248 void set_server_port_base (int p) {
249 _server_port_base = p;
253 /** @param i IP address of a TMS that we can copy DCPs to */
254 void set_tms_ip (std::string i) {
259 /** @param p Path on a TMS that we should changed DCPs to */
260 void set_tms_path (std::string p) {
265 /** @param u User name to log into the TMS with */
266 void set_tms_user (std::string u) {
271 /** @param p Password to log into the TMS with */
272 void set_tms_password (std::string p) {
277 void add_cinema (boost::shared_ptr<Cinema> c) {
278 _cinemas.push_back (c);
282 void remove_cinema (boost::shared_ptr<Cinema> c) {
287 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
288 _allowed_dcp_frame_rates = r;
292 void set_allow_any_dcp_frame_rate (bool a) {
293 _allow_any_dcp_frame_rate = a;
297 void set_default_isdcf_metadata (ISDCFMetadata d) {
298 _default_isdcf_metadata = d;
302 void set_language (std::string l) {
307 void unset_language () {
308 _language = boost::none;
312 void set_default_still_length (int s) {
313 _default_still_length = s;
317 void set_default_scale (VideoContentScale s) {
322 void set_default_container (Ratio const * c) {
323 _default_container = c;
327 void set_default_dcp_content_type (DCPContentType const * t) {
328 _default_dcp_content_type = t;
332 void set_dcp_issuer (std::string i) {
337 void set_default_j2k_bandwidth (int b) {
338 _default_j2k_bandwidth = b;
342 void set_default_audio_delay (int d) {
343 _default_audio_delay = d;
347 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
348 _colour_conversions = c;
352 void set_mail_server (std::string s) {
357 void set_mail_user (std::string u) {
362 void set_mail_password (std::string p) {
367 void set_kdm_subject (std::string s) {
372 void set_kdm_from (std::string f) {
377 void set_kdm_cc (std::string f) {
382 void set_kdm_bcc (std::string f) {
387 void set_kdm_email (std::string e) {
392 void reset_kdm_email ();
394 void set_signer (boost::shared_ptr<const dcp::Signer> s) {
399 void set_decryption_certificate (dcp::Certificate c) {
400 _decryption_certificate = c;
404 void set_decryption_private_key (std::string k) {
405 _decryption_private_key = k;
409 void set_check_for_updates (bool c) {
410 _check_for_updates = c;
414 void set_check_for_test_updates (bool c) {
415 _check_for_test_updates = c;
419 void set_maximum_j2k_bandwidth (int b) {
420 _maximum_j2k_bandwidth = b;
424 void set_log_types (int t) {
429 #ifdef DCPOMATIC_WINDOWS
430 void set_win32_console (bool c) {
436 void clear_history () {
441 void add_to_history (boost::filesystem::path p);
444 boost::signals2::signal<void ()> Changed;
446 static Config* instance ();
451 boost::filesystem::path file () const;
454 void make_decryption_keys ();
456 /** number of threads to use for J2K encoding on the local machine */
457 int _num_local_encoding_threads;
458 /** default directory to put new films in */
459 boost::filesystem::path _default_directory;
460 /** base port number to use for J2K encoding servers;
461 * this port and the one above it will be used.
463 int _server_port_base;
464 /** true to broadcast on the `any' address to look for servers */
465 bool _use_any_servers;
466 /** J2K encoding servers that should definitely be used */
467 std::vector<std::string> _servers;
468 /** The IP address of a TMS that we can copy DCPs to */
470 /** The path on a TMS that we should write DCPs to */
471 std::string _tms_path;
472 /** User name to log into the TMS with */
473 std::string _tms_user;
474 /** Password to log into the TMS with */
475 std::string _tms_password;
476 /** Our cinema sound processor */
477 CinemaSoundProcessor const * _cinema_sound_processor;
478 std::list<int> _allowed_dcp_frame_rates;
479 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
480 bool _allow_any_dcp_frame_rate;
481 /** Default ISDCF metadata for newly-created Films */
482 ISDCFMetadata _default_isdcf_metadata;
483 boost::optional<std::string> _language;
484 int _default_still_length;
485 VideoContentScale _default_scale;
486 Ratio const * _default_container;
487 DCPContentType const * _default_dcp_content_type;
488 std::string _dcp_issuer;
489 int _default_j2k_bandwidth;
490 int _default_audio_delay;
491 std::vector<PresetColourConversion> _colour_conversions;
492 std::list<boost::shared_ptr<Cinema> > _cinemas;
493 std::string _mail_server;
494 std::string _mail_user;
495 std::string _mail_password;
496 std::string _kdm_subject;
497 std::string _kdm_from;
499 std::string _kdm_bcc;
500 std::string _kdm_email;
501 boost::shared_ptr<const dcp::Signer> _signer;
502 dcp::Certificate _decryption_certificate;
503 std::string _decryption_private_key;
504 /** true to check for updates on startup */
505 bool _check_for_updates;
506 bool _check_for_test_updates;
507 /** maximum allowed J2K bandwidth in bits per second */
508 int _maximum_j2k_bandwidth;
510 #ifdef DCPOMATIC_WINDOWS
513 std::vector<boost::filesystem::path> _history;
515 /** Singleton instance, or 0 */
516 static Config* _instance;