first step to separate generic-gui layout
[ardour.git] / gtk2_ardour / generic_pluginui.cc
index 47b5f93a9829b296c0fdb5829d04b938444e68a4..3f33b78c924ff0af2ad91e1f379b7ff2888cbdb1 100644 (file)
@@ -43,6 +43,7 @@
 #include "ardour/session.h"
 #include "ardour/value_as_string.h"
 
+#include "ardour_spinner.h"
 #include "prompter.h"
 #include "plugin_ui.h"
 #include "gui_thread.h"
@@ -62,11 +63,6 @@ using namespace ARDOUR_UI_UTILS;
 
 GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrollable)
        : PlugUIBase (pi)
-       , button_table (initial_button_rows, initial_button_cols)
-       , output_table (initial_output_rows, initial_output_cols)
-       , hAdjustment(0.0, 0.0, 0.0)
-       , vAdjustment(0.0, 0.0, 0.0)
-       , scroller_view(hAdjustment, vAdjustment)
        , automation_menu (0)
        , is_scrollable(scrollable)
 {
@@ -136,22 +132,19 @@ GenericPluginUI::GenericPluginUI (boost::shared_ptr<PluginInsert> pi, bool scrol
 
        main_contents.pack_start (*constraint_hbox, false, false);
 
-       if (is_scrollable ) {
-               scroller.set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
-               scroller.set_name ("PluginEditor");
-               scroller_view.set_name("PluginEditor");
-               scroller_view.add (hpacker);
-               scroller.add (scroller_view);
-
-               main_contents.pack_start (scroller, true, true);
-
+       if (is_scrollable) {
+               Gtk::ScrolledWindow *scroller = manage (new Gtk::ScrolledWindow());
+               scroller->set_policy (Gtk::POLICY_NEVER, Gtk::POLICY_AUTOMATIC);
+               scroller->set_name ("PluginEditor");
+               scroller->add (hpacker);
+               main_contents.pack_start (*scroller, true, true);
        } else {
                main_contents.pack_start (hpacker, false, false);
        }
 
        pi->ActiveChanged.connect (active_connection, invalidator (*this), boost::bind (&GenericPluginUI::processor_active_changed, this, boost::weak_ptr<Processor>(pi)), gui_context());
 
-       bypass_button.set_active (!pi->active());
+       bypass_button.set_active (!pi->enabled());
 
        prefheight = 0;
        build ();
@@ -216,58 +209,10 @@ static const float default_similarity_threshold = 0.3;
 void
 GenericPluginUI::build ()
 {
-       guint32 i = 0;
-       guint32 x = 0;
-       Frame* frame;
-       Frame* bt_frame;
-       VBox* box;
-       int output_row, output_col;
-       int button_row, button_col;
-       int output_rows, output_cols;
-       int button_rows, button_cols;
-
-       hpacker.set_spacing (10);
-
-       output_rows = initial_output_rows;
-       output_cols = initial_output_cols;
-       button_rows = initial_button_rows;
-       button_cols = initial_button_cols;
-       output_row = 0;
-       button_row = 0;
-       output_col = 0;
-       button_col = 0;
-
-       button_table.set_homogeneous (false);
-       button_table.set_row_spacings (2);
-       button_table.set_col_spacings (2);
-       output_table.set_homogeneous (true);
-       output_table.set_row_spacings (2);
-       output_table.set_col_spacings (2);
-       button_table.set_border_width (5);
-       output_table.set_border_width (5);
-
-       hpacker.set_border_width (10);
-
-       bt_frame = manage (new Frame);
-       bt_frame->set_name ("BaseFrame");
-       bt_frame->set_label (_("Switches"));
-       bt_frame->add (button_table);
-       hpacker.pack_start(*bt_frame, true, true);
-
-       box = manage (new VBox);
-       box->set_border_width (5);
-       box->set_spacing (1);
-
-       frame = manage (new Frame);
-       frame->set_name ("BaseFrame");
-       frame->set_label (_("Controls"));
-       frame->add (*box);
-       hpacker.pack_start(*frame, true, true);
-
        std::vector<ControlUI *> control_uis;
 
        // Build a ControlUI for each control port
-       for (i = 0; i < plugin->parameter_count(); ++i) {
+       for (size_t i = 0; i < plugin->parameter_count(); ++i) {
 
                if (plugin->parameter_is_control (i)) {
 
@@ -335,39 +280,111 @@ GenericPluginUI::build ()
                plugin->announce_property_values();
        }
 
+       layout (control_uis);
+
+       output_update ();
+
+       automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
+       automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
+       automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
+       automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
+}
+
+
+void
+GenericPluginUI::layout (const std::vector<ControlUI *>& control_uis)
+{
+       guint32 x = 0;
+
+       static const int32_t initial_button_rows = 12;
+       static const int32_t initial_button_cols = 1;
+       static const int32_t initial_output_rows = 1;
+       static const int32_t initial_output_cols = 4;
+
+       Gtk::Table* button_table = manage (new Gtk::Table (initial_button_rows, initial_button_cols));
+       Gtk::Table* output_table = manage (new Gtk::Table (initial_output_rows, initial_output_cols));
+
+       Frame* frame;
+       Frame* bt_frame;
+       VBox* box;
+       int output_row, output_col;
+       int button_row, button_col;
+       int output_rows, output_cols;
+       int button_rows, button_cols;
+
+       hpacker.set_spacing (10);
+       hpacker.set_border_width (10);
+
+       output_rows = initial_output_rows;
+       output_cols = initial_output_cols;
+       button_rows = initial_button_rows;
+       button_cols = initial_button_cols;
+       output_row = 0;
+       button_row = 0;
+       output_col = 0;
+       button_col = 0;
+
+       button_table->set_homogeneous (false);
+       button_table->set_row_spacings (2);
+       button_table->set_col_spacings (2);
+       output_table->set_homogeneous (true);
+       output_table->set_row_spacings (2);
+       output_table->set_col_spacings (2);
+       button_table->set_border_width (5);
+       output_table->set_border_width (5);
+
+
+       bt_frame = manage (new Frame);
+       bt_frame->set_name ("BaseFrame");
+       bt_frame->set_label (_("Switches"));
+       bt_frame->add (*button_table);
+       hpacker.pack_start(*bt_frame, true, true);
+
+       box = manage (new VBox);
+       box->set_border_width (5);
+       box->set_spacing (1);
+
+       frame = manage (new Frame);
+       frame->set_name ("BaseFrame");
+       frame->set_label (_("Controls"));
+       frame->add (*box);
+       hpacker.pack_start(*frame, true, true);
+
+
        // Add special controls to UI, and build list of normal controls to be layed out later
        std::vector<ControlUI *> cui_controls_list;
-       for (i = 0; i < control_uis.size(); ++i) {
+       for (size_t i = 0; i < control_uis.size(); ++i) {
                ControlUI* cui = control_uis[i];
 
-               if (cui->controller || cui->clickbox || cui->combo) {
-                       // Get all of the controls into a list, so that
-                       // we can lay them out a bit more nicely later.
-                       cui_controls_list.push_back(cui);
-               } else if (cui->button || cui->file_button) {
+               if (cui->button || cui->file_button) {
 
                        if (!is_scrollable && button_row == button_rows) {
                                button_row = 0;
                                if (++button_col == button_cols) {
                                        button_cols += 2;
-                                       button_table.resize (button_rows, button_cols);
+                                       button_table->resize (button_rows, button_cols);
                                }
                        }
 
-                       button_table.attach (*cui, button_col, button_col + 1, button_row, button_row+1,
+                       button_table->attach (*cui, button_col, button_col + 1, button_row, button_row+1,
                                             FILL|EXPAND, FILL);
                        button_row++;
 
+               } else if (cui->controller || cui->clickbox || cui->combo) {
+                       // Get all of the controls into a list, so that
+                       // we can lay them out a bit more nicely later.
+                       cui_controls_list.push_back(cui);
+
                } else if (cui->display) {
 
-                       output_table.attach (*cui, output_col, output_col + 1, output_row, output_row+1,
+                       output_table->attach (*cui, output_col, output_col + 1, output_row, output_row+1,
                                             FILL|EXPAND, FILL);
 
                        // TODO: The meters should be divided into multiple rows
 
                        if (++output_col == output_cols) {
                                output_cols ++;
-                               output_table.resize (output_rows, output_cols);
+                               output_table->resize (output_rows, output_cols);
                        }
                }
        }
@@ -381,7 +398,7 @@ GenericPluginUI::build ()
        std::vector<float> similarity_scores(cui_controls_list.size());
        float most_similar = 0.0, least_similar = 1.0;
 
-       i = 0;
+       size_t i = 0;
        for (vector<ControlUI*>::iterator cuip = cui_controls_list.begin(); cuip != cui_controls_list.end(); ++cuip, ++i) {
                label = (*cuip)->label.get_text();
                numbers_in_labels[i] = get_number(label);
@@ -461,27 +478,23 @@ GenericPluginUI::build ()
                hpacker.remove (*frame);
        }
 
-       if (button_table.children().empty()) {
+       if (button_table->children().empty()) {
                hpacker.remove (*bt_frame);
+               delete button_table;
+       } else {
+               button_table->show_all ();
        }
 
-       if (!output_table.children().empty()) {
+       if (!output_table->children().empty()) {
                frame = manage (new Frame);
                frame->set_name ("BaseFrame");
                frame->set_label(_("Meters"));
-               frame->add (output_table);
+               frame->add (*output_table);
                hpacker.pack_end (*frame, true, true);
+               output_table->show_all ();
+       } else {
+               delete output_table;
        }
-
-       output_update ();
-
-       output_table.show_all ();
-       button_table.show_all ();
-
-       automation_manual_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Off));
-       automation_play_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Play));
-       automation_write_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Write));
-       automation_touch_all_button.signal_clicked.connect(sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::set_all_automation), ARDOUR::Touch));
 }
 
 GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
@@ -501,7 +514,7 @@ GenericPluginUI::ControlUI::ControlUI (const Evoral::Parameter& p)
 
        ignore_change = 0;
        display = 0;
-       button = 0;
+       button = false;
        clickbox = 0;
        meterinfo = 0;
 }
@@ -633,33 +646,6 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                        return control_ui;
                }
 
-               if (desc.toggled) {
-
-                       /* Build a button */
-
-                       control_ui->button = manage (new ToggleButton ());
-                       control_ui->button->set_name ("PluginEditorButton");
-                       control_ui->button->set_size_request (20, 20);
-
-                       control_ui->pack_start (control_ui->label, true, true);
-                       control_ui->pack_start (*control_ui->button, false, true);
-                       control_ui->pack_start (control_ui->automate_button, false, false);
-
-                       control_ui->button->signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::control_port_toggled), control_ui));
-                       control_ui->automate_button.signal_clicked().connect (bind (mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
-
-                       mcontrol->Changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::toggle_parameter_changed, this, control_ui), gui_context());
-                       mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
-
-                       if (value > 0.5){
-                               control_ui->button->set_active(true);
-                       }
-
-                       automation_state_changed (control_ui);
-
-                       return control_ui;
-               }
-
                if (desc.datatype == Variant::PATH) {
 
                        /* Build a file selector button */
@@ -686,9 +672,10 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                }
 
                /* create the controller */
