Remove unused Processor::process_begin; some docs.
[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 Screen;
33 class Scaler;
34 class Filter;
35 class SoundProcessor;
36
37 /** @class Config
38  *  @brief A singleton class holding configuration.
39  */
40 class Config
41 {
42 public:
43
44         /** @return number of threads to use for J2K encoding on the local machine */
45         int num_local_encoding_threads () const {
46                 return _num_local_encoding_threads;
47         }
48
49         std::string default_directory () const {
50                 return _default_directory;
51         }
52
53         std::string default_directory_or (std::string a) const;
54
55         /** @return port to use for J2K encoding servers */
56         int server_port () const {
57                 return _server_port;
58         }
59
60         /** @return index of colour LUT to use when converting RGB to XYZ.
61          *  0: sRGB
62          *  1: Rec 709
63          */
64         int colour_lut_index () const {
65                 return _colour_lut_index;
66         }
67
68         /** @return bandwidth for J2K files in bits per second */
69         int j2k_bandwidth () const {
70                 return _j2k_bandwidth;
71         }
72
73         /** @return J2K encoding servers to use */
74         std::vector<ServerDescription*> servers () const {
75                 return _servers;
76         }
77
78         std::vector<boost::shared_ptr<Screen> > screens () const {
79                 return _screens;
80         }
81
82         Scaler const * reference_scaler () const {
83                 return _reference_scaler;
84         }
85
86         std::vector<Filter const *> reference_filters () const {
87                 return _reference_filters;
88         }
89
90         /** @return The IP address of a TMS that we can copy DCPs to */
91         std::string tms_ip () const {
92                 return _tms_ip;
93         }
94
95         /** @return The path on a TMS that we should write DCPs to */
96         std::string tms_path () const {
97                 return _tms_path;
98         }
99
100         /** @return User name to log into the TMS with */
101         std::string tms_user () const {
102                 return _tms_user;
103         }
104
105         /** @return Password to log into the TMS with */
106         std::string tms_password () const {
107                 return _tms_password;
108         }
109
110         /** @return The sound processor that we are using */
111         SoundProcessor const * sound_processor () const {
112                 return _sound_processor;
113         }
114
115         /** @param n New number of local encoding threads */
116         void set_num_local_encoding_threads (int n) {
117                 _num_local_encoding_threads = n;
118                 Changed ();
119         }
120
121         void set_default_directory (std::string d) {
122                 _default_directory = d;
123                 Changed ();
124         }
125
126         /** @param p New server port */
127         void set_server_port (int p) {
128                 _server_port = p;
129                 Changed ();
130         }
131
132         /** @param i New colour LUT index */
133         void set_colour_lut_index (int i) {
134                 _colour_lut_index = i;
135                 Changed ();
136         }
137
138         /** @param b New J2K bandwidth */
139         void set_j2k_bandwidth (int b) {
140                 _j2k_bandwidth = b;
141                 Changed ();
142         }
143
144         /** @param s New list of servers */
145         void set_servers (std::vector<ServerDescription*> s) {
146                 _servers = s;
147                 Changed ();
148         }
149
150         void set_screens (std::vector<boost::shared_ptr<Screen> > s) {
151                 _screens = s;
152                 Changed ();
153         }
154
155         void set_reference_scaler (Scaler const * s) {
156                 _reference_scaler = s;
157                 Changed ();
158         }
159         
160         void set_reference_filters (std::vector<Filter const *> const & f) {
161                 _reference_filters = f;
162                 Changed ();
163         }
164
165         /** @param i IP address of a TMS that we can copy DCPs to */
166         void set_tms_ip (std::string i) {
167                 _tms_ip = i;
168                 Changed ();
169         }
170
171         /** @param p Path on a TMS that we should write DCPs to */
172         void set_tms_path (std::string p) {
173                 _tms_path = p;
174                 Changed ();
175         }
176
177         /** @param u User name to log into the TMS with */
178         void set_tms_user (std::string u) {
179                 _tms_user = u;
180                 Changed ();
181         }
182
183         /** @param p Password to log into the TMS with */
184         void set_tms_password (std::string p) {
185                 _tms_password = p;
186                 Changed ();
187         }
188         
189         void write () const;
190
191         boost::signals2::signal<void()> Changed;
192
193         static Config* instance ();
194
195 private:
196         Config ();
197         std::string file () const;
198
199         /** number of threads to use for J2K encoding on the local machine */
200         int _num_local_encoding_threads;
201         /** default directory to put new films in */
202         std::string _default_directory;
203         /** port to use for J2K encoding servers */
204         int _server_port;
205         /** index of colour LUT to use when converting RGB to XYZ
206          *  (see colour_lut_index ())
207          */
208         int _colour_lut_index;
209         /** bandwidth for J2K files in bits per second */
210         int _j2k_bandwidth;
211
212         /** J2K encoding servers to use */
213         std::vector<ServerDescription *> _servers;
214         /** Screen definitions */
215         std::vector<boost::shared_ptr<Screen> > _screens;
216         /** Scaler to use for the "A" part of A/B comparisons */
217         Scaler const * _reference_scaler;
218         /** Filters to use for the "A" part of A/B comparisons */
219         std::vector<Filter const *> _reference_filters;
220         /** The IP address of a TMS that we can copy DCPs to */
221         std::string _tms_ip;
222         /** The path on a TMS that we should write DCPs to */
223         std::string _tms_path;
224         /** User name to log into the TMS with */
225         std::string _tms_user;
226         /** Password to log into the TMS with */
227         std::string _tms_password;
228         /** Our sound processor */
229         SoundProcessor const * _sound_processor;
230
231         /** Singleton instance, or 0 */
232         static Config* _instance;
233 };
234
235 #endif