2 Copyright (C) 2004 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 <cstdio> // so libraptor doesn't complain
29 #include <cstring> // for memmove
33 #include <glibmm/miscutils.h>
38 #include "pbd/compose.h"
39 #include "pbd/error.h"
40 #include "pbd/pathscanner.h"
41 #include "pbd/xml++.h"
45 #include "ardour/session.h"
46 #include "ardour/audioengine.h"
47 #include "ardour/filesystem_paths.h"
48 #include "ardour/vst_plugin.h"
49 #include "ardour/buffer_set.h"
50 #include "ardour/audio_buffer.h"
51 #include "ardour/midi_buffer.h"
53 #include "pbd/stl_delete.h"
59 using namespace ARDOUR
;
64 VSTPlugin::VSTPlugin (AudioEngine
& e
, Session
& session
, FSTHandle
* h
)
69 if ((_fst
= fst_instantiate (handle
, Session::vst_callback
, this)) == 0) {
70 throw failed_constructor();
73 _plugin
= _fst
->plugin
;
76 /* set rate and blocksize */
78 _plugin
->dispatcher (_plugin
, effSetSampleRate
, 0, 0, NULL
,
79 (float) session
.frame_rate());
80 _plugin
->dispatcher (_plugin
, effSetBlockSize
, 0,
81 session
.get_block_size(), NULL
, 0.0f
);
83 /* set program to zero */
85 _plugin
->dispatcher (_plugin
, effSetProgram
, 0, 0, NULL
, 0.0f
);
87 // Plugin::setup_controls ();
90 VSTPlugin::VSTPlugin (const VSTPlugin
&other
)
93 handle
= other
.handle
;
95 if ((_fst
= fst_instantiate (handle
, Session::vst_callback
, this)) == 0) {
96 throw failed_constructor();
98 _plugin
= _fst
->plugin
;
100 // Plugin::setup_controls ();
103 VSTPlugin::~VSTPlugin ()
110 VSTPlugin::set_block_size (pframes_t nframes
)
113 _plugin
->dispatcher (_plugin
, effSetBlockSize
, 0, nframes
, NULL
, 0.0f
);
119 VSTPlugin::default_value (uint32_t port
)
125 VSTPlugin::set_parameter (uint32_t which
, float val
)
127 _plugin
->setParameter (_plugin
, which
, val
);
129 if (_fst
->want_program
== -1 && _fst
->want_chunk
== 0) {
130 /* Heinous hack: Plugin::set_parameter below updates the `modified' status of the
131 current preset, but if _fst->want_program is not -1 then there is a preset
132 setup pending or in progress, which we don't want any `modified' updates
133 to happen for. So we only do this if _fst->want_program is -1.
135 Plugin::set_parameter (which
, val
);
140 VSTPlugin::get_parameter (uint32_t which
) const
142 return _plugin
->getParameter (_plugin
, which
);
147 VSTPlugin::nth_parameter (uint32_t n
, bool& ok
) const
153 /** Get VST chunk as base64-encoded data.
154 * @param single true for single program, false for all programs.
155 * @return 0-terminated base64-encoded data; must be passed to g_free () by caller.
158 VSTPlugin::get_chunk (bool single
) const
161 int32_t data_size
= _plugin
->dispatcher (_plugin
, 23 /* effGetChunk */, single
? 1 : 0, 0, &data
, 0);
162 if (data_size
== 0) {
166 return g_base64_encode (data
, data_size
);
169 /** Set VST chunk from base64-encoded data.
170 * @param 0-terminated base64-encoded data.
171 * @param single true for single program, false for all programs.
172 * @return 0 on success, non-0 on failure
175 VSTPlugin::set_chunk (gchar
const * data
, bool single
)
178 guchar
* raw_data
= g_base64_decode (data
, &size
);
179 int const r
= _plugin
->dispatcher (_plugin
, 24 /* effSetChunk */, single
? 1 : 0, size
, raw_data
, 0);
185 VSTPlugin::add_state (XMLNode
* root
) const
187 LocaleGuard
lg (X_("POSIX"));
189 if (_fst
->current_program
!= -1) {
191 snprintf (buf
, sizeof (buf
), "%d", _fst
->current_program
);
192 root
->add_property ("current-program", buf
);
195 if (_plugin
->flags
& 32 /* effFlagsProgramsChunks */) {
197 gchar
* data
= get_chunk (false);
202 /* store information */
204 XMLNode
* chunk_node
= new XMLNode (X_("chunk"));
206 chunk_node
->add_content (data
);
209 root
->add_child_nocopy (*chunk_node
);
213 XMLNode
* parameters
= new XMLNode ("parameters");
215 for (int32_t n
= 0; n
< _plugin
->numParams
; ++n
) {
218 snprintf (index
, sizeof (index
), "param_%d", n
);
219 snprintf (val
, sizeof (val
), "%.12g", _plugin
->getParameter (_plugin
, n
));
220 parameters
->add_property (index
, val
);
223 root
->add_child_nocopy (*parameters
);
228 VSTPlugin::set_state (const XMLNode
& node
, int version
)
230 LocaleGuard
lg (X_("POSIX"));
232 if (node
.name() != state_node_name()) {
233 error
<< _("Bad node sent to VSTPlugin::set_state") << endmsg
;
237 const XMLProperty
* prop
;
239 if ((prop
= node
.property ("current-program")) != 0) {
240 _fst
->want_program
= atoi (prop
->value().c_str());
246 if ((child
= find_named_node (node
, X_("chunk"))) != 0) {
248 XMLPropertyList::const_iterator i
;
249 XMLNodeList::const_iterator n
;
252 for (n
= child
->children ().begin (); n
!= child
->children ().end (); ++n
) {
253 if ((*n
)->is_content ()) {
254 /* XXX: this may be dubious for the same reasons that we delay
255 execution of load_preset.
257 ret
= set_chunk ((*n
)->content().c_str(), false);
261 } else if ((child
= find_named_node (node
, X_("parameters"))) != 0) {
263 XMLPropertyList::const_iterator i
;
265 for (i
= child
->properties().begin(); i
!= child
->properties().end(); ++i
) {
269 sscanf ((*i
)->name().c_str(), "param_%d", ¶m
);
270 sscanf ((*i
)->value().c_str(), "%f", &val
);
272 _plugin
->setParameter (_plugin
, param
, val
);
275 /* program number is not knowable */
277 _fst
->current_program
= -1;
283 Plugin::set_state (node
, version
);
288 VSTPlugin::get_parameter_descriptor (uint32_t which
, ParameterDescriptor
& desc
) const
290 VstParameterProperties prop
;
292 desc
.min_unbound
= false;
293 desc
.max_unbound
= false;
296 if (_plugin
->dispatcher (_plugin
, effGetParameterProperties
, which
, 0, &prop
, 0)) {
298 #ifdef VESTIGE_COMPLETE
300 /* i have yet to find or hear of a VST plugin that uses this */
302 if (prop
.flags
& kVstParameterUsesIntegerMinMax
) {
303 desc
.lower
= prop
.minInteger
;
304 desc
.upper
= prop
.maxInteger
;
310 if (prop
.flags
& kVstParameterUsesIntStep
) {
312 desc
.step
= prop
.stepInteger
;
313 desc
.smallstep
= prop
.stepInteger
;
314 desc
.largestep
= prop
.stepInteger
;
316 } else if (prop
.flags
& kVstParameterUsesFloatStep
) {
318 desc
.step
= prop
.stepFloat
;
319 desc
.smallstep
= prop
.smallStepFloat
;
320 desc
.largestep
= prop
.largeStepFloat
;
324 float range
= desc
.upper
- desc
.lower
;
326 desc
.step
= range
/ 100.0f
;
327 desc
.smallstep
= desc
.step
/ 2.0f
;
328 desc
.largestep
= desc
.step
* 10.0f
;
331 desc
.toggled
= prop
.flags
& kVstParameterIsSwitch
;
332 desc
.logarithmic
= false;
333 desc
.sr_dependent
= false;
334 desc
.label
= prop
.label
;
344 _plugin
->dispatcher (_plugin
, effGetParamName
, which
, 0, label
, 0);
347 desc
.integer_step
= false;
351 desc
.smallstep
= 0.005f
;
352 desc
.largestep
= 0.1f
;
353 desc
.toggled
= false;
354 desc
.logarithmic
= false;
355 desc
.sr_dependent
= false;
362 VSTPlugin::load_preset (PresetRecord r
)
367 s
= load_user_preset (r
);
369 s
= load_plugin_preset (r
);
373 Plugin::load_preset (r
);
380 VSTPlugin::load_plugin_preset (PresetRecord r
)
382 /* This is a plugin-provided preset.
383 We can't dispatch directly here; too many plugins expects only one GUI thread.
386 /* Extract the index of this preset from the URI */
389 int const p
= sscanf (r
.uri
.c_str(), "VST:%d:%d", &id
, &index
);
392 _fst
->want_program
= index
;
397 VSTPlugin::load_user_preset (PresetRecord r
)
399 /* This is a user preset; we load it, and this code also knows about the
400 non-direct-dispatch thing.
403 boost::shared_ptr
<XMLTree
> t (presets_tree ());
408 XMLNode
* root
= t
->root ();
410 for (XMLNodeList::const_iterator i
= root
->children().begin(); i
!= root
->children().end(); ++i
) {
412 XMLProperty
* uri
= (*i
)->property (X_("uri"));
413 XMLProperty
* label
= (*i
)->property (X_("label"));
418 if (label
->value() != r
.label
) {
422 if (_plugin
->flags
& 32 /* effFlagsProgramsChunks */) {
424 /* Load a user preset chunk from our XML file and send it via a circuitous route to the plugin */
426 if (_fst
->wanted_chunk
) {
427 g_free (_fst
->wanted_chunk
);
430 for (XMLNodeList::const_iterator j
= (*i
)->children().begin(); j
!= (*i
)->children().end(); ++j
) {
431 if ((*j
)->is_content ()) {
432 /* we can't dispatch directly here; too many plugins expect only one GUI thread */
434 guchar
* raw_data
= g_base64_decode ((*j
)->content().c_str(), &size
);
435 _fst
->wanted_chunk
= raw_data
;
436 _fst
->wanted_chunk_size
= size
;
437 _fst
->want_chunk
= 1;
446 for (XMLNodeList::const_iterator j
= (*i
)->children().begin(); j
!= (*i
)->children().end(); ++j
) {
447 if ((*j
)->name() == X_("Parameter")) {
449 XMLProperty
* index
= (*j
)->property (X_("index"));
450 XMLProperty
* value
= (*j
)->property (X_("value"));
455 set_parameter (atoi (index
->value().c_str()), atof (value
->value().c_str ()));
467 VSTPlugin::do_save_preset (string name
)
469 boost::shared_ptr
<XMLTree
> t (presets_tree ());
475 /* XXX: use of _presets.size() + 1 for the unique ID here is dubious at best */
476 string
const uri
= string_compose (X_("VST:%1:%2"), unique_id (), _presets
.size() + 1);
478 if (_plugin
->flags
& 32 /* effFlagsProgramsChunks */) {
480 p
= new XMLNode (X_("ChunkPreset"));
481 p
->add_property (X_("uri"), uri
);
482 p
->add_property (X_("label"), name
);
483 gchar
* data
= get_chunk (true);
484 p
->add_content (string (data
));
489 p
= new XMLNode (X_("Preset"));
490 p
->add_property (X_("uri"), uri
);
491 p
->add_property (X_("label"), name
);
493 for (uint32_t i
= 0; i
< parameter_count(); ++i
) {
494 if (parameter_is_input (i
)) {
495 XMLNode
* c
= new XMLNode (X_("Parameter"));
496 c
->add_property (X_("index"), string_compose ("%1", i
));
497 c
->add_property (X_("value"), string_compose ("%1", get_parameter (i
)));
498 p
->add_child_nocopy (*c
);
504 t
->root()->add_child_nocopy (*p
);
506 sys::path f
= ARDOUR::user_config_directory ();
508 f
/= presets_file ();
510 t
->write (f
.to_string ());
515 VSTPlugin::do_remove_preset (string name
)
517 boost::shared_ptr
<XMLTree
> t (presets_tree ());
522 t
->root()->remove_nodes_and_delete (X_("label"), name
);
524 sys::path f
= ARDOUR::user_config_directory ();
526 f
/= presets_file ();
528 t
->write (f
.to_string ());
532 VSTPlugin::describe_parameter (Evoral::Parameter param
)
535 _plugin
->dispatcher (_plugin
, effGetParamName
, param
.id(), 0, name
, 0);
540 VSTPlugin::signal_latency () const
543 return _user_latency
;
546 #ifdef VESTIGE_HEADER
547 return *((framecnt_t
*) (((char *) &_plugin
->flags
) + 12)); /* initialDelay */
549 return _plugin
->initial_delay
;
553 set
<Evoral::Parameter
>
554 VSTPlugin::automatable () const
556 set
<Evoral::Parameter
> ret
;
558 for (uint32_t i
= 0; i
< parameter_count(); ++i
){
559 ret
.insert (ret
.end(), Evoral::Parameter(PluginAutomation
, 0, i
));
566 VSTPlugin::connect_and_run (BufferSet
& bufs
,
567 ChanMapping in_map
, ChanMapping out_map
,
568 pframes_t nframes
, framecnt_t offset
)
570 Plugin::connect_and_run (bufs
, in_map
, out_map
, nframes
, offset
);
572 float *ins
[_plugin
->numInputs
];
573 float *outs
[_plugin
->numOutputs
];
576 const uint32_t nbufs
= bufs
.count().n_audio();
579 for (i
= 0; i
< (int32_t) _plugin
->numInputs
; ++i
) {
580 ins
[i
] = bufs
.get_audio(min((uint32_t) in_index
, nbufs
- 1)).data() + offset
;
585 for (i
= 0; i
< (int32_t) _plugin
->numOutputs
; ++i
) {
586 outs
[i
] = bufs
.get_audio(min((uint32_t) out_index
, nbufs
- 1)).data() + offset
;
588 /* unbelievably, several VST plugins still rely on Cubase
589 behaviour and do not silence the buffer in processReplacing
590 when they have no output.
593 // memset (outs[i], 0, sizeof (Sample) * nframes);
598 if (bufs
.count().n_midi() > 0) {
599 VstEvents
* v
= bufs
.get_vst_midi (0);
600 _plugin
->dispatcher (_plugin
, effProcessEvents
, 0, 0, v
, 0);
603 /* we already know it can support processReplacing */
604 _plugin
->processReplacing (_plugin
, ins
, outs
, nframes
);
610 VSTPlugin::deactivate ()
612 _plugin
->dispatcher (_plugin
, effMainsChanged
, 0, 0, NULL
, 0.0f
);
616 VSTPlugin::activate ()
618 _plugin
->dispatcher (_plugin
, effMainsChanged
, 0, 1, NULL
, 0.0f
);
622 VSTPlugin::unique_id() const
626 #ifdef VESTIGE_HEADER
627 snprintf (buf
, sizeof (buf
), "%d", *((int32_t*) &_plugin
->unused_id
));
629 snprintf (buf
, sizeof (buf
), "%d", _plugin
->uniqueID
);
636 VSTPlugin::name () const
642 VSTPlugin::maker () const
644 return _info
->creator
.c_str();
648 VSTPlugin::label () const
654 VSTPlugin::parameter_count() const
656 return _plugin
->numParams
;
660 VSTPlugin::has_editor () const
662 return _plugin
->flags
& effFlagsHasEditor
;
666 VSTPlugin::print_parameter (uint32_t param
, char *buf
, uint32_t len
) const
670 _plugin
->dispatcher (_plugin
, 7 /* effGetParamDisplay */, param
, 0, buf
, 0);
672 if (buf
[0] == '\0') {
677 while (*first_nonws
&& isspace (*first_nonws
)) {
680 if (*first_nonws
== '\0') {
684 memmove (buf
, first_nonws
, strlen (buf
) - (first_nonws
- buf
) + 1);
688 VSTPluginInfo::load (Session
& session
)
693 if (Config
->get_use_vst()) {
696 handle
= fst_load(path
.c_str());
698 if ( (int)handle
== -1) {
699 error
<< string_compose(_("VST: cannot load module from \"%1\""), path
) << endmsg
;
701 plugin
.reset (new VSTPlugin (session
.engine(), session
, handle
));
704 error
<< _("You asked ardour to not use any VST plugins") << endmsg
;
705 return PluginPtr ((Plugin
*) 0);
708 plugin
->set_info(PluginInfoPtr(new VSTPluginInfo(*this)));
712 catch (failed_constructor
&err
) {
713 return PluginPtr ((Plugin
*) 0);
718 VSTPlugin::find_presets ()
720 /* Built-in presets */
722 int const vst_version
= _plugin
->dispatcher (_plugin
, effGetVstVersion
, 0, 0, NULL
, 0);
723 for (int i
= 0; i
< _plugin
->numPrograms
; ++i
) {
724 PresetRecord
r (string_compose (X_("VST:%1:%2"), unique_id (), i
), "", false);
726 if (vst_version
>= 2) {
728 if (_plugin
->dispatcher (_plugin
, 29, i
, 0, buf
, 0) == 1) {
731 r
.label
= string_compose (_("Preset %1"), i
);
734 r
.label
= string_compose (_("Preset %1"), i
);
737 _presets
.insert (make_pair (r
.uri
, r
));
740 /* User presets from our XML file */
742 boost::shared_ptr
<XMLTree
> t (presets_tree ());
745 XMLNode
* root
= t
->root ();
746 for (XMLNodeList::const_iterator i
= root
->children().begin(); i
!= root
->children().end(); ++i
) {
748 XMLProperty
* uri
= (*i
)->property (X_("uri"));
749 XMLProperty
* label
= (*i
)->property (X_("label"));
754 PresetRecord
r (uri
->value(), label
->value(), true);
755 _presets
.insert (make_pair (r
.uri
, r
));
761 /** @return XMLTree with our user presets; could be a new one if no existing
762 * one was found, or 0 if one was present but badly-formatted.
765 VSTPlugin::presets_tree () const
767 XMLTree
* t
= new XMLTree
;
769 sys::path p
= ARDOUR::user_config_directory ();
772 if (!is_directory (p
)) {
773 create_directory (p
);
776 p
/= presets_file ();
779 t
->set_root (new XMLNode (X_("VSTPresets")));
783 t
->set_filename (p
.to_string ());
792 /** @return Index of the first user preset in our lists */
794 VSTPlugin::first_user_preset_index () const
796 return _plugin
->numPrograms
;
800 VSTPlugin::presets_file () const
802 return string_compose ("vst-%1", unique_id ());
805 VSTPluginInfo::VSTPluginInfo()