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