Add some tests and hopefully clarify the DCPFrameRate class.
[dcpomatic.git] / src / lib / config.h
1 /*
2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
3
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.
8
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.
13
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.
17
18 */
19
20 /** @file src/config.h
21  *  @brief Class holding configuration.
22  */
23
24 #ifndef DVDOMATIC_CONFIG_H
25 #define DVDOMATIC_CONFIG_H
26
27 #include <vector>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/signals2.hpp>
30
31 class ServerDescription;
32 class Scaler;
33 class Filter;
34 class SoundProcessor;
35
36 /** @class Config
37  *  @brief A singleton class holding configuration.
38  */
39 class Config
40 {
41 public:
42
43         /** @return number of threads to use for J2K encoding on the local machine */
44         int num_local_encoding_threads () const {
45                 return _num_local_encoding_threads;
46         }
47
48         std::string default_directory () const {
49                 return _default_directory;
50         }
51
52         std::string default_directory_or (std::string a) const;
53
54         /** @return port to use for J2K encoding servers */
55         int server_port () const {
56                 return _server_port;
57         }
58
59         /** @return J2K encoding servers to use */
60         std::vector<ServerDescription*> servers () const {
61                 return _servers;
62         }
63
64         Scaler const * reference_scaler () const {
65                 return _reference_scaler;
66         }
67
68         std::vector<Filter const *> reference_filters () const {
69                 return _reference_filters;
70         }
71
72         /** @return The IP address of a TMS that we can copy DCPs to */
73         std::string tms_ip () const {
74                 return _tms_ip;
75         }
76
77         /** @return The path on a TMS that we should write DCPs to */
78         std::string tms_path () const {
79                 return _tms_path;
80         }
81
82         /** @return User name to log into the TMS with */
83         std::string tms_user () const {
84                 return _tms_user;
85         }
86
87         /** @return Password to log into the TMS with */
88         std::string tms_password () const {
89                 return _tms_password;
90         }
91
92         /** @return The sound processor that we are using */
93         SoundProcessor const * sound_processor () const {
94                 return _sound_processor;
95         }
96
97         std::list<int> allowed_dcp_frame_rates () const {
98                 return _allowed_dcp_frame_rates;
99         }
100         
101         /** @param n New number of local encoding threads */
102         void set_num_local_encoding_threads (int n) {
103                 _num_local_encoding_threads = n;
104         }
105
106         void set_default_directory (std::string d) {
107                 _default_directory = d;
108         }
109
110         /** @param p New server port */
111         void set_server_port (int p) {
112                 _server_port = p;
113         }
114
115         /** @param s New list of servers */
116         void set_servers (std::vector<ServerDescription*> s) {
117                 _servers = s;
118         }
119
120         void set_reference_scaler (Scaler const * s) {
121                 _reference_scaler = s;
122         }
123         
124         void set_reference_filters (std::vector<Filter const *> const & f) {
125                 _reference_filters = f;
126         }
127
128         /** @param i IP address of a TMS that we can copy DCPs to */
129         void set_tms_ip (std::string i) {
130                 _tms_ip = i;
131         }
132
133         /** @param p Path on a TMS that we should write DCPs to */
134         void set_tms_path (std::string p) {
135                 _tms_path = p;
136         }
137
138         /** @param u User name to log into the TMS with */
139         void set_tms_user (std::string u) {
140                 _tms_user = u;
141         }
142
143         /** @param p Password to log into the TMS with */
144         void set_tms_password (std::string p) {
145                 _tms_password = p;
146         }
147
148         void set_allowed_dcp_frame_rates (std::list<int> const & r) {
149                 _allowed_dcp_frame_rates = r;
150         }
151
152         void write () const;
153
154         static Config* instance ();
155
156 private:
157         Config ();
158         std::string file () const;
159
160         /** number of threads to use for J2K encoding on the local machine */
161         int _num_local_encoding_threads;
162         /** default directory to put new films in */
163         std::string _default_directory;
164         /** port to use for J2K encoding servers */
165         int _server_port;
166
167         /** J2K encoding servers to use */
168         std::vector<ServerDescription *> _servers;
169         /** Scaler to use for the "A" part of A/B comparisons */
170         Scaler const * _reference_scaler;
171         /** Filters to use for the "A" part of A/B comparisons */
172         std::vector<Filter const *> _reference_filters;
173         /** The IP address of a TMS that we can copy DCPs to */
174         std::string _tms_ip;
175         /** The path on a TMS that we should write DCPs to */
176         std::string _tms_path;
177         /** User name to log into the TMS with */
178         std::string _tms_user;
179         /** Password to log into the TMS with */
180         std::string _tms_password;
181         /** Our sound processor */
182         SoundProcessor const * _sound_processor;
183         std::list<int> _allowed_dcp_frame_rates;
184
185         /** Singleton instance, or 0 */
186         static Config* _instance;
187 };
188
189 #endif