source: python/ext/py-musicutils.h @ 665b711

feature/autosinkfeature/constantqfeature/pitchshiftfeature/pydocstringsfeature/timestretchpitchshiftsamplertimestretchyinfft+
Last change on this file since 665b711 was 665b711, checked in by Paul Brossier <piem@piem.org>, 5 years ago

ext/py-musicutils.h: add doc for level_lin and db_spl

  • Property mode set to 100644
File size: 1.1 KB
Line 
1#ifndef _PY_AUBIO_MUSICUTILS_H_
2#define _PY_AUBIO_MUSICUTILS_H_
3
4static char Py_aubio_window_doc[] = ""
5"window(string, integer) -> fvec\n"
6"\n"
7"Create a window\n"
8"\n"
9"Example\n"
10"-------\n"
11"\n"
12">>> window('hanningz', 1024)\n"
13"array([  0.00000000e+00,   9.41753387e-06,   3.76403332e-05, ...,\n"
14"         8.46982002e-05,   3.76403332e-05,   9.41753387e-06], dtype=float32)";
15
16PyObject * Py_aubio_window(PyObject *self, PyObject *args);
17
18static char Py_aubio_level_lin_doc[] = ""
19"level_lin(fvec) -> fvec\n"
20"\n"
21"Compute sound level on a linear scale.\n"
22"\n"
23"This gives the average of the square amplitudes.\n"
24"\n"
25"Example\n"
26"-------\n"
27"\n"
28">>> level_Lin(numpy.ones(1024))\n"
29"1.0";
30
31PyObject * Py_aubio_level_lin(PyObject *self, PyObject *args);
32
33static char Py_aubio_db_spl_doc[] = ""
34"Compute sound pressure level (SPL) in dB\n"
35"\n"
36"This quantity is often wrongly called 'loudness'.\n"
37"\n"
38"This gives ten times the log10 of the average of the square amplitudes.\n"
39"\n"
40"Example\n"
41"-------\n"
42"\n"
43">>> db_spl(numpy.ones(1024))\n"
44"1.0";
45
46PyObject * Py_aubio_db_spl(PyObject *self, PyObject *args);
47
48#endif /* _PY_AUBIO_MUSICUTILS_H_ */
Note: See TracBrowser for help on using the repository browser.