Mercurial > hg > vampy-host

comparison vamp/__init__.py @ 132:f798cda1007f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Another minor doc update
author Chris Cannam
date Wed, 24 Jun 2015 16:30:22 +0100
parents b8fe675f9c3f
children 58a2272d0046
comparison
equal deleted inserted replaced
131:774abff99d98 132:f798cda1007f
90 High-level interface (vamp) 90 High-level interface (vamp)
91 --------------------------- 91 ---------------------------
92 92
93 This module contains three sorts of function: 93 This module contains three sorts of function:
94 94
95 1. Basic info and lookup functions: 95 1. Basic info and lookup functions
96 """"""""""""""""""""""""""""""""""
96 97
97 * ``vamp.list_plugins`` 98 * ``vamp.list_plugins``
98 * ``vamp.get_outputs_of`` 99 * ``vamp.get_outputs_of``
99 * ``vamp.get_category_of`` 100 * ``vamp.get_category_of``
100 101
101 These retrieve the installed plugin keys and get basic information 102 These retrieve the installed plugin keys and get basic information
102 about each plugin. (For more detailed information, load a plugin 103 about each plugin. (For more detailed information, load a plugin
103 and inspect it using the low-level interface described below.) 104 and inspect it using the low-level interface described below.)
104 105
105 2. Process functions: 106 2. Process functions
107 """"""""""""""""""""
106 108
107 * ``vamp.process_audio`` 109 * ``vamp.process_audio``
108 * ``vamp.process_frames`` 110 * ``vamp.process_frames``
109 * ``vamp.process_audio_multiple_outputs`` 111 * ``vamp.process_audio_multiple_outputs``
110 * ``vamp.process_frames_multiple_outputs`` 112 * ``vamp.process_frames_multiple_outputs``
118 The ``_audio`` versions take a single (presumably long) array of 120 The ``_audio`` versions take a single (presumably long) array of
119 audio samples as input, and chop it into frames according to the 121 audio samples as input, and chop it into frames according to the
120 plugin's preferred step and block sizes. The ``_frames`` versions 122 plugin's preferred step and block sizes. The ``_frames`` versions
121 instead accept an enumerable sequence of audio frame arrays. 123 instead accept an enumerable sequence of audio frame arrays.
122 124
123 3. The process-and-collect function: 125 3. The process-and-collect function
124 126 """""""""""""""""""""""""""""""""""
127
125 * ``vamp.collect`` 128 * ``vamp.collect``
126 129
127 This accepts a single array of audio samples as input, and returns 130 This accepts a single array of audio samples as input, and returns
128 an output structure that reflects the underlying structure of the 131 an output structure that reflects the underlying structure of the
129 feature output (depending on whether it is a curve, grid, etc). The 132 feature output (depending on whether it is a curve, grid, etc). The