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