source: python/ext/py-sink.c @ 81abf91

feature/autosinkfeature/cnnfeature/cnn_orgfeature/constantqfeature/crepefeature/crepe_orgfeature/pitchshiftfeature/pydocstringsfeature/timestretchfix/ffmpeg5
Last change on this file since 81abf91 was 0629356, checked in by Paul Brossier <piem@piem.org>, 6 years ago

[python] improve sink.close doc

  • Property mode set to 100644
File size: 6.5 KB
RevLine 
[5652a8c]1#include "aubio-types.h"
[f1100a4]2
3typedef struct
4{
5  PyObject_HEAD
6  aubio_sink_t * o;
7  char_t* uri;
8  uint_t samplerate;
[1a121ca]9  uint_t channels;
[569b363]10  fvec_t write_data;
11  fmat_t mwrite_data;
[f1100a4]12} Py_sink;
13
[a79ec76]14static char Py_sink_doc[] = ""
[d281698]15"sink(path, samplerate=44100, channels=1)\n"
[a79ec76]16"\n"
[d281698]17"Open `path` to write a WAV file.\n"
[a79ec76]18"\n"
[d281698]19"Parameters\n"
20"----------\n"
21"path : str\n"
22"   Pathname of the file to be opened for writing.\n"
23"samplerate : int\n"
24"   Sampling rate of the file, in Hz.\n"
25"channels : int\n"
26"   Number of channels to create the file with.\n"
[a79ec76]27"\n"
[d281698]28"Examples\n"
29"--------\n"
[a79ec76]30"\n"
[d281698]31"Create a new sink at 44100Hz, mono:\n"
[a79ec76]32"\n"
[d281698]33">>> snk = aubio.sink('out.wav')\n"
[a79ec76]34"\n"
[d281698]35"Create a new sink at 32000Hz, stereo, write 100 samples into it:\n"
[a79ec76]36"\n"
[d281698]37">>> snk = aubio.sink('out.wav', samplerate=16000, channels=3)\n"
38">>> snk(aubio.fvec(100), 100)\n"
[a79ec76]39"\n"
[d281698]40"Open a new sink at 48000Hz, stereo, write `1234` samples into it:\n"
[a79ec76]41"\n"
[d281698]42">>> with aubio.sink('out.wav', samplerate=48000, channels=2) as src:\n"
43"...     snk(aubio.fvec(1024), 1024)\n"
44"...     snk(aubio.fvec(210), 210)\n"
45"...\n"
[a79ec76]46"\n"
[d281698]47"See also\n"
48"--------\n"
49"source: read audio samples from a file.\n"
[a79ec76]50"\n";
51
52static char Py_sink_do_doc[] = ""
[d281698]53"do(vec, write)\n"
[a79ec76]54"\n"
[d281698]55"Write a single channel vector to sink.\n"
56"\n"
57"Parameters\n"
58"----------\n"
59"vec : fvec\n"
60"   input vector `(n,)` where `n >= 0`.\n"
61"write : int\n"
62"   Number of samples to write.\n"
63"";
[a79ec76]64
65static char Py_sink_do_multi_doc[] = ""
[d281698]66"do_multi(mat, write)\n"
67"\n"
68"Write a matrix containing vectors from multiple channels to sink.\n"
[a79ec76]69"\n"
[d281698]70"Parameters\n"
71"----------\n"
72"mat : numpy.ndarray\n"
73"   input matrix of shape `(channels, n)`, where `n >= 0`.\n"
74"write : int\n"
75"   Number of frames to write.\n"
76"";
[a79ec76]77
78static char Py_sink_close_doc[] = ""
[d281698]79"close()\n"
80"\n"
81"Close this sink now.\n"
[a79ec76]82"\n"
[0629356]83"By default, the sink will be closed before being deleted.\n"
84"Explicitely closing a sink can be useful to control the number\n"
85"of files simultaneously opened.\n"
[d281698]86"";
[f1100a4]87
88static PyObject *
89Py_sink_new (PyTypeObject * pytype, PyObject * args, PyObject * kwds)
90{
91  Py_sink *self;
92  char_t* uri = NULL;
93  uint_t samplerate = 0;
[1a121ca]94  uint_t channels = 0;
95  static char *kwlist[] = { "uri", "samplerate", "channels", NULL };
[f1100a4]96
[1a121ca]97  if (!PyArg_ParseTupleAndKeywords (args, kwds, "|sII", kwlist,
98          &uri, &samplerate, &channels)) {
[f1100a4]99    return NULL;
100  }
101
102  self = (Py_sink *) pytype->tp_alloc (pytype, 0);
103
104  if (self == NULL) {
105    return NULL;
106  }
107
[b8cedb6]108  self->uri = NULL;
[f1100a4]109  if (uri != NULL) {
[b8cedb6]110    self->uri = (char_t *)malloc(sizeof(char_t) * (strnlen(uri, PATH_MAX) + 1));
111    strncpy(self->uri, uri, strnlen(uri, PATH_MAX) + 1);
[f1100a4]112  }
113
114  self->samplerate = Py_aubio_default_samplerate;
[b81a642]115  if (samplerate != 0) {
[f1100a4]116    self->samplerate = samplerate;
117  }
118
[1a121ca]119  self->channels = 1;
[b81a642]120  if (channels != 0) {
[1a121ca]121    self->channels = channels;
122  }
123
[f1100a4]124  return (PyObject *) self;
125}
126
[1a121ca]127static int
128Py_sink_init (Py_sink * self, PyObject * args, PyObject * kwds)
129{
[b81a642]130  self->o = new_aubio_sink ( self->uri, 0 );
[1a121ca]131  if (self->o == NULL) {
[b81a642]132    // error string was set in new_aubio_sink
133    return -1;
134  }
135  if (aubio_sink_preset_channels(self->o, self->channels) != 0) {
136    // error string was set in aubio_sink_preset_channels
137    return -1;
138  }
139  if (aubio_sink_preset_samplerate(self->o, self->samplerate) != 0) {
140    // error string was set in aubio_sink_preset_samplerate
[1a121ca]141    return -1;
142  }
[b81a642]143
[1a121ca]144  self->samplerate = aubio_sink_get_samplerate ( self->o );
145  self->channels = aubio_sink_get_channels ( self->o );
146
147  return 0;
148}
[f1100a4]149
[5652a8c]150static void
151Py_sink_del (Py_sink *self, PyObject *unused)
152{
153  del_aubio_sink(self->o);
[569b363]154  free(self->mwrite_data.data);
[4f89154]155  if (self->uri) {
156    free(self->uri);
157  }
[5652a8c]158  Py_TYPE(self)->tp_free((PyObject *) self);
159}
[f1100a4]160
161/* function Py_sink_do */
[1a121ca]162static PyObject *
[f1100a4]163Py_sink_do(Py_sink * self, PyObject * args)
164{
165  /* input vectors python prototypes */
166  PyObject * write_data_obj;
167
168  /* input vectors prototypes */
169  uint_t write;
170
171
172  if (!PyArg_ParseTuple (args, "OI", &write_data_obj, &write)) {
173    return NULL;
174  }
175
176  /* input vectors parsing */
[569b363]177  if (!PyAubio_ArrayToCFvec(write_data_obj, &(self->write_data))) {
[f1100a4]178    return NULL;
179  }
180
[1a121ca]181
[f1100a4]182  /* compute _do function */
[569b363]183  aubio_sink_do (self->o, &(self->write_data), write);
[f1100a4]184
185  Py_RETURN_NONE;
186}
187
[a79ec76]188/* function Py_sink_do_multi */
[1a121ca]189static PyObject *
190Py_sink_do_multi(Py_sink * self, PyObject * args)
191{
192  /* input vectors python prototypes */
193  PyObject * write_data_obj;
194
195  /* input vectors prototypes */
196  uint_t write;
197
198
199  if (!PyArg_ParseTuple (args, "OI", &write_data_obj, &write)) {
200    return NULL;
201  }
202
203
204  /* input vectors parsing */
[569b363]205  if (!PyAubio_ArrayToCFmat(write_data_obj, &(self->mwrite_data))) {
[1a121ca]206    return NULL;
207  }
208
209  /* compute _do function */
[569b363]210  aubio_sink_do_multi (self->o, &(self->mwrite_data), write);
[1a121ca]211  Py_RETURN_NONE;
212}
213
[5652a8c]214static PyMemberDef Py_sink_members[] = {
[a79ec76]215  {"uri", T_STRING, offsetof (Py_sink, uri), READONLY,
[d281698]216    "str (read-only): Path at which the sink was created."},
[a79ec76]217  {"samplerate", T_INT, offsetof (Py_sink, samplerate), READONLY,
[d281698]218    "int (read-only): Samplerate at which the sink was created."},
[a79ec76]219  {"channels", T_INT, offsetof (Py_sink, channels), READONLY,
[d281698]220    "int (read-only): Number of channels with which the sink was created."},
[5652a8c]221  { NULL } // sentinel
222};
[f1100a4]223
[7b56229]224static PyObject *
225Pyaubio_sink_close (Py_sink *self, PyObject *unused)
226{
[3cc3fd8]227  aubio_sink_close (self->o);
[7b56229]228  Py_RETURN_NONE;
229}
[f1100a4]230
[fcb6e8c]231static char Pyaubio_sink_enter_doc[] = "";
232static PyObject* Pyaubio_sink_enter(Py_sink *self, PyObject *unused) {
233  Py_INCREF(self);
234  return (PyObject*)self;
235}
236
237static char Pyaubio_sink_exit_doc[] = "";
238static PyObject* Pyaubio_sink_exit(Py_sink *self, PyObject *unused) {
239  return Pyaubio_sink_close(self, unused);
240}
241
[f1100a4]242static PyMethodDef Py_sink_methods[] = {
[a79ec76]243  {"do", (PyCFunction) Py_sink_do, METH_VARARGS, Py_sink_do_doc},
244  {"do_multi", (PyCFunction) Py_sink_do_multi, METH_VARARGS, Py_sink_do_multi_doc},
245  {"close", (PyCFunction) Pyaubio_sink_close, METH_NOARGS, Py_sink_close_doc},
[fcb6e8c]246  {"__enter__", (PyCFunction)Pyaubio_sink_enter, METH_NOARGS,
247    Pyaubio_sink_enter_doc},
248  {"__exit__",  (PyCFunction)Pyaubio_sink_exit, METH_VARARGS,
249    Pyaubio_sink_exit_doc},
[f1100a4]250  {NULL} /* sentinel */
251};
252
[5652a8c]253PyTypeObject Py_sinkType = {
254  PyVarObject_HEAD_INIT (NULL, 0)
255  "aubio.sink",
256  sizeof (Py_sink),
257  0,
258  (destructor) Py_sink_del,
259  0,
260  0,
261  0,
262  0,
263  0,
264  0,
265  0,
266  0,
267  0,
268  (ternaryfunc)Py_sink_do,
269  0,
270  0,
271  0,
272  0,
273  Py_TPFLAGS_DEFAULT,
274  Py_sink_doc,
275  0,
276  0,
277  0,
278  0,
279  0,
280  0,
281  Py_sink_methods,
282  Py_sink_members,
283  0,
284  0,
285  0,
286  0,
287  0,
288  0,
289  (initproc) Py_sink_init,
290  0,
291  Py_sink_new,
[0e70ef9]292  0,
293  0,
294  0,
295  0,
296  0,
297  0,
298  0,
299  0,
300  0,
[5652a8c]301};
Note: See TracBrowser for help on using the repository browser.