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"
29 #include <gtkmm/table.h>
30 #include <gtkmm/stock.h>
31 #include <gtkmm/button.h>
32 #include <gtkmm/notebook.h>
34 #include <gtkmm2ext/utils.h>
36 #include "pbd/convert.h"
38 #include "ardour/plugin_manager.h"
39 #include "ardour/plugin.h"
40 #include "ardour/configuration.h"
41 #include "ardour/session.h"
43 #include "ardour_ui.h"
44 #include "plugin_selector.h"
45 #include "gui_thread.h"
49 using namespace ARDOUR;
54 static const char* _filter_mode_strings[] = {
57 N_("Category contains"),
58 N_("Author contains"),
59 N_("Library contains"),
65 PluginSelector::PluginSelector (PluginManager& mgr)
66 : ArdourDialog (_("Plugin Manager"), true, false)
67 , filter_button (Stock::CLEAR)
71 set_position (Gtk::WIN_POS_MOUSE);
72 set_name ("PluginSelectorWindow");
73 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
76 in_row_change = false;
78 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
81 plugin_model = Gtk::ListStore::create (plugin_columns);
82 plugin_display.set_model (plugin_model);
83 /* XXX translators: try to convert "Fav" into a short term
84 related to "favorite" and "Hid" into a short term
87 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
88 plugin_display.append_column (_("Hid"), plugin_columns.hidden);
89 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
90 plugin_display.append_column (_("Type"), plugin_columns.type_name);
91 plugin_display.append_column (_("Category"), plugin_columns.category);
92 plugin_display.append_column (_("Creator"), plugin_columns.creator);
93 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
94 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
95 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
96 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
97 plugin_display.set_headers_visible (true);
98 plugin_display.set_headers_clickable (true);
99 plugin_display.set_reorderable (false);
100 plugin_display.set_rules_hint (true);
102 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
103 fav_cell->property_activatable() = true;
104 fav_cell->property_radio() = true;
105 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
107 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
108 hidden_cell->property_activatable() = true;
109 hidden_cell->property_radio() = true;
110 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
112 scroller.set_border_width(10);
113 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
114 scroller.add(plugin_display);
116 amodel = Gtk::ListStore::create(acols);
117 added_list.set_model (amodel);
118 added_list.append_column (_("Plugins to be connected"), acols.text);
119 added_list.set_headers_visible (true);
120 added_list.set_reorderable (false);
122 for (int i = 0; i <=8; i++) {
123 Gtk::TreeView::Column* column = plugin_display.get_column(i);
124 column->set_sort_column(i);
127 ascroller.set_border_width(10);
128 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
129 ascroller.add(added_list);
130 btn_add = manage(new Gtk::Button(Stock::ADD));
131 ARDOUR_UI::instance()->set_tip(*btn_add, _("Add a plugin to the effect list"));
132 btn_add->set_sensitive (false);
133 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
134 btn_remove->set_sensitive (false);
135 ARDOUR_UI::instance()->set_tip(*btn_remove, _("Remove a plugin from the effect list"));
136 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
137 ARDOUR_UI::instance()->set_tip(*btn_update, _("Update available plugins"));
139 btn_add->set_name("PluginSelectorButton");
140 btn_remove->set_name("PluginSelectorButton");
142 Gtk::Table* table = manage(new Gtk::Table(7, 11));
143 table->set_size_request(750, 500);
144 table->attach(scroller, 0, 7, 0, 5);
146 HBox* filter_box = manage (new HBox);
148 vector<string> filter_strings = I18N (_filter_mode_strings);
149 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
150 filter_mode.set_active_text (filter_strings.front());
152 filter_box->pack_start (filter_mode, false, false);
153 filter_box->pack_start (filter_entry, true, true);
154 filter_box->pack_start (filter_button, false, false);
156 filter_entry.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
157 filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
158 filter_mode.signal_changed().connect (sigc::mem_fun (*this, &PluginSelector::filter_mode_changed));
162 filter_entry.show ();
163 filter_button.show ();
165 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
167 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
168 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
169 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
171 table->attach(ascroller, 0, 7, 8, 10);
173 add_button (Stock::CLOSE, RESPONSE_CLOSE);
174 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
175 set_default_response (RESPONSE_APPLY);
176 set_response_sensitive (RESPONSE_APPLY, false);
177 get_vbox()->pack_start (*table);
179 table->set_name("PluginSelectorTable");
180 plugin_display.set_name("PluginSelectorDisplay");
181 //plugin_display.set_name("PluginSelectorList");
182 added_list.set_name("PluginSelectorList");
184 plugin_display.signal_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
185 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
186 plugin_display.grab_focus();
188 btn_update->signal_clicked().connect (sigc::mem_fun(*this, &PluginSelector::btn_update_clicked));
189 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
190 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
191 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
196 PluginSelector::~PluginSelector ()
202 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
208 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
211 std::string mode = filter_mode.get_active_text ();
213 if (mode == _("Favorites only")) {
214 return manager.get_status (info) == PluginManager::Favorite;
217 if (mode == _("Hidden only")) {
218 return manager.get_status (info) == PluginManager::Hidden;
221 if (!filterstr.empty()) {
223 if (mode == _("Name contains")) {
224 compstr = info->name;
225 } else if (mode == _("Category contains")) {
226 compstr = info->category;
227 } else if (mode == _("Type contains")) {
229 switch (info->type) {
231 compstr = X_("LADSPA");
234 compstr = X_("AudioUnit");
243 compstr = X_("LXVST");
247 } else if (mode == _("Author contains")) {
248 compstr = info->creator;
249 } else if (mode == _("Library contains")) {
250 compstr = info->path;
253 if (compstr.empty()) {
257 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
259 if (compstr.find (filterstr) != string::npos) {
270 PluginSelector::setup_filter_string (string& filterstr)
272 filterstr = filter_entry.get_text ();
273 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
277 PluginSelector::refill ()
279 std::string filterstr;
281 in_row_change = true;
283 plugin_model->clear ();
285 setup_filter_string (filterstr);
287 ladspa_refiller (filterstr);
288 lv2_refiller (filterstr);
289 vst_refiller (filterstr);
290 lxvst_refiller (filterstr);
291 au_refiller (filterstr);
293 in_row_change = false;
297 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
301 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
303 if (show_this_plugin (*i, filterstr)) {
305 TreeModel::Row newrow = *(plugin_model->append());
306 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
307 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
308 newrow[plugin_columns.name] = (*i)->name;
309 newrow[plugin_columns.type_name] = type;
310 newrow[plugin_columns.category] = (*i)->category;
312 string creator = (*i)->creator;
313 string::size_type pos = 0;
315 /* stupid LADSPA creator strings */
317 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
318 creator = creator.substr (0, pos);
320 newrow[plugin_columns.creator] = creator;
322 if ((*i)->reconfigurable_io ()) {
323 newrow[plugin_columns.audio_ins] = _("variable");
324 newrow[plugin_columns.midi_ins] = _("variable");
325 newrow[plugin_columns.audio_outs] = _("variable");
326 newrow[plugin_columns.midi_outs] = _("variable");
328 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
329 newrow[plugin_columns.audio_ins] = buf;
330 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
331 newrow[plugin_columns.midi_ins] = buf;
333 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
334 newrow[plugin_columns.audio_outs] = buf;
335 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
336 newrow[plugin_columns.midi_outs] = buf;
339 newrow[plugin_columns.plugin] = *i;
345 PluginSelector::ladspa_refiller (const std::string& filterstr)
347 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
351 PluginSelector::lv2_refiller (const std::string& filterstr)
354 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
359 #ifdef WINDOWS_VST_SUPPORT
360 PluginSelector::vst_refiller (const std::string& filterstr)
362 PluginSelector::vst_refiller (const std::string&)
365 #ifdef WINDOWS_VST_SUPPORT
366 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
372 PluginSelector::lxvst_refiller (const std::string& filterstr)
374 PluginSelector::lxvst_refiller (const std::string&)
378 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
383 #ifdef AUDIOUNIT_SUPPORT
384 PluginSelector::au_refiller (const std::string& filterstr)
386 PluginSelector::au_refiller (const std::string&)
389 #ifdef AUDIOUNIT_SUPPORT
390 refiller (manager.au_plugin_info(), filterstr, "AU");
395 PluginSelector::load_plugin (PluginInfoPtr pi)
401 return pi->load (*_session);
405 PluginSelector::btn_add_clicked()
409 TreeModel::Row newrow = *(amodel->append());
412 row = *(plugin_display.get_selection()->get_selected());
413 name = row[plugin_columns.name];
414 pi = row[plugin_columns.plugin];
416 newrow[acols.text] = name;
417 newrow[acols.plugin] = pi;
419 if (!amodel->children().empty()) {
420 set_response_sensitive (RESPONSE_APPLY, true);
425 PluginSelector::btn_remove_clicked()
427 TreeModel::iterator iter = added_list.get_selection()->get_selected();
430 if (amodel->children().empty()) {
431 set_response_sensitive (RESPONSE_APPLY, false);
436 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 = strcasecmp (a->creator.c_str(), b->creator.c_str());
548 } else if (cmp == 0) {
549 /* same creator ... compare names */
550 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
558 struct PluginMenuCompareByName {
559 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
562 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
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 = strcasecmp (a->category.c_str(), b->category.c_str());
584 } else if (cmp == 0) {
585 /* same category ... compare names */
586 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 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 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
688 creator = creator.substr (0, pos);
690 SubmenuMap::iterator x;
692 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
695 submenu = new Gtk::Menu;
696 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
697 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
698 submenu->set_name("ArdourContextMenu");
700 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
701 elem.get_child()->set_use_underline (false);
702 submenu->items().push_back (elem);
708 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
710 using namespace Menu_Helpers;
712 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
713 SubmenuMap category_submenu_map;
715 Menu* by_category = new Menu();
716 by_category->set_name("ArdourContextMenu");
718 MenuList& by_category_items = by_category->items();
719 PluginMenuCompareByCategory cmp_by_category;
720 all_plugs.sort (cmp_by_category);
722 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
724 if (manager.get_status (*i) == PluginManager::Hidden) continue;
726 string category = (*i)->category;
728 SubmenuMap::iterator x;
730 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
733 submenu = new Gtk::Menu;
734 by_category_items.push_back (MenuElem (category, *manage (submenu)));
735 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
736 submenu->set_name("ArdourContextMenu");
738 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
739 elem.get_child()->set_use_underline (false);
740 submenu->items().push_back (elem);
746 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
748 PluginPtr p = load_plugin (pi);
750 if (p && interested_object) {
751 SelectedPlugins plugins;
752 plugins.push_back (p);
753 interested_object->use_plugins (plugins);
756 interested_object = 0;
760 PluginSelector::favorite_changed (const std::string& path)
768 in_row_change = true;
770 TreeModel::iterator iter = plugin_model->get_iter (path);
774 bool favorite = !(*iter)[plugin_columns.favorite];
778 (*iter)[plugin_columns.favorite] = favorite;
779 (*iter)[plugin_columns.hidden] = false;
780 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
782 /* save new statuses list */
784 pi = (*iter)[plugin_columns.plugin];
786 manager.set_status (pi->type, pi->unique_id, status);
788 manager.save_statuses ();
790 build_plugin_menu ();
792 in_row_change = false;
796 PluginSelector::hidden_changed (const std::string& path)
804 in_row_change = true;
806 TreeModel::iterator iter = plugin_model->get_iter (path);
810 bool hidden = !(*iter)[plugin_columns.hidden];
814 (*iter)[plugin_columns.favorite] = false;
815 (*iter)[plugin_columns.hidden] = hidden;
816 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
818 /* save new statuses list */
820 pi = (*iter)[plugin_columns.plugin];
822 manager.set_status (pi->type, pi->unique_id, status);
824 manager.save_statuses ();
826 in_row_change = false;
830 PluginSelector::show_manager ()
837 PluginSelector::set_interested_object (PluginInterestedObject& obj)
839 interested_object = &obj;