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());
78 plugin_model = Gtk::ListStore::create (plugin_columns);
79 plugin_display.set_model (plugin_model);
80 /* XXX translators: try to convert "Fav" into a short term
81 related to "favorite" and "Hid" into a short term
84 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
85 plugin_display.append_column (_("Hide"), plugin_columns.hidden);
86 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
87 plugin_display.append_column (_("Type"), plugin_columns.type_name);
88 plugin_display.append_column (_("Category"), plugin_columns.category);
89 plugin_display.append_column (_("Creator"), plugin_columns.creator);
90 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
91 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
92 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
93 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
94 plugin_display.set_headers_visible (true);
95 plugin_display.set_headers_clickable (true);
96 plugin_display.set_reorderable (false);
97 plugin_display.set_rules_hint (true);
99 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
100 fav_cell->property_activatable() = true;
101 fav_cell->property_radio() = true;
102 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
104 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
105 hidden_cell->property_activatable() = true;
106 hidden_cell->property_radio() = true;
107 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
109 scroller.set_border_width(10);
110 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
111 scroller.add(plugin_display);
113 amodel = Gtk::ListStore::create(acols);
114 added_list.set_model (amodel);
115 added_list.append_column (_("Plugins to be connected"), acols.text);
116 added_list.set_headers_visible (true);
117 added_list.set_reorderable (false);
119 for (int i = 0; i <=8; i++) {
120 Gtk::TreeView::Column* column = plugin_display.get_column(i);
121 column->set_sort_column(i);
124 ascroller.set_border_width(10);
125 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
126 ascroller.add(added_list);
127 btn_add = manage(new Gtk::Button(Stock::ADD));
128 ARDOUR_UI::instance()->set_tip(*btn_add, _("Add a plugin to the effect list"));
129 btn_add->set_sensitive (false);
130 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
131 btn_remove->set_sensitive (false);
132 ARDOUR_UI::instance()->set_tip(*btn_remove, _("Remove a plugin from the effect list"));
133 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
134 ARDOUR_UI::instance()->set_tip(*btn_update, _("Update available plugins"));
136 btn_add->set_name("PluginSelectorButton");
137 btn_remove->set_name("PluginSelectorButton");
139 Gtk::Table* table = manage(new Gtk::Table(7, 11));
140 table->set_size_request(750, 500);
141 table->attach(scroller, 0, 7, 0, 5);
143 HBox* filter_box = manage (new HBox);
145 vector<string> filter_strings = I18N (_filter_mode_strings);
146 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
147 filter_mode.set_active_text (filter_strings.front());
149 filter_box->pack_start (filter_mode, false, false);
150 filter_box->pack_start (filter_entry, true, true);
151 filter_box->pack_start (filter_button, false, false);
153 filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
154 filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
155 filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
159 filter_entry.show ();
160 filter_button.show ();
162 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
164 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
165 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
166 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
168 table->attach(ascroller, 0, 7, 8, 10);
170 add_button (Stock::CLOSE, RESPONSE_CLOSE);
171 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
172 set_default_response (RESPONSE_APPLY);
173 set_response_sensitive (RESPONSE_APPLY, false);
174 get_vbox()->pack_start (*table);
176 table->set_name("PluginSelectorTable");
177 plugin_display.set_name("PluginSelectorDisplay");
178 //plugin_display.set_name("PluginSelectorList");
179 added_list.set_name("PluginSelectorList");
181 plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
182 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
183 plugin_display.grab_focus();
185 btn_update->signal_clicked().connect (sigc::mem_fun(*this, &PluginSelector::btn_update_clicked));
186 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
187 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
188 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
193 PluginSelector::~PluginSelector ()
199 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
205 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
208 std::string mode = filter_mode.get_active_text ();
210 if (mode == _("Favorites only")) {
211 return manager.get_status (info) == PluginManager::Favorite;
214 if (mode == _("Hidden only")) {
215 return manager.get_status (info) == PluginManager::Hidden;
218 if (!filterstr.empty()) {
220 if (mode == _("Name contains")) {
221 compstr = info->name;
222 } else if (mode == _("Category contains")) {
223 compstr = info->category;
224 } else if (mode == _("Type contains")) {
226 switch (info->type) {
228 compstr = X_("LADSPA");
231 compstr = X_("AudioUnit");
240 compstr = X_("LXVST");
244 } else if (mode == _("Author contains")) {
245 compstr = info->creator;
246 } else if (mode == _("Library contains")) {
247 compstr = info->path;
250 if (compstr.empty()) {
254 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
256 if (compstr.find (filterstr) != string::npos) {
267 PluginSelector::setup_filter_string (string& filterstr)
269 filterstr = filter_entry.get_text ();
270 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
274 PluginSelector::refill ()
276 std::string filterstr;
278 in_row_change = true;
280 plugin_model->clear ();
282 setup_filter_string (filterstr);
284 ladspa_refiller (filterstr);
285 lv2_refiller (filterstr);
286 vst_refiller (filterstr);
287 lxvst_refiller (filterstr);
288 au_refiller (filterstr);
290 in_row_change = false;
294 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
298 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
300 if (show_this_plugin (*i, filterstr)) {
302 TreeModel::Row newrow = *(plugin_model->append());
303 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
304 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
305 newrow[plugin_columns.name] = (*i)->name;
306 newrow[plugin_columns.type_name] = type;
307 newrow[plugin_columns.category] = (*i)->category;
309 string creator = (*i)->creator;
310 string::size_type pos = 0;
312 /* stupid LADSPA creator strings */
314 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
315 creator = creator.substr (0, pos);
317 newrow[plugin_columns.creator] = creator;
319 if ((*i)->reconfigurable_io ()) {
320 newrow[plugin_columns.audio_ins] = _("variable");
321 newrow[plugin_columns.midi_ins] = _("variable");
322 newrow[plugin_columns.audio_outs] = _("variable");
323 newrow[plugin_columns.midi_outs] = _("variable");
325 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
326 newrow[plugin_columns.audio_ins] = buf;
327 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
328 newrow[plugin_columns.midi_ins] = buf;
330 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
331 newrow[plugin_columns.audio_outs] = buf;
332 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
333 newrow[plugin_columns.midi_outs] = buf;
336 newrow[plugin_columns.plugin] = *i;
342 PluginSelector::ladspa_refiller (const std::string& filterstr)
344 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
348 PluginSelector::lv2_refiller (const std::string& filterstr)
351 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
356 #ifdef WINDOWS_VST_SUPPORT
357 PluginSelector::vst_refiller (const std::string& filterstr)
359 PluginSelector::vst_refiller (const std::string&)
362 #ifdef WINDOWS_VST_SUPPORT
363 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
369 PluginSelector::lxvst_refiller (const std::string& filterstr)
371 PluginSelector::lxvst_refiller (const std::string&)
375 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
380 #ifdef AUDIOUNIT_SUPPORT
381 PluginSelector::au_refiller (const std::string& filterstr)
383 PluginSelector::au_refiller (const std::string&)
386 #ifdef AUDIOUNIT_SUPPORT
387 refiller (manager.au_plugin_info(), filterstr, "AU");
392 PluginSelector::load_plugin (PluginInfoPtr pi)
398 return pi->load (*_session);
402 PluginSelector::btn_add_clicked()
406 TreeModel::Row newrow = *(amodel->append());
409 row = *(plugin_display.get_selection()->get_selected());
410 name = row[plugin_columns.name];
411 pi = row[plugin_columns.plugin];
413 newrow[acols.text] = name;
414 newrow[acols.plugin] = pi;
416 if (!amodel->children().empty()) {
417 set_response_sensitive (RESPONSE_APPLY, true);
422 PluginSelector::btn_remove_clicked()
424 TreeModel::iterator iter = added_list.get_selection()->get_selected();
427 if (amodel->children().empty()) {
428 set_response_sensitive (RESPONSE_APPLY, false);
433 PluginSelector::btn_update_clicked()
440 PluginSelector::display_selection_changed()
442 if (plugin_display.get_selection()->count_selected_rows() != 0) {
443 btn_add->set_sensitive (true);
445 btn_add->set_sensitive (false);
450 PluginSelector::added_list_selection_changed()
452 if (added_list.get_selection()->count_selected_rows() != 0) {
453 btn_remove->set_sensitive (true);
455 btn_remove->set_sensitive (false);
460 PluginSelector::run ()
463 TreeModel::Children::iterator i;
469 SelectedPlugins plugins;
470 r = (ResponseType) Dialog::run ();
474 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
475 PluginInfoPtr pp = (*i)[acols.plugin];
476 PluginPtr p = load_plugin (pp);
478 plugins.push_back (p);
480 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
484 if (interested_object && !plugins.empty()) {
485 finish = !interested_object->use_plugins (plugins);
499 interested_object = 0;
505 PluginSelector::filter_button_clicked ()
507 filter_entry.set_text ("");
511 PluginSelector::filter_entry_changed ()
517 PluginSelector::filter_mode_changed ()
519 std::string mode = filter_mode.get_active_text ();
521 if (mode == _("Favorites only") || mode == _("Hidden only")) {
522 filter_entry.set_sensitive (false);
524 filter_entry.set_sensitive (true);
531 PluginSelector::on_show ()
533 ArdourDialog::on_show ();
534 filter_entry.grab_focus ();
537 struct PluginMenuCompareByCreator {
538 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
541 cmp = cmp_nocase_utf8 (a->creator, b->creator);
545 } else if (cmp == 0) {
546 /* same creator ... compare names */
547 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
555 struct PluginMenuCompareByName {
556 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
559 cmp = cmp_nocase_utf8 (a->name, b->name);
563 } else if (cmp == 0) {
564 /* same name ... compare type */
565 if (a->type < b->type) {
573 struct PluginMenuCompareByCategory {
574 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
577 cmp = cmp_nocase_utf8 (a->category, b->category);
581 } else if (cmp == 0) {
582 /* same category ... compare names */
583 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
591 /** @return Plugin menu. The caller should not delete it */
593 PluginSelector::plugin_menu()
599 PluginSelector::build_plugin_menu ()
601 PluginInfoList all_plugs;
603 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
604 #ifdef WINDOWS_VST_SUPPORT
605 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
608 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
610 #ifdef AUDIOUNIT_SUPPORT
611 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
614 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
617 using namespace Menu_Helpers;
621 _plugin_menu = manage (new Menu);
622 _plugin_menu->set_name("ArdourContextMenu");
624 MenuList& items = _plugin_menu->items();
627 Gtk::Menu* favs = create_favs_menu(all_plugs);
628 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
630 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
631 items.push_back (SeparatorElem ());
633 Menu* by_creator = create_by_creator_menu(all_plugs);
634 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
636 Menu* by_category = create_by_category_menu(all_plugs);
637 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
641 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
643 using namespace Menu_Helpers;
645 Menu* favs = new Menu();
646 favs->set_name("ArdourContextMenu");
648 PluginMenuCompareByName cmp_by_name;
649 all_plugs.sort (cmp_by_name);
651 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
652 if (manager.get_status (*i) == PluginManager::Favorite) {
653 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
654 elem.get_child()->set_use_underline (false);
655 favs->items().push_back (elem);
662 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
664 using namespace Menu_Helpers;
666 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
667 SubmenuMap creator_submenu_map;
669 Menu* by_creator = new Menu();
670 by_creator->set_name("ArdourContextMenu");
672 MenuList& by_creator_items = by_creator->items();
673 PluginMenuCompareByCreator cmp_by_creator;
674 all_plugs.sort (cmp_by_creator);
676 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
678 if (manager.get_status (*i) == PluginManager::Hidden) continue;
680 string creator = (*i)->creator;
682 /* stupid LADSPA creator strings */
683 string::size_type pos = 0;
684 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
685 creator = creator.substr (0, pos);
687 SubmenuMap::iterator x;
689 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
692 submenu = new Gtk::Menu;
693 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
694 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
695 submenu->set_name("ArdourContextMenu");
697 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
698 elem.get_child()->set_use_underline (false);
699 submenu->items().push_back (elem);
705 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
707 using namespace Menu_Helpers;
709 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
710 SubmenuMap category_submenu_map;
712 Menu* by_category = new Menu();
713 by_category->set_name("ArdourContextMenu");
715 MenuList& by_category_items = by_category->items();
716 PluginMenuCompareByCategory cmp_by_category;
717 all_plugs.sort (cmp_by_category);
719 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
721 if (manager.get_status (*i) == PluginManager::Hidden) continue;
723 string category = (*i)->category;
725 SubmenuMap::iterator x;
727 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
730 submenu = new Gtk::Menu;
731 by_category_items.push_back (MenuElem (category, *manage (submenu)));
732 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
733 submenu->set_name("ArdourContextMenu");
735 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
736 elem.get_child()->set_use_underline (false);
737 submenu->items().push_back (elem);
743 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
745 PluginPtr p = load_plugin (pi);
747 if (p && interested_object) {
748 SelectedPlugins plugins;
749 plugins.push_back (p);
750 interested_object->use_plugins (plugins);
753 interested_object = 0;
757 PluginSelector::favorite_changed (const std::string& path)
765 in_row_change = true;
767 TreeModel::iterator iter = plugin_model->get_iter (path);
771 bool favorite = !(*iter)[plugin_columns.favorite];
775 (*iter)[plugin_columns.favorite] = favorite;
776 (*iter)[plugin_columns.hidden] = false;
777 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
779 /* save new statuses list */
781 pi = (*iter)[plugin_columns.plugin];
783 manager.set_status (pi->type, pi->unique_id, status);
785 manager.save_statuses ();
787 build_plugin_menu ();
789 in_row_change = false;
793 PluginSelector::hidden_changed (const std::string& path)
801 in_row_change = true;
803 TreeModel::iterator iter = plugin_model->get_iter (path);
807 bool hidden = !(*iter)[plugin_columns.hidden];
811 (*iter)[plugin_columns.favorite] = false;
812 (*iter)[plugin_columns.hidden] = hidden;
813 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
815 /* save new statuses list */
817 pi = (*iter)[plugin_columns.plugin];
819 manager.set_status (pi->type, pi->unique_id, status);
821 manager.save_statuses ();
823 build_plugin_menu ();
825 in_row_change = false;
829 PluginSelector::show_manager ()
836 PluginSelector::set_interested_object (PluginInterestedObject& obj)
838 interested_object = &obj;