Speed up Plugin status changes
[ardour.git] / 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/button.h>
29 #include <gtkmm/comboboxtext.h>
30 #include <gtkmm/frame.h>
31 #include <gtkmm/messagedialog.h>
32 #include <gtkmm/notebook.h>
33 #include <gtkmm/stock.h>
34 #include <gtkmm/table.h>
35 #include <gtkmm/treestore.h>
36
37 #include "gtkmm2ext/utils.h"
38
39 #include "widgets/tooltips.h"
40
41 #include "pbd/convert.h"
42 #include "pbd/tokenizer.h"
43
44 #include "ardour/utils.h"
45
46 #include "plugin_selector.h"
47 #include "gui_thread.h"
48 #include "ui_config.h"
49
50 #include "pbd/i18n.h"
51
52 using namespace ARDOUR;
53 using namespace PBD;
54 using namespace Gtk;
55 using namespace std;
56 using namespace ArdourWidgets;
57
58 static const uint32_t MAX_CREATOR_LEN = 24;
59
60 PluginSelector::PluginSelector (PluginManager& mgr)
61         : ArdourDialog (_("Plugin Manager"), true, false)
62         , search_clear_button (Stock::CLEAR)
63         , manager (mgr)
64         , _need_tag_save (false)
65         , _need_status_save (false)
66         , _need_menu_rebuild (false)
67         , _inhibit_refill (false)
68 {
69         set_name ("PluginSelectorWindow");
70         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
71
72         _plugin_menu = 0;
73         in_row_change = false;
74
75         manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
76         manager.PluginStatusChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
77
78         manager.PluginStatusChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::plugin_status_changed, this, _1, _2, _3), gui_context());
79         manager.PluginTagChanged.connect(plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::tags_changed, this, _1, _2, _3), gui_context());
80
81         plugin_model = Gtk::ListStore::create (plugin_columns);
82         plugin_display.set_model (plugin_model);
83         /* XXX translators: try to convert "Fav" into a short term
84          * related to "favorite" and "Hid" into a short term
85          * related to "hidden"
86          */
87         plugin_display.append_column (_("Fav"), plugin_columns.favorite);
88         plugin_display.append_column (_("Hide"), plugin_columns.hidden);
89         plugin_display.append_column (_("Name"), plugin_columns.name);
90         plugin_display.append_column (_("Tags"), plugin_columns.tags);
91         plugin_display.append_column (_("Creator"), plugin_columns.creator);
92         plugin_display.append_column (_("Type"), plugin_columns.type_name);
93         plugin_display.append_column (_("Audio I/O"),plugin_columns.audio_io);
94         plugin_display.append_column (_("MIDI I/O"), plugin_columns.midi_io);
95         plugin_display.set_headers_visible (true);
96         plugin_display.set_headers_clickable (true);
97         plugin_display.set_reorderable (false);
98         plugin_display.set_rules_hint (true);
99         plugin_display.add_object_drag (plugin_columns.plugin.index(), "PluginInfoPtr");
100         plugin_display.set_drag_column (plugin_columns.name.index());
101
102         // setting a sort-column prevents re-ordering via Drag/Drop
103         plugin_model->set_sort_column (plugin_columns.name.index(), Gtk::SORT_ASCENDING);
104
105         plugin_display.set_name("PluginSelectorDisplay");
106         plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
107         plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
108
109         CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
110         fav_cell->property_activatable() = true;
111         fav_cell->property_radio() = true;
112         fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
113
114         CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
115         hidden_cell->property_activatable() = true;
116         hidden_cell->property_radio() = true;
117         hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
118
119         scroller.set_border_width(10);
120         scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
121         scroller.add(plugin_display);
122
123         amodel = Gtk::ListStore::create(acols);
124         added_list.set_model (amodel);
125         added_list.append_column (_("Plugins to be connected"), acols.text);
126         added_list.set_headers_visible (true);
127         added_list.set_reorderable (false);
128
129         for (int i = 2; i <= 7; ++i) {
130                 Gtk::TreeView::Column* column = plugin_display.get_column(i);
131                 if (column) {
132                         column->set_sort_column(i);
133                 }
134         }
135
136         ascroller.set_border_width(10);
137         ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
138         ascroller.add(added_list);
139         btn_add = manage(new Gtk::Button(Stock::ADD));
140         set_tooltip(*btn_add, _("Add a plugin to the effect list"));
141         btn_add->set_sensitive (false);
142         btn_remove = manage(new Gtk::Button(Stock::REMOVE));
143         btn_remove->set_sensitive (false);
144         set_tooltip(*btn_remove, _("Remove a plugin from the effect list"));
145
146         btn_add->set_name("PluginSelectorButton");
147         btn_remove->set_name("PluginSelectorButton");
148
149         /* SEARCH */
150
151         Gtk::Table* search_table = manage(new Gtk::Table(2, 2));
152
153         search_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::search_entry_changed));
154         search_clear_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::search_clear_button_clicked));
155
156         _search_name_checkbox = manage (new ArdourButton (_("Name"), ArdourButton::led_default_elements, true));
157         _search_name_checkbox->set_active(true);
158         _search_name_checkbox->set_name ("pluginlist filter button");
159
160         _search_tags_checkbox = manage (new ArdourButton (_("Tags"), ArdourButton::led_default_elements, true));
161         _search_tags_checkbox->set_active(true);
162         _search_tags_checkbox->set_name ("pluginlist filter button");
163
164         _search_ignore_checkbox = manage (new ArdourButton(_("Ignore Filters when searching"), ArdourButton::led_default_elements, true));
165         _search_ignore_checkbox->set_active(true);
166         _search_ignore_checkbox->set_name ("pluginlist filter button");
167
168         Gtk::Label* search_help_label1 = manage (new Label(
169                 _("All search terms must be matched."), Gtk::ALIGN_LEFT));
170
171         Gtk::Label* search_help_label2 = manage (new Label(
172                 _("Ex: \"ess dyn\" will find \"dynamic de-esser\" but not \"de-esser\"."), Gtk::ALIGN_LEFT));
173
174         search_table->attach (search_entry,            0, 3, 0, 1, FILL|EXPAND, FILL);
175         search_table->attach (search_clear_button,     3, 4, 0, 1, FILL, FILL);
176         search_table->attach (*_search_name_checkbox,  0, 1, 1, 2, FILL, FILL);
177         search_table->attach (*_search_tags_checkbox,  1, 2, 1, 2, FILL, FILL);
178         search_table->attach (*_search_ignore_checkbox,2, 3, 1, 2, FILL, FILL);
179         search_table->attach (*search_help_label1,     0, 3, 2, 3, FILL, FILL);
180         search_table->attach (*search_help_label2,     0, 3, 3, 4, FILL, FILL);
181
182         search_table->set_border_width (4);
183         search_table->set_col_spacings (4);
184         search_table->set_row_spacings (4);
185
186         Frame* search_frame = manage (new Frame);
187         search_frame->set_name ("BaseFrame");
188         search_frame->set_label (_("Search"));
189         search_frame->add (*search_table);
190         search_frame->show_all ();
191
192         _search_name_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::refill));
193         _search_tags_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::refill));
194         _search_ignore_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::set_sensitive_widgets));
195
196         /* FILTER */
197
198         Gtk::RadioButtonGroup fil_radio_group;
199
200         _fil_effects_radio = manage (new RadioButton (fil_radio_group, _("Show Effects Only")));
201         _fil_instruments_radio = manage (new RadioButton (fil_radio_group, _("Show Instruments Only")));
202         _fil_utils_radio = manage (new RadioButton (fil_radio_group, _("Show Utilities Only")));
203         _fil_favorites_radio = manage (new RadioButton (fil_radio_group, _("Show Favorites Only")));
204         _fil_hidden_radio = manage (new RadioButton (fil_radio_group, _("Show Hidden Only")));
205         _fil_all_radio = manage (new RadioButton (fil_radio_group, _("Show All")));
206
207         //_fil_type_combo = manage (new ComboBoxText);
208         _fil_type_combo.append_text_item (_("Show All Formats"));
209         _fil_type_combo.append_text_item (X_("VST"));
210 #ifdef AUDIOUNIT_SUPPORT
211         _fil_type_combo.append_text_item (X_("AudioUnit"));
212 #endif
213 #ifdef LV2_SUPPORT
214         _fil_type_combo.append_text_item (X_("LV2"));
215 #endif
216         _fil_type_combo.append_text_item (X_("Lua"));
217         _fil_type_combo.append_text_item (X_("LADSPA"));
218         _fil_type_combo.set_text (_("Show All Formats"));
219
220         /* note: _fil_creator_combo menu gets filled in build_plugin_menu */
221         _fil_creator_combo.set_text_ellipsize (Pango::ELLIPSIZE_END);
222         _fil_creator_combo.set_layout_ellipsize_width (PANGO_SCALE * 160 * UIConfiguration::instance ().get_ui_scale ());
223
224         VBox* filter_vbox = manage (new VBox);
225         filter_vbox->pack_start (*_fil_effects_radio,     false, false);
226         filter_vbox->pack_start (*_fil_instruments_radio, false, false);
227         filter_vbox->pack_start (*_fil_utils_radio,       false, false);
228         filter_vbox->pack_start (*_fil_favorites_radio,   false, false);
229         filter_vbox->pack_start (*_fil_hidden_radio,      false, false);
230         filter_vbox->pack_start (*_fil_all_radio,         false, false);
231         filter_vbox->pack_start (_fil_type_combo,         false, false);
232         filter_vbox->pack_start (_fil_creator_combo,      false, false);
233
234         filter_vbox->set_border_width (4);
235         filter_vbox->set_spacing (4);
236
237         Frame* filter_frame = manage (new Frame);
238         filter_frame->set_name ("BaseFrame");
239         filter_frame->set_label (_("Filter"));
240         filter_frame->add (*filter_vbox);
241         filter_frame->show_all ();
242
243         _fil_effects_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
244         _fil_instruments_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
245         _fil_utils_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
246         _fil_favorites_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
247         _fil_hidden_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
248
249         _fil_type_combo.StateChanged.connect (sigc::mem_fun (*this, &PluginSelector::refill));
250         _fil_creator_combo.StateChanged.connect (sigc::mem_fun (*this, &PluginSelector::refill));
251
252         /* TAG entry */
253
254         Gtk::Table* tagging_table = manage(new Gtk::Table(1, 2));
255         tagging_table->set_border_width (4);
256         tagging_table->set_col_spacings (4);
257         tagging_table->set_row_spacings (4);
258
259         tag_entry = manage (new Gtk::Entry);
260         tag_entry_connection = tag_entry->signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::tag_entry_changed));
261
262         tag_reset_button = manage (new Button (_("Reset")));
263         tag_reset_button->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::tag_reset_button_clicked));
264
265         Gtk::Label* tagging_help_label1 = manage (new Label(
266                 _("Enter space-separated, one-word Tags for the selected plugin."), Gtk::ALIGN_LEFT));
267
268         Gtk::Label* tagging_help_label2 = manage (new Label(
269                 _("You can include dashes, colons or underscores in a Tag."), Gtk::ALIGN_LEFT));
270
271         Gtk::Label* tagging_help_label3 = manage (new Label(
272                 _("Ex: \"dynamic de-esser vocal\" applies 3 Tags."), Gtk::ALIGN_LEFT));
273
274         int p = 0;
275         tagging_table->attach (*tag_entry,           0, 1, p, p+1, FILL|EXPAND, FILL);
276         tagging_table->attach (*tag_reset_button,    1, 2, p, p+1, FILL, FILL); p++;
277         tagging_table->attach (*tagging_help_label1, 0, 2, p, p+1, FILL, FILL); p++;
278         tagging_table->attach (*tagging_help_label2, 0, 2, p, p+1, FILL, FILL); p++;
279         tagging_table->attach (*tagging_help_label3, 0, 2, p, p+1, FILL, FILL); p++;
280
281         Frame* tag_frame = manage (new Frame);
282         tag_frame->set_name ("BaseFrame");
283         tag_frame->set_label (_("Tags for Selected Plugin"));
284         tag_frame->add (*tagging_table);
285         tag_frame->show_all ();
286
287         /* Add & remove buttons */
288
289         HBox* add_remove = manage (new HBox);
290         add_remove->pack_start (*btn_add, true, true);
291         add_remove->pack_start (*btn_remove, true, true);
292
293         btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
294         btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
295         added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
296         added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
297
298         added_list.set_name("PluginSelectorList");
299
300         /* Top-level Layout */
301
302         VBox* to_be_inserted_vbox = manage (new VBox);
303         to_be_inserted_vbox->pack_start (ascroller);
304         to_be_inserted_vbox->pack_start (*add_remove, false, false);
305         to_be_inserted_vbox->set_size_request (200, -1);
306
307         Gtk::Table* table = manage(new Gtk::Table(3, 3));
308         table->set_size_request(-1, 600);
309         table->attach (scroller,               0, 3, 0, 5); /* this is the main plugin list */
310         table->attach (*search_frame,          0, 1, 6, 7, FILL, FILL, 5, 5);
311         table->attach (*tag_frame,             0, 1, 7, 8, FILL, FILL, 5, 5);
312         table->attach (*filter_frame,          1, 2, 6, 8, FILL, FILL, 5, 5);
313         table->attach (*to_be_inserted_vbox,   2, 3, 6, 8, FILL|EXPAND, FILL, 5, 5); /* to be inserted... */
314
315         add_button (Stock::CLOSE, RESPONSE_CLOSE);
316         add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
317         set_default_response (RESPONSE_APPLY);
318         set_response_sensitive (RESPONSE_APPLY, false);
319         get_vbox()->pack_start (*table);
320
321         table->set_name("PluginSelectorTable");
322
323         plugin_display.grab_focus();
324
325         build_plugin_menu ();
326         display_selection_changed ();
327 }
328
329 PluginSelector::~PluginSelector ()
330 {
331         delete _plugin_menu;
332 }
333
334 void
335 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
336 {
337         btn_add_clicked();
338 }
339
340 void
341 PluginSelector::added_row_clicked(GdkEventButton* event)
342 {
343         if (event->type == GDK_2BUTTON_PRESS)
344                 btn_remove_clicked();
345 }
346
347 bool
348 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& searchstr)
349 {
350         string mode;
351         bool maybe_show = false;
352
353         if (!searchstr.empty()) {
354
355                 std::string compstr;
356
357                 if (_search_name_checkbox->get_active()) { /* name contains */
358                         compstr = info->name;
359                         transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
360                         if (compstr.find (searchstr) != string::npos) {
361                                 maybe_show = true;
362                         }
363                 }
364
365                 if (_search_tags_checkbox->get_active()) { /* tag contains */
366                         compstr = manager.get_tags_as_string (info);
367                         transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
368                         if (compstr.find (searchstr) != string::npos) {
369                                 maybe_show = true;
370                         }
371                 }
372
373                 if (!maybe_show) {
374                         return false;
375                 }
376
377                 /* user asked to ignore filters */
378                 if (maybe_show && _search_ignore_checkbox->get_active()) {
379                         if (manager.get_status (info) == PluginManager::Hidden) {
380                                 return false;
381                         }
382                         return true;
383                 }
384         }
385
386         if (_fil_effects_radio->get_active() && !info->is_effect()) {
387                 return false;
388         }
389
390         if (_fil_instruments_radio->get_active() && !info->is_instrument()) {
391                 return false;
392         }
393
394         if (_fil_utils_radio->get_active() && !(info->is_utility() || info->is_analyzer())) {
395                 return false;
396         }
397
398         if (_fil_favorites_radio->get_active() && !(manager.get_status (info) == PluginManager::Favorite)) {
399                 return false;
400         }
401
402         if (_fil_hidden_radio->get_active() && !(manager.get_status (info) == PluginManager::Hidden)) {
403                 return false;
404         }
405
406         if (!_fil_hidden_radio->get_active() && manager.get_status (info) == PluginManager::Hidden) {
407                 return false;
408         }
409
410         /* Filter "type" combobox */
411
412         if (_fil_type_combo.get_text() == X_("VST") && PluginManager::to_generic_vst(info->type) != LXVST) {
413                 return false;
414         }
415
416         if (_fil_type_combo.get_text() == X_("AudioUnit") && info->type != AudioUnit) {
417                 return false;
418         }
419
420 #ifdef LV2_SUPPORT
421         if (_fil_type_combo.get_text() == X_("LV2") && info->type != LV2) {
422                 return false;
423         }
424 #endif
425
426         if (_fil_type_combo.get_text() == X_("Lua") && info->type != Lua) {
427                 return false;
428         }
429
430         if (_fil_type_combo.get_text() == X_("LADSPA") && info->type != LADSPA) {
431                 return false;
432         }
433
434         /* Filter "creator" combobox */
435
436         if (_fil_creator_combo.get_text() != _("Show All Creators")) {
437                 if (_fil_creator_combo.get_text() != info->creator) {
438                         return false;
439                 }
440         }
441
442         return true;
443 }
444
445 void
446 PluginSelector::setup_search_string (string& searchstr)
447 {
448         searchstr = search_entry.get_text ();
449         transform (searchstr.begin(), searchstr.end(), searchstr.begin(), ::toupper);
450 }
451
452 void
453 PluginSelector::set_sensitive_widgets ()
454 {
455         if (_search_ignore_checkbox->get_active() && !search_entry.get_text().empty()) {
456                 _fil_effects_radio->set_sensitive(false);
457                 _fil_instruments_radio->set_sensitive(false);
458                 _fil_utils_radio->set_sensitive(false);
459                 _fil_favorites_radio->set_sensitive(false);
460                 _fil_hidden_radio->set_sensitive(false);
461                 _fil_all_radio->set_sensitive(false);
462                 _inhibit_refill = true;
463                 _fil_type_combo.set_sensitive(false);
464                 _fil_creator_combo.set_sensitive(false);
465                 _inhibit_refill = false;
466         } else {
467                 _fil_effects_radio->set_sensitive(true);
468                 _fil_instruments_radio->set_sensitive(true);
469                 _fil_utils_radio->set_sensitive(true);
470                 _fil_favorites_radio->set_sensitive(true);
471                 _fil_hidden_radio->set_sensitive(true);
472                 _fil_all_radio->set_sensitive(true);
473                 _inhibit_refill = true;
474                 _fil_type_combo.set_sensitive(true);
475                 _fil_creator_combo.set_sensitive(true);
476                 _inhibit_refill = false;
477         }
478         if (!search_entry.get_text().empty()) {
479                 refill ();
480         }
481 }
482
483 void
484 PluginSelector::refill ()
485 {
486         if (_inhibit_refill) {
487                 return;
488         }
489
490         std::string searchstr;
491
492         in_row_change = true;
493
494         plugin_display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
495
496         int sort_col;
497         SortType sort_type;
498         bool sorted = plugin_model->get_sort_column_id (sort_col, sort_type);
499
500         /* Disable sorting to gain performance */
501         plugin_model->set_sort_column (-2, SORT_ASCENDING);
502
503         plugin_model->clear ();
504
505         setup_search_string (searchstr);
506
507         ladspa_refiller (searchstr);
508         lv2_refiller (searchstr);
509         vst_refiller (searchstr);
510         lxvst_refiller (searchstr);
511         mac_vst_refiller (searchstr);
512         au_refiller (searchstr);
513         lua_refiller (searchstr);
514
515         in_row_change = false;
516
517         plugin_display.set_model (plugin_model);
518         if (sorted) {
519                 plugin_model->set_sort_column (sort_col, sort_type);
520         }
521 }
522
523 void
524 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& searchstr, const char* type)
525 {
526         char buf[16];
527
528         for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
529
530                 if (show_this_plugin (*i, searchstr)) {
531
532                         TreeModel::Row newrow = *(plugin_model->append());
533                         newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
534                         newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
535
536                         string name = (*i)->name;
537                         if (name.length() > 48) {
538                                 name = name.substr (0, 48);
539                                 name.append("...");
540                         }
541                         newrow[plugin_columns.name] = name;
542
543                         newrow[plugin_columns.type_name] = type;
544
545                         /* Creator */
546                         string creator = (*i)->creator;
547                         string::size_type pos = 0;
548                         if ((*i)->type == ARDOUR::LADSPA) {
549                                 /* stupid LADSPA creator strings */
550 #ifdef PLATFORM_WINDOWS
551                                 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
552 #else
553                                 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
554 #endif
555                         } else {
556                                 pos = creator.length ();
557                         }
558                         // If there were too few characters to create a
559                         // meaningful name, mark this creator as 'Unknown'
560                         if (creator.length() < 2 || pos < 3) {
561                                 creator = "Unknown";
562                         } else{
563                                 creator = creator.substr (0, pos);
564                         }
565
566                         if (creator.length() > MAX_CREATOR_LEN) {
567                                 creator = creator.substr (0, MAX_CREATOR_LEN);
568                                 creator.append("...");
569                         }
570                         newrow[plugin_columns.creator] = creator;
571
572                         /* Tags */
573                         string tags = manager.get_tags_as_string(*i);
574                         if (tags.length() > 32) {
575                                 tags = tags.substr (0, 32);
576                                 tags.append("...");
577                         }
578                         newrow[plugin_columns.tags] = tags;
579
580                         if ((*i)->reconfigurable_io ()) {
581                                 newrow[plugin_columns.audio_io] = "* / *";
582                                 newrow[plugin_columns.midi_io] = "* / *";
583                         } else {
584                                 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_audio(), (*i)->n_outputs.n_audio());
585                                 newrow[plugin_columns.audio_io] = buf;
586                                 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_midi(), (*i)->n_outputs.n_midi());
587                                 newrow[plugin_columns.midi_io] = buf;
588                         }
589
590                         newrow[plugin_columns.plugin] = *i;
591                 }
592         }
593 }
594
595 void
596 PluginSelector::ladspa_refiller (const std::string& searchstr)
597 {
598         refiller (manager.ladspa_plugin_info(), searchstr, "LADSPA");
599 }
600
601 void
602 PluginSelector::lua_refiller (const std::string& searchstr)
603 {
604         refiller (manager.lua_plugin_info(), searchstr, "Lua");
605 }
606
607 void
608 PluginSelector::lv2_refiller (const std::string& searchstr)
609 {
610 #ifdef LV2_SUPPORT
611         refiller (manager.lv2_plugin_info(), searchstr, "LV2");
612 #endif
613 }
614
615 void
616 #ifdef WINDOWS_VST_SUPPORT
617 PluginSelector::vst_refiller (const std::string& searchstr)
618 #else
619 PluginSelector::vst_refiller (const std::string&)
620 #endif
621 {
622 #ifdef WINDOWS_VST_SUPPORT
623         refiller (manager.windows_vst_plugin_info(), searchstr, "VST");
624 #endif
625 }
626
627 void
628 #ifdef LXVST_SUPPORT
629 PluginSelector::lxvst_refiller (const std::string& searchstr)
630 #else
631 PluginSelector::lxvst_refiller (const std::string&)
632 #endif
633 {
634 #ifdef LXVST_SUPPORT
635         refiller (manager.lxvst_plugin_info(), searchstr, "LXVST");
636 #endif
637 }
638
639 void
640 #ifdef MACVST_SUPPORT
641 PluginSelector::mac_vst_refiller (const std::string& searchstr)
642 #else
643 PluginSelector::mac_vst_refiller (const std::string&)
644 #endif
645 {
646 #ifdef MACVST_SUPPORT
647         refiller (manager.mac_vst_plugin_info(), searchstr, "MacVST");
648 #endif
649 }
650
651 void
652 #ifdef AUDIOUNIT_SUPPORT
653 PluginSelector::au_refiller (const std::string& searchstr)
654 #else
655 PluginSelector::au_refiller (const std::string&)
656 #endif
657 {
658 #ifdef AUDIOUNIT_SUPPORT
659         refiller (manager.au_plugin_info(), searchstr, "AU");
660 #endif
661 }
662
663 PluginPtr
664 PluginSelector::load_plugin (PluginInfoPtr pi)
665 {
666         if (_session == 0) {
667                 return PluginPtr();
668         }
669
670         return pi->load (*_session);
671 }
672
673 void
674 PluginSelector::btn_add_clicked()
675 {
676         if (plugin_display.get_selection()->count_selected_rows() == 0) {
677                 /* may happen with ctrl + double-click un-selecting but activating a row */
678                 return;
679         }
680         std::string name;
681         PluginInfoPtr pi;
682         TreeModel::Row newrow = *(amodel->append());
683         TreeModel::Row row;
684
685         row = *(plugin_display.get_selection()->get_selected());
686         name = row[plugin_columns.name];
687         pi = row[plugin_columns.plugin];
688
689         newrow[acols.text] = name;
690         newrow[acols.plugin] = pi;
691
692         if (!amodel->children().empty()) {
693                 set_response_sensitive (RESPONSE_APPLY, true);
694         }
695 }
696
697 void
698 PluginSelector::btn_remove_clicked()
699 {
700         TreeModel::iterator iter = added_list.get_selection()->get_selected();
701
702         amodel->erase(iter);
703         if (amodel->children().empty()) {
704                 set_response_sensitive (RESPONSE_APPLY, false);
705         }
706 }
707
708 void
709 PluginSelector::display_selection_changed()
710 {
711         tag_entry_connection.block ();
712         if (plugin_display.get_selection()->count_selected_rows() != 0) {
713
714                 /* a plugin row is selected; allow the user to edit the "tags" on it. */
715                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
716                 string tags = manager.get_tags_as_string (row[plugin_columns.plugin]);
717                 tag_entry->set_text (tags);
718
719                 tag_entry->set_sensitive (true);
720                 tag_reset_button->set_sensitive (true);
721                 btn_add->set_sensitive (true);
722
723         } else {
724                 tag_entry->set_text ("");
725
726                 tag_entry->set_sensitive (false);
727                 tag_reset_button->set_sensitive (false);
728                 btn_add->set_sensitive (false);
729         }
730         tag_entry_connection.unblock ();
731 }
732
733 void
734 PluginSelector::added_list_selection_changed()
735 {
736         if (added_list.get_selection()->count_selected_rows() != 0) {
737                 btn_remove->set_sensitive (true);
738         } else {
739                 btn_remove->set_sensitive (false);
740         }
741 }
742
743 int
744 PluginSelector::run ()
745 {
746         ResponseType r;
747         TreeModel::Children::iterator i;
748
749         bool finish = false;
750
751         while (!finish) {
752
753                 SelectedPlugins plugins;
754                 r = (ResponseType) Dialog::run ();
755
756                 switch (r) {
757                 case RESPONSE_APPLY:
758                         for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
759                                 PluginInfoPtr pp = (*i)[acols.plugin];
760                                 PluginPtr p = load_plugin (pp);
761                                 if (p) {
762                                         plugins.push_back (p);
763                                 } else {
764                                         MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
765                                         msg.run ();
766                                 }
767                         }
768                         if (interested_object && !plugins.empty()) {
769                                 finish = !interested_object->use_plugins (plugins);
770                         }
771
772                         break;
773
774                 default:
775                         finish = true;
776                         break;
777                 }
778         }
779
780
781         hide();
782         amodel->clear();
783         interested_object = 0;
784
785         if (_need_tag_save) {
786                 manager.save_tags();
787         }
788
789         if (_need_status_save) {
790                 manager.save_statuses();
791         }
792         if (_need_menu_rebuild) {
793                 build_plugin_menu ();
794         }
795
796         return (int) r;
797 }
798
799 void
800 PluginSelector::search_clear_button_clicked ()
801 {
802         search_entry.set_text ("");
803 }
804
805 void
806 PluginSelector::tag_reset_button_clicked ()
807 {
808         if (plugin_display.get_selection()->count_selected_rows() != 0) {
809                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
810                 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
811                 manager.reset_tags (pi);
812                 display_selection_changed ();
813                 _need_tag_save = true;
814         }
815 }
816
817 void
818 PluginSelector::search_entry_changed ()
819 {
820         set_sensitive_widgets();
821         if (search_entry.get_text().empty()) {
822                 refill ();
823         }
824 }
825
826 void
827 PluginSelector::tag_entry_changed ()
828 {
829         if (plugin_display.get_selection()->count_selected_rows() != 0) {
830                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
831
832                 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
833                 manager.set_tags (pi->type, pi->unique_id, tag_entry->get_text(), pi->name, PluginManager::FromGui);
834
835                 _need_tag_save = true;
836         }
837 }
838
839 void
840 PluginSelector::tags_changed (PluginType t, std::string unique_id, std::string tags)
841 {
842         if (plugin_display.get_selection()->count_selected_rows() != 0) {
843                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
844                 if (tags.length() > 32) {
845                         tags = tags.substr (0, 32);
846                         tags.append ("...");
847                 }
848                 row[plugin_columns.tags] = tags;
849         }
850 }
851
852 void
853 PluginSelector::plugin_status_changed (PluginType t, std::string uid, PluginManager::PluginStatusType stat)
854 {
855         Gtk::TreeModel::iterator i;
856         for (i = plugin_model->children().begin(); i != plugin_model->children().end(); ++i) {
857                 PluginInfoPtr pp = (*i)[plugin_columns.plugin];
858                 if ((pp->type == t) && (pp->unique_id == uid)) {
859                         (*i)[plugin_columns.favorite] = (stat == PluginManager::Favorite) ? true : false;
860                         (*i)[plugin_columns.hidden] = (stat == PluginManager::Hidden) ? true : false;
861
862                         /* if plug was hidden, remove it from the view */
863                         if (stat == PluginManager::Hidden) {
864                                 if (!_fil_hidden_radio->get_active() && !_fil_all_radio->get_active()) {
865                                         plugin_model->erase(i);
866                                 }
867                         } else if (_fil_hidden_radio->get_active()) {
868                                 plugin_model->erase(i);
869                         }
870                         /* if no longer a favorite, remove it from the view */
871                         if (stat != PluginManager::Favorite && _fil_favorites_radio->get_active()) {
872                                         plugin_model->erase(i);
873                         }
874
875                         return;
876                 }
877         }
878 }
879
880 void
881 PluginSelector::on_show ()
882 {
883         ArdourDialog::on_show ();
884         search_entry.grab_focus ();
885
886         refill ();
887
888         _need_tag_save = false;
889         _need_status_save = false;
890 }
891
892 struct PluginMenuCompareByCreator {
893         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
894                 int cmp;
895
896                 cmp = cmp_nocase_utf8 (a->creator, b->creator);
897
898                 if (cmp < 0) {
899                         return true;
900                 } else if (cmp == 0) {
901                         /* same creator ... compare names */
902                         if (cmp_nocase_utf8 (a->name, b->name) < 0) {
903                                 return true;
904                         }
905                 }
906                 return false;
907         }
908 };
909
910 struct PluginMenuCompareByName {
911         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
912                 int cmp;
913
914                 cmp = cmp_nocase_utf8 (a->name, b->name);
915
916                 if (cmp < 0) {
917                         return true;
918                 } else if (cmp == 0) {
919                         /* same name ... compare type */
920                         if (a->type < b->type) {
921                                 return true;
922                         }
923                 }
924                 return false;
925         }
926 };
927
928 /** @return Plugin menu. The caller should not delete it */
929 Gtk::Menu*
930 PluginSelector::plugin_menu()
931 {
932         return _plugin_menu;
933 }
934
935 void
936 PluginSelector::build_plugin_menu ()
937 {
938         if (is_visible ()) {
939                 _need_menu_rebuild = true;
940                 return;
941         }
942         _need_menu_rebuild = false;
943         PluginInfoList all_plugs;
944
945         all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
946         all_plugs.insert (all_plugs.end(), manager.lua_plugin_info().begin(), manager.lua_plugin_info().end());
947 #ifdef WINDOWS_VST_SUPPORT
948         all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
949 #endif
950 #ifdef LXVST_SUPPORT
951         all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
952 #endif
953 #ifdef MACVST_SUPPORT
954         all_plugs.insert (all_plugs.end(), manager.mac_vst_plugin_info().begin(), manager.mac_vst_plugin_info().end());
955 #endif
956 #ifdef AUDIOUNIT_SUPPORT
957         all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
958 #endif
959 #ifdef LV2_SUPPORT
960         all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
961 #endif
962
963         using namespace Menu_Helpers;
964
965         delete _plugin_menu;
966
967         _plugin_menu = new Menu;
968         _plugin_menu->set_name("ArdourContextMenu");
969
970         MenuList& items = _plugin_menu->items();
971         items.clear ();
972
973         Gtk::Menu* favs = create_favs_menu(all_plugs);
974         items.push_back (MenuElem (_("Favorites"), *manage (favs)));
975
976         items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
977         items.push_back (SeparatorElem ());
978
979         Menu* by_creator = create_by_creator_menu(all_plugs);
980         items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
981
982         Menu* by_tags = create_by_tags_menu(all_plugs);
983         items.push_back (MenuElem (_("By Tags"), *manage (by_tags)));
984 }
985
986 string
987 GetPluginTypeStr(PluginInfoPtr info)
988 {
989         string type;
990
991         switch (info->type) {
992         case LADSPA:
993                 type = X_(" (LADSPA)");
994                 break;
995         case AudioUnit:
996                 type = X_(" (AU)");
997                 break;
998         case LV2:
999                 type = X_(" (LV2)");
1000                 break;
1001         case Windows_VST:
1002         case LXVST:
1003         case MacVST:
1004                 type = X_(" (VST)");
1005                 break;
1006         case Lua:
1007                 type = X_(" (Lua)");
1008                 break;
1009         }
1010
1011         return type;
1012 }
1013
1014 Gtk::Menu*
1015 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
1016 {
1017         using namespace Menu_Helpers;
1018
1019         Menu* favs = new Menu();
1020         favs->set_name("ArdourContextMenu");
1021
1022         PluginMenuCompareByName cmp_by_name;
1023         all_plugs.sort (cmp_by_name);
1024
1025         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1026                 if (manager.get_status (*i) == PluginManager::Favorite) {
1027                         string typ = GetPluginTypeStr(*i);
1028                         MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1029                         elem.get_child()->set_use_underline (false);
1030                         favs->items().push_back (elem);
1031                 }
1032         }
1033         return favs;
1034 }
1035
1036 Gtk::Menu*
1037 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
1038 {
1039         _inhibit_refill = true;
1040         _fil_creator_combo.clear_items ();
1041         _fil_creator_combo.append_text_item (_("Show All Creators"));
1042         _fil_creator_combo.set_text (_("Show All Creators"));
1043         _inhibit_refill = false;
1044
1045         using namespace Menu_Helpers;
1046
1047         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1048         SubmenuMap creator_submenu_map;
1049
1050         Menu* by_creator = new Menu();
1051         by_creator->set_name("ArdourContextMenu");
1052
1053         MenuList& by_creator_items = by_creator->items();
1054         PluginMenuCompareByCreator cmp_by_creator;
1055         all_plugs.sort (cmp_by_creator);
1056
1057         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1058
1059                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1060
1061                 string creator = (*i)->creator;
1062
1063                 /* If there were too few characters to create a
1064                  * meaningful name, mark this creator as 'Unknown'
1065                  */
1066                 if (creator.length() < 2) {
1067                         creator = "Unknown";
1068                 }
1069
1070                 SubmenuMap::iterator x;
1071                 Gtk::Menu* submenu;
1072                 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
1073                         submenu = x->second;
1074                 } else {
1075
1076                         _fil_creator_combo.append_text_item (creator);
1077
1078                         submenu = new Gtk::Menu;
1079                         by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
1080                         creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
1081                         submenu->set_name("ArdourContextMenu");
1082                 }
1083                 string typ = GetPluginTypeStr(*i);
1084                 MenuElem elem ((*i)->name+typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1085                 elem.get_child()->set_use_underline (false);
1086                 submenu->items().push_back (elem);
1087         }
1088
1089         return by_creator;
1090 }
1091
1092 Gtk::Menu*
1093 PluginSelector::create_by_tags_menu (ARDOUR::PluginInfoList& all_plugs)
1094 {
1095         using namespace Menu_Helpers;
1096
1097         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1098         SubmenuMap tags_submenu_map;
1099
1100         Menu* by_tags = new Menu();
1101         by_tags->set_name("ArdourContextMenu");
1102         MenuList& by_tags_items = by_tags->items();
1103
1104         std::vector<std::string> all_tags = manager.get_all_tags (PluginManager::NoHidden);
1105         for (vector<string>::iterator t = all_tags.begin(); t != all_tags.end(); ++t) {
1106                 Gtk::Menu *submenu = new Gtk::Menu;
1107                 by_tags_items.push_back (MenuElem (*t, *manage (submenu)));
1108                 tags_submenu_map.insert (pair<std::string,Menu*> (*t, submenu));
1109                 submenu->set_name("ArdourContextMenu");
1110         }
1111
1112         PluginMenuCompareByName cmp_by_name;
1113         all_plugs.sort (cmp_by_name);
1114
1115         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1116
1117                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1118
1119                 /* for each tag in the plugins tag list, add it to that submenu */
1120                 vector<string> tokens = manager.get_tags(*i);
1121                 for (vector<string>::iterator t = tokens.begin(); t != tokens.end(); ++t) {
1122                         SubmenuMap::iterator x;
1123                         Gtk::Menu* submenu;
1124                         if ((x = tags_submenu_map.find (*t)) != tags_submenu_map.end()) {
1125                                 submenu = x->second;
1126                                 string typ = GetPluginTypeStr(*i);
1127                                 MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1128                                 elem.get_child()->set_use_underline (false);
1129                                 submenu->items().push_back (elem);
1130                         }
1131                 }
1132         }
1133         return by_tags;
1134 }
1135
1136 void
1137 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
1138 {
1139         PluginPtr p = load_plugin (pi);
1140
1141         if (p && interested_object) {
1142                 SelectedPlugins plugins;
1143                 plugins.push_back (p);
1144                 interested_object->use_plugins (plugins);
1145         }
1146
1147         interested_object = 0;
1148 }
1149
1150 void
1151 PluginSelector::favorite_changed (const std::string& path)
1152 {
1153         PluginInfoPtr pi;
1154
1155         if (in_row_change) {
1156                 return;
1157         }
1158
1159         in_row_change = true;
1160
1161         TreeModel::iterator iter = plugin_model->get_iter (path);
1162
1163         if (iter) {
1164
1165                 bool favorite = !(*iter)[plugin_columns.favorite];
1166
1167                 /* change state */
1168
1169                 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
1170
1171                 /* save new statuses list */
1172
1173                 pi = (*iter)[plugin_columns.plugin];
1174
1175                 manager.set_status (pi->type, pi->unique_id, status);
1176
1177                 _need_status_save = true;
1178         }
1179         in_row_change = false;
1180 }
1181
1182 void
1183 PluginSelector::hidden_changed (const std::string& path)
1184 {
1185         PluginInfoPtr pi;
1186
1187         if (in_row_change) {
1188                 return;
1189         }
1190
1191         in_row_change = true;
1192
1193         TreeModel::iterator iter = plugin_model->get_iter (path);
1194
1195         if (iter) {
1196
1197                 bool hidden = !(*iter)[plugin_columns.hidden];
1198
1199                 /* change state */
1200
1201                 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
1202
1203                 /* save new statuses list */
1204
1205                 pi = (*iter)[plugin_columns.plugin];
1206
1207                 manager.set_status (pi->type, pi->unique_id, status);
1208
1209                 _need_status_save = true;
1210         }
1211         in_row_change = false;
1212 }
1213
1214 void
1215 PluginSelector::show_manager ()
1216 {
1217         show_all();
1218         run ();
1219 }
1220
1221 void
1222 PluginSelector::set_interested_object (PluginInterestedObject& obj)
1223 {
1224         interested_object = &obj;
1225 }