5 # Code generator for python ctypes bindings for VLC
6 # Copyright (C) 2009 the VideoLAN team
9 # Authors: Olivier Aubert <olivier.aubert at liris.cnrs.fr>
11 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 2 of the License, or
14 # (at your option) any later version.
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with this program; if not, write to the Free Software
23 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26 """This module parses VLC public API include files and generates
27 corresponding python/ctypes code. Moreover, it generates class
28 wrappers for most methods.
37 # DefaultDict from ASPN python cookbook
39 class DefaultDict(dict):
40 """Dictionary with a default value for unknown keys."""
41 def __init__(self, default=None, **items):
42 dict.__init__(self, **items)
43 self.default = default
45 def __getitem__(self, key):
49 ## Need copy in case self.default is something like []
50 return self.setdefault(key, copy.deepcopy(self.default))
53 return DefaultDict(self.default, **self)
55 # Methods not decorated/not referenced
57 "libvlc_exception_raise",
58 "libvlc_exception_raised",
59 "libvlc_exception_get_message",
60 "libvlc_get_vlc_instance",
62 "libvlc_media_add_option_flag",
63 "libvlc_media_list_view_index_of_item",
64 "libvlc_media_list_view_insert_at_index",
65 "libvlc_media_list_view_remove_at_index",
66 "libvlc_media_list_view_add_item",
68 # In svn but not in current 1.0.0
69 'libvlc_video_set_deinterlace',
70 'libvlc_video_get_marquee_option_as_int',
71 'libvlc_video_get_marquee_option_as_string',
72 'libvlc_video_set_marquee_option_as_int',
73 'libvlc_video_set_marquee_option_as_string',
74 'libvlc_vlm_get_event_manager',
76 'mediacontrol_PlaylistSeq__free',
79 "libvlc_event_detach",
80 "libvlc_event_attach",
84 api_re=re.compile('VLC_PUBLIC_API\s+(\S+\s+.+?)\s*\(\s*(.+?)\s*\)')
85 param_re=re.compile('\s*(const\s*|unsigned\s*|struct\s*)?(\S+\s*\**)\s+(.+)')
86 paramlist_re=re.compile('\s*,\s*')
87 comment_re=re.compile('\\param\s+(\S+)')
88 python_param_re=re.compile('(@param\s+\S+)(.+)')
89 forward_re=re.compile('.+\(\s*(.+?)\s*\)(\s*\S+)')
90 enum_re=re.compile('typedef\s+(enum)\s*(\S+\s*)?\{\s*(.+)\s*\}\s*(\S+);')
92 # Definition of parameter passing mode for types. This should not be
93 # hardcoded this way, but works alright ATM.
94 parameter_passing=DefaultDict(default=1)
95 parameter_passing['libvlc_exception_t*']=3
97 # C-type to ctypes/python type conversion.
98 # Note that enum types conversions are generated (cf convert_enum_names)
100 'libvlc_exception_t*': 'ctypes.POINTER(VLCException)',
102 'libvlc_media_player_t*': 'MediaPlayer',
103 'libvlc_instance_t*': 'Instance',
104 'libvlc_media_t*': 'Media',
105 'libvlc_log_t*': 'Log',
106 'libvlc_log_iterator_t*': 'LogIterator',
107 'libvlc_log_message_t*': 'LogMessage',
108 'libvlc_event_type_t': 'EventType',
109 'libvlc_event_manager_t*': 'EventManager',
110 'libvlc_media_discoverer_t*': 'MediaDiscoverer',
111 'libvlc_media_library_t*': 'MediaLibrary',
112 'libvlc_media_list_t*': 'MediaList',
113 'libvlc_media_list_player_t*': 'MediaListPlayer',
114 'libvlc_media_list_view_t*': 'MediaListView',
115 'libvlc_track_description_t*': 'TrackDescription',
116 'libvlc_audio_output_t*': 'AudioOutput',
118 'mediacontrol_Instance*': 'MediaControl',
119 'mediacontrol_Exception*': 'MediaControlException',
120 'mediacontrol_RGBPicture*': 'RGBPicture',
121 'mediacontrol_PlaylistSeq*': 'MediaControlPlaylistSeq',
122 'mediacontrol_Position*': 'MediaControlPosition',
123 'mediacontrol_StreamInformation*': 'MediaControlStreamInformation',
124 'WINDOWHANDLE': 'ctypes.c_ulong',
127 'void*': 'ctypes.c_void_p',
128 'short': 'ctypes.c_short',
129 'char*': 'ctypes.c_char_p',
130 'char**': 'ListPOINTER(ctypes.c_char_p)',
131 'uint32_t': 'ctypes.c_uint',
132 'float': 'ctypes.c_float',
133 'unsigned': 'ctypes.c_uint',
134 'int': 'ctypes.c_int',
135 '...': 'FIXMEva_list',
136 'libvlc_callback_t': 'FIXMEcallback',
137 'libvlc_time_t': 'ctypes.c_longlong',
140 # Defined python classes, i.e. classes for which we want to generate
141 # class wrappers around libvlc functions
160 #'MediaControlPosition',
161 #'MediaControlStreamInformation',
164 # Definition of prefixes that we can strip from method names when
165 # wrapping them into class methods
166 prefixes=dict( (v, k[:-2]) for (k, v) in typ2class.iteritems() if v in defined_classes )
167 prefixes['MediaControl']='mediacontrol_'
170 """Parse a C parameter expression.
172 It is used to parse both the type/name for methods, and type/name
173 for their parameters.
175 It returns a tuple (type, name).
178 s=s.replace('const', '')
179 if 'VLC_FORWARD' in s:
180 m=forward_re.match(s)
181 s=m.group(1)+m.group(2)
184 const, typ, name=m.groups()
185 while name.startswith('*'):
189 # K&R definition: const char * const*
191 typ=typ.replace(' ', '')
194 # K&R definition: only type
195 return s.replace(' ', ''), ''
197 def generate_header(classes=None):
198 """Generate header code.
200 f=open('header.py', 'r')
202 if 'build_date' in l:
203 print 'build_date="%s"' % time.ctime()
208 def convert_enum_names(enums):
210 for (typ, name, values, comment) in enums:
212 raise Exception('This method only handles enums')
213 pyname=re.findall('(libvlc|mediacontrol)_(.+?)(_t)?$', name)[0][1]
215 pyname=pyname.title().replace('_', '')
217 pyname=pyname.capitalize()
221 def generate_enums(enums):
222 for (typ, name, values, comment) in enums:
224 raise Exception('This method only handles enums')
225 pyname=typ2class[name]
227 print "class %s(ctypes.c_uint):" % pyname
228 print ' """%s\n """' % comment
231 # Convert symbol names
235 # Single character. Some symbols use 1_1, 5_1, etc.
236 n="_".join( k.split('_')[:-2] )
237 if re.match('^[0-9]', n):
238 # Cannot start an identifier with a number
243 print " %s=%s" % (conv[k], v)
247 print " %s: '%s'," % (v, conv[k])
252 return ".".join((self.__class__.__module__, self.__class__.__name__, self._names[self.value]))
255 def parse_typedef(name):
256 """Parse include file for typedef expressions.
258 This generates a tuple for each typedef:
259 (type, name, value_list, comment)
260 with type == 'enum' (for the moment) and value_list being a list of (name, value)
261 Note that values are string, since this is intended for code generation.
266 # Note: lstrip() should not be necessary, but there is 1 badly
267 # formatted comment in vlc1.0.0 includes
268 if l.lstrip().startswith('/**'):
271 elif l.startswith(' * '):
272 comment = comment + l[3:]
278 accumulator=" ".join( (accumulator, l) )
283 elif l.startswith('typedef enum') and not l.endswith(';'):
284 # Multiline definition. Accumulate until end of definition
291 (typ, dummy, data, name)=m.groups()
292 for i, l in enumerate(paramlist_re.split(data)):
294 if l.startswith('/*'):
297 # A value was specified. Use it.
298 values.append(re.split('\s*=\s*', l))
301 values.append( (l, str(i)) )
302 comment=comment.replace('@{', '').replace('@see', 'See').replace('\ingroup', '')
303 yield (typ, name, values, comment)
306 def parse_include(name):
307 """Parse include file.
309 This generates a tuple for each function:
310 (return_type, method_name, parameter_list, comment)
311 with parameter_list being a list of tuples (parameter_type, parameter_name).
317 # Note: lstrip() should not be necessary, but there is 1 badly
318 # formatted comment in vlc1.0.0 includes
319 if l.lstrip().startswith('/**'):
322 elif l.startswith(' * '):
323 comment = comment + l[3:]
329 accumulator=" ".join( (accumulator, l) )
334 elif l.startswith('VLC_PUBLIC_API') and not l.endswith(');'):
335 # Multiline definition. Accumulate until end of definition
341 (ret, param)=m.groups()
343 rtype, method=parse_param(ret)
346 for p in paramlist_re.split(param):
347 params.append( parse_param(p) )
349 if len(params) == 1 and params[0][0] == 'void':
350 # Empty parameter list
353 if list(p for p in params if not p[1]):
354 # Empty parameter names. Have to poke into comment.
355 names=comment_re.findall(comment)
356 if len(names) < len(params):
357 # Bad description: all parameters are not specified.
358 # Generate default parameter names
359 badnames=[ "param%d" % i for i in xrange(len(params)) ]
360 # Put in the existing ones
361 for (i, p) in enumerate(names):
364 print "### Error ###"
365 print "### Cannot get parameter names from comment for %s: %s" % (method, comment.replace("\n", ' '))
366 # Note: this was previously
367 # raise Exception("Cannot get parameter names from comment for %s: %s" % (method, comment))
368 # but it prevented code generation for a minor detail (some bad descriptions).
369 params=[ (p[0], names[i]) for (i, p) in enumerate(params) ]
371 for typ, name in params:
372 if not typ in typ2class:
373 raise Exception("No conversion for %s (from %s:%s)" % (typ, method, name))
375 # Transform Doxygen syntax into epydoc syntax
376 comment=comment.replace('\\param', '@param').replace('\\return', '@return')
379 print '********************'
382 print "%s (%s)" % (method, rtype)
383 for typ, name in params:
384 print " %s (%s)" % (name, typ)
385 print '********************'
392 def output_ctypes(rtype, method, params, comment):
393 """Output ctypes decorator for the given method.
395 if method in blacklist:
400 print "prototype=ctypes.CFUNCTYPE(%s, %s)" % (typ2class.get(rtype, 'FIXME_%s' % rtype),
401 ",".join( typ2class[p[0]] for p in params ))
403 print "prototype=ctypes.CFUNCTYPE(%s)" % typ2class.get(rtype, 'FIXME_%s' % rtype)
407 flags='paramflags= tuple()'
408 elif len(params) == 1:
409 flags="paramflags=( (%d, ), )" % parameter_passing[params[0][0]]
411 flags="paramflags=%s" % ",".join( '(%d,)' % parameter_passing[p[0]] for p in params )
413 print '%s = prototype( ("%s", dll), paramflags )' % (method, method)
415 # A VLCException is present. Process it.
416 print "%s.errcheck = check_vlc_exception" % method
417 print '%s.__doc__ = """%s"""' % (method, comment)
420 def parse_override(name):
421 """Parse override definitions file.
423 It is possible to override methods definitions in classes.
426 (code, overriden_methods, docstring)
434 m=re.match('class (\S+):', l)
437 if current is not None:
438 code[current]="".join(data)
443 code[current]="".join(data)
447 for k, v in code.iteritems():
448 if v.lstrip().startswith('"""'):
449 # Starting comment. Use it as docstring.
450 dummy, docstring[k], code[k]=v.split('"""', 2)
452 # Not robust wrt. internal methods, but this works for the moment.
453 overridden_methods=dict( (k, re.findall('^\s+def\s+(\w+)', v, re.MULTILINE)) for (k, v) in code.iteritems() )
455 return code, overridden_methods, docstring
457 def fix_python_comment(c):
458 """Fix comment by removing first and last parameters (self and exception)
460 data=c.replace('@{', '').replace('@see', 'See').splitlines()
461 body=itertools.takewhile(lambda l: not '@param' in l and not '@return' in l, data)
462 param=[ python_param_re.sub('\\1:\\2', l) for l in itertools.ifilter(lambda l: '@param' in l, data) ]
463 ret=[ l.replace('@return', '@return:') for l in itertools.ifilter(lambda l: '@return' in l, data) ]
467 elif len(param) == 1:
470 return "\n".join(itertools.chain(body, param, ret))
472 def generate_wrappers(methods):
473 """Generate class wrappers for all appropriate methods.
475 @return: the set of wrapped method names
478 # Sort methods against the element they apply to.
479 elements=sorted( ( (typ2class.get(params[0][0]), rt, met, params, c)
480 for (rt, met, params, c) in methods
481 if params and typ2class.get(params[0][0], '_') in defined_classes
483 key=operator.itemgetter(0))
485 overrides, overriden_methods, docstring=parse_override('override.py')
487 for classname, el in itertools.groupby(elements, key=operator.itemgetter(0)):
488 print """class %(name)s(object):""" % {'name': classname}
489 if classname in docstring:
490 print ' """%s\n """' % docstring[classname]
493 def __new__(cls, pointer=None):
494 '''Internal method used for instanciating wrappers from ctypes.
497 raise Exception("Internal method. You should instanciate objects through other class methods (probably named 'new' or ending with 'new')")
501 o=object.__new__(cls)
502 o._as_parameter_=ctypes.c_void_p(pointer)
507 '''(INTERNAL) ctypes parameter conversion method.
509 return arg._as_parameter_
510 """ % {'name': classname}
512 if classname in overrides:
513 print overrides[classname]
515 prefix=prefixes.get(classname, '')
517 for cl, rtype, method, params, comment in el:
518 if method in blacklist:
521 name=method.replace(prefix, '').replace('libvlc_', '')
523 if name in overriden_methods.get(cl, []):
524 # Method already defined in override.py
528 params[0]=(params[0][0], 'self')
529 if params and params[-1][0] in ('libvlc_exception_t*', 'mediacontrol_Exception*'):
530 args=", ".join( p[1] for p in params[:-1] )
532 args=", ".join( p[1] for p in params )
534 print " def %s(%s):" % (name, args)
535 print ' """%s\n """' % fix_python_comment(comment)
536 if params and params[-1][0] == 'libvlc_exception_t*':
538 print " e=VLCException()"
539 print " return %s(%s, e)" % (method, args)
540 elif params and params[-1][0] == 'mediacontrol_Exception*':
542 print " e=MediaControlException()"
543 print " return %s(%s, e)" % (method, args)
545 print " return %s(%s)" % (method, args)
548 # Check for standard methods
550 # There is a count method. Generate a __len__ one.
551 print " def __len__(self):"
552 print " e=VLCException()"
553 print " return %s(self, e)" % method
555 elif name.endswith('item_at_index'):
556 # Indexable (and thus iterable)"
557 print " def __getitem__(self, i):"
558 print " e=VLCException()"
559 print " return %s(self, i, e)" % method
561 print " def __iter__(self):"
562 print " e=VLCException()"
563 print " for i in xrange(len(self)):"
564 print " yield self[i]"
569 if __name__ == '__main__':
571 for name in sys.argv[1:]:
572 enums.extend(list(parse_typedef(name)))
573 # Generate python names for enums
574 typ2class.update(convert_enum_names(enums))
577 for name in sys.argv[1:]:
578 methods.extend(list(parse_include(name)))
583 generate_enums(enums)
584 wrapped=generate_wrappers(methods)
588 all=set( t[1] for t in methods )
589 not_wrapped=all.difference(wrapped)
590 print "# Not wrapped methods:"
591 for m in not_wrapped: