option_editor.cc

Go to the documentation of this file.

/*
    Copyright (C) 2001-2009 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/
#include <algorithm>

#include <gtkmm/box.h>
#include <gtkmm/alignment.h>
#include "gtkmm2ext/utils.h"

#include "ardour/dB.h"
#include "ardour/rc_configuration.h"
#include "ardour/session.h"
#include "ardour/types.h"
#include "ardour/utils.h"

#include "pbd/configuration.h"
#include "pbd/replace_all.h"

#include "public_editor.h"
#include "option_editor.h"
#include "gui_thread.h"
#include "i18n.h"

using namespace std;
using namespace Gtk;
using namespace Gtkmm2ext;
using namespace ARDOUR;

void
OptionEditorComponent::add_widget_to_page (OptionEditorPage* p, Gtk::Widget* w)
{
        int const n = p->table.property_n_rows();
        int m = n + 1;
        if (!_note.empty ()) {
                ++m;
        }

        p->table.resize (m, 3);
        p->table.attach (*w, 1, 3, n, n + 1, FILL | EXPAND);

        maybe_add_note (p, n + 1);
}

void
OptionEditorComponent::add_widgets_to_page (OptionEditorPage* p, Gtk::Widget* wa, Gtk::Widget* wb)
{
        int const n = p->table.property_n_rows();
        int m = n + 1;
        if (!_note.empty ()) {
                ++m;
        }
        
        p->table.resize (m, 3);
        p->table.attach (*wa, 1, 2, n, n + 1, FILL);
        p->table.attach (*wb, 2, 3, n, n + 1, FILL | EXPAND);
        
        maybe_add_note (p, n + 1);
}

void
OptionEditorComponent::maybe_add_note (OptionEditorPage* p, int n)
{
        if (!_note.empty ()) {
                Gtk::Label* l = manage (new Gtk::Label (string_compose (X_("<i>%1</i>"), _note)));
                l->set_use_markup (true);
                p->table.attach (*l, 1, 3, n, n + 1, FILL | EXPAND);
        }
}

void
OptionEditorComponent::set_note (string const & n)
{
        _note = n;
}

OptionEditorHeading::OptionEditorHeading (string const & h)
{
        std::stringstream s;
        s << "<b>" << h << "</b>";
        _label = manage (left_aligned_label (s.str()));
        _label->set_use_markup (true);
}

void
OptionEditorHeading::add_to_page (OptionEditorPage* p)
{
        int const n = p->table.property_n_rows();
        p->table.resize (n + 2, 3);

        p->table.attach (*manage (new Label ("")), 0, 3, n, n + 1, FILL | EXPAND);
        p->table.attach (*_label, 0, 3, n + 1, n + 2, FILL | EXPAND);
}

void
OptionEditorBox::add_to_page (OptionEditorPage* p)
{
        add_widget_to_page (p, _box);
}

BoolOption::BoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
        : Option (i, n),
          _get (g),
          _set (s)
{
        _button = manage (new CheckButton);
        _label = manage (new Label);
        _label->set_markup (n);
        _button->add (*_label);
        _button->set_active (_get ());
        _button->signal_toggled().connect (sigc::mem_fun (*this, &BoolOption::toggled));
}

void
BoolOption::add_to_page (OptionEditorPage* p)
{
        add_widget_to_page (p, _button);
}

void
BoolOption::set_state_from_config ()
{
        _button->set_active (_get ());
}

void
BoolOption::toggled ()
{
        _set (_button->get_active ());
}

RouteDisplayBoolOption::RouteDisplayBoolOption (string const & i, string const & n, sigc::slot<bool> g, sigc::slot<bool, bool> s)
        : BoolOption (i, n, g, s)
{
}

void
RouteDisplayBoolOption::toggled ()
{
        DisplaySuspender ds;
        BoolOption::toggled ();
}

EntryOption::EntryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
        : Option (i, n),
          _get (g),
          _set (s)
{
        _label = manage (left_aligned_label (n + ":"));
        _entry = manage (new Entry);
        _entry->signal_activate().connect (sigc::mem_fun (*this, &EntryOption::activated));
        _entry->signal_focus_out_event().connect (sigc::mem_fun (*this, &EntryOption::focus_out));
        _entry->signal_insert_text().connect (sigc::mem_fun (*this, &EntryOption::filter_text));
}

void
EntryOption::add_to_page (OptionEditorPage* p)
{
        add_widgets_to_page (p, _label, _entry);
}

void
EntryOption::set_state_from_config ()
{
        _entry->set_text (_get ());
}

void
EntryOption::set_sensitive (bool s)
{
        _entry->set_sensitive (s);
}

void
EntryOption::filter_text (const Glib::ustring&, int*)
{
        std::string text = _entry->get_text ();
        for (size_t i = 0; i < _invalid.length(); ++i) {
                text.erase (std::remove(text.begin(), text.end(), _invalid.at(i)), text.end());
        }
        if (text != _entry->get_text ()) {
                _entry->set_text (text);
        }
}

void
EntryOption::activated ()
{
        _set (_entry->get_text ());
}

bool
EntryOption::focus_out (GdkEventFocus*)
{
        _set (_entry->get_text ());
        return true;
}

BoolComboOption::BoolComboOption (
        string const & i, string const & n, string const & t, string const & f, 
        sigc::slot<bool> g, sigc::slot<bool, bool> s
        )
        : Option (i, n)
        , _get (g)
        , _set (s)
{
        _label = manage (new Label (n + ":"));
        _label->set_alignment (0, 0.5);
        _combo = manage (new ComboBoxText);

        /* option 0 is the false option */
        _combo->append_text (f);
        /* and option 1 is the true */
        _combo->append_text (t);
        
        _combo->signal_changed().connect (sigc::mem_fun (*this, &BoolComboOption::changed));
}

void
BoolComboOption::set_state_from_config ()
{
        _combo->set_active (_get() ? 1 : 0);
}

void
BoolComboOption::add_to_page (OptionEditorPage* p)
{
        add_widgets_to_page (p, _label, _combo);
}

void
BoolComboOption::changed ()
{
        _set (_combo->get_active_row_number () == 0 ? false : true);
}

void
BoolComboOption::set_sensitive (bool yn)
{
        _combo->set_sensitive (yn);
}
        

          
FaderOption::FaderOption (string const & i, string const & n, sigc::slot<gain_t> g, sigc::slot<bool, gain_t> s)
        : Option (i, n)
        , _db_adjustment (gain_to_slider_position_with_max (1.0, Config->get_max_gain()), 0, 1, 0.01, 0.1)
        , _get (g)
        , _set (s)
{
        _db_slider = manage (new HSliderController (&_db_adjustment, boost::shared_ptr<PBD::Controllable>(), 115, 18));

        _label.set_text (n + ":");
        _label.set_alignment (0, 0.5);
        _label.set_name (X_("OptionsLabel"));

        _fader_centering_box.pack_start (*_db_slider, true, false);

        _box.set_spacing (4);
        _box.set_homogeneous (false);
        _box.pack_start (_fader_centering_box, false, false);
        _box.pack_start (_db_display, false, false);
        _box.show_all ();

        set_size_request_to_display_given_text (_db_display, "-99.00", 12, 12);

        _db_adjustment.signal_value_changed().connect (sigc::mem_fun (*this, &FaderOption::db_changed));
}

void
FaderOption::set_state_from_config ()
{
        gain_t const val = _get ();
        _db_adjustment.set_value (gain_to_slider_position_with_max (val, Config->get_max_gain ()));

        char buf[16];

        if (val == 0.0) {
                snprintf (buf, sizeof (buf), "-inf");
        } else {
                snprintf (buf, sizeof (buf), "%.2f", accurate_coefficient_to_dB (val));
        }

        _db_display.set_text (buf);
}

void
FaderOption::db_changed ()
{
        _set (slider_position_to_gain_with_max (_db_adjustment.get_value (), Config->get_max_gain()));
}

void
FaderOption::add_to_page (OptionEditorPage* p)
{
        add_widgets_to_page (p, &_label, &_box);
}

ClockOption::ClockOption (string const & i, string const & n, sigc::slot<std::string> g, sigc::slot<bool, std::string> s)
        : Option (i, n)
        , _clock (X_("timecode-offset"), true, X_(""), true, false, true, false)
        , _get (g)
        , _set (s)
{
        _label.set_text (n + ":");
        _label.set_alignment (0, 0.5);
        _label.set_name (X_("OptionsLabel"));
        _clock.ValueChanged.connect (sigc::mem_fun (*this, &ClockOption::save_clock_time));
}

