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/table.h>
29 #include <gtkmm/stock.h>
30 #include <gtkmm/button.h>
31 #include <gtkmm/notebook.h>
33 #include <gtkmm2ext/utils.h>
35 #include "pbd/convert.h"
37 #include "ardour/plugin_manager.h"
38 #include "ardour/plugin.h"
39 #include "ardour/utils.h"
41 #include "ardour_ui.h"
42 #include "plugin_selector.h"
43 #include "gui_thread.h"
47 using namespace ARDOUR;
52 static const char* _filter_mode_strings[] = {
55 N_("Category contains"),
56 N_("Author contains"),
57 N_("Library contains"),
63 PluginSelector::PluginSelector (PluginManager& mgr)
64 : ArdourDialog (_("Plugin Manager"), true, false)
65 , filter_button (Stock::CLEAR)
69 set_name ("PluginSelectorWindow");
70 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
73 in_row_change = false;
75 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
76 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), 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 (_("Available Plugins"), plugin_columns.name);
88 plugin_display.append_column (_("Type"), plugin_columns.type_name);
89 plugin_display.append_column (_("Category"), plugin_columns.category);
90 plugin_display.append_column (_("Creator"), plugin_columns.creator);
91 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
92 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
93 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
94 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
95 plugin_display.set_headers_visible (true);
96 plugin_display.set_headers_clickable (true);
97 plugin_display.set_reorderable (false);
98 plugin_display.set_rules_hint (true);
100 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
101 fav_cell->property_activatable() = true;
102 fav_cell->property_radio() = true;
103 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
105 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
106 hidden_cell->property_activatable() = true;
107 hidden_cell->property_radio() = true;
108 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
110 scroller.set_border_width(10);
111 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
112 scroller.add(plugin_display);
114 amodel = Gtk::ListStore::create(acols);
115 added_list.set_model (amodel);
116 added_list.append_column (_("Plugins to be connected"), acols.text);
117 added_list.set_headers_visible (true);
118 added_list.set_reorderable (false);
120 for (int i = 0; i <=8; i++) {
121 Gtk::TreeView::Column* column = plugin_display.get_column(i);
122 column->set_sort_column(i);
125 ascroller.set_border_width(10);
126 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
127 ascroller.add(added_list);
128 btn_add = manage(new Gtk::Button(Stock::ADD));
129 ARDOUR_UI::instance()->set_tip(*btn_add, _("Add a plugin to the effect list"));
130 btn_add->set_sensitive (false);
131 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
132 btn_remove->set_sensitive (false);
133 ARDOUR_UI::instance()->set_tip(*btn_remove, _("Remove a plugin from the effect list"));
134 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
135 ARDOUR_UI::instance()->set_tip(*btn_update, _("Update available plugins"));
137 btn_add->set_name("PluginSelectorButton");
138 btn_remove->set_name("PluginSelectorButton");
140 Gtk::Table* table = manage(new Gtk::Table(7, 11));
141 table->set_size_request(750, 500);
142 table->attach(scroller, 0, 7, 0, 5);
144 HBox* filter_box = manage (new HBox);
146 vector<string> filter_strings = I18N (_filter_mode_strings);
147 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
148 filter_mode.set_active_text (filter_strings.front());
150 filter_box->pack_start (filter_mode, false, false);
151 filter_box->pack_start (filter_entry, true, true);
152 filter_box->pack_start (filter_button, false, false);
154 filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
155 filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
156 filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
160 filter_entry.show ();
161 filter_button.show ();
163 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
165 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
166 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
167 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
169 table->attach(ascroller, 0, 7, 8, 10);
171 add_button (Stock::CLOSE, RESPONSE_CLOSE);
172 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
173 set_default_response (RESPONSE_APPLY);
174 set_response_sensitive (RESPONSE_APPLY, false);
175 get_vbox()->pack_start (*table);
177 table->set_name("PluginSelectorTable");
178 plugin_display.set_name("PluginSelectorDisplay");
179 //plugin_display.set_name("PluginSelectorList");
180 added_list.set_name("PluginSelectorList");
182 plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
183 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
184 plugin_display.grab_focus();
186 btn_update->signal_clicked().connect (sigc::mem_fun(*this, &PluginSelector::btn_update_clicked));
187 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
188 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
189 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
190 added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
195 PluginSelector::~PluginSelector ()
201 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
207 PluginSelector::added_row_clicked(GdkEventButton* event)
209 if (event->type == GDK_2BUTTON_PRESS)
210 btn_remove_clicked();
214 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
217 std::string mode = filter_mode.get_active_text ();
219 if (mode == _("Favorites only")) {
220 return manager.get_status (info) == PluginManager::Favorite;
223 if (mode == _("Hidden only")) {
224 return manager.get_status (info) == PluginManager::Hidden;
227 if (!filterstr.empty()) {
229 if (mode == _("Name contains")) {
230 compstr = info->name;
231 } else if (mode == _("Category contains")) {
232 compstr = info->category;
233 } else if (mode == _("Type contains")) {
235 switch (info->type) {
237 compstr = X_("LADSPA");
240 compstr = X_("AudioUnit");
249 compstr = X_("LXVST");
253 } else if (mode == _("Author contains")) {
254 compstr = info->creator;
255 } else if (mode == _("Library contains")) {
256 compstr = info->path;
259 if (compstr.empty()) {
263 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
265 if (compstr.find (filterstr) != string::npos) {
276 PluginSelector::setup_filter_string (string& filterstr)
278 filterstr = filter_entry.get_text ();
279 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
283 PluginSelector::refill ()
285 std::string filterstr;
287 in_row_change = true;
289 plugin_model->clear ();
291 setup_filter_string (filterstr);
293 ladspa_refiller (filterstr);
294 lv2_refiller (filterstr);
295 vst_refiller (filterstr);
296 lxvst_refiller (filterstr);
297 au_refiller (filterstr);
299 in_row_change = false;
303 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
307 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
309 if (show_this_plugin (*i, filterstr)) {
311 TreeModel::Row newrow = *(plugin_model->append());
312 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
313 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
314 newrow[plugin_columns.name] = (*i)->name;
315 newrow[plugin_columns.type_name] = type;
316 newrow[plugin_columns.category] = (*i)->category;
318 string creator = (*i)->creator;
319 string::size_type pos = 0;
321 /* stupid LADSPA creator strings */
322 #ifdef PLATFORM_WINDOWS
323 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
325 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
327 // If there were too few characters to create a
328 // meaningful name, mark this creator as 'Unknown'
329 if (creator.length()<2 || pos<3)
332 creator = creator.substr (0, pos);
334 newrow[plugin_columns.creator] = creator;
336 if ((*i)->reconfigurable_io ()) {
337 newrow[plugin_columns.audio_ins] = _("variable");
338 newrow[plugin_columns.midi_ins] = _("variable");
339 newrow[plugin_columns.audio_outs] = _("variable");
340 newrow[plugin_columns.midi_outs] = _("variable");
342 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
343 newrow[plugin_columns.audio_ins] = buf;
344 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
345 newrow[plugin_columns.midi_ins] = buf;
347 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
348 newrow[plugin_columns.audio_outs] = buf;
349 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
350 newrow[plugin_columns.midi_outs] = buf;
353 newrow[plugin_columns.plugin] = *i;
359 PluginSelector::ladspa_refiller (const std::string& filterstr)
361 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
365 PluginSelector::lv2_refiller (const std::string& filterstr)
368 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
373 #ifdef WINDOWS_VST_SUPPORT
374 PluginSelector::vst_refiller (const std::string& filterstr)
376 PluginSelector::vst_refiller (const std::string&)
379 #ifdef WINDOWS_VST_SUPPORT
380 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
386 PluginSelector::lxvst_refiller (const std::string& filterstr)
388 PluginSelector::lxvst_refiller (const std::string&)
392 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
397 #ifdef AUDIOUNIT_SUPPORT
398 PluginSelector::au_refiller (const std::string& filterstr)
400 PluginSelector::au_refiller (const std::string&)
403 #ifdef AUDIOUNIT_SUPPORT
404 refiller (manager.au_plugin_info(), filterstr, "AU");
409 PluginSelector::load_plugin (PluginInfoPtr pi)
415 return pi->load (*_session);
419 PluginSelector::btn_add_clicked()
423 TreeModel::Row newrow = *(amodel->append());
426 row = *(plugin_display.get_selection()->get_selected());
427 name = row[plugin_columns.name];
428 pi = row[plugin_columns.plugin];
430 newrow[acols.text] = name;
431 newrow[acols.plugin] = pi;
433 if (!amodel->children().empty()) {
434 set_response_sensitive (RESPONSE_APPLY, true);
439 PluginSelector::btn_remove_clicked()
441 TreeModel::iterator iter = added_list.get_selection()->get_selected();
444 if (amodel->children().empty()) {
445 set_response_sensitive (RESPONSE_APPLY, false);
450 PluginSelector::btn_update_clicked()
456 PluginSelector::display_selection_changed()
458 if (plugin_display.get_selection()->count_selected_rows() != 0) {
459 btn_add->set_sensitive (true);
461 btn_add->set_sensitive (false);
466 PluginSelector::added_list_selection_changed()
468 if (added_list.get_selection()->count_selected_rows() != 0) {
469 btn_remove->set_sensitive (true);
471 btn_remove->set_sensitive (false);
476 PluginSelector::run ()
479 TreeModel::Children::iterator i;
485 SelectedPlugins plugins;
486 r = (ResponseType) Dialog::run ();
490 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
491 PluginInfoPtr pp = (*i)[acols.plugin];
492 PluginPtr p = load_plugin (pp);
494 plugins.push_back (p);
496 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
500 if (interested_object && !plugins.empty()) {
501 finish = !interested_object->use_plugins (plugins);
515 interested_object = 0;
521 PluginSelector::filter_button_clicked ()
523 filter_entry.set_text ("");
527 PluginSelector::filter_entry_changed ()
533 PluginSelector::filter_mode_changed ()
535 std::string mode = filter_mode.get_active_text ();
537 if (mode == _("Favorites only") || mode == _("Hidden only")) {
538 filter_entry.set_sensitive (false);
540 filter_entry.set_sensitive (true);
547 PluginSelector::on_show ()
549 ArdourDialog::on_show ();
550 filter_entry.grab_focus ();
553 struct PluginMenuCompareByCreator {
554 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
557 cmp = cmp_nocase_utf8 (a->creator, b->creator);
561 } else if (cmp == 0) {
562 /* same creator ... compare names */
563 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
571 struct PluginMenuCompareByName {
572 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
575 cmp = cmp_nocase_utf8 (a->name, b->name);
579 } else if (cmp == 0) {
580 /* same name ... compare type */
581 if (a->type < b->type) {
589 struct PluginMenuCompareByCategory {
590 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
593 cmp = cmp_nocase_utf8 (a->category, b->category);
597 } else if (cmp == 0) {
598 /* same category ... compare names */
599 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
607 /** @return Plugin menu. The caller should not delete it */
609 PluginSelector::plugin_menu()
615 PluginSelector::build_plugin_menu ()
617 PluginInfoList all_plugs;
619 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
620 #ifdef WINDOWS_VST_SUPPORT
621 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
624 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
626 #ifdef AUDIOUNIT_SUPPORT
627 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
630 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
633 using namespace Menu_Helpers;
637 _plugin_menu = manage (new Menu);
638 _plugin_menu->set_name("ArdourContextMenu");
640 MenuList& items = _plugin_menu->items();
643 Gtk::Menu* favs = create_favs_menu(all_plugs);
644 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
646 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
647 items.push_back (SeparatorElem ());
649 Menu* by_creator = create_by_creator_menu(all_plugs);
650 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
652 Menu* by_category = create_by_category_menu(all_plugs);
653 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
657 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
659 using namespace Menu_Helpers;
661 Menu* favs = new Menu();
662 favs->set_name("ArdourContextMenu");
664 PluginMenuCompareByName cmp_by_name;
665 all_plugs.sort (cmp_by_name);
667 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
668 if (manager.get_status (*i) == PluginManager::Favorite) {
669 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
670 elem.get_child()->set_use_underline (false);
671 favs->items().push_back (elem);
678 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
680 using namespace Menu_Helpers;
682 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
683 SubmenuMap creator_submenu_map;
685 Menu* by_creator = new Menu();
686 by_creator->set_name("ArdourContextMenu");
688 MenuList& by_creator_items = by_creator->items();
689 PluginMenuCompareByCreator cmp_by_creator;
690 all_plugs.sort (cmp_by_creator);
692 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
694 if (manager.get_status (*i) == PluginManager::Hidden) continue;
696 string creator = (*i)->creator;
698 /* stupid LADSPA creator strings */
699 string::size_type pos = 0;
700 #ifdef PLATFORM_WINDOWS
701 while (pos < creator.length() && creator[pos]>(-2) && creator[pos]<256 && (isprint (creator[pos]))) ++pos;
703 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
706 // Check to see if we found any invalid characters.
707 if (creator.length() != pos) {
708 // If there were too few characters to create a
709 // meaningful name, mark this creator as 'Unknown'
711 creator = "Unknown?";
713 creator = creator.substr (0, pos);
716 SubmenuMap::iterator x;
718 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
721 submenu = new Gtk::Menu;
722 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
723 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
724 submenu->set_name("ArdourContextMenu");
726 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
727 elem.get_child()->set_use_underline (false);
728 submenu->items().push_back (elem);
734 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
736 using namespace Menu_Helpers;
738 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
739 SubmenuMap category_submenu_map;
741 Menu* by_category = new Menu();
742 by_category->set_name("ArdourContextMenu");
744 MenuList& by_category_items = by_category->items();
745 PluginMenuCompareByCategory cmp_by_category;
746 all_plugs.sort (cmp_by_category);
748 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
750 if (manager.get_status (*i) == PluginManager::Hidden) continue;
752 string category = (*i)->category;
754 SubmenuMap::iterator x;
756 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
759 submenu = new Gtk::Menu;
760 by_category_items.push_back (MenuElem (category, *manage (submenu)));
761 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
762 submenu->set_name("ArdourContextMenu");
764 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
765 elem.get_child()->set_use_underline (false);
766 submenu->items().push_back (elem);
772 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
774 PluginPtr p = load_plugin (pi);
776 if (p && interested_object) {
777 SelectedPlugins plugins;
778 plugins.push_back (p);
779 interested_object->use_plugins (plugins);
782 interested_object = 0;
786 PluginSelector::favorite_changed (const std::string& path)
794 in_row_change = true;
796 TreeModel::iterator iter = plugin_model->get_iter (path);
800 bool favorite = !(*iter)[plugin_columns.favorite];
804 (*iter)[plugin_columns.favorite] = favorite;
805 (*iter)[plugin_columns.hidden] = false;
806 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
808 /* save new statuses list */
810 pi = (*iter)[plugin_columns.plugin];
812 manager.set_status (pi->type, pi->unique_id, status);
814 manager.save_statuses ();
816 build_plugin_menu ();
818 in_row_change = false;
822 PluginSelector::hidden_changed (const std::string& path)
830 in_row_change = true;
832 TreeModel::iterator iter = plugin_model->get_iter (path);
836 bool hidden = !(*iter)[plugin_columns.hidden];
840 (*iter)[plugin_columns.favorite] = false;
841 (*iter)[plugin_columns.hidden] = hidden;
842 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
844 /* save new statuses list */
846 pi = (*iter)[plugin_columns.plugin];
848 manager.set_status (pi->type, pi->unique_id, status);
850 manager.save_statuses ();
852 build_plugin_menu ();
854 in_row_change = false;
858 PluginSelector::show_manager ()
865 PluginSelector::set_interested_object (PluginInterestedObject& obj)
867 interested_object = &obj;