[doc] add py_utils
[aubio.git] / doc / py_utils.rst
1 .. default-domain:: py
2 .. currentmodule:: aubio
3
4 Utilities
5 ---------
6
7 This section documents various helpers functions included in the aubio library.
8
9 Note name conversion
10 ....................
11
12 .. midiconv.py
13
14 .. autofunction:: note2midi
15
16 .. autofunction:: midi2note
17
18 .. autofunction:: freq2note
19
20 .. autofunction:: note2freq
21
22 Frequency conversion
23 ....................
24
25 .. python/ext/ufuncs.c
26
27 .. autofunction:: freqtomidi
28
29 .. autofunction:: miditofreq
30
31 .. python/ext/aubiomodule.c
32
33 .. autofunction:: bintomidi
34 .. autofunction:: miditobin
35 .. autofunction:: bintofreq
36 .. autofunction:: freqtobin
37
38 Audio file slicing
39 ..................
40
41 .. slicing.py
42
43 .. autofunction:: slice_source_at_stamps
44
45 Windowing
46 .........
47
48 .. python/ext/py-musicutils.h
49
50 .. autofunction:: window
51
52 Audio level detection
53 .....................
54
55 .. python/ext/py-musicutils.h
56
57 .. autofunction:: level_lin
58 .. autofunction:: db_spl
59 .. autofunction:: silence_detection
60 .. autofunction:: level_detection
61
62 Vector utilities
63 ................
64
65 .. python/ext/aubiomodule.c
66
67 .. autofunction:: alpha_norm
68 .. autofunction:: zero_crossing_rate
69 .. autofunction:: min_removal
70
71 .. python/ext/py-musicutils.h
72
73 .. autofunction:: shift
74 .. autofunction:: ishift
75
76 .. python/ext/ufuncs.c
77
78 .. autofunction:: unwrap2pi