e1946002c1b834d8dc02a964ace0b5a9bda450c6
[ardour.git] / gtk2_ardour / option_editor.cc
1 /*
2     Copyright (C) 2001-2009 Paul Davis
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 #include <gtkmm/box.h>
21 #include <gtkmm/alignment.h>
22 #include "gtkmm2ext/utils.h"
23
24 #include "ardour/configuration.h"
25 #include "ardour/rc_configuration.h"
26 #include "ardour/utils.h"
27 #include "ardour/dB.h"
28
29 #include "option_editor.h"
30 #include "gui_thread.h"
31 #include "utils.h"
32 #include "i18n.h"
33
34 using namespace std;
35 using namespace Gtk;
36 using namespace Gtkmm2ext;
37 using namespace ARDOUR;
38
39 void
40 OptionEditorComponent::add_widget_to_page (OptionEditorPage* p, Gtk::Widget* w)
41 {
42         int const n = p->table.property_n_rows();
43         int m = n + 1;
44         if (!_note.empty ()) {
45                 ++m;
46         }
47
48         p->table.resize (m, 3);
49         p->table.attach (*w, 1, 3, n, n + 1, FILL | EXPAND);
50
51         maybe_add_note (p, n + 1);
52 }
53
54 void
55 OptionEditorComponent::add_widgets_to_page (OptionEditorPage* p, Gtk::Widget* wa, Gtk::Widget* wb)
56 {
57         int const n = p->table.property_n_rows();
58         int m = n + 1;
59         if (!_note.empty ()) {
60                 ++m;
61         }
62         
63         p->table.resize (m, 3);
64         p->table.attach (*wa, 1, 2, n, n + 1, FILL);
65         p->table.attach (*wb, 2, 3, n, n + 1, FILL | EXPAND);
66         
67         maybe_add_note (p, n + 1);
68 }
69
70 void
71 OptionEditorComponent::maybe_add_note (OptionEditorPage* p, int n)
72 {
73         if (!_note.empty ()) {
74                 Gtk::Label* l = manage (new Gtk::Label (string_compose (X_("<i>%1</i>"), _note)));
75                 l->set_use_markup (true);
76                 p->table.attach (*l, 1, 3, n, n + 1, FILL | EXPAND);
77         }
78 }
79
80 void
81 OptionEditorComponent::set_note (string const & n)
82 {
83         _note = n;
84 }
85
86 OptionEditorHeading::OptionEditorHeading (string const & h)
87 {
88         std::stringstream s;
89         s << "<b>" << h << "</b>";
90         _label = manage (left_aligned_label (s.str()));
91         _label->set_use_markup (true);
92 }
93
94 void
95 OptionEditorHeading::add_to_page (OptionEditorPage* p)
96 {
97         int const n = p->table.property_n_rows();
98         p->table.resize (n + 2, 3);
99
100         p->table.attach (*manage (new Label ("")), 0, 3, n, n + 1, FILL | EXPAND);
101         p->table.attach (*_label, 0, 3, n + 1, n + 2, FILL | EXPAND);
102 }
103
104 void
105 OptionEditorBox::add_to_page (OptionEditorPage* p)
106 {
107         add_widget_to_page (p, _box);
108 }
109
110 BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
111         : Option (i, n),
112           _get (g),
113           _set (s)
114 {
115         _button = manage (new CheckButton (n));
116         _button->set_active (_get ());
117         _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
118 }
119
120 void
121 BoolOption::add_to_page (OptionEditorPage* p)
122 {
123         add_widget_to_page (p, _button);
124 }
125
126 void
127 BoolOption::set_state_from_config ()
128 {
129         _button->set_active (_get ());
130 }
131
132 void
133 BoolOption::toggled ()
134 {
135         _set (_button->get_active ());
136 }
137
138 EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
139         : Option (i, n),
140           _get (g),
141           _set (s)
142 {
143         _label = manage (left_aligned_label (n + ":"));
144         _entry = manage (new Entry);
145         _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
146 }
147
148 void
149 EntryOption::add_to_page (OptionEditorPage* p)
150 {
151         add_widgets_to_page (p, _label, _entry);
152 }
153
154 void
155 EntryOption::set_state_from_config ()
156 {
157         _entry->set_text (_get ());
158 }
159
160 void
161 EntryOption::activated ()
162 {
163         _set (_entry->get_text ());
164 }
165
166 FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
167         : Option (i, n)
168         , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
169         , _get (g)
170         , _set (s)
171 {
172         _pix = ::get_icon (X_("fader_belt_h"));
173         if (_pix == 0) {
174                 throw failed_constructor ();
175         }
176
177         _pix_desensitised = ::get_icon (X_("fader_belt_h_desensitised"));
178         if (_pix_desensitised == 0) {
179                 throw failed_constructor ();
180         }
181         
182         _db_slider = manage (new HSliderController (_pix,
183                                                     _pix_desensitised,
184                                                     &_db_adjustment,
185                                                     115,
186                                                     false));
187
188         _label.set_text (n + ":");
189         _label.set_name (X_("OptionsLabel"));
190
191         _fader_centering_box.pack_start (*_db_slider, true, false);
192
193         _box.set_spacing (4);
194         _box.set_homogeneous (false);
195         _box.pack_start (_fader_centering_box, false, false);
196         _box.pack_start (_db_display, false, false);
197         _box.show_all ();
198
199         set_size_request_to_display_given_text (_db_display, "-99.00", 12, 12);
200
201         _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
202 }
203
204 void
205 FaderOption::set_state_from_config ()
206 {
207         gain_t const val = _get ();
208         _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));
209
210         char buf[16];
211
212         if (val == 0.0) {
213                 snprintf (buf, sizeof (buf), "-inf");
214         } else {
215                 snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
216         }
217
218         _db_display.set_text (buf);
219 }
220
221 void
222 FaderOption::db_changed ()
223 {
224         _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
225 }
226
227 void
228 FaderOption::add_to_page (OptionEditorPage* p)
229 {
230         add_widgets_to_page (p, &_label, &_box);
231 }
232
233 ClockOption::ClockOption (string const & i, string const & n, sigc::slot<framecnt_t> g, sigc::slot<bool, framecnt_t> s)
234         : Option (i, n)
235         , _clock (X_("timecode-offset"), false, X_(""), true, false, true, false)
236         , _get (g)
237         , _set (s)
238 {
239         _label.set_text (n + ":");
240         _label.set_alignment (0, 0.5);
241         _label.set_name (X_("OptionsLabel"));
242 }
243
244 void
245 ClockOption::set_state_from_config ()
246 {
247         _clock.set (_get ());
248 }
249
250 void
251 ClockOption::add_to_page (OptionEditorPage* p)
252 {
253         add_widgets_to_page (p, &_label, &_clock);
254 }
255
256 void
257 ClockOption::set_session (Session* s)
258 {
259         _clock.set_session (s);
260 }
261
262 OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
263         : table (1, 3)
264 {
265         table.set_spacings (4);
266         table.set_col_spacing (0, 32);
267         box.pack_start (table, false, false);
268         box.set_border_width (4);
269         n.append_page (box, t);
270 }
271
272 /** Construct an OptionEditor.
273  *  @param o Configuration to edit.
274  *  @param t Title for the dialog.
275  */
276 OptionEditor::OptionEditor (Configuration* c, std::string const & t)
277         : ArdourWindow (t), _config (c)
278 {
279         using namespace Notebook_Helpers;
280
281         set_default_size (300, 300);
282         set_wmclass (X_("ardour_preferences"), PROGRAM_NAME);
283
284         set_name ("Preferences");
285         add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);
286
287         set_border_width (4);
288
289         add (_notebook);
290
291         _notebook.set_show_tabs (true);
292         _notebook.set_show_border (true);
293         _notebook.set_name ("OptionsNotebook");
294
295         show_all_children();
296
297         /* Watch out for changes to parameters */
298         _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
299 }
300
301 OptionEditor::~OptionEditor ()
302 {
303         for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
304                 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
305                         delete *j;
306                 }
307                 delete i->second;
308         }
309 }
310
311 /** Called when a configuration parameter has been changed.
312  *  @param p Parameter name.
313  */
314 void
315 OptionEditor::parameter_changed (std::string const & p)
316 {
317         ENSURE_GUI_THREAD (*this, &OptionEditor::parameter_changed, p)
318
319         for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
320                 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
321                         (*j)->parameter_changed (p);
322                 }
323         }
324 }
325
326 /** Add a component to a given page.
327  *  @param pn Page name (will be created if it doesn't already exist)
328  *  @param o Component.
329  */
330 void
331 OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
332 {
333         if (_pages.find (pn) == _pages.end()) {
334                 _pages[pn] = new OptionEditorPage (_notebook, pn);
335         }
336
337         OptionEditorPage* p = _pages[pn];
338         p->components.push_back (o);
339
340         o->add_to_page (p);
341         o->set_state_from_config ();
342 }
343
344 void
345 OptionEditor::set_current_page (string const & p)
346 {
347         int i = 0;
348         while (i < _notebook.get_n_pages ()) {
349                 if (_notebook.get_tab_label_text (*_notebook.get_nth_page (i)) == p) {
350                         _notebook.set_current_page (i);
351                         return;
352                 }
353
354                 ++i;
355         }
356 }
357
358
359 DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
360         : Option (i, n)
361         , _get (g)
362         , _set (s)
363 {
364         _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
365         _file_chooser.signal_file_set().connect (sigc::mem_fun (*this, &DirectoryOption::file_set));
366         _file_chooser.signal_current_folder_changed().connect (sigc::mem_fun (*this, &DirectoryOption::current_folder_set));
367 }
368
369
370 void
371 DirectoryOption::set_state_from_config ()
372 {
373         _file_chooser.set_current_folder (_get ());
374 }
375
376 void
377 DirectoryOption::add_to_page (OptionEditorPage* p)
378 {
379         add_widgets_to_page (p, manage (new Label (_name)), &_file_chooser);
380 }
381
382 void
383 DirectoryOption::file_set ()
384 {
385         _set (_file_chooser.get_filename ());
386 }
387
388 void
389 DirectoryOption::current_folder_set ()
390 {
391         _set (_file_chooser.get_current_folder ());
392 }