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"
42 #include "ardour_ui.h"
43 #include "plugin_selector.h"
44 #include "gui_thread.h"
48 using namespace ARDOUR;
53 static const char* _filter_mode_strings[] = {
56 N_("Category contains"),
57 N_("Author contains"),
58 N_("Library contains"),
63 PluginSelector::PluginSelector (PluginManager *mgr)
64 : ArdourDialog (_("ardour: plugins"), true, false),
65 filter_button (Stock::CLEAR)
67 set_position (Gtk::WIN_POS_MOUSE);
68 set_name ("PluginSelectorWindow");
69 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
74 in_row_change = false;
76 plugin_model = Gtk::ListStore::create (plugin_columns);
77 plugin_display.set_model (plugin_model);
78 /* XXX translators: try to convert "Fav" into a short term
81 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
82 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
83 plugin_display.append_column (_("Type"), plugin_columns.type_name);
84 plugin_display.append_column (_("Category"), plugin_columns.category);
85 plugin_display.append_column (_("Creator"), plugin_columns.creator);
86 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
87 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
88 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
89 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
90 plugin_display.set_headers_visible (true);
91 plugin_display.set_headers_clickable (true);
92 plugin_display.set_reorderable (false);
93 plugin_display.set_rules_hint (true);
95 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
96 fav_cell->property_activatable() = true;
97 fav_cell->property_radio() = false;
98 fav_cell->signal_toggled().connect (mem_fun (*this, &PluginSelector::favorite_changed));
100 scroller.set_border_width(10);
101 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
102 scroller.add(plugin_display);
104 amodel = Gtk::ListStore::create(acols);
105 added_list.set_model (amodel);
106 added_list.append_column (_("Plugins to be connected"), acols.text);
107 added_list.set_headers_visible (true);
108 added_list.set_reorderable (false);
110 for (int i = 0; i <=7; i++) {
111 Gtk::TreeView::Column* column = plugin_display.get_column(i);
112 column->set_sort_column(i);
115 ascroller.set_border_width(10);
116 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
117 ascroller.add(added_list);
118 btn_add = manage(new Gtk::Button(Stock::ADD));
119 ARDOUR_UI::instance()->tooltips().set_tip(*btn_add, _("Add a plugin to the effect list"));
120 btn_add->set_sensitive (false);
121 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
122 btn_remove->set_sensitive (false);
123 ARDOUR_UI::instance()->tooltips().set_tip(*btn_remove, _("Remove a plugin from the effect list"));
124 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
125 ARDOUR_UI::instance()->tooltips().set_tip(*btn_update, _("Update available plugins"));
127 btn_add->set_name("PluginSelectorButton");
128 btn_remove->set_name("PluginSelectorButton");
130 Gtk::Table* table = manage(new Gtk::Table(7, 11));
131 table->set_size_request(750, 500);
132 table->attach(scroller, 0, 7, 0, 5);
134 HBox* filter_box = manage (new HBox);
136 vector<string> filter_strings = I18N (_filter_mode_strings);
137 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
138 filter_mode.set_active_text (filter_strings.front());
140 filter_box->pack_start (filter_mode, false, false);
141 filter_box->pack_start (filter_entry, true, true);
142 filter_box->pack_start (filter_button, false, false);
144 filter_entry.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_entry_changed));
145 filter_button.signal_clicked().connect (mem_fun (*this, &PluginSelector::filter_button_clicked));
146 filter_mode.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_mode_changed));
150 filter_entry.show ();
151 filter_button.show ();
153 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
155 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
156 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
157 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
159 table->attach(ascroller, 0, 7, 8, 10);
161 add_button (Stock::CANCEL, RESPONSE_CANCEL);
162 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
163 set_default_response (RESPONSE_APPLY);
164 set_response_sensitive (RESPONSE_APPLY, false);
165 get_vbox()->pack_start (*table);
167 table->set_name("PluginSelectorTable");
168 plugin_display.set_name("PluginSelectorDisplay");
169 //plugin_display.set_name("PluginSelectorList");
170 added_list.set_name("PluginSelectorList");
172 plugin_display.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::row_clicked));
173 plugin_display.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::display_selection_changed));
174 plugin_display.grab_focus();
176 btn_update->signal_clicked().connect (mem_fun(*this, &PluginSelector::btn_update_clicked));
177 btn_add->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_add_clicked));
178 btn_remove->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_remove_clicked));
179 added_list.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::added_list_selection_changed));
185 PluginSelector::row_clicked(GdkEventButton* event)
187 if (event->type == GDK_2BUTTON_PRESS)
192 PluginSelector::set_session (Session* s)
194 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginSelector::set_session), s));
199 session->GoingAway.connect (bind (mem_fun(*this, &PluginSelector::set_session), static_cast<Session*> (0)));
204 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
207 std::string mode = filter_mode.get_active_text ();
209 if (mode == _("Favorites only")) {
210 return manager->is_a_favorite_plugin (info);
213 if (!filterstr.empty()) {
215 if (mode == _("Name contains")) {
216 compstr = info->name;
217 } else if (mode == _("Category contains")) {
218 compstr = info->category;
219 } else if (mode == _("Type contains")) {
221 switch (info->type) {
223 compstr = X_("LADSPA");
226 compstr = X_("AudioUnit");
236 } else if (mode == _("Author contains")) {
237 compstr = info->creator;
238 } else if (mode == _("Library contains")) {
239 compstr = info->path;
242 if (compstr.empty()) {
246 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
248 if (compstr.find (filterstr) != string::npos) {
259 PluginSelector::setup_filter_string (string& filterstr)
261 filterstr = filter_entry.get_text ();
262 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
266 PluginSelector::refill ()
268 std::string filterstr;
270 in_row_change = true;
272 plugin_model->clear ();
274 setup_filter_string (filterstr);
276 ladspa_refiller (filterstr);
277 lv2_refiller (filterstr);
278 vst_refiller (filterstr);
279 au_refiller (filterstr);
281 in_row_change = false;
285 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
289 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
291 if (show_this_plugin (*i, filterstr)) {
293 TreeModel::Row newrow = *(plugin_model->append());
294 newrow[plugin_columns.favorite] = manager->is_a_favorite_plugin (*i);
295 newrow[plugin_columns.name] = (*i)->name;
296 newrow[plugin_columns.type_name] = type;
297 newrow[plugin_columns.category] = (*i)->category;
299 string creator = (*i)->creator;
300 string::size_type pos = 0;
302 /* stupid LADSPA creator strings */
304 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
305 creator = creator.substr (0, pos);
307 newrow[plugin_columns.creator] = creator;
309 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
310 newrow[plugin_columns.audio_ins] = buf;
311 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
312 newrow[plugin_columns.midi_ins] = buf;
314 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
315 newrow[plugin_columns.audio_outs] = buf;
316 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
317 newrow[plugin_columns.midi_outs] = buf;
319 newrow[plugin_columns.plugin] = *i;
325 PluginSelector::ladspa_refiller (const std::string& filterstr)
327 refiller (manager->ladspa_plugin_info(), filterstr, "LADSPA");
331 PluginSelector::lv2_refiller (const std::string& filterstr)
334 refiller (manager->lv2_plugin_info(), filterstr, "LV2");
340 PluginSelector::vst_refiller (const std::string& filterstr)
342 PluginSelector::vst_refiller (const std::string&)
346 refiller (manager->vst_plugin_info(), filterstr, "VST");
351 #ifdef HAVE_AUDIOUNITS
352 PluginSelector::au_refiller (const std::string& filterstr)
354 PluginSelector::au_refiller (const std::string&)
357 #ifdef HAVE_AUDIOUNITS
358 refiller (manager->au_plugin_info(), filterstr, "AU");
363 PluginSelector::load_plugin (PluginInfoPtr pi)
369 return pi->load (*session);
373 PluginSelector::btn_add_clicked()
377 TreeModel::Row newrow = *(amodel->append());
380 row = *(plugin_display.get_selection()->get_selected());
381 name = row[plugin_columns.name];
382 pi = row[plugin_columns.plugin];
384 newrow[acols.text] = name;
385 newrow[acols.plugin] = pi;
387 if (!amodel->children().empty()) {
388 set_response_sensitive (RESPONSE_APPLY, true);
393 PluginSelector::btn_remove_clicked()
395 TreeModel::iterator iter = added_list.get_selection()->get_selected();
398 if (amodel->children().empty()) {
399 set_response_sensitive (RESPONSE_APPLY, false);
404 PluginSelector::btn_update_clicked()
411 PluginSelector::display_selection_changed()
413 if (plugin_display.get_selection()->count_selected_rows() != 0) {
414 btn_add->set_sensitive (true);
416 btn_add->set_sensitive (false);
421 PluginSelector::added_list_selection_changed()
423 if (added_list.get_selection()->count_selected_rows() != 0) {
424 btn_remove->set_sensitive (true);
426 btn_remove->set_sensitive (false);
431 PluginSelector::run ()
434 TreeModel::Children::iterator i;
435 SelectedPlugins plugins;
437 r = (ResponseType) Dialog::run ();
441 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
442 PluginInfoPtr pp = (*i)[acols.plugin];
443 PluginPtr p = load_plugin (pp);
445 plugins.push_back (p);
448 if (interested_object && !plugins.empty()) {
449 interested_object->use_plugins (plugins);
460 interested_object = 0;
466 PluginSelector::filter_button_clicked ()
468 filter_entry.set_text ("");
472 PluginSelector::filter_entry_changed ()
478 PluginSelector::filter_mode_changed ()
480 std::string mode = filter_mode.get_active_text ();
482 if (mode == _("Favorites only")) {
483 filter_entry.set_sensitive (false);
485 filter_entry.set_sensitive (true);
492 PluginSelector::on_show ()
494 ArdourDialog::on_show ();
495 filter_entry.grab_focus ();
498 struct PluginMenuCompare {
499 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
502 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
506 } else if (cmp == 0) {
507 /* same creator ... compare names */
508 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
517 PluginSelector::plugin_menu()
519 using namespace Menu_Helpers;
521 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
522 SubmenuMap submenu_map;
526 _menu->set_name("ArdourContextMenu");
529 MenuList& items = _menu->items();
530 Menu* favs = new Menu();
531 favs->set_name("ArdourContextMenu");
534 items.push_back (MenuElem (_("Favorites"), *favs));
535 items.push_back (MenuElem (_("Plugin Manager"), mem_fun (*this, &PluginSelector::show_manager)));
536 items.push_back (SeparatorElem ());
538 PluginInfoList all_plugs;
540 all_plugs.insert (all_plugs.end(), manager->ladspa_plugin_info().begin(), manager->ladspa_plugin_info().end());
542 all_plugs.insert (all_plugs.end(), manager->vst_plugin_info().begin(), manager->vst_plugin_info().end());
544 #ifdef HAVE_AUDIOUNITS
545 all_plugs.insert (all_plugs.end(), manager->au_plugin_info().begin(), manager->au_plugin_info().end());
548 all_plugs.insert (all_plugs.end(), manager->lv2_plugin_info().begin(), manager->lv2_plugin_info().end());
551 PluginMenuCompare cmp;
552 all_plugs.sort (cmp);
554 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
555 SubmenuMap::iterator x;
558 string creator = (*i)->creator;
559 string::size_type pos = 0;
561 if (manager->is_a_favorite_plugin (*i)) {
562 favs->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
565 /* stupid LADSPA creator strings */
567 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
568 creator = creator.substr (0, pos);
570 if ((x = submenu_map.find (creator)) != submenu_map.end()) {
573 submenu = new Gtk::Menu;
574 items.push_back (MenuElem (creator, *submenu));
575 submenu_map.insert (pair<Glib::ustring,Menu*> (creator, submenu));
576 submenu->set_name("ArdourContextMenu");
579 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
586 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
588 PluginPtr p = load_plugin (pi);
590 if (p && interested_object) {
591 SelectedPlugins plugins;
592 plugins.push_back (p);
593 interested_object->use_plugins (plugins);
596 interested_object = 0;
600 PluginSelector::favorite_changed (const Glib::ustring& path)
608 in_row_change = true;
610 TreeModel::iterator iter = plugin_model->get_iter (path);
614 bool favorite = !(*iter)[plugin_columns.favorite];
618 (*iter)[plugin_columns.favorite] = favorite;
620 /* save new favorites list */
622 pi = (*iter)[plugin_columns.plugin];
625 manager->add_favorite (pi->type, pi->unique_id);
627 manager->remove_favorite (pi->type, pi->unique_id);
630 manager->save_favorites ();
632 in_row_change = false;
636 PluginSelector::show_manager ()
643 PluginSelector::set_interested_object (PluginInterestedObject& obj)
645 interested_object = &obj;