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_button_press_event().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_clicked));
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_clicked(GdkEventButton* event)
204 if (event->type == GDK_2BUTTON_PRESS) {
210 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
213 std::string mode = filter_mode.get_active_text ();
215 if (mode == _("Favorites only")) {
216 return manager.get_status (info) == PluginManager::Favorite;
219 if (mode == _("Hidden only")) {
220 return manager.get_status (info) == PluginManager::Hidden;
223 if (!filterstr.empty()) {
225 if (mode == _("Name contains")) {
226 compstr = info->name;
227 } else if (mode == _("Category contains")) {
228 compstr = info->category;
229 } else if (mode == _("Type contains")) {
231 switch (info->type) {
233 compstr = X_("LADSPA");
236 compstr = X_("AudioUnit");
245 compstr = X_("LXVST");
249 } else if (mode == _("Author contains")) {
250 compstr = info->creator;
251 } else if (mode == _("Library contains")) {
252 compstr = info->path;
255 if (compstr.empty()) {
259 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
261 if (compstr.find (filterstr) != string::npos) {
272 PluginSelector::setup_filter_string (string& filterstr)
274 filterstr = filter_entry.get_text ();
275 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
279 PluginSelector::refill ()
281 std::string filterstr;
283 in_row_change = true;
285 plugin_model->clear ();
287 setup_filter_string (filterstr);
289 ladspa_refiller (filterstr);
290 lv2_refiller (filterstr);
291 vst_refiller (filterstr);
292 lxvst_refiller (filterstr);
293 au_refiller (filterstr);
295 in_row_change = false;
299 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
303 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
305 if (show_this_plugin (*i, filterstr)) {
307 TreeModel::Row newrow = *(plugin_model->append());
308 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
309 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
310 newrow[plugin_columns.name] = (*i)->name;
311 newrow[plugin_columns.type_name] = type;
312 newrow[plugin_columns.category] = (*i)->category;
314 string creator = (*i)->creator;
315 string::size_type pos = 0;
317 /* stupid LADSPA creator strings */
319 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
320 creator = creator.substr (0, pos);
322 newrow[plugin_columns.creator] = creator;
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;
334 newrow[plugin_columns.plugin] = *i;
340 PluginSelector::ladspa_refiller (const std::string& filterstr)
342 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
346 PluginSelector::lv2_refiller (const std::string& filterstr)
349 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
355 PluginSelector::vst_refiller (const std::string& filterstr)
357 PluginSelector::vst_refiller (const std::string&)
361 refiller (manager.vst_plugin_info(), filterstr, "VST");
367 PluginSelector::lxvst_refiller (const std::string& filterstr)
369 PluginSelector::lxvst_refiller (const std::string&)
373 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
378 #ifdef AUDIOUNIT_SUPPORT
379 PluginSelector::au_refiller (const std::string& filterstr)
381 PluginSelector::au_refiller (const std::string&)
384 #ifdef AUDIOUNIT_SUPPORT
385 refiller (manager.au_plugin_info(), filterstr, "AU");
390 PluginSelector::load_plugin (PluginInfoPtr pi)
396 return pi->load (*_session);
400 PluginSelector::btn_add_clicked()
404 TreeModel::Row newrow = *(amodel->append());
407 row = *(plugin_display.get_selection()->get_selected());
408 name = row[plugin_columns.name];
409 pi = row[plugin_columns.plugin];
411 newrow[acols.text] = name;
412 newrow[acols.plugin] = pi;
414 if (!amodel->children().empty()) {
415 set_response_sensitive (RESPONSE_APPLY, true);
420 PluginSelector::btn_remove_clicked()
422 TreeModel::iterator iter = added_list.get_selection()->get_selected();
425 if (amodel->children().empty()) {
426 set_response_sensitive (RESPONSE_APPLY, false);
431 PluginSelector::btn_update_clicked()
438 PluginSelector::display_selection_changed()
440 if (plugin_display.get_selection()->count_selected_rows() != 0) {
441 btn_add->set_sensitive (true);
443 btn_add->set_sensitive (false);
448 PluginSelector::added_list_selection_changed()
450 if (added_list.get_selection()->count_selected_rows() != 0) {
451 btn_remove->set_sensitive (true);
453 btn_remove->set_sensitive (false);
458 PluginSelector::run ()
461 TreeModel::Children::iterator i;
467 SelectedPlugins plugins;
468 r = (ResponseType) Dialog::run ();
472 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
473 PluginInfoPtr pp = (*i)[acols.plugin];
474 PluginPtr p = load_plugin (pp);
476 plugins.push_back (p);
478 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
482 if (interested_object && !plugins.empty()) {
483 finish = !interested_object->use_plugins (plugins);
497 interested_object = 0;
503 PluginSelector::filter_button_clicked ()
505 filter_entry.set_text ("");
509 PluginSelector::filter_entry_changed ()
515 PluginSelector::filter_mode_changed ()
517 std::string mode = filter_mode.get_active_text ();
519 if (mode == _("Favorites only") || mode == _("Hidden only")) {
520 filter_entry.set_sensitive (false);
522 filter_entry.set_sensitive (true);
529 PluginSelector::on_show ()
531 ArdourDialog::on_show ();
532 filter_entry.grab_focus ();
535 struct PluginMenuCompareByCreator {
536 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
539 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
543 } else if (cmp == 0) {
544 /* same creator ... compare names */
545 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
553 struct PluginMenuCompareByName {
554 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
557 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
561 } else if (cmp == 0) {
562 /* same name ... compare type */
563 if (a->type < b->type) {
571 struct PluginMenuCompareByCategory {
572 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
575 cmp = strcasecmp (a->category.c_str(), b->category.c_str());
579 } else if (cmp == 0) {
580 /* same category ... compare names */
581 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
589 /** @return Plugin menu. The caller should not delete it */
591 PluginSelector::plugin_menu()
597 PluginSelector::build_plugin_menu ()
599 PluginInfoList all_plugs;
601 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
603 all_plugs.insert (all_plugs.end(), manager.vst_plugin_info().begin(), manager.vst_plugin_info().end());
606 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
608 #ifdef AUDIOUNIT_SUPPORT
609 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
612 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
615 using namespace Menu_Helpers;
619 _plugin_menu = manage (new Menu);
620 _plugin_menu->set_name("ArdourContextMenu");
622 MenuList& items = _plugin_menu->items();
625 Gtk::Menu* favs = create_favs_menu(all_plugs);
626 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
628 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
629 items.push_back (SeparatorElem ());
631 Menu* by_creator = create_by_creator_menu(all_plugs);
632 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
634 Menu* by_category = create_by_category_menu(all_plugs);
635 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
639 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
641 using namespace Menu_Helpers;
643 Menu* favs = new Menu();
644 favs->set_name("ArdourContextMenu");
646 PluginMenuCompareByName cmp_by_name;
647 all_plugs.sort (cmp_by_name);
649 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
650 if (manager.get_status (*i) == PluginManager::Favorite) {
651 favs->items().push_back (MenuElem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
658 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
660 using namespace Menu_Helpers;
662 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
663 SubmenuMap creator_submenu_map;
665 Menu* by_creator = new Menu();
666 by_creator->set_name("ArdourContextMenu");
668 MenuList& by_creator_items = by_creator->items();
669 PluginMenuCompareByCreator cmp_by_creator;
670 all_plugs.sort (cmp_by_creator);
672 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
674 if (manager.get_status (*i) == PluginManager::Hidden) continue;
676 string creator = (*i)->creator;
678 /* stupid LADSPA creator strings */
679 string::size_type pos = 0;
680 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
681 creator = creator.substr (0, pos);
683 SubmenuMap::iterator x;
685 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
688 submenu = new Gtk::Menu;
689 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
690 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
691 submenu->set_name("ArdourContextMenu");
693 submenu->items().push_back (MenuElem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
699 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
701 using namespace Menu_Helpers;
703 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
704 SubmenuMap category_submenu_map;
706 Menu* by_category = new Menu();
707 by_category->set_name("ArdourContextMenu");
709 MenuList& by_category_items = by_category->items();
710 PluginMenuCompareByCategory cmp_by_category;
711 all_plugs.sort (cmp_by_category);
713 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
715 if (manager.get_status (*i) == PluginManager::Hidden) continue;
717 string category = (*i)->category;
719 SubmenuMap::iterator x;
721 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
724 submenu = new Gtk::Menu;
725 by_category_items.push_back (MenuElem (category, *manage (submenu)));
726 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
727 submenu->set_name("ArdourContextMenu");
729 submenu->items().push_back (MenuElem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
735 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
737 PluginPtr p = load_plugin (pi);
739 if (p && interested_object) {
740 SelectedPlugins plugins;
741 plugins.push_back (p);
742 interested_object->use_plugins (plugins);
745 interested_object = 0;
749 PluginSelector::favorite_changed (const std::string& path)
757 in_row_change = true;
759 TreeModel::iterator iter = plugin_model->get_iter (path);
763 bool favorite = !(*iter)[plugin_columns.favorite];
767 (*iter)[plugin_columns.favorite] = favorite;
768 (*iter)[plugin_columns.hidden] = false;
769 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
771 /* save new statuses list */
773 pi = (*iter)[plugin_columns.plugin];
775 manager.set_status (pi->type, pi->unique_id, status);
777 manager.save_statuses ();
779 build_plugin_menu ();
781 in_row_change = false;
785 PluginSelector::hidden_changed (const std::string& path)
793 in_row_change = true;
795 TreeModel::iterator iter = plugin_model->get_iter (path);
799 bool hidden = !(*iter)[plugin_columns.hidden];
803 (*iter)[plugin_columns.favorite] = false;
804 (*iter)[plugin_columns.hidden] = hidden;
805 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
807 /* save new statuses list */
809 pi = (*iter)[plugin_columns.plugin];
811 manager.set_status (pi->type, pi->unique_id, status);
813 manager.save_statuses ();
815 in_row_change = false;
819 PluginSelector::show_manager ()
826 PluginSelector::set_interested_object (PluginInterestedObject& obj)
828 interested_object = &obj;