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