Optimize Plugin-Manager: minimize status query
[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         PluginManager::PluginStatusType status = manager.get_status (info);
353
354         if (!searchstr.empty()) {
355
356                 std::string compstr;
357
358                 if (_search_name_checkbox->get_active()) { /* name contains */
359                         compstr = info->name;
360                         transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
361                         if (compstr.find (searchstr) != string::npos) {
362                                 maybe_show = true;
363                         }
364                 }
365
366                 if (_search_tags_checkbox->get_active()) { /* tag contains */
367                         compstr = manager.get_tags_as_string (info);
368                         transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
369                         if (compstr.find (searchstr) != string::npos) {
370                                 maybe_show = true;
371                         }
372                 }
373
374                 if (!maybe_show) {
375                         return false;
376                 }
377
378                 /* user asked to ignore filters */
379                 if (maybe_show && _search_ignore_checkbox->get_active()) {
380                         if (status == PluginManager::Hidden) {
381                                 return false;
382                         }
383                                 return false;
384                         }
385                         return true;
386                 }
387         }
388
389         if (_fil_effects_radio->get_active() && !info->is_effect()) {
390                 return false;
391         }
392
393         if (_fil_instruments_radio->get_active() && !info->is_instrument()) {
394                 return false;
395         }
396
397         if (_fil_utils_radio->get_active() && !(info->is_utility() || info->is_analyzer())) {
398                 return false;
399         }
400
401         if (_fil_favorites_radio->get_active() && status != PluginManager::Favorite) {
402                 return false;
403         }
404
405         if (_fil_hidden_radio->get_active() && status != PluginManager::Hidden) {
406                 return false;
407         }
408
409         if (!_fil_hidden_radio->get_active() && status == PluginManager::Hidden) {
410                 return false;
411         }
412                 return false;
413         }
414
415         /* Filter "type" combobox */
416
417         if (_fil_type_combo.get_text() == X_("VST") && PluginManager::to_generic_vst(info->type) != LXVST) {
418                 return false;
419         }
420
421         if (_fil_type_combo.get_text() == X_("AudioUnit") && info->type != AudioUnit) {
422                 return false;
423         }
424
425 #ifdef LV2_SUPPORT
426         if (_fil_type_combo.get_text() == X_("LV2") && info->type != LV2) {
427                 return false;
428         }
429 #endif
430
431         if (_fil_type_combo.get_text() == X_("Lua") && info->type != Lua) {
432                 return false;
433         }
434
435         if (_fil_type_combo.get_text() == X_("LADSPA") && info->type != LADSPA) {
436                 return false;
437         }
438
439         /* Filter "creator" combobox */
440
441         if (_fil_creator_combo.get_text() != _("Show All Creators")) {
442                 if (_fil_creator_combo.get_text() != info->creator) {
443                         return false;
444                 }
445         }
446
447         return true;
448 }
449
450 void
451 PluginSelector::setup_search_string (string& searchstr)
452 {
453         searchstr = search_entry.get_text ();
454         transform (searchstr.begin(), searchstr.end(), searchstr.begin(), ::toupper);
455 }
456
457 void
458 PluginSelector::set_sensitive_widgets ()
459 {
460         if (_search_ignore_checkbox->get_active() && !search_entry.get_text().empty()) {
461                 _fil_effects_radio->set_sensitive(false);
462                 _fil_instruments_radio->set_sensitive(false);
463                 _fil_utils_radio->set_sensitive(false);
464                 _fil_favorites_radio->set_sensitive(false);
465                 _fil_hidden_radio->set_sensitive(false);
466                 _fil_all_radio->set_sensitive(false);
467                 _inhibit_refill = true;
468                 _fil_type_combo.set_sensitive(false);
469                 _fil_creator_combo.set_sensitive(false);
470                 _inhibit_refill = false;
471         } else {
472                 _fil_effects_radio->set_sensitive(true);
473                 _fil_instruments_radio->set_sensitive(true);
474                 _fil_utils_radio->set_sensitive(true);
475                 _fil_favorites_radio->set_sensitive(true);
476                 _fil_hidden_radio->set_sensitive(true);
477                 _fil_all_radio->set_sensitive(true);
478                 _inhibit_refill = true;
479                 _fil_type_combo.set_sensitive(true);
480                 _fil_creator_combo.set_sensitive(true);
481                 _inhibit_refill = false;
482         }
483         if (!search_entry.get_text().empty()) {
484                 refill ();
485         }
486 }
487
488 void
489 PluginSelector::refill ()
490 {
491         if (_inhibit_refill) {
492                 return;
493         }
494
495         std::string searchstr;
496
497         in_row_change = true;
498
499         plugin_display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
500
501         int sort_col;
502         SortType sort_type;
503         bool sorted = plugin_model->get_sort_column_id (sort_col, sort_type);
504
505         /* Disable sorting to gain performance */
506         plugin_model->set_sort_column (-2, SORT_ASCENDING);
507
508         plugin_model->clear ();
509
510         setup_search_string (searchstr);
511
512         ladspa_refiller (searchstr);
513         lv2_refiller (searchstr);
514         vst_refiller (searchstr);
515         lxvst_refiller (searchstr);
516         mac_vst_refiller (searchstr);
517         au_refiller (searchstr);
518         lua_refiller (searchstr);
519
520         in_row_change = false;
521
522         plugin_display.set_model (plugin_model);
523         if (sorted) {
524                 plugin_model->set_sort_column (sort_col, sort_type);
525         }
526 }
527
528 void
529 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& searchstr, const char* type)
530 {
531         char buf[16];
532
533         for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
534
535                 if (show_this_plugin (*i, searchstr)) {
536
537                         TreeModel::Row newrow = *(plugin_model->append());
538                         newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
539                         newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
540
541                         string name = (*i)->name;
542                         if (name.length() > 48) {
543                                 name = name.substr (0, 48);
544                                 name.append("...");
545                         }
546                         newrow[plugin_columns.name] = name;
547
548                         newrow[plugin_columns.type_name] = type;
549
550                         /* Creator */
551                         string creator = (*i)->creator;
552                         string::size_type pos = 0;
553                         if ((*i)->type == ARDOUR::LADSPA) {
554                                 /* stupid LADSPA creator strings */
555 #ifdef PLATFORM_WINDOWS
556                                 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
557 #else
558                                 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
559 #endif
560                         } else {
561                                 pos = creator.length ();
562                         }
563                         // If there were too few characters to create a
564                         // meaningful name, mark this creator as 'Unknown'
565                         if (creator.length() < 2 || pos < 3) {
566                                 creator = "Unknown";
567                         } else{
568                                 creator = creator.substr (0, pos);
569                         }
570
571                         if (creator.length() > MAX_CREATOR_LEN) {
572                                 creator = creator.substr (0, MAX_CREATOR_LEN);
573                                 creator.append("...");
574                         }
575                         newrow[plugin_columns.creator] = creator;
576
577                         /* Tags */
578                         string tags = manager.get_tags_as_string(*i);
579                         if (tags.length() > 32) {
580                                 tags = tags.substr (0, 32);
581                                 tags.append("...");
582                         }
583                         newrow[plugin_columns.tags] = tags;
584
585                         if ((*i)->reconfigurable_io ()) {
586                                 newrow[plugin_columns.audio_io] = "* / *";
587                                 newrow[plugin_columns.midi_io] = "* / *";
588                         } else {
589                                 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_audio(), (*i)->n_outputs.n_audio());
590                                 newrow[plugin_columns.audio_io] = buf;
591                                 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_midi(), (*i)->n_outputs.n_midi());
592                                 newrow[plugin_columns.midi_io] = buf;
593                         }
594
595                         newrow[plugin_columns.plugin] = *i;
596                 }
597         }
598 }
599
600 void
601 PluginSelector::ladspa_refiller (const std::string& searchstr)
602 {
603         refiller (manager.ladspa_plugin_info(), searchstr, "LADSPA");
604 }
605
606 void
607 PluginSelector::lua_refiller (const std::string& searchstr)
608 {
609         refiller (manager.lua_plugin_info(), searchstr, "Lua");
610 }
611
612 void
613 PluginSelector::lv2_refiller (const std::string& searchstr)
614 {
615 #ifdef LV2_SUPPORT
616         refiller (manager.lv2_plugin_info(), searchstr, "LV2");
617 #endif
618 }
619
620 void
621 #ifdef WINDOWS_VST_SUPPORT
622 PluginSelector::vst_refiller (const std::string& searchstr)
623 #else
624 PluginSelector::vst_refiller (const std::string&)
625 #endif
626 {
627 #ifdef WINDOWS_VST_SUPPORT
628         refiller (manager.windows_vst_plugin_info(), searchstr, "VST");
629 #endif
630 }
631
632 void
633 #ifdef LXVST_SUPPORT
634 PluginSelector::lxvst_refiller (const std::string& searchstr)
635 #else
636 PluginSelector::lxvst_refiller (const std::string&)
637 #endif
638 {
639 #ifdef LXVST_SUPPORT
640         refiller (manager.lxvst_plugin_info(), searchstr, "LXVST");
641 #endif
642 }
643
644 void
645 #ifdef MACVST_SUPPORT
646 PluginSelector::mac_vst_refiller (const std::string& searchstr)
647 #else
648 PluginSelector::mac_vst_refiller (const std::string&)
649 #endif
650 {
651 #ifdef MACVST_SUPPORT
652         refiller (manager.mac_vst_plugin_info(), searchstr, "MacVST");
653 #endif
654 }
655
656 void
657 #ifdef AUDIOUNIT_SUPPORT
658 PluginSelector::au_refiller (const std::string& searchstr)
659 #else
660 PluginSelector::au_refiller (const std::string&)
661 #endif
662 {
663 #ifdef AUDIOUNIT_SUPPORT
664         refiller (manager.au_plugin_info(), searchstr, "AU");
665 #endif
666 }
667
668 PluginPtr
669 PluginSelector::load_plugin (PluginInfoPtr pi)
670 {
671         if (_session == 0) {
672                 return PluginPtr();
673         }
674
675         return pi->load (*_session);
676 }
677
678 void
679 PluginSelector::btn_add_clicked()
680 {
681         if (plugin_display.get_selection()->count_selected_rows() == 0) {
682                 /* may happen with ctrl + double-click un-selecting but activating a row */
683                 return;
684         }
685         std::string name;
686         PluginInfoPtr pi;
687         TreeModel::Row newrow = *(amodel->append());
688         TreeModel::Row row;
689
690         row = *(plugin_display.get_selection()->get_selected());
691         name = row[plugin_columns.name];
692         pi = row[plugin_columns.plugin];
693
694         newrow[acols.text] = name;
695         newrow[acols.plugin] = pi;
696
697         if (!amodel->children().empty()) {
698                 set_response_sensitive (RESPONSE_APPLY, true);
699         }
700 }
701
702 void
703 PluginSelector::btn_remove_clicked()
704 {
705         TreeModel::iterator iter = added_list.get_selection()->get_selected();
706
707         amodel->erase(iter);
708         if (amodel->children().empty()) {
709                 set_response_sensitive (RESPONSE_APPLY, false);
710         }
711 }
712
713 void
714 PluginSelector::display_selection_changed()
715 {
716         tag_entry_connection.block ();
717         if (plugin_display.get_selection()->count_selected_rows() != 0) {
718
719                 /* a plugin row is selected; allow the user to edit the "tags" on it. */
720                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
721                 string tags = manager.get_tags_as_string (row[plugin_columns.plugin]);
722                 tag_entry->set_text (tags);
723
724                 tag_entry->set_sensitive (true);
725                 tag_reset_button->set_sensitive (true);
726                 btn_add->set_sensitive (true);
727
728         } else {
729                 tag_entry->set_text ("");
730
731                 tag_entry->set_sensitive (false);
732                 tag_reset_button->set_sensitive (false);
733                 btn_add->set_sensitive (false);
734         }
735         tag_entry_connection.unblock ();
736 }
737
738 void
739 PluginSelector::added_list_selection_changed()
740 {
741         if (added_list.get_selection()->count_selected_rows() != 0) {
742                 btn_remove->set_sensitive (true);
743         } else {
744                 btn_remove->set_sensitive (false);
745         }
746 }
747
748 int
749 PluginSelector::run ()
750 {
751         ResponseType r;
752         TreeModel::Children::iterator i;
753
754         bool finish = false;
755
756         while (!finish) {
757
758                 SelectedPlugins plugins;
759                 r = (ResponseType) Dialog::run ();
760
761                 switch (r) {
762                 case RESPONSE_APPLY:
763                         for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
764                                 PluginInfoPtr pp = (*i)[acols.plugin];
765                                 PluginPtr p = load_plugin (pp);
766                                 if (p) {
767                                         plugins.push_back (p);
768                                 } else {
769                                         MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
770                                         msg.run ();
771                                 }
772                         }
773                         if (interested_object && !plugins.empty()) {
774                                 finish = !interested_object->use_plugins (plugins);
775                         }
776
777                         break;
778
779                 default:
780                         finish = true;
781                         break;
782                 }
783         }
784
785
786         hide();
787         amodel->clear();
788         interested_object = 0;
789
790         if (_need_tag_save) {
791                 manager.save_tags();
792         }
793
794         if (_need_status_save) {
795                 manager.save_statuses();
796         }
797         if (_need_menu_rebuild) {
798                 build_plugin_menu ();
799         }
800
801         return (int) r;
802 }
803
804 void
805 PluginSelector::search_clear_button_clicked ()
806 {
807         search_entry.set_text ("");
808 }
809
810 void
811 PluginSelector::tag_reset_button_clicked ()
812 {
813         if (plugin_display.get_selection()->count_selected_rows() != 0) {
814                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
815                 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
816                 manager.reset_tags (pi);
817                 display_selection_changed ();
818                 _need_tag_save = true;
819         }
820 }
821
822 void
823 PluginSelector::search_entry_changed ()
824 {
825         set_sensitive_widgets();
826         if (search_entry.get_text().empty()) {
827                 refill ();
828         }
829 }
830
831 void
832 PluginSelector::tag_entry_changed ()
833 {
834         if (plugin_display.get_selection()->count_selected_rows() != 0) {
835                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
836
837                 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
838                 manager.set_tags (pi->type, pi->unique_id, tag_entry->get_text(), pi->name, PluginManager::FromGui);
839
840                 _need_tag_save = true;
841         }
842 }
843
844 void
845 PluginSelector::tags_changed (PluginType t, std::string unique_id, std::string tags)
846 {
847         if (plugin_display.get_selection()->count_selected_rows() != 0) {
848                 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
849                 if (tags.length() > 32) {
850                         tags = tags.substr (0, 32);
851                         tags.append ("...");
852                 }
853                 row[plugin_columns.tags] = tags;
854         }
855 }
856
857 void
858 PluginSelector::plugin_status_changed (PluginType t, std::string uid, PluginManager::PluginStatusType stat)
859 {
860         Gtk::TreeModel::iterator i;
861         for (i = plugin_model->children().begin(); i != plugin_model->children().end(); ++i) {
862                 PluginInfoPtr pp = (*i)[plugin_columns.plugin];
863                 if ((pp->type == t) && (pp->unique_id == uid)) {
864                         (*i)[plugin_columns.favorite] = (stat == PluginManager::Favorite) ? true : false;
865                         (*i)[plugin_columns.hidden] = (stat == PluginManager::Hidden) ? true : false;
866
867                         /* if plug was hidden, remove it from the view */
868                         if (stat == PluginManager::Hidden) {
869                                 if (!_fil_hidden_radio->get_active() && !_fil_all_radio->get_active()) {
870                                         plugin_model->erase(i);
871                                 }
872                         } else if (_fil_hidden_radio->get_active()) {
873                                 plugin_model->erase(i);
874                         }
875                         /* if no longer a favorite, remove it from the view */
876                         if (stat != PluginManager::Favorite && _fil_favorites_radio->get_active()) {
877                                         plugin_model->erase(i);
878                         }
879
880                         return;
881                 }
882         }
883 }
884
885 void
886 PluginSelector::on_show ()
887 {
888         ArdourDialog::on_show ();
889         search_entry.grab_focus ();
890
891         refill ();
892
893         _need_tag_save = false;
894         _need_status_save = false;
895 }
896
897 struct PluginMenuCompareByCreator {
898         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
899                 int cmp;
900
901                 cmp = cmp_nocase_utf8 (a->creator, b->creator);
902
903                 if (cmp < 0) {
904                         return true;
905                 } else if (cmp == 0) {
906                         /* same creator ... compare names */
907                         if (cmp_nocase_utf8 (a->name, b->name) < 0) {
908                                 return true;
909                         }
910                 }
911                 return false;
912         }
913 };
914
915 struct PluginMenuCompareByName {
916         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
917                 int cmp;
918
919                 cmp = cmp_nocase_utf8 (a->name, b->name);
920
921                 if (cmp < 0) {
922                         return true;
923                 } else if (cmp == 0) {
924                         /* same name ... compare type */
925                         if (a->type < b->type) {
926                                 return true;
927                         }
928                 }
929                 return false;
930         }
931 };
932
933 /** @return Plugin menu. The caller should not delete it */
934 Gtk::Menu*
935 PluginSelector::plugin_menu()
936 {
937         return _plugin_menu;
938 }
939
940 void
941 PluginSelector::build_plugin_menu ()
942 {
943         if (is_visible ()) {
944                 _need_menu_rebuild = true;
945                 return;
946         }
947         _need_menu_rebuild = false;
948         PluginInfoList all_plugs;
949
950         all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
951         all_plugs.insert (all_plugs.end(), manager.lua_plugin_info().begin(), manager.lua_plugin_info().end());
952 #ifdef WINDOWS_VST_SUPPORT
953         all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
954 #endif
955 #ifdef LXVST_SUPPORT
956         all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
957 #endif
958 #ifdef MACVST_SUPPORT
959         all_plugs.insert (all_plugs.end(), manager.mac_vst_plugin_info().begin(), manager.mac_vst_plugin_info().end());
960 #endif
961 #ifdef AUDIOUNIT_SUPPORT
962         all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
963 #endif
964 #ifdef LV2_SUPPORT
965         all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
966 #endif
967
968         using namespace Menu_Helpers;
969
970         delete _plugin_menu;
971
972         _plugin_menu = new Menu;
973         _plugin_menu->set_name("ArdourContextMenu");
974
975         MenuList& items = _plugin_menu->items();
976         items.clear ();
977
978         Gtk::Menu* favs = create_favs_menu(all_plugs);
979         items.push_back (MenuElem (_("Favorites"), *manage (favs)));
980
981         items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
982         items.push_back (SeparatorElem ());
983
984         Menu* by_creator = create_by_creator_menu(all_plugs);
985         items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
986
987         Menu* by_tags = create_by_tags_menu(all_plugs);
988         items.push_back (MenuElem (_("By Tags"), *manage (by_tags)));
989 }
990
991 string
992 GetPluginTypeStr(PluginInfoPtr info)
993 {
994         string type;
995
996         switch (info->type) {
997         case LADSPA:
998                 type = X_(" (LADSPA)");
999                 break;
1000         case AudioUnit:
1001                 type = X_(" (AU)");
1002                 break;
1003         case LV2:
1004                 type = X_(" (LV2)");
1005                 break;
1006         case Windows_VST:
1007         case LXVST:
1008         case MacVST:
1009                 type = X_(" (VST)");
1010                 break;
1011         case Lua:
1012                 type = X_(" (Lua)");
1013                 break;
1014         }
1015
1016         return type;
1017 }
1018
1019 Gtk::Menu*
1020 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
1021 {
1022         using namespace Menu_Helpers;
1023
1024         Menu* favs = new Menu();
1025         favs->set_name("ArdourContextMenu");
1026
1027         PluginMenuCompareByName cmp_by_name;
1028         all_plugs.sort (cmp_by_name);
1029
1030         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1031                 if (manager.get_status (*i) == PluginManager::Favorite) {
1032                         string typ = GetPluginTypeStr(*i);
1033                         MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1034                         elem.get_child()->set_use_underline (false);
1035                         favs->items().push_back (elem);
1036                 }
1037         }
1038         return favs;
1039 }
1040
1041 Gtk::Menu*
1042 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
1043 {
1044         _inhibit_refill = true;
1045         _fil_creator_combo.clear_items ();
1046         _fil_creator_combo.append_text_item (_("Show All Creators"));
1047         _fil_creator_combo.set_text (_("Show All Creators"));
1048         _inhibit_refill = false;
1049
1050         using namespace Menu_Helpers;
1051
1052         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1053         SubmenuMap creator_submenu_map;
1054
1055         Menu* by_creator = new Menu();
1056         by_creator->set_name("ArdourContextMenu");
1057
1058         MenuList& by_creator_items = by_creator->items();
1059         PluginMenuCompareByCreator cmp_by_creator;
1060         all_plugs.sort (cmp_by_creator);
1061
1062         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1063
1064                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1065
1066                 string creator = (*i)->creator;
1067
1068                 /* If there were too few characters to create a
1069                  * meaningful name, mark this creator as 'Unknown'
1070                  */
1071                 if (creator.length() < 2) {
1072                         creator = "Unknown";
1073                 }
1074
1075                 SubmenuMap::iterator x;
1076                 Gtk::Menu* submenu;
1077                 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
1078                         submenu = x->second;
1079                 } else {
1080
1081                         _fil_creator_combo.append_text_item (creator);
1082
1083                         submenu = new Gtk::Menu;
1084                         by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
1085                         creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
1086                         submenu->set_name("ArdourContextMenu");
1087                 }
1088                 string typ = GetPluginTypeStr(*i);
1089                 MenuElem elem ((*i)->name+typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1090                 elem.get_child()->set_use_underline (false);
1091                 submenu->items().push_back (elem);
1092         }
1093
1094         return by_creator;
1095 }
1096
1097 Gtk::Menu*
1098 PluginSelector::create_by_tags_menu (ARDOUR::PluginInfoList& all_plugs)
1099 {
1100         using namespace Menu_Helpers;
1101
1102         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1103         SubmenuMap tags_submenu_map;
1104
1105         Menu* by_tags = new Menu();
1106         by_tags->set_name("ArdourContextMenu");
1107         MenuList& by_tags_items = by_tags->items();
1108
1109         std::vector<std::string> all_tags = manager.get_all_tags (PluginManager::NoHidden);
1110         for (vector<string>::iterator t = all_tags.begin(); t != all_tags.end(); ++t) {
1111                 Gtk::Menu *submenu = new Gtk::Menu;
1112                 by_tags_items.push_back (MenuElem (*t, *manage (submenu)));
1113                 tags_submenu_map.insert (pair<std::string,Menu*> (*t, submenu));
1114                 submenu->set_name("ArdourContextMenu");
1115         }
1116
1117         PluginMenuCompareByName cmp_by_name;
1118         all_plugs.sort (cmp_by_name);
1119
1120         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1121
1122                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1123
1124                 /* for each tag in the plugins tag list, add it to that submenu */
1125                 vector<string> tokens = manager.get_tags(*i);
1126                 for (vector<string>::iterator t = tokens.begin(); t != tokens.end(); ++t) {
1127                         SubmenuMap::iterator x;
1128                         Gtk::Menu* submenu;
1129                         if ((x = tags_submenu_map.find (*t)) != tags_submenu_map.end()) {
1130                                 submenu = x->second;
1131                                 string typ = GetPluginTypeStr(*i);
1132                                 MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1133                                 elem.get_child()->set_use_underline (false);
1134                                 submenu->items().push_back (elem);
1135                         }
1136                 }
1137         }
1138         return by_tags;
1139 }
1140
1141 void
1142 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
1143 {
1144         PluginPtr p = load_plugin (pi);
1145
1146         if (p && interested_object) {
1147                 SelectedPlugins plugins;
1148                 plugins.push_back (p);
1149                 interested_object->use_plugins (plugins);
1150         }
1151
1152         interested_object = 0;
1153 }
1154
1155 void
1156 PluginSelector::favorite_changed (const std::string& path)
1157 {
1158         PluginInfoPtr pi;
1159
1160         if (in_row_change) {
1161                 return;
1162         }
1163
1164         in_row_change = true;
1165
1166         TreeModel::iterator iter = plugin_model->get_iter (path);
1167
1168         if (iter) {
1169
1170                 bool favorite = !(*iter)[plugin_columns.favorite];
1171
1172                 /* change state */
1173
1174                 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
1175
1176                 /* save new statuses list */
1177
1178                 pi = (*iter)[plugin_columns.plugin];
1179
1180                 manager.set_status (pi->type, pi->unique_id, status);
1181
1182                 _need_status_save = true;
1183         }
1184         in_row_change = false;
1185 }
1186
1187 void
1188 PluginSelector::hidden_changed (const std::string& path)
1189 {
1190         PluginInfoPtr pi;
1191
1192         if (in_row_change) {
1193                 return;
1194         }
1195
1196         in_row_change = true;
1197
1198         TreeModel::iterator iter = plugin_model->get_iter (path);
1199
1200         if (iter) {
1201
1202                 bool hidden = !(*iter)[plugin_columns.hidden];
1203
1204                 /* change state */
1205
1206                 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
1207
1208                 /* save new statuses list */
1209
1210                 pi = (*iter)[plugin_columns.plugin];
1211
1212                 manager.set_status (pi->type, pi->unique_id, status);
1213
1214                 _need_status_save = true;
1215         }
1216         in_row_change = false;
1217 }
1218
1219 void
1220 PluginSelector::show_manager ()
1221 {
1222         show_all();
1223         run ();
1224 }
1225
1226 void
1227 PluginSelector::set_interested_object (PluginInterestedObject& obj)
1228 {
1229         interested_object = &obj;
1230 }