README.md: rewrite readme
[vamp-aubio-plugins.git] / vamp-aubio.n3
index c12371c..9bcebd6 100644 (file)
@@ -21,6 +21,8 @@
     vamp:available_plugin plugbase:aubiosilence ; 
     vamp:available_plugin plugbase:aubiotempo ; 
     vamp:available_plugin plugbase:aubiomfcc ;
+    vamp:available_plugin plugbase:aubiomelenergy ;
+    vamp:available_plugin plugbase:aubiospecdesc ;
 #   foaf:page <Place more-information HTML page URL here and uncomment> ;
     .
 
@@ -51,6 +53,7 @@ plugbase:aubionotes a   vamp:Plugin ;
 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 +65,7 @@ plugbase:aubionotes_param_onsettype a  vamp:QuantizedParameter ;
 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 +77,7 @@ plugbase:aubionotes_param_pitchtype a  vamp:QuantizedParameter ;
 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 +89,7 @@ plugbase:aubionotes_param_minpitch a  vamp:QuantizedParameter ;
 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 +101,7 @@ plugbase:aubionotes_param_maxpitch a  vamp:QuantizedParameter ;
 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 +113,7 @@ plugbase:aubionotes_param_wraprange a  vamp:QuantizedParameter ;
 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 +125,7 @@ plugbase:aubionotes_param_avoidleaps a  vamp:QuantizedParameter ;
 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 +136,7 @@ plugbase:aubionotes_param_peakpickthreshold a  vamp:Parameter ;
 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 +147,7 @@ plugbase:aubionotes_param_silencethreshold a  vamp:Parameter ;
 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 +159,7 @@ plugbase:aubionotes_param_minioi a  vamp:QuantizedParameter ;
 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 +193,7 @@ plugbase:aubioonset a   vamp:Plugin ;
 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 +205,7 @@ plugbase:aubioonset_param_onsettype a  vamp:QuantizedParameter ;
 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 +216,7 @@ plugbase:aubioonset_param_peakpickthreshold a  vamp:Parameter ;
 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 +227,7 @@ plugbase:aubioonset_param_silencethreshold a  vamp:Parameter ;
 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 +239,7 @@ plugbase:aubioonset_param_minioi a  vamp:QuantizedParameter ;
 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 +251,7 @@ plugbase:aubioonset_output_onsets a  vamp:SparseOutput ;
 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 +260,7 @@ plugbase:aubioonset_output_odf a  vamp:DenseOutput ;
 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 +289,7 @@ plugbase:aubiopitch a   vamp:Plugin ;
 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 +301,7 @@ plugbase:aubiopitch_param_pitchtype a  vamp:QuantizedParameter ;
 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 +312,7 @@ plugbase:aubiopitch_param_minfreq a  vamp:Parameter ;
 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 +323,7 @@ plugbase:aubiopitch_param_maxfreq a  vamp:Parameter ;
 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 +335,7 @@ plugbase:aubiopitch_param_wraprange a  vamp:QuantizedParameter ;
 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 +346,7 @@ plugbase:aubiopitch_param_silencethreshold a  vamp:Parameter ;
 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 +446,7 @@ plugbase:aubiotempo a   vamp:Plugin ;
 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 +458,7 @@ plugbase:aubiotempo_param_onsettype a  vamp:QuantizedParameter ;
 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 +469,7 @@ plugbase:aubiotempo_param_peakpickthreshold a  vamp:Parameter ;
 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 +480,7 @@ plugbase:aubiotempo_param_silencethreshold a  vamp:Parameter ;
 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 +492,7 @@ plugbase:aubiotempo_output_beats a  vamp:SparseOutput ;
 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,9 +520,10 @@ plugbase:aubiomfcc a   vamp:Plugin ;
 plugbase:aubiomfcc_param_nfilters a  vamp:Parameter ;
     vamp:identifier     "nfilters" ;
     dc:title            "Number of filters" ;
+    dc:description      """Size of filterbank used to compute MFCCs (fixed to 40 for now)""" ;
     dc:format           "" ;
-    vamp:min_value       10 ;
-    vamp:max_value       100 ;
+    vamp:min_value       40 ;
+    vamp:max_value       40 ;
     vamp:unit           ""  ;
     vamp:default_value   40 ;
     vamp:value_names     ();
