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 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 (_("Hid"), 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 (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 (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()->tooltips().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()->tooltips().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()->tooltips().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 (mem_fun (*this, &PluginSelector::filter_entry_changed));
154 filter_button.signal_clicked().connect (mem_fun (*this, &PluginSelector::filter_button_clicked));
155 filter_mode.signal_changed().connect (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_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::row_clicked));
182 plugin_display.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::display_selection_changed));
183 plugin_display.grab_focus();
185 btn_update->signal_clicked().connect (mem_fun(*this, &PluginSelector::btn_update_clicked));
186 btn_add->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_add_clicked));
187 btn_remove->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_remove_clicked));
188 added_list.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::added_list_selection_changed));
194 PluginSelector::row_clicked(GdkEventButton* event)
196 if (event->type == GDK_2BUTTON_PRESS)
201 PluginSelector::set_session (Session* s)
203 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginSelector::set_session), s));
208 session->GoingAway.connect (bind (mem_fun(*this, &PluginSelector::set_session), static_cast<Session*> (0)));
213 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
216 std::string mode = filter_mode.get_active_text ();
218 if (mode == _("Favorites only")) {
219 return manager->get_status (info) == PluginManager::Favorite;
222 if (mode == _("Hidden only")) {
223 return manager->get_status (info) == PluginManager::Hidden;
226 if (!filterstr.empty()) {
228 if (mode == _("Name contains")) {
229 compstr = info->name;
230 } else if (mode == _("Category contains")) {
231 compstr = info->category;
232 } else if (mode == _("Type contains")) {
234 switch (info->type) {
236 compstr = X_("LADSPA");
239 compstr = X_("AudioUnit");
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 au_refiller (filterstr);
294 in_row_change = false;
298 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
302 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
304 if (show_this_plugin (*i, filterstr)) {
306 TreeModel::Row newrow = *(plugin_model->append());
307 newrow[plugin_columns.favorite] = (manager->get_status (*i) == PluginManager::Favorite);
308 newrow[plugin_columns.hidden] = (manager->get_status (*i) == PluginManager::Hidden);
309 newrow[plugin_columns.name] = (*i)->name;
310 newrow[plugin_columns.type_name] = type;
311 newrow[plugin_columns.category] = (*i)->category;
313 string creator = (*i)->creator;
314 string::size_type pos = 0;
316 /* stupid LADSPA creator strings */
318 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
319 creator = creator.substr (0, pos);
321 newrow[plugin_columns.creator] = creator;
323 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
324 newrow[plugin_columns.audio_ins] = buf;
325 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
326 newrow[plugin_columns.midi_ins] = buf;
328 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
329 newrow[plugin_columns.audio_outs] = buf;
330 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
331 newrow[plugin_columns.midi_outs] = buf;
333 newrow[plugin_columns.plugin] = *i;
339 PluginSelector::ladspa_refiller (const std::string& filterstr)
341 refiller (manager->ladspa_plugin_info(), filterstr, "LADSPA");
345 PluginSelector::lv2_refiller (const std::string& filterstr)
348 refiller (manager->lv2_plugin_info(), filterstr, "LV2");
354 PluginSelector::vst_refiller (const std::string& filterstr)
356 PluginSelector::vst_refiller (const std::string&)
360 refiller (manager->vst_plugin_info(), filterstr, "VST");
365 #ifdef HAVE_AUDIOUNITS
366 PluginSelector::au_refiller (const std::string& filterstr)
368 PluginSelector::au_refiller (const std::string&)
371 #ifdef HAVE_AUDIOUNITS
372 refiller (manager->au_plugin_info(), filterstr, "AU");
377 PluginSelector::load_plugin (PluginInfoPtr pi)
383 return pi->load (*session);
387 PluginSelector::btn_add_clicked()
391 TreeModel::Row newrow = *(amodel->append());
394 row = *(plugin_display.get_selection()->get_selected());
395 name = row[plugin_columns.name];
396 pi = row[plugin_columns.plugin];
398 newrow[acols.text] = name;
399 newrow[acols.plugin] = pi;
401 if (!amodel->children().empty()) {
402 set_response_sensitive (RESPONSE_APPLY, true);
407 PluginSelector::btn_remove_clicked()
409 TreeModel::iterator iter = added_list.get_selection()->get_selected();
412 if (amodel->children().empty()) {
413 set_response_sensitive (RESPONSE_APPLY, false);
418 PluginSelector::btn_update_clicked()
425 PluginSelector::display_selection_changed()
427 if (plugin_display.get_selection()->count_selected_rows() != 0) {
428 btn_add->set_sensitive (true);
430 btn_add->set_sensitive (false);
435 PluginSelector::added_list_selection_changed()
437 if (added_list.get_selection()->count_selected_rows() != 0) {
438 btn_remove->set_sensitive (true);
440 btn_remove->set_sensitive (false);
445 PluginSelector::run ()
448 TreeModel::Children::iterator i;
449 SelectedPlugins plugins;
451 r = (ResponseType) Dialog::run ();
455 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
456 PluginInfoPtr pp = (*i)[acols.plugin];
457 PluginPtr p = load_plugin (pp);
459 plugins.push_back (p);
462 if (interested_object && !plugins.empty()) {
463 interested_object->use_plugins (plugins);
474 interested_object = 0;
480 PluginSelector::filter_button_clicked ()
482 filter_entry.set_text ("");
486 PluginSelector::filter_entry_changed ()
492 PluginSelector::filter_mode_changed ()
494 std::string mode = filter_mode.get_active_text ();
496 if (mode == _("Favorites only") || mode == _("Hidden only")) {
497 filter_entry.set_sensitive (false);
499 filter_entry.set_sensitive (true);
506 PluginSelector::on_show ()
508 ArdourDialog::on_show ();
509 filter_entry.grab_focus ();
512 struct PluginMenuCompareByCreator {
513 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
516 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
520 } else if (cmp == 0) {
521 /* same creator ... compare names */
522 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
530 struct PluginMenuCompareByName {
531 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
534 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
538 } else if (cmp == 0) {
539 /* same name ... compare type */
540 if (a->type < b->type) {
548 struct PluginMenuCompareByCategory {
549 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
552 cmp = strcasecmp (a->category.c_str(), b->category.c_str());
556 } else if (cmp == 0) {
557 /* same category ... compare names */
558 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
567 PluginSelector::plugin_menu()
569 PluginInfoList all_plugs;
571 all_plugs.insert (all_plugs.end(), manager->ladspa_plugin_info().begin(), manager->ladspa_plugin_info().end());
573 all_plugs.insert (all_plugs.end(), manager->vst_plugin_info().begin(), manager->vst_plugin_info().end());
575 #ifdef HAVE_AUDIOUNITS
576 all_plugs.insert (all_plugs.end(), manager->au_plugin_info().begin(), manager->au_plugin_info().end());
579 all_plugs.insert (all_plugs.end(), manager->lv2_plugin_info().begin(), manager->lv2_plugin_info().end());
582 using namespace Menu_Helpers;
586 _menu->set_name("ArdourContextMenu");
589 MenuList& items = _menu->items();
592 Gtk::Menu* favs = create_favs_menu(all_plugs);
593 items.push_back (MenuElem (_("Favorites"), *favs));
595 items.push_back (MenuElem (_("Plugin Manager"), mem_fun (*this, &PluginSelector::show_manager)));
596 items.push_back (SeparatorElem ());
598 Menu* by_creator = create_by_creator_menu(all_plugs);
599 items.push_back (MenuElem (_("By Creator"), *by_creator));
601 Menu* by_category = create_by_category_menu(all_plugs);
602 items.push_back (MenuElem (_("By Category"), *by_category));
608 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
610 using namespace Menu_Helpers;
612 Menu* favs = new Menu();
613 favs->set_name("ArdourContextMenu");
615 PluginMenuCompareByName cmp_by_name;
616 all_plugs.sort (cmp_by_name);
618 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
619 if (manager->get_status (*i) == PluginManager::Favorite) {
620 favs->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
627 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
629 using namespace Menu_Helpers;
631 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
632 SubmenuMap creator_submenu_map;
634 Menu* by_creator = new Menu();
635 by_creator->set_name("ArdourContextMenu");
637 MenuList& by_creator_items = by_creator->items();
638 PluginMenuCompareByCreator cmp_by_creator;
639 all_plugs.sort (cmp_by_creator);
641 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
643 if (manager->get_status (*i) == PluginManager::Hidden) continue;
645 string creator = (*i)->creator;
647 /* stupid LADSPA creator strings */
648 string::size_type pos = 0;
649 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
650 creator = creator.substr (0, pos);
652 SubmenuMap::iterator x;
654 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
657 submenu = new Gtk::Menu;
658 by_creator_items.push_back (MenuElem (creator, *submenu));
659 creator_submenu_map.insert (pair<Glib::ustring,Menu*> (creator, submenu));
660 submenu->set_name("ArdourContextMenu");
662 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
668 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
670 using namespace Menu_Helpers;
672 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
673 SubmenuMap category_submenu_map;
675 Menu* by_category = new Menu();
676 by_category->set_name("ArdourContextMenu");
678 MenuList& by_category_items = by_category->items();
679 PluginMenuCompareByCategory cmp_by_category;
680 all_plugs.sort (cmp_by_category);
682 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
684 if (manager->get_status (*i) == PluginManager::Hidden) continue;
686 string category = (*i)->category;
688 SubmenuMap::iterator x;
690 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
693 submenu = new Gtk::Menu;
694 by_category_items.push_back (MenuElem (category, *submenu));
695 category_submenu_map.insert (pair<Glib::ustring,Menu*> (category, submenu));
696 submenu->set_name("ArdourContextMenu");
698 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
704 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
706 PluginPtr p = load_plugin (pi);
708 if (p && interested_object) {
709 SelectedPlugins plugins;
710 plugins.push_back (p);
711 interested_object->use_plugins (plugins);
714 interested_object = 0;
718 PluginSelector::favorite_changed (const Glib::ustring& path)
726 in_row_change = true;
728 TreeModel::iterator iter = plugin_model->get_iter (path);
732 bool favorite = !(*iter)[plugin_columns.favorite];
736 (*iter)[plugin_columns.favorite] = favorite;
737 (*iter)[plugin_columns.hidden] = false;
738 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
740 /* save new statuses list */
742 pi = (*iter)[plugin_columns.plugin];
744 manager->set_status (pi->type, pi->unique_id, status);
746 manager->save_statuses ();
748 in_row_change = false;
752 PluginSelector::hidden_changed (const Glib::ustring& path)
760 in_row_change = true;
762 TreeModel::iterator iter = plugin_model->get_iter (path);
766 bool hidden = !(*iter)[plugin_columns.hidden];
770 (*iter)[plugin_columns.favorite] = false;
771 (*iter)[plugin_columns.hidden] = hidden;
772 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
774 /* save new statuses list */
776 pi = (*iter)[plugin_columns.plugin];
778 manager->set_status (pi->type, pi->unique_id, status);
780 manager->save_statuses ();
782 in_row_change = false;
786 PluginSelector::show_manager ()
793 PluginSelector::set_interested_object (PluginInterestedObject& obj)
795 interested_object = &obj;