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"
28 #include <gtkmm/table.h>
29 #include <gtkmm/stock.h>
30 #include <gtkmm/button.h>
31 #include <gtkmm/notebook.h>
33 #include <gtkmm2ext/utils.h>
35 #include "pbd/convert.h"
37 #include "ardour/plugin_manager.h"
38 #include "ardour/plugin.h"
39 #include "ardour/utils.h"
41 #include "plugin_selector.h"
42 #include "gui_thread.h"
47 using namespace ARDOUR;
51 using namespace ARDOUR_UI_UTILS;
53 static const char* _filter_mode_strings[] = {
56 N_("Category contains"),
57 N_("Author contains"),
58 N_("Library contains"),
64 PluginSelector::PluginSelector (PluginManager& mgr)
65 : ArdourDialog (_("Plugin Manager"), true, false)
66 , filter_button (Stock::CLEAR)
70 set_name ("PluginSelectorWindow");
71 add_events (Gdk::KEY_PRESS_MASK|Gdk::KEY_RELEASE_MASK);
74 in_row_change = false;
76 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::build_plugin_menu, this), gui_context());
77 manager.PluginListChanged.connect (plugin_list_changed_connection, invalidator (*this), boost::bind (&PluginSelector::refill, this), gui_context());
80 plugin_model = Gtk::ListStore::create (plugin_columns);
81 plugin_display.set_model (plugin_model);
82 /* XXX translators: try to convert "Fav" into a short term
83 related to "favorite" and "Hid" into a short term
86 plugin_display.append_column (_("Fav"), plugin_columns.favorite);
87 plugin_display.append_column (_("Hide"), plugin_columns.hidden);
88 plugin_display.append_column (_("Available Plugins"), plugin_columns.name);
89 plugin_display.append_column (_("Type"), plugin_columns.type_name);
90 plugin_display.append_column (_("Category"), plugin_columns.category);
91 plugin_display.append_column (_("Creator"), plugin_columns.creator);
92 plugin_display.append_column (_("# Audio In"),plugin_columns.audio_ins);
93 plugin_display.append_column (_("# Audio Out"), plugin_columns.audio_outs);
94 plugin_display.append_column (_("# MIDI In"),plugin_columns.midi_ins);
95 plugin_display.append_column (_("# MIDI Out"), plugin_columns.midi_outs);
96 plugin_display.set_headers_visible (true);
97 plugin_display.set_headers_clickable (true);
98 plugin_display.set_reorderable (false);
99 plugin_display.set_rules_hint (true);
101 CellRendererToggle* fav_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (0));
102 fav_cell->property_activatable() = true;
103 fav_cell->property_radio() = true;
104 fav_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::favorite_changed));
106 CellRendererToggle* hidden_cell = dynamic_cast<CellRendererToggle*>(plugin_display.get_column_cell_renderer (1));
107 hidden_cell->property_activatable() = true;
108 hidden_cell->property_radio() = true;
109 hidden_cell->signal_toggled().connect (sigc::mem_fun (*this, &PluginSelector::hidden_changed));
111 scroller.set_border_width(10);
112 scroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
113 scroller.add(plugin_display);
115 amodel = Gtk::ListStore::create(acols);
116 added_list.set_model (amodel);
117 added_list.append_column (_("Plugins to be connected"), acols.text);
118 added_list.set_headers_visible (true);
119 added_list.set_reorderable (false);
121 for (int i = 0; i <=8; i++) {
122 Gtk::TreeView::Column* column = plugin_display.get_column(i);
123 column->set_sort_column(i);
126 ascroller.set_border_width(10);
127 ascroller.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);
128 ascroller.add(added_list);
129 btn_add = manage(new Gtk::Button(Stock::ADD));
130 set_tooltip(*btn_add, _("Add a plugin to the effect list"));
131 btn_add->set_sensitive (false);
132 btn_remove = manage(new Gtk::Button(Stock::REMOVE));
133 btn_remove->set_sensitive (false);
134 set_tooltip(*btn_remove, _("Remove a plugin from the effect list"));
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 (sigc::mem_fun (*this, &PluginSelector::filter_entry_changed));
154 filter_button.signal_clicked().connect (sigc::mem_fun (*this, &PluginSelector::filter_button_clicked));
155 filter_mode.signal_changed().connect (sigc::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, 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_row_activated().connect_notify (sigc::mem_fun(*this, &PluginSelector::row_activated));
181 plugin_display.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::display_selection_changed));
182 plugin_display.grab_focus();
184 btn_add->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_add_clicked));
185 btn_remove->signal_clicked().connect(sigc::mem_fun(*this, &PluginSelector::btn_remove_clicked));
186 added_list.get_selection()->signal_changed().connect (sigc::mem_fun(*this, &PluginSelector::added_list_selection_changed));
187 added_list.signal_button_press_event().connect_notify (mem_fun(*this, &PluginSelector::added_row_clicked));
192 PluginSelector::~PluginSelector ()
198 PluginSelector::row_activated(Gtk::TreeModel::Path, Gtk::TreeViewColumn*)
204 PluginSelector::added_row_clicked(GdkEventButton* event)
206 if (event->type == GDK_2BUTTON_PRESS)
207 btn_remove_clicked();
211 PluginSelector::show_this_plugin (const PluginInfoPtr& info, const std::string& filterstr)
214 std::string mode = filter_mode.get_active_text ();
216 if (mode == _("Favorites only")) {
217 return manager.get_status (info) == PluginManager::Favorite;
220 if (mode == _("Hidden only")) {
221 return manager.get_status (info) == PluginManager::Hidden;
224 if (!filterstr.empty()) {
226 if (mode == _("Name contains")) {
227 compstr = info->name;
228 } else if (mode == _("Category contains")) {
229 compstr = info->category;
230 } else if (mode == _("Type contains")) {
232 switch (info->type) {
234 compstr = X_("LADSPA");
237 compstr = X_("AudioUnit");
246 compstr = X_("LXVST");
250 } else if (mode == _("Author contains")) {
251 compstr = info->creator;
252 } else if (mode == _("Library contains")) {
253 compstr = info->path;
256 if (compstr.empty()) {
260 transform (compstr.begin(), compstr.end(), compstr.begin(), ::toupper);
262 if (compstr.find (filterstr) != string::npos) {
273 PluginSelector::setup_filter_string (string& filterstr)
275 filterstr = filter_entry.get_text ();
276 transform (filterstr.begin(), filterstr.end(), filterstr.begin(), ::toupper);
280 PluginSelector::refill ()
282 std::string filterstr;
284 in_row_change = true;
286 plugin_model->clear ();
288 setup_filter_string (filterstr);
290 ladspa_refiller (filterstr);
291 lv2_refiller (filterstr);
292 vst_refiller (filterstr);
293 lxvst_refiller (filterstr);
294 au_refiller (filterstr);
296 in_row_change = false;
300 PluginSelector::refiller (const PluginInfoList& plugs, const::std::string& filterstr, const char* type)
304 for (PluginInfoList::const_iterator i = plugs.begin(); i != plugs.end(); ++i) {
306 if (show_this_plugin (*i, filterstr)) {
308 TreeModel::Row newrow = *(plugin_model->append());
309 newrow[plugin_columns.favorite] = (manager.get_status (*i) == PluginManager::Favorite);
310 newrow[plugin_columns.hidden] = (manager.get_status (*i) == PluginManager::Hidden);
311 newrow[plugin_columns.name] = (*i)->name;
312 newrow[plugin_columns.type_name] = type;
313 newrow[plugin_columns.category] = (*i)->category;
315 string creator = (*i)->creator;
316 string::size_type pos = 0;
318 /* stupid LADSPA creator strings */
319 #ifdef PLATFORM_WINDOWS
320 while (pos < creator.length() && creator[pos] > -2 && creator[pos] < 256 && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
322 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
324 // If there were too few characters to create a
325 // meaningful name, mark this creator as 'Unknown'
326 if (creator.length()<2 || pos<3)
329 creator = creator.substr (0, pos);
331 newrow[plugin_columns.creator] = creator;
333 if ((*i)->reconfigurable_io ()) {
334 newrow[plugin_columns.audio_ins] = _("variable");
335 newrow[plugin_columns.midi_ins] = _("variable");
336 newrow[plugin_columns.audio_outs] = _("variable");
337 newrow[plugin_columns.midi_outs] = _("variable");
339 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_audio());
340 newrow[plugin_columns.audio_ins] = buf;
341 snprintf (buf, sizeof(buf), "%d", (*i)->n_inputs.n_midi());
342 newrow[plugin_columns.midi_ins] = buf;
344 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_audio());
345 newrow[plugin_columns.audio_outs] = buf;
346 snprintf (buf, sizeof(buf), "%d", (*i)->n_outputs.n_midi());
347 newrow[plugin_columns.midi_outs] = buf;
350 newrow[plugin_columns.plugin] = *i;
356 PluginSelector::ladspa_refiller (const std::string& filterstr)
358 refiller (manager.ladspa_plugin_info(), filterstr, "LADSPA");
362 PluginSelector::lv2_refiller (const std::string& filterstr)
365 refiller (manager.lv2_plugin_info(), filterstr, "LV2");
370 #ifdef WINDOWS_VST_SUPPORT
371 PluginSelector::vst_refiller (const std::string& filterstr)
373 PluginSelector::vst_refiller (const std::string&)
376 #ifdef WINDOWS_VST_SUPPORT
377 refiller (manager.windows_vst_plugin_info(), filterstr, "VST");
383 PluginSelector::lxvst_refiller (const std::string& filterstr)
385 PluginSelector::lxvst_refiller (const std::string&)
389 refiller (manager.lxvst_plugin_info(), filterstr, "LXVST");
394 #ifdef AUDIOUNIT_SUPPORT
395 PluginSelector::au_refiller (const std::string& filterstr)
397 PluginSelector::au_refiller (const std::string&)
400 #ifdef AUDIOUNIT_SUPPORT
401 refiller (manager.au_plugin_info(), filterstr, "AU");
406 PluginSelector::load_plugin (PluginInfoPtr pi)
412 return pi->load (*_session);
416 PluginSelector::btn_add_clicked()
420 TreeModel::Row newrow = *(amodel->append());
423 row = *(plugin_display.get_selection()->get_selected());
424 name = row[plugin_columns.name];
425 pi = row[plugin_columns.plugin];
427 newrow[acols.text] = name;
428 newrow[acols.plugin] = pi;
430 if (!amodel->children().empty()) {
431 set_response_sensitive (RESPONSE_APPLY, true);
436 PluginSelector::btn_remove_clicked()
438 TreeModel::iterator iter = added_list.get_selection()->get_selected();
441 if (amodel->children().empty()) {
442 set_response_sensitive (RESPONSE_APPLY, false);
447 PluginSelector::display_selection_changed()
449 if (plugin_display.get_selection()->count_selected_rows() != 0) {
450 btn_add->set_sensitive (true);
452 btn_add->set_sensitive (false);
457 PluginSelector::added_list_selection_changed()
459 if (added_list.get_selection()->count_selected_rows() != 0) {
460 btn_remove->set_sensitive (true);
462 btn_remove->set_sensitive (false);
467 PluginSelector::run ()
470 TreeModel::Children::iterator i;
476 SelectedPlugins plugins;
477 r = (ResponseType) Dialog::run ();
481 for (i = amodel->children().begin(); i != amodel->children().end(); ++i) {
482 PluginInfoPtr pp = (*i)[acols.plugin];
483 PluginPtr p = load_plugin (pp);
485 plugins.push_back (p);
487 MessageDialog msg (string_compose (_("The plugin \"%1\" could not be loaded\n\nSee the Log window for more details (maybe)"), pp->name));
491 if (interested_object && !plugins.empty()) {
492 finish = !interested_object->use_plugins (plugins);
506 interested_object = 0;
512 PluginSelector::filter_button_clicked ()
514 filter_entry.set_text ("");
518 PluginSelector::filter_entry_changed ()
524 PluginSelector::filter_mode_changed ()
526 std::string mode = filter_mode.get_active_text ();
528 if (mode == _("Favorites only") || mode == _("Hidden only")) {
529 filter_entry.set_sensitive (false);
531 filter_entry.set_sensitive (true);
538 PluginSelector::on_show ()
540 ArdourDialog::on_show ();
541 filter_entry.grab_focus ();
544 struct PluginMenuCompareByCreator {
545 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
548 cmp = cmp_nocase_utf8 (a->creator, b->creator);
552 } else if (cmp == 0) {
553 /* same creator ... compare names */
554 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
562 struct PluginMenuCompareByName {
563 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
566 cmp = cmp_nocase_utf8 (a->name, b->name);
570 } else if (cmp == 0) {
571 /* same name ... compare type */
572 if (a->type < b->type) {
580 struct PluginMenuCompareByCategory {
581 bool operator() (PluginInfoPtr a, PluginInfoPtr b) const {
584 cmp = cmp_nocase_utf8 (a->category, b->category);
588 } else if (cmp == 0) {
589 /* same category ... compare names */
590 if (cmp_nocase_utf8 (a->name, b->name) < 0) {
598 /** @return Plugin menu. The caller should not delete it */
600 PluginSelector::plugin_menu()
606 PluginSelector::build_plugin_menu ()
608 PluginInfoList all_plugs;
610 all_plugs.insert (all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
611 #ifdef WINDOWS_VST_SUPPORT
612 all_plugs.insert (all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
615 all_plugs.insert (all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
617 #ifdef AUDIOUNIT_SUPPORT
618 all_plugs.insert (all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
621 all_plugs.insert (all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
624 using namespace Menu_Helpers;
628 _plugin_menu = manage (new Menu);
629 _plugin_menu->set_name("ArdourContextMenu");
631 MenuList& items = _plugin_menu->items();
634 Gtk::Menu* favs = create_favs_menu(all_plugs);
635 items.push_back (MenuElem (_("Favorites"), *manage (favs)));
637 items.push_back (MenuElem (_("Plugin Manager..."), sigc::mem_fun (*this, &PluginSelector::show_manager)));
638 items.push_back (SeparatorElem ());
640 Menu* by_creator = create_by_creator_menu(all_plugs);
641 items.push_back (MenuElem (_("By Creator"), *manage (by_creator)));
643 Menu* by_category = create_by_category_menu(all_plugs);
644 items.push_back (MenuElem (_("By Category"), *manage (by_category)));
648 PluginSelector::create_favs_menu (PluginInfoList& all_plugs)
650 using namespace Menu_Helpers;
652 Menu* favs = new Menu();
653 favs->set_name("ArdourContextMenu");
655 PluginMenuCompareByName cmp_by_name;
656 all_plugs.sort (cmp_by_name);
658 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
659 if (manager.get_status (*i) == PluginManager::Favorite) {
660 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
661 elem.get_child()->set_use_underline (false);
662 favs->items().push_back (elem);
669 PluginSelector::create_by_creator_menu (ARDOUR::PluginInfoList& all_plugs)
671 using namespace Menu_Helpers;
673 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
674 SubmenuMap creator_submenu_map;
676 Menu* by_creator = new Menu();
677 by_creator->set_name("ArdourContextMenu");
679 MenuList& by_creator_items = by_creator->items();
680 PluginMenuCompareByCreator cmp_by_creator;
681 all_plugs.sort (cmp_by_creator);
683 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
685 if (manager.get_status (*i) == PluginManager::Hidden) continue;
687 string creator = (*i)->creator;
689 /* stupid LADSPA creator strings */
690 string::size_type pos = 0;
691 #ifdef PLATFORM_WINDOWS
692 while (pos < creator.length() && creator[pos]>(-2) && creator[pos]<256 && (isprint (creator[pos]))) ++pos;
694 while (pos < creator.length() && (isalnum (creator[pos]) || isspace (creator[pos]))) ++pos;
697 // Check to see if we found any invalid characters.
698 if (creator.length() != pos) {
699 // If there were too few characters to create a
700 // meaningful name, mark this creator as 'Unknown'
702 creator = "Unknown?";
704 creator = creator.substr (0, pos);
707 SubmenuMap::iterator x;
709 if ((x = creator_submenu_map.find (creator)) != creator_submenu_map.end()) {
712 submenu = new Gtk::Menu;
713 by_creator_items.push_back (MenuElem (creator, *manage (submenu)));
714 creator_submenu_map.insert (pair<std::string,Menu*> (creator, submenu));
715 submenu->set_name("ArdourContextMenu");
717 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
718 elem.get_child()->set_use_underline (false);
719 submenu->items().push_back (elem);
725 PluginSelector::create_by_category_menu (ARDOUR::PluginInfoList& all_plugs)
727 using namespace Menu_Helpers;
729 typedef std::map<std::string,Gtk::Menu*> SubmenuMap;
730 SubmenuMap category_submenu_map;
732 Menu* by_category = new Menu();
733 by_category->set_name("ArdourContextMenu");
735 MenuList& by_category_items = by_category->items();
736 PluginMenuCompareByCategory cmp_by_category;
737 all_plugs.sort (cmp_by_category);
739 for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
741 if (manager.get_status (*i) == PluginManager::Hidden) continue;
743 string category = (*i)->category;
745 SubmenuMap::iterator x;
747 if ((x = category_submenu_map.find (category)) != category_submenu_map.end()) {
750 submenu = new Gtk::Menu;
751 by_category_items.push_back (MenuElem (category, *manage (submenu)));
752 category_submenu_map.insert (pair<std::string,Menu*> (category, submenu));
753 submenu->set_name("ArdourContextMenu");
755 MenuElem elem ((*i)->name, (sigc::bind (sigc::mem_fun (*this, &PluginSelector::plugin_chosen_from_menu), *i)));
756 elem.get_child()->set_use_underline (false);
757 submenu->items().push_back (elem);
763 PluginSelector::plugin_chosen_from_menu (const PluginInfoPtr& pi)
765 PluginPtr p = load_plugin (pi);
767 if (p && interested_object) {
768 SelectedPlugins plugins;
769 plugins.push_back (p);
770 interested_object->use_plugins (plugins);
773 interested_object = 0;
777 PluginSelector::favorite_changed (const std::string& path)
785 in_row_change = true;
787 TreeModel::iterator iter = plugin_model->get_iter (path);
791 bool favorite = !(*iter)[plugin_columns.favorite];
795 (*iter)[plugin_columns.favorite] = favorite;
796 (*iter)[plugin_columns.hidden] = false;
797 PluginManager::PluginStatusType status = (favorite ? PluginManager::Favorite : PluginManager::Normal);
799 /* save new statuses list */
801 pi = (*iter)[plugin_columns.plugin];
803 manager.set_status (pi->type, pi->unique_id, status);
805 manager.save_statuses ();
807 build_plugin_menu ();
809 in_row_change = false;
813 PluginSelector::hidden_changed (const std::string& path)
821 in_row_change = true;
823 TreeModel::iterator iter = plugin_model->get_iter (path);
827 bool hidden = !(*iter)[plugin_columns.hidden];
831 (*iter)[plugin_columns.favorite] = false;
832 (*iter)[plugin_columns.hidden] = hidden;
833 PluginManager::PluginStatusType status = (hidden ? PluginManager::Hidden : PluginManager::Normal);
835 /* save new statuses list */
837 pi = (*iter)[plugin_columns.plugin];
839 manager.set_status (pi->type, pi->unique_id, status);
841 manager.save_statuses ();
843 build_plugin_menu ();
845 in_row_change = false;
849 PluginSelector::show_manager ()
856 PluginSelector::set_interested_object (PluginInterestedObject& obj)
858 interested_object = &obj;