@@ -507,6 +531,7 @@ plugbase:aubiomfcc_param_nfilters a  vamp:Parameter ;
 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,9 +542,84 @@ plugbase:aubiomfcc_param_ncoeffs a  vamp:Parameter ;
 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             "" ;
+    a                     vamp:QuantizedOutput ;
+    vamp:bin_count        1 ;
+    .
+plugbase:aubiomelenergy a   vamp:Plugin ;
+    dc:title              "Aubio Mel-Frequency Bands Extractor" ;
+    vamp:name             "Aubio Mel-Energy Bands Extractor" ;
+    dc:description        """Compute energy in each 40 mel-frequency bands""" ;
+    foaf:maker            [ foaf:name "Paul Brossier" ] ; # FIXME could give plugin author's URI here
+    dc:rights             """GPL""" ;
+#   cc:license            <Place plugin license URI here and uncomment> ;
+    vamp:identifier       "aubiomelenergy" ;
+    vamp:vamp_API_version vamp:api_version_2 ;
+    owl:versionInfo       "4" ;
+    vamp:input_domain     vamp:TimeDomain ;
+
+    vamp:parameter   plugbase:aubiomelenergy_param_nfilters ;
+
+    vamp:output      plugbase:aubiomelenergy_output_melenergy ;
+    .
+plugbase:aubiomelenergy_param_nfilters a  vamp:Parameter ;
+    vamp:identifier     "nfilters" ;
+    dc:title            "Number of filters" ;
+    dc:description      """Size of filterbank used to compute mel bands (fixed to 40 for now)""" ;
+    dc:format           "" ;
+    vamp:min_value       40 ;
+    vamp:max_value       40 ;
+    vamp:unit           ""  ;
+    vamp:default_value   40 ;
+    vamp:value_names     ();
+    .
+plugbase:aubiomelenergy_output_melenergy a  vamp:DenseOutput ;
+    vamp:identifier       "melenergy" ;
+    dc:title              "Mel-Frequency Cepstrum Coefficients" ;
+    dc:description        """List of measured energy in each Mel-frequency bands""" ;
     dc:description        """"""  ;
     vamp:fixed_bin_count  "true" ;
     vamp:unit             "" ;
     a                     vamp:QuantizedOutput ;
     vamp:bin_count        1 ;
     .
+plugbase:aubiospecdesc a   vamp:Plugin ;
+    dc:title              "Aubio Spectral Descriptor" ;
+    vamp:name             "Aubio Spectral Descriptor" ;
+    dc:description        """Compute spectral description function""" ;
+    foaf:maker            [ foaf:name "Paul Brossier" ] ; # FIXME could give plugin author's URI here
+    dc:rights             """GPL""" ;
+#   cc:license            <Place plugin license URI here and uncomment> ;
+    vamp:identifier       "aubiospecdesc" ;
+    vamp:vamp_API_version vamp:api_version_2 ;
+    owl:versionInfo       "4" ;
+    vamp:input_domain     vamp:TimeDomain ;
+
+    vamp:parameter   plugbase:aubiospecdesc_param_specdesctype ;
+
+    vamp:output      plugbase:aubiospecdesc_output_descriptor ;
+    .
+plugbase:aubioonset_param_specdesctype a  vamp:QuantizedParameter ;
+    vamp:identifier     "specdesctype" ;
+    dc:title            "Spectral Description Function" ;
+    dc:description      """Type of onset detection function to use""" ;
+    dc:format           "" ;
+    vamp:min_value       0 ;
+    vamp:max_value       7 ;
+    vamp:unit           "" ;
+    vamp:quantize_step   1  ;
+    vamp:default_value   3 ;
+    vamp:value_names     ( "Spectral Flux" "Spectral Centroid" "Spectral Spread" "Spectral Skewness" "Spectral Kurtosis" "Spectral Slope" "Spectral Decrease" "Spectral Rolloff" );
+    .
+plugbase:aubiospecdesc_output_descriptor a  vamp:DenseOutput ;
+    vamp:identifier       "specdesc" ;
+    dc:title              "Spectral Descriptor Output" ;
+    dc:description        """Values computed on consecutive spectral frames""" ;
+    vamp:fixed_bin_count  "true" ;
+    vamp:unit             "" ;
+    vamp:bin_count        1 ;
+    vamp:computes_signal_type  af:Signal ;
+    .