vlc_objects.h File Reference

This file defines the vlc_object_t structure and object types. More...

Include dependency graph for vlc_objects.h:

Go to the source code of this file.

Data Structures
struct	vlc_object_t
	The main vlc_object_t structure. More...
Defines
#define	VLC_OBJECT_LIBVLC   (-2)
#define	VLC_OBJECT_MODULE   (-3)
#define	VLC_OBJECT_INTF   (-4)
#define	VLC_OBJECT_PLAYLIST   (-5)
#define	VLC_OBJECT_INPUT   (-7)
#define	VLC_OBJECT_DECODER   (-8)
#define	VLC_OBJECT_VOUT   (-9)
#define	VLC_OBJECT_AOUT   (-10)
#define	VLC_OBJECT_PACKETIZER   (-13)
#define	VLC_OBJECT_ENCODER   (-14)
#define	VLC_OBJECT_ANNOUNCE   (-17)
#define	VLC_OBJECT_OPENGL   (-21)
#define	VLC_OBJECT_OSDMENU   (-28)
#define	VLC_OBJECT_GENERIC   (-666)
#define	FIND_PARENT   0x0001
#define	FIND_CHILD   0x0002
#define	FIND_ANYWHERE   0x0003
#define	FIND_STRICT   0x0010
#define	OBJECT_FLAGS_NODBG   0x0001
#define	OBJECT_FLAGS_QUIET   0x0002
#define	OBJECT_FLAGS_NOINTERACT   0x0004
#define	vlc_object_create(a, b)   __vlc_object_create( VLC_OBJECT(a), b )
#define	vlc_object_set_destructor(a, b)   __vlc_object_set_destructor( VLC_OBJECT(a), b )
#define	vlc_object_detach(a)   __vlc_object_detach( VLC_OBJECT(a) )
#define	vlc_object_attach(a, b)   __vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )
#define	vlc_object_find(a, b, c)   __vlc_object_find( VLC_OBJECT(a),b,c)
#define	vlc_object_find_name(a, b, c)   __vlc_object_find_name( VLC_OBJECT(a),b,c)
#define	vlc_object_yield(a)   __vlc_object_yield( VLC_OBJECT(a) )
#define	vlc_object_release(a)   __vlc_object_release( VLC_OBJECT(a) )
#define	vlc_list_find(a, b, c)   __vlc_list_find( VLC_OBJECT(a),b,c)
#define	vlc_list_children(a)   __vlc_list_children( VLC_OBJECT(a) )
#define	vlc_object_dump(a)   __vlc_object_dump( VLC_OBJECT(a))
#define	vlc_object_lock(obj)   __vlc_object_lock( VLC_OBJECT( obj ) )
#define	vlc_object_unlock(obj)   __vlc_object_unlock( VLC_OBJECT( obj ) )
#define	vlc_object_wait(obj)   __vlc_object_wait( VLC_OBJECT( obj ) )
#define	vlc_object_timedwait(obj, d)   __vlc_object_timedwait( VLC_OBJECT( obj ), d )
#define	vlc_object_signal_unlocked(obj)   __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
#define	vlc_object_signal(obj)   __vlc_object_signal( VLC_OBJECT( obj ) )
#define	vlc_object_kill(a)   __vlc_object_kill( VLC_OBJECT(a) )
#define	vlc_object_alive(a)   __vlc_object_alive( VLC_OBJECT(a) )
#define	vlc_object_waitpipe(a)   __vlc_object_waitpipe( VLC_OBJECT(a) )
#define	vlc_object_lock_and_wait(obj)   __vlc_object_lock_and_wait( VLC_OBJECT(obj) )
Typedefs
typedef void(*)	vlc_destructor_t (struct vlc_object_t *)
Functions
void *	__vlc_object_create (vlc_object_t *, int)
	Allocates and initializes a vlc object.
void	__vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t)
	Set the destructor of a vlc object.
void	__vlc_object_attach (vlc_object_t *, vlc_object_t *)
	attach object to a parent object
void	__vlc_object_detach (vlc_object_t *)
	detach object from its parent
void *	vlc_object_get (int)
	Find an object given its ID.
void *	__vlc_object_find (vlc_object_t *, int, int)
	find a typed object and increment its refcount
void *	__vlc_object_find_name (vlc_object_t *, const char *, int)
	find a named object and increment its refcount
void	__vlc_object_yield (vlc_object_t *)
	Increment an object reference counter.
void	__vlc_object_release (vlc_object_t *)
vlc_list_t *	__vlc_list_find (vlc_object_t *, int, int)
	find a list typed objects and increment their refcount
vlc_list_t *	__vlc_list_children (vlc_object_t *)
	Gets the list of children of an objects, and increment their reference count.
void	vlc_list_release (vlc_list_t *)
void	__vlc_object_dump (vlc_object_t *p_this)
void	__vlc_object_lock (vlc_object_t *)
	Inter-object signaling.
void	__vlc_object_unlock (vlc_object_t *)
void	__vlc_object_wait (vlc_object_t *)
	Waits for the object to be signaled (using vlc_object_signal()).
int	__vlc_object_timedwait (vlc_object_t *, mtime_t)
	Waits for the object to be signaled (using vlc_object_signal()), or for a timer to expire.
void	__vlc_object_signal_unlocked (vlc_object_t *)
	Signals an object for which the lock is held.
static void	__vlc_object_signal (vlc_object_t *obj)
void	__vlc_object_kill (vlc_object_t *)
	Requests termination of an object.
static bool	__vlc_object_alive (const vlc_object_t *obj)
int	__vlc_object_waitpipe (vlc_object_t *obj)
	Returns the readable end of a pipe that becomes readable once termination of the object is requested (vlc_object_kill()).
static bool	__vlc_object_lock_and_wait (vlc_object_t *obj)

---

Detailed Description

This file defines the vlc_object_t structure and object types.

---