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