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