2 Copyright (C) 2000-2006 Paul Davis
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.
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.
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.
20 #include "gtk2ardour-config.h"
28 #include <gtkmm/button.h>
29 #include <gtkmm/comboboxtext.h>
30 #include <gtkmm/frame.h>
31 #include <gtkmm/messagedialog.h>
32 #include <gtkmm/notebook.h>
33 #include <gtkmm/stock.h>
34 #include <gtkmm/table.h>
35 #include <gtkmm/treestore.h>
37 #include "gtkmm2ext/utils.h"
39 #include "widgets/tooltips.h"
41 #include "pbd/convert.h"
42 #include "pbd/tokenizer.h"
44 #include "ardour/utils.h"
46 #include "plugin_selector.h"
47 #include "gui_thread.h"
48 #include "ui_config.h"
52 using namespace ARDOUR;
56 using namespace ArdourWidgets;
58 static const uint32_t MAX_CREATOR_LEN = 24;
60 PluginSelector::PluginSelector (PluginManager& mgr)
61 : ArdourDialog (_("Plugin Manager"), true, false)
62 , search_clear_button (Stock::CLEAR)
64 , _inhibit_refill (false)
66 set_name ("PluginSelectorWindow");
67 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
70 in_row_change = false;
72 //anytime the list changes ( Status, Tags, or scanned plugins ) we need to rebuild redirect-box plugin selector menu
73 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
75 //these are used to update the info of specific entries, while they are being edited
76 manager.PluginStatusChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::plugin_status_changed, this, _1, _2, _3), gui_context());
77 manager.PluginTagChanged.connect(plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::tags_changed, this, _1, _2, _3), gui_context());
79 plugin_model = Gtk::ListStore::create (plugin_columns);
80 plugin_display.set_model (plugin_model);
81 /* XXX translators: try to convert "Fav" into a short term
82 * related to "favorite" and "Hid" into a short term
85 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
86 plugin_display.append_column (_("Hide"), plugin_columns.hidden);
87 plugin_display.append_column (_("Name"), plugin_columns.name);
88 plugin_display.append_column (_("Tags"), plugin_columns.tags);
89 plugin_display.append_column (_("Creator"), plugin_columns.creator);
90 plugin_display.append_column (_("Type"), plugin_columns.type_name);
91 plugin_display.append_column (_("Audio I/O"),plugin_columns.audio_io);
92 plugin_display.append_column (_("MIDI I/O"), plugin_columns.midi_io);
93 plugin_display.set_headers_visible (true);
94 plugin_display.set_headers_clickable (true);
95 plugin_display.set_reorderable (false);
96 plugin_display.set_rules_hint (true);
97 plugin_display.add_object_drag (plugin_columns.plugin.index(), "PluginInfoPtr");
98 plugin_display.set_drag_column (plugin_columns.name.index());
100 // setting a sort-column prevents re-ordering via Drag/Drop
101 plugin_model->set_sort_column (plugin_columns.name.index(), Gtk::SORT_ASCENDING);
103 plugin_display.set_name("PluginSelectorDisplay");
104 plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
105 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
107 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
108 fav_cell->property_activatable() = true;
109 fav_cell->property_radio() = true;
110 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
112 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
113 hidden_cell->property_activatable() = true;
114 hidden_cell->property_radio() = true;
115 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
117 scroller.set_border_width(10);
118 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
119 scroller.add(plugin_display);
121 amodel = Gtk::ListStore::create(acols);
122 added_list.set_model (amodel);
123 added_list.append_column (_("Plugins to be connected"), acols.text);
124 added_list.set_headers_visible (true);
125 added_list.set_reorderable (false);
127 for (int i = 2; i <= 7; ++i) {
128 Gtk::TreeView::Column* column = plugin_display.get_column(i);
130 column->set_sort_column(i);
134 ascroller.set_border_width(10);
135 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
136 ascroller.add(added_list);
137 btn_add = manage(new Gtk::Button(Stock::ADD));
138 set_tooltip(*btn_add, _("Add a plugin to the effect list"));
139 btn_add->set_sensitive (false);
140 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
141 btn_remove->set_sensitive (false);
142 set_tooltip(*btn_remove, _("Remove a plugin from the effect list"));
144 btn_add->set_name("PluginSelectorButton");
145 btn_remove->set_name("PluginSelectorButton");
149 Gtk::Table* search_table = manage(new Gtk::Table(2, 2));
151 search_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::search_entry_changed));
152 search_clear_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::search_clear_button_clicked));
154 _search_name_checkbox = manage (new ArdourButton (_("Name"), ArdourButton::led_default_elements, true));
155 _search_name_checkbox->set_active(true);
156 _search_name_checkbox->set_name ("pluginlist filter button");
158 _search_tags_checkbox = manage (new ArdourButton (_("Tags"), ArdourButton::led_default_elements, true));
159 _search_tags_checkbox->set_active(true);
160 _search_tags_checkbox->set_name ("pluginlist filter button");
162 _search_ignore_checkbox = manage (new ArdourButton(_("Ignore Filters when searching"), ArdourButton::led_default_elements, true));
163 _search_ignore_checkbox->set_active(true);
164 _search_ignore_checkbox->set_name ("pluginlist filter button");
166 Gtk::Label* search_help_label1 = manage (new Label(
167 _("All search terms must be matched."), Gtk::ALIGN_LEFT));
169 Gtk::Label* search_help_label2 = manage (new Label(
170 _("Ex: \"ess dyn\" will find \"dynamic de-esser\" but not \"de-esser\"."), Gtk::ALIGN_LEFT));
172 search_table->attach (search_entry, 0, 3, 0, 1, FILL|EXPAND, FILL);
173 search_table->attach (search_clear_button, 3, 4, 0, 1, FILL, FILL);
174 search_table->attach (*_search_name_checkbox, 0, 1, 1, 2, FILL, FILL);
175 search_table->attach (*_search_tags_checkbox, 1, 2, 1, 2, FILL, FILL);
176 search_table->attach (*_search_ignore_checkbox,2, 3, 1, 2, FILL, FILL);
177 search_table->attach (*search_help_label1, 0, 3, 2, 3, FILL, FILL);
178 search_table->attach (*search_help_label2, 0, 3, 3, 4, FILL, FILL);
180 search_table->set_border_width (4);
181 search_table->set_col_spacings (4);
182 search_table->set_row_spacings (4);
184 Frame* search_frame = manage (new Frame);
185 search_frame->set_name ("BaseFrame");
186 search_frame->set_label (_("Search"));
187 search_frame->add (*search_table);
188 search_frame->show_all ();
190 _search_name_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::refill));
191 _search_tags_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::refill));
192 _search_ignore_checkbox->signal_clicked.connect (sigc::mem_fun (*this, &PluginSelector::set_sensitive_widgets));
196 Gtk::RadioButtonGroup fil_radio_group;
198 _fil_effects_radio = manage (new RadioButton (fil_radio_group, _("Show Effects Only")));
199 _fil_instruments_radio = manage (new RadioButton (fil_radio_group, _("Show Instruments Only")));
200 _fil_utils_radio = manage (new RadioButton (fil_radio_group, _("Show Utilities Only")));
201 _fil_favorites_radio = manage (new RadioButton (fil_radio_group, _("Show Favorites Only")));
202 _fil_hidden_radio = manage (new RadioButton (fil_radio_group, _("Show Hidden Only")));
203 _fil_all_radio = manage (new RadioButton (fil_radio_group, _("Show All")));
205 //_fil_type_combo = manage (new ComboBoxText);
206 _fil_type_combo.append_text_item (_("Show All Formats"));
207 _fil_type_combo.append_text_item (X_("VST"));
208 #ifdef AUDIOUNIT_SUPPORT
209 _fil_type_combo.append_text_item (X_("AudioUnit"));
212 _fil_type_combo.append_text_item (X_("LV2"));
214 _fil_type_combo.append_text_item (X_("Lua"));
215 _fil_type_combo.append_text_item (X_("LADSPA"));
216 _fil_type_combo.set_text (_("Show All Formats"));
218 /* note: _fil_creator_combo menu gets filled in build_plugin_menu */
219 _fil_creator_combo.set_text_ellipsize (Pango::ELLIPSIZE_END);
220 _fil_creator_combo.set_layout_ellipsize_width (PANGO_SCALE * 160 * UIConfiguration::instance ().get_ui_scale ());
222 _fil_channel_combo.append_text_item (_("Audio I/O"));
223 _fil_channel_combo.append_text_item (_("Mono Audio I/O"));
224 _fil_channel_combo.append_text_item (_("Stereo Audio I/O"));
225 _fil_channel_combo.append_text_item (_("MIDI I/O (only)"));
226 _fil_channel_combo.append_text_item (_("Show All I/O"));
228 _fil_channel_combo.set_text (_("Audio I/O"));
230 _fil_channel_combo.set_text (_("Show All I/O"));
233 VBox* filter_vbox = manage (new VBox);
234 filter_vbox->pack_start (*_fil_effects_radio, false, false);
235 filter_vbox->pack_start (*_fil_instruments_radio, false, false);
236 filter_vbox->pack_start (*_fil_utils_radio, false, false);
237 filter_vbox->pack_start (*_fil_favorites_radio, false, false);
238 filter_vbox->pack_start (*_fil_hidden_radio, false, false);
239 filter_vbox->pack_start (*_fil_all_radio, false, false);
240 filter_vbox->pack_start (_fil_type_combo, false, false);
241 filter_vbox->pack_start (_fil_creator_combo, false, false);
242 filter_vbox->pack_start (_fil_channel_combo, false, false);
244 filter_vbox->set_border_width (4);
245 filter_vbox->set_spacing (4);
247 Frame* filter_frame = manage (new Frame);
248 filter_frame->set_name ("BaseFrame");
249 filter_frame->set_label (_("Filter"));
250 filter_frame->add (*filter_vbox);
251 filter_frame->show_all ();
253 _fil_effects_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
254 _fil_instruments_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
255 _fil_utils_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
256 _fil_favorites_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
257 _fil_hidden_radio->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::refill));
259 _fil_type_combo.StateChanged.connect (sigc::mem_fun (*this, &PluginSelector::refill));
260 _fil_creator_combo.StateChanged.connect (sigc::mem_fun (*this, &PluginSelector::refill));
261 _fil_channel_combo.StateChanged.connect (sigc::mem_fun (*this, &PluginSelector::refill));
265 Gtk::Table* tagging_table = manage(new Gtk::Table(1, 2));
266 tagging_table->set_border_width (4);
267 tagging_table->set_col_spacings (4);
268 tagging_table->set_row_spacings (4);
270 tag_entry = manage (new Gtk::Entry);
271 tag_entry_connection = tag_entry->signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::tag_entry_changed));
273 tag_reset_button = manage (new Button (_("Reset")));
274 tag_reset_button->signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::tag_reset_button_clicked));
276 Gtk::Label* tagging_help_label1 = manage (new Label(
277 _("Enter space-separated, one-word Tags for the selected plugin."), Gtk::ALIGN_LEFT));
279 Gtk::Label* tagging_help_label2 = manage (new Label(
280 _("You can include dashes, colons or underscores in a Tag."), Gtk::ALIGN_LEFT));
282 Gtk::Label* tagging_help_label3 = manage (new Label(
283 _("Ex: \"dynamic de-esser vocal\" applies 3 Tags."), Gtk::ALIGN_LEFT));
286 tagging_table->attach (*tag_entry, 0, 1, p, p+1, FILL|EXPAND, FILL);
287 tagging_table->attach (*tag_reset_button, 1, 2, p, p+1, FILL, FILL); p++;
288 tagging_table->attach (*tagging_help_label1, 0, 2, p, p+1, FILL, FILL); p++;
289 tagging_table->attach (*tagging_help_label2, 0, 2, p, p+1, FILL, FILL); p++;
290 tagging_table->attach (*tagging_help_label3, 0, 2, p, p+1, FILL, FILL); p++;
292 Frame* tag_frame = manage (new Frame);
293 tag_frame->set_name ("BaseFrame");
294 tag_frame->set_label (_("Tags for Selected Plugin"));
295 tag_frame->add (*tagging_table);
296 tag_frame->show_all ();
298 /* Add & remove buttons */
300 HBox* add_remove = manage (new HBox);
301 add_remove->pack_start (*btn_add, true, true);
302 add_remove->pack_start (*btn_remove, true, true);
304 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
305 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
306 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
307 added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
309 added_list.set_name("PluginSelectorList");
311 /* Top-level Layout */
313 VBox* to_be_inserted_vbox = manage (new VBox);
314 to_be_inserted_vbox->pack_start (ascroller);
315 to_be_inserted_vbox->pack_start (*add_remove, false, false);
316 to_be_inserted_vbox->set_size_request (200, -1);
318 Gtk::Table* table = manage(new Gtk::Table(3, 3));
319 table->set_size_request(-1, 600);
320 table->attach (scroller, 0, 3, 0, 5); /* this is the main plugin list */
321 table->attach (*search_frame, 0, 1, 6, 7, FILL, FILL, 5, 5);
322 table->attach (*tag_frame, 0, 1, 7, 8, FILL, FILL, 5, 5);
323 table->attach (*filter_frame, 1, 2, 6, 8, FILL, FILL, 5, 5);
324 table->attach (*to_be_inserted_vbox, 2, 3, 6, 8, FILL|EXPAND, FILL, 5, 5); /* to be inserted... */
326 add_button (Stock::CLOSE, RESPONSE_CLOSE);
327 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
328 set_default_response (RESPONSE_APPLY);
329 set_response_sensitive (RESPONSE_APPLY, false);
330 get_vbox()->pack_start (*table);
332 table->set_name("PluginSelectorTable");
334 plugin_display.grab_focus();
336 build_plugin_menu ();
337 display_selection_changed ();
340 PluginSelector::~PluginSelector ()
346 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
352 PluginSelector::added_row_clicked(GdkEventButton* event)
354 if (event->type == GDK_2BUTTON_PRESS)
355 btn_remove_clicked();
359 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& searchstr)
362 bool maybe_show = false;
364 if (!searchstr.empty()) {
368 if (_search_name_checkbox->get_active()) { /* name contains */
369 compstr = info->name;
370 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
371 if (compstr.find (searchstr) != string::npos) {
376 if (_search_tags_checkbox->get_active()) { /* tag contains */
377 compstr = manager.get_tags_as_string (info);
378 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
379 if (compstr.find (searchstr) != string::npos) {
388 /* user asked to ignore filters */
389 if (maybe_show && _search_ignore_checkbox->get_active()) {
390 if (manager.get_status (info) == PluginManager::Hidden) {
397 if (_fil_effects_radio->get_active() && !info->is_effect()) {
401 if (_fil_instruments_radio->get_active() && !info->is_instrument()) {
405 if (_fil_utils_radio->get_active() && !(info->is_utility() || info->is_analyzer())) {
409 if (_fil_favorites_radio->get_active() && !(manager.get_status (info) == PluginManager::Favorite)) {
413 if (_fil_hidden_radio->get_active() && !(manager.get_status (info) == PluginManager::Hidden)) {
417 if (!_fil_hidden_radio->get_active() && manager.get_status (info) == PluginManager::Hidden) {
421 /* Filter "type" combobox */
423 if (_fil_type_combo.get_text() == X_("VST") && PluginManager::to_generic_vst(info->type) != LXVST) {
427 if (_fil_type_combo.get_text() == X_("AudioUnit") && info->type != AudioUnit) {
432 if (_fil_type_combo.get_text() == X_("LV2") && info->type != LV2) {
437 if (_fil_type_combo.get_text() == X_("Lua") && info->type != Lua) {
441 if (_fil_type_combo.get_text() == X_("LADSPA") && info->type != LADSPA) {
445 /* Filter "creator" combobox */
447 if (_fil_creator_combo.get_text() != _("Show All Creators")) {
448 if (_fil_creator_combo.get_text() != info->creator) {
453 /* Filter "I/O" combobox */
455 if (_fil_channel_combo.get_text() != _("Show All I/O") || info->reconfigurable_io ()) {
458 if (info->reconfigurable_io ()) {
459 return true; // who knows.... ?
463 if (_fil_channel_combo.get_text() == _("Audio I/O")) {
464 if ((info->n_inputs.n_audio() == 0 || info->n_outputs.n_audio() == 0)) {
469 if (_fil_channel_combo.get_text() == _("Mono Audio I/O")) {
470 if (info->n_inputs.n_audio() != 1 || info->n_outputs.n_audio() != 1) {
475 if (_fil_channel_combo.get_text() == _("Stereo Audio I/O")) {
476 if (info->n_inputs.n_audio() != 2 || info->n_outputs.n_audio() != 2) {
481 if (_fil_channel_combo.get_text() == _("MIDI I/O (only)")) {
482 if ((info->n_inputs.n_audio() != 0 || info->n_outputs.n_audio() == 0)) {
493 PluginSelector::setup_search_string (string& searchstr)
495 searchstr = search_entry.get_text ();
496 transform (searchstr.begin(), searchstr.end(), searchstr.begin(), ::toupper);
500 PluginSelector::set_sensitive_widgets ()
502 if (_search_ignore_checkbox->get_active() && !search_entry.get_text().empty()) {
503 _fil_effects_radio->set_sensitive(false);
504 _fil_instruments_radio->set_sensitive(false);
505 _fil_utils_radio->set_sensitive(false);
506 _fil_favorites_radio->set_sensitive(false);
507 _fil_hidden_radio->set_sensitive(false);
508 _fil_all_radio->set_sensitive(false);
509 _inhibit_refill = true;
510 _fil_type_combo.set_sensitive(false);
511 _fil_creator_combo.set_sensitive(false);
512 _fil_channel_combo.set_sensitive(false);
513 _inhibit_refill = false;
515 _fil_effects_radio->set_sensitive(true);
516 _fil_instruments_radio->set_sensitive(true);
517 _fil_utils_radio->set_sensitive(true);
518 _fil_favorites_radio->set_sensitive(true);
519 _fil_hidden_radio->set_sensitive(true);
520 _fil_all_radio->set_sensitive(true);
521 _inhibit_refill = true;
522 _fil_type_combo.set_sensitive(true);
523 _fil_creator_combo.set_sensitive(true);
524 _fil_channel_combo.set_sensitive(true);
525 _inhibit_refill = false;
527 if (!search_entry.get_text().empty()) {
533 PluginSelector::refill ()
535 if (_inhibit_refill) {
539 std::string searchstr;
541 in_row_change = true;
543 plugin_display.set_model (Glib::RefPtr<Gtk::TreeStore>(0));
547 bool sorted = plugin_model->get_sort_column_id (sort_col, sort_type);
549 /* Disable sorting to gain performance */
550 plugin_model->set_sort_column (-2, SORT_ASCENDING);
552 plugin_model->clear ();
554 setup_search_string (searchstr);
556 ladspa_refiller (searchstr);
557 lv2_refiller (searchstr);
558 vst_refiller (searchstr);
559 lxvst_refiller (searchstr);
560 mac_vst_refiller (searchstr);
561 au_refiller (searchstr);
562 lua_refiller (searchstr);
564 in_row_change = false;
566 plugin_display.set_model (plugin_model);
568 plugin_model->set_sort_column (sort_col, sort_type);
573 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& searchstr, const char* type)
577 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
579 if (show_this_plugin (*i, searchstr)) {
581 TreeModel::Row newrow = *(plugin_model->append());
582 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
583 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
585 string name = (*i)->name;
586 if (name.length() > 48) {
587 name = name.substr (0, 48);
590 newrow[plugin_columns.name] = name;
592 newrow[plugin_columns.type_name] = type;
595 string creator = (*i)->creator;
596 string::size_type pos = 0;
597 if ((*i)->type == ARDOUR::LADSPA) {
598 /* stupid LADSPA creator strings */
599 #ifdef PLATFORM_WINDOWS
600 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
602 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
605 pos = creator.length ();
607 // If there were too few characters to create a
608 // meaningful name, mark this creator as 'Unknown'
609 if (creator.length() < 2 || pos < 3) {
612 creator = creator.substr (0, pos);
615 if (creator.length() > MAX_CREATOR_LEN) {
616 creator = creator.substr (0, MAX_CREATOR_LEN);
617 creator.append("...");
619 newrow[plugin_columns.creator] = creator;
622 string tags = manager.get_tags_as_string(*i);
623 if (tags.length() > 32) {
624 tags = tags.substr (0, 32);
627 newrow[plugin_columns.tags] = tags;
629 if ((*i)->reconfigurable_io ()) {
630 newrow[plugin_columns.audio_io] = "* / *";
631 newrow[plugin_columns.midi_io] = "* / *";
633 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_audio(), (*i)->n_outputs.n_audio());
634 newrow[plugin_columns.audio_io] = buf;
635 snprintf (buf, sizeof(buf), "%d / %d", (*i)->n_inputs.n_midi(), (*i)->n_outputs.n_midi());
636 newrow[plugin_columns.midi_io] = buf;
639 newrow[plugin_columns.plugin] = *i;
645 PluginSelector::ladspa_refiller (const std::string& searchstr)
647 refiller (manager.ladspa_plugin_info(), searchstr, "LADSPA");
651 PluginSelector::lua_refiller (const std::string& searchstr)
653 refiller (manager.lua_plugin_info(), searchstr, "Lua");
657 PluginSelector::lv2_refiller (const std::string& searchstr)
660 refiller (manager.lv2_plugin_info(), searchstr, "LV2");
665 #ifdef WINDOWS_VST_SUPPORT
666 PluginSelector::vst_refiller (const std::string& searchstr)
668 PluginSelector::vst_refiller (const std::string&)
671 #ifdef WINDOWS_VST_SUPPORT
672 refiller (manager.windows_vst_plugin_info(), searchstr, "VST");
678 PluginSelector::lxvst_refiller (const std::string& searchstr)
680 PluginSelector::lxvst_refiller (const std::string&)
684 refiller (manager.lxvst_plugin_info(), searchstr, "LXVST");
689 #ifdef MACVST_SUPPORT
690 PluginSelector::mac_vst_refiller (const std::string& searchstr)
692 PluginSelector::mac_vst_refiller (const std::string&)
695 #ifdef MACVST_SUPPORT
696 refiller (manager.mac_vst_plugin_info(), searchstr, "MacVST");
701 #ifdef AUDIOUNIT_SUPPORT
702 PluginSelector::au_refiller (const std::string& searchstr)
704 PluginSelector::au_refiller (const std::string&)
707 #ifdef AUDIOUNIT_SUPPORT
708 refiller (manager.au_plugin_info(), searchstr, "AU");
713 PluginSelector::load_plugin (PluginInfoPtr pi)
719 return pi->load (*_session);
723 PluginSelector::btn_add_clicked()
725 if (plugin_display.get_selection()->count_selected_rows() == 0) {
726 /* may happen with ctrl + double-click un-selecting but activating a row */
731 TreeModel::Row newrow = *(amodel->append());
734 row = *(plugin_display.get_selection()->get_selected());
735 name = row[plugin_columns.name];
736 pi = row[plugin_columns.plugin];
738 newrow[acols.text] = name;
739 newrow[acols.plugin] = pi;
741 if (!amodel->children().empty()) {
742 set_response_sensitive (RESPONSE_APPLY, true);
747 PluginSelector::btn_remove_clicked()
749 TreeModel::iterator iter = added_list.get_selection()->get_selected();
752 if (amodel->children().empty()) {
753 set_response_sensitive (RESPONSE_APPLY, false);
758 PluginSelector::display_selection_changed()
760 tag_entry_connection.block ();
761 if (plugin_display.get_selection()->count_selected_rows() != 0) {
763 /* a plugin row is selected; allow the user to edit the "tags" on it. */
764 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
765 string tags = manager.get_tags_as_string (row[plugin_columns.plugin]);
766 tag_entry->set_text (tags);
768 tag_entry->set_sensitive (true);
769 tag_reset_button->set_sensitive (true);
770 btn_add->set_sensitive (true);
773 tag_entry->set_text ("");
775 tag_entry->set_sensitive (false);
776 tag_reset_button->set_sensitive (false);
777 btn_add->set_sensitive (false);
779 tag_entry_connection.unblock ();
783 PluginSelector::added_list_selection_changed()
785 if (added_list.get_selection()->count_selected_rows() != 0) {
786 btn_remove->set_sensitive (true);
788 btn_remove->set_sensitive (false);
793 PluginSelector::run ()
796 TreeModel::Children::iterator i;
802 SelectedPlugins plugins;
803 r = (ResponseType) Dialog::run ();
807 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
808 PluginInfoPtr pp = (*i)[acols.plugin];
809 PluginPtr p = load_plugin (pp);
811 plugins.push_back (p);
813 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
817 if (interested_object && !plugins.empty()) {
818 finish = !interested_object->use_plugins (plugins);
832 interested_object = 0;
834 if (_need_tag_save) {
838 if (_need_status_save) {
839 manager.save_statuses();
842 if ( _need_tag_save || _need_status_save || _need_menu_rebuild ) {
843 manager.PluginListChanged(); //emit signal
850 PluginSelector::search_clear_button_clicked ()
852 search_entry.set_text ("");
856 PluginSelector::tag_reset_button_clicked ()
858 if (plugin_display.get_selection()->count_selected_rows() != 0) {
859 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
860 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
861 manager.reset_tags (pi);
862 display_selection_changed ();
863 _need_tag_save = true;
864 _need_menu_rebuild = true;
869 PluginSelector::search_entry_changed ()
871 set_sensitive_widgets();
872 if (search_entry.get_text().empty()) {
878 PluginSelector::tag_entry_changed ()
880 if (plugin_display.get_selection()->count_selected_rows() != 0) {
881 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
883 ARDOUR::PluginInfoPtr pi = row[plugin_columns.plugin];
884 manager.set_tags (pi->type, pi->unique_id, tag_entry->get_text(), pi->name, PluginManager::FromGui);
886 _need_tag_save = true;
887 _need_menu_rebuild = true;
892 PluginSelector::tags_changed (PluginType t, std::string unique_id, std::string tags)
894 if (plugin_display.get_selection()->count_selected_rows() != 0) {
895 TreeModel::Row row = *(plugin_display.get_selection()->get_selected());
896 if (tags.length() > 32) {
897 tags = tags.substr (0, 32);
900 row[plugin_columns.tags] = tags;
905 PluginSelector::plugin_status_changed (PluginType t, std::string uid, PluginManager::PluginStatusType stat)
907 Gtk::TreeModel::iterator i;
908 for (i = plugin_model->children().begin(); i != plugin_model->children().end(); ++i) {
909 PluginInfoPtr pp = (*i)[plugin_columns.plugin];
910 if ((pp->type == t) && (pp->unique_id == uid)) {
911 (*i)[plugin_columns.favorite] = (stat == PluginManager::Favorite) ? true : false;
912 (*i)[plugin_columns.hidden] = (stat == PluginManager::Hidden) ? true : false;
914 /* if plug was hidden, remove it from the view */
915 if (stat == PluginManager::Hidden) {
916 if (!_fil_hidden_radio->get_active() && !_fil_all_radio->get_active()) {
917 plugin_model->erase(i);
919 } else if (_fil_hidden_radio->get_active()) {
920 plugin_model->erase(i);
922 /* if no longer a favorite, remove it from the view */
923 if (stat != PluginManager::Favorite && _fil_favorites_radio->get_active()) {
924 plugin_model->erase(i);
933 PluginSelector::on_show ()
935 ArdourDialog::on_show ();
936 search_entry.grab_focus ();
940 _need_tag_save = false;
941 _need_status_save = false;
942 _need_menu_rebuild = false;
945 struct PluginMenuCompareByCreator {
946 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
949 cmp = cmp_nocase_utf8 (a->creator, b->creator);
953 } else if (cmp == 0) {
954 /* same creator ... compare names */
955 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
963 struct PluginMenuCompareByName {
964 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
967 cmp = cmp_nocase_utf8 (a->name, b->name);
971 } else if (cmp == 0) {
972 /* same name ... compare type */
973 if (a->type < b->type) {
981 /** @return Plugin menu. The caller should not delete it */
983 PluginSelector::plugin_menu()
989 PluginSelector::build_plugin_menu ()
991 PluginInfoList all_plugs;
993 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
994 all_plugs.insert (all_plugs.end(), manager.lua_plugin_info().begin(), manager.lua_plugin_info().end());
995 #ifdef WINDOWS_VST_SUPPORT
996 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
999 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
1001 #ifdef MACVST_SUPPORT
1002 all_plugs.insert (all_plugs.end(), manager.mac_vst_plugin_info().begin(), manager.mac_vst_plugin_info().end());
1004 #ifdef AUDIOUNIT_SUPPORT
1005 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
1008 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
1011 using namespace Menu_Helpers;
1013 delete _plugin_menu;
1015 _plugin_menu = manage (new Menu);
1016 _plugin_menu->set_name("ArdourContextMenu");
1018 MenuList& items = _plugin_menu->items();
1021 Gtk::Menu* favs = create_favs_menu(all_plugs);
1022 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
1024 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
1025 items.push_back (SeparatorElem ());
1027 Menu* by_creator = create_by_creator_menu(all_plugs);
1028 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
1030 Menu* by_tags = create_by_tags_menu(all_plugs);
1031 items.push_back (MenuElem (_("By Tags"), *manage (by_tags)));
1035 GetPluginTypeStr(PluginInfoPtr info)
1039 switch (info->type) {
1041 type = X_(" (LADSPA)");
1047 type = X_(" (LV2)");
1052 type = X_(" (VST)");
1055 type = X_(" (Lua)");
1063 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
1065 using namespace Menu_Helpers;
1067 Menu* favs = new Menu();
1068 favs->set_name("ArdourContextMenu");
1070 PluginMenuCompareByName cmp_by_name;
1071 all_plugs.sort (cmp_by_name);
1073 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1074 if (manager.get_status (*i) == PluginManager::Favorite) {
1075 string typ = GetPluginTypeStr(*i);
1076 MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1077 elem.get_child()->set_use_underline (false);
1078 favs->items().push_back (elem);
1085 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
1087 _inhibit_refill = true;
1088 _fil_creator_combo.clear_items ();
1089 _fil_creator_combo.append_text_item (_("Show All Creators"));
1090 _fil_creator_combo.set_text (_("Show All Creators"));
1091 _inhibit_refill = false;
1093 using namespace Menu_Helpers;
1095 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1096 SubmenuMap creator_submenu_map;
1098 Menu* by_creator = new Menu();
1099 by_creator->set_name("ArdourContextMenu");
1101 MenuList& by_creator_items = by_creator->items();
1102 PluginMenuCompareByCreator cmp_by_creator;
1103 all_plugs.sort (cmp_by_creator);
1105 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1107 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1109 string creator = (*i)->creator;
1111 /* If there were too few characters to create a
1112 * meaningful name, mark this creator as 'Unknown'
1114 if (creator.length() < 2) {
1115 creator = "Unknown";
1118 SubmenuMap::iterator x;
1120 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
1121 submenu = x->second;
1124 _fil_creator_combo.append_text_item (creator);
1126 submenu = new Gtk::Menu;
1127 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
1128 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
1129 submenu->set_name("ArdourContextMenu");
1131 string typ = GetPluginTypeStr(*i);
1132 MenuElem elem ((*i)->name+typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1133 elem.get_child()->set_use_underline (false);
1134 submenu->items().push_back (elem);
1141 PluginSelector::create_by_tags_menu (ARDOUR::PluginInfoList& all_plugs)
1143 using namespace Menu_Helpers;
1145 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
1146 SubmenuMap tags_submenu_map;
1148 Menu* by_tags = new Menu();
1149 by_tags->set_name("ArdourContextMenu");
1150 MenuList& by_tags_items = by_tags->items();
1152 std::vector<std::string> all_tags = manager.get_all_tags (PluginManager::NoHidden);
1153 for (vector<string>::iterator t = all_tags.begin(); t != all_tags.end(); ++t) {
1154 Gtk::Menu *submenu = new Gtk::Menu;
1155 by_tags_items.push_back (MenuElem (*t, *manage (submenu)));
1156 tags_submenu_map.insert (pair<std::string,Menu*> (*t, submenu));
1157 submenu->set_name("ArdourContextMenu");
1160 PluginMenuCompareByName cmp_by_name;
1161 all_plugs.sort (cmp_by_name);
1163 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
1165 if (manager.get_status (*i) == PluginManager::Hidden) continue;
1167 /* for each tag in the plugins tag list, add it to that submenu */
1168 vector<string> tokens = manager.get_tags(*i);
1169 for (vector<string>::iterator t = tokens.begin(); t != tokens.end(); ++t) {
1170 SubmenuMap::iterator x;
1172 if ((x = tags_submenu_map.find (*t)) != tags_submenu_map.end()) {
1173 submenu = x->second;
1174 string typ = GetPluginTypeStr(*i);
1175 MenuElem elem ((*i)->name + typ, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
1176 elem.get_child()->set_use_underline (false);
1177 submenu->items().push_back (elem);
1185 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
1187 PluginPtr p = load_plugin (pi);
1189 if (p && interested_object) {
1190 SelectedPlugins plugins;
1191 plugins.push_back (p);
1192 interested_object->use_plugins (plugins);
1195 interested_object = 0;
1199 PluginSelector::favorite_changed (const std::string& path)
1203 if (in_row_change) {
1207 in_row_change = true;
1209 TreeModel::iterator iter = plugin_model->get_iter (path);
1213 bool favorite = !(*iter)[plugin_columns.favorite];
1217 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
1219 /* save new statuses list */
1221 pi = (*iter)[plugin_columns.plugin];
1223 manager.set_status (pi->type, pi->unique_id, status);
1225 _need_status_save = true;
1226 _need_menu_rebuild = true;
1228 in_row_change = false;
1232 PluginSelector::hidden_changed (const std::string& path)
1236 if (in_row_change) {
1240 in_row_change = true;
1242 TreeModel::iterator iter = plugin_model->get_iter (path);
1246 bool hidden = !(*iter)[plugin_columns.hidden];
1250 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
1252 /* save new statuses list */
1254 pi = (*iter)[plugin_columns.plugin];
1256 manager.set_status (pi->type, pi->unique_id, status);
1258 _need_status_save = true;
1259 _need_menu_rebuild = true;
1261 in_row_change = false;
1265 PluginSelector::show_manager ()
1272 PluginSelector::set_interested_object (PluginInterestedObject& obj)
1274 interested_object = &obj;