From: Guillaume Pellerin <yomguy@parisson.com>
Date: Fri, 8 Nov 2013 00:30:32 +0000 (+0100)
Subject: update processors in readme
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=da25b8683ea033846d143d616d3c7024de5537bf;p=timeside-diadems.git

update processors in readme
---

diff --git a/README.rst b/README.rst
index 5ed7b33..6d604df 100644
--- a/README.rst
+++ b/README.rst
@@ -29,43 +29,50 @@ Here is a schematic diagram of the TimeSide engine architecture:
 .. image:: https://raw.github.com/yomguy/TimeSide/master/doc/slides/img/timeside_schema.png
 
 
-Available plugins
-=================
+Processors
+==========
+
+ * IEncoder
+    VorbisEncoder [gst_vorbis_enc]
+    WavEncoder [gst_wav_enc]
+    Mp3Encoder [gst_mp3_enc]
+    FlacEncoder [gst_flac_enc]
+    AacEncoder [gst_aac_enc]
+    WebMEncoder [gst_webm_enc]
+ * IDecoder
+    FileDecoder [gst_dec]
+ * IGrapher
+    Waveform [waveform_simple]
+    WaveformCentroid [waveform_centroid]
+    WaveformTransparent [waveform_transparent]
+    WaveformContourBlack [waveform_contour_black]
+    WaveformContourWhite [waveform_contour_white]
+    SpectrogramLog [spectrogram_log]
+    SpectrogramLinear [spectrogram_linear]
+ * IAnalyzer
+    IValueAnalyzer
+      Level [level]
+      MeanDCShift [mean_dc_shift]
+    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 [odf]
 
-* Decoder:
-     - Takes ALL known media formats thanks to GStreamer
-
-* Analyzers:
-     - Levels : max level, mean level, DC
-     - Yaafe : all data flows
-     - Aubio : BPM, beats, pitch, various spectral descriptors
-     - VAMP : all default plugins from simple host
-     - IRIT : 4Hz modulation and entropy speech detectors
-
-* Graphers:
-     - Waveform
-     - Contour
-     - Spectrogram
-
-* Encoders:
-     - WAV
-     - FLAC
-     - WebM
-     - OGG Vorbis
-     - MP3
-
-* Serializers:
-     - YAML
-     - JSON
-     - XML
-     - HDF5
 
 News
 =====
 
 0.5.1
 
- * Simplify and optimize the grapher system,
+ * Simplify and optimize the grapher system
  * Add Grapher abstract generic class
  * Add a UUID property to Processor
  * Add a SpectrogramLinear grapher