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