source: doc/py_examples.rst

Last change on this file was d6561ea, checked in by Paul Brossier <piem@piem.org>, 13 months ago

[doc] re-add py_examples

  • Property mode set to 100644
File size: 1.1 KB
RevLine 
[d6561ea]1.. default-domain:: py
2.. currentmodule:: aubio
3
4Examples
5--------
6
7Below is a short selection of examples using the aubio module.
8
9Read a sound file
10.................
11
12Here is a simple script, :download:`demo_source_simple.py
13<../python/demos/demo_source_simple.py>` that reads all the samples from a
14media file using :class:`source`:
15
16.. literalinclude:: ../python/demos/demo_source_simple.py
17   :language: python
18
19Filter a sound file
20...................
21
22Here is another example, :download:`demo_filter.py
23<../python/demos/demo_filter.py>`, which applies a filter to a sound file
24and writes the filtered signal in another file:
25
26* read audio samples from a file with :class:`source`
27
28* filter them using an `A-weighting <https://en.wikipedia.org/wiki/A-weighting>`_
29  filter using :class:`digital_filter`
30
31* write the filtered samples to a new file with :class:`sink`.
32
33.. literalinclude:: ../python/demos/demo_filter.py
34   :language: python
35
36More examples
37.............
38
39For more examples showing how to use other components of the module, see
40the `python demos folder`_.
41
42.. _python demos folder: https://github.com/aubio/aubio/blob/master/python/demos
Note: See TracBrowser for help on using the repository browser.