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);
75 in_row_change = false;
77 plugin_model = Gtk::ListStore::create (plugin_columns);
78 plugin_display.set_model (plugin_model);
79 /* XXX translators: try to convert "Fav" into a short term
80 related to "favorite" and "Hid" into a short term
83 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
84 plugin_display.append_column (_("Hid"), plugin_columns.hidden);
85 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
86 plugin_display.append_column (_("Type"), plugin_columns.type_name);
87 plugin_display.append_column (_("Category"), plugin_columns.category);
88 plugin_display.append_column (_("Creator"), plugin_columns.creator);
89 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
90 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
91 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
92 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
93 plugin_display.set_headers_visible (true);
94 plugin_display.set_headers_clickable (true);
95 plugin_display.set_reorderable (false);
96 plugin_display.set_rules_hint (true);
98 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
99 fav_cell->property_activatable() = true;
100 fav_cell->property_radio() = true;
101 fav_cell->signal_toggled().connect (mem_fun (*this, &PluginSelector::favorite_changed));
103 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
104 hidden_cell->property_activatable() = true;
105 hidden_cell->property_radio() = true;
106 hidden_cell->signal_toggled().connect (mem_fun (*this, &PluginSelector::hidden_changed));
108 scroller.set_border_width(10);
109 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
110 scroller.add(plugin_display);
112 amodel = Gtk::ListStore::create(acols);
113 added_list.set_model (amodel);
114 added_list.append_column (_("Plugins to be connected"), acols.text);
115 added_list.set_headers_visible (true);
116 added_list.set_reorderable (false);
118 for (int i = 0; i <=8; i++) {
119 Gtk::TreeView::Column* column = plugin_display.get_column(i);
120 column->set_sort_column(i);
123 ascroller.set_border_width(10);
124 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
125 ascroller.add(added_list);
126 btn_add = manage(new Gtk::Button(Stock::ADD));
127 ARDOUR_UI::instance()->tooltips().set_tip(*btn_add, _("Add a plugin to the effect list"));
128 btn_add->set_sensitive (false);
129 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
130 btn_remove->set_sensitive (false);
131 ARDOUR_UI::instance()->tooltips().set_tip(*btn_remove, _("Remove a plugin from the effect list"));
132 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
133 ARDOUR_UI::instance()->tooltips().set_tip(*btn_update, _("Update available plugins"));
135 btn_add->set_name("PluginSelectorButton");
136 btn_remove->set_name("PluginSelectorButton");
138 Gtk::Table* table = manage(new Gtk::Table(7, 11));
139 table->set_size_request(750, 500);
140 table->attach(scroller, 0, 7, 0, 5);
142 HBox* filter_box = manage (new HBox);
144 vector<string> filter_strings = I18N (_filter_mode_strings);
145 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
146 filter_mode.set_active_text (filter_strings.front());
148 filter_box->pack_start (filter_mode, false, false);
149 filter_box->pack_start (filter_entry, true, true);
150 filter_box->pack_start (filter_button, false, false);
152 filter_entry.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_entry_changed));
153 filter_button.signal_clicked().connect (mem_fun (*this, &PluginSelector::filter_button_clicked));
154 filter_mode.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_mode_changed));
158 filter_entry.show ();
159 filter_button.show ();
161 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
163 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
164 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
165 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
167 table->attach(ascroller, 0, 7, 8, 10);
169 add_button (Stock::CLOSE, RESPONSE_CLOSE);
170 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
171 set_default_response (RESPONSE_APPLY);
172 set_response_sensitive (RESPONSE_APPLY, false);
173 get_vbox()->pack_start (*table);
175 table->set_name("PluginSelectorTable");
176 plugin_display.set_name("PluginSelectorDisplay");
177 //plugin_display.set_name("PluginSelectorList");
178 added_list.set_name("PluginSelectorList");
180 plugin_display.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::row_clicked));
181 plugin_display.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::display_selection_changed));
182 plugin_display.grab_focus();
184 btn_update->signal_clicked().connect (mem_fun(*this, &PluginSelector::btn_update_clicked));
185 btn_add->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_add_clicked));
186 btn_remove->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_remove_clicked));
187 added_list.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::added_list_selection_changed));
193 PluginSelector::row_clicked(GdkEventButton* event)
195 if (event->type == GDK_2BUTTON_PRESS)
200 PluginSelector::set_session (Session* s)
202 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginSelector::set_session), s));
207 session->GoingAway.connect (bind (mem_fun(*this, &PluginSelector::set_session), static_cast<Session*> (0)));
212 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
215 std::string mode = filter_mode.get_active_text ();
217 if (mode == _("Favorites only")) {
218 return manager->get_status (info) == PluginManager::Favorite;
221 if (mode == _("Hidden only")) {
222 return manager->get_status (info) == PluginManager::Hidden;
225 if (!filterstr.empty()) {
227 if (mode == _("Name contains")) {
228 compstr = info->name;
229 } else if (mode == _("Category contains")) {
230 compstr = info->category;
231 } else if (mode == _("Type contains")) {
233 switch (info->type) {
235 compstr = X_("LADSPA");
238 compstr = X_("AudioUnit");
248 } else if (mode == _("Author contains")) {
249 compstr = info->creator;
250 } else if (mode == _("Library contains")) {
251 compstr = info->path;
254 if (compstr.empty()) {
258 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
260 if (compstr.find (filterstr) != string::npos) {
271 PluginSelector::setup_filter_string (string& filterstr)
273 filterstr = filter_entry.get_text ();
274 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
278 PluginSelector::refill ()
280 std::string filterstr;
282 in_row_change = true;
284 plugin_model->clear ();
286 setup_filter_string (filterstr);
288 ladspa_refiller (filterstr);
289 lv2_refiller (filterstr);
290 vst_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 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
323 newrow[plugin_columns.audio_ins] = buf;
324 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
325 newrow[plugin_columns.midi_ins] = buf;
327 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
328 newrow[plugin_columns.audio_outs] = buf;
329 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
330 newrow[plugin_columns.midi_outs] = buf;
332 newrow[plugin_columns.plugin] = *i;
338 PluginSelector::ladspa_refiller (const std::string& filterstr)
340 refiller (manager->ladspa_plugin_info(), filterstr, "LADSPA");
344 PluginSelector::lv2_refiller (const std::string& filterstr)
347 refiller (manager->lv2_plugin_info(), filterstr, "LV2");
353 PluginSelector::vst_refiller (const std::string& filterstr)
355 PluginSelector::vst_refiller (const std::string&)
359 refiller (manager->vst_plugin_info(), filterstr, "VST");
364 #ifdef HAVE_AUDIOUNITS
365 PluginSelector::au_refiller (const std::string& filterstr)
367 PluginSelector::au_refiller (const std::string&)
370 #ifdef HAVE_AUDIOUNITS
371 refiller (manager->au_plugin_info(), filterstr, "AU");
376 PluginSelector::load_plugin (PluginInfoPtr pi)
382 return pi->load (*session);
386 PluginSelector::btn_add_clicked()
390 TreeModel::Row newrow = *(amodel->append());
393 row = *(plugin_display.get_selection()->get_selected());
394 name = row[plugin_columns.name];
395 pi = row[plugin_columns.plugin];
397 newrow[acols.text] = name;
398 newrow[acols.plugin] = pi;
400 if (!amodel->children().empty()) {
401 set_response_sensitive (RESPONSE_APPLY, true);
406 PluginSelector::btn_remove_clicked()
408 TreeModel::iterator iter = added_list.get_selection()->get_selected();
411 if (amodel->children().empty()) {
412 set_response_sensitive (RESPONSE_APPLY, false);
417 PluginSelector::btn_update_clicked()
424 PluginSelector::display_selection_changed()
426 if (plugin_display.get_selection()->count_selected_rows() != 0) {
427 btn_add->set_sensitive (true);
429 btn_add->set_sensitive (false);
434 PluginSelector::added_list_selection_changed()
436 if (added_list.get_selection()->count_selected_rows() != 0) {
437 btn_remove->set_sensitive (true);
439 btn_remove->set_sensitive (false);
444 PluginSelector::run ()
447 TreeModel::Children::iterator i;
448 SelectedPlugins plugins;
450 r = (ResponseType) Dialog::run ();
454 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
455 PluginInfoPtr pp = (*i)[acols.plugin];
456 PluginPtr p = load_plugin (pp);
458 plugins.push_back (p);
461 if (interested_object && !plugins.empty()) {
462 interested_object->use_plugins (plugins);
473 interested_object = 0;
479 PluginSelector::filter_button_clicked ()
481 filter_entry.set_text ("");
485 PluginSelector::filter_entry_changed ()
491 PluginSelector::filter_mode_changed ()
493 std::string mode = filter_mode.get_active_text ();
495 if (mode == _("Favorites only") || mode == _("Hidden only")) {
496 filter_entry.set_sensitive (false);
498 filter_entry.set_sensitive (true);
505 PluginSelector::on_show ()
507 ArdourDialog::on_show ();
508 filter_entry.grab_focus ();
511 struct PluginMenuCompareByCreator {
512 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
515 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
519 } else if (cmp == 0) {
520 /* same creator ... compare names */
521 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
529 struct PluginMenuCompareByName {
530 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
533 cmp = strcasecmp (a->name.c_str(), b->name.c_str());
537 } else if (cmp == 0) {
538 /* same name ... compare type */
539 if (a->type < b->type) {
547 struct PluginMenuCompareByCategory {
548 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
551 cmp = strcasecmp (a->category.c_str(), b->category.c_str());
555 } else if (cmp == 0) {
556 /* same category ... compare names */
557 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
565 /** @return a Gtk::manage()d menu */
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;
584 Menu* menu = manage (new Menu());
585 menu->set_name("ArdourContextMenu");
587 MenuList& items = menu->items();
590 Gtk::Menu* favs = create_favs_menu(all_plugs);
591 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
593 items.push_back (MenuElem (_("Plugin Manager"), mem_fun (*this, &PluginSelector::show_manager)));
594 items.push_back (SeparatorElem ());
596 Menu* by_creator = create_by_creator_menu(all_plugs);
597 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
599 Menu* by_category = create_by_category_menu(all_plugs);
600 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
606 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
608 using namespace Menu_Helpers;
610 Menu* favs = new Menu();
611 favs->set_name("ArdourContextMenu");
613 PluginMenuCompareByName cmp_by_name;
614 all_plugs.sort (cmp_by_name);
616 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
617 if (manager->get_status (*i) == PluginManager::Favorite) {
618 favs->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
625 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
627 using namespace Menu_Helpers;
629 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
630 SubmenuMap creator_submenu_map;
632 Menu* by_creator = new Menu();
633 by_creator->set_name("ArdourContextMenu");
635 MenuList& by_creator_items = by_creator->items();
636 PluginMenuCompareByCreator cmp_by_creator;
637 all_plugs.sort (cmp_by_creator);
639 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
641 if (manager->get_status (*i) == PluginManager::Hidden) continue;
643 string creator = (*i)->creator;
645 /* stupid LADSPA creator strings */
646 string::size_type pos = 0;
647 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
648 creator = creator.substr (0, pos);
650 SubmenuMap::iterator x;
652 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
655 submenu = new Gtk::Menu;
656 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
657 creator_submenu_map.insert (pair<Glib::ustring,Menu*> (creator, submenu));
658 submenu->set_name("ArdourContextMenu");
660 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
666 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
668 using namespace Menu_Helpers;
670 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
671 SubmenuMap category_submenu_map;
673 Menu* by_category = new Menu();
674 by_category->set_name("ArdourContextMenu");
676 MenuList& by_category_items = by_category->items();
677 PluginMenuCompareByCategory cmp_by_category;
678 all_plugs.sort (cmp_by_category);
680 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
682 if (manager->get_status (*i) == PluginManager::Hidden) continue;
684 string category = (*i)->category;
686 SubmenuMap::iterator x;
688 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
691 submenu = new Gtk::Menu;
692 by_category_items.push_back (MenuElem (category, *manage (submenu)));
693 category_submenu_map.insert (pair<Glib::ustring,Menu*> (category, submenu));
694 submenu->set_name("ArdourContextMenu");
696 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
702 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
704 PluginPtr p = load_plugin (pi);
706 if (p && interested_object) {
707 SelectedPlugins plugins;
708 plugins.push_back (p);
709 interested_object->use_plugins (plugins);
712 interested_object = 0;
716 PluginSelector::favorite_changed (const Glib::ustring& path)
724 in_row_change = true;
726 TreeModel::iterator iter = plugin_model->get_iter (path);
730 bool favorite = !(*iter)[plugin_columns.favorite];
734 (*iter)[plugin_columns.favorite] = favorite;
735 (*iter)[plugin_columns.hidden] = false;
736 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
738 /* save new statuses list */
740 pi = (*iter)[plugin_columns.plugin];
742 manager->set_status (pi->type, pi->unique_id, status);
744 manager->save_statuses ();
746 in_row_change = false;
750 PluginSelector::hidden_changed (const Glib::ustring& path)
758 in_row_change = true;
760 TreeModel::iterator iter = plugin_model->get_iter (path);
764 bool hidden = !(*iter)[plugin_columns.hidden];
768 (*iter)[plugin_columns.favorite] = false;
769 (*iter)[plugin_columns.hidden] = hidden;
770 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
772 /* save new statuses list */
774 pi = (*iter)[plugin_columns.plugin];
776 manager->set_status (pi->type, pi->unique_id, status);
778 manager->save_statuses ();
780 in_row_change = false;
784 PluginSelector::show_manager ()
791 PluginSelector::set_interested_object (PluginInterestedObject& obj)
793 interested_object = &obj;