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