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