void
ClockOption::set_state_from_config ()
{
        Timecode::Time TC;
        framepos_t when;
        if (!Timecode::parse_timecode_format(_get(), TC)) {
                _clock.set (0, true);
        }
        TC.rate = _session->frames_per_timecode_frame();
        TC.drop = _session->timecode_drop_frames();
        _session->timecode_to_sample(TC, when, false, false);
        if (TC.negative) { when=-when; }
        _clock.set (when, true);
}

void
ClockOption::save_clock_time ()
{
        Timecode::Time TC;
        _session->sample_to_timecode(_clock.current_time(), TC, false, false);
        _set (Timecode::timecode_format_time(TC));
}

void
ClockOption::add_to_page (OptionEditorPage* p)
{
        add_widgets_to_page (p, &_label, &_clock);
}

void
ClockOption::set_session (Session* s)
{
        _session = s;
        _clock.set_session (s);
}

OptionEditorPage::OptionEditorPage (Gtk::Notebook& n, std::string const & t)
        : table (1, 3)
{
        table.set_spacings (4);
        table.set_col_spacing (0, 32);
        box.pack_start (table, false, false);
        box.set_border_width (4);
        n.append_page (box, t);
}

OptionEditor::OptionEditor (PBD::Configuration* c, std::string const & t)
        : ArdourWindow (t), _config (c)
{
        using namespace Notebook_Helpers;

        set_default_size (300, 300);
        // set_wmclass (X_("ardour_preferences"), PROGRAM_NAME);

        set_name ("Preferences");
        add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);

        set_border_width (4);

        add (_notebook);

        _notebook.set_show_tabs (true);
        _notebook.set_show_border (true);
        _notebook.set_name ("OptionsNotebook");

        show_all_children();

        /* Watch out for changes to parameters */
        _config->ParameterChanged.connect (config_connection, invalidator (*this), boost::bind (&OptionEditor::parameter_changed, this, _1), gui_context());
}

OptionEditor::~OptionEditor ()
{
        for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
                for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
                        delete *j;
                }
                delete i->second;
        }
}

void
OptionEditor::parameter_changed (std::string const & p)
{
        ENSURE_GUI_THREAD (*this, &OptionEditor::parameter_changed, p)

        for (std::map<std::string, OptionEditorPage*>::iterator i = _pages.begin(); i != _pages.end(); ++i) {
                for (std::list<OptionEditorComponent*>::iterator j = i->second->components.begin(); j != i->second->components.end(); ++j) {
                        (*j)->parameter_changed (p);
                }
        }
}

void
OptionEditor::add_option (std::string const & pn, OptionEditorComponent* o)
{
        if (_pages.find (pn) == _pages.end()) {
                _pages[pn] = new OptionEditorPage (_notebook, pn);
        }

        OptionEditorPage* p = _pages[pn];
        p->components.push_back (o);

        o->add_to_page (p);
        o->set_state_from_config ();
}

void
OptionEditor::add_page (std::string const & pn, Gtk::Widget& w)
{
        if (_pages.find (pn) == _pages.end()) {
                _pages[pn] = new OptionEditorPage (_notebook, pn);
        }

        OptionEditorPage* p = _pages[pn];
        p->box.pack_start (w, true, true);
}

void
OptionEditor::set_current_page (string const & p)
{
        int i = 0;
        while (i < _notebook.get_n_pages ()) {
                if (_notebook.get_tab_label_text (*_notebook.get_nth_page (i)) == p) {
                        _notebook.set_current_page (i);
                        return;
                }

                ++i;
        }
}


DirectoryOption::DirectoryOption (string const & i, string const & n, sigc::slot<string> g, sigc::slot<bool, string> s)
        : Option (i, n)
        , _get (g)
        , _set (s)
{
        _file_chooser.set_action (Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
        _file_chooser.signal_selection_changed().connect (sigc::mem_fun (*this, &DirectoryOption::selection_changed));
}


void
DirectoryOption::set_state_from_config ()
{
        _file_chooser.set_current_folder (poor_mans_glob(_get ()));
}

void
DirectoryOption::add_to_page (OptionEditorPage* p)
{
        Gtk::Label *label = manage (new Label (_name));
        label->set_alignment (0, 0.5);
        label->set_name (X_("OptionsLabel"));
        add_widgets_to_page (p, label, &_file_chooser);
}

void
DirectoryOption::selection_changed ()
{
        _set (poor_mans_glob(_file_chooser.get_filename ()));
}