From fb9410c12f33ba34b090884701c4c54f91f9fb5f Mon Sep 17 00:00:00 2001 From: Guillaume Pellerin Date: Wed, 16 Oct 2013 02:06:28 +0200 Subject: [PATCH] update news and prepare basic tutorial --- README.rst | 12 +++++++----- doc/source/examples/tutorial.rst | 31 +++++++++++++++++++++++++++++++ doc/source/install.rst | 3 ++- doc/source/intro.rst | 6 +++--- setup.py | 1 + 5 files changed, 44 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 79ba802..00e56c3 100644 --- a/README.rst +++ b/README.rst @@ -36,11 +36,11 @@ Available plugins - Takes ALL known media formats thanks to GStreamer * Analyzers: - - MaxLevel, MeanLevel, DC + - Levels : max level, mean level, DC - Yaafe : all data flows - - Aubio : BPM, Beats, Pitch, various spectral descriptors + - Aubio : BPM, beats, pitch, various spectral descriptors - VAMP : all default plugins from simple host - - IRIT 4Hz, Entropy + - IRIT : 4Hz modulation and entropy speech detectors * Graphers: - Waveform @@ -73,7 +73,8 @@ News * Add new documentation : http://files.parisson.com/timeside/doc/ * New Debian repository for instant install * Various bugfixes - * Comptatible with Python >=2.7 + * Comptatible with python >=2.7 + * WARNING : no longer compatible with Telemeta 1.4.5 0.4.5 @@ -192,7 +193,8 @@ Dependencies ============ python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, gstreamer0.10-gnonlin, -gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py +gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py, +python-scipy Platforms diff --git a/doc/source/examples/tutorial.rst b/doc/source/examples/tutorial.rst index 2a7aeac..aae0c07 100644 --- a/doc/source/examples/tutorial.rst +++ b/doc/source/examples/tutorial.rst @@ -2,3 +2,34 @@ Tutorial ========== +== Quick Start == + +A most basic operation, transcoding, is easily performed with two processors: + + >>> import timeside + >>> decoder = timeside.decoder.FileDecoder('myfile.wav') + >>> encoder = timeside.encoder.OggEncoder("myfile.ogg") + >>> pipe = decoder | encoder + >>> pipe.run() + +As one can see in the above example, creating a processing pipe is performed with +the binary OR operator. + +Audio data visualisation can be performed using graphers, such as Waveform and +Spectrogram. All graphers return a [http://www.pythonware.com/library/pil/handbook/image.htm PIL image]: + + >>> import timeside + >>> decoder = timeside.decoder.FileDecoder('myfile.wav') + >>> spectrogram = timeside.grapher.Spectrogram(width=400, height=150) + >>> (decoder | spectrogram).run() + >>> spectrogram.render().save('graph.png') + +It is possible to create longer pipes, as well as subpipes, here for both +analysis and encoding: + + >>> import timeside + >>> decoder = timeside.decoder.FileDecoder('myfile.wav') + >>> levels = timeside.analyzer.Level() + >>> encoders = timeside.encoder.Mp3Encoder('myfile.mp3') | timeside.encoder.FlacEncoder('myfile.flac') + >>> (decoder | levels | encoders).run() + >>> print levels.results diff --git a/doc/source/install.rst b/doc/source/install.rst index e0b3004..f3b9f26 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -31,7 +31,8 @@ Dependencies ============ python (>=2.7), python-setuptools, python-gst0.10, gstreamer0.10-plugins-good, gstreamer0.10-gnonlin, -gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py +gstreamer0.10-plugins-ugly, python-aubio, python-yaafe, python-simplejson, python-yaml, python-h5py, +python-scipy Platforms diff --git a/doc/source/intro.rst b/doc/source/intro.rst index 95532d4..75063eb 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -36,11 +36,11 @@ Available plugins - Takes ALL known media formats thanks to GStreamer * Analyzers: - - MaxLevel, MeanLevel, DC + - Levels : max level, mean level, DC - Yaafe : all data flows - - Aubio : BPM, Beats, Pitch, various spectral descriptors + - Aubio : BPM, beats, pitch, various spectral descriptors - VAMP : all default plugins from simple host - - IRIT 4Hz, Entropy + - IRIT : 4Hz modulation and entropy speech detectors * Graphers: - Waveform diff --git a/setup.py b/setup.py index e0885d3..41e11d0 100644 --- a/setup.py +++ b/setup.py @@ -35,6 +35,7 @@ setup( 'h5py', 'yaml', 'simplejson', + 'scipy', ], platforms=['OS Independent'], license='Gnu Public License V2', -- 2.39.5