Changeset 89c44aa


Ignore:
Timestamp:
Nov 21, 2018, 7:51:33 PM (13 months ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
feature/autosink, feature/constantq, feature/pitchshift, feature/pydocstrings, feature/timestretch, master
Children:
afe90ee
Parents:
d90d5bb0
Message:

[doc] reorder python/README.md sections, group links

File:
1 edited

Legend:

Unmodified
Added
Removed
  • python/README.md

    rd90d5bb0 r89c44aa  
    1616aubio works with both Python 2 and Python 3.
    1717
    18 Built with
    19 ----------
    20 
    21 The core of aubio is written in C for portability and speed. In addition to
    22 [NumPy], aubio can be optionally built to use one or more of the following
    23 libraries:
    24 
    25 - media file reading:
    26 
    27     - [ffmpeg](https://ffmpeg.org) / [avcodec](https://libav.org) to decode and
    28       read audio from almost any format,
    29     - [libsndfile](http://www.mega-nerd.com/libsndfile/) to read audio from
    30       uncompressed sound files,
    31     - [libsamplerate](http://www.mega-nerd.com/SRC/) to re-sample audio signals
    32     - [CoreAudio](https://developer.apple.com/reference/coreaudio) to read all
    33       media files supported natively on macOS, iOS, and tvOS.
    34 
    35 - hardware acceleration:
    36 
    37     - [Atlas](http://math-atlas.sourceforge.net/) and
    38       [Blas](https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms),
    39       for accelerated vector and matrix computations,
    40     - [fftw3](http://fftw.org), to compute fast Fourier Transforms of any size.
    41     - [Accelerate](https://developer.apple.com/reference/accelerate) for
    42       hardware accelerated FFT and matrix computations on macOs and iOS,
    43     - [Intel IPP](https://software.intel.com/en-us/intel-ipp), accelerated
    44       vector computation and FFT implementation,
    45 
    46 Documentation
    47 -------------
     18Links
     19-----
    4820
    4921- [module documentation][doc_python]
    50 - [installation][doc_python_install]
     22- [installation instructions][doc_python_install]
    5123- [aubio manual][manual]
    5224- [aubio homepage][homepage]
     25- [issue tracker][bugtracker]
    5326
    54 [manual]: https://aubio.org/manual/latest/
    55 [doc_python]: https://aubio.org/manual/latest/python.html
    56 [doc_python_install]: https://aubio.org/manual/latest/python_module.html
    57 [homepage]: https://aubio.org
    58 [NumPy]: https://www.numpy.org
     27Demos
     28-----
    5929
    60 Demos scripts
    61 -------------
    62 
    63 Some examples are available in the [`python/demos`][demos_dir] folder. These
    64 scripts are small programs written in python and using python-aubio.
     30Some examples are available in the [`python/demos`][demos_dir] folder. Each
     31script is a command line program which accepts one ore more argument.
    6532
    6633**Notes**: installing additional modules is required to run some of the demos.
     
    9663    $ python demo_timestretch_online.py loop.wav stretched_loop.wav 0.92
    9764
     65Built with
     66----------
     67
     68The core of aubio is written in C for portability and speed. In addition to
     69[NumPy], aubio can be optionally built to use one or more of the following
     70libraries:
     71
     72- media file reading:
     73
     74    - [ffmpeg] / [avcodec] to decode and read audio from almost any format,
     75    - [libsndfile] to read audio from uncompressed sound files,
     76    - [libsamplerate] to re-sample audio signals,
     77    - [CoreAudio] to read all media formats supported by macOS, iOS, and tvOS.
     78
     79- hardware acceleration:
     80
     81    - [Atlas] and [Blas], for accelerated vector and matrix computations,
     82    - [fftw3], to compute fast Fourier Transforms of any size,
     83    - [Accelerate] for accelerated FFT and matrix computations (macOS/iOS),
     84    - [Intel IPP], accelerated vector computation and FFT implementation.
     85
     86[ffmpeg]: https://ffmpeg.org
     87[avcodec]: https://libav.org
     88[libsndfile]: http://www.mega-nerd.com/libsndfile/
     89[libsamplerate]: http://www.mega-nerd.com/SRC/
     90[CoreAudio]: https://developer.apple.com/reference/coreaudio
     91[Atlas]: http://math-atlas.sourceforge.net/
     92[Blas]: https://en.wikipedia.org/wiki/Basic_Linear_Algebra_Subprograms
     93[fftw3]: http://fftw.org
     94[Accelerate]: https://developer.apple.com/reference/accelerate
     95[Intel IPP]: https://software.intel.com/en-us/intel-ipp
     96
    9897[demos_dir]:https://github.com/aubio/aubio/tree/master/python/demos
    9998[pyaudio]:https://people.csail.mit.edu/hubert/pyaudio/
     
    101100[pyalsaaudio]:https://larsimmisch.github.io/pyalsaaudio/
    102101[mido]:https://mido.readthedocs.io
     102
     103[manual]: https://aubio.org/manual/latest/
     104[doc_python]: https://aubio.org/manual/latest/python.html
     105[doc_python_install]: https://aubio.org/manual/latest/python_module.html
     106[homepage]: https://aubio.org
     107[NumPy]: https://www.numpy.org
     108[bugtracker]: https://github.com/aubio/aubio/issues
    103109[matplotlib]:https://matplotlib.org/
Note: See TracChangeset for help on using the changeset viewer.