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 (_("ardour: plugins"), true, false),
67 filter_button (Stock::CLEAR)
69 set_position (Gtk::WIN_POS_MOUSE);
70 set_name ("PluginSelectorWindow");
71 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
76 in_row_change = false;
78 manager->PluginListChanged.connect (mem_fun (*this, &PluginSelector::build_plugin_menu));
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 (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 (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()->tooltips().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()->tooltips().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()->tooltips().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 (mem_fun (*this, &PluginSelector::filter_entry_changed));
157 filter_button.signal_clicked().connect (mem_fun (*this, &PluginSelector::filter_button_clicked));
158 filter_mode.signal_changed().connect (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 (mem_fun(*this, &PluginSelector::row_clicked));
185 plugin_display.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::display_selection_changed));
186 plugin_display.grab_focus();
188 btn_update->signal_clicked().connect (mem_fun(*this, &PluginSelector::btn_update_clicked));
189 btn_add->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_add_clicked));
190 btn_remove->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_remove_clicked));
191 added_list.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::added_list_selection_changed));
196 PluginSelector::~PluginSelector ()
202 PluginSelector::row_clicked(GdkEventButton* event)
204 if (event->type == GDK_2BUTTON_PRESS)
209 PluginSelector::set_session (Session* s)
211 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginSelector::set_session), s));
216 session->GoingAway.connect (bind (mem_fun(*this, &PluginSelector::set_session), static_cast<Session*> (0)));
221 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
224 std::string mode = filter_mode.get_active_text ();
226 if (mode == _("Favorites only")) {
227 return manager->get_status (info) == PluginManager::Favorite;
230 if (mode == _("Hidden only")) {
231 return manager->get_status (info) == PluginManager::Hidden;
234 if (!filterstr.empty()) {
236 if (mode == _("Name contains")) {
237 compstr = info->name;
238 } else if (mode == _("Category contains")) {
239 compstr = info->category;
240 } else if (mode == _("Type contains")) {
242 switch (info->type) {
244 compstr = X_("LADSPA");
247 compstr = X_("AudioUnit");
257 } else if (mode == _("Author contains")) {
258 compstr = info->creator;
259 } else if (mode == _("Library contains")) {
260 compstr = info->path;
263 if (compstr.empty()) {
267 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
269 if (compstr.find (filterstr) != string::npos) {
280 PluginSelector::setup_filter_string (string& filterstr)
282 filterstr = filter_entry.get_text ();
283 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
287 PluginSelector::refill ()
289 std::string filterstr;
291 in_row_change = true;
293 plugin_model->clear ();
295 setup_filter_string (filterstr);
297 ladspa_refiller (filterstr);
298 lv2_refiller (filterstr);
299 vst_refiller (filterstr);
300 au_refiller (filterstr);
302 in_row_change = false;
306 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
310 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
312 if (show_this_plugin (*i, filterstr)) {
314 TreeModel::Row newrow = *(plugin_model->append());
315 newrow[plugin_columns.favorite] = (manager->get_status (*i) == PluginManager::Favorite);
316 newrow[plugin_columns.hidden] = (manager->get_status (*i) == PluginManager::Hidden);
317 newrow[plugin_columns.name] = (*i)->name;
318 newrow[plugin_columns.type_name] = type;
319 newrow[plugin_columns.category] = (*i)->category;
321 string creator = (*i)->creator;
322 string::size_type pos = 0;
324 /* stupid LADSPA creator strings */
326 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
327 creator = creator.substr (0, pos);
329 newrow[plugin_columns.creator] = creator;
331 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
332 newrow[plugin_columns.audio_ins] = buf;
333 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
334 newrow[plugin_columns.midi_ins] = buf;
336 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
337 newrow[plugin_columns.audio_outs] = buf;
338 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
339 newrow[plugin_columns.midi_outs] = buf;
341 newrow[plugin_columns.plugin] = *i;
347 PluginSelector::ladspa_refiller (const std::string& filterstr)
349 refiller (manager->ladspa_plugin_info(), filterstr, "LADSPA");
353 PluginSelector::lv2_refiller (const std::string& filterstr)
356 refiller (manager->lv2_plugin_info(), filterstr, "LV2");
362 PluginSelector::vst_refiller (const std::string& filterstr)
364 PluginSelector::vst_refiller (const std::string&)
368 refiller (manager->vst_plugin_info(), filterstr, "VST");
373 #ifdef HAVE_AUDIOUNITS
374 PluginSelector::au_refiller (const std::string& filterstr)
376 PluginSelector::au_refiller (const std::string&)
379 #ifdef HAVE_AUDIOUNITS
380 refiller (manager->au_plugin_info(), filterstr, "AU");
385 PluginSelector::load_plugin (PluginInfoPtr pi)
391 return pi->load (*session);
395 PluginSelector::btn_add_clicked()
399 TreeModel::Row newrow = *(amodel->append());
402 row = *(plugin_display.get_selection()->get_selected());
403 name = row[plugin_columns.name];
404 pi = row[plugin_columns.plugin];
406 newrow[acols.text] = name;
407 newrow[acols.plugin] = pi;
409 if (!amodel->children().empty()) {
410 set_response_sensitive (RESPONSE_APPLY, true);
415 PluginSelector::btn_remove_clicked()
417 TreeModel::iterator iter = added_list.get_selection()->get_selected();
420 if (amodel->children().empty()) {
421 set_response_sensitive (RESPONSE_APPLY, false);
426 PluginSelector::btn_update_clicked()
433 PluginSelector::display_selection_changed()
435 if (plugin_display.get_selection()->count_selected_rows() != 0) {
436 btn_add->set_sensitive (true);
438 btn_add->set_sensitive (false);
443 PluginSelector::added_list_selection_changed()
445 if (added_list.get_selection()->count_selected_rows() != 0) {
446 btn_remove->set_sensitive (true);
448 btn_remove->set_sensitive (false);
453 PluginSelector::run ()
456 TreeModel::Children::iterator i;
457 SelectedPlugins plugins;
459 r = (ResponseType) Dialog::run ();
463 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
464 PluginInfoPtr pp = (*i)[acols.plugin];
465 PluginPtr p = load_plugin (pp);
467 plugins.push_back (p);
470 if (interested_object && !plugins.empty()) {
471 interested_object->use_plugins (plugins);
482 interested_object = 0;
488 PluginSelector::filter_button_clicked ()
490 filter_entry.set_text ("");
494 PluginSelector::filter_entry_changed ()
500 PluginSelector::filter_mode_changed ()
502 std::string mode = filter_mode.get_active_text ();
504 if (mode == _("Favorites only") || mode == _("Hidden only")) {
505 filter_entry.set_sensitive (false);
507 filter_entry.set_sensitive (true);
514 PluginSelector::on_show ()
516 ArdourDialog::on_show ();
517 filter_entry.grab_focus ();
520 struct PluginMenuCompareByCreator {
521 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
524 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
528 } else if (cmp == 0) {
529 /* same creator ... compare names */
530 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
538 struct PluginMenuCompareByName {
539 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
542 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
546 } else if (cmp == 0) {
547 /* same name ... compare type */
548 if (a->type < b->type) {
556 struct PluginMenuCompareByCategory {
557 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
560 cmp = strcasecmp (a->category.c_str(), b->category.c_str());
564 } else if (cmp == 0) {
565 /* same category ... compare names */
566 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
574 /** @return Plugin menu. The caller should not delete it */
576 PluginSelector::plugin_menu()
582 PluginSelector::build_plugin_menu ()
584 PluginInfoList all_plugs;
586 all_plugs.insert (all_plugs.end(), manager->ladspa_plugin_info().begin(), manager->ladspa_plugin_info().end());
588 all_plugs.insert (all_plugs.end(), manager->vst_plugin_info().begin(), manager->vst_plugin_info().end());
590 #ifdef HAVE_AUDIOUNITS
591 all_plugs.insert (all_plugs.end(), manager->au_plugin_info().begin(), manager->au_plugin_info().end());
594 all_plugs.insert (all_plugs.end(), manager->lv2_plugin_info().begin(), manager->lv2_plugin_info().end());
597 using namespace Menu_Helpers;
601 _plugin_menu = new Menu;
602 _plugin_menu->set_name("ArdourContextMenu");
604 MenuList& items = _plugin_menu->items();
607 Gtk::Menu* favs = create_favs_menu(all_plugs);
608 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
610 items.push_back (MenuElem (_("Plugin Manager"), mem_fun (*this, &PluginSelector::show_manager)));
611 items.push_back (SeparatorElem ());
613 Menu* by_creator = create_by_creator_menu(all_plugs);
614 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
616 Menu* by_category = create_by_category_menu(all_plugs);
617 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
621 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
623 using namespace Menu_Helpers;
625 Menu* favs = new Menu();
626 favs->set_name("ArdourContextMenu");
628 PluginMenuCompareByName cmp_by_name;
629 all_plugs.sort (cmp_by_name);
631 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
632 if (manager->get_status (*i) == PluginManager::Favorite) {
633 favs->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
640 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
642 using namespace Menu_Helpers;
644 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
645 SubmenuMap creator_submenu_map;
647 Menu* by_creator = new Menu();
648 by_creator->set_name("ArdourContextMenu");
650 MenuList& by_creator_items = by_creator->items();
651 PluginMenuCompareByCreator cmp_by_creator;
652 all_plugs.sort (cmp_by_creator);
654 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
656 if (manager->get_status (*i) == PluginManager::Hidden) continue;
658 string creator = (*i)->creator;
660 /* stupid LADSPA creator strings */
661 string::size_type pos = 0;
662 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
663 creator = creator.substr (0, pos);
665 SubmenuMap::iterator x;
667 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
670 submenu = new Gtk::Menu;
671 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
672 creator_submenu_map.insert (pair<Glib::ustring,Menu*> (creator, submenu));
673 submenu->set_name("ArdourContextMenu");
675 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
681 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
683 using namespace Menu_Helpers;
685 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
686 SubmenuMap category_submenu_map;
688 Menu* by_category = new Menu();
689 by_category->set_name("ArdourContextMenu");
691 MenuList& by_category_items = by_category->items();
692 PluginMenuCompareByCategory cmp_by_category;
693 all_plugs.sort (cmp_by_category);
695 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
697 if (manager->get_status (*i) == PluginManager::Hidden) continue;
699 string category = (*i)->category;
701 SubmenuMap::iterator x;
703 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
706 submenu = new Gtk::Menu;
707 by_category_items.push_back (MenuElem (category, *manage (submenu)));
708 category_submenu_map.insert (pair<Glib::ustring,Menu*> (category, submenu));
709 submenu->set_name("ArdourContextMenu");
711 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
717 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
719 PluginPtr p = load_plugin (pi);
721 if (p && interested_object) {
722 SelectedPlugins plugins;
723 plugins.push_back (p);
724 interested_object->use_plugins (plugins);
727 interested_object = 0;
731 PluginSelector::favorite_changed (const Glib::ustring& path)
739 in_row_change = true;
741 TreeModel::iterator iter = plugin_model->get_iter (path);
745 bool favorite = !(*iter)[plugin_columns.favorite];
749 (*iter)[plugin_columns.favorite] = favorite;
750 (*iter)[plugin_columns.hidden] = false;
751 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
753 /* save new statuses list */
755 pi = (*iter)[plugin_columns.plugin];
757 manager->set_status (pi->type, pi->unique_id, status);
759 manager->save_statuses ();
761 build_plugin_menu ();
763 in_row_change = false;
767 PluginSelector::hidden_changed (const Glib::ustring& path)
775 in_row_change = true;
777 TreeModel::iterator iter = plugin_model->get_iter (path);
781 bool hidden = !(*iter)[plugin_columns.hidden];
785 (*iter)[plugin_columns.favorite] = false;
786 (*iter)[plugin_columns.hidden] = hidden;
787 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
789 /* save new statuses list */
791 pi = (*iter)[plugin_columns.plugin];
793 manager->set_status (pi->type, pi->unique_id, status);
795 manager->save_statuses ();
797 in_row_change = false;
801 PluginSelector::show_manager ()
808 PluginSelector::set_interested_object (PluginInterestedObject& obj)
810 interested_object = &obj;