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