gtk2_ardour/plugin_selector.cc

   1 /*
   2     Copyright (C) 2000-2006 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 #ifdef WAF_BUILD
  20 #include "gtk2ardour-config.h"
  21 #endif
  22
  23 #include <cstdio>
  24 #include <map>
  25
  26 #include <algorithm>
  27
  28 #include <gtkmm/table.h>
  29 #include <gtkmm/stock.h>
  30 #include <gtkmm/button.h>
  31 #include <gtkmm/notebook.h>
  32
  33 #include <gtkmm2ext/utils.h>
  34
  35 #include "pbd/convert.h"
  36
  37 #include "ardour/plugin_manager.h"
  38 #include "ardour/plugin.h"
  39 #include "ardour/utils.h"
  40
  41 #include "plugin_selector.h"
  42 #include "gui_thread.h"
  43 #include "tooltips.h"
  44
  45 #include "i18n.h"
  46
  47 using namespace ARDOUR;
  48 using namespace PBD;
  49 using namespace Gtk;
  50 using namespace std;
  51 using namespace ARDOUR_UI_UTILS;
  52
  53 static const char* _filter_mode_strings[] = {
  54         N_("Name contains"),
  55         N_("Type contains"),
  56         N_("Category contains"),
  57         N_("Author contains"),
  58         N_("Library contains"),
  59         N_("Favorites only"),
  60         N_("Hidden only"),
  61         0
  62 };
  63
  64 PluginSelector::PluginSelector (PluginManager& mgr)
  65         : ArdourDialog (_("Plugin Manager"), true, false)
  66         , filter_button (Stock::CLEAR)
  67         , fil_hidden_button (ArdourButton::led_default_elements)
  68         , fil_instruments_button (ArdourButton::default_elements)
  69         , fil_analysis_button (ArdourButton::default_elements)
  70         , fil_utils_button (ArdourButton::default_elements)
  71         , manager (mgr)
  72         , _show_hidden (false)
  73         , _show_instruments (Gtkmm2ext::ImplicitActive)
  74         , _show_analysers (Gtkmm2ext::Off)
  75         , _show_utils (Gtkmm2ext::Off)
  76
  77 {
  78         set_name ("PluginSelectorWindow");
  79         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
  80
  81         _plugin_menu = 0;
  82         in_row_change = false;
  83
  84         manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
  85         manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), gui_context());
  86         manager.PluginStatusesChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
  87         manager.PluginStatusesChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), gui_context());
  88         build_plugin_menu ();
  89
  90         plugin_model = Gtk::ListStore::create (plugin_columns);
  91         plugin_display.set_model (plugin_model);
  92         /* XXX translators: try to convert "Fav" into a short term
  93            related to "favorite" and "Hid" into a short term
  94            related to "hidden"
  95         */
  96         plugin_display.append_column (_("Fav"), plugin_columns.favorite);
  97         plugin_display.append_column (_("Hide"), plugin_columns.hidden);
  98         plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
  99         plugin_display.append_column (_("Type"), plugin_columns.type_name);
 100         plugin_display.append_column (_("Category"), plugin_columns.category);
 101         plugin_display.append_column (_("Creator"), plugin_columns.creator);
 102         plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
 103         plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
 104         plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
 105         plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
 106         plugin_display.set_headers_visible (true);
 107         plugin_display.set_headers_clickable (true);
 108         plugin_display.set_reorderable (false);
 109         plugin_display.set_rules_hint (true);
 110         plugin_display.add_object_drag (plugin_columns.plugin.index(), "PluginInfoPtr");
 111         plugin_display.set_drag_column (plugin_columns.name.index());
 112
 113         // setting a sort-column prevents re-ordering via Drag/Drop
 114         plugin_model->set_sort_column (plugin_columns.name.index(), Gtk::SORT_ASCENDING);
 115
 116         CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
 117         fav_cell->property_activatable() = true;
 118         fav_cell->property_radio() = true;
 119         fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
 120
 121         CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
 122         hidden_cell->property_activatable() = true;
 123         hidden_cell->property_radio() = true;
 124         hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
 125
 126         scroller.set_border_width(10);
 127         scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
 128         scroller.add(plugin_display);
 129
 130         amodel = Gtk::ListStore::create(acols);
 131         added_list.set_model (amodel);
 132         added_list.append_column (_("Plugins to be connected"), acols.text);
 133         added_list.set_headers_visible (true);
 134         added_list.set_reorderable (false);
 135
 136         for (int i = 0; i <=8; i++) {
 137                 Gtk::TreeView::Column* column = plugin_display.get_column(i);
 138                 column->set_sort_column(i);
 139         }
 140
 141         ascroller.set_border_width(10);
 142         ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
 143         ascroller.add(added_list);
 144         btn_add = manage(new Gtk::Button(Stock::ADD));
 145         set_tooltip(*btn_add, _("Add a plugin to the effect list"));
 146         btn_add->set_sensitive (false);
 147         btn_remove = manage(new Gtk::Button(Stock::REMOVE));
 148         btn_remove->set_sensitive (false);
 149         set_tooltip(*btn_remove, _("Remove a plugin from the effect list"));
 150
 151         btn_add->set_name("PluginSelectorButton");
 152         btn_remove->set_name("PluginSelectorButton");
 153
 154
 155         Gtk::Table* table = manage(new Gtk::Table(7, 11));
 156         table->set_size_request(750, 500);
 157
 158         Gtk::Table* filter_table = manage(new Gtk::Table(2, 5));
 159
 160         fil_hidden_button.set_name ("pluginlist hide button");
 161         fil_hidden_button.set_text (_("Show Hidden"));
 162         fil_hidden_button.set_active (_show_hidden);
 163         set_tooltip (fil_hidden_button, _("Include hidden plugins in list."));
 164
 165         fil_instruments_button.set_name ("pluginlist filter button");
 166         fil_instruments_button.set_text (_("Instruments"));
 167         fil_instruments_button.set_active_state (_show_instruments);
 168         set_tooltip (fil_instruments_button, _("Cycle display of instrument plugins (if any)."));
 169
 170         fil_analysis_button.set_name ("pluginlist filter button");
 171         fil_analysis_button.set_text (_("Analyzers"));
 172         fil_analysis_button.set_active_state (_show_analysers);
 173         set_tooltip (fil_analysis_button, _("Cycle display of analysis plugins (if any)."));
 174
 175         fil_utils_button.set_name ("pluginlist filter button");
 176         fil_utils_button.set_text (_("Utils"));
 177         fil_utils_button.set_active_state (_show_utils);
 178         set_tooltip (fil_utils_button, _("Cycle display of utility plugins (if any)."));
 179
 180         vector<string> filter_strings = I18N (_filter_mode_strings);
 181         Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
 182         filter_mode.set_active_text (filter_strings.front());
 183
 184         fil_hidden_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_hidden_button_release), false);
 185         fil_instruments_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_instruments_button_release), false);
 186         fil_analysis_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_analysis_button_release), false);
 187         fil_utils_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_utils_button_release), false);
 188
 189         filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
 190         filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
 191         filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
 192
 193         filter_table->attach (filter_mode,            0, 1, 0, 1, FILL, FILL);
 194         filter_table->attach (filter_entry,           1, 4, 0, 1, FILL|EXPAND, FILL);
 195         filter_table->attach (filter_button,          4, 5, 0, 1, FILL, FILL);
 196
 197         filter_table->attach (fil_hidden_button,      1, 2, 1, 2, FILL, FILL);
 198         filter_table->attach (fil_instruments_button, 2, 3, 1, 2, FILL, FILL);
 199         filter_table->attach (fil_analysis_button,    3, 4, 1, 2, FILL, FILL);
 200         filter_table->attach (fil_utils_button,       4, 5, 1, 2, FILL, FILL);
 201
 202         filter_table->set_border_width (4);
 203         filter_table->set_col_spacings (2);
 204         filter_table->set_row_spacings (4);
 205
 206         Frame* filter_frame = manage (new Frame);
 207         filter_frame->set_name ("BaseFrame");
 208         filter_frame->set_label (_("Filter"));
 209         filter_frame->add (*filter_table);
 210
 211         filter_frame->show_all ();
 212
 213         table->attach (scroller, 0, 7, 0, 5);
 214         table->attach (*filter_frame, 0, 7, 6, 7, FILL|EXPAND, FILL, 5, 5);
 215         table->attach(*btn_add, 1, 2, 7, 8, FILL, FILL, 5, 5);
 216         table->attach(*btn_remove, 5, 6, 7, 8, FILL, FILL, 5, 5);
 217
 218         table->attach(ascroller, 0, 7, 8, 10);
 219
 220         add_button (Stock::CLOSE, RESPONSE_CLOSE);
 221         add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
 222         set_default_response (RESPONSE_APPLY);
 223         set_response_sensitive (RESPONSE_APPLY, false);
 224         get_vbox()->pack_start (*table);
 225
 226         table->set_name("PluginSelectorTable");
 227         plugin_display.set_name("PluginSelectorDisplay");
 228         //plugin_display.set_name("PluginSelectorList");
 229         added_list.set_name("PluginSelectorList");
 230
 231         plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
 232         plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
 233         plugin_display.grab_focus();
 234
 235         btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
 236         btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
 237         added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
 238         added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
 239
 240         refill ();
 241 }
 242
 243 PluginSelector::~PluginSelector ()
 244 {
 245         delete _plugin_menu;
 246 }
 247
 248 void
 249 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
 250 {
 251         btn_add_clicked();
 252 }
 253
 254 void
 255 PluginSelector::added_row_clicked(GdkEventButton* event)
 256 {
 257         if (event->type == GDK_2BUTTON_PRESS)
 258                 btn_remove_clicked();
 259 }
 260
 261 bool
 262 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
 263 {
 264         std::string compstr;
 265         std::string mode = filter_mode.get_active_text ();
 266
 267         if (mode == _("Favorites only")) {
 268                 return manager.get_status (info) == PluginManager::Favorite;
 269         }
 270
 271         if (mode == _("Hidden only")) {
 272                 return manager.get_status (info) == PluginManager::Hidden;
 273         }
 274
 275         if (!_show_hidden && manager.get_status (info) == PluginManager::Hidden) {
 276                 return false;
 277         }
 278
 279         if (_show_instruments == Gtkmm2ext::Off && info->is_instrument()) {
 280                 return false;
 281         }
 282         if (_show_analysers == Gtkmm2ext::Off && info->in_category ("Analyser")) {
 283                 return false;
 284         }
 285         if (_show_utils == Gtkmm2ext::Off && info->in_category ("Utility")) {
 286                 return false;
 287         }
 288
 289         /* NB once lilv_node_as_string() does honor translation AND
 290          * the lv2 onthology provides localized class name,
 291          * PluginInfo will need methods for Util & Analysis.
 292          */
 293         bool exp_ok = false;
 294         if (_show_instruments == Gtkmm2ext::ExplicitActive && info->is_instrument()) {
 295                 exp_ok = true;
 296         }
 297         if (_show_analysers == Gtkmm2ext::ExplicitActive && info->in_category ("Analyser")) {
 298                 exp_ok = true;
 299         }
 300         if (_show_utils == Gtkmm2ext::ExplicitActive && info->in_category ("Utility")) {
 301                 exp_ok = true;
 302         }
 303         if (_show_instruments == Gtkmm2ext::ExplicitActive  || _show_analysers == Gtkmm2ext::ExplicitActive || _show_utils == Gtkmm2ext::ExplicitActive) {
 304                 if (!exp_ok) {
 305                         return false;
 306                 }
 307         }
 308
 309         if (!filterstr.empty()) {
 310
 311                 if (mode == _("Name contains")) {
 312                         compstr = info->name;
 313                 } else if (mode == _("Category contains")) {
 314                         compstr = info->category;
 315                 } else if (mode == _("Type contains")) {
 316
 317                         switch (info->type) {
 318                         case LADSPA:
 319                                 compstr = X_("LADSPA");
 320                                 break;
 321                         case AudioUnit:
 322                                 compstr = X_("AudioUnit");
 323                                 break;
 324                         case LV2:
 325                                 compstr = X_("LV2");
 326                                 break;
 327                         case Windows_VST:
 328                                 compstr = X_("VST");
 329                                 break;
 330                         case LXVST:
 331                                 compstr = X_("LXVST");
 332                                 break;
 333                         }
 334
 335                 } else if (mode == _("Author contains")) {
 336                         compstr = info->creator;
 337                 } else if (mode == _("Library contains")) {
 338                         compstr = info->path;
 339                 }
 340
 341                 if (compstr.empty()) {
 342                         return false;
 343                 }
 344
 345                 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
 346
 347                 if (compstr.find (filterstr) != string::npos) {
 348                         return true;
 349                 } else {
 350                         return false;
 351                 }
 352         }
 353
 354         return true;
 355 }
 356
 357 void
 358 PluginSelector::setup_filter_string (string& filterstr)
 359 {
 360         filterstr = filter_entry.get_text ();
 361         transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
 362 }
 363
 364 void
 365 PluginSelector::refill ()
 366 {
 367         std::string filterstr;
 368
 369         in_row_change = true;
 370
 371         plugin_model->clear ();
 372
 373         setup_filter_string (filterstr);
 374
 375         ladspa_refiller (filterstr);
 376         lv2_refiller (filterstr);
 377         vst_refiller (filterstr);
 378         lxvst_refiller (filterstr);
 379         au_refiller (filterstr);
 380
 381         in_row_change = false;
 382 }
 383
 384 void
 385 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
 386 {
 387         char buf[16];
 388
 389         for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
 390
 391                 if (show_this_plugin (*i, filterstr)) {
 392
 393                         TreeModel::Row newrow = *(plugin_model->append());
 394                         newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
 395                         newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
 396                         newrow[plugin_columns.name] = (*i)->name;
 397                         newrow[plugin_columns.type_name] = type;
 398                         newrow[plugin_columns.category] = (*i)->category;
 399
 400                         string creator = (*i)->creator;
 401                         string::size_type pos = 0;
 402
 403                         /* stupid LADSPA creator strings */
 404 #ifdef PLATFORM_WINDOWS
 405                         while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
 406 #else
 407                         while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
 408 #endif
 409                         // If there were too few characters to create a
 410                         // meaningful name, mark this creator as 'Unknown'
 411                         if (creator.length()<2 || pos<3)
 412                                 creator = "Unknown";
 413                         else
 414                                 creator = creator.substr (0, pos);
 415
 416                         newrow[plugin_columns.creator] = creator;
 417
 418                         if ((*i)->reconfigurable_io ()) {
 419                                 newrow[plugin_columns.audio_ins] = _("variable");
 420                                 newrow[plugin_columns.midi_ins] = _("variable");
 421                                 newrow[plugin_columns.audio_outs] = _("variable");
 422                                 newrow[plugin_columns.midi_outs] = _("variable");
 423                         } else {
 424                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
 425                                 newrow[plugin_columns.audio_ins] = buf;
 426                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
 427                                 newrow[plugin_columns.midi_ins] = buf;
 428
 429                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
 430                                 newrow[plugin_columns.audio_outs] = buf;
 431                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
 432                                 newrow[plugin_columns.midi_outs] = buf;
 433                         }
 434
 435                         newrow[plugin_columns.plugin] = *i;
 436                 }
 437         }
 438 }
 439
 440 void
 441 PluginSelector::ladspa_refiller (const std::string& filterstr)
 442 {
 443         refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
 444 }
 445
 446 void
 447 PluginSelector::lv2_refiller (const std::string& filterstr)
 448 {
 449 #ifdef LV2_SUPPORT
 450         refiller (manager.lv2_plugin_info(), filterstr, "LV2");
 451 #endif
 452 }
 453
 454 void
 455 #ifdef WINDOWS_VST_SUPPORT
 456 PluginSelector::vst_refiller (const std::string& filterstr)
 457 #else
 458 PluginSelector::vst_refiller (const std::string&)
 459 #endif
 460 {
 461 #ifdef WINDOWS_VST_SUPPORT
 462         refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
 463 #endif
 464 }
 465
 466 void
 467 #ifdef LXVST_SUPPORT
 468 PluginSelector::lxvst_refiller (const std::string& filterstr)
 469 #else
 470 PluginSelector::lxvst_refiller (const std::string&)
 471 #endif
 472 {
 473 #ifdef LXVST_SUPPORT
 474         refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
 475 #endif
 476 }
 477
 478 void
 479 #ifdef AUDIOUNIT_SUPPORT
 480 PluginSelector::au_refiller (const std::string& filterstr)
 481 #else
 482 PluginSelector::au_refiller (const std::string&)
 483 #endif
 484 {
 485 #ifdef AUDIOUNIT_SUPPORT
 486         refiller (manager.au_plugin_info(), filterstr, "AU");
 487 #endif
 488 }
 489
 490 PluginPtr
 491 PluginSelector::load_plugin (PluginInfoPtr pi)
 492 {
 493         if (_session == 0) {
 494                 return PluginPtr();
 495         }
 496
 497         return pi->load (*_session);
 498 }
 499
 500 void
 501 PluginSelector::btn_add_clicked()
 502 {
 503         std::string name;
 504         PluginInfoPtr pi;
 505         TreeModel::Row newrow = *(amodel->append());
 506         TreeModel::Row row;
 507
 508         row = *(plugin_display.get_selection()->get_selected());
 509         name = row[plugin_columns.name];
 510         pi = row[plugin_columns.plugin];
 511
 512         newrow[acols.text] = name;
 513         newrow[acols.plugin] = pi;
 514
 515         if (!amodel->children().empty()) {
 516                 set_response_sensitive (RESPONSE_APPLY, true);
 517         }
 518 }
 519
 520 void
 521 PluginSelector::btn_remove_clicked()
 522 {
 523         TreeModel::iterator iter = added_list.get_selection()->get_selected();
 524
 525         amodel->erase(iter);
 526         if (amodel->children().empty()) {
 527                 set_response_sensitive (RESPONSE_APPLY, false);
 528         }
 529 }
 530
 531 void
 532 PluginSelector::display_selection_changed()
 533 {
 534         if (plugin_display.get_selection()->count_selected_rows() != 0) {
 535                 btn_add->set_sensitive (true);
 536         } else {
 537                 btn_add->set_sensitive (false);
 538         }
 539 }
 540
 541 void
 542 PluginSelector::added_list_selection_changed()
 543 {
 544         if (added_list.get_selection()->count_selected_rows() != 0) {
 545                 btn_remove->set_sensitive (true);
 546         } else {
 547                 btn_remove->set_sensitive (false);
 548         }
 549 }
 550
 551 int
 552 PluginSelector::run ()
 553 {
 554         ResponseType r;
 555         TreeModel::Children::iterator i;
 556
 557         bool finish = false;
 558
 559         while (!finish) {
 560
 561                 SelectedPlugins plugins;
 562                 r = (ResponseType) Dialog::run ();
 563
 564                 switch (r) {
 565                 case RESPONSE_APPLY:
 566                         for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
 567                                 PluginInfoPtr pp = (*i)[acols.plugin];
 568                                 PluginPtr p = load_plugin (pp);
 569                                 if (p) {
 570                                         plugins.push_back (p);
 571                                 } else {
 572                                         MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
 573                                         msg.run ();
 574                                 }
 575                         }
 576                         if (interested_object && !plugins.empty()) {
 577                                 finish = !interested_object->use_plugins (plugins);
 578                         }
 579
 580                         break;
 581
 582                 default:
 583                         finish = true;
 584                         break;
 585                 }
 586         }
 587
 588
 589         hide();
 590         amodel->clear();
 591         interested_object = 0;
 592
 593         return (int) r;
 594 }
 595
 596 void
 597 PluginSelector::filter_button_clicked ()
 598 {
 599         filter_entry.set_text ("");
 600 }
 601
 602 void
 603 PluginSelector::filter_entry_changed ()
 604 {
 605         refill ();
 606 }
 607
 608 void
 609 PluginSelector::filter_mode_changed ()
 610 {
 611         std::string mode = filter_mode.get_active_text ();
 612
 613         if (mode == _("Favorites only") || mode == _("Hidden only")) {
 614                 filter_entry.set_sensitive (false);
 615                 filter_button.set_sensitive (false);
 616                 fil_hidden_button.set_sensitive (false);
 617                 fil_instruments_button.set_sensitive (false);
 618                 fil_analysis_button.set_sensitive (false);
 619                 fil_utils_button.set_sensitive (false);
 620         } else {
 621                 filter_entry.set_sensitive (true);
 622                 filter_button.set_sensitive (true);
 623                 fil_hidden_button.set_sensitive (true);
 624                 fil_instruments_button.set_sensitive (true);
 625                 fil_analysis_button.set_sensitive (true);
 626                 fil_utils_button.set_sensitive (true);
 627         }
 628
 629         refill ();
 630 }
 631
 632 void
 633 PluginSelector::on_show ()
 634 {
 635         ArdourDialog::on_show ();
 636         filter_entry.grab_focus ();
 637 }
 638
 639 struct PluginMenuCompareByCreator {
 640     bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
 641             int cmp;
 642
 643             cmp = cmp_nocase_utf8 (a->creator, b->creator);
 644
 645             if (cmp < 0) {
 646                     return true;
 647             } else if (cmp == 0) {
 648                     /* same creator ... compare names */
 649                     if (cmp_nocase_utf8 (a->name, b->name) < 0) {
 650                             return true;
 651                     }
 652             }
 653             return false;
 654     }
 655 };
 656
 657 struct PluginMenuCompareByName {
 658     bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
 659             int cmp;
 660
 661             cmp = cmp_nocase_utf8 (a->name, b->name);
 662
 663             if (cmp < 0) {
 664                     return true;
 665             } else if (cmp == 0) {
 666                     /* same name ... compare type */
 667                     if (a->type < b->type) {
 668                             return true;
 669                     }
 670             }
 671             return false;
 672     }
 673 };
 674
 675 struct PluginMenuCompareByCategory {
 676     bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
 677             int cmp;
 678
 679             cmp = cmp_nocase_utf8 (a->category, b->category);
 680
 681             if (cmp < 0) {
 682                     return true;
 683             } else if (cmp == 0) {
 684                     /* same category ... compare names */
 685                     if (cmp_nocase_utf8 (a->name, b->name) < 0) {
 686                             return true;
 687                     }
 688             }
 689             return false;
 690     }
 691 };
 692
 693 /** @return Plugin menu. The caller should not delete it */
 694 Gtk::Menu*
 695 PluginSelector::plugin_menu()
 696 {
 697         return _plugin_menu;
 698 }
 699
 700 void
 701 PluginSelector::build_plugin_menu ()
 702 {
 703         PluginInfoList all_plugs;
 704
 705         all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
 706 #ifdef WINDOWS_VST_SUPPORT
 707         all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
 708 #endif
 709 #ifdef LXVST_SUPPORT
 710         all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
 711 #endif
 712 #ifdef AUDIOUNIT_SUPPORT
 713         all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
 714 #endif
 715 #ifdef LV2_SUPPORT
 716         all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
 717 #endif
 718
 719         using namespace Menu_Helpers;
 720
 721         delete _plugin_menu;
 722
 723         _plugin_menu = manage (new Menu);
 724         _plugin_menu->set_name("ArdourContextMenu");
 725
 726         MenuList& items = _plugin_menu->items();
 727         items.clear ();
 728
 729         Gtk::Menu* favs = create_favs_menu(all_plugs);
 730         items.push_back (MenuElem (_("Favorites"), *manage (favs)));
 731
 732         items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
 733         items.push_back (SeparatorElem ());
 734
 735         Menu* by_creator = create_by_creator_menu(all_plugs);
 736         items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
 737
 738         Menu* by_category = create_by_category_menu(all_plugs);
 739         items.push_back (MenuElem (_("By Category"), *manage (by_category)));
 740 }
 741
 742 Gtk::Menu*
 743 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
 744 {
 745         using namespace Menu_Helpers;
 746
 747         Menu* favs = new Menu();
 748         favs->set_name("ArdourContextMenu");
 749
 750         PluginMenuCompareByName cmp_by_name;
 751         all_plugs.sort (cmp_by_name);
 752
 753         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
 754                 if (manager.get_status (*i) == PluginManager::Favorite) {
 755                         MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
 756                         elem.get_child()->set_use_underline (false);
 757                         favs->items().push_back (elem);
 758                 }
 759         }
 760         return favs;
 761 }
 762
 763 Gtk::Menu*
 764 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
 765 {
 766         using namespace Menu_Helpers;
 767
 768         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
 769         SubmenuMap creator_submenu_map;
 770
 771         Menu* by_creator = new Menu();
 772         by_creator->set_name("ArdourContextMenu");
 773
 774         MenuList& by_creator_items = by_creator->items();
 775         PluginMenuCompareByCreator cmp_by_creator;
 776         all_plugs.sort (cmp_by_creator);
 777
 778         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
 779
 780                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
 781
 782                 string creator = (*i)->creator;
 783
 784                 /* stupid LADSPA creator strings */
 785                 string::size_type pos = 0;
 786 #ifdef PLATFORM_WINDOWS
 787                 while (pos < creator.length() && creator[pos]>(-2) && creator[pos]<256 && (isprint (creator[pos]))) ++pos;
 788 #else
 789                 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
 790 #endif
 791
 792                 // Check to see if we found any invalid characters.
 793                 if (creator.length() != pos) {
 794                         // If there were too few characters to create a
 795                         // meaningful name, mark this creator as 'Unknown'
 796                         if (pos<3)
 797                                 creator = "Unknown?";
 798                         else
 799                                 creator = creator.substr (0, pos);
 800                 }
 801
 802                 SubmenuMap::iterator x;
 803                 Gtk::Menu* submenu;
 804                 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
 805                         submenu = x->second;
 806                 } else {
 807                         submenu = new Gtk::Menu;
 808                         by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
 809                         creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
 810                         submenu->set_name("ArdourContextMenu");
 811                 }
 812                 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
 813                 elem.get_child()->set_use_underline (false);
 814                 submenu->items().push_back (elem);
 815         }
 816         return by_creator;
 817 }
 818
 819 Gtk::Menu*
 820 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
 821 {
 822         using namespace Menu_Helpers;
 823
 824         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
 825         SubmenuMap category_submenu_map;
 826
 827         Menu* by_category = new Menu();
 828         by_category->set_name("ArdourContextMenu");
 829
 830         MenuList& by_category_items = by_category->items();
 831         PluginMenuCompareByCategory cmp_by_category;
 832         all_plugs.sort (cmp_by_category);
 833
 834         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
 835
 836                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
 837
 838                 string category = (*i)->category;
 839
 840                 SubmenuMap::iterator x;
 841                 Gtk::Menu* submenu;
 842                 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
 843                         submenu = x->second;
 844                 } else {
 845                         submenu = new Gtk::Menu;
 846                         by_category_items.push_back (MenuElem (category, *manage (submenu)));
 847                         category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
 848                         submenu->set_name("ArdourContextMenu");
 849                 }
 850                 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
 851                 elem.get_child()->set_use_underline (false);
 852                 submenu->items().push_back (elem);
 853         }
 854         return by_category;
 855 }
 856
 857 void
 858 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
 859 {
 860         PluginPtr p = load_plugin (pi);
 861
 862         if (p && interested_object) {
 863                 SelectedPlugins plugins;
 864                 plugins.push_back (p);
 865                 interested_object->use_plugins (plugins);
 866         }
 867
 868         interested_object = 0;
 869 }
 870
 871 void
 872 PluginSelector::favorite_changed (const std::string& path)
 873 {
 874         PluginInfoPtr pi;
 875
 876         if (in_row_change) {
 877                 return;
 878         }
 879
 880         in_row_change = true;
 881
 882         TreeModel::iterator iter = plugin_model->get_iter (path);
 883
 884         if (iter) {
 885
 886                 bool favorite = !(*iter)[plugin_columns.favorite];
 887
 888                 /* change state */
 889
 890                 (*iter)[plugin_columns.favorite] = favorite;
 891                 (*iter)[plugin_columns.hidden] = false;
 892                 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
 893
 894                 /* save new statuses list */
 895
 896                 pi = (*iter)[plugin_columns.plugin];
 897
 898                 manager.set_status (pi->type, pi->unique_id, status);
 899
 900                 manager.save_statuses ();
 901
 902                 build_plugin_menu ();
 903         }
 904         in_row_change = false;
 905 }
 906
 907 void
 908 PluginSelector::hidden_changed (const std::string& path)
 909 {
 910         PluginInfoPtr pi;
 911
 912         if (in_row_change) {
 913                 return;
 914         }
 915
 916         in_row_change = true;
 917
 918         TreeModel::iterator iter = plugin_model->get_iter (path);
 919
 920         if (iter) {
 921
 922                 bool hidden = !(*iter)[plugin_columns.hidden];
 923
 924                 /* change state */
 925
 926                 (*iter)[plugin_columns.favorite] = false;
 927                 (*iter)[plugin_columns.hidden] = hidden;
 928                 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
 929
 930                 /* save new statuses list */
 931
 932                 pi = (*iter)[plugin_columns.plugin];
 933
 934                 manager.set_status (pi->type, pi->unique_id, status);
 935
 936                 manager.save_statuses ();
 937
 938                 build_plugin_menu ();
 939         }
 940         in_row_change = false;
 941 }
 942
 943 bool
 944 PluginSelector::fil_hidden_button_release (GdkEventButton*)
 945 {
 946         _show_hidden = (fil_hidden_button.active_state() == 0);
 947         fil_hidden_button.set_active (_show_hidden);
 948         refill ();
 949         return false;
 950 }
 951
 952 static Gtkmm2ext::ActiveState next_state (Gtkmm2ext::ActiveState s){
 953         switch (s) {
 954                 case Gtkmm2ext::Off:
 955                         return Gtkmm2ext::ImplicitActive;
 956                         break;
 957                 case Gtkmm2ext::ImplicitActive:
 958                         return Gtkmm2ext::ExplicitActive;
 959                         break;
 960                 case Gtkmm2ext::ExplicitActive:
 961                         return Gtkmm2ext::Off;
 962                         break;
 963                 default: assert(0); break; // not reached
 964         }
 965 }
 966
 967 static Gtkmm2ext::ActiveState prev_state (Gtkmm2ext::ActiveState s){
 968         switch (s) {
 969                 case Gtkmm2ext::Off:
 970                         return Gtkmm2ext::ExplicitActive;
 971                         break;
 972                 case Gtkmm2ext::ImplicitActive:
 973                         return Gtkmm2ext::Off;
 974                         break;
 975                 case Gtkmm2ext::ExplicitActive:
 976                         return Gtkmm2ext::ImplicitActive;
 977                         break;
 978                 default: assert(0); break; // not reached
 979         }
 980 }
 981
 982 bool
 983 PluginSelector::fil_instruments_button_release (GdkEventButton* ev)
 984 {
 985         if (ev->button == 3) {
 986                 _show_instruments = prev_state (fil_instruments_button.active_state());
 987         } else {
 988                 _show_instruments = next_state (fil_instruments_button.active_state());
 989         }
 990         fil_instruments_button.set_active_state (_show_instruments);
 991         refill ();
 992         return false;
 993 }
 994
 995 bool
 996 PluginSelector::fil_analysis_button_release (GdkEventButton* ev)
 997 {
 998         if (ev->button == 3) {
 999                 _show_analysers = prev_state (fil_analysis_button.active_state());
1000         } else {
1001                 _show_analysers = next_state (fil_analysis_button.active_state());
1002         }
1003         fil_analysis_button.set_active_state (_show_analysers);
1004         refill ();
1005         return false;
1006 }
1007
1008 bool
1009 PluginSelector::fil_utils_button_release (GdkEventButton* ev)
1010 {
1011         if (ev->button == 3) {
1012                 _show_utils = prev_state (fil_utils_button.active_state());
1013         } else {
1014                 _show_utils = next_state (fil_utils_button.active_state());
1015         }
1016         fil_utils_button.set_active_state (_show_utils);
1017         refill ();
1018         return false;
1019 }
1020
1021 void
1022 PluginSelector::show_manager ()
1023 {
1024         show_all();
1025         run ();
1026 }
1027
1028 void
1029 PluginSelector::set_interested_object (PluginInterestedObject& obj)
1030 {
1031         interested_object = &obj;
1032 }