add processor list

diff --git a/README.rst b/README.rst
index eadbf16f560254be23a5889480bb9c0ac349673c..ff2de1cf5b68911e12302d5a647f901e7e0655ed 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -47,72 +47,12 @@ The streaming architecture of TimeSide relies on 2 main parts: a processing engi
 .. image:: http://vcs.parisson.com/gitweb/?p=timeside.git;a=blob_plain;f=doc/slides/img/timeside_schema.svg;hb=refs/heads/dev
   :width: 800 px
 
-
-Processors
-==========
-
-IDecoder
----------
-
-  * FileDecoder [file_decoder]
-  * ArrayDecoder [array_decoder]
-  * LiveDecoder [live_decoder]
-
-IAnalyzer
----------
-
-  *  AubioTemporal [aubio_temporal]
-  *  AubioPitch [aubio_pitch]
-  *  AubioMfcc [aubio_mfcc]
-  *  AubioMelEnergy [aubio_melenergy]
-  *  AubioSpecdesc [aubio_specdesc]
-  *  Yaafe [yaafe]
-  *  Spectrogram [spectrogram_analyzer]
-  *  Waveform [waveform_analyzer]
-  *  VampSimpleHost [vamp_simple_host]
-  *  IRITSpeechEntropy [irit_speech_entropy]
-  *  IRITSpeech4Hz [irit_speech_4hz]
-  *  OnsetDetectionFunction [onset_detection_function]
-  *  LimsiSad [limsi_sad]
-
-IValueAnalyzer
----------------
-
-  * Level [level]
-  * MeanDCShift [mean_dc_shift]
-
-IGrapher
----------
-
-  *  Waveform [waveform_simple]
-  *  WaveformCentroid [waveform_centroid]
-  *  WaveformTransparent [waveform_transparent]
-  *  WaveformContourBlack [waveform_contour_black]
-  *  WaveformContourWhite [waveform_contour_white]
-  *  SpectrogramLog [spectrogram_log]
-  *  SpectrogramLinear [spectrogram_lin]
-  *  Display.aubio_pitch.pitch [grapher_aubio_pitch]
-  *  Display.onset_detection_function [grapher_odf]
-  *  Display.waveform_analyzer [grapher_waveform]
-  *  Display.irit_speech_4hz.segments [grapher_irit_speech_4hz_segments]
-
-IEncoder
----------
-
-  * VorbisEncoder [vorbis_encoder]
-  * WavEncoder [wav_encoder]
-  * Mp3Encoder [mp3_encoder]
-  * FlacEncoder [flac_encoder]
-  * AacEncoder [aac_encoder]
-  * WebMEncoder [webm_encoder]
-  * OpusEncoder [opus_encoder]
-  * AudioSink [live_encoder]
-
 News
 =====
 
 0.5.7
 
+  * WARNING! some processor ids have changed. Please see the full list below.
   * Add a Docker development box
   * Add a Vagrant development box
   * Add a Debian package installation procedure
@@ -125,6 +65,114 @@ News
 
 For older news, please visit: https://github.com/yomguy/TimeSide/blob/master/NEWS.rst
 
+Processors
+==========
+
+  IEncoder
+  --------
+    * live_encoder
+                Gstreamer-based Audio Sink
+    * flac_encoder
+                FLAC encoder based on Gstreamer
+    * aac_encoder
+                AAC encoder based on Gstreamer
+    * mp3_encoder
+                MP3 encoder based on Gstreamer
+    * vorbis_encoder
+                OGG Vorbis encoder based on Gstreamer
+    * opus_encoder
+                Opus encoder based on Gstreamer
+    * wav_encoder
+                WAV encoder based on Gstreamer
+    * webm_encoder
+                WebM encoder based on Gstreamer
+  IDecoder
+  --------
+    * array_decoder
+                Decoder taking Numpy array as input
+    * file_decoder
+                File Decoder based on Gstreamer
+    * live_decoder
+                Live source Decoder based on Gstreamer
+  IGrapher
+  --------
+    * grapher_aubio_pitch
+                Builds a PIL image representing Aubio Pitch
+    * grapher_onset_detection_function
+                Builds a PIL image representing Onset detection function
+    * grapher_waveform
+                Builds a PIL image representing Waveform from Analyzer
+    * grapher_irit_speech_4hz_segments
+                Builds a PIL image representing Irit 4Hz Speech Segmentation
+    * grapher_irit_speech_4hz_segments_median
+                Builds a PIL image representing Irit 4Hz Speech Segmentation with median filter
+    * grapher_monopoly_segments
+                Builds a PIL image representing Irit Monopoly Segmentation
+    * grapher_limsi_sad_etape
+                Builds a PIL image representing LIMSI SAD with ETAPE model
+    * grapher_limsi_sad_maya
+                Builds a PIL image representing LIMSI SAD with Mayan model
+    * grapher_irit_startseg
+                Builds a PIL image representing IRIT Start Noise
+    * spectrogram_log
+                Builds a PIL image representing a spectrogram of the audio stream
+    * spectrogram_lin
+                Builds a PIL image representing a spectrogram of the audio stream (level vs. frequency vs. time).
+    * waveform_simple
+                Builds a PIL image representing a simple waveform of the audio stream.
+    * waveform_centroid
+                Builds a PIL image representing a waveform of the audio stream.
+    * waveform_contour_black
+                Builds a PIL image representing an amplitude coutour (envelop) of the audio stream.
+    * waveform_contour_white
+                Builds a PIL image representing an amplitude coutour (envelop) of the audio stream.
+    * waveform_transparent
+                Builds a PIL image representing a transparent waveform
+  IAnalyzer
+  ---------
+    IValueAnalyzer
+    --------------
+      * mean_dc_shift
+                        Mean DC shift analyzer
+      * level
+                        Audio level analyzer
+    * aubio_melenergy
+                Aubio Mel Energy analyzer
+    * aubio_mfcc
+                Aubio MFCC analyzer
+    * aubio_pitch
+                Aubio Pitch estimation analyzer
+    * aubio_specdesc
+                Aubio Spectral Descriptors collection analyzer
+    * aubio_temporal
+                Aubio Temporal analyzer
+    * yaafe
+                Yaafe feature extraction library interface analyzer
+    * irit_monopoly
+                Segmentor Monophony/Polyphony based on the analysis of yin confidence.
+    * irit_startseg
+                Segmentation of recording sessions into 'start' and 'session' segments
+    * irit_speech_4hz
+                Speech Segmentor based on the 4Hz energy modulation analysis.
+    * irit_speech_entropy
+                Speech Segmentor based on Entropy analysis.
+    * limsi_sad
+                Limsi Speech Activity Detection Systems
+    * spectrogram_analyzer
+                Spectrogram analyzer
+    * onset_detection_function
+                Onset Detection Function analyzer
+    * spectrogram_analyzer_2
+                Spectrogram analyzer
+    * spectrogram_analyzer_3
+                Spectrogram analyzer
+    * waveform_analyzer
+                Waveform analyzer
+  IEffect
+  -------
+    * fx_gain
+                Gain effect processor
+
 Dive in
 ========
 
@@ -163,6 +211,8 @@ Note you can also instanciate each processor with its own class::
  encoder  =  timeside.encoder.ogg.VorbisEncoder('sweep.ogg')
 
 For more extensive examples, please see the `full documentation <http://files.parisson.com/timeside/doc/>`_.
+
+
 API / Documentation
 ====================