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.
26 #include <gtkmm/table.h>
27 #include <gtkmm/stock.h>
28 #include <gtkmm/button.h>
29 #include <gtkmm/notebook.h>
31 #include <gtkmm2ext/utils.h>
33 #include "pbd/convert.h"
35 #include "ardour/plugin_manager.h"
36 #include "ardour/plugin.h"
37 #include "ardour/configuration.h"
39 #include "ardour_ui.h"
40 #include "plugin_selector.h"
41 #include "gui_thread.h"
45 using namespace ARDOUR;
50 static const char* _filter_mode_strings[] = {
53 N_("Category contains"),
54 N_("Author contains"),
55 N_("Library contains"),
60 PluginSelector::PluginSelector (PluginManager *mgr)
61 : ArdourDialog (_("ardour: plugins"), true, false),
62 filter_button (Stock::CLEAR)
64 set_position (Gtk::WIN_POS_MOUSE);
65 set_name ("PluginSelectorWindow");
66 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
71 in_row_change = false;
73 plugin_model = Gtk::ListStore::create (plugin_columns);
74 plugin_display.set_model (plugin_model);
75 /* XXX translators: try to convert "Fav" into a short term
78 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
79 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
80 plugin_display.append_column (_("Type"), plugin_columns.type_name);
81 plugin_display.append_column (_("Category"), plugin_columns.category);
82 plugin_display.append_column (_("Creator"), plugin_columns.creator);
83 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
84 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
85 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
86 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
87 plugin_display.set_headers_visible (true);
88 plugin_display.set_headers_clickable (true);
89 plugin_display.set_reorderable (false);
90 plugin_display.set_rules_hint (true);
92 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
93 fav_cell->property_activatable() = true;
94 fav_cell->property_radio() = false;
95 fav_cell->signal_toggled().connect (mem_fun (*this, &PluginSelector::favorite_changed));
97 scroller.set_border_width(10);
98 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
99 scroller.add(plugin_display);
101 amodel = Gtk::ListStore::create(acols);
102 added_list.set_model (amodel);
103 added_list.append_column (_("Plugins to be connected"), acols.text);
104 added_list.set_headers_visible (true);
105 added_list.set_reorderable (false);
107 for (int i = 0; i <=7; i++) {
108 Gtk::TreeView::Column* column = plugin_display.get_column(i);
109 column->set_sort_column(i);
112 ascroller.set_border_width(10);
113 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
114 ascroller.add(added_list);
115 btn_add = manage(new Gtk::Button(Stock::ADD));
116 ARDOUR_UI::instance()->tooltips().set_tip(*btn_add, _("Add a plugin to the effect list"));
117 btn_add->set_sensitive (false);
118 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
119 btn_remove->set_sensitive (false);
120 ARDOUR_UI::instance()->tooltips().set_tip(*btn_remove, _("Remove a plugin from the effect list"));
121 Gtk::Button *btn_update = manage(new Gtk::Button(Stock::REFRESH));
122 ARDOUR_UI::instance()->tooltips().set_tip(*btn_update, _("Update available plugins"));
124 btn_add->set_name("PluginSelectorButton");
125 btn_remove->set_name("PluginSelectorButton");
127 Gtk::Table* table = manage(new Gtk::Table(7, 11));
128 table->set_size_request(750, 500);
129 table->attach(scroller, 0, 7, 0, 5);
131 HBox* filter_box = manage (new HBox);
133 vector<string> filter_strings = I18N (_filter_mode_strings);
134 Gtkmm2ext::set_popdown_strings (filter_mode, filter_strings);
135 filter_mode.set_active_text (filter_strings.front());
137 filter_box->pack_start (filter_mode, false, false);
138 filter_box->pack_start (filter_entry, true, true);
139 filter_box->pack_start (filter_button, false, false);
141 filter_entry.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_entry_changed));
142 filter_button.signal_clicked().connect (mem_fun (*this, &PluginSelector::filter_button_clicked));
143 filter_mode.signal_changed().connect (mem_fun (*this, &PluginSelector::filter_mode_changed));
147 filter_entry.show ();
148 filter_button.show ();
150 table->attach (*filter_box, 0, 7, 5, 6, FILL|EXPAND, FILL, 5, 5);
152 table->attach(*btn_add, 1, 2, 6, 7, FILL, FILL, 5, 5);
153 table->attach(*btn_remove, 3, 4, 6, 7, FILL, FILL, 5, 5);
154 table->attach(*btn_update, 5, 6, 6, 7, FILL, FILL, 5, 5);
156 table->attach(ascroller, 0, 7, 8, 10);
158 add_button (Stock::CANCEL, RESPONSE_CANCEL);
159 add_button (_("Insert Plugin(s)"), RESPONSE_APPLY);
160 set_default_response (RESPONSE_APPLY);
161 set_response_sensitive (RESPONSE_APPLY, false);
162 get_vbox()->pack_start (*table);
164 table->set_name("PluginSelectorTable");
165 plugin_display.set_name("PluginSelectorDisplay");
166 //plugin_display.set_name("PluginSelectorList");
167 added_list.set_name("PluginSelectorList");
169 plugin_display.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::row_clicked));
170 plugin_display.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::display_selection_changed));
171 plugin_display.grab_focus();
173 btn_update->signal_clicked().connect (mem_fun(*this, &PluginSelector::btn_update_clicked));
174 btn_add->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_add_clicked));
175 btn_remove->signal_clicked().connect(mem_fun(*this, &PluginSelector::btn_remove_clicked));
176 added_list.get_selection()->signal_changed().connect (mem_fun(*this, &PluginSelector::added_list_selection_changed));
182 PluginSelector::row_clicked(GdkEventButton* event)
184 if (event->type == GDK_2BUTTON_PRESS)
189 PluginSelector::set_session (Session* s)
191 ENSURE_GUI_THREAD(bind (mem_fun(*this, &PluginSelector::set_session), s));
196 session->GoingAway.connect (bind (mem_fun(*this, &PluginSelector::set_session), static_cast<Session*> (0)));
201 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
204 std::string mode = filter_mode.get_active_text ();
206 if (mode == _("Favorites only")) {
207 return manager->is_a_favorite_plugin (info);
210 if (!filterstr.empty()) {
212 if (mode == _("Name contains")) {
213 compstr = info->name;
214 } else if (mode == _("Category contains")) {
215 compstr = info->category;
216 } else if (mode == _("Type contains")) {
218 switch (info->type) {
220 compstr = X_("LADSPA");
223 compstr = X_("AudioUnit");
233 } else if (mode == _("Author contains")) {
234 compstr = info->creator;
235 } else if (mode == _("Library contains")) {
236 compstr = info->path;
239 if (compstr.empty()) {
243 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
245 if (compstr.find (filterstr) != string::npos) {
256 PluginSelector::setup_filter_string (string& filterstr)
258 filterstr = filter_entry.get_text ();
259 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
263 PluginSelector::refill ()
265 std::string filterstr;
267 in_row_change = true;
269 plugin_model->clear ();
271 setup_filter_string (filterstr);
273 ladspa_refiller (filterstr);
274 lv2_refiller (filterstr);
275 vst_refiller (filterstr);
276 au_refiller (filterstr);
278 in_row_change = false;
282 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
286 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
288 if (show_this_plugin (*i, filterstr)) {
290 TreeModel::Row newrow = *(plugin_model->append());
291 newrow[plugin_columns.favorite] = manager->is_a_favorite_plugin (*i);
292 newrow[plugin_columns.name] = (*i)->name;
293 newrow[plugin_columns.type_name] = type;
294 newrow[plugin_columns.category] = (*i)->category;
296 string creator = (*i)->creator;
297 string::size_type pos = 0;
299 /* stupid LADSPA creator strings */
301 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
302 creator = creator.substr (0, pos);
304 newrow[plugin_columns.creator] = creator;
306 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
307 newrow[plugin_columns.audio_ins] = buf;
308 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
309 newrow[plugin_columns.midi_ins] = buf;
311 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
312 newrow[plugin_columns.audio_outs] = buf;
313 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
314 newrow[plugin_columns.midi_outs] = buf;
316 newrow[plugin_columns.plugin] = *i;
322 PluginSelector::ladspa_refiller (const std::string& filterstr)
324 refiller (manager->ladspa_plugin_info(), filterstr, "LADSPA");
328 PluginSelector::lv2_refiller (const std::string& filterstr)
331 refiller (manager->lv2_plugin_info(), filterstr, "LV2");
336 PluginSelector::vst_refiller (const std::string& filterstr)
339 refiller (manager->vst_plugin_info(), filterstr, "VST");
344 PluginSelector::au_refiller (const std::string& filterstr)
346 #ifdef HAVE_AUDIOUNITS
347 refiller (manager->au_plugin_info(), filterstr, "AU");
352 PluginSelector::load_plugin (PluginInfoPtr pi)
358 return pi->load (*session);
362 PluginSelector::btn_add_clicked()
366 TreeModel::Row newrow = *(amodel->append());
369 row = *(plugin_display.get_selection()->get_selected());
370 name = row[plugin_columns.name];
371 pi = row[plugin_columns.plugin];
373 newrow[acols.text] = name;
374 newrow[acols.plugin] = pi;
376 if (!amodel->children().empty()) {
377 set_response_sensitive (RESPONSE_APPLY, true);
382 PluginSelector::btn_remove_clicked()
384 TreeModel::iterator iter = added_list.get_selection()->get_selected();
387 if (amodel->children().empty()) {
388 set_response_sensitive (RESPONSE_APPLY, false);
393 PluginSelector::btn_update_clicked()
400 PluginSelector::display_selection_changed()
402 if (plugin_display.get_selection()->count_selected_rows() != 0) {
403 btn_add->set_sensitive (true);
405 btn_add->set_sensitive (false);
410 PluginSelector::added_list_selection_changed()
412 if (added_list.get_selection()->count_selected_rows() != 0) {
413 btn_remove->set_sensitive (true);
415 btn_remove->set_sensitive (false);
420 PluginSelector::run ()
423 TreeModel::Children::iterator i;
424 SelectedPlugins plugins;
426 r = (ResponseType) Dialog::run ();
430 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
431 PluginInfoPtr pp = (*i)[acols.plugin];
432 PluginPtr p = load_plugin (pp);
434 plugins.push_back (p);
437 if (interested_object && !plugins.empty()) {
438 interested_object->use_plugins (plugins);
449 interested_object = 0;
455 PluginSelector::filter_button_clicked ()
457 filter_entry.set_text ("");
461 PluginSelector::filter_entry_changed ()
467 PluginSelector::filter_mode_changed ()
469 std::string mode = filter_mode.get_active_text ();
471 if (mode == _("Favorites only")) {
472 filter_entry.set_sensitive (false);
474 filter_entry.set_sensitive (true);
481 PluginSelector::on_show ()
483 ArdourDialog::on_show ();
484 filter_entry.grab_focus ();
487 struct PluginMenuCompare {
488 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
491 cmp = strcasecmp (a->creator.c_str(), b->creator.c_str());
495 } else if (cmp == 0) {
496 /* same creator ... compare names */
497 if (strcasecmp (a->name.c_str(), b->name.c_str()) < 0) {
506 PluginSelector::plugin_menu()
508 using namespace Menu_Helpers;
510 typedef std::map<Glib::ustring,Gtk::Menu*> SubmenuMap;
511 SubmenuMap submenu_map;
515 _menu->set_name("ArdourContextMenu");
518 MenuList& items = _menu->items();
519 Menu* favs = new Menu();
520 favs->set_name("ArdourContextMenu");
523 items.push_back (MenuElem (_("Favorites"), *favs));
524 items.push_back (MenuElem (_("Plugin Manager"), mem_fun (*this, &PluginSelector::show_manager)));
525 items.push_back (SeparatorElem ());
527 PluginInfoList all_plugs;
529 all_plugs.insert (all_plugs.end(), manager->ladspa_plugin_info().begin(), manager->ladspa_plugin_info().end());
531 all_plugs.insert (all_plugs.end(), manager->vst_plugin_info().begin(), manager->vst_plugin_info().end());
533 #ifdef HAVE_AUDIOUNITS
534 all_plugs.insert (all_plugs.end(), manager->au_plugin_info().begin(), manager->au_plugin_info().end());
537 all_plugs.insert (all_plugs.end(), manager->lv2_plugin_info().begin(), manager->lv2_plugin_info().end());
540 PluginMenuCompare cmp;
541 all_plugs.sort (cmp);
543 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
544 SubmenuMap::iterator x;
547 string creator = (*i)->creator;
548 string::size_type pos = 0;
550 if (manager->is_a_favorite_plugin (*i)) {
551 favs->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
554 /* stupid LADSPA creator strings */
556 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
557 creator = creator.substr (0, pos);
559 if ((x = submenu_map.find (creator)) != submenu_map.end()) {
562 submenu = new Gtk::Menu;
563 items.push_back (MenuElem (creator, *submenu));
564 submenu_map.insert (pair<Glib::ustring,Menu*> (creator, submenu));
565 submenu->set_name("ArdourContextMenu");
568 submenu->items().push_back (MenuElem ((*i)->name, (bind (mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i))));
575 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
577 PluginPtr p = load_plugin (pi);
579 if (p && interested_object) {
580 SelectedPlugins plugins;
581 plugins.push_back (p);
582 interested_object->use_plugins (plugins);
585 interested_object = 0;
589 PluginSelector::favorite_changed (const Glib::ustring& path)
597 in_row_change = true;
599 TreeModel::iterator iter = plugin_model->get_iter (path);
603 bool favorite = !(*iter)[plugin_columns.favorite];
607 (*iter)[plugin_columns.favorite] = favorite;
609 /* save new favorites list */
611 pi = (*iter)[plugin_columns.plugin];
614 manager->add_favorite (pi->type, pi->unique_id);
616 manager->remove_favorite (pi->type, pi->unique_id);
619 manager->save_favorites ();
621 in_row_change = false;
625 PluginSelector::show_manager ()
632 PluginSelector::set_interested_object (PluginInterestedObject& obj)
634 interested_object = &obj;