From: Guillaume Pellerin <yomguy@parisson.com>
Date: Fri, 8 Nov 2013 01:15:42 +0000 (+0100)
Subject: update doc
X-Git-Tag: 0.5.1-1
X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=9f9f8c898cf284b97fd8c02e7e5e119c3e55287c;p=timeside.git

update doc
---

diff --git a/README.rst b/README.rst
index 7099ceb..8025a10 100644
--- a/README.rst
+++ b/README.rst
@@ -77,7 +77,6 @@ IAnalyzer
   * IRITSpeech4Hz [irit_speech_4hz]
   * OnsetDetectionFunction [odf]
 
-
 News
 =====
 
diff --git a/doc/source/intro.rst b/doc/source/intro.rst
index 9f88fdc..f89f326 100644
--- a/doc/source/intro.rst
+++ b/doc/source/intro.rst
@@ -29,34 +29,51 @@ 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
-=================
-
-* 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
+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]
 
diff --git a/doc/source/news.rst b/doc/source/news.rst
index 8eb224c..9dfecde 100644
--- a/doc/source/news.rst
+++ b/doc/source/news.rst
@@ -1,6 +1,22 @@
 News
 =====
 
+0.5.1
+
+ * Add *parent* procesor list to Processor
+ * Simplify and optimize the grapher system
+ * Add Grapher abstract generic class
+ * Add a UUID property to Processor
+ * Add a SpectrogramLinear grapher
+ * Add WaveformTransparent grapher
+ * Fix some assignment issues regarding immutable type in for Analyzer Result
+ * Simplify analyzer results implementation by introducing a Factory and multiple classes and subclasses to handle the 8 different kinds of results
+ * Add doctests and improve the unit tests
+ * Add a OnsetDetectionFunction analyzer
+ * Update documentation
+ * Various cleanups
+ * Various bugfixes
+
 0.5.0
 
  * Deep refactoring of the analyzer API to handle various new usecases, specifically audio feature extraction