Difference between revisions of "Vamp Plug-ins"

From Audacity Wiki
Jump to: navigation, search
(add listing of plug-in directories, and note of SDK version for next audacity release.)
(add intro and tidy a bit)
Line 1: Line 1:
Ability to use Vamp plug-ins is a new feature in Audacity 1.3.4. As of Audacity 1.3.7 audacity supports Vamp 2.0 plug-ins.
+
{{introrel|Ability to use [http://www.vamp-plugins.org/ Vamp] plug-ins is a new feature in Audacity 1.3.4. As from Audacity 1.3.7, Audacity supports Vamp 2.0 plug-ins.||[[Creating your own Plug-in]]}}
  
{{external|[http://www.vamp-plugins.org/ Vamp]}} is a plug-in format developed by Chris Cannam (author of {{external|[http://www.rosegardenmusic.com/ Rosegarden]}} and {{external|[http://www.sonicvisualiser.org/ Sonic Visualiser]}}) and is an application for viewing and analysing the descriptive contents of music audio files. Typical things that a Vamp plug-in might calculate include the locations of moments such as note onset times, visual representations of the audio such as histograms, or curve data such as power or fundamental frequency.
+
Vamp is a plug-in format developed by Chris Cannam (author of [http://www.rosegardenmusic.com/ Rosegarden] and [http://www.sonicvisualiser.org/ Sonic Visualiser]) for viewing and analysing the descriptive contents of music audio files. Typical things that a Vamp plug-in might calculate include the locations of moments such as note onset times, visual representations of the audio such as histograms, or curve data such as power or fundamental frequency.
  
 
Vamp can process selected audio and produce a label track with particular parts annotated with labels, based on various criteria.
 
Vamp can process selected audio and produce a label track with particular parts annotated with labels, based on various criteria.
Line 8: Line 8:
  
 
== Plug-in directories ==
 
== Plug-in directories ==
Currently Audacity only loads plug-ins from the standard directories defined by the Vamp SDK, not any of the audacity-specific directories. These are:
+
Currently Audacity only loads plug-ins from the standard directories defined by the Vamp SDK, not any of the Audacity-specific directories. These are:
 
* Any directories listed in the VAMP_PATH environment variable (all platforms)
 
* Any directories listed in the VAMP_PATH environment variable (all platforms)
* On Windows, '''%%PROGRAMFILES%%\Vamp Plugins''' (i.e. a directory named "Vamp Plugins" within the system program files directory, however localised and on whatever drive is relevant to this install of windows)
+
* On Windows, '''%%PROGRAMFILES%%\Vamp Plugins''' (i.e. a directory named "Vamp Plugins" within the system Program Files directory, however localised and on whatever drive is relevant to this install of Windows)
* On Mac OSX, '''$HOME/Library/Audio/Plug-Ins/Vamp''' (user plug-ins) and '''/Library/Audio/Plug-Ins/Vamp''' (system-wide plug-ins)
+
* On Mac OS X, '''$HOME/Library/Audio/Plug-Ins/Vamp''' (user plug-ins) and '''/Library/Audio/Plug-Ins/Vamp''' (system-wide plug-ins)
 
* On anything else but mainly Linux, '''$HOME/vamp''', '''$HOME/.vamp''' (user plug-ins) and '''/usr/local/lib/vamp''', '''/usr/lib/vamp''' (system-wide plug-ins).
 
* On anything else but mainly Linux, '''$HOME/vamp''', '''$HOME/.vamp''' (user plug-ins) and '''/usr/local/lib/vamp''', '''/usr/lib/vamp''' (system-wide plug-ins).
  
 
[[Category:Plug-ins]]
 
[[Category:Plug-ins]]

Revision as of 19:02, 2 January 2009

Ability to use Vamp plug-ins is a new feature in Audacity 1.3.4. As from Audacity 1.3.7, Audacity supports Vamp 2.0 plug-ins.
 
Related article(s):

Vamp is a plug-in format developed by Chris Cannam (author of Rosegarden and Sonic Visualiser) for viewing and analysing the descriptive contents of music audio files. Typical things that a Vamp plug-in might calculate include the locations of moments such as note onset times, visual representations of the audio such as histograms, or curve data such as power or fundamental frequency.

Vamp can process selected audio and produce a label track with particular parts annotated with labels, based on various criteria.

Current plug-ins include: to be added

Plug-in directories

Currently Audacity only loads plug-ins from the standard directories defined by the Vamp SDK, not any of the Audacity-specific directories. These are:

  • Any directories listed in the VAMP_PATH environment variable (all platforms)
  • On Windows, %%PROGRAMFILES%%\Vamp Plugins (i.e. a directory named "Vamp Plugins" within the system Program Files directory, however localised and on whatever drive is relevant to this install of Windows)
  • On Mac OS X, $HOME/Library/Audio/Plug-Ins/Vamp (user plug-ins) and /Library/Audio/Plug-Ins/Vamp (system-wide plug-ins)
  • On anything else but mainly Linux, $HOME/vamp, $HOME/.vamp (user plug-ins) and /usr/local/lib/vamp, /usr/lib/vamp (system-wide plug-ins).