6 Read `Contribute`_ to report issues and request new features.
8 See `Doxygen documentation`_ for the complete documentation of the C library,
9 built using `Doxygen <http://www.doxygen.org/>`_.
11 Below is a brief `Library overview`_.
16 Here is a brief overview of the C library. See also the `Doxygen
17 documentation`_ for a more detailed list of available functions.
22 ``fvec_t`` are used to hold vectors of float (``smpl_t``).
24 .. literalinclude:: ../tests/src/test-fvec.c
33 vec->data[vec->length-2] = 1.;
35 Similarly, ``fmat_t`` are used to hold matrix of floats.
37 .. literalinclude:: ../tests/src/test-fmat.c
43 In this example, ``aubio_source`` is used to read a media file.
45 First, create the objects we need.
47 .. literalinclude:: ../tests/src/io/test-source.c
49 :lines: 22-24, 30-32, 34
52 With ``samplerate = 0``, ``aubio_source`` will be created with the file's
55 Now for the processing loop:
57 .. literalinclude:: ../tests/src/io/test-source.c
61 At the end of the processing loop, clean-up and de-allocate memory:
63 .. literalinclude:: ../tests/src/io/test-source.c
67 See the complete example: :download:`test-source.c
68 <../tests/src/io/test-source.c>`.
70 Computing the spectrum
71 ``````````````````````
73 Now let's create a phase vocoder:
75 .. literalinclude:: ../tests/src/spectral/test-phasevoc.c
79 The processing loop could now look like:
81 .. literalinclude:: ../tests/src/spectral/test-phasevoc.c
85 See the complete example: :download:`test-phasevoc.c
86 <../tests/src/spectral/test-phasevoc.c>`.
88 .. _doxygen-documentation:
93 The latest version of the doxygen documentation is available at:
95 https://aubio.org/doc/latest
100 Please report any issue and feature request at the `Github issue tracker
101 <https://github.com/aubio/aubio/issues>`_. Patches and pull-requests welcome!