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 "isdcf_metadata.h"
33 #include "colour_conversion.h"
35 class ServerDescription;
44 * @brief A singleton class holding configuration.
46 class Config : public boost::noncopyable
50 /** @return number of threads to use for J2K encoding on the local machine */
51 int num_local_encoding_threads () const {
52 return _num_local_encoding_threads;
55 boost::filesystem::path default_directory () const {
56 return _default_directory;
59 boost::filesystem::path default_directory_or (boost::filesystem::path a) const;
61 /** @return base port number to use for J2K encoding servers */
62 int server_port_base () const {
63 return _server_port_base;
66 void set_use_any_servers (bool u) {
71 bool use_any_servers () const {
72 return _use_any_servers;
75 /** @param s New list of servers */
76 void set_servers (std::vector<std::string> s) {
81 /** @return Host names / IP addresses of J2K encoding servers that should definitely be used */
82 std::vector<std::string> servers () const {
86 /** @return The IP address of a TMS that we can copy DCPs to */
87 std::string tms_ip () const {
91 /** @return The path on a TMS that we should changed DCPs to */
92 std::string tms_path () const {
96 /** @return User name to log into the TMS with */
97 std::string tms_user () const {
101 /** @return Password to log into the TMS with */
102 std::string tms_password () const {
103 return _tms_password;
106 /** @return The sound processor that we are using */
107 SoundProcessor const * sound_processor () const {
108 return _sound_processor;
111 std::list<boost::shared_ptr<Cinema> > cinemas () const {
115 std::list<int> allowed_dcp_frame_rates () const {
116 return _allowed_dcp_frame_rates;
119 bool allow_any_dcp_frame_rate () const {
120 return _allow_any_dcp_frame_rate;
123 ISDCFMetadata default_isdcf_metadata () const {
124 return _default_isdcf_metadata;
127 boost::optional<std::string> language () const {
131 int default_still_length () const {
132 return _default_still_length;
135 Ratio const * default_container () const {
136 return _default_container;
139 DCPContentType const * default_dcp_content_type () const {
140 return _default_dcp_content_type;
143 dcp::XMLMetadata dcp_metadata () const {
144 return _dcp_metadata;
147 int default_j2k_bandwidth () const {
148 return _default_j2k_bandwidth;
151 int default_audio_delay () const {
152 return _default_audio_delay;
155 std::vector<PresetColourConversion> colour_conversions () const {
156 return _colour_conversions;
159 std::string mail_server () const {
163 std::string mail_user () const {
167 std::string mail_password () const {
168 return _mail_password;
171 std::string kdm_from () const {
175 std::string kdm_email () const {
179 bool check_for_updates () const {
180 return _check_for_updates;
183 bool check_for_test_updates () const {
184 return _check_for_test_updates;
187 int maximum_j2k_bandwidth () const {
188 return _maximum_j2k_bandwidth;
191 int log_types () const {
195 /** @param n New number of local encoding threads */
196 void set_num_local_encoding_threads (int n) {
197 _num_local_encoding_threads = n;
201 void set_default_directory (boost::filesystem::path d) {
202 _default_directory = d;
206 /** @param p New server port */
207 void set_server_port_base (int p) {
208 _server_port_base = p;
212 /** @param i IP address of a TMS that we can copy DCPs to */
213 void set_tms_ip (std::string i) {
218 /** @param p Path on a TMS that we should changed DCPs to */
219 void set_tms_path (std::string p) {
224 /** @param u User name to log into the TMS with */
225 void set_tms_user (std::string u) {
230 /** @param p Password to log into the TMS with */
231 void set_tms_password (std::string p) {
236 void add_cinema (boost::shared_ptr<Cinema> c) {
237 _cinemas.push_back (c);
241 void remove_cinema (boost::shared_ptr<Cinema> c) {
246 void set_allowed_dcp_frame_rates (std::list<int> const & r) {
247 _allowed_dcp_frame_rates = r;
251 void set_allow_any_dcp_frame_rate (bool a) {
252 _allow_any_dcp_frame_rate = a;
256 void set_default_isdcf_metadata (ISDCFMetadata d) {
257 _default_isdcf_metadata = d;
261 void set_language (std::string l) {
266 void unset_language () {
267 _language = boost::none;
271 void set_default_still_length (int s) {
272 _default_still_length = s;
276 void set_default_container (Ratio const * c) {
277 _default_container = c;
281 void set_default_dcp_content_type (DCPContentType const * t) {
282 _default_dcp_content_type = t;
286 void set_dcp_metadata (dcp::XMLMetadata m) {
291 void set_default_j2k_bandwidth (int b) {
292 _default_j2k_bandwidth = b;
296 void set_default_audio_delay (int d) {
297 _default_audio_delay = d;
301 void set_colour_conversions (std::vector<PresetColourConversion> const & c) {
302 _colour_conversions = c;
306 void set_mail_server (std::string s) {
311 void set_mail_user (std::string u) {
316 void set_mail_password (std::string p) {
321 void set_kdm_from (std::string f) {
326 void set_kdm_email (std::string e) {
331 void set_check_for_updates (bool c) {
332 _check_for_updates = c;
336 void set_check_for_test_updates (bool c) {
337 _check_for_test_updates = c;
341 void set_maximum_j2k_bandwidth (int b) {
342 _maximum_j2k_bandwidth = b;
346 void set_log_types (int t) {
351 boost::filesystem::path signer_chain_directory () const;
354 boost::signals2::signal<void ()> Changed;
356 static Config* instance ();
361 boost::filesystem::path file (bool) const;
363 void read_old_metadata ();
366 /** number of threads to use for J2K encoding on the local machine */
367 int _num_local_encoding_threads;
368 /** default directory to put new films in */
369 boost::filesystem::path _default_directory;
370 /** base port number to use for J2K encoding servers;
371 * this port and the one above it will be used.
373 int _server_port_base;
374 /** true to broadcast on the `any' address to look for servers */
375 bool _use_any_servers;
376 /** J2K encoding servers that should definitely be used */
377 std::vector<std::string> _servers;
378 /** The IP address of a TMS that we can copy DCPs to */
380 /** The path on a TMS that we should write DCPs to */
381 std::string _tms_path;
382 /** User name to log into the TMS with */
383 std::string _tms_user;
384 /** Password to log into the TMS with */
385 std::string _tms_password;
386 /** Our sound processor */
387 SoundProcessor const * _sound_processor;
388 std::list<int> _allowed_dcp_frame_rates;
389 /** Allow any video frame rate for the DCP; if true, overrides _allowed_dcp_frame_rates */
390 bool _allow_any_dcp_frame_rate;
391 /** Default ISDCF metadata for newly-created Films */
392 ISDCFMetadata _default_isdcf_metadata;
393 boost::optional<std::string> _language;
394 int _default_still_length;
395 Ratio const * _default_container;
396 DCPContentType const * _default_dcp_content_type;
397 dcp::XMLMetadata _dcp_metadata;
398 int _default_j2k_bandwidth;
399 int _default_audio_delay;
400 std::vector<PresetColourConversion> _colour_conversions;
401 std::list<boost::shared_ptr<Cinema> > _cinemas;
402 std::string _mail_server;
403 std::string _mail_user;
404 std::string _mail_password;
405 std::string _kdm_from;
406 std::string _kdm_email;
407 /** true to check for updates on startup */
408 bool _check_for_updates;
409 bool _check_for_test_updates;
410 /** maximum allowed J2K bandwidth in bits per second */
411 int _maximum_j2k_bandwidth;
414 /** Singleton instance, or 0 */
415 static Config* _instance;