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::needs_midi_input () const
87 return (n_inputs.n_midi() != 0);
91 PluginInfo::is_instrument () const
93 return (n_inputs.n_midi() != 0) && (n_outputs.n_audio() > 0) && (n_inputs.n_audio() == 0);
96 Plugin::Plugin (AudioEngine& e, Session& s)
101 , _have_presets (false)
102 , _have_pending_stop_events (false)
103 , _parameter_changed_since_last_preset (false)
104 , _immediate_events(6096) // FIXME: size?
106 _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
109 Plugin::Plugin (const Plugin& other)
110 : StatefulDestructible()
112 , _engine (other._engine)
113 , _session (other._session)
114 , _info (other._info)
116 , _owner (other._owner)
117 , _have_presets (false)
118 , _have_pending_stop_events (false)
119 , _parameter_changed_since_last_preset (false)
120 , _immediate_events(6096) // FIXME: size?
122 _pending_stop_events.ensure_buffers (DataType::MIDI, 1, 4096);
130 Plugin::remove_preset (string name)
132 Plugin::PresetRecord const * p = preset_by_label (name);
134 PBD::error << _("Trying to remove nonexistent preset.") << endmsg;
138 PBD::error << _("Cannot remove plugin factory preset.") << endmsg;
142 do_remove_preset (name);
143 _presets.erase (p->uri);
145 _last_preset.uri = "";
146 _parameter_changed_since_last_preset = false;
147 _have_presets = false;
148 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
149 PresetRemoved (); /* EMIT SIGNAL */
152 /** @return PresetRecord with empty URI on failure */
154 Plugin::save_preset (string name)
156 if (preset_by_label (name)) {
157 PBD::error << _("Preset with given name already exists.") << endmsg;
158 return Plugin::PresetRecord ();
161 string const uri = do_save_preset (name);
164 _presets.insert (make_pair (uri, PresetRecord (uri, name)));
165 _have_presets = false;
166 PresetsChanged (unique_id(), this); /* EMIT SIGNAL */
167 PresetAdded (); /* EMIT SIGNAL */
170 return PresetRecord (uri, name);
174 ARDOUR::find_plugin(Session& session, string identifier, PluginType type)
176 PluginManager& mgr (PluginManager::instance());
177 PluginInfoList plugs;
181 plugs = mgr.lua_plugin_info();
185 plugs = mgr.ladspa_plugin_info();
190 plugs = mgr.lv2_plugin_info();
194 #ifdef WINDOWS_VST_SUPPORT
195 case ARDOUR::Windows_VST:
196 plugs = mgr.windows_vst_plugin_info();
202 plugs = mgr.lxvst_plugin_info();
206 #ifdef MACVST_SUPPORT
208 plugs = mgr.mac_vst_plugin_info();
212 #ifdef AUDIOUNIT_SUPPORT
213 case ARDOUR::AudioUnit:
214 plugs = mgr.au_plugin_info();
219 return PluginPtr ((Plugin *) 0);
222 PluginInfoList::iterator i;
224 for (i = plugs.begin(); i != plugs.end(); ++i) {
225 if (identifier == (*i)->unique_id){
226 return (*i)->load (session);
230 #ifdef WINDOWS_VST_SUPPORT
231 /* hmm, we didn't find it. could be because in older versions of Ardour.
232 we used to store the name of a VST plugin, not its unique ID. so try
236 for (i = plugs.begin(); i != plugs.end(); ++i) {
237 if (identifier == (*i)->name){
238 return (*i)->load (session);
244 /* hmm, we didn't find it. could be because in older versions of Ardour.
245 we used to store the name of a VST plugin, not its unique ID. so try
249 for (i = plugs.begin(); i != plugs.end(); ++i) {
250 if (identifier == (*i)->name){
251 return (*i)->load (session);
256 return PluginPtr ((Plugin*) 0);
260 Plugin::output_streams () const
262 /* LADSPA & VST should not get here because they do not
263 return "infinite" i/o counts.
265 return ChanCount::ZERO;
269 Plugin::input_streams () const
271 /* LADSPA & VST should not get here because they do not
272 return "infinite" i/o counts.
274 return ChanCount::ZERO;
277 Plugin::IOPortDescription
278 Plugin::describe_io_port (ARDOUR::DataType dt, bool input, uint32_t id) const
280 std::stringstream ss;
282 case DataType::AUDIO:
283 ss << _("Audio") << " ";
286 ss << _("Midi") << " ";
293 ss << _("In") << " ";
295 ss << _("Out") << " ";
300 Plugin::IOPortDescription iod (ss.str());
304 PluginOutputConfiguration
305 Plugin::possible_output () const
307 PluginOutputConfiguration oc;
309 oc.insert (_info->n_outputs.n_audio ());
314 const Plugin::PresetRecord *
315 Plugin::preset_by_label (const string& label)
317 #ifndef NO_PLUGIN_STATE
318 if (!_have_presets) {
320 _have_presets = true;
324 for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
325 if (i->second.label == label) {
333 const Plugin::PresetRecord *
334 Plugin::preset_by_uri (const string& uri)
336 #ifndef NO_PLUGIN_STATE
337 if (!_have_presets) {
339 _have_presets = true;
342 map<string, PresetRecord>::const_iterator pr = _presets.find (uri);
343 if (pr != _presets.end()) {
351 Plugin::write_immediate_event (size_t size, const uint8_t* buf)
353 if (!Evoral::midi_event_is_valid (buf, size)) {
356 return (_immediate_events.write (0, Evoral::MIDI_EVENT, size, buf) == size);
360 Plugin::connect_and_run (BufferSet& bufs,
361 framepos_t /*start*/, framepos_t /*end*/, double /*speed*/,
362 ChanMapping /*in_map*/, ChanMapping /*out_map*/,
363 pframes_t nframes, framecnt_t /*offset*/)
365 if (bufs.count().n_midi() > 0) {
367 if (_immediate_events.read_space() && nframes > 0) {
368 _immediate_events.read (bufs.get_midi (0), 0, 1, nframes - 1, true);
371 /* Track notes that we are sending to the plugin */
372 const MidiBuffer& b = bufs.get_midi (0);
374 _tracker.track (b.begin(), b.end());
376 if (_have_pending_stop_events) {
377 /* Transmit note-offs that are pending from the last transport stop */
378 bufs.merge_from (_pending_stop_events, 0);
379 _have_pending_stop_events = false;
387 Plugin::realtime_handle_transport_stopped ()
393 Plugin::realtime_locate ()
399 Plugin::monitoring_changed ()
405 Plugin::resolve_midi ()
407 /* Create note-offs for any active notes and put them in _pending_stop_events, to be picked
408 up on the next call to connect_and_run ().
411 _pending_stop_events.get_midi(0).clear ();
412 _tracker.resolve_notes (_pending_stop_events.get_midi (0), 0);
413 _have_pending_stop_events = true;
416 vector<Plugin::PresetRecord>
417 Plugin::get_presets ()
419 vector<PresetRecord> p;
421 #ifndef NO_PLUGIN_STATE
422 if (!_have_presets) {
424 _have_presets = true;
427 for (map<string, PresetRecord>::const_iterator i = _presets.begin(); i != _presets.end(); ++i) {
428 p.push_back (i->second);
431 if (!seen_set_state_message) {
432 info << string_compose (_("Plugin presets are not supported in this build of %1. Consider paying for a full version"),
435 seen_set_state_message = true;
442 /** Set parameters using a preset */
444 Plugin::load_preset (PresetRecord r)
447 _parameter_changed_since_last_preset = false;
449 _session.set_dirty ();
450 PresetLoaded (); /* EMIT SIGNAL */
455 Plugin::clear_preset ()
457 _last_preset.uri = "";
458 _last_preset.label = "";
459 _parameter_changed_since_last_preset = false;
461 _session.set_dirty ();
462 PresetLoaded (); /* EMIT SIGNAL */
466 Plugin::set_parameter (uint32_t /* which */, float /* value */)
468 _parameter_changed_since_last_preset = true;
469 PresetDirty (); /* EMIT SIGNAL */
473 Plugin::parameter_changed_externally (uint32_t which, float /* value */)
475 _parameter_changed_since_last_preset = true;
476 _session.set_dirty ();
477 ParameterChangedExternally (which, get_parameter (which)); /* EMIT SIGNAL */
478 PresetDirty (); /* EMIT SIGNAL */
482 Plugin::set_state (const XMLNode& node, int /*version*/)
484 node.get_property (X_("last-preset-uri"), _last_preset.uri);
485 node.get_property (X_("last-preset-label"), _last_preset.label);
486 node.get_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
493 XMLNode* root = new XMLNode (state_node_name ());
495 root->set_property (X_("last-preset-uri"), _last_preset.uri);
496 root->set_property (X_("last-preset-label"), _last_preset.label);
497 root->set_property (X_("parameter-changed-since-last-preset"), _parameter_changed_since_last_preset);
499 #ifndef NO_PLUGIN_STATE
502 if (!seen_get_state_message) {
503 info << string_compose (_("Saving plugin settings is not supported in this build of %1. Consider paying for the full version"),
506 seen_get_state_message = true;
514 Plugin::set_info (PluginInfoPtr info)
520 Plugin::parameter_label (uint32_t which) const
522 if (which >= parameter_count ()) {
525 ParameterDescriptor pd;
526 get_parameter_descriptor (which, pd);