+               bool use_knob = false; // XXX TODO
 
                if (mcontrol) {
-                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol);
+                       control_ui->controller = AutomationController::create(insert, mcontrol->parameter(), desc, mcontrol, use_knob);
                }
 
                /* XXX this code is not right yet, because it doesn't handle
@@ -697,7 +684,7 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 
                Adjustment* adj = control_ui->controller->adjustment();
 
-               if (desc.integer_step) {
+               if (desc.integer_step && !desc.toggled) {
                        control_ui->clickbox = new ClickBox (adj, "PluginUIClickBox", true);
                        Gtkmm2ext::set_size_request_to_display_given_text (*control_ui->clickbox, "g9999999", 2, 2);
                        if (desc.unit == ParameterDescriptor::MIDI_NOTE) {
@@ -705,6 +692,8 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                        } else {
                                control_ui->clickbox->set_printer (sigc::bind (sigc::mem_fun (*this, &GenericPluginUI::integer_printer), control_ui));
                        }
+               } else if (desc.toggled || use_knob) {
+                       control_ui->controller->set_size_request (req.height, req.height);
                } else {
                        //sigc::slot<void,char*,uint32_t> pslot = sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::print_parameter), (uint32_t) port_index);
 
@@ -721,18 +710,36 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
                */
 
                control_ui->pack_start (control_ui->label, true, true);
