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 "isdcf_metadata.h"
32 #include "colour_conversion.h"
34 #include "video_content.h"
36 class ServerDescription;
45 * @brief A singleton class holding configuration.
47 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 sound processor that we are using */
108 SoundProcessor const * sound_processor () const {
109 return _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 VideoContentScale default_scale () const {
137 return _default_scale;
140 Ratio const * default_container () const {
141 return _default_container;
144 DCPContentType const * default_dcp_content_type () const {
145 return _default_dcp_content_type;
148 std::string dcp_issuer () const {
152 int default_j2k_bandwidth () const {
153 return _default_j2k_bandwidth;
156 int default_audio_delay () const {
157 return _default_audio_delay;
160 std::vector<PresetColourConversion> colour_conversions () const {
161 return _colour_conversions;
164 std::string mail_server () const {
168 std::string mail_user () const {
172 std::string mail_password () const {
173 return _mail_password;
176 std::string kdm_subject () const {
180 std::string kdm_from () const {
184 std::string kdm_cc () const {
188 std::string kdm_bcc () const {
192 std::string kdm_email () const {
196 bool check_for_updates () const {
197 return _check_for_updates;
200 bool check_for_test_updates () const {
201 return _check_for_test_updates;
204 int maximum_j2k_bandwidth () const {
205 return _maximum_j2k_bandwidth;
208 int log_types () const {
212 std::vector<boost::filesystem::path> history () const {
216 /** @param n New number of local encoding threads */
217 void set_num_local_encoding_threads (int n) {
218 _num_local_encoding_threads = n;
222 void set_default_directory (boost::filesystem::path d) {
223 _default_directory = d;
227 /** @param p New server port */
228 void set_server_port_base (int p) {
229 _server_port_base = p;
233 /** @param i IP address of a TMS that we can copy DCPs to */
234 void set_tms_ip (std::string i) {
239 /** @param p Path on a TMS that we should changed DCPs to */
240 void set_tms_path (std::string p) {
245 /** @param u User name to log into the TMS with */
246 void set_tms_user (std::string u) {
251 /** @param p Password to log into the TMS with */
252 void set_tms_password (std::string p) {
257 void add_cinema (boost::shared_ptr<Cinema> c) {
258 _cinemas.push_back (c);
262 void remove_cinema (boost::shared_ptr<Cinema> c) {
267 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
268 _allowed_dcp_frame_rates = r;
272 void set_allow_any_dcp_frame_rate (bool a) {
273 _allow_any_dcp_frame_rate = a;
277 void set_default_isdcf_metadata (ISDCFMetadata d) {
278 _default_isdcf_metadata = d;
282 void set_language (std::string l) {
287 void unset_language () {
288 _language = boost::none;
292 void set_default_still_length (int s) {
293 _default_still_length = s;
297 void set_default_scale (VideoContentScale s) {
302 void set_default_container (Ratio const * c) {
303 _default_container = c;
307 void set_default_dcp_content_type (DCPContentType const * t) {
308 _default_dcp_content_type = t;
312 void set_dcp_issuer (std::string i) {
317 void set_default_j2k_bandwidth (int b) {
318 _default_j2k_bandwidth = b;
322 void set_default_audio_delay (int d) {
323 _default_audio_delay = d;
327 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
328 _colour_conversions = c;
332 void set_mail_server (std::string s) {
337 void set_mail_user (std::string u) {
342 void set_mail_password (std::string p) {
347 void set_kdm_subject (std::string s) {
352 void set_kdm_from (std::string f) {
357 void set_kdm_cc (std::string f) {
362 void set_kdm_bcc (std::string f) {
367 void set_kdm_email (std::string e) {
372 void reset_kdm_email ();
374 void set_check_for_updates (bool c) {
375 _check_for_updates = c;
379 void set_check_for_test_updates (bool c) {
380 _check_for_test_updates = c;
384 void set_maximum_j2k_bandwidth (int b) {
385 _maximum_j2k_bandwidth = b;
389 void set_log_types (int t) {
394 void clear_history () {
399 void add_to_history (boost::filesystem::path p);
401 boost::filesystem::path signer_chain_directory () const;
404 boost::signals2::signal<void ()> Changed;
406 static Config* instance ();
411 boost::filesystem::path file (bool) const;
413 void read_old_metadata ();
416 /** number of threads to use for J2K encoding on the local machine */
417 int _num_local_encoding_threads;
418 /** default directory to put new films in */
419 boost::filesystem::path _default_directory;
420 /** base port number to use for J2K encoding servers;
421 * this port and the one above it will be used.
423 int _server_port_base;
424 /** true to broadcast on the `any' address to look for servers */
425 bool _use_any_servers;
426 /** J2K encoding servers that should definitely be used */
427 std::vector<std::string> _servers;
428 /** The IP address of a TMS that we can copy DCPs to */
430 /** The path on a TMS that we should write DCPs to */
431 std::string _tms_path;
432 /** User name to log into the TMS with */
433 std::string _tms_user;
434 /** Password to log into the TMS with */
435 std::string _tms_password;
436 /** Our sound processor */
437 SoundProcessor const * _sound_processor;
438 std::list<int> _allowed_dcp_frame_rates;
439 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
440 bool _allow_any_dcp_frame_rate;
441 /** Default ISDCF metadata for newly-created Films */
442 ISDCFMetadata _default_isdcf_metadata;
443 boost::optional<std::string> _language;
444 int _default_still_length;
445 VideoContentScale _default_scale;
446 Ratio const * _default_container;
447 DCPContentType const * _default_dcp_content_type;
448 std::string _dcp_issuer;
449 int _default_j2k_bandwidth;
450 int _default_audio_delay;
451 std::vector<PresetColourConversion> _colour_conversions;
452 std::list<boost::shared_ptr<Cinema> > _cinemas;
453 std::string _mail_server;
454 std::string _mail_user;
455 std::string _mail_password;
456 std::string _kdm_subject;
457 std::string _kdm_from;
459 std::string _kdm_bcc;
460 std::string _kdm_email;
461 /** true to check for updates on startup */
462 bool _check_for_updates;
463 bool _check_for_test_updates;
464 /** maximum allowed J2K bandwidth in bits per second */
465 int _maximum_j2k_bandwidth;
467 std::vector<boost::filesystem::path> _history;
469 /** Singleton instance, or 0 */
470 static Config* _instance;