Showing the changes to python/ext/py-source.c (1 of 2 files). Show all
Unified · Split
| @@ -10,7 +10,64 @@ typedef struct · 9 unmodified lines | ||
| 10 | 10 | uint_t hop_size; |
| 11 | 11 | } Py_source; |
| 12 | 12 | |
| 13 | −static char Py_source_doc[] = "source object"; | |
| 13 | +static char Py_source_doc[] = "" | |
| 14 | +" __new__(path, samplerate = 0, hop_size = 512, channels = 1)\n" | |
| 15 | +"\n" | |
| 16 | +" Create a new source, opening the given path for reading.\n" | |
| 17 | +"\n" | |
| 18 | +" Examples\n" | |
| 19 | +" --------\n" | |
| 20 | +"\n" | |
| 21 | +" Create a new source, using the original samplerate, with hop_size = 512:\n" | |
| 22 | +"\n" | |
| 23 | +" >>> source('/tmp/t.wav')\n" | |
| 24 | +"\n" | |
| 25 | +" Create a new source, resampling the original to 8000Hz:\n" | |
| 26 | +"\n" | |
| 27 | +" >>> source('/tmp/t.wav', samplerate = 8000)\n" | |
| 28 | +"\n" | |
| 29 | +" Create a new source, resampling it at 32000Hz, hop_size = 32:\n" | |
| 30 | +"\n" | |
| 31 | +" >>> source('/tmp/t.wav', samplerate = 32000, hop_size = 32)\n" | |
| 32 | +"\n" | |
| 33 | +" Create a new source, using its original samplerate:\n" | |
| 34 | +"\n" | |
| 35 | +" >>> source('/tmp/t.wav', samplerate = 0)\n" | |
| 36 | +"\n" | |
| 37 | +" __call__()\n" | |
| 38 | +" vec, read = x() <==> vec, read = x.do()\n" | |
| 39 | +"\n" | |
| 40 | +" Read vector from source.\n" | |
| 41 | +"\n" | |
| 42 | +" See also\n" | |
| 43 | +" --------\n" | |
| 44 | +" aubio.source.do\n" | |
| 45 | +"\n"; | |
| 46 | + | |
| 47 | +static char Py_source_get_samplerate_doc[] = "" | |
| 48 | +"x.get_samplerate() -> source samplerate\n" | |
| 49 | +"\n" | |
| 50 | +"Get samplerate of source."; | |
| 51 | + | |
| 52 | +static char Py_source_get_channels_doc[] = "" | |
| 53 | +"x.get_channels() -> number of channels\n" | |
| 54 | +"\n" | |
| 55 | +"Get number of channels in source."; | |
| 56 | + | |
| 57 | +static char Py_source_do_doc[] = "" | |
| 58 | +"vec, read = x.do() <==> vec, read = x()\n" | |
| 59 | +"\n" | |
| 60 | +"Read monophonic vector from source."; | |
| 61 | + | |
| 62 | +static char Py_source_do_multi_doc[] = "" | |
| 63 | +"mat, read = x.do_multi()\n" | |
| 64 | +"\n" | |
| 65 | +"Read polyphonic vector from source."; | |
| 66 | + | |
| 67 | +static char Py_source_close_doc[] = "" | |
| 68 | +"x.close()\n" | |
| 69 | +"\n" | |
| 70 | +"Close this source now."; | |
| 14 | 71 | |
| 15 | 72 | static PyObject * |
| 16 | 73 | Py_source_new (PyTypeObject * pytype, PyObject * args, PyObject * kwds) |
| @@ -135,10 +192,14 @@ Py_source_do_multi(Py_source * self, PyObject * args) · 118 unmodified lines | ||
| 135 | 192 | } |
| 136 | 193 | |
| 137 | 194 | AUBIO_MEMBERS_START(source) |
| 138 | − {"uri", T_STRING, offsetof (Py_source, uri), READONLY, ""}, | |
| 139 | − {"samplerate", T_INT, offsetof (Py_source, samplerate), READONLY, ""}, | |
| 140 | − {"channels", T_INT, offsetof (Py_source, channels), READONLY, ""}, | |
| 141 | − {"hop_size", T_INT, offsetof (Py_source, hop_size), READONLY, ""}, | |
| 195 | + {"uri", T_STRING, offsetof (Py_source, uri), READONLY, | |
| 196 | + "path at which the source was created"}, | |
| 197 | + {"samplerate", T_INT, offsetof (Py_source, samplerate), READONLY, | |
| 198 | + "samplerate at which the source is viewed"}, | |
| 199 | + {"channels", T_INT, offsetof (Py_source, channels), READONLY, | |
| 200 | + "number of channels found in the source"}, | |
| 201 | + {"hop_size", T_INT, offsetof (Py_source, hop_size), READONLY, | |
| 202 | + "number of consecutive frames that will be read at each do or do_multi call"}, | |
| 142 | 203 | AUBIO_MEMBERS_STOP(source) |
| 143 | 204 | |
| 144 | 205 | |
| @@ -165,13 +226,15 @@ Pyaubio_source_close (Py_source *self, PyObject *unused) · 20 unmodified lines | ||
| 165 | 226 | |
| 166 | 227 | static PyMethodDef Py_source_methods[] = { |
| 167 | 228 | {"get_samplerate", (PyCFunction) Pyaubio_source_get_samplerate, |
| 168 | − METH_NOARGS, ""}, | |
| 229 | + METH_NOARGS, Py_source_get_samplerate_doc}, | |
| 169 | 230 | {"get_channels", (PyCFunction) Pyaubio_source_get_channels, |
| 170 | − METH_NOARGS, ""}, | |
| 231 | + METH_NOARGS, Py_source_get_channels_doc}, | |
| 232 | + {"do", (PyCFunction) Py_source_do, | |
| 233 | + METH_NOARGS, Py_source_do_doc}, | |
| 171 | 234 | {"do_multi", (PyCFunction) Py_source_do_multi, |
| 172 | − METH_NOARGS, ""}, | |
| 235 | + METH_NOARGS, Py_source_do_multi_doc}, | |
| 173 | 236 | {"close", (PyCFunction) Pyaubio_source_close, |
| 174 | − METH_NOARGS, ""}, | |
| 237 | + METH_NOARGS, Py_source_close_doc}, | |
| 175 | 238 | {NULL} /* sentinel */ |
| 176 | 239 | }; |
| 177 | 240 | |