2 Copyright (C) 2000-2002 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.
21 #include "libardour-config.h"
28 #include <cstdio> // so libraptor doesn't complain
41 #include "pbd/compose.h"
42 #include "pbd/error.h"
43 #include "pbd/xml++.h"
45 #include "ardour/buffer_set.h"
46 #include "ardour/chan_count.h"
47 #include "ardour/chan_mapping.h"
48 #include "ardour/data_type.h"
49 #include "ardour/luaproc.h"
50 #include "ardour/midi_buffer.h"
51 #include "ardour/midi_state_tracker.h"
52 #include "ardour/plugin.h"
53 #include "ardour/plugin_manager.h"
54 #include "ardour/port.h"
55 #include "ardour/session.h"
56 #include "ardour/types.h"
58 #ifdef AUDIOUNIT_SUPPORT
59 #include "ardour/audio_unit.h"
63 #include "ardour/lv2_plugin.h"
66 #include "pbd/stl_delete.h"
72 using namespace ARDOUR;
75 namespace ARDOUR { class AudioEngine; }
77 #ifdef NO_PLUGIN_STATE
78 static bool seen_get_state_message = false;
79 static bool seen_set_state_message = false;
82 PBD::Signal2<void, std::string, Plugin*> Plugin::PresetsChanged;
85 PluginInfo::is_instrument () const
87 return (n_inputs.n_midi() != 0) && (n_outputs.n_audio() > 0);
90 Plugin::Plugin (AudioEngine& e, Session& s)
94 , _have_presets (false)
95 , _have_pending_stop_events (false)
96 , _parameter_changed_since_last_preset (false)
98 _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
99 PresetsChanged.connect_same_thread (_preset_connection, boost::bind (&Plugin::update_presets, this, _1 ,_2));
102 Plugin::Plugin (const Plugin& other)
103 : StatefulDestructible()
105 , _engine (other._engine)
106 , _session (other._session)
107 , _info (other._info)
109 , _have_presets (false)
110 , _have_pending_stop_events (false)
111 , _parameter_changed_since_last_preset (false)
113 _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
114 PresetsChanged.connect_same_thread (_preset_connection, boost::bind (&Plugin::update_presets, this, _1 ,_2));
122 Plugin::remove_preset (string name)
124 Plugin::PresetRecord const * p = preset_by_label (name);
126 PBD::error << _("Cannot remove plugin factory preset.") << endmsg;
130 do_remove_preset (name);
131 _presets.erase (preset_by_label (name)->uri);
133 _last_preset.uri = "";
134 _parameter_changed_since_last_preset = false;
135 PresetRemoved (); /* EMIT SIGNAL */
136 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
139 /** @return PresetRecord with empty URI on failure */
141 Plugin::save_preset (string name)
143 if (preset_by_label (name)) {
144 PBD::error << _("Preset with given name already exists.") << endmsg;
145 return Plugin::PresetRecord ();
148 string const uri = do_save_preset (name);
151 _presets.insert (make_pair (uri, PresetRecord (uri, name)));
152 PresetAdded (); /* EMIT SIGNAL */
153 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
156 return PresetRecord (uri, name);
160 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
162 PluginManager& mgr (PluginManager::instance());
163 PluginInfoList plugs;
168 PluginPtr plugin (new LuaProc (session.engine(), session, ""));
174 plugs = mgr.ladspa_plugin_info();
179 plugs = mgr.lv2_plugin_info();
183 #ifdef WINDOWS_VST_SUPPORT
184 case ARDOUR::Windows_VST:
185 plugs = mgr.windows_vst_plugin_info();
191 plugs = mgr.lxvst_plugin_info();
195 #ifdef AUDIOUNIT_SUPPORT
196 case ARDOUR::AudioUnit:
197 plugs = mgr.au_plugin_info();
202 return PluginPtr ((Plugin *) 0);
205 PluginInfoList::iterator i;
207 for (i = plugs.begin(); i != plugs.end(); ++i) {
208 if (identifier == (*i)->unique_id){
209 return (*i)->load (session);
213 #ifdef WINDOWS_VST_SUPPORT
214 /* hmm, we didn't find it. could be because in older versions of Ardour.
215 we used to store the name of a VST plugin, not its unique ID. so try
219 for (i = plugs.begin(); i != plugs.end(); ++i) {
220 if (identifier == (*i)->name){
221 return (*i)->load (session);
227 /* hmm, we didn't find it. could be because in older versions of Ardour.
228 we used to store the name of a VST plugin, not its unique ID. so try
232 for (i = plugs.begin(); i != plugs.end(); ++i) {
233 if (identifier == (*i)->name){
234 return (*i)->load (session);
239 return PluginPtr ((Plugin*) 0);
243 Plugin::output_streams () const
245 /* LADSPA & VST should not get here because they do not
246 return "infinite" i/o counts.
248 return ChanCount::ZERO;
252 Plugin::input_streams () const
254 /* LADSPA & VST should not get here because they do not
255 return "infinite" i/o counts.
257 return ChanCount::ZERO;
260 Plugin::IOPortDescription
261 Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
263 std::stringstream ss;
265 case DataType::AUDIO:
266 ss << _("Audio") << " ";
269 ss << _("Midi") << " ";
276 ss << _("In") << " ";
278 ss << _("Out") << " ";
283 Plugin::IOPortDescription iod (ss.str());
287 PluginOutputConfiguration
288 Plugin::possible_output () const
290 PluginOutputConfiguration oc;
292 oc.insert (_info->n_outputs.n_audio ());
297 const Plugin::PresetRecord *
298 Plugin::preset_by_label (const string& label)
300 #ifndef NO_PLUGIN_STATE
301 if (!_have_presets) {
303 _have_presets = true;
307 for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
308 if (i->second.label == label) {
316 const Plugin::PresetRecord *
317 Plugin::preset_by_uri (const string& uri)
319 #ifndef NO_PLUGIN_STATE
320 if (!_have_presets) {
322 _have_presets = true;
325 map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
326 if (pr != _presets.end()) {
334 Plugin::connect_and_run (BufferSet& bufs,
335 ChanMapping /*in_map*/, ChanMapping /*out_map*/,
336 pframes_t /* nframes */, framecnt_t /*offset*/)
338 if (bufs.count().n_midi() > 0) {
340 /* Track notes that we are sending to the plugin */
342 const MidiBuffer& b = bufs.get_midi (0);
344 _tracker.track (b.begin(), b.end());
346 if (_have_pending_stop_events) {
347 /* Transmit note-offs that are pending from the last transport stop */
348 bufs.merge_from (_pending_stop_events, 0);
349 _have_pending_stop_events = false;
357 Plugin::realtime_handle_transport_stopped ()
363 Plugin::realtime_locate ()
369 Plugin::monitoring_changed ()
375 Plugin::resolve_midi ()
377 /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
378 up on the next call to connect_and_run ().
381 _pending_stop_events.get_midi(0).clear ();
382 _tracker.resolve_notes (_pending_stop_events.get_midi (0), /* split cycle offset*/ Port::port_offset());
383 _have_pending_stop_events = true;
387 Plugin::update_presets (std::string src_unique_id, Plugin* src )
389 if (src == this || unique_id() != src_unique_id) {
392 _have_presets = false;
393 // TODO check if a preset was added/removed and emit the proper signal
394 // so far no subscriber distinguishes between PresetAdded and PresetRemoved
398 vector<Plugin::PresetRecord>
399 Plugin::get_presets ()
401 vector<PresetRecord> p;
403 #ifndef NO_PLUGIN_STATE
404 if (!_have_presets) {
406 _have_presets = true;
409 for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
410 p.push_back (i->second);
413 if (!seen_set_state_message) {
414 info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
417 seen_set_state_message = true;
424 /** Set parameters using a preset */
426 Plugin::load_preset (PresetRecord r)
429 _parameter_changed_since_last_preset = false;
431 PresetLoaded (); /* EMIT SIGNAL */
436 Plugin::clear_preset ()
438 _last_preset.uri = "";
439 _last_preset.label = "";
440 _parameter_changed_since_last_preset = false;
442 PresetLoaded (); /* EMIT SIGNAL */
446 Plugin::set_parameter (uint32_t /* which */, float /* value */)
448 _parameter_changed_since_last_preset = true;
449 _session.set_dirty ();
450 PresetDirty (); /* EMIT SIGNAL */
454 Plugin::parameter_changed_externally (uint32_t which, float /* value */)
456 _parameter_changed_since_last_preset = true;
457 _session.set_dirty ();
458 ParameterChangedExternally (which, get_parameter (which)); /* EMIT SIGNAL */
459 PresetDirty (); /* EMIT SIGNAL */
463 Plugin::set_state (const XMLNode& node, int /*version*/)
465 XMLProperty const * p = node.property (X_("last-preset-uri"));
467 _last_preset.uri = p->value ();
470 p = node.property (X_("last-preset-label"));
472 _last_preset.label = p->value ();
475 p = node.property (X_("parameter-changed-since-last-preset"));
477 _parameter_changed_since_last_preset = string_is_affirmative (p->value ());
486 XMLNode* root = new XMLNode (state_node_name ());
487 LocaleGuard lg (X_("C"));
489 root->add_property (X_("last-preset-uri"), _last_preset.uri);
490 root->add_property (X_("last-preset-label"), _last_preset.label);
491 root->add_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset ? X_("yes") : X_("no"));
493 #ifndef NO_PLUGIN_STATE
496 if (!seen_get_state_message) {
497 info << string_compose (_("Saving plugin settings is not supported in this build of %1. Consider paying for the full version"),
500 seen_get_state_message = true;
508 Plugin::set_info (PluginInfoPtr info)