From 1d86cab19a6352d97d1efffb8769e345a8a582a0 Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Sun, 18 May 2014 01:27:42 +0200 Subject: [PATCH] add some doc --- doc/source/dive_in.rst | 9 +++++---- doc/source/install.rst | 3 +-- doc/source/news.rst | 8 +++++--- doc/source/related.rst | 2 +- timeside/decoder/file.py | 4 ++++ 5 files changed, 16 insertions(+), 10 deletions(-) diff --git a/doc/source/dive_in.rst b/doc/source/dive_in.rst index 1aa8a77..87be35f 100644 --- a/doc/source/dive_in.rst +++ b/doc/source/dive_in.rst @@ -4,10 +4,10 @@ Dive in Define some processors:: >>> import timeside - >>> decoder = timeside.decoder.FileDecoder('sweep.wav') - >>> grapher = timeside.grapher.Waveform() - >>> analyzer = timeside.analyzer.Level() - >>> encoder = timeside.encoder.VorbisEncoder('sweep.ogg') + >>> decoder = timeside.decoder.file.FileDecoder('sweep.wav') + >>> grapher = timeside.grapher.waveform_simple.Waveform() + >>> analyzer = timeside.analyzer.level.Level() + >>> encoder = timeside.encoder.ogg.VorbisEncoder('sweep.ogg') then, the *magic* pipeline:: @@ -18,4 +18,5 @@ get the results:: >>> grapher.render(output='waveform.png') >>> print 'Level:', analyzer.results +For more extensive examples, please see the `http://files.parisson.com/timeside/doc/ `_. diff --git a/doc/source/install.rst b/doc/source/install.rst index 357507e..755333c 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -1,8 +1,7 @@ Install ======= -The TimeSide engine is intended to work on all Unix / Linux platforms. -MacOS X and Windows versions will soon be explorated. +The TimeSide engine is intended to work on all Unix and Linux platforms. TimeSide needs some other python modules and other compiled librairies like GStreamer, Aubio and Yaafe to run. So, before installing the module, you'll need to install dependencies before. diff --git a/doc/source/news.rst b/doc/source/news.rst index 5d52215..aff9afa 100644 --- a/doc/source/news.rst +++ b/doc/source/news.rst @@ -3,14 +3,16 @@ News 0.5.5 - * All processor folder (analyzer, grapher, etc...) are now a real plugin repositoris : you can now drop processors in them and play ! - * Encoder : add an Opus encoder + * All processor folders (decoder, analyzer, grapher, encoder) are now real plugin repositories : you can just drop processors in it and play! + * TimeSide can be installed without Aubio, Yaafe nor Vamp : it should be easier to install on old distributions for which those librairies are difficult or impossible to compile * Experimental : add a django web server with a REST API (see Interface : web server) + * Encoder : add an Opus encoder * AubioPitch: prevent NaN in result by converting them to zero * Yaafe analyzer: simplify adaptation of process frames from TimeSide to Yaafe * LimsiSad: add a default value for parameter sad_model - * Full Travis integration * Fix various NaN and Inf and PEP8 issues also many PyFlake warnings + * Full Travis integration + * Thanks to all contributors! 0.5.4 diff --git a/doc/source/related.rst b/doc/source/related.rst index 879ba91..98ffd0d 100644 --- a/doc/source/related.rst +++ b/doc/source/related.rst @@ -13,7 +13,7 @@ Sponsors and Partners Related projects ================= - * `Telemeta `_ : open source web audio CMS + * `Telemeta `_ : open source web audio platform * `Sound archives `_ of the CNRS, CREM and the "Musée de l'Homme" in Paris, France. * The `DIADEMS project `_ sponsored by the ANR. diff --git a/timeside/decoder/file.py b/timeside/decoder/file.py index 3c49abd..262220b 100644 --- a/timeside/decoder/file.py +++ b/timeside/decoder/file.py @@ -73,6 +73,10 @@ class FileDecoder(Decoder): start time of the segment in seconds duration : float duration of the segment in seconds + stack : boolean + keep decoded data in the stack + sha1 : boolean + compute the sha1 hash of the data """ -- 2.39.5