-               if (desc.integer_step) {
+
+               if (desc.toggled) {
+                       control_ui->button = true;
+                       ArdourButton* but = dynamic_cast<ArdourButton*>(control_ui->controller->widget ());
+                       assert (but);
+                       but->set_name ("pluginui toggle");
+                       update_control_display(control_ui);
+               }
+
+               if (desc.integer_step && !desc.toggled) {
                        control_ui->pack_start (*control_ui->clickbox, false, false);
                } else {
+                       if (!desc.toggled && use_knob) {
+                               ArdourSpinner* spb = manage (new ArdourSpinner (mcontrol, adj, insert));
+                               control_ui->pack_start (*spb, false, false);
+                       }
                        control_ui->pack_start (*control_ui->controller, false, false);
                }
 
                control_ui->pack_start (control_ui->automate_button, false, false);
-               control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
 
-               automation_state_changed (control_ui);
+               if (mcontrol->flags () & Controllable::NotAutomatable) {
+                       control_ui->automate_button.set_sensitive (false);
+                       set_tooltip(control_ui->automate_button, _("This control cannot be automated"));
+               } else {
+                       control_ui->automate_button.signal_clicked().connect (sigc::bind (sigc::mem_fun(*this, &GenericPluginUI::astate_clicked), control_ui));
+                       mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
+               }
 
-               mcontrol->alist()->automation_state_changed.connect (control_connections, invalidator (*this), boost::bind (&GenericPluginUI::automation_state_changed, this, control_ui), gui_context());
+               automation_state_changed (control_ui);
 
                input_controls.push_back (control_ui);
                input_controls_with_automation.push_back (control_ui);
@@ -751,49 +758,56 @@ GenericPluginUI::build_control_ui (const Evoral::Parameter&             param,
 
                control_ui->display->show_all ();
 
-               /* set up a meter */
-               /* TODO: only make a meter if the port is Hinted for it */
+               control_ui->vbox = manage (new VBox);
+               control_ui->vbox->set_spacing(3);
+
+               if (desc.integer_step || desc.enumeration) {
+                       control_ui->vbox->pack_end (*control_ui->display, false, false);
+                       control_ui->vbox->pack_end (control_ui->label, false, false);
+               } else {
+                       /* set up a meter for float ports */
 
-               MeterInfo * info = new MeterInfo();
-               control_ui->meterinfo = info;
+                       MeterInfo * info = new MeterInfo();
+                       control_ui->meterinfo = info;
 
-               info->meter = new FastMeter (
-                               5, 5, FastMeter::Vertical, 0,
-                               0x0000aaff,
-                               0x008800ff, 0x008800ff,
-                               0x00ff00ff, 0x00ff00ff,
-                               0xcccc00ff, 0xcccc00ff,
-                               0xffaa00ff, 0xffaa00ff,
-                               0xff0000ff,
-                               UIConfiguration::instance().color ("meter background bottom"),
-                               UIConfiguration::instance().color ("meter background top")
-                               );
+                       info->meter = new FastMeter (
+                                       5, 5, FastMeter::Vertical, 0,
+                                       0x0000aaff,
+                                       0x008800ff, 0x008800ff,
+                                       0x00ff00ff, 0x00ff00ff,
+                                       0xcccc00ff, 0xcccc00ff,
+                                       0xffaa00ff, 0xffaa00ff,
+                                       0xff0000ff,
+                                       UIConfiguration::instance().color ("meter background bottom"),
+                                       UIConfiguration::instance().color ("meter background top")
+                                       );
 
-               info->min_unbound = desc.min_unbound;
-               info->max_unbound = desc.max_unbound;
+                       info->min_unbound = desc.min_unbound;
+                       info->max_unbound = desc.max_unbound;
 
-               info->min = desc.lower;
-               info->max = desc.upper;
+                       info->min = desc.lower;
+                       info->max = desc.upper;
 
-               control_ui->vbox = manage (new VBox);
-               control_ui->hbox = manage (new HBox);
+                       control_ui->label.set_angle(90);
 
-               control_ui->hbox->set_spacing(1);
-               control_ui->vbox->set_spacing(3);
+                       HBox* center =  manage (new HBox);
+                       center->set_spacing(1);
+                       center->pack_start (control_ui->label, false, false);
+                       center->pack_start (*info->meter, false, false);
 
-               control_ui->label.set_angle(90);
-               control_ui->hbox->pack_start (control_ui->label, false, false);
-               control_ui->hbox->pack_start (*info->meter, false, false);
+                       control_ui->hbox = manage (new HBox);
+                       control_ui->hbox->pack_start (*center, true, false);
 
-               control_ui->vbox->pack_start (*control_ui->hbox, false, false);
+                       // horizontally center this hbox in the vbox
+                       control_ui->vbox->pack_start (*control_ui->hbox, false, false);
 
-               control_ui->vbox->pack_start (*control_ui->display, false, false);
+                       control_ui->meterinfo->meter->show_all();
+                       control_ui->meterinfo->packed = true;
+                       control_ui->vbox->pack_start (*control_ui->display, false, false);
+               }
 
                control_ui->pack_start (*control_ui->vbox);
 
-               control_ui->meterinfo->meter->show_all();
-               control_ui->meterinfo->packed = true;
-
                output_controls.push_back (control_ui);
        }
 
@@ -845,22 +859,6 @@ GenericPluginUI::set_automation_state (AutoState state, ControlUI* cui)
        insert->set_parameter_automation_state (cui->parameter(), state);
 }
 
