python/lib/gen_code.py

   1 aubiodefvalue = {
   2     # we have some clean up to do
   3     'buf_size': 'Py_default_vector_length',
   4     'win_s': 'Py_default_vector_length',
   5     'size': 'Py_default_vector_length',
   6     # and here too
   7     'hop_size': 'Py_default_vector_length / 2',
   8     'hop_s': 'Py_default_vector_length / 2',
   9     # these should be alright
  10     'samplerate': 'Py_aubio_default_samplerate',
  11     # now for the non obvious ones
  12     'n_filters': '40',
  13     'n_coeffs': '13',
  14     'nelems': '10',
  15     'flow': '0.',
  16     'fhig': '1.',
  17     'ilow': '0.',
  18     'ihig': '1.',
  19     'thrs': '0.5',
  20     'ratio': '0.5',
  21     'method': '"default"',
  22     'uri': '"none"',
  23     }
  24
  25 member_types = {
  26         'name': 'type',
  27         'char_t*': 'T_STRING',
  28         'uint_t': 'T_INT',
  29         'smpl_t': 'AUBIO_NPY_SMPL',
  30         }
  31
  32 pyfromtype_fn = {
  33         'smpl_t': 'PyFloat_FromDouble',
  34         'uint_t': 'PyLong_FromLong', # was: 'PyInt_FromLong',
  35         'fvec_t*': 'PyAubio_CFvecToArray',
  36         'fmat_t*': 'PyAubio_CFmatToArray',
  37         }
  38
  39 pytoaubio_fn = {
  40         'fvec_t*': 'PyAubio_ArrayToCFvec',
  41         'cvec_t*': 'PyAubio_PyCvecToCCvec',
  42         #'fmat_t*': 'PyAubio_ArrayToCFmat',
  43         }
  44
  45 newfromtype_fn = {
  46         'fvec_t*': 'new_py_fvec',
  47         'fmat_t*': 'new_py_fmat',
  48         'cvec_t*': 'new_py_cvec',
  49         }
  50
  51 delfromtype_fn = {
  52         'fvec_t*': 'Py_DECREF',
  53         'fmat_t*': 'Py_DECREF',
  54         'cvec_t*': 'Py_DECREF',
  55         }
  56
  57 param_init = {
  58         'char_t*': 'NULL',
  59         'uint_t': '0',
  60         'sint_t': 0,
  61         'smpl_t': 0.,
  62         'lsmp_t': 0.,
  63         }
  64
  65 pyargparse_chars = {
  66         'smpl_t': 'f', # if not usedouble else 'd',
  67         'uint_t': 'I',
  68         'sint_t': 'I',
  69         'char_t*': 's',
  70         'fmat_t*': 'O',
  71         'fvec_t*': 'O',
  72         'cvec_t*': 'O',
  73         }
  74
  75 objoutsize = {
  76         'onset': '1',
  77         'pitch': '1',
  78         'notes': '3',
  79         'wavetable': 'self->hop_size',
  80         'sampler': 'self->hop_size',
  81         'mfcc': 'self->n_coeffs',
  82         'specdesc': '1',
  83         'tempo': '1',
  84         'filterbank': 'self->n_filters',
  85         'tss': 'self->buf_size',
  86         'dct': 'self->size',
  87         }
  88
  89 objinputsize = {
  90         'mfcc': 'self->buf_size / 2 + 1',
  91         'notes': 'self->hop_size',
  92         'onset': 'self->hop_size',
  93         'pitch': 'self->hop_size',
  94         'sampler': 'self->hop_size',
  95         'specdesc': 'self->buf_size / 2 + 1',
  96         'tempo': 'self->hop_size',
  97         'wavetable': 'self->hop_size',
  98         'tss': 'self->buf_size / 2 + 1',
  99         }
 100
 101 def get_name(proto):
 102     name = proto.replace(' *', '* ').split()[1].split('(')[0]
 103     name = name.replace('*','')
 104     if name == '': raise ValueError(proto + "gave empty name")
 105     return name
 106
 107 def get_return_type(proto):
 108     import re
 109     paramregex = re.compile('(\w+ ?\*?).*')
 110     outputs = paramregex.findall(proto)
 111     assert len(outputs) == 1
 112     return outputs[0].replace(' ', '')
 113
 114 def split_type(arg):
 115     """ arg = 'foo *name'
 116         return ['foo*', 'name'] """
 117     l = arg.split()
 118     type_arg = {} #'type': l[0], 'name': l[1]}
 119     type_arg['type'] = " ".join(l[:-1])
 120     type_arg['name'] = l[-1]
 121     # fix up type / name
 122     if type_arg['name'].startswith('*'):
 123         # ['foo', '*name'] -> ['foo*', 'name']
 124         type_arg['type'] += '*'
 125         type_arg['name'] = type_arg['name'][1:]
 126     if type_arg['type'].endswith(' *'):
 127         # ['foo *', 'name'] -> ['foo*', 'name']
 128         type_arg['type'] = type_arg['type'].replace(' *','*')
 129     if type_arg['type'].startswith('const '):
 130         # ['foo *', 'name'] -> ['foo*', 'name']
 131         type_arg['type'] = type_arg['type'].replace('const ','')
 132     return type_arg
 133
 134 def get_params(proto):
 135     """ get the list of parameters from a function prototype
 136     example: proto = "int main (int argc, char ** argv)"
 137     returns: ['int argc', 'char ** argv']
 138     """
 139     import re
 140     paramregex = re.compile('.*\((.*)\);')
 141     a = paramregex.findall(proto)[0].split(', ')
 142     #a = [i.replace('const ', '') for i in a]
 143     return a
 144
 145 def get_input_params(proto):
 146     a = get_params(proto)
 147     return [i.replace('const ', '') for i in a if (i.startswith('const ') or i.startswith('uint_t ') or i.startswith('smpl_t '))]
 148
 149 def get_output_params(proto):
 150     a = get_params(proto)
 151     return [i for i in a if not i.startswith('const ')][1:]
 152
 153 def get_params_types_names(proto):
 154     """ get the list of parameters from a function prototype
 155     example: proto = "int main (int argc, char ** argv)"
 156     returns: [['int', 'argc'], ['char **','argv']]
 157     """
 158     a = list(map(split_type, get_params(proto)))
 159     #print proto, a
 160     #import sys; sys.exit(1)
 161     return a
 162
 163 class MappedObject(object):
 164
 165     def __init__(self, prototypes, usedouble = False):
 166         if usedouble:
 167             pyargparse_chars['smpl_t'] = 'd'
 168         self.prototypes = prototypes
 169
 170         self.shortname = prototypes['shortname']
 171         self.longname = prototypes['longname']
 172         self.new_proto = prototypes['new'][0]
 173         self.del_proto = prototypes['del'][0]
 174         self.do_proto = prototypes['do'][0]
 175         self.input_params = get_params_types_names(self.new_proto)
 176         self.input_params_list = "; ".join(get_input_params(self.new_proto))
 177         self.outputs = get_params_types_names(self.do_proto)[2:]
 178         self.do_inputs = [get_params_types_names(self.do_proto)[1]]
 179         self.do_outputs = get_params_types_names(self.do_proto)[2:]
 180         struct_output_str = ["PyObject *{0[name]}; {1} c_{0[name]}".format(i, i['type'][:-1]) for i in self.do_outputs]
 181         if len(self.prototypes['rdo']):
 182             rdo_outputs = get_params_types_names(prototypes['rdo'][0])[2:]
 183             struct_output_str += ["PyObject *{0[name]}; {1} c_{0[name]}".format(i, i['type'][:-1]) for i in rdo_outputs]
 184             self.outputs += rdo_outputs
 185         self.struct_outputs = ";\n    ".join(struct_output_str)
 186
 187         #print ("input_params: ", map(split_type, get_input_params(self.do_proto)))
 188         #print ("output_params", map(split_type, get_output_params(self.do_proto)))
 189
 190     def gen_code(self):
 191         out = ""
 192         try:
 193             out += self.gen_struct()
 194             out += self.gen_doc()
 195             out += self.gen_new()
 196             out += self.gen_init()
 197             out += self.gen_del()
 198             out += self.gen_do()
 199             if len(self.prototypes['rdo']):
 200                 self.do_proto = self.prototypes['rdo'][0]
 201                 self.do_inputs = [get_params_types_names(self.do_proto)[1]]
 202                 self.do_outputs = get_params_types_names(self.do_proto)[2:]
 203                 out += self.gen_do(method='rdo')
 204             out += self.gen_memberdef()
 205             out += self.gen_set()
 206             out += self.gen_get()
 207             out += self.gen_methodef()
 208             out += self.gen_typeobject()
 209         except Exception as e:
 210             print ("Failed generating code for", self.shortname)
 211             raise
 212         return out
 213
 214     def gen_struct(self):
 215         out = """
 216 // {shortname} structure
 217 typedef struct{{
 218     PyObject_HEAD
 219     // pointer to aubio object
 220     {longname} *o;
 221     // input parameters
 222     {input_params_list};
 223     // do input vectors
 224     {do_inputs_list};
 225     // output results
 226     {struct_outputs};
 227 }} Py_{shortname};
 228 """
 229         # fmat_t* / fvec_t* / cvec_t* inputs -> full fvec_t /.. struct in Py_{shortname}
 230         do_inputs_list = "; ".join(get_input_params(self.do_proto)).replace('fvec_t *','fvec_t').replace('fmat_t *', 'fmat_t').replace('cvec_t *', 'cvec_t')
 231         return out.format(do_inputs_list = do_inputs_list, **self.__dict__)
 232
 233     def gen_doc(self):
 234         out = """
 235 // TODO: add documentation
 236 static char Py_{shortname}_doc[] = \"undefined\";
 237 """
 238         return out.format(**self.__dict__)
 239
 240     def gen_new(self):
 241         out = """
 242 // new {shortname}
 243 static PyObject *
 244 Py_{shortname}_new (PyTypeObject * pytype, PyObject * args, PyObject * kwds)
 245 {{
 246     Py_{shortname} *self;
 247 """.format(**self.__dict__)
 248         params = self.input_params
 249         for p in params:
 250             out += """
 251     {type} {name} = {defval};""".format(defval = param_init[p['type']], **p)
 252         plist = ", ".join(["\"%s\"" % p['name'] for p in params])
 253         out += """
 254     static char *kwlist[] = {{ {plist}, NULL }};""".format(plist = plist)
 255         argchars = "".join([pyargparse_chars[p['type']] for p in params])
 256         arglist = ", ".join(["&%s" % p['name'] for p in params])
 257         out += """
 258     if (!PyArg_ParseTupleAndKeywords (args, kwds, "|{argchars}", kwlist,
 259               {arglist})) {{
 260         return NULL;
 261     }}
 262 """.format(argchars = argchars, arglist = arglist)
 263         out += """
 264     self = (Py_{shortname} *) pytype->tp_alloc (pytype, 0);
 265     if (self == NULL) {{
 266         return NULL;
 267     }}
 268 """.format(**self.__dict__)
 269         params = self.input_params
 270         for p in params:
 271             out += self.check_valid(p)
 272         out += """
 273     return (PyObject *)self;
 274 }
 275 """
 276         return out
 277
 278     def check_valid(self, p):
 279         if p['type'] == 'uint_t':
 280             return self.check_valid_uint(p)
 281         if p['type'] == 'char_t*':
 282             return self.check_valid_char(p)
 283         else:
 284             print ("ERROR, no idea how to check %s for validity" % p['type'])
 285
 286     def check_valid_uint(self, p):
 287         name = p['name']
 288         return """
 289     self->{name} = {defval};
 290     if ((sint_t){name} > 0) {{
 291         self->{name} = {name};
 292     }} else if ((sint_t){name} < 0) {{
 293         PyErr_SetString (PyExc_ValueError, "can not use negative value for {name}");
 294         return NULL;
 295     }}
 296 """.format(defval = aubiodefvalue[name], name = name)
 297
 298     def check_valid_char(self, p):
 299         name = p['name']
 300         return """
 301     self->{name} = {defval};
 302     if ({name} != NULL) {{
 303         self->{name} = {name};
 304     }}
 305 """.format(defval = aubiodefvalue[name], name = name)
 306
 307     def gen_init(self):
 308         out = """
 309 // init {shortname}
 310 static int
 311 Py_{shortname}_init (Py_{shortname} * self, PyObject * args, PyObject * kwds)
 312 {{
 313 """.format(**self.__dict__)
 314         new_name = get_name(self.new_proto)
 315         new_params = ", ".join(["self->%s" % s['name'] for s in self.input_params])
 316         out += """
 317   self->o = {new_name}({new_params});
 318 """.format(new_name = new_name, new_params = new_params)
 319         paramchars = "%s"
 320         paramvals = "self->method"
 321         out += """
 322   // return -1 and set error string on failure
 323   if (self->o == NULL) {{
 324     PyErr_Format (PyExc_RuntimeError, "failed creating {shortname}");
 325     return -1;
 326   }}
 327 """.format(paramchars = paramchars, paramvals = paramvals, **self.__dict__)
 328         output_create = ""
 329         for o in self.outputs:
 330             output_create += """
 331   self->{name} = {create_fn}({output_size});""".format(name = o['name'], create_fn = newfromtype_fn[o['type']], output_size = objoutsize[self.shortname])
 332         out += """
 333   // TODO get internal params after actual object creation?
 334 """
 335         out += """
 336   // create outputs{output_create}
 337 """.format(output_create = output_create)
 338         out += """
 339   return 0;
 340 }
 341 """
 342         return out
 343
 344     def gen_memberdef(self):
 345         out = """
 346 static PyMemberDef Py_{shortname}_members[] = {{
 347 """.format(**self.__dict__)
 348         for p in get_params_types_names(self.new_proto):
 349             tmp = "  {{\"{name}\", {ttype}, offsetof (Py_{shortname}, {name}), READONLY, \"TODO documentation\"}},\n"
 350             pytype = member_types[p['type']]
 351             out += tmp.format(name = p['name'], ttype = pytype, shortname = self.shortname)
 352         out += """  {NULL}, // sentinel
 353 };
 354 """
 355         return out
 356
 357     def gen_del(self):
 358         out = """
 359 // del {shortname}
 360 static void
 361 Py_{shortname}_del  (Py_{shortname} * self, PyObject * unused)
 362 {{""".format(**self.__dict__)
 363         for input_param in self.do_inputs:
 364             if input_param['type'] == 'fmat_t *':
 365                 out += """
 366   free(self->{0[name]}.data);""".format(input_param)
 367         for o in self.outputs:
 368             name = o['name']
 369             del_out = delfromtype_fn[o['type']]
 370             out += """
 371   if (self->{name}) {{
 372     {del_out}(self->{name});
 373   }}""".format(del_out = del_out, name = name)
 374         del_fn = get_name(self.del_proto)
 375         out += """
 376   if (self->o) {{
 377     {del_fn}(self->o);
 378   }}
 379   Py_TYPE(self)->tp_free((PyObject *) self);
 380 }}
 381 """.format(del_fn = del_fn)
 382         return out
 383
 384     def gen_do(self, method = 'do'):
 385         out = """
 386 // do {shortname}
 387 static PyObject*
 388 Pyaubio_{shortname}_{method}  (Py_{shortname} * self, PyObject * args)
 389 {{""".format(method = method, **self.__dict__)
 390         input_params = self.do_inputs
 391         output_params = self.do_outputs
 392         #print input_params
 393         #print output_params
 394         out += """
 395     PyObject *outputs;"""
 396         for input_param in input_params:
 397             out += """
 398     PyObject *py_{0};""".format(input_param['name'])
 399         refs = ", ".join(["&py_%s" % p['name'] for p in input_params])
 400         pyparamtypes = "".join([pyargparse_chars[p['type']] for p in input_params])
 401         out += """
 402     if (!PyArg_ParseTuple (args, "{pyparamtypes}", {refs})) {{
 403         return NULL;
 404     }}""".format(refs = refs, pyparamtypes = pyparamtypes, **self.__dict__)
 405         for input_param in input_params:
 406             out += """
 407
 408     if (!{pytoaubio}(py_{0[name]}, &(self->{0[name]}))) {{
 409         return NULL;
 410     }}""".format(input_param, pytoaubio = pytoaubio_fn[input_param['type']])
 411         if self.shortname in objinputsize:
 412             out += """
 413
 414     if (self->{0[name]}.length != {expected_size}) {{
 415         PyErr_Format (PyExc_ValueError,
 416             "input size of {shortname} should be %d, not %d",
 417             {expected_size}, self->{0[name]}.length);
 418         return NULL;
 419     }}""".format(input_param, expected_size = objinputsize[self.shortname], **self.__dict__)
 420         else:
 421             out += """
 422
 423     // TODO: check input sizes"""
 424         for output_param in output_params:
 425             out += """
 426
 427     Py_INCREF(self->{0[name]});
 428     if (!{pytoaubio}(self->{0[name]}, &(self->c_{0[name]}))) {{
 429         return NULL;
 430     }}""".format(output_param, pytoaubio = pytoaubio_fn[output_param['type']])
 431         do_fn = get_name(self.do_proto)
 432         inputs = ", ".join(['&(self->'+p['name']+')' for p in input_params])
 433         c_outputs = ", ".join(["&(self->c_%s)" % p['name'] for p in self.do_outputs])
 434         outputs = ", ".join(["self->%s" % p['name'] for p in self.do_outputs])
 435         out += """
 436
 437     {do_fn}(self->o, {inputs}, {c_outputs});
 438 """.format(
 439         do_fn = do_fn,
 440         inputs = inputs, c_outputs = c_outputs,
 441         )
 442         if len(self.do_outputs) > 1:
 443             out += """
 444     outputs = PyTuple_New({:d});""".format(len(self.do_outputs))
 445             for i, p in enumerate(self.do_outputs):
 446                 out += """
 447     PyTuple_SetItem( outputs, {i}, self->{p[name]});""".format(i = i, p = p)
 448         else:
 449             out += """
 450     outputs = self->{p[name]};""".format(p = self.do_outputs[0])
 451         out += """
 452
 453     return outputs;
 454 }}
 455 """.format(
 456         outputs = outputs,
 457         )
 458         return out
 459
 460     def gen_set(self):
 461         out = """
 462 // {shortname} setters
 463 """.format(**self.__dict__)
 464         for set_param in self.prototypes['set']:
 465             params = get_params_types_names(set_param)[1]
 466             paramtype = params['type']
 467             method_name = get_name(set_param)
 468             param = method_name.split('aubio_'+self.shortname+'_set_')[-1]
 469             pyparamtype = pyargparse_chars[paramtype]
 470             out += """
 471 static PyObject *
 472 Pyaubio_{shortname}_set_{param} (Py_{shortname} *self, PyObject *args)
 473 {{
 474   uint_t err = 0;
 475   {paramtype} {param};
 476
 477   if (!PyArg_ParseTuple (args, "{pyparamtype}", &{param})) {{
 478     return NULL;
 479   }}
 480   err = aubio_{shortname}_set_{param} (self->o, {param});
 481
 482   if (err > 0) {{
 483     PyErr_SetString (PyExc_ValueError, "error running aubio_{shortname}_set_{param}");
 484     return NULL;
 485   }}
 486   Py_RETURN_NONE;
 487 }}
 488 """.format(param = param, paramtype = paramtype, pyparamtype = pyparamtype, **self.__dict__)
 489         return out
 490
 491     def gen_get(self):
 492         out = """
 493 // {shortname} getters
 494 """.format(**self.__dict__)
 495         for method in self.prototypes['get']:
 496             params = get_params_types_names(method)
 497             method_name = get_name(method)
 498             assert len(params) == 1, \
 499                 "get method has more than one parameter %s" % params
 500             param = method_name.split('aubio_'+self.shortname+'_get_')[-1]
 501             paramtype = get_return_type(method)
 502             ptypeconv = pyfromtype_fn[paramtype]
 503             out += """
 504 static PyObject *
 505 Pyaubio_{shortname}_get_{param} (Py_{shortname} *self, PyObject *unused)
 506 {{
 507   {ptype} {param} = aubio_{shortname}_get_{param} (self->o);
 508   return (PyObject *){ptypeconv} ({param});
 509 }}
 510 """.format(param = param, ptype = paramtype, ptypeconv = ptypeconv,
 511         **self.__dict__)
 512         return out
 513
 514     def gen_methodef(self):
 515         out = """
 516 static PyMethodDef Py_{shortname}_methods[] = {{""".format(**self.__dict__)
 517         for m in self.prototypes['set']:
 518             name = get_name(m)
 519             shortname = name.replace('aubio_%s_' % self.shortname, '')
 520             out += """
 521   {{"{shortname}", (PyCFunction) Py{name},
 522     METH_VARARGS, ""}},""".format(name = name, shortname = shortname)
 523         for m in self.prototypes['get']:
 524             name = get_name(m)
 525             shortname = name.replace('aubio_%s_' % self.shortname, '')
 526             out += """
 527   {{"{shortname}", (PyCFunction) Py{name},
 528     METH_NOARGS, ""}},""".format(name = name, shortname = shortname)
 529         for m in self.prototypes['rdo']:
 530             name = get_name(m)
 531             shortname = name.replace('aubio_%s_' % self.shortname, '')
 532             out += """
 533   {{"{shortname}", (PyCFunction) Py{name},
 534     METH_VARARGS, ""}},""".format(name = name, shortname = shortname)
 535         out += """
 536   {NULL} /* sentinel */
 537 };
 538 """
 539         return out
 540
 541     def gen_typeobject(self):
 542         return """
 543 PyTypeObject Py_{shortname}Type = {{
 544   //PyObject_HEAD_INIT (NULL)
 545   //0,
 546   PyVarObject_HEAD_INIT (NULL, 0)
 547   "aubio.{shortname}",
 548   sizeof (Py_{shortname}),
 549   0,
 550   (destructor) Py_{shortname}_del,
 551   0,
 552   0,
 553   0,
 554   0,
 555   0,
 556   0,
 557   0,
 558   0,
 559   0,
 560   (ternaryfunc)Pyaubio_{shortname}_do,
 561   0,
 562   0,
 563   0,
 564   0,
 565   Py_TPFLAGS_DEFAULT,
 566   Py_{shortname}_doc,
 567   0,
 568   0,
 569   0,
 570   0,
 571   0,
 572   0,
 573   Py_{shortname}_methods,
 574   Py_{shortname}_members,
 575   0,
 576   0,
 577   0,
 578   0,
 579   0,
 580   0,
 581   (initproc) Py_{shortname}_init,
 582   0,
 583   Py_{shortname}_new,
 584   0,
 585   0,
 586   0,
 587   0,
 588   0,
 589   0,
 590   0,
 591   0,
 592   0,
 593 }};
 594 """.format(**self.__dict__)