[py] add minimal docstring to fft

[aubio.git] / python / ext / py-fft.c

diff --git a/python/ext/py-fft.c b/python/ext/py-fft.c
index de05ef7..a08af4e 100644 (file)
--- a/python/ext/py-fft.c
+++ b/python/ext/py-fft.c
@@ -1,6 +1,24 @@
 #include "aubio-types.h"
 
-static char Py_fft_doc[] = "fft object";
+static char Py_fft_doc[] = ""
+"fft(size=1024)\n"
+"\n"
+"Compute Fast Fourier Transorms.\n"
+"\n"
+"Parameters\n"
+"----------\n"
+"size : int\n"
+"    size of the FFT to compute\n"
+"\n"
+"Example\n"
+"-------\n"
+">>> x = aubio.fvec(512)\n"
+">>> f = aubio.fft(512)\n"
+">>> c = f(x); c\n"
+"aubio cvec of 257 elements\n"
+">>> x2 = f.rdo(c); x2.shape\n"
+"(512,)\n"
+"";
 
 typedef struct
 {
@@ -51,9 +69,8 @@ Py_fft_init (Py_fft * self, PyObject * args, PyObject * kwds)
 {
   self->o = new_aubio_fft (self->win_s);
   if (self->o == NULL) {
-    char_t errstr[30];
-    sprintf(errstr, "error creating fft with win_s=%d", self->win_s);
-    PyErr_SetString (PyExc_Exception, errstr);
+    // PyErr_Format(PyExc_RuntimeError, ...) was set above by new_ which called
+    // AUBIO_ERR when failing
     return -1;
   }
 
@@ -68,7 +85,9 @@ Py_fft_del (Py_fft *self, PyObject *unused)
 {
   Py_XDECREF(self->doout);
   Py_XDECREF(self->rdoout);
-  del_aubio_fft(self->o);
+  if (self->o) {
+    del_aubio_fft(self->o);
+  }
   Py_TYPE(self)->tp_free((PyObject *) self);
 }
 
@@ -76,6 +95,7 @@ static PyObject *
 Py_fft_do(Py_fft * self, PyObject * args)
 {
   PyObject *input;
+  cvec_t c_out;
 
   if (!PyArg_ParseTuple (args, "O", &input)) {
     return NULL;
@@ -87,12 +107,11 @@ Py_fft_do(Py_fft * self, PyObject * args)
 
   if (self->vecin.length != self->win_s) {
     PyErr_Format(PyExc_ValueError,
-                 "input array has length %d, but fft has size %d",
+                 "input array has length %d, but fft expects length %d",
                  self->vecin.length, self->win_s);
     return NULL;
   }
 
-  cvec_t c_out;
   Py_INCREF(self->doout);
   if (!PyAubio_PyCvecToCCvec(self->doout, &c_out)) {
     return NULL;
@@ -112,6 +131,7 @@ static PyObject *
 Py_fft_rdo(Py_fft * self, PyObject * args)
 {
   PyObject *input;
+  fvec_t out;
 
   if (!PyArg_ParseTuple (args, "O", &input)) {
     return NULL;
@@ -121,7 +141,13 @@ Py_fft_rdo(Py_fft * self, PyObject * args)
     return NULL;
   }
 
-  fvec_t out;
+  if (self->cvecin.length != self->win_s / 2 + 1) {
+    PyErr_Format(PyExc_ValueError,
+                 "input cvec has length %d, but fft expects length %d",
+                 self->cvecin.length, self->win_s / 2 + 1);
+    return NULL;
+  }
+
   Py_INCREF(self->rdoout);
   if (!PyAubio_ArrayToCFvec(self->rdoout, &out) ) {
     return NULL;
@@ -176,4 +202,13 @@ PyTypeObject Py_fftType = {
   (initproc) Py_fft_init,
   0,
   Py_fft_new,
+  0,
+  0,
+  0,
+  0,
+  0,
+  0,
+  0,
+  0,
+  0,
 };