Changeset d90d5bb0 for python


Ignore:
Timestamp:
Nov 21, 2018, 7:33:53 PM (5 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
89c44aa
Parents:
007c0a1
Message:

[doc] rewrite python/README.md demo section

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/README.md

    r007c0a1 rd90d5bb0  
    5858[NumPy]: https://www.numpy.org
    5959
    60 Finding some inspiration
    61 ------------------------
     60Demos scripts
     61-------------
    6262
    63 Some examples are available in the `python/demos` directory. These scripts are
    64 small programs written in python and using python-aubio.
     63Some examples are available in the [`python/demos`][demos_dir] folder. These
     64scripts are small programs written in python and using python-aubio.
    6565
    66 For instance, `demo_source.py` reads a media file.
     66**Notes**: installing additional modules is required to run some of the demos.
    6767
    68     $ ./python/demos/demo_source.py /path/to/sound/sample.wav
     68### Analysis
    6969
    70 and `demo_timestretch_online.py` stretches the original file into a new one:
     70- `demo_source.py` uses aubio to read audio samples from media files
     71- `demo_onset_plot.py` detects attacks in a sound file and plots the results
     72  using [matplotlib]
     73- `demo_pitch.py` looks for fundamental frequency in a sound file and plots the
     74  results using [matplotlib]
     75- `demo_spectrogram.py`, `demo_specdesc.py`, `demo_mfcc.py` for spectral
     76  analysis.
    7177
    72     $ ./python/demo/demo_timestretch_online.py loop.wav stretched_loop.wav 0.92`
     78### Real-time
    7379
    74 Note: you might need to install additional modules to run some of the demos.
    75 Some demos use [matplotlib](http://matplotlib.org/) to draw plots, others use
    76 [PySoundCard](https://github.com/bastibe/PySoundCard) to play and record
    77 sounds.
     80- `demo_pyaudio.py` and `demo_tapthebeat.py` use [pyaudio]
     81- `demo_pysoundcard_play.py`, `demo_pysoundcard.py` use [PySoundCard]
     82- `demo_alsa.py` uses [pyalsaaudio]
     83
     84### Others
     85
     86- `demo_timestretch.py` can change the duration of an input file and write the
     87  new sound to disk,
     88- `demo_wav2midi.py` detects the notes in a file and uses [mido] to write the
     89  results into a MIDI file
     90
     91### Example
     92
     93Use `demo_timestretch_online.py` to slow down `loop.wav`, write the results in
     94`stretched_loop.wav`:
     95
     96    $ python demo_timestretch_online.py loop.wav stretched_loop.wav 0.92
     97
     98[demos_dir]:https://github.com/aubio/aubio/tree/master/python/demos
     99[pyaudio]:https://people.csail.mit.edu/hubert/pyaudio/
     100[PySoundCard]:https://github.com/bastibe/PySoundCard
     101[pyalsaaudio]:https://larsimmisch.github.io/pyalsaaudio/
     102[mido]:https://mido.readthedocs.io
     103[matplotlib]:https://matplotlib.org/
Note: See TracChangeset for help on using the changeset viewer.