Gracefully handle templates that lack contents in their description or created_with...
[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 #include "pbd/convert.h"
38 #include "widgets/tooltips.h"
39
40 #include "ardour/plugin_manager.h"
41 #include "ardour/plugin.h"
42 #include "ardour/utils.h"
43
44 #include "plugin_selector.h"
45 #include "gui_thread.h"
46
47 #include "pbd/i18n.h"
48
49 using namespace ARDOUR;
50 using namespace PBD;
51 using namespace Gtk;
52 using namespace std;
53 using namespace ArdourWidgets;
54
55 static const char* _filter_mode_strings[] = {
56         N_("Name contains"),
57         N_("Type contains"),
58         N_("Category contains"),
59         N_("Author contains"),
60         N_("Library contains"),
61         N_("Favorites only"),
62         N_("Hidden only"),
63         0
64 };
65
66 PluginSelector::PluginSelector (PluginManager& mgr)
67         : ArdourDialog (_("Plugin Manager"), true, false)
68         , filter_button (Stock::CLEAR)
69         , fil_hidden_button (ArdourButton::led_default_elements)
70         , fil_instruments_button (ArdourButton::default_elements)
71         , fil_analysis_button (ArdourButton::default_elements)
72         , fil_utils_button (ArdourButton::default_elements)
73         , manager (mgr)
74         , _show_hidden (false)
75         , _show_instruments (Gtkmm2ext::ImplicitActive)
76         , _show_analysers (Gtkmm2ext::Off)
77         , _show_utils (Gtkmm2ext::Off)
78
79 {
80         set_name ("PluginSelectorWindow");
81         add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
82
83         _plugin_menu = 0;
84         in_row_change = false;
85
86         manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
87         manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), gui_context());
88         manager.PluginStatusesChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
89         manager.PluginStatusesChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), gui_context());
90         build_plugin_menu ();
91
92         plugin_model = Gtk::ListStore::create (plugin_columns);
93         plugin_display.set_model (plugin_model);
94         /* XXX translators: try to convert "Fav" into a short term
95            related to "favorite" and "Hid" into a short term
96            related to "hidden"
97         */
98         plugin_display.append_column (_("Fav"), plugin_columns.favorite);
99         plugin_display.append_column (_("Hide"), plugin_columns.hidden);
100         plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
101         plugin_display.append_column (_("Type"), plugin_columns.type_name);
102         plugin_display.append_column (_("Category"), plugin_columns.category);
103         plugin_display.append_column (_("Creator"), plugin_columns.creator);
104         plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
105         plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
106         plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
107         plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
108         plugin_display.set_headers_visible (true);
109         plugin_display.set_headers_clickable (true);
110         plugin_display.set_reorderable (false);
111         plugin_display.set_rules_hint (true);
112         plugin_display.add_object_drag (plugin_columns.plugin.index(), "PluginInfoPtr");
113         plugin_display.set_drag_column (plugin_columns.name.index());
114
115         // setting a sort-column prevents re-ordering via Drag/Drop
116         plugin_model->set_sort_column (plugin_columns.name.index(), Gtk::SORT_ASCENDING);
117
118         CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
119         fav_cell->property_activatable() = true;
120         fav_cell->property_radio() = true;
121         fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
122
123         CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
124         hidden_cell->property_activatable() = true;
125         hidden_cell->property_radio() = true;
126         hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
127
128         scroller.set_border_width(10);
129         scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
130         scroller.add(plugin_display);
131
132         amodel = Gtk::ListStore::create(acols);
133         added_list.set_model (amodel);
134         added_list.append_column (_("Plugins to be connected"), acols.text);
135         added_list.set_headers_visible (true);
136         added_list.set_reorderable (false);
137
138         for (int i = 0; i <=8; i++) {
139                 Gtk::TreeView::Column* column = plugin_display.get_column(i);
140                 column->set_sort_column(i);
141         }
142
143         ascroller.set_border_width(10);
144         ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
145         ascroller.add(added_list);
146         btn_add = manage(new Gtk::Button(Stock::ADD));
147         set_tooltip(*btn_add, _("Add a plugin to the effect list"));
148         btn_add->set_sensitive (false);
149         btn_remove = manage(new Gtk::Button(Stock::REMOVE));
150         btn_remove->set_sensitive (false);
151         set_tooltip(*btn_remove, _("Remove a plugin from the effect list"));
152
153         btn_add->set_name("PluginSelectorButton");
154         btn_remove->set_name("PluginSelectorButton");
155
156
157         Gtk::Table* table = manage(new Gtk::Table(7, 11));
158         table->set_size_request(750, 500);
159
160         Gtk::Table* filter_table = manage(new Gtk::Table(2, 5));
161
162         fil_hidden_button.set_name ("pluginlist hide button");
163         fil_hidden_button.set_text (_("Show Hidden"));
164         fil_hidden_button.set_active (_show_hidden);
165         set_tooltip (fil_hidden_button, _("Include hidden plugins in list."));
166
167         fil_instruments_button.set_name ("pluginlist filter button");
168         fil_instruments_button.set_text (_("Instruments"));
169         fil_instruments_button.set_active_state (_show_instruments);
170         set_tooltip (fil_instruments_button, _("Cycle display of instrument plugins (if any)."));
171
172         fil_analysis_button.set_name ("pluginlist filter button");
173         fil_analysis_button.set_text (_("Analyzers"));
174         fil_analysis_button.set_active_state (_show_analysers);
175         set_tooltip (fil_analysis_button, _("Cycle display of analysis plugins (if any)."));
176
177         fil_utils_button.set_name ("pluginlist filter button");
178         fil_utils_button.set_text (_("Utils"));
179         fil_utils_button.set_active_state (_show_utils);
180         set_tooltip (fil_utils_button, _("Cycle display of utility plugins (if any)."));
181
182         vector<string> filter_strings = I18N (_filter_mode_strings);
183         Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
184         filter_mode.set_active_text (filter_strings.front());
185
186         fil_hidden_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_hidden_button_release), false);
187         fil_instruments_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_instruments_button_release), false);
188         fil_analysis_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_analysis_button_release), false);
189         fil_utils_button.signal_button_release_event().connect (sigc::mem_fun(*this, &PluginSelector::fil_utils_button_release), false);
190
191         filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
192         filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
193         filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
194
195         filter_table->attach (filter_mode,            0, 1, 0, 1, FILL, FILL);
196         filter_table->attach (filter_entry,           1, 4, 0, 1, FILL|EXPAND, FILL);
197         filter_table->attach (filter_button,          4, 5, 0, 1, FILL, FILL);
198
199         filter_table->attach (fil_hidden_button,      1, 2, 1, 2, FILL, FILL);
200         filter_table->attach (fil_instruments_button, 2, 3, 1, 2, FILL, FILL);
201         filter_table->attach (fil_analysis_button,    3, 4, 1, 2, FILL, FILL);
202         filter_table->attach (fil_utils_button,       4, 5, 1, 2, FILL, FILL);
203
204         filter_table->set_border_width (4);
205         filter_table->set_col_spacings (2);
206         filter_table->set_row_spacings (4);
207
208         Frame* filter_frame = manage (new Frame);
209         filter_frame->set_name ("BaseFrame");
210         filter_frame->set_label (_("Filter"));
211         filter_frame->add (*filter_table);
212
213         filter_frame->show_all ();
214
215         HBox* side_by_side = manage (new HBox);
216         VBox* right_side = manage (new VBox);
217
218         table->attach (scroller, 0, 7, 0, 5);
219         table->attach (*filter_frame, 0, 7, 6, 7, FILL|EXPAND, FILL, 5, 5);
220
221         right_side->pack_start (ascroller);
222
223         HBox* add_remove = manage (new HBox);
224         add_remove->pack_start (*btn_add, true, true);
225         add_remove->pack_start (*btn_remove, true, true);
226
227         right_side->pack_start (*add_remove, false, false);
228         right_side->set_size_request (200, -1);
229
230         side_by_side->pack_start (*table);
231         side_by_side->pack_start (*right_side);
232
233         add_button (Stock::CLOSE, RESPONSE_CLOSE);
234         add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
235         set_default_response (RESPONSE_APPLY);
236         set_response_sensitive (RESPONSE_APPLY, false);
237         get_vbox()->pack_start (*side_by_side);
238
239         table->set_name("PluginSelectorTable");
240         plugin_display.set_name("PluginSelectorDisplay");
241         //plugin_display.set_name("PluginSelectorList");
242         added_list.set_name("PluginSelectorList");
243
244         plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
245         plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
246         plugin_display.grab_focus();
247
248         btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
249         btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
250         added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
251         added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
252
253         refill ();
254 }
255
256 PluginSelector::~PluginSelector ()
257 {
258         delete _plugin_menu;
259 }
260
261 void
262 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
263 {
264         btn_add_clicked();
265 }
266
267 void
268 PluginSelector::added_row_clicked(GdkEventButton* event)
269 {
270         if (event->type == GDK_2BUTTON_PRESS)
271                 btn_remove_clicked();
272 }
273
274 static bool is_analyzer (const PluginInfoPtr& info) {
275         // Anaylsis, Analyzer are for backwards compatibility (vst cache)
276         return info->in_category ("Analyser") || info->in_category ("Anaylsis") ||  info->in_category ("Analyzer");
277 }
278
279 static bool is_util (const PluginInfoPtr& info) {
280         // all MIDI plugins which are not Instruments are Utils.
281         return info->in_category ("Utility") || info->in_category ("MIDI") || info->in_category ("Generator");
282 }
283
284 bool
285 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
286 {
287         std::string compstr;
288         std::string mode = filter_mode.get_active_text ();
289
290         if (mode == _("Favorites only")) {
291                 return manager.get_status (info) == PluginManager::Favorite;
292         }
293
294         if (mode == _("Hidden only")) {
295                 return manager.get_status (info) == PluginManager::Hidden;
296         }
297
298         if (!_show_hidden && manager.get_status (info) == PluginManager::Hidden) {
299                 return false;
300         }
301
302         if (_show_instruments == Gtkmm2ext::Off && info->is_instrument()) {
303                 return false;
304         }
305         if (_show_analysers == Gtkmm2ext::Off && is_analyzer (info)) {
306                 return false;
307         }
308         if (_show_utils == Gtkmm2ext::Off && is_util (info)) {
309                 return false;
310         }
311
312         /* NB once lilv_node_as_string() does honor translation AND
313          * the lv2 onthology provides localized class name,
314          * PluginInfo will need methods for Util & Analysis.
315          */
316         bool exp_ok = false;
317         if (_show_instruments == Gtkmm2ext::ExplicitActive && info->is_instrument()) {
318                 exp_ok = true;
319         }
320         if (_show_analysers == Gtkmm2ext::ExplicitActive && is_analyzer(info)) {
321                 exp_ok = true;
322         }
323         if (_show_utils == Gtkmm2ext::ExplicitActive && is_util (info)) {
324                 exp_ok = true;
325         }
326         if (_show_instruments == Gtkmm2ext::ExplicitActive  || _show_analysers == Gtkmm2ext::ExplicitActive || _show_utils == Gtkmm2ext::ExplicitActive) {
327                 if (!exp_ok) {
328                         return false;
329                 }
330         }
331
332         if (!filterstr.empty()) {
333
334                 if (mode == _("Name contains")) {
335                         compstr = info->name;
336                 } else if (mode == _("Category contains")) {
337                         compstr = info->category;
338                 } else if (mode == _("Type contains")) {
339
340                         switch (info->type) {
341                         case LADSPA:
342                                 compstr = X_("LADSPA");
343                                 break;
344                         case AudioUnit:
345                                 compstr = X_("AudioUnit");
346                                 break;
347                         case LV2:
348                                 compstr = X_("LV2");
349                                 break;
350                         case Windows_VST:
351                                 compstr = X_("VST");
352                                 break;
353                         case LXVST:
354                                 compstr = X_("LXVST");
355                                 break;
356                         case MacVST:
357                                 compstr = X_("MacVST");
358                                 break;
359                         case Lua:
360                                 compstr = X_("Lua");
361                                 break;
362                         }
363
364                 } else if (mode == _("Author contains")) {
365                         compstr = info->creator;
366                 } else if (mode == _("Library contains")) {
367                         compstr = info->path;
368                 }
369
370                 if (compstr.empty()) {
371                         return false;
372                 }
373
374                 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
375
376                 if (compstr.find (filterstr) != string::npos) {
377                         return true;
378                 } else {
379                         return false;
380                 }
381         }
382
383         return true;
384 }
385
386 void
387 PluginSelector::setup_filter_string (string& filterstr)
388 {
389         filterstr = filter_entry.get_text ();
390         transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
391 }
392
393 void
394 PluginSelector::refill ()
395 {
396         std::string filterstr;
397
398         in_row_change = true;
399
400         plugin_model->clear ();
401
402         setup_filter_string (filterstr);
403
404         ladspa_refiller (filterstr);
405         lv2_refiller (filterstr);
406         vst_refiller (filterstr);
407         lxvst_refiller (filterstr);
408         mac_vst_refiller (filterstr);
409         au_refiller (filterstr);
410         lua_refiller (filterstr);
411
412         in_row_change = false;
413 }
414
415 void
416 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
417 {
418         char buf[16];
419
420         for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
421
422                 if (show_this_plugin (*i, filterstr)) {
423
424                         TreeModel::Row newrow = *(plugin_model->append());
425                         newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
426                         newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
427                         newrow[plugin_columns.name] = (*i)->name;
428                         newrow[plugin_columns.type_name] = type;
429                         newrow[plugin_columns.category] = (*i)->category;
430
431                         string creator = (*i)->creator;
432                         string::size_type pos = 0;
433
434                         if ((*i)->type == ARDOUR::LADSPA) {
435                                 /* stupid LADSPA creator strings */
436 #ifdef PLATFORM_WINDOWS
437                                 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
438 #else
439                                 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
440 #endif
441                         } else {
442                                 pos = creator.length ();
443                         }
444                         // If there were too few characters to create a
445                         // meaningful name, mark this creator as 'Unknown'
446                         if (creator.length() < 2 || pos < 3) {
447                                 creator = "Unknown";
448                         } else{
449                                 creator = creator.substr (0, pos);
450                         }
451
452                         newrow[plugin_columns.creator] = creator;
453
454                         if ((*i)->reconfigurable_io ()) {
455                                 newrow[plugin_columns.audio_ins] = _("variable");
456                                 newrow[plugin_columns.midi_ins] = _("variable");
457                                 newrow[plugin_columns.audio_outs] = _("variable");
458                                 newrow[plugin_columns.midi_outs] = _("variable");
459                         } else {
460                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
461                                 newrow[plugin_columns.audio_ins] = buf;
462                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
463                                 newrow[plugin_columns.midi_ins] = buf;
464
465                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
466                                 newrow[plugin_columns.audio_outs] = buf;
467                                 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
468                                 newrow[plugin_columns.midi_outs] = buf;
469                         }
470
471                         newrow[plugin_columns.plugin] = *i;
472                 }
473         }
474 }
475
476 void
477 PluginSelector::ladspa_refiller (const std::string& filterstr)
478 {
479         refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
480 }
481
482 void
483 PluginSelector::lua_refiller (const std::string& filterstr)
484 {
485         refiller (manager.lua_plugin_info(), filterstr, "Lua");
486 }
487
488 void
489 PluginSelector::lv2_refiller (const std::string& filterstr)
490 {
491 #ifdef LV2_SUPPORT
492         refiller (manager.lv2_plugin_info(), filterstr, "LV2");
493 #endif
494 }
495
496 void
497 #ifdef WINDOWS_VST_SUPPORT
498 PluginSelector::vst_refiller (const std::string& filterstr)
499 #else
500 PluginSelector::vst_refiller (const std::string&)
501 #endif
502 {
503 #ifdef WINDOWS_VST_SUPPORT
504         refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
505 #endif
506 }
507
508 void
509 #ifdef LXVST_SUPPORT
510 PluginSelector::lxvst_refiller (const std::string& filterstr)
511 #else
512 PluginSelector::lxvst_refiller (const std::string&)
513 #endif
514 {
515 #ifdef LXVST_SUPPORT
516         refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
517 #endif
518 }
519
520 void
521 #ifdef MACVST_SUPPORT
522 PluginSelector::mac_vst_refiller (const std::string& filterstr)
523 #else
524 PluginSelector::mac_vst_refiller (const std::string&)
525 #endif
526 {
527 #ifdef MACVST_SUPPORT
528         refiller (manager.mac_vst_plugin_info(), filterstr, "MacVST");
529 #endif
530 }
531
532 void
533 #ifdef AUDIOUNIT_SUPPORT
534 PluginSelector::au_refiller (const std::string& filterstr)
535 #else
536 PluginSelector::au_refiller (const std::string&)
537 #endif
538 {
539 #ifdef AUDIOUNIT_SUPPORT
540         refiller (manager.au_plugin_info(), filterstr, "AU");
541 #endif
542 }
543
544 PluginPtr
545 PluginSelector::load_plugin (PluginInfoPtr pi)
546 {
547         if (_session == 0) {
548                 return PluginPtr();
549         }
550
551         return pi->load (*_session);
552 }
553
554 void
555 PluginSelector::btn_add_clicked()
556 {
557         std::string name;
558         PluginInfoPtr pi;
559         TreeModel::Row newrow = *(amodel->append());
560         TreeModel::Row row;
561
562         row = *(plugin_display.get_selection()->get_selected());
563         name = row[plugin_columns.name];
564         pi = row[plugin_columns.plugin];
565
566         newrow[acols.text] = name;
567         newrow[acols.plugin] = pi;
568
569         if (!amodel->children().empty()) {
570                 set_response_sensitive (RESPONSE_APPLY, true);
571         }
572 }
573
574 void
575 PluginSelector::btn_remove_clicked()
576 {
577         TreeModel::iterator iter = added_list.get_selection()->get_selected();
578
579         amodel->erase(iter);
580         if (amodel->children().empty()) {
581                 set_response_sensitive (RESPONSE_APPLY, false);
582         }
583 }
584
585 void
586 PluginSelector::display_selection_changed()
587 {
588         if (plugin_display.get_selection()->count_selected_rows() != 0) {
589                 btn_add->set_sensitive (true);
590         } else {
591                 btn_add->set_sensitive (false);
592         }
593 }
594
595 void
596 PluginSelector::added_list_selection_changed()
597 {
598         if (added_list.get_selection()->count_selected_rows() != 0) {
599                 btn_remove->set_sensitive (true);
600         } else {
601                 btn_remove->set_sensitive (false);
602         }
603 }
604
605 int
606 PluginSelector::run ()
607 {
608         ResponseType r;
609         TreeModel::Children::iterator i;
610
611         bool finish = false;
612
613         while (!finish) {
614
615                 SelectedPlugins plugins;
616                 r = (ResponseType) Dialog::run ();
617
618                 switch (r) {
619                 case RESPONSE_APPLY:
620                         for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
621                                 PluginInfoPtr pp = (*i)[acols.plugin];
622                                 PluginPtr p = load_plugin (pp);
623                                 if (p) {
624                                         plugins.push_back (p);
625                                 } else {
626                                         MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
627                                         msg.run ();
628                                 }
629                         }
630                         if (interested_object && !plugins.empty()) {
631                                 finish = !interested_object->use_plugins (plugins);
632                         }
633
634                         break;
635
636                 default:
637                         finish = true;
638                         break;
639                 }
640         }
641
642
643         hide();
644         amodel->clear();
645         interested_object = 0;
646
647         return (int) r;
648 }
649
650 void
651 PluginSelector::filter_button_clicked ()
652 {
653         filter_entry.set_text ("");
654 }
655
656 void
657 PluginSelector::filter_entry_changed ()
658 {
659         refill ();
660 }
661
662 void
663 PluginSelector::filter_mode_changed ()
664 {
665         std::string mode = filter_mode.get_active_text ();
666
667         if (mode == _("Favorites only") || mode == _("Hidden only")) {
668                 filter_entry.set_sensitive (false);
669                 filter_button.set_sensitive (false);
670                 fil_hidden_button.set_sensitive (false);
671                 fil_instruments_button.set_sensitive (false);
672                 fil_analysis_button.set_sensitive (false);
673                 fil_utils_button.set_sensitive (false);
674         } else {
675                 filter_entry.set_sensitive (true);
676                 filter_button.set_sensitive (true);
677                 fil_hidden_button.set_sensitive (true);
678                 fil_instruments_button.set_sensitive (true);
679                 fil_analysis_button.set_sensitive (true);
680                 fil_utils_button.set_sensitive (true);
681         }
682
683         refill ();
684 }
685
686 void
687 PluginSelector::on_show ()
688 {
689         ArdourDialog::on_show ();
690         filter_entry.grab_focus ();
691 }
692
693 struct PluginMenuCompareByCreator {
694         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
695                 int cmp;
696
697                 cmp = cmp_nocase_utf8 (a->creator, b->creator);
698
699                 if (cmp < 0) {
700                         return true;
701                 } else if (cmp == 0) {
702                         /* same creator ... compare names */
703                         if (cmp_nocase_utf8 (a->name, b->name) < 0) {
704                                 return true;
705                         }
706                 }
707                 return false;
708         }
709 };
710
711 struct PluginMenuCompareByName {
712         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
713                 int cmp;
714
715                 cmp = cmp_nocase_utf8 (a->name, b->name);
716
717                 if (cmp < 0) {
718                         return true;
719                 } else if (cmp == 0) {
720                         /* same name ... compare type */
721                         if (a->type < b->type) {
722                                 return true;
723                         }
724                 }
725                 return false;
726         }
727 };
728
729 struct PluginMenuCompareByCategory {
730         bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
731                 int cmp;
732
733                 cmp = cmp_nocase_utf8 (a->category, b->category);
734
735                 if (cmp < 0) {
736                         return true;
737                 } else if (cmp == 0) {
738                         /* same category ... compare names */
739                         if (cmp_nocase_utf8 (a->name, b->name) < 0) {
740                                 return true;
741                         }
742                 }
743                 return false;
744         }
745 };
746
747 /** @return Plugin menu. The caller should not delete it */
748 Gtk::Menu*
749 PluginSelector::plugin_menu()
750 {
751         return _plugin_menu;
752 }
753
754 void
755 PluginSelector::build_plugin_menu ()
756 {
757         PluginInfoList all_plugs;
758
759         all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
760         all_plugs.insert (all_plugs.end(), manager.lua_plugin_info().begin(), manager.lua_plugin_info().end());
761 #ifdef WINDOWS_VST_SUPPORT
762         all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
763 #endif
764 #ifdef LXVST_SUPPORT
765         all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
766 #endif
767 #ifdef MACVST_SUPPORT
768         all_plugs.insert (all_plugs.end(), manager.mac_vst_plugin_info().begin(), manager.mac_vst_plugin_info().end());
769 #endif
770 #ifdef AUDIOUNIT_SUPPORT
771         all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
772 #endif
773 #ifdef LV2_SUPPORT
774         all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
775 #endif
776
777         using namespace Menu_Helpers;
778
779         delete _plugin_menu;
780
781         _plugin_menu = manage (new Menu);
782         _plugin_menu->set_name("ArdourContextMenu");
783
784         MenuList& items = _plugin_menu->items();
785         items.clear ();
786
787         Gtk::Menu* favs = create_favs_menu(all_plugs);
788         items.push_back (MenuElem (_("Favorites"), *manage (favs)));
789
790         items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
791         items.push_back (SeparatorElem ());
792
793         Menu* by_creator = create_by_creator_menu(all_plugs);
794         items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
795
796         Menu* by_category = create_by_category_menu(all_plugs);
797         items.push_back (MenuElem (_("By Category"), *manage (by_category)));
798 }
799
800 string
801 GetPluginTypeStr(PluginInfoPtr info)
802 {
803         string type;
804         
805         switch (info->type) {
806         case LADSPA:
807                 type = X_(" (LADSPA)");
808                 break;
809         case AudioUnit:
810                 type = X_(" (AU)");
811                 break;
812         case LV2:
813                 type = X_(" (LV2)");
814                 break;
815         case Windows_VST:
816         case LXVST:
817         case MacVST:
818                 type = X_(" (VST)");
819                 break;
820         case Lua:
821                 type = X_(" (Lua)");
822                 break;
823         }
824         
825         return type;
826 }
827
828 Gtk::Menu*
829 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
830 {
831         using namespace Menu_Helpers;
832
833         Menu* favs = new Menu();
834         favs->set_name("ArdourContextMenu");
835
836         PluginMenuCompareByName cmp_by_name;
837         all_plugs.sort (cmp_by_name);
838
839         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
840                 if (manager.get_status (*i) == PluginManager::Favorite) {
841                         string typ = GetPluginTypeStr(*i);
842                         MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
843                         elem.get_child()->set_use_underline (false);
844                         favs->items().push_back (elem);
845                 }
846         }
847         return favs;
848 }
849
850 Gtk::Menu*
851 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
852 {
853         using namespace Menu_Helpers;
854
855         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
856         SubmenuMap creator_submenu_map;
857
858         Menu* by_creator = new Menu();
859         by_creator->set_name("ArdourContextMenu");
860
861         MenuList& by_creator_items = by_creator->items();
862         PluginMenuCompareByCreator cmp_by_creator;
863         all_plugs.sort (cmp_by_creator);
864
865         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
866
867                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
868
869                 string creator = (*i)->creator;
870                 string::size_type pos = 0;
871
872                 if ((*i)->type == ARDOUR::LADSPA) {
873                         /* stupid LADSPA creator strings */
874 #ifdef PLATFORM_WINDOWS
875                         while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
876 #else
877                         while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
878 #endif
879                 } else {
880                         pos = creator.length ();
881                 }
882
883                 // If there were too few characters to create a
884                 // meaningful name, mark this creator as 'Unknown'
885                 if (creator.length() < 2 || pos < 3) {
886                         creator = "Unknown";
887                 } else{
888                         creator = creator.substr (0, pos);
889                 }
890
891                 SubmenuMap::iterator x;
892                 Gtk::Menu* submenu;
893                 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
894                         submenu = x->second;
895                 } else {
896                         submenu = new Gtk::Menu;
897                         by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
898                         creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
899                         submenu->set_name("ArdourContextMenu");
900                 }
901                 string typ = GetPluginTypeStr(*i);
902                 MenuElem elem ((*i)->name+typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
903                 elem.get_child()->set_use_underline (false);
904                 submenu->items().push_back (elem);
905         }
906         return by_creator;
907 }
908
909 Gtk::Menu*
910 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
911 {
912         using namespace Menu_Helpers;
913
914         typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
915         SubmenuMap category_submenu_map;
916
917         Menu* by_category = new Menu();
918         by_category->set_name("ArdourContextMenu");
919
920         MenuList& by_category_items = by_category->items();
921         PluginMenuCompareByCategory cmp_by_category;
922         all_plugs.sort (cmp_by_category);
923
924         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
925
926                 if (manager.get_status (*i) == PluginManager::Hidden) continue;
927
928                 string category = (*i)->category;
929
930                 SubmenuMap::iterator x;
931                 Gtk::Menu* submenu;
932                 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
933                         submenu = x->second;
934                 } else {
935                         submenu = new Gtk::Menu;
936                         by_category_items.push_back (MenuElem (category, *manage (submenu)));
937                         category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
938                         submenu->set_name("ArdourContextMenu");
939                 }
940                 string typ = GetPluginTypeStr(*i);
941                 MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
942                 elem.get_child()->set_use_underline (false);
943                 submenu->items().push_back (elem);
944         }
945         return by_category;
946 }
947
948 void
949 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
950 {
951         PluginPtr p = load_plugin (pi);
952
953         if (p && interested_object) {
954                 SelectedPlugins plugins;
955                 plugins.push_back (p);
956                 interested_object->use_plugins (plugins);
957         }
958
959         interested_object = 0;
960 }
961
962 void
963 PluginSelector::favorite_changed (const std::string& path)
964 {
965         PluginInfoPtr pi;
966
967         if (in_row_change) {
968                 return;
969         }
970
971         in_row_change = true;
972
973         TreeModel::iterator iter = plugin_model->get_iter (path);
974
975         if (iter) {
976
977                 bool favorite = !(*iter)[plugin_columns.favorite];
978
979                 /* change state */
980
981                 (*iter)[plugin_columns.favorite] = favorite;
982                 (*iter)[plugin_columns.hidden] = false;
983                 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
984
985                 /* save new statuses list */
986
987                 pi = (*iter)[plugin_columns.plugin];
988
989                 manager.set_status (pi->type, pi->unique_id, status);
990
991                 manager.save_statuses ();
992
993                 build_plugin_menu ();
994         }
995         in_row_change = false;
996 }
997
998 void
999 PluginSelector::hidden_changed (const std::string& path)
1000 {
1001         PluginInfoPtr pi;
1002
1003         if (in_row_change) {
1004                 return;
1005         }
1006
1007         in_row_change = true;
1008
1009         TreeModel::iterator iter = plugin_model->get_iter (path);
1010
1011         if (iter) {
1012
1013                 bool hidden = !(*iter)[plugin_columns.hidden];
1014
1015                 /* change state */
1016
1017                 (*iter)[plugin_columns.favorite] = false;
1018                 (*iter)[plugin_columns.hidden] = hidden;
1019                 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
1020
1021                 /* save new statuses list */
1022
1023                 pi = (*iter)[plugin_columns.plugin];
1024
1025                 manager.set_status (pi->type, pi->unique_id, status);
1026
1027                 manager.save_statuses ();
1028
1029                 build_plugin_menu ();
1030         }
1031         in_row_change = false;
1032 }
1033
1034 bool
1035 PluginSelector::fil_hidden_button_release (GdkEventButton*)
1036 {
1037         _show_hidden = (fil_hidden_button.active_state() == 0);
1038         fil_hidden_button.set_active (_show_hidden);
1039         refill ();
1040         return false;
1041 }
1042
1043 static Gtkmm2ext::ActiveState next_state (Gtkmm2ext::ActiveState s){
1044         switch (s) {
1045                 case Gtkmm2ext::Off:
1046                         return Gtkmm2ext::ImplicitActive;
1047                         break;
1048                 case Gtkmm2ext::ImplicitActive:
1049                         return Gtkmm2ext::ExplicitActive;
1050                         break;
1051                 case Gtkmm2ext::ExplicitActive:
1052                         return Gtkmm2ext::Off;
1053                         break;
1054                 default: assert(0); break; // not reached
1055         }
1056         /* impossible, but keep some compiles happy */
1057         fatal << string_compose (_("programming error: %1"),
1058                         X_("Illegal Active State."))
1059                 << endmsg;
1060         abort(); /*NOTREACHED*/
1061         return Gtkmm2ext::Off;
1062 }
1063
1064 static Gtkmm2ext::ActiveState prev_state (Gtkmm2ext::ActiveState s){
1065         switch (s) {
1066                 case Gtkmm2ext::Off:
1067                         return Gtkmm2ext::ExplicitActive;
1068                         break;
1069                 case Gtkmm2ext::ImplicitActive:
1070                         return Gtkmm2ext::Off;
1071                         break;
1072                 case Gtkmm2ext::ExplicitActive:
1073                         return Gtkmm2ext::ImplicitActive;
1074                         break;
1075                 default: assert(0); break; // not reached
1076         }
1077         /* impossible, but keep some compiles happy */
1078         fatal << string_compose (_("programming error: %1"),
1079                         X_("Illegal Active State."))
1080                 << endmsg;
1081         abort(); /*NOTREACHED*/
1082         return Gtkmm2ext::Off;
1083 }
1084
1085 bool
1086 PluginSelector::fil_instruments_button_release (GdkEventButton* ev)
1087 {
1088         if (ev->button == 3) {
1089                 _show_instruments = prev_state (fil_instruments_button.active_state());
1090         } else {
1091                 _show_instruments = next_state (fil_instruments_button.active_state());
1092         }
1093         fil_instruments_button.set_active_state (_show_instruments);
1094         refill ();
1095         return false;
1096 }
1097
1098 bool
1099 PluginSelector::fil_analysis_button_release (GdkEventButton* ev)
1100 {
1101         if (ev->button == 3) {
1102                 _show_analysers = prev_state (fil_analysis_button.active_state());
1103         } else {
1104                 _show_analysers = next_state (fil_analysis_button.active_state());
1105         }
1106         fil_analysis_button.set_active_state (_show_analysers);
1107         refill ();
1108         return false;
1109 }
1110
1111 bool
1112 PluginSelector::fil_utils_button_release (GdkEventButton* ev)
1113 {
1114         if (ev->button == 3) {
1115                 _show_utils = prev_state (fil_utils_button.active_state());
1116         } else {
1117                 _show_utils = next_state (fil_utils_button.active_state());
1118         }
1119         fil_utils_button.set_active_state (_show_utils);
1120         refill ();
1121         return false;
1122 }
1123
1124 void
1125 PluginSelector::show_manager ()
1126 {
1127         show_all();
1128         run ();
1129 }
1130
1131 void
1132 PluginSelector::set_interested_object (PluginInterestedObject& obj)
1133 {
1134         interested_object = &obj;
1135 }