raoul/openlp
1
0
Fork 0
forked from openlp/openlp
Code Issues Pull Requests Projects Releases Wiki Activity

- update the vlc.py from master

Browse Source 
bzr-revno: 2226
This commit is contained in:
Andreas Preikschat 2013-04-05 11:03:47 +02:00
commit ed99061078
1 changed files with 130 additions and 97 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

227
openlp/core/ui/media/vendor/vlc.py vendored
View File

@ -48,7 +48,7 @@ import sys
from inspect import getargspec from inspect import getargspec
__version__ = "N/A" __version__ = "N/A"
build_date = "Thu Mar 21 22:33:03 2013" build_date = "Mon Apr 1 23:47:38 2013"
if sys.version_info[0] > 2: if sys.version_info[0] > 2:
str = str str = str
@ -70,7 +70,7 @@ if sys.version_info[0] > 2:
if isinstance(b, bytes): if isinstance(b, bytes):
return b.decode(sys.getfilesystemencoding()) return b.decode(sys.getfilesystemencoding())
else: else:
return str(b) return b
else: else:
str = str str = str
unicode = unicode unicode = unicode
@ -278,6 +278,11 @@ def class_result(classname):
return classname(result) return classname(result)
return wrap_errcheck return wrap_errcheck
# Wrapper for the opaque struct libvlc_log_t
class Log(ctypes.Structure):
pass
Log_ptr = ctypes.POINTER(Log)
# FILE* ctypes wrapper, copied from # FILE* ctypes wrapper, copied from
# http://svn.python.org/projects/ctypes/trunk/ctypeslib/ctypeslib/contrib/pythonhdr.py # http://svn.python.org/projects/ctypes/trunk/ctypeslib/ctypeslib/contrib/pythonhdr.py
class FILE(ctypes.Structure): class FILE(ctypes.Structure):
@ -675,11 +680,14 @@ class Callback(ctypes.c_void_p):
pass pass
class LogCb(ctypes.c_void_p): class LogCb(ctypes.c_void_p):
"""Callback prototype for LibVLC log message handler. """Callback prototype for LibVLC log message handler.
\param data data pointer as given to L{libvlc_log_subscribe}() \param data data pointer as given to L{libvlc_log_set}()
\param level message level (@ref enum libvlc_log_level) \param level message level (@ref enum libvlc_log_level)
\param ctx message context (meta-informations about the message)
\param fmt printf() format string (as defined by ISO C11) \param fmt printf() format string (as defined by ISO C11)
\param args variable argument list for the format \param args variable argument list for the format
\note Log message handlers <b>must</b> be thread-safe. \note Log message handlers <b>must</b> be thread-safe.
\warning The message context pointer, the format string parameters and the
variable arguments are only valid until the callback returns.
""" """
pass pass
class VideoLockCb(ctypes.c_void_p): class VideoLockCb(ctypes.c_void_p):
@ -813,13 +821,16 @@ class CallbackDecorators(object):
Callback.__doc__ = '''Callback function notification Callback.__doc__ = '''Callback function notification
\param p_event the event triggering the callback \param p_event the event triggering the callback
''' '''
LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, ctypes.c_char_p, ctypes.c_void_p) LogCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ctypes.c_int, Log_ptr, ctypes.c_char_p, ctypes.c_void_p)
LogCb.__doc__ = '''Callback prototype for LibVLC log message handler. LogCb.__doc__ = '''Callback prototype for LibVLC log message handler.
\param data data pointer as given to L{libvlc_log_subscribe}() \param data data pointer as given to L{libvlc_log_set}()
\param level message level (@ref enum libvlc_log_level) \param level message level (@ref enum libvlc_log_level)
\param ctx message context (meta-informations about the message)
\param fmt printf() format string (as defined by ISO C11) \param fmt printf() format string (as defined by ISO C11)
\param args variable argument list for the format \param args variable argument list for the format
\note Log message handlers <b>must</b> be thread-safe. \note Log message handlers <b>must</b> be thread-safe.
\warning The message context pointer, the format string parameters and the
variable arguments are only valid until the callback returns.
''' '''
VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p)) VideoLockCb = ctypes.CFUNCTYPE(ctypes.c_void_p, ctypes.c_void_p, ListPOINTER(ctypes.c_void_p))
VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer. VideoLockCb.__doc__ = '''Callback prototype to allocate and lock a picture buffer.
@ -1407,7 +1418,7 @@ class Instance(_Ctype):
@param name: interface name, or NULL for default. @param name: interface name, or NULL for default.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_add_intf(self, name) return libvlc_add_intf(self, str_to_bytes(name))
def set_user_agent(self, name, http): def set_user_agent(self, name, http):
'''Sets the application name. LibVLC passes this as the user agent string '''Sets the application name. LibVLC passes this as the user agent string
@ -1416,7 +1427,33 @@ class Instance(_Ctype):
@param http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0". @param http: HTTP User Agent, e.g. "FooBar/1.2.3 Python/2.6.0".
@version: LibVLC 1.1.1 or later. @version: LibVLC 1.1.1 or later.
''' '''
return libvlc_set_user_agent(self, name, http) return libvlc_set_user_agent(self, str_to_bytes(name), str_to_bytes(http))
def log_unset(self):
'''Unsets the logging callback for a LibVLC instance. This is rarely needed:
the callback is implicitly unset when the instance is destroyed.
This function will wait for any pending callbacks invocation to complete
(causing a deadlock if called from within the callback).
@version: LibVLC 2.1.0 or later.
'''
return libvlc_log_unset(self)
def log_set(self, data, p_instance):
'''Sets the logging callback for a LibVLC instance.
This function is thread-safe: it will wait for any pending callbacks
invocation to complete.
@param data: opaque data pointer for the callback function @note Some log messages (especially debug) are emitted by LibVLC while is being initialized. These messages cannot be captured with this interface. @warning A deadlock may occur if this function is called from the callback.
@param p_instance: libvlc instance.
@version: LibVLC 2.1.0 or later.
'''
return libvlc_log_set(self, data, p_instance)
def log_set_file(self, stream):
'''Sets up logging to a file.
@param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{log_unset}()).
@version: LibVLC 2.1.0 or later.
'''
return libvlc_log_set_file(self, stream)
def media_new_location(self, psz_mrl): def media_new_location(self, psz_mrl):
'''Create a media with a certain given media resource location, '''Create a media with a certain given media resource location,
@ -1429,7 +1466,7 @@ class Instance(_Ctype):
@param psz_mrl: the media location. @param psz_mrl: the media location.
@return: the newly created media or NULL on error. @return: the newly created media or NULL on error.
''' '''
return libvlc_media_new_location(self, psz_mrl) return libvlc_media_new_location(self, str_to_bytes(psz_mrl))
def media_new_path(self, path): def media_new_path(self, path):
'''Create a media for a certain file path. '''Create a media for a certain file path.
@ -1437,7 +1474,7 @@ class Instance(_Ctype):
@param path: local filesystem path. @param path: local filesystem path.
@return: the newly created media or NULL on error. @return: the newly created media or NULL on error.
''' '''
return libvlc_media_new_path(self, path) return libvlc_media_new_path(self, str_to_bytes(path))
def media_new_fd(self, fd): def media_new_fd(self, fd):
'''Create a media for an already open file descriptor. '''Create a media for an already open file descriptor.
@ -1465,14 +1502,14 @@ class Instance(_Ctype):
@param psz_name: the name of the node. @param psz_name: the name of the node.
@return: the new empty media or NULL on error. @return: the new empty media or NULL on error.
''' '''
return libvlc_media_new_as_node(self, psz_name) return libvlc_media_new_as_node(self, str_to_bytes(psz_name))
def media_discoverer_new_from_name(self, psz_name): def media_discoverer_new_from_name(self, psz_name):
'''Discover media service by name. '''Discover media service by name.
@param psz_name: service name. @param psz_name: service name.
@return: media discover object or NULL in case of error. @return: media discover object or NULL in case of error.
''' '''
return libvlc_media_discoverer_new_from_name(self, psz_name) return libvlc_media_discoverer_new_from_name(self, str_to_bytes(psz_name))
def media_library_new(self): def media_library_new(self):
'''Create an new Media Library object. '''Create an new Media Library object.
@ -1500,7 +1537,7 @@ class Instance(_Ctype):
@return: A NULL-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}(). @return: A NULL-terminated linked list of potential audio output devices. It must be freed it with L{audio_output_device_list_release}().
@version: LibVLC 2.1.0 or later. @version: LibVLC 2.1.0 or later.
''' '''
return libvlc_audio_output_device_list_get(self, aout) return libvlc_audio_output_device_list_get(self, str_to_bytes(aout))
def vlm_release(self): def vlm_release(self):
'''Release the vlm instance related to the given L{Instance}. '''Release the vlm instance related to the given L{Instance}.
@ -1518,7 +1555,7 @@ class Instance(_Ctype):
@param b_loop: Should this broadcast be played in loop ? @param b_loop: Should this broadcast be played in loop ?
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_add_broadcast(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop) return libvlc_vlm_add_broadcast(self, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(psz_output), i_options, ppsz_options, b_enabled, b_loop)
def vlm_add_vod(self, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux): def vlm_add_vod(self, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux):
'''Add a vod, with one input. '''Add a vod, with one input.
@ -1530,14 +1567,14 @@ class Instance(_Ctype):
@param psz_mux: the muxer of the vod media. @param psz_mux: the muxer of the vod media.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_add_vod(self, psz_name, psz_input, i_options, ppsz_options, b_enabled, psz_mux) return libvlc_vlm_add_vod(self, str_to_bytes(psz_name), str_to_bytes(psz_input), i_options, ppsz_options, b_enabled, str_to_bytes(psz_mux))
def vlm_del_media(self, psz_name): def vlm_del_media(self, psz_name):
'''Delete a media (VOD or broadcast). '''Delete a media (VOD or broadcast).
@param psz_name: the media to delete. @param psz_name: the media to delete.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_del_media(self, psz_name) return libvlc_vlm_del_media(self, str_to_bytes(psz_name))
def vlm_set_enabled(self, psz_name, b_enabled): def vlm_set_enabled(self, psz_name, b_enabled):
'''Enable or disable a media (VOD or broadcast). '''Enable or disable a media (VOD or broadcast).
@ -1545,7 +1582,7 @@ class Instance(_Ctype):
@param b_enabled: the new status. @param b_enabled: the new status.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_set_enabled(self, psz_name, b_enabled) return libvlc_vlm_set_enabled(self, str_to_bytes(psz_name), b_enabled)
def vlm_set_output(self, psz_name, psz_output): def vlm_set_output(self, psz_name, psz_output):
'''Set the output for a media. '''Set the output for a media.
@ -1553,7 +1590,7 @@ class Instance(_Ctype):
@param psz_output: the output MRL (the parameter to the "sout" variable). @param psz_output: the output MRL (the parameter to the "sout" variable).
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_set_output(self, psz_name, psz_output) return libvlc_vlm_set_output(self, str_to_bytes(psz_name), str_to_bytes(psz_output))
def vlm_set_input(self, psz_name, psz_input): def vlm_set_input(self, psz_name, psz_input):
'''Set a media's input MRL. This will delete all existing inputs and '''Set a media's input MRL. This will delete all existing inputs and
@ -1562,7 +1599,7 @@ class Instance(_Ctype):
@param psz_input: the input MRL. @param psz_input: the input MRL.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_set_input(self, psz_name, psz_input) return libvlc_vlm_set_input(self, str_to_bytes(psz_name), str_to_bytes(psz_input))
def vlm_add_input(self, psz_name, psz_input): def vlm_add_input(self, psz_name, psz_input):
'''Add a media's input MRL. This will add the specified one. '''Add a media's input MRL. This will add the specified one.
@ -1570,7 +1607,7 @@ class Instance(_Ctype):
@param psz_input: the input MRL. @param psz_input: the input MRL.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_add_input(self, psz_name, psz_input) return libvlc_vlm_add_input(self, str_to_bytes(psz_name), str_to_bytes(psz_input))
def vlm_set_loop(self, psz_name, b_loop): def vlm_set_loop(self, psz_name, b_loop):
'''Set a media's loop status. '''Set a media's loop status.
@ -1578,7 +1615,7 @@ class Instance(_Ctype):
@param b_loop: the new status. @param b_loop: the new status.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_set_loop(self, psz_name, b_loop) return libvlc_vlm_set_loop(self, str_to_bytes(psz_name), b_loop)
def vlm_set_mux(self, psz_name, psz_mux): def vlm_set_mux(self, psz_name, psz_mux):
'''Set a media's vod muxer. '''Set a media's vod muxer.
@ -1586,7 +1623,7 @@ class Instance(_Ctype):
@param psz_mux: the new muxer. @param psz_mux: the new muxer.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_set_mux(self, psz_name, psz_mux) return libvlc_vlm_set_mux(self, str_to_bytes(psz_name), str_to_bytes(psz_mux))
def vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop): def vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop):
'''Edit the parameters of a media. This will delete all existing inputs and '''Edit the parameters of a media. This will delete all existing inputs and
@ -1600,28 +1637,28 @@ class Instance(_Ctype):
@param b_loop: Should this broadcast be played in loop ? @param b_loop: Should this broadcast be played in loop ?
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_change_media(self, psz_name, psz_input, psz_output, i_options, ppsz_options, b_enabled, b_loop) return libvlc_vlm_change_media(self, str_to_bytes(psz_name), str_to_bytes(psz_input), str_to_bytes(psz_output), i_options, ppsz_options, b_enabled, b_loop)
def vlm_play_media(self, psz_name): def vlm_play_media(self, psz_name):
'''Play the named broadcast. '''Play the named broadcast.
@param psz_name: the name of the broadcast. @param psz_name: the name of the broadcast.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_play_media(self, psz_name) return libvlc_vlm_play_media(self, str_to_bytes(psz_name))
def vlm_stop_media(self, psz_name): def vlm_stop_media(self, psz_name):
'''Stop the named broadcast. '''Stop the named broadcast.
@param psz_name: the name of the broadcast. @param psz_name: the name of the broadcast.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_stop_media(self, psz_name) return libvlc_vlm_stop_media(self, str_to_bytes(psz_name))
def vlm_pause_media(self, psz_name): def vlm_pause_media(self, psz_name):
'''Pause the named broadcast. '''Pause the named broadcast.
@param psz_name: the name of the broadcast. @param psz_name: the name of the broadcast.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_pause_media(self, psz_name) return libvlc_vlm_pause_media(self, str_to_bytes(psz_name))
def vlm_seek_media(self, psz_name, f_percentage): def vlm_seek_media(self, psz_name, f_percentage):
'''Seek in the named broadcast. '''Seek in the named broadcast.
@ -1629,7 +1666,7 @@ class Instance(_Ctype):
@param f_percentage: the percentage to seek to. @param f_percentage: the percentage to seek to.
@return: 0 on success, -1 on error. @return: 0 on success, -1 on error.
''' '''
return libvlc_vlm_seek_media(self, psz_name, f_percentage) return libvlc_vlm_seek_media(self, str_to_bytes(psz_name), f_percentage)
def vlm_show_media(self, psz_name): def vlm_show_media(self, psz_name):
'''Return information about the named media as a JSON '''Return information about the named media as a JSON
@ -1643,7 +1680,7 @@ class Instance(_Ctype):
@param psz_name: the name of the media, if the name is an empty string, all media is described. @param psz_name: the name of the media, if the name is an empty string, all media is described.
@return: string with information about named media, or NULL on error. @return: string with information about named media, or NULL on error.
''' '''
return libvlc_vlm_show_media(self, psz_name) return libvlc_vlm_show_media(self, str_to_bytes(psz_name))
def vlm_get_media_instance_position(self, psz_name, i_instance): def vlm_get_media_instance_position(self, psz_name, i_instance):
'''Get vlm_media instance position by name or instance id. '''Get vlm_media instance position by name or instance id.
@ -1651,7 +1688,7 @@ class Instance(_Ctype):
@param i_instance: instance id. @param i_instance: instance id.
@return: position as float or -1. on error. @return: position as float or -1. on error.
''' '''
return libvlc_vlm_get_media_instance_position(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_position(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_time(self, psz_name, i_instance): def vlm_get_media_instance_time(self, psz_name, i_instance):
'''Get vlm_media instance time by name or instance id. '''Get vlm_media instance time by name or instance id.
@ -1659,7 +1696,7 @@ class Instance(_Ctype):
@param i_instance: instance id. @param i_instance: instance id.
@return: time as integer or -1 on error. @return: time as integer or -1 on error.
''' '''
return libvlc_vlm_get_media_instance_time(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_time(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_length(self, psz_name, i_instance): def vlm_get_media_instance_length(self, psz_name, i_instance):
'''Get vlm_media instance length by name or instance id. '''Get vlm_media instance length by name or instance id.
@ -1667,7 +1704,7 @@ class Instance(_Ctype):
@param i_instance: instance id. @param i_instance: instance id.
@return: length of media item or -1 on error. @return: length of media item or -1 on error.
''' '''
return libvlc_vlm_get_media_instance_length(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_length(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_rate(self, psz_name, i_instance): def vlm_get_media_instance_rate(self, psz_name, i_instance):
'''Get vlm_media instance playback rate by name or instance id. '''Get vlm_media instance playback rate by name or instance id.
@ -1675,7 +1712,7 @@ class Instance(_Ctype):
@param i_instance: instance id. @param i_instance: instance id.
@return: playback rate or -1 on error. @return: playback rate or -1 on error.
''' '''
return libvlc_vlm_get_media_instance_rate(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_rate(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_title(self, psz_name, i_instance): def vlm_get_media_instance_title(self, psz_name, i_instance):
'''Get vlm_media instance title number by name or instance id. '''Get vlm_media instance title number by name or instance id.
@ -1684,7 +1721,7 @@ class Instance(_Ctype):
@return: title as number or -1 on error. @return: title as number or -1 on error.
@bug: will always return 0. @bug: will always return 0.
''' '''
return libvlc_vlm_get_media_instance_title(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_title(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_chapter(self, psz_name, i_instance): def vlm_get_media_instance_chapter(self, psz_name, i_instance):
'''Get vlm_media instance chapter number by name or instance id. '''Get vlm_media instance chapter number by name or instance id.
@ -1693,7 +1730,7 @@ class Instance(_Ctype):
@return: chapter as number or -1 on error. @return: chapter as number or -1 on error.
@bug: will always return 0. @bug: will always return 0.
''' '''
return libvlc_vlm_get_media_instance_chapter(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_chapter(self, str_to_bytes(psz_name), i_instance)
def vlm_get_media_instance_seekable(self, psz_name, i_instance): def vlm_get_media_instance_seekable(self, psz_name, i_instance):
'''Is libvlc instance seekable ? '''Is libvlc instance seekable ?
@ -1702,7 +1739,7 @@ class Instance(_Ctype):
@return: 1 if seekable, 0 if not, -1 if media does not exist. @return: 1 if seekable, 0 if not, -1 if media does not exist.
@bug: will always return 0. @bug: will always return 0.
''' '''
return libvlc_vlm_get_media_instance_seekable(self, psz_name, i_instance) return libvlc_vlm_get_media_instance_seekable(self, str_to_bytes(psz_name), i_instance)
def vlm_get_event_manager(self): def vlm_get_event_manager(self):
'''Get libvlc_event_manager from a vlm media. '''Get libvlc_event_manager from a vlm media.
@ -1751,7 +1788,7 @@ class Media(_Ctype):
self.add_option(o) self.add_option(o)
def add_option(self, ppsz_options): def add_option(self, psz_options):
'''Add an option to the media. '''Add an option to the media.
This option will be used to determine how the media_player will This option will be used to determine how the media_player will
read the media. This allows to use VLC's advanced read the media. This allows to use VLC's advanced
@ -1763,11 +1800,11 @@ class Media(_Ctype):
Specifically, due to architectural issues most audio and video options, Specifically, due to architectural issues most audio and video options,
such as text renderer options, have no effects on an individual media. such as text renderer options, have no effects on an individual media.
These options must be set through L{new}() instead. These options must be set through L{new}() instead.
@param ppsz_options: the options (as a string). @param psz_options: the options (as a string).
''' '''
return libvlc_media_add_option(self, ppsz_options) return libvlc_media_add_option(self, str_to_bytes(psz_options))
def add_option_flag(self, ppsz_options, i_flags): def add_option_flag(self, psz_options, i_flags):
'''Add an option to the media with configurable flags. '''Add an option to the media with configurable flags.
This option will be used to determine how the media_player will This option will be used to determine how the media_player will
read the media. This allows to use VLC's advanced read the media. This allows to use VLC's advanced
@ -1777,10 +1814,10 @@ class Media(_Ctype):
specifically, due to architectural issues, video-related options specifically, due to architectural issues, video-related options
such as text renderer options cannot be set on a single media. They such as text renderer options cannot be set on a single media. They
must be set on the whole libvlc instance instead. must be set on the whole libvlc instance instead.
@param ppsz_options: the options (as a string). @param psz_options: the options (as a string).
@param i_flags: the flags for this option. @param i_flags: the flags for this option.
''' '''
return libvlc_media_add_option_flag(self, ppsz_options, i_flags) return libvlc_media_add_option_flag(self, str_to_bytes(psz_options), i_flags)
def retain(self): def retain(self):
'''Retain a reference to a media descriptor object (libvlc_media_t). Use '''Retain a reference to a media descriptor object (libvlc_media_t). Use
@ -1829,7 +1866,7 @@ class Media(_Ctype):
@param e_meta: the meta to write. @param e_meta: the meta to write.
@param psz_value: the media's meta. @param psz_value: the media's meta.
''' '''
return libvlc_media_set_meta(self, e_meta, psz_value) return libvlc_media_set_meta(self, e_meta, str_to_bytes(psz_value))
def save_meta(self): def save_meta(self):
'''Save the meta previously set. '''Save the meta previously set.
@ -2490,7 +2527,7 @@ class MediaPlayer(_Ctype):
@version: LibVLC 1.1.1 or later. @version: LibVLC 1.1.1 or later.
@bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using L{video_set_format_callbacks}() instead. @bug: All pixel planes are expected to have the same pitch. To use the YCbCr color space with chrominance subsampling, consider using L{video_set_format_callbacks}() instead.
''' '''
return libvlc_video_set_format(self, chroma, width, height, pitch) return libvlc_video_set_format(self, str_to_bytes(chroma), width, height, pitch)
def video_set_format_callbacks(self, setup, cleanup): def video_set_format_callbacks(self, setup, cleanup):
'''Set decoded video chroma and dimensions. This only works in combination with '''Set decoded video chroma and dimensions. This only works in combination with
@ -2617,7 +2654,7 @@ class MediaPlayer(_Ctype):
@param channels: channels count. @param channels: channels count.
@version: LibVLC 2.0.0 or later. @version: LibVLC 2.0.0 or later.
''' '''
return libvlc_audio_set_format(self, format, rate, channels) return libvlc_audio_set_format(self, str_to_bytes(format), rate, channels)
def get_length(self): def get_length(self):
'''Get the current movie length (in ms). '''Get the current movie length (in ms).
@ -2843,7 +2880,7 @@ class MediaPlayer(_Ctype):
'''Set new video aspect ratio. '''Set new video aspect ratio.
@param psz_aspect: new video aspect-ratio or NULL to reset to default @note Invalid aspect ratios are ignored. @param psz_aspect: new video aspect-ratio or NULL to reset to default @note Invalid aspect ratios are ignored.
''' '''
return libvlc_video_set_aspect_ratio(self, psz_aspect) return libvlc_video_set_aspect_ratio(self, str_to_bytes(psz_aspect))
def video_get_spu(self): def video_get_spu(self):
'''Get current video subtitle. '''Get current video subtitle.
@ -2859,7 +2896,7 @@ class MediaPlayer(_Ctype):
def video_set_spu(self, i_spu): def video_set_spu(self, i_spu):
'''Set new video subtitle. '''Set new video subtitle.
@param i_spu: new video subtitle to select. @param i_spu: video subtitle track to select (i_id from track description).
@return: 0 on success, -1 if out of range. @return: 0 on success, -1 if out of range.
''' '''
return libvlc_video_set_spu(self, i_spu) return libvlc_video_set_spu(self, i_spu)
@ -2869,7 +2906,7 @@ class MediaPlayer(_Ctype):
@param psz_subtitle: new video subtitle file. @param psz_subtitle: new video subtitle file.
@return: the success status (boolean). @return: the success status (boolean).
''' '''
return libvlc_video_set_subtitle_file(self, psz_subtitle) return libvlc_video_set_subtitle_file(self, str_to_bytes(psz_subtitle))
def video_get_spu_delay(self): def video_get_spu_delay(self):
'''Get the current subtitle delay. Positive values means subtitles are being '''Get the current subtitle delay. Positive values means subtitles are being
@ -2900,7 +2937,7 @@ class MediaPlayer(_Ctype):
'''Set new crop filter geometry. '''Set new crop filter geometry.
@param psz_geometry: new crop filter geometry (NULL to unset). @param psz_geometry: new crop filter geometry (NULL to unset).
''' '''
return libvlc_video_set_crop_geometry(self, psz_geometry) return libvlc_video_set_crop_geometry(self, str_to_bytes(psz_geometry))
def video_get_teletext(self): def video_get_teletext(self):
'''Get current teletext page requested. '''Get current teletext page requested.
@ -2948,13 +2985,13 @@ class MediaPlayer(_Ctype):
@param i_height: the snapshot's height. @param i_height: the snapshot's height.
@return: 0 on success, -1 if the video was not found. @return: 0 on success, -1 if the video was not found.
''' '''
return libvlc_video_take_snapshot(self, num, psz_filepath, i_width, i_height) return libvlc_video_take_snapshot(self, num, str_to_bytes(psz_filepath), i_width, i_height)
def video_set_deinterlace(self, psz_mode): def video_set_deinterlace(self, psz_mode):
'''Enable or disable deinterlace filter. '''Enable or disable deinterlace filter.
@param psz_mode: type of deinterlace filter, NULL to disable. @param psz_mode: type of deinterlace filter, NULL to disable.
''' '''
return libvlc_video_set_deinterlace(self, psz_mode) return libvlc_video_set_deinterlace(self, str_to_bytes(psz_mode))
def video_get_marquee_int(self, option): def video_get_marquee_int(self, option):
'''Get an integer marquee option value. '''Get an integer marquee option value.
@ -2982,7 +3019,7 @@ class MediaPlayer(_Ctype):
@param option: marq option to set See libvlc_video_marquee_string_option_t. @param option: marq option to set See libvlc_video_marquee_string_option_t.
@param psz_text: marq option value. @param psz_text: marq option value.
''' '''
return libvlc_video_set_marquee_string(self, option, psz_text) return libvlc_video_set_marquee_string(self, option, str_to_bytes(psz_text))
def video_get_logo_int(self, option): def video_get_logo_int(self, option):
'''Get integer logo option. '''Get integer logo option.
@ -3006,7 +3043,7 @@ class MediaPlayer(_Ctype):
@param option: logo option to set, values of libvlc_video_logo_option_t. @param option: logo option to set, values of libvlc_video_logo_option_t.
@param psz_value: logo option value. @param psz_value: logo option value.
''' '''
return libvlc_video_set_logo_string(self, option, psz_value) return libvlc_video_set_logo_string(self, option, str_to_bytes(psz_value))
def video_get_adjust_int(self, option): def video_get_adjust_int(self, option):
'''Get integer adjust option. '''Get integer adjust option.
@ -3049,7 +3086,7 @@ class MediaPlayer(_Ctype):
@param psz_name: name of audio output, use psz_name of See L{AudioOutput}. @param psz_name: name of audio output, use psz_name of See L{AudioOutput}.
@return: 0 if function succeded, -1 on error. @return: 0 if function succeded, -1 on error.
''' '''
return libvlc_audio_output_set(self, psz_name) return libvlc_audio_output_set(self, str_to_bytes(psz_name))
def audio_output_device_set(self, psz_audio_output, psz_device_id): def audio_output_device_set(self, psz_audio_output, psz_device_id):
'''Configures an explicit audio output device for a given audio output plugin. '''Configures an explicit audio output device for a given audio output plugin.
@ -3065,7 +3102,7 @@ class MediaPlayer(_Ctype):
@param psz_device_id: device. @param psz_device_id: device.
@return: Nothing. Errors are ignored. @return: Nothing. Errors are ignored.
''' '''
return libvlc_audio_output_device_set(self, psz_audio_output, psz_device_id) return libvlc_audio_output_device_set(self, str_to_bytes(psz_audio_output), str_to_bytes(psz_device_id))
def audio_toggle_mute(self): def audio_toggle_mute(self):
'''Toggle mute status. '''Toggle mute status.
@ -3314,44 +3351,43 @@ def libvlc_event_type_name(event_type):
ctypes.c_char_p, ctypes.c_uint) ctypes.c_char_p, ctypes.c_uint)
return f(event_type) return f(event_type)
def libvlc_log_subscribe(sub, cb, data): def libvlc_log_unset(p_instance):
'''Registers a logging callback to LibVLC. '''Unsets the logging callback for a LibVLC instance. This is rarely needed:
This function is thread-safe. the callback is implicitly unset when the instance is destroyed.
@param sub: uninitialized subscriber structure. This function will wait for any pending callbacks invocation to complete
(causing a deadlock if called from within the callback).
@param p_instance: libvlc instance.
@version: LibVLC 2.1.0 or later.
'''
f = _Cfunctions.get('libvlc_log_unset', None) or \
_Cfunction('libvlc_log_unset', ((1,),), None,
None, Instance)
return f(p_instance)
def libvlc_log_set(cb, data, p_instance):
'''Sets the logging callback for a LibVLC instance.
This function is thread-safe: it will wait for any pending callbacks
invocation to complete.
@param cb: callback function pointer. @param cb: callback function pointer.
@param data: opaque data pointer for the callback function @note Some log messages (especially debug) are emitted by LibVLC while initializing, before any LibVLC instance even exists. Thus this function does not require a LibVLC instance parameter. @warning As a consequence of not depending on a LibVLC instance, all logging callbacks are shared by all LibVLC instances within the process / address space. This also enables log messages to be emitted by LibVLC components that are not specific to any given LibVLC instance. @warning Do not call this function from within a logging callback. It would trigger a dead lock. @param data: opaque data pointer for the callback function @note Some log messages (especially debug) are emitted by LibVLC while is being initialized. These messages cannot be captured with this interface. @warning A deadlock may occur if this function is called from the callback.
@param p_instance: libvlc instance.
@version: LibVLC 2.1.0 or later. @version: LibVLC 2.1.0 or later.
''' '''
f = _Cfunctions.get('libvlc_log_subscribe', None) or \ f = _Cfunctions.get('libvlc_log_set', None) or \
_Cfunction('libvlc_log_subscribe', ((1,), (1,), (1,),), None, _Cfunction('libvlc_log_set', ((1,), (1,), (1,),), None,
None, ctypes.c_void_p, LogCb, ctypes.c_void_p) None, Instance, LogCb, ctypes.c_void_p)
return f(sub, cb, data) return f(cb, data, p_instance)
def libvlc_log_subscribe_file(sub, stream): def libvlc_log_set_file(p_instance, stream):
'''Registers a logging callback to a file. '''Sets up logging to a file.
@param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{libvlc_log_unsubscribe}()). @param p_instance: libvlc instance.
@param stream: FILE pointer opened for writing (the FILE pointer must remain valid until L{libvlc_log_unset}()).
@version: LibVLC 2.1.0 or later. @version: LibVLC 2.1.0 or later.
''' '''
f = _Cfunctions.get('libvlc_log_subscribe_file', None) or \ f = _Cfunctions.get('libvlc_log_set_file', None) or \
_Cfunction('libvlc_log_subscribe_file', ((1,), (1,),), None, _Cfunction('libvlc_log_set_file', ((1,), (1,),), None,
None, ctypes.c_void_p, FILE_ptr) None, Instance, FILE_ptr)
return f(sub, stream) return f(p_instance, stream)
def libvlc_log_unsubscribe(sub):
'''Deregisters a logging callback from LibVLC.
This function is thread-safe.
@note: After (and only after) L{libvlc_log_unsubscribe}() has returned,
LibVLC warrants that there are no more pending calls of the subscription
callback function.
@warning: Do not call this function from within a logging callback.
It would trigger a dead lock.
@param sub: initialized subscriber structure.
@version: LibVLC 2.1.0 or later.
'''
f = _Cfunctions.get('libvlc_log_unsubscribe', None) or \
_Cfunction('libvlc_log_unsubscribe', ((1,),), None,
None, ctypes.c_void_p)
return f(sub)
def libvlc_module_description_list_release(p_list): def libvlc_module_description_list_release(p_list):
'''Release a list of module descriptions. '''Release a list of module descriptions.
@ -3460,7 +3496,7 @@ def libvlc_media_new_as_node(p_instance, psz_name):
ctypes.c_void_p, Instance, ctypes.c_char_p) ctypes.c_void_p, Instance, ctypes.c_char_p)
return f(p_instance, psz_name) return f(p_instance, psz_name)
def libvlc_media_add_option(p_md, ppsz_options): def libvlc_media_add_option(p_md, psz_options):
'''Add an option to the media. '''Add an option to the media.
This option will be used to determine how the media_player will This option will be used to determine how the media_player will
read the media. This allows to use VLC's advanced read the media. This allows to use VLC's advanced
@ -3473,14 +3509,14 @@ def libvlc_media_add_option(p_md, ppsz_options):
such as text renderer options, have no effects on an individual media. such as text renderer options, have no effects on an individual media.
These options must be set through L{libvlc_new}() instead. These options must be set through L{libvlc_new}() instead.
@param p_md: the media descriptor. @param p_md: the media descriptor.
@param ppsz_options: the options (as a string). @param psz_options: the options (as a string).
''' '''
f = _Cfunctions.get('libvlc_media_add_option', None) or \ f = _Cfunctions.get('libvlc_media_add_option', None) or \
_Cfunction('libvlc_media_add_option', ((1,), (1,),), None, _Cfunction('libvlc_media_add_option', ((1,), (1,),), None,
None, Media, ctypes.c_char_p) None, Media, ctypes.c_char_p)
return f(p_md, ppsz_options) return f(p_md, psz_options)
def libvlc_media_add_option_flag(p_md, ppsz_options, i_flags): def libvlc_media_add_option_flag(p_md, psz_options, i_flags):
'''Add an option to the media with configurable flags. '''Add an option to the media with configurable flags.
This option will be used to determine how the media_player will This option will be used to determine how the media_player will
read the media. This allows to use VLC's advanced read the media. This allows to use VLC's advanced
@ -3491,13 +3527,13 @@ def libvlc_media_add_option_flag(p_md, ppsz_options, i_flags):
such as text renderer options cannot be set on a single media. They such as text renderer options cannot be set on a single media. They
must be set on the whole libvlc instance instead. must be set on the whole libvlc instance instead.
@param p_md: the media descriptor. @param p_md: the media descriptor.
@param ppsz_options: the options (as a string). @param psz_options: the options (as a string).
@param i_flags: the flags for this option. @param i_flags: the flags for this option.
''' '''
f = _Cfunctions.get('libvlc_media_add_option_flag', None) or \ f = _Cfunctions.get('libvlc_media_add_option_flag', None) or \
_Cfunction('libvlc_media_add_option_flag', ((1,), (1,), (1,),), None, _Cfunction('libvlc_media_add_option_flag', ((1,), (1,), (1,),), None,
None, Media, ctypes.c_char_p, ctypes.c_uint) None, Media, ctypes.c_char_p, ctypes.c_uint)
return f(p_md, ppsz_options, i_flags) return f(p_md, psz_options, i_flags)
def libvlc_media_retain(p_md): def libvlc_media_retain(p_md):
'''Retain a reference to a media descriptor object (libvlc_media_t). Use '''Retain a reference to a media descriptor object (libvlc_media_t). Use
@ -4949,12 +4985,12 @@ def libvlc_video_get_spu_description(p_mi):
def libvlc_video_set_spu(p_mi, i_spu): def libvlc_video_set_spu(p_mi, i_spu):
'''Set new video subtitle. '''Set new video subtitle.
@param p_mi: the media player. @param p_mi: the media player.
@param i_spu: new video subtitle to select. @param i_spu: video subtitle track to select (i_id from track description).
@return: 0 on success, -1 if out of range. @return: 0 on success, -1 if out of range.
''' '''
f = _Cfunctions.get('libvlc_video_set_spu', None) or \ f = _Cfunctions.get('libvlc_video_set_spu', None) or \
_Cfunction('libvlc_video_set_spu', ((1,), (1,),), None, _Cfunction('libvlc_video_set_spu', ((1,), (1,),), None,
ctypes.c_int, MediaPlayer, ctypes.c_uint) ctypes.c_int, MediaPlayer, ctypes.c_int)
return f(p_mi, i_spu) return f(p_mi, i_spu)
def libvlc_video_set_subtitle_file(p_mi, psz_subtitle): def libvlc_video_set_subtitle_file(p_mi, psz_subtitle):
@ -5791,7 +5827,7 @@ def libvlc_vlm_get_event_manager(p_instance):
# libvlc_printerr # libvlc_printerr
# libvlc_set_exit_handler # libvlc_set_exit_handler
# 18 function(s) not wrapped as methods: # 15 function(s) not wrapped as methods:
# libvlc_audio_output_device_list_release # libvlc_audio_output_device_list_release
# libvlc_audio_output_list_release # libvlc_audio_output_list_release
# libvlc_clearerr # libvlc_clearerr
@ -5802,9 +5838,6 @@ def libvlc_vlm_get_event_manager(p_instance):
# libvlc_get_changeset # libvlc_get_changeset
# libvlc_get_compiler # libvlc_get_compiler
# libvlc_get_version # libvlc_get_version
# libvlc_log_subscribe
# libvlc_log_subscribe_file
# libvlc_log_unsubscribe
# libvlc_media_tracks_release # libvlc_media_tracks_release
# libvlc_module_description_list_release # libvlc_module_description_list_release
# libvlc_new # libvlc_new