2 Copyright (C) 2001-2009 Paul Davis
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.
21 #include <gtkmm/box.h>
22 #include <gtkmm/alignment.h>
23 #include "gtkmm2ext/utils.h"
25 #include "ardour/dB.h"
26 #include "ardour/rc_configuration.h"
27 #include "ardour/session.h"
28 #include "ardour/types.h"
29 #include "ardour/utils.h"
31 #include "pbd/configuration.h"
32 #include "pbd/replace_all.h"
33 #include "pbd/strsplit.h"
35 #include "gui_thread.h"
36 #include "option_editor.h"
37 #include "public_editor.h"
43 using namespace Gtkmm2ext;
44 using namespace ARDOUR;
47 OptionEditorComponent::add_widget_to_page (OptionEditorPage* p, Gtk::Widget* w)
49 int const n = p->table.property_n_rows();
51 if (!_note.empty ()) {
55 p->table.resize (m, 3);
56 p->table.attach (*w, 1, 3, n, n + 1, FILL | EXPAND);
58 maybe_add_note (p, n + 1);
62 OptionEditorComponent::add_widgets_to_page (OptionEditorPage* p, Gtk::Widget* wa, Gtk::Widget* wb)
64 int const n = p->table.property_n_rows();
66 if (!_note.empty ()) {
70 p->table.resize (m, 3);
71 p->table.attach (*wa, 1, 2, n, n + 1, FILL);
72 p->table.attach (*wb, 2, 3, n, n + 1, FILL | EXPAND);
74 maybe_add_note (p, n + 1);
78 OptionEditorComponent::maybe_add_note (OptionEditorPage* p, int n)
80 if (!_note.empty ()) {
81 Gtk::Label* l = manage (new Gtk::Label (string_compose (X_("<i>%1</i>"), _note)));
82 l->set_use_markup (true);
83 p->table.attach (*l, 1, 3, n, n + 1, FILL | EXPAND);
88 OptionEditorComponent::set_note (string const & n)
93 OptionEditorHeading::OptionEditorHeading (string const & h)
96 s << "<b>" << h << "</b>";
97 _label = manage (left_aligned_label (s.str()));
98 _label->set_use_markup (true);
102 OptionEditorHeading::add_to_page (OptionEditorPage* p)
104 int const n = p->table.property_n_rows();
105 p->table.resize (n + 2, 3);
107 p->table.attach (*manage (new Label ("")), 0, 3, n, n + 1, FILL | EXPAND);
108 p->table.attach (*_label, 0, 3, n + 1, n + 2, FILL | EXPAND);
112 OptionEditorBox::add_to_page (OptionEditorPage* p)
114 add_widget_to_page (p, _box);
117 RcActionButton::RcActionButton (std::string const & t, const Glib::SignalProxy0< void >::SlotType & slot, std::string const & l)
120 _button = manage (new Button (t));
121 _button->signal_clicked().connect (slot);
123 _label = manage (right_aligned_label (l));
128 RcActionButton::add_to_page (OptionEditorPage *p)
130 int const n = p->table.property_n_rows();
132 p->table.resize (m, 3);
134 p->table.attach (*_label, 1, 2, n, n + 1, FILL | EXPAND);
135 p->table.attach (*_button, 2, 3, n, n + 1, FILL | EXPAND);
137 p->table.attach (*_button, 1, 3, n, n + 1, FILL | EXPAND);
141 RcConfigDisplay::RcConfigDisplay (string const & i, string const & n, sigc::slot<string> g, char s)
146 _label = manage (right_aligned_label (n));
147 _info = manage (new Label);
148 _info-> set_line_wrap (true);
149 set_state_from_config ();
153 RcConfigDisplay::set_state_from_config ()
157 std::replace (p.begin(), p.end(), _sep, '\n');
163 RcConfigDisplay::parameter_changed (std::string const & p)
166 set_state_from_config ();
171 RcConfigDisplay::add_to_page (OptionEditorPage *p)
173 int const n = p->table.property_n_rows();
175 p->table.resize (m, 3);
176 p->table.attach (*_label, 1, 2, n, n + 1, FILL | EXPAND);
177 p->table.attach (*_info, 2, 3, n, n + 1, FILL | EXPAND);
181 BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
186 _button = manage (new CheckButton);
187 _label = manage (new Label);
188 _label->set_markup (n);
189 _button->add (*_label);
190 _button->set_active (_get ());
191 _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
195 BoolOption::add_to_page (OptionEditorPage* p)
197 add_widget_to_page (p, _button);
201 BoolOption::set_state_from_config ()
203 _button->set_active (_get ());
207 BoolOption::toggled ()
209 if (!_set (_button->get_active ())) {
210 _button->set_active (_get ());
214 RouteDisplayBoolOption::RouteDisplayBoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
215 : BoolOption (i, n, g, s)
220 RouteDisplayBoolOption::toggled ()
223 BoolOption::toggled ();
226 EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
231 _label = manage (left_aligned_label (n + ":"));
232 _entry = manage (new Entry);
233 _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
234 _entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &EntryOption::focus_out));
235 _entry->signal_insert_text().connect (sigc::mem_fun (*this, &EntryOption::filter_text));
239 EntryOption::add_to_page (OptionEditorPage* p)
241 add_widgets_to_page (p, _label, _entry);
245 EntryOption::set_state_from_config ()
247 _entry->set_text (_get ());
251 EntryOption::set_sensitive (bool s)
253 _entry->set_sensitive (s);
257 EntryOption::filter_text (const Glib::ustring&, int*)
259 std::string text = _entry->get_text ();
260 for (size_t i = 0; i < _invalid.length(); ++i) {
261 text.erase (std::remove(text.begin(), text.end(), _invalid.at(i)), text.end());
263 if (text != _entry->get_text ()) {
264 _entry->set_text (text);
269 EntryOption::activated ()
271 _set (_entry->get_text ());
275 EntryOption::focus_out (GdkEventFocus*)
277 _set (_entry->get_text ());
281 /** Construct a BoolComboOption.
283 * @param n User-visible name.
284 * @param t Text to give for the variable being true.
285 * @param f Text to give for the variable being false.
286 * @param g Slot to get the variable's value.
287 * @param s Slot to set the variable's value.
289 BoolComboOption::BoolComboOption (
290 string const & i, string const & n, string const & t, string const & f,
291 sigc::slot<bool> g, sigc::slot<bool, bool> s
297 _label = manage (new Label (n + ":"));
298 _label->set_alignment (0, 0.5);
299 _combo = manage (new ComboBoxText);
301 /* option 0 is the false option */
302 _combo->append_text (f);
303 /* and option 1 is the true */
304 _combo->append_text (t);
306 _combo->signal_changed().connect (sigc::mem_fun (*this, &BoolComboOption::changed));
310 BoolComboOption::set_state_from_config ()
312 _combo->set_active (_get() ? 1 : 0);
316 BoolComboOption::add_to_page (OptionEditorPage* p)
318 add_widgets_to_page (p, _label, _combo);
322 BoolComboOption::changed ()
324 _set (_combo->get_active_row_number () == 0 ? false : true);
328 BoolComboOption::set_sensitive (bool yn)
330 _combo->set_sensitive (yn);
335 FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
337 , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
341 _db_slider = manage (new HSliderController (&_db_adjustment, boost::shared_ptr<PBD::Controllable>(), 115, 18));
343 _label.set_text (n + ":");
344 _label.set_alignment (0, 0.5);
345 _label.set_name (X_("OptionsLabel"));
347 _fader_centering_box.pack_start (*_db_slider, true, false);
349 _box.set_spacing (4);
350 _box.set_homogeneous (false);
351 _box.pack_start (_fader_centering_box, false, false);
352 _box.pack_start (_db_display, false, false);
355 set_size_request_to_display_given_text (_db_display, "-99.00", 12, 12);
357 _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
358 _db_display.signal_activate().connect (sigc::mem_fun (*this, &FaderOption::on_activate));
359 _db_display.signal_key_press_event().connect (sigc::mem_fun (*this, &FaderOption::on_key_press), false);
363 FaderOption::set_state_from_config ()
365 gain_t const val = _get ();
366 _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));
371 snprintf (buf, sizeof (buf), "-inf");
373 snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
376 _db_display.set_text (buf);
380 FaderOption::db_changed ()
382 _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
386 FaderOption::on_activate ()
388 float db_val = atof (_db_display.get_text ().c_str ());
389 gain_t coeff_val = dB_to_coefficient (db_val);
391 _db_adjustment.set_value (gain_to_slider_position_with_max (coeff_val, Config->get_max_gain ()));
395 FaderOption::on_key_press (GdkEventKey* ev)
397 if (ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (ev->keyval)) {
398 /* drop through to normal handling */
401 /* illegal key for gain entry */
406 FaderOption::add_to_page (OptionEditorPage* p)
408 add_widgets_to_page (p, &_label, &_box);
411 ClockOption::ClockOption (string const & i, string const & n, sigc::slot<std::string> g, sigc::slot<bool, std::string> s)
413 , _clock (X_("timecode-offset"), true, X_(""), true, false, true, false)
417 _label.set_text (n + ":");
418 _label.set_alignment (0, 0.5);
419 _label.set_name (X_("OptionsLabel"));
420 _clock.ValueChanged.connect (sigc::mem_fun (*this, &ClockOption::save_clock_time));
424 ClockOption::set_state_from_config ()
428 if (!Timecode::parse_timecode_format(_get(), TC)) {
429 _clock.set (0, true);
431 TC.rate = _session->frames_per_timecode_frame();
432 TC.drop = _session->timecode_drop_frames();
433 _session->timecode_to_sample(TC, when, false, false);
434 if (TC.negative) { when=-when; }
435 _clock.set (when, true);
439 ClockOption::save_clock_time ()
442 _session->sample_to_timecode(_clock.current_time(), TC, false, false);
443 _set (Timecode::timecode_format_time(TC));
447 ClockOption::add_to_page (OptionEditorPage* p)
449 add_widgets_to_page (p, &_label, &_clock);
453 ClockOption::set_session (Session* s)
456 _clock.set_session (s);
459 OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
462 table.set_spacings (4);
463 table.set_col_spacing (0, 32);
464 box.pack_start (table, false, false);
465 box.set_border_width (4);
466 n.append_page (box, t);
469 /** Construct an OptionEditor.
470 * @param o Configuration to edit.
471 * @param t Title for the dialog.
473 OptionEditor::OptionEditor (PBD::Configuration* c, std::string const & t)
475 , option_tree (TreeStore::create (option_columns))
476 , option_treeview (option_tree)
478 using namespace Notebook_Helpers;
480 _notebook.set_show_tabs (false);
481 _notebook.set_show_border (true);
482 _notebook.set_name ("OptionsNotebook");
484 option_treeview.append_column ("", option_columns.name);
485 option_treeview.set_enable_search(true);
486 option_treeview.set_search_column(0);
487 option_treeview.set_name ("OptionsTreeView");
488 option_treeview.set_headers_visible (false);
490 option_treeview.get_selection()->set_mode (Gtk::SELECTION_SINGLE);
491 option_treeview.get_selection()->signal_changed().connect (sigc::mem_fun (*this, &OptionEditor::treeview_row_selected));
493 /* Watch out for changes to parameters */
494 _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
497 OptionEditor::~OptionEditor ()
499 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
500 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
507 /** Called when a configuration parameter has been changed.
508 * @param p Parameter name.
511 OptionEditor::parameter_changed (std::string const & p)
513 ENSURE_GUI_THREAD (*this, &OptionEditor::parameter_changed, p)
515 for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
516 for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
517 (*j)->parameter_changed (p);
523 OptionEditor::treeview_row_selected ()
525 Glib::RefPtr<Gtk::TreeSelection> selection = option_treeview.get_selection();
526 TreeModel::iterator iter = selection->get_selected();
528 TreeModel::Row row = *iter;
529 Gtk::Widget* w = row[option_columns.widget];
531 _notebook.set_current_page (_notebook.page_num (*w));
537 OptionEditor::add_path_to_treeview (std::string const & pn, Gtk::Widget& widget)
539 option_treeview.set_model (Glib::RefPtr<TreeStore>());
541 if (pn.find ('/') == std::string::npos) {
542 /* new top level item in tree */
544 TreeModel::iterator new_row = option_tree->append ();
545 TreeModel::Row row = *new_row;
546 row[option_columns.name] = pn;
547 row[option_columns.widget] = &widget;
553 /* split page name, which is actually a path, into each
557 std::vector<std::string> components;
558 split (pn, components, '/');
560 /* start with top level children */
562 typedef Gtk::TreeModel::Children type_children; //minimise code length.
563 type_children children = option_tree->children();
565 /* foreach path component ... */
567 for (std::vector<std::string>::const_iterator s = components.begin(); s != components.end(); ) {
569 bool component_found = false;
571 type_children::iterator iter;
573 /* look through the children at this level */
575 for (iter = children.begin(); iter != children.end(); ++iter) {
576 Gtk::TreeModel::Row row = *iter;
578 std::string row_name = row[option_columns.name];
579 if (row_name == (*s)) {
583 component_found = true;
585 /* reset children to point to
586 * the children of this row
589 children = row.children();
594 if (!component_found) {
596 /* missing component. If it is the last
597 * one, append a real page. Otherwise
598 * just put an entry in the tree model
599 * since it is a navigational/sorting
603 TreeModel::iterator new_row = option_tree->append (children);
604 TreeModel::Row row = *new_row;
605 row[option_columns.name] = *s;
609 if (s == components.end()) {
610 row[option_columns.widget] = &widget;
612 row[option_columns.widget] = 0;
615 children = row.children ();
619 /* component found, just move on to the
620 * next one. children has already been
621 * reset appropriately.
630 option_treeview.set_model (option_tree);
631 option_treeview.expand_all ();
634 /** Add a component to a given page.
635 * @param pn Page name (will be created if it doesn't already exist)
636 * @param o Component.
639 OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
641 if (_pages.find (pn) == _pages.end()) {
642 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
645 add_path_to_treeview (pn, oep->box);
648 OptionEditorPage* p = _pages[pn];
649 p->components.push_back (o);
652 o->set_state_from_config ();
656 * @param pn Page name (will be created if it doesn't already exist)
657 * @param w widget that fills the page
660 OptionEditor::add_page (std::string const & pn, Gtk::Widget& w)
662 if (_pages.find (pn) == _pages.end()) {
663 OptionEditorPage* oep = new OptionEditorPage (_notebook, pn);
665 add_path_to_treeview (pn, oep->box);
668 OptionEditorPage* p = _pages[pn];
669 p->box.pack_start (w, true, true);
673 OptionEditor::set_current_page (string const & p)
676 while (i < _notebook.get_n_pages ()) {
677 if (_notebook.get_tab_label_text (*_notebook.get_nth_page (i)) == p) {
678 _notebook.set_current_page (i);
687 DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
692 _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
693 _file_chooser.signal_selection_changed().connect (sigc::mem_fun (*this, &DirectoryOption::selection_changed));
698 DirectoryOption::set_state_from_config ()
700 _file_chooser.set_current_folder (poor_mans_glob(_get ()));
704 DirectoryOption::add_to_page (OptionEditorPage* p)
706 Gtk::Label *label = manage (new Label (_name));
707 label->set_alignment (0, 0.5);
708 label->set_name (X_("OptionsLabel"));
709 add_widgets_to_page (p, label, &_file_chooser);
713 DirectoryOption::selection_changed ()
715 _set (poor_mans_glob(_file_chooser.get_filename ()));
718 /*--------------------------*/
720 OptionEditorContainer::OptionEditorContainer (PBD::Configuration* c, string const& str)
721 : OptionEditor (c, str)
723 set_border_width (4);
724 hpacker.pack_start (treeview(), false, false);
725 hpacker.pack_start (notebook(), true, true);
726 pack_start (hpacker, true, true);
732 OptionEditorWindow::OptionEditorWindow (PBD::Configuration* c, string const& str)
733 : OptionEditor (c, str)
735 container.set_border_width (4);
736 hpacker.pack_start (treeview(), false, false);
737 hpacker.pack_start (notebook(), true, true);
739 container.pack_start (hpacker, true, true);