4 # Python ctypes bindings for VLC
5 # Copyright (C) 2009 the VideoLAN team
8 # Authors: Olivier Aubert <olivier.aubert at liris.cnrs.fr>
10 # This program is free software; you can redistribute it and/or modify
11 # it under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 2 of the License, or
13 # (at your option) any later version.
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License
21 # along with this program; if not, write to the Free Software
22 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 """This module provides bindings for the
26 U{libvlc<http://wiki.videolan.org/ExternalAPI>} and
27 U{MediaControl<http://wiki.videolan.org/MediaControlAPI>} APIs.
29 You can find documentation at U{http://www.advene.org/download/python-ctypes/}.
31 Basically, the most important class is L{Instance}, which is used to
32 create a libvlc Instance. From this instance, you can then create
33 L{MediaPlayer} and L{MediaListPlayer} instances.
39 build_date="This will be replaced by the build date"
41 if sys.platform == 'linux2':
42 dll=ctypes.CDLL('libvlc.so')
43 elif sys.platform == 'win32':
47 path=ctypes.util.find_library('libvlc.dll')
49 # Try to use registry settings
51 plugin_path_found = None
52 subkey, name = 'Software\\VideoLAN\\VLC','InstallDir'
53 for hkey in _winreg.HKEY_LOCAL_MACHINE, _winreg.HKEY_CURRENT_USER:
55 reg = _winreg.OpenKey(hkey, subkey)
56 plugin_path_found, type_id = _winreg.QueryValueEx(reg, name)
62 plugin_path = plugin_path_found
64 # Try a standard location.
65 p='c:\\Program Files\\VideoLAN\\VLC\\libvlc.dll'
67 plugin_path=os.path.dirname(p)
69 # If chdir failed, this will not work and raise an exception
72 plugin_path=os.path.dirname(path)
74 elif sys.platform == 'darwin':
75 # FIXME: should find a means to configure path
76 dll=ctypes.CDLL('/Applications/VLC.app/Contents/MacOS/lib/libvlc.2.dylib')
78 class ListPOINTER(object):
79 '''Just like a POINTER but accept a list of ctype as an argument.
81 def __init__(self, etype):
84 def from_param(self, param):
85 if isinstance(param, (list,tuple)):
86 return (self.etype * len(param))(*param)
88 class LibVLCException(Exception):
89 """Python exception raised by libvlc methods.
93 # From libvlc_structures.h
95 # This is version-dependent, depending on the presence of libvlc_exception_get_message.
97 if hasattr(dll, 'libvlc_exception_get_message'):
98 # New-style message passing
99 class VLCException(ctypes.Structure):
103 ('raised', ctypes.c_int),
108 return dll.libvlc_exception_get_message()
111 libvlc_exception_init(self)
114 libvlc_exception_clear(self)
116 # Old-style exceptions
117 class VLCException(ctypes.Structure):
121 ('raised', ctypes.c_int),
122 ('code', ctypes.c_int),
123 ('message', ctypes.c_char_p),
126 libvlc_exception_init(self)
129 libvlc_exception_clear(self)
131 class PlaylistItem(ctypes.Structure):
133 ('id', ctypes.c_int),
134 ('uri', ctypes.c_char_p),
135 ('name', ctypes.c_char_p),
139 return "PlaylistItem #%d %s (%uri)" % (self.id, self.name, self.uri)
141 class LogMessage(ctypes.Structure):
143 ('size', ctypes.c_uint),
144 ('severity', ctypes.c_int),
145 ('type', ctypes.c_char_p),
146 ('name', ctypes.c_char_p),
147 ('header', ctypes.c_char_p),
148 ('message', ctypes.c_char_p),
152 return "vlc.LogMessage(%d:%s): %s" % (self.severity, self.type, self.message)
154 class MediaControlPosition(ctypes.Structure):
156 ('origin', ctypes.c_int),
157 ('key', ctypes.c_int),
158 ('value', ctypes.c_longlong),
162 return "MediaControlPosition %ld (%s, %s)" % (
164 str(PositionOrigin(self.origin)),
165 str(PositionKey(self.key))
170 if isinstance(arg, (int, long)):
171 p=MediaControlPosition()
178 class MediaControlException(ctypes.Structure):
180 ('code', ctypes.c_int),
181 ('message', ctypes.c_char_p),
184 mediacontrol_exception_init(self)
187 mediacontrol_exception_free(self)
189 class MediaControlStreamInformation(ctypes.Structure):
191 ('status', ctypes.c_int),
192 ('url', ctypes.c_char_p),
193 ('position', ctypes.c_longlong),
194 ('length', ctypes.c_longlong),
198 return "%s (%s) : %ld / %ld" % (self.url,
199 str(PlayerStatus(self.status)),
203 class RGBPicture(ctypes.Structure):
205 ('width', ctypes.c_int),
206 ('height', ctypes.c_int),
207 ('type', ctypes.c_uint32),
208 ('date', ctypes.c_ulonglong),
209 ('size', ctypes.c_int),
210 ('data_pointer', ctypes.c_void_p),
215 return ctypes.string_at(self.data_pointer, self.size)
218 return "RGBPicture (%d, %d) - %ld ms - %d bytes" % (self.width, self.height, self.date, self.size)
221 mediacontrol_RGBPicture__free(self)
223 def check_vlc_exception(result, func, args):
224 """Error checking method for functions using an exception in/out parameter.
227 # Take into account both VLCException and MediacontrolException:
228 c=getattr(ex, 'raised', getattr(ex, 'code', 0))
230 raise LibVLCException(args[-1].message)
233 ### End of header.py ###