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"
40 #include "ardour_ui.h"
41 #include "plugin_selector.h"
42 #include "gui_thread.h"
46 using namespace ARDOUR;
51 static const char* _filter_mode_strings[] = {
54 N_("Category contains"),
55 N_("Author contains"),
56 N_("Library contains"),
62 PluginSelector::PluginSelector (PluginManager& mgr)
63 : ArdourDialog (_("Plugin Manager"), true, false)
64 , filter_button (Stock::CLEAR)
68 set_name ("PluginSelectorWindow");
69 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
72 in_row_change = false;
74 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
77 plugin_model = Gtk::ListStore::create (plugin_columns);
78 plugin_display.set_model (plugin_model);
79 /* XXX translators: try to convert "Fav" into a short term
80 related to "favorite" and "Hid" into a short term
83 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
84 plugin_display.append_column (_("Hide"), plugin_columns.hidden);
85 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
86 plugin_display.append_column (_("Type"), plugin_columns.type_name);
87 plugin_display.append_column (_("Category"), plugin_columns.category);
88 plugin_display.append_column (_("Creator"), plugin_columns.creator);
89 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
90 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
91 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
92 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
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);
98 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
99 fav_cell->property_activatable() = true;
100 fav_cell->property_radio() = true;
101 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
103 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
104 hidden_cell->property_activatable() = true;
105 hidden_cell->property_radio() = true;
106 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
108 scroller.set_border_width(10);
109 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
110 scroller.add(plugin_display);
112 amodel = Gtk::ListStore::create(acols);
113 added_list.set_model (amodel);
114 added_list.append_column (_("Plugins to be connected"), acols.text);
115 added_list.set_headers_visible (true);
116 added_list.set_reorderable (false);
118 for (int i = 0; i <=8; i++) {
119 Gtk::TreeView::Column* column = plugin_display.get_column(i);
120 column->set_sort_column(i);
123 ascroller.set_border_width(10);
124 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
125 ascroller.add(added_list);
126 btn_add = manage(new Gtk::Button(Stock::ADD));
127 ARDOUR_UI::instance()->set_tip(*btn_add, _("Add a plugin to the effect list"));
128 btn_add->set_sensitive (false);
129 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
130 btn_remove->set_sensitive (false);
131 ARDOUR_UI::instance()->set_tip(*btn_remove, _("Remove a plugin from the effect list"));
132 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
133 ARDOUR_UI::instance()->set_tip(*btn_update, _("Update available plugins"));
135 btn_add->set_name("PluginSelectorButton");
136 btn_remove->set_name("PluginSelectorButton");
138 Gtk::Table* table = manage(new Gtk::Table(7, 11));
139 table->set_size_request(750, 500);
140 table->attach(scroller, 0, 7, 0, 5);
142 HBox* filter_box = manage (new HBox);
144 vector<string> filter_strings = I18N (_filter_mode_strings);
145 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
146 filter_mode.set_active_text (filter_strings.front());
148 filter_box->pack_start (filter_mode, false, false);
149 filter_box->pack_start (filter_entry, true, true);
150 filter_box->pack_start (filter_button, false, false);
152 filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
153 filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
154 filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
158 filter_entry.show ();
159 filter_button.show ();
161 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
163 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
164 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
165 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
167 table->attach(ascroller, 0, 7, 8, 10);
169 add_button (Stock::CLOSE, RESPONSE_CLOSE);
170 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
171 set_default_response (RESPONSE_APPLY);
172 set_response_sensitive (RESPONSE_APPLY, false);
173 get_vbox()->pack_start (*table);
175 table->set_name("PluginSelectorTable");
176 plugin_display.set_name("PluginSelectorDisplay");
177 //plugin_display.set_name("PluginSelectorList");
178 added_list.set_name("PluginSelectorList");
180 plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
181 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
182 plugin_display.grab_focus();
184 btn_update->signal_clicked().connect (sigc::mem_fun(*this, &PluginSelector::btn_update_clicked));
185 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
186 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
187 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
192 PluginSelector::~PluginSelector ()
198 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
204 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
207 std::string mode = filter_mode.get_active_text ();
209 if (mode == _("Favorites only")) {
210 return manager.get_status (info) == PluginManager::Favorite;
213 if (mode == _("Hidden only")) {
214 return manager.get_status (info) == PluginManager::Hidden;
217 if (!filterstr.empty()) {
219 if (mode == _("Name contains")) {
220 compstr = info->name;
221 } else if (mode == _("Category contains")) {
222 compstr = info->category;
223 } else if (mode == _("Type contains")) {
225 switch (info->type) {
227 compstr = X_("LADSPA");
230 compstr = X_("AudioUnit");
239 compstr = X_("LXVST");
243 } else if (mode == _("Author contains")) {
244 compstr = info->creator;
245 } else if (mode == _("Library contains")) {
246 compstr = info->path;
249 if (compstr.empty()) {
253 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
255 if (compstr.find (filterstr) != string::npos) {
266 PluginSelector::setup_filter_string (string& filterstr)
268 filterstr = filter_entry.get_text ();
269 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
273 PluginSelector::refill ()
275 std::string filterstr;
277 in_row_change = true;
279 plugin_model->clear ();
281 setup_filter_string (filterstr);
283 ladspa_refiller (filterstr);
284 lv2_refiller (filterstr);
285 vst_refiller (filterstr);
286 lxvst_refiller (filterstr);
287 au_refiller (filterstr);
289 in_row_change = false;
293 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
297 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
299 if (show_this_plugin (*i, filterstr)) {
301 TreeModel::Row newrow = *(plugin_model->append());
302 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
303 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
304 newrow[plugin_columns.name] = (*i)->name;
305 newrow[plugin_columns.type_name] = type;
306 newrow[plugin_columns.category] = (*i)->category;
308 string creator = (*i)->creator;
309 string::size_type pos = 0;
311 /* stupid LADSPA creator strings */
313 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
314 creator = creator.substr (0, pos);
316 newrow[plugin_columns.creator] = creator;
318 if ((*i)->reconfigurable_io ()) {
319 newrow[plugin_columns.audio_ins] = _("variable");
320 newrow[plugin_columns.midi_ins] = _("variable");
321 newrow[plugin_columns.audio_outs] = _("variable");
322 newrow[plugin_columns.midi_outs] = _("variable");
324 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
325 newrow[plugin_columns.audio_ins] = buf;
326 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
327 newrow[plugin_columns.midi_ins] = buf;
329 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
330 newrow[plugin_columns.audio_outs] = buf;
331 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
332 newrow[plugin_columns.midi_outs] = buf;
335 newrow[plugin_columns.plugin] = *i;
341 PluginSelector::ladspa_refiller (const std::string& filterstr)
343 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
347 PluginSelector::lv2_refiller (const std::string& filterstr)
350 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
355 #ifdef WINDOWS_VST_SUPPORT
356 PluginSelector::vst_refiller (const std::string& filterstr)
358 PluginSelector::vst_refiller (const std::string&)
361 #ifdef WINDOWS_VST_SUPPORT
362 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
368 PluginSelector::lxvst_refiller (const std::string& filterstr)
370 PluginSelector::lxvst_refiller (const std::string&)
374 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
379 #ifdef AUDIOUNIT_SUPPORT
380 PluginSelector::au_refiller (const std::string& filterstr)
382 PluginSelector::au_refiller (const std::string&)
385 #ifdef AUDIOUNIT_SUPPORT
386 refiller (manager.au_plugin_info(), filterstr, "AU");
391 PluginSelector::load_plugin (PluginInfoPtr pi)
397 return pi->load (*_session);
401 PluginSelector::btn_add_clicked()
405 TreeModel::Row newrow = *(amodel->append());
408 row = *(plugin_display.get_selection()->get_selected());
409 name = row[plugin_columns.name];
410 pi = row[plugin_columns.plugin];
412 newrow[acols.text] = name;
413 newrow[acols.plugin] = pi;
415 if (!amodel->children().empty()) {
416 set_response_sensitive (RESPONSE_APPLY, true);
421 PluginSelector::btn_remove_clicked()
423 TreeModel::iterator iter = added_list.get_selection()->get_selected();
426 if (amodel->children().empty()) {
427 set_response_sensitive (RESPONSE_APPLY, false);
432 PluginSelector::btn_update_clicked()
439 PluginSelector::display_selection_changed()
441 if (plugin_display.get_selection()->count_selected_rows() != 0) {
442 btn_add->set_sensitive (true);
444 btn_add->set_sensitive (false);
449 PluginSelector::added_list_selection_changed()
451 if (added_list.get_selection()->count_selected_rows() != 0) {
452 btn_remove->set_sensitive (true);
454 btn_remove->set_sensitive (false);
459 PluginSelector::run ()
462 TreeModel::Children::iterator i;
468 SelectedPlugins plugins;
469 r = (ResponseType) Dialog::run ();
473 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
474 PluginInfoPtr pp = (*i)[acols.plugin];
475 PluginPtr p = load_plugin (pp);
477 plugins.push_back (p);
479 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
483 if (interested_object && !plugins.empty()) {
484 finish = !interested_object->use_plugins (plugins);
498 interested_object = 0;
504 PluginSelector::filter_button_clicked ()
506 filter_entry.set_text ("");
510 PluginSelector::filter_entry_changed ()
516 PluginSelector::filter_mode_changed ()
518 std::string mode = filter_mode.get_active_text ();
520 if (mode == _("Favorites only") || mode == _("Hidden only")) {
521 filter_entry.set_sensitive (false);
523 filter_entry.set_sensitive (true);
530 PluginSelector::on_show ()
532 ArdourDialog::on_show ();
533 filter_entry.grab_focus ();
536 struct PluginMenuCompareByCreator {
537 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
540 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
544 } else if (cmp == 0) {
545 /* same creator ... compare names */
546 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
554 struct PluginMenuCompareByName {
555 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
558 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
562 } else if (cmp == 0) {
563 /* same name ... compare type */
564 if (a->type < b->type) {
572 struct PluginMenuCompareByCategory {
573 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
576 cmp = strcasecmp (a->category.c_str(), b->category.c_str());
580 } else if (cmp == 0) {
581 /* same category ... compare names */
582 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
590 /** @return Plugin menu. The caller should not delete it */
592 PluginSelector::plugin_menu()
598 PluginSelector::build_plugin_menu ()
600 PluginInfoList all_plugs;
602 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
603 #ifdef WINDOWS_VST_SUPPORT
604 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
607 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
609 #ifdef AUDIOUNIT_SUPPORT
610 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
613 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
616 using namespace Menu_Helpers;
620 _plugin_menu = manage (new Menu);
621 _plugin_menu->set_name("ArdourContextMenu");
623 MenuList& items = _plugin_menu->items();
626 Gtk::Menu* favs = create_favs_menu(all_plugs);
627 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
629 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
630 items.push_back (SeparatorElem ());
632 Menu* by_creator = create_by_creator_menu(all_plugs);
633 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
635 Menu* by_category = create_by_category_menu(all_plugs);
636 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
640 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
642 using namespace Menu_Helpers;
644 Menu* favs = new Menu();
645 favs->set_name("ArdourContextMenu");
647 PluginMenuCompareByName cmp_by_name;
648 all_plugs.sort (cmp_by_name);
650 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
651 if (manager.get_status (*i) == PluginManager::Favorite) {
652 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
653 elem.get_child()->set_use_underline (false);
654 favs->items().push_back (elem);
661 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
663 using namespace Menu_Helpers;
665 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
666 SubmenuMap creator_submenu_map;
668 Menu* by_creator = new Menu();
669 by_creator->set_name("ArdourContextMenu");
671 MenuList& by_creator_items = by_creator->items();
672 PluginMenuCompareByCreator cmp_by_creator;
673 all_plugs.sort (cmp_by_creator);
675 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
677 if (manager.get_status (*i) == PluginManager::Hidden) continue;
679 string creator = (*i)->creator;
681 /* stupid LADSPA creator strings */
682 string::size_type pos = 0;
683 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
684 creator = creator.substr (0, pos);
686 SubmenuMap::iterator x;
688 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
691 submenu = new Gtk::Menu;
692 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
693 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
694 submenu->set_name("ArdourContextMenu");
696 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
697 elem.get_child()->set_use_underline (false);
698 submenu->items().push_back (elem);
704 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
706 using namespace Menu_Helpers;
708 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
709 SubmenuMap category_submenu_map;
711 Menu* by_category = new Menu();
712 by_category->set_name("ArdourContextMenu");
714 MenuList& by_category_items = by_category->items();
715 PluginMenuCompareByCategory cmp_by_category;
716 all_plugs.sort (cmp_by_category);
718 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
720 if (manager.get_status (*i) == PluginManager::Hidden) continue;
722 string category = (*i)->category;
724 SubmenuMap::iterator x;
726 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
729 submenu = new Gtk::Menu;
730 by_category_items.push_back (MenuElem (category, *manage (submenu)));
731 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
732 submenu->set_name("ArdourContextMenu");
734 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
735 elem.get_child()->set_use_underline (false);
736 submenu->items().push_back (elem);
742 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
744 PluginPtr p = load_plugin (pi);
746 if (p && interested_object) {
747 SelectedPlugins plugins;
748 plugins.push_back (p);
749 interested_object->use_plugins (plugins);
752 interested_object = 0;
756 PluginSelector::favorite_changed (const std::string& path)
764 in_row_change = true;
766 TreeModel::iterator iter = plugin_model->get_iter (path);
770 bool favorite = !(*iter)[plugin_columns.favorite];
774 (*iter)[plugin_columns.favorite] = favorite;
775 (*iter)[plugin_columns.hidden] = false;
776 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
778 /* save new statuses list */
780 pi = (*iter)[plugin_columns.plugin];
782 manager.set_status (pi->type, pi->unique_id, status);
784 manager.save_statuses ();
786 build_plugin_menu ();
788 in_row_change = false;
792 PluginSelector::hidden_changed (const std::string& path)
800 in_row_change = true;
802 TreeModel::iterator iter = plugin_model->get_iter (path);
806 bool hidden = !(*iter)[plugin_columns.hidden];
810 (*iter)[plugin_columns.favorite] = false;
811 (*iter)[plugin_columns.hidden] = hidden;
812 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
814 /* save new statuses list */
816 pi = (*iter)[plugin_columns.plugin];
818 manager.set_status (pi->type, pi->unique_id, status);
820 manager.save_statuses ();
822 build_plugin_menu ();
824 in_row_change = false;
828 PluginSelector::show_manager ()
835 PluginSelector::set_interested_object (PluginInterestedObject& obj)
837 interested_object = &obj;