From: Guillaume Pellerin Date: Fri, 24 Oct 2014 09:28:38 +0000 (+0200) Subject: update doc X-Git-Tag: 0.6~2^2~1 X-Git-Url: https://git.parisson.com/?a=commitdiff_plain;h=8a855d3b9fa3e30652060443c1e5aad7ba9b50e1;p=timeside.git update doc --- diff --git a/doc/source/dive_in.rst b/doc/source/dive_in.rst deleted file mode 100644 index 7b1322c..0000000 --- a/doc/source/dive_in.rst +++ /dev/null @@ -1,40 +0,0 @@ -Dive in -======== - -To list all available plugins:: - - import timeside - timeside.core.list_processors() - -Define some processors:: - - from timeside.core import get_processor - decoder = get_processor('file_decoder')('sweep.wav') - grapher = get_processor('waveform_simple') - analyzer = get_processor('level') - encoder = get_processor('vorbis_encoder')('sweep.ogg') - -Then run the *magic* pipeline:: - - (decoder | grapher | analyzer | encoder).run() - -Render the grapher results:: - - grapher.render(output='waveform.png') - -Show the analyzer results:: - - print 'Level:', analyzer.results - -The encoded OGG file should also be there... - -Note you can also instanciate each processor with its own class:: - - 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') - -For more extensive examples, please see the `full documentation `_. - - diff --git a/doc/source/doc.rst b/doc/source/doc.rst index 49aef54..8a6127b 100644 --- a/doc/source/doc.rst +++ b/doc/source/doc.rst @@ -8,6 +8,5 @@ API / Documentation * Examples: - http://nbviewer.ipython.org/github/thomasfillon/Timeside-demos/tree/master/ - - https://github.com/yomguy/TimeSide/blob/master/tests/sandbox/example_CMMR.py - - https://github.com/yomguy/TimeSide/blob/master/tests/sandbox/exempleCMMR_vamp.py - + - http://archives.crem-cnrs.fr/archives/items/CNRSMH_E_2004_017_001_01/ + - diff --git a/doc/source/install.rst b/doc/source/install.rst index fd53fea..013ee1f 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -1,28 +1,26 @@ Install ======= -The TimeSide engine is intended to work on all Linux and Unix like platforms. - -It depends on several other python modules and compiled librairies like GStreamer. +The TimeSide engine is intended to work on all Linux and Unix like platforms. It depends on several other python modules and compiled libraries like GStreamer. Debian, Ubuntu --------------- -For Debian based distributions, we provide a safe repository which provides all additional dependencies that are not included in Debian yet. Please follow the instructions on `this page `_. +For Debian based distributions, we provide a safe repository giving additional dependencies that are not included in Debian yet. Please follow the instructions on `this page `_. Other Linux distributions -------------------------- -On other Linux platforms, you need to install all dependencies listed in the paragraph "Dependencies" (find all equivalent package names for your distribution). +On other Linux platforms, you need to install all dependencies listed in Dependencies finding all equivalent package names for your distribution. Then, use pip:: sudo pip install timeside -OSX ---- +OSX / Windows +-------------- -The installation on OSX platforms is pretty hard at the moment because all dependencies are not in brew. But, it will be fully documented in the next release 0.5.6. +Native install is hard at the moment but you can either run our Vagrant or Docker images (see Development). Dependencies ------------- diff --git a/doc/source/intro.rst b/doc/source/intro.rst index a603c17..2282bf3 100644 --- a/doc/source/intro.rst +++ b/doc/source/intro.rst @@ -47,3 +47,37 @@ 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 + +Dive in +======== + +To list all available plugins:: + + import timeside + timeside.core.list_processors() + +Define some processors:: + + from timeside.core import get_processor + decoder = get_processor('file_decoder')('sweep.wav') + grapher = get_processor('waveform_simple') + analyzer = get_processor('level') + encoder = get_processor('vorbis_encoder')('sweep.ogg') + +Then run the *magic* pipeline:: + + (decoder | grapher | analyzer | encoder).run() + +Render the grapher results:: + + grapher.render(output='waveform.png') + +Show the analyzer results:: + + print 'Level:', analyzer.results + +The encoded OGG file should also be there... + +For more extensive examples, please see the `full documentation `_. + + diff --git a/doc/source/tutorial/Streaming.rst b/doc/source/tutorial/Streaming.rst index e6f86e6..bbefa0e 100644 --- a/doc/source/tutorial/Streaming.rst +++ b/doc/source/tutorial/Streaming.rst @@ -2,7 +2,7 @@ @author: Guillaume Pellerin ================================= - Streaming encoded audio outside + Streaming out encoded audio ================================= Instead of calling a pipe.run(), the chunks of an encoding processor can also be retrieved and streamed outside the pipe during the process.