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));
194 PluginSelector::~PluginSelector ()
200 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
206 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
209 std::string mode = filter_mode.get_active_text ();
211 if (mode == _("Favorites only")) {
212 return manager.get_status (info) == PluginManager::Favorite;
215 if (mode == _("Hidden only")) {
216 return manager.get_status (info) == PluginManager::Hidden;
219 if (!filterstr.empty()) {
221 if (mode == _("Name contains")) {
222 compstr = info->name;
223 } else if (mode == _("Category contains")) {
224 compstr = info->category;
225 } else if (mode == _("Type contains")) {
227 switch (info->type) {
229 compstr = X_("LADSPA");
232 compstr = X_("AudioUnit");
241 compstr = X_("LXVST");
245 } else if (mode == _("Author contains")) {
246 compstr = info->creator;
247 } else if (mode == _("Library contains")) {
248 compstr = info->path;
251 if (compstr.empty()) {
255 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
257 if (compstr.find (filterstr) != string::npos) {
268 PluginSelector::setup_filter_string (string& filterstr)
270 filterstr = filter_entry.get_text ();
271 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
275 PluginSelector::refill ()
277 std::string filterstr;
279 in_row_change = true;
281 plugin_model->clear ();
283 setup_filter_string (filterstr);
285 ladspa_refiller (filterstr);
286 lv2_refiller (filterstr);
287 vst_refiller (filterstr);
288 lxvst_refiller (filterstr);
289 au_refiller (filterstr);
291 in_row_change = false;
295 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
299 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
301 if (show_this_plugin (*i, filterstr)) {
303 TreeModel::Row newrow = *(plugin_model->append());
304 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
305 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
306 newrow[plugin_columns.name] = (*i)->name;
307 newrow[plugin_columns.type_name] = type;
308 newrow[plugin_columns.category] = (*i)->category;
310 string creator = (*i)->creator;
311 string::size_type pos = 0;
313 /* stupid LADSPA creator strings */
314 #ifdef PLATFORM_WINDOWS
315 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
317 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
319 creator = creator.substr (0, pos);
321 newrow[plugin_columns.creator] = creator;
323 if ((*i)->reconfigurable_io ()) {
324 newrow[plugin_columns.audio_ins] = _("variable");
325 newrow[plugin_columns.midi_ins] = _("variable");
326 newrow[plugin_columns.audio_outs] = _("variable");
327 newrow[plugin_columns.midi_outs] = _("variable");
329 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
330 newrow[plugin_columns.audio_ins] = buf;
331 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
332 newrow[plugin_columns.midi_ins] = buf;
334 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
335 newrow[plugin_columns.audio_outs] = buf;
336 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
337 newrow[plugin_columns.midi_outs] = buf;
340 newrow[plugin_columns.plugin] = *i;
346 PluginSelector::ladspa_refiller (const std::string& filterstr)
348 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
352 PluginSelector::lv2_refiller (const std::string& filterstr)
355 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
360 #ifdef WINDOWS_VST_SUPPORT
361 PluginSelector::vst_refiller (const std::string& filterstr)
363 PluginSelector::vst_refiller (const std::string&)
366 #ifdef WINDOWS_VST_SUPPORT
367 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
373 PluginSelector::lxvst_refiller (const std::string& filterstr)
375 PluginSelector::lxvst_refiller (const std::string&)
379 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
384 #ifdef AUDIOUNIT_SUPPORT
385 PluginSelector::au_refiller (const std::string& filterstr)
387 PluginSelector::au_refiller (const std::string&)
390 #ifdef AUDIOUNIT_SUPPORT
391 refiller (manager.au_plugin_info(), filterstr, "AU");
396 PluginSelector::load_plugin (PluginInfoPtr pi)
402 return pi->load (*_session);
406 PluginSelector::btn_add_clicked()
410 TreeModel::Row newrow = *(amodel->append());
413 row = *(plugin_display.get_selection()->get_selected());
414 name = row[plugin_columns.name];
415 pi = row[plugin_columns.plugin];
417 newrow[acols.text] = name;
418 newrow[acols.plugin] = pi;
420 if (!amodel->children().empty()) {
421 set_response_sensitive (RESPONSE_APPLY, true);
426 PluginSelector::btn_remove_clicked()
428 TreeModel::iterator iter = added_list.get_selection()->get_selected();
431 if (amodel->children().empty()) {
432 set_response_sensitive (RESPONSE_APPLY, false);
437 PluginSelector::btn_update_clicked()
443 PluginSelector::display_selection_changed()
445 if (plugin_display.get_selection()->count_selected_rows() != 0) {
446 btn_add->set_sensitive (true);
448 btn_add->set_sensitive (false);
453 PluginSelector::added_list_selection_changed()
455 if (added_list.get_selection()->count_selected_rows() != 0) {
456 btn_remove->set_sensitive (true);
458 btn_remove->set_sensitive (false);
463 PluginSelector::run ()
466 TreeModel::Children::iterator i;
472 SelectedPlugins plugins;
473 r = (ResponseType) Dialog::run ();
477 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
478 PluginInfoPtr pp = (*i)[acols.plugin];
479 PluginPtr p = load_plugin (pp);
481 plugins.push_back (p);
483 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
487 if (interested_object && !plugins.empty()) {
488 finish = !interested_object->use_plugins (plugins);
502 interested_object = 0;
508 PluginSelector::filter_button_clicked ()
510 filter_entry.set_text ("");
514 PluginSelector::filter_entry_changed ()
520 PluginSelector::filter_mode_changed ()
522 std::string mode = filter_mode.get_active_text ();
524 if (mode == _("Favorites only") || mode == _("Hidden only")) {
525 filter_entry.set_sensitive (false);
527 filter_entry.set_sensitive (true);
534 PluginSelector::on_show ()
536 ArdourDialog::on_show ();
537 filter_entry.grab_focus ();
540 struct PluginMenuCompareByCreator {
541 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
544 cmp = cmp_nocase_utf8 (a->creator, b->creator);
548 } else if (cmp == 0) {
549 /* same creator ... compare names */
550 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
558 struct PluginMenuCompareByName {
559 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
562 cmp = cmp_nocase_utf8 (a->name, b->name);
566 } else if (cmp == 0) {
567 /* same name ... compare type */
568 if (a->type < b->type) {
576 struct PluginMenuCompareByCategory {
577 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
580 cmp = cmp_nocase_utf8 (a->category, b->category);
584 } else if (cmp == 0) {
585 /* same category ... compare names */
586 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
594 /** @return Plugin menu. The caller should not delete it */
596 PluginSelector::plugin_menu()
602 PluginSelector::build_plugin_menu ()
604 PluginInfoList all_plugs;
606 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
607 #ifdef WINDOWS_VST_SUPPORT
608 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
611 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
613 #ifdef AUDIOUNIT_SUPPORT
614 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
617 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
620 using namespace Menu_Helpers;
624 _plugin_menu = manage (new Menu);
625 _plugin_menu->set_name("ArdourContextMenu");
627 MenuList& items = _plugin_menu->items();
630 Gtk::Menu* favs = create_favs_menu(all_plugs);
631 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
633 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
634 items.push_back (SeparatorElem ());
636 Menu* by_creator = create_by_creator_menu(all_plugs);
637 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
639 Menu* by_category = create_by_category_menu(all_plugs);
640 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
644 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
646 using namespace Menu_Helpers;
648 Menu* favs = new Menu();
649 favs->set_name("ArdourContextMenu");
651 PluginMenuCompareByName cmp_by_name;
652 all_plugs.sort (cmp_by_name);
654 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
655 if (manager.get_status (*i) == PluginManager::Favorite) {
656 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
657 elem.get_child()->set_use_underline (false);
658 favs->items().push_back (elem);
665 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
667 using namespace Menu_Helpers;
669 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
670 SubmenuMap creator_submenu_map;
672 Menu* by_creator = new Menu();
673 by_creator->set_name("ArdourContextMenu");
675 MenuList& by_creator_items = by_creator->items();
676 PluginMenuCompareByCreator cmp_by_creator;
677 all_plugs.sort (cmp_by_creator);
679 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
681 if (manager.get_status (*i) == PluginManager::Hidden) continue;
683 string creator = (*i)->creator;
685 /* stupid LADSPA creator strings */
686 string::size_type pos = 0;
687 #ifdef PLATFORM_WINDOWS
688 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
690 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
692 creator = creator.substr (0, pos);
694 SubmenuMap::iterator x;
696 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
699 submenu = new Gtk::Menu;
700 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
701 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
702 submenu->set_name("ArdourContextMenu");
704 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
705 elem.get_child()->set_use_underline (false);
706 submenu->items().push_back (elem);
712 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
714 using namespace Menu_Helpers;
716 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
717 SubmenuMap category_submenu_map;
719 Menu* by_category = new Menu();
720 by_category->set_name("ArdourContextMenu");
722 MenuList& by_category_items = by_category->items();
723 PluginMenuCompareByCategory cmp_by_category;
724 all_plugs.sort (cmp_by_category);
726 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
728 if (manager.get_status (*i) == PluginManager::Hidden) continue;
730 string category = (*i)->category;
732 SubmenuMap::iterator x;
734 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
737 submenu = new Gtk::Menu;
738 by_category_items.push_back (MenuElem (category, *manage (submenu)));
739 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
740 submenu->set_name("ArdourContextMenu");
742 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
743 elem.get_child()->set_use_underline (false);
744 submenu->items().push_back (elem);
750 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
752 PluginPtr p = load_plugin (pi);
754 if (p && interested_object) {
755 SelectedPlugins plugins;
756 plugins.push_back (p);
757 interested_object->use_plugins (plugins);
760 interested_object = 0;
764 PluginSelector::favorite_changed (const std::string& path)
772 in_row_change = true;
774 TreeModel::iterator iter = plugin_model->get_iter (path);
778 bool favorite = !(*iter)[plugin_columns.favorite];
782 (*iter)[plugin_columns.favorite] = favorite;
783 (*iter)[plugin_columns.hidden] = false;
784 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
786 /* save new statuses list */
788 pi = (*iter)[plugin_columns.plugin];
790 manager.set_status (pi->type, pi->unique_id, status);
792 manager.save_statuses ();
794 build_plugin_menu ();
796 in_row_change = false;
800 PluginSelector::hidden_changed (const std::string& path)
808 in_row_change = true;
810 TreeModel::iterator iter = plugin_model->get_iter (path);
814 bool hidden = !(*iter)[plugin_columns.hidden];
818 (*iter)[plugin_columns.favorite] = false;
819 (*iter)[plugin_columns.hidden] = hidden;
820 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
822 /* save new statuses list */
824 pi = (*iter)[plugin_columns.plugin];
826 manager.set_status (pi->type, pi->unique_id, status);
828 manager.save_statuses ();
830 build_plugin_menu ();
832 in_row_change = false;
836 PluginSelector::show_manager ()
843 PluginSelector::set_interested_object (PluginInterestedObject& obj)
845 interested_object = &obj;