Changeset 665b711

Timestamp:

Jul 10, 2015, 2:25:47 AM (9 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

feature/autosink, feature/cnn, feature/cnn_org, feature/constantq, feature/crepe, feature/crepe_org, feature/pitchshift, feature/pydocstrings, feature/timestretch, fix/ffmpeg5, master, pitchshift, sampler, timestretch, yinfft+

Children:

31a09d2

Parents:

4615886a

Message:

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

File:

• python/ext/py-musicutils.h (modified) (1 diff)

python/ext/py-musicutils.h

@@ -16 +16 @@
 PyObject * Py_aubio_window(PyObject *self, PyObject *args);
 
+static char Py_aubio_level_lin_doc[] = ""
+"level_lin(fvec) -> fvec\n"
+"\n"
+"Compute sound level on a linear scale.\n"
+"\n"
+"This gives the average of the square amplitudes.\n"
+"\n"
+"Example\n"
+"-------\n"
+"\n"
+">>> level_Lin(numpy.ones(1024))\n"
+"1.0";
+
+PyObject * Py_aubio_level_lin(PyObject *self, PyObject *args);
+
+static char Py_aubio_db_spl_doc[] = ""
+"Compute sound pressure level (SPL) in dB\n"
+"\n"
+"This quantity is often wrongly called 'loudness'.\n"
+"\n"
+"This gives ten times the log10 of the average of the square amplitudes.\n"
+"\n"
+"Example\n"
+"-------\n"
+"\n"
+">>> db_spl(numpy.ones(1024))\n"
+"1.0";
+
+PyObject * Py_aubio_db_spl(PyObject *self, PyObject *args);
+
 #endif /* _PY_AUBIO_MUSICUTILS_H_ */