Mercurial > hg > vamp-aubio-plugins

changeset 80:fbf883ad6482

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
vamp-aubio.n3: sync descriptions with plugins/*.cpp
author Paul Brossier <piem@piem.org>
date Wed, 28 Jan 2015 20:58:16 +0100
parents f482dafd340a
children 5d80071c7dce
files vamp-aubio.n3
diffstat 1 files changed, 31 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/vamp-aubio.n3	Wed Jan 28 20:57:44 2015 +0100
+++ b/vamp-aubio.n3	Wed Jan 28 20:58:16 2015 +0100
@@ -51,6 +51,7 @@
 plugbase:aubionotes_param_onsettype a  vamp:QuantizedParameter ;
     vamp:identifier     "onsettype" ;
     dc:title            "Onset Detection Function Type" ;
+    dc:description      """Type of onset detection function to use"""  ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       7 ;
@@ -62,6 +63,7 @@
 plugbase:aubionotes_param_pitchtype a  vamp:QuantizedParameter ;
     vamp:identifier     "pitchtype" ;
     dc:title            "Pitch Detection Function Type" ;
+    dc:description      """Type of pitch detection function to use"""  ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       4 ;
@@ -73,6 +75,7 @@
 plugbase:aubionotes_param_minpitch a  vamp:QuantizedParameter ;
     vamp:identifier     "minpitch" ;
     dc:title            "Minimum Pitch" ;
+    dc:description      """Lowest pitch value to look for"""  ;
     dc:format           "MIDI units" ;
     vamp:min_value       0 ;
     vamp:max_value       127 ;
@@ -84,6 +87,7 @@
 plugbase:aubionotes_param_maxpitch a  vamp:QuantizedParameter ;
     vamp:identifier     "maxpitch" ;
     dc:title            "Maximum Pitch" ;
+    dc:description      """Highest pitch value to look for"""  ;
     dc:format           "MIDI units" ;
     vamp:min_value       0 ;
     vamp:max_value       127 ;
@@ -95,6 +99,7 @@
 plugbase:aubionotes_param_wraprange a  vamp:QuantizedParameter ;
     vamp:identifier     "wraprange" ;
     dc:title            "Fold Higher or Lower Notes into Range" ;
+    dc:description      """Notes detected outside the range will be transposed to higher or lower octaves"""  ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -106,6 +111,7 @@
 plugbase:aubionotes_param_avoidleaps a  vamp:QuantizedParameter ;
     vamp:identifier     "avoidleaps" ;
     dc:title            "Avoid Multi-Octave Jumps" ;
+    dc:description      """Minimize octave jumps by transposing to the octave of the previously detected note"""  ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -117,6 +123,7 @@
 plugbase:aubionotes_param_peakpickthreshold a  vamp:Parameter ;
     vamp:identifier     "peakpickthreshold" ;
     dc:title            "Peak Picker Threshold" ;
+    dc:description      """Peak picking threshold, the higher the least detection"""  ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -127,6 +134,7 @@
 plugbase:aubionotes_param_silencethreshold a  vamp:Parameter ;
     vamp:identifier     "silencethreshold" ;
     dc:title            "Silence Threshold" ;
+    dc:description      """Silence threshold, the higher the least detection"""  ;
     dc:format           "dB" ;
     vamp:min_value       -120 ;
     vamp:max_value       0 ;
@@ -137,6 +145,7 @@
 plugbase:aubionotes_param_minioi a  vamp:QuantizedParameter ;
     vamp:identifier     "minioi" ;
     dc:title            "Minimum Inter-Onset Interval" ;
+    dc:description      """Time interval below which two consecutive onsets should be merged"""  ;
     dc:format           "ms" ;
     vamp:min_value       0 ;
     vamp:max_value       40 ;
@@ -148,7 +157,7 @@
 plugbase:aubionotes_output_notes a  vamp:SparseOutput ;
     vamp:identifier       "notes" ;
     dc:title              "Notes" ;
-    dc:description        """"""  ;
+    dc:description        """List of notes detected, with their frequency and velocity"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "Hz" ;
     vamp:bin_count        2 ;
@@ -182,6 +191,7 @@
 plugbase:aubioonset_param_onsettype a  vamp:QuantizedParameter ;
     vamp:identifier     "onsettype" ;
     dc:title            "Onset Detection Function Type" ;
+    dc:description      """Type of onset detection function to use""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       7 ;
@@ -193,6 +203,7 @@
 plugbase:aubioonset_param_peakpickthreshold a  vamp:Parameter ;
     vamp:identifier     "peakpickthreshold" ;
     dc:title            "Peak Picker Threshold" ;
+    dc:description      """Threshold used for peak picking, the higher the more detections""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -203,6 +214,7 @@
 plugbase:aubioonset_param_silencethreshold a  vamp:Parameter ;
     vamp:identifier     "silencethreshold" ;
     dc:title            "Silence Threshold" ;
+    dc:description      """Silence threshold, the higher the least detection""" ;
     dc:format           "dB" ;
     vamp:min_value       -120 ;
     vamp:max_value       0 ;
@@ -213,6 +225,7 @@
 plugbase:aubioonset_param_minioi a  vamp:QuantizedParameter ;
     vamp:identifier     "minioi" ;
     dc:title            "Minimum Inter-Onset Interval" ;
+    dc:description      """Time interval below which two consecutive onsets should be merged""" ;
     dc:format           "ms" ;
     vamp:min_value       0 ;
     vamp:max_value       40 ;
@@ -224,7 +237,7 @@
 plugbase:aubioonset_output_onsets a  vamp:SparseOutput ;
     vamp:identifier       "onsets" ;
     dc:title              "Onsets" ;
-    dc:description        """"""  ;
+    dc:description        """List of times at which a note onset was detected"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;
     vamp:bin_count        0 ;
@@ -236,7 +249,7 @@
 plugbase:aubioonset_output_odf a  vamp:DenseOutput ;
     vamp:identifier       "onsets" ;
     dc:title              "Onsets" ;
-    dc:description        """"""  ;
+    dc:description        """Output of the onset detection function"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;
     vamp:bin_count        1 ;
@@ -245,7 +258,7 @@
 plugbase:aubioonset_output_todf a  vamp:DenseOutput ;
     vamp:identifier       "onsets" ;
     dc:title              "Onsets" ;
-    dc:description        """"""  ;
+    dc:description        """Output of the thresholded onset detection function"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;
     vamp:bin_count        0 ;
@@ -274,6 +287,7 @@
 plugbase:aubiopitch_param_pitchtype a  vamp:QuantizedParameter ;
     vamp:identifier     "pitchtype" ;
     dc:title            "Pitch Detection Function Type" ;
+    dc:description      """Type of pitch detection function to use""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       4 ;
@@ -285,6 +299,7 @@
 plugbase:aubiopitch_param_minfreq a  vamp:Parameter ;
     vamp:identifier     "minfreq" ;
     dc:title            "Minimum Fundamental Frequency" ;
+    dc:description      """Lowest frequency to look for""" ;
     dc:format           "Hz" ;
     vamp:min_value       1 ;
     vamp:max_value       24000 ;
@@ -295,6 +310,7 @@
 plugbase:aubiopitch_param_maxfreq a  vamp:Parameter ;
     vamp:identifier     "maxfreq" ;
     dc:title            "Maximum Fundamental Frequency" ;
+    dc:description      """Highest frequency to look for""" ;
     dc:format           "Hz" ;
     vamp:min_value       1 ;
     vamp:max_value       24000 ;
@@ -305,6 +321,7 @@
 plugbase:aubiopitch_param_wraprange a  vamp:QuantizedParameter ;
     vamp:identifier     "wraprange" ;
     dc:title            "Fold Higher or Lower Frequencies into Range" ;
+    dc:description      """Frequencies detected outside the range will be transposed to higher or lower octaves""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -316,6 +333,7 @@
 plugbase:aubiopitch_param_silencethreshold a  vamp:Parameter ;
     vamp:identifier     "silencethreshold" ;
     dc:title            "Silence Threshold" ;
+    dc:description      """Silence threshold, the higher the least detection"""  ;
     dc:format           "dB" ;
     vamp:min_value       -120 ;
     vamp:max_value       0 ;
@@ -326,7 +344,7 @@
 plugbase:aubiopitch_output_frequency a  vamp:SparseOutput ;
     vamp:identifier       "frequency" ;
     dc:title              "Fundamental Frequency" ;
-    dc:description        """"""  ;
+    dc:description        """List of detected frequencies"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "Hz" ;
     vamp:bin_count        1 ;
@@ -426,6 +444,7 @@
 plugbase:aubiotempo_param_onsettype a  vamp:QuantizedParameter ;
     vamp:identifier     "onsettype" ;
     dc:title            "Onset Detection Function Type" ;
+    dc:description      """Type of onset detection function to use""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       7 ;
@@ -437,6 +456,7 @@
 plugbase:aubiotempo_param_peakpickthreshold a  vamp:Parameter ;
     vamp:identifier     "peakpickthreshold" ;
     dc:title            "Peak Picker Threshold" ;
+    dc:description      """Peak picking threshold, the higher the least detection""" ;
     dc:format           "" ;
     vamp:min_value       0 ;
     vamp:max_value       1 ;
@@ -447,6 +467,7 @@
 plugbase:aubiotempo_param_silencethreshold a  vamp:Parameter ;
     vamp:identifier     "silencethreshold" ;
     dc:title            "Silence Threshold" ;
+    dc:description      "Silence threshold, the higher the least detection" ;
     dc:format           "dB" ;
     vamp:min_value       -120 ;
     vamp:max_value       0 ;
@@ -457,7 +478,7 @@
 plugbase:aubiotempo_output_beats a  vamp:SparseOutput ;
     vamp:identifier       "beats" ;
     dc:title              "Beats" ;
-    dc:description        """"""  ;
+    dc:description        """List of times at which a beat was detected"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;
     vamp:bin_count        0 ;
@@ -469,7 +490,7 @@
 plugbase:aubiotempo_output_tempo a  vamp:DenseOutput ;
     vamp:identifier       "tempo" ;
     dc:title              "Tempo" ;
-    dc:description        """"""  ;
+    dc:description        """Overall estimated tempo"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "bpm" ;
     vamp:bin_count        1 ;
@@ -497,6 +518,7 @@
 plugbase:aubiomfcc_param_nfilters a  vamp:Parameter ;
     vamp:identifier     "nfilters" ;
     dc:title            "Number of filters" ;
+    dc:description      """Size of filterbank used to compute MFCCs""" ;
     dc:format           "" ;
     vamp:min_value       10 ;
     vamp:max_value       100 ;
@@ -507,6 +529,7 @@
 plugbase:aubiomfcc_param_ncoeffs a  vamp:Parameter ;
     vamp:identifier     "ncoeffs" ;
     dc:title            "Number of coefficients" ;
+    dc:description      """Number of output coefficients to compute""" ;
     dc:format           "" ;
     vamp:min_value       1 ;
     vamp:max_value       100 ;
@@ -517,6 +540,7 @@
 plugbase:aubiomfcc_output_silencelevel a  vamp:DenseOutput ;
     vamp:identifier       "mfcc" ;
     dc:title              "Mel-Frequency Cepstrum Coefficients" ;
+    dc:description        """List of detected Mel-Frequency Cepstrum Coefficients""" ;
     dc:description        """"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;