-void
-GenericPluginUI::toggle_parameter_changed (ControlUI* cui)
-{
-       float val = cui->control->get_value();
-
-       if (!cui->ignore_change) {
-               if (val > 0.5) {
-                       cui->button->set_active (true);
-                       cui->button->set_name ("PluginEditorButton-active");
-               } else {
-                       cui->button->set_active (false);
-                       cui->button->set_name ("PluginEditorButton");
-               }
-       }
-}
-
 void
 GenericPluginUI::ui_parameter_changed (ControlUI* cui)
 {
@@ -889,12 +887,7 @@ GenericPluginUI::update_control_display (ControlUI* cui)
                        }
                }
        } else if (cui->button) {
-
-               if (val > 0.5) {
-                       cui->button->set_active (true);
-               } else {
-                       cui->button->set_active (false);
-               }
+               // AutomationController handles this
        }
 
        if( cui->controller ) {
@@ -913,26 +906,12 @@ GenericPluginUI::update_control_display (ControlUI* cui)
        cui->ignore_change--;
 }
 
-void
-GenericPluginUI::control_port_toggled (ControlUI* cui)
-{
-       cui->ignore_change++;
-       const bool active = cui->button->get_active();
-       if (active) {
-               cui->button->set_name ("PluginEditorButton-active");
-       } else {
-               cui->button->set_name ("PluginEditorButton");
-       }
-       insert->automation_control (cui->parameter())->set_value (active);
-       cui->ignore_change--;
-}
-
 void
 GenericPluginUI::control_combo_changed (ControlUI* cui)
 {
        if (!cui->ignore_change && cui->scale_points) {
                string value = cui->combo->get_active_text();
-               insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value]);
+               insert->automation_control (cui->parameter())->set_value ((*cui->scale_points)[value], Controllable::NoGroup);
        }
 }