Objects


Data Structures
struct	vlc_object_t
	The main vlc_object_t structure. More...
VLC_COMMON_MEMBERS these members are common for all vlc objects
const char *	vlc_object_t::psz_object_type
char *	vlc_object_t::psz_header
int	vlc_object_t::i_flags
volatile bool	vlc_object_t::b_error
	set by the object
volatile bool	vlc_object_t::b_die
	set by the outside
bool	vlc_object_t::b_force
	set by the outside (eg.
bool	vlc_object_t::be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
	Just a reminder so that people don't cast garbage.
libvlc_int_t *	vlc_object_t::p_libvlc
	(root of all evil) - 1
vlc_object_t *	vlc_object_t::p_parent
	our parent
Defines
#define	VLC_OBJECT_INPUT (-7)
#define	VLC_OBJECT_DECODER (-8)
#define	VLC_OBJECT_VOUT (-9)
#define	VLC_OBJECT_AOUT (-10)
#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_get_name(o) vlc_object_get_name(VLC_OBJECT(o))
#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_hold(a) __vlc_object_hold( VLC_OBJECT(a) )
#define	vlc_object_release(a) __vlc_object_release( VLC_OBJECT(a) )
#define	vlc_list_children(a) __vlc_list_children( VLC_OBJECT(a) )
#define	vlc_object_kill(a) __vlc_object_kill( VLC_OBJECT(a) )
#define	vlc_object_alive(a) vlc_object_alive( VLC_OBJECT(a) )
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_find (vlc_object_t *, int, int)
vlc_object_t *	vlc_object_find_name (vlc_object_t , const char , int)
	Finds a named object and increment its reference count.
void *	__vlc_object_hold (vlc_object_t *)
	Increment an object reference counter.
void	__vlc_object_release (vlc_object_t *)
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 *)
char *	vlc_object_get_name (const vlc_object_t *)
void	__vlc_object_kill (vlc_object_t *)
	Requests termination of an object, cancels the object thread, and make the object wait pipe (if it exists) readable.
static bool	vlc_object_alive (const vlc_object_t *obj)

Define Documentation

#define FIND_ANYWHERE 0x0003

Referenced by __aout_VolumeGet(), __aout_VolumeSet(), __vlc_object_find(), __vout_OSDMessage(), aout_EnableFilter(), aout_FindAndRestart(), ChapterMenu::AttachedToWindow(), TitleMenu::AttachedToWindow(), LanguageMenu::AttachedToWindow(), ConfigItem::ConfigItem(), DumpCommand(), FindObject(), FindObjectName(), SeekSlider::MouseUp(), Timer::Notify(), Interface::OnFastStream(), Interface::OnPlayStream(), Interface::OnSlowStream(), Interface::OnVideoOnTop(), OpenDecoder(), PopupMenu(), PreferencesWindow::PreferencesWindow(), RefreshAudioMenu(), RefreshNavigMenu(), RefreshVideoMenu(), Run(), RunIntf(), VLCExtended::sliderActionAdjustImage:, VLCControls::telxNavLink:, VLCControls::telxTransparent:, FileInfo::UpdateFileInfo(), InterfaceWindow::UpdateInterface(), vlc_list_find(), vlc_object_find_name(), vlc_object_search_mode_from_string(), vlclua_spu_channel_clear(), vlclua_spu_channel_register(), vout_Destructor(), vout_OSDIcon(), and vout_OSDSlider().

#define FIND_PARENT 0x0001

Referenced by __stream_MemoryNew(), __stream_UrlNew(), Add(), CreateFilter(), DeinterlaceSave(), FilterCallback(), FindObject(), FindObjectName(), InitThread(), LoadFontsFromAttachments(), OpenWindow(), PopupMenu(), Reassemble(), RefreshVideoMenu(), Send(), sout_UpdateStatistic(), spu_Attach(), demux_sys_t::StartUiThread(), and vlc_object_search_mode_from_string().

#define FIND_STRICT 0x0010

Referenced by __vlc_object_find(), and vlc_object_find_name().

#define OBJECT_FLAGS_NODBG 0x0001

Referenced by __vlc_custom_create(), and QueueMsg().

#define OBJECT_FLAGS_NOINTERACT 0x0004

Referenced by __vlc_custom_create(), Create(), dialog_Login(), dialog_ProgressCreate(), dialog_Question(), and dialog_VFatal().

#define OBJECT_FLAGS_QUIET 0x0002

Referenced by __vlc_custom_create(), Create(), and QueueMsg().

#define vlc_list_children ( a ) __vlc_list_children( VLC_OBJECT(a) )

Referenced by DumpObject(), and ObjectKillChildrens().

#define vlc_object_alive ( a ) vlc_object_alive( VLC_OBJECT(a) )

Referenced by AccessReadStream(), AVI_IndexCreate(), AVI_PacketSearch(), AVI_StreamChunkFind(), Block(), BlockScan(), Close(), CloseVideoGL(), CommandThread(), Connect(), ControlPop(), ControlSetPosition(), DecoderFlush(), Demux(), Demux_Seekable(), DemuxFile(), DoWork(), Dummy(), en50221_Init(), demux_sys_t::EventThread(), FindLength(), GrabCapture(), InputManager::hasInput(), input_DecoderWaitBuffering(), InputSourceInit(), intf_Create(), intf_DestroyAll(), KillerThread(), libvlc_InternalWait(), LoopInput(), LoopRequest(), MainLoop(), VLCMain::manage, VLCMain::manageIntf:, mms_HeaderMediaRead(), MyThread(), NetFillBuffer(), Timer::Notify(), OpenWithCookies(), OSSThread(), playlist_BothAddInput(), PlaylistVAControl(), Process(), QNXaoutThread(), QNXManage(), Read(), ReadCommand(), ReadCompressed(), Render(), Request(), VLCMain::resetScrollField, ReSynch(), rtp_dgram_recv(), Run(), RunIntf(), RunQtThread(), Seek(), SessionsSetup(), InputManager::setInput(), should_die(), Thread(), ThreadControl(), update_request_thread(), vnc_worker_thread(), VoutsNewPicture(), and WaveOutCallback().

#define VLC_OBJECT_AOUT (-10)

Referenced by __aout_New(), __aout_VolumeGet(), __aout_VolumeSet(), __vlc_object_create(), aout_EnableFilter(), aout_FindAndRestart(), GetAOut(), ObjectKillChildrens(), PopupMenu(), RefreshAudioMenu(), and vlc_object_type_from_string().

#define vlc_object_attach	(	a,
		b		)	__vlc_object_attach( VLC_OBJECT(a), VLC_OBJECT(b) )

Referenced by __access_New(), __aout_DecNew(), __demux_New(), __osd_MenuCreate(), __sout_NewInstance(), __spu_Create(), __stream_MemoryNew(), __vlm_New(), __vout_Create(), __vout_Request(), __xml_Create(), Add(), aout_InputNew(), aout_MixerNew(), AppThread(), Callback(), ChromaCreate(), Create(), CreateAndLoadScale(), CreateDecoder(), CreateEncoder(), CreateFilter(), CreateVout(), Filter(), filter_chain_AppendFilterInternal(), filter_NewBlend(), FindArt(), FindFilter(), httpd_TLSHostNew(), Init(), input_item_WriteMeta(), intf_Create(), libvlc_InternalInit(), Open(), OpenDisplay(), OpenFilter(), OpenTextRenderer(), playlist_Export(), RequestAout(), RequestSout(), sout_AccessOutNew(), sout_MuxNew(), sout_StreamNew(), SpuRenderCreateAndLoadText(), sql_Create(), stream_AccessNew(), stream_DemuxNew(), stream_FilterNew(), system_Configure(), tls_ClientCreate(), tls_ServerCreate(), tls_ServerSessionPrepare(), video_splitter_New(), vlc_inhibit_Create(), vlc_sd_Create(), vlm_ControlMediaAdd(), vnc_worker_thread(), vout_display_New(), and vout_window_New().

#define vlc_object_create	(	a,
		b		)	__vlc_object_create( VLC_OBJECT(a), b )

#define VLC_OBJECT_DECODER (-8)

Referenced by __vlc_object_create(), Add(), CreateDecoder(), demux_PacketizerNew(), InitThread(), ObjectKillChildrens(), PopupMenu(), RefreshVideoMenu(), and vlc_object_type_from_string().

#define vlc_object_detach ( a ) __vlc_object_detach( VLC_OBJECT(a) )

Referenced by __access_New(), __demux_New(), __sout_NewInstance(), __vout_Request(), __xml_Create(), access_Delete(), Add(), aout_FiltersDestroyPipeline(), aout_InputNew(), aout_MixerDelete(), aout_MixerNew(), AppThread(), AStreamDestroy(), Callback(), Close(), CloseFilter(), CloseTextRenderer(), CreateDecoder(), CreateFilter(), CreateVout(), Del(), Delete(), DeleteDecoder(), DeleteEncoder(), DeleteFilter(), demux_Delete(), DStreamDelete(), End(), EndThread(), Filter(), filter_chain_AppendFilterInternal(), filter_chain_DeleteFilterInternal(), filter_DeleteBlend(), FilterRelease(), FindFilter(), gnutls_ServerSessionPrepare(), gnutls_SessionClose(), httpd_TLSHostNew(), Init(), input_resource_SetInput(), Open(), OpenFilter(), ReleaseFilter(), RenderCursor(), RequestAout(), RequestSout(), sout_AccessOutDelete(), sout_AccessOutNew(), sout_MuxDelete(), sout_MuxNew(), sout_StreamDelete(), stop_osdvnc(), stream_AccessNew(), stream_DemuxNew(), system_End(), tls_ClientDelete(), tls_ServerDelete(), video_splitter_Delete(), vlm_ControlMediaAdd(), vlm_ControlMediaDel(), vnc_worker_thread(), vout_display_Delete(), vout_display_New(), vout_window_Delete(), vout_window_New(), and xml_Delete().

#define vlc_object_find	(	a,
		b,
		c	)	__vlc_object_find( VLC_OBJECT(a),b,c)

Referenced by __aout_VolumeGet(), __aout_VolumeSet(), __stream_MemoryNew(), __stream_UrlNew(), __vlc_object_find(), __vout_OSDMessage(), Add(), aout_EnableFilter(), aout_FindAndRestart(), ChapterMenu::AttachedToWindow(), TitleMenu::AttachedToWindow(), LanguageMenu::AttachedToWindow(), CreateFilter(), DeinterlaceSave(), demux_sys_t::EventThread(), FilterCallback(), GetAOut(), GetVideoSize(), HandleKey(), InitThread(), LoadFontsFromAttachments(), SeekSlider::MouseUp(), Timer::Notify(), Interface::OnFastStream(), Interface::OnPlayStream(), Interface::OnSlowStream(), Interface::OnVideoOnTop(), OpenDecoder(), OpenWindow(), PopupMenu(), Reassemble(), RefreshAudioMenu(), RefreshNavigMenu(), RefreshVideoMenu(), Run(), RunIntf(), Send(), sout_UpdateStatistic(), spu_Attach(), demux_sys_t::StartUiThread(), FileInfo::UpdateFileInfo(), InterfaceWindow::UpdateInterface(), vlclua_fullscreen(), vlclua_object_find(), vlclua_spu_channel_clear(), vlclua_spu_channel_register(), vout_Destructor(), vout_OSDIcon(), and vout_OSDSlider().

#define vlc_object_find_name	(	a,
		b,
		c	)	vlc_object_find_name( VLC_OBJECT(a),b,c)

Referenced by __var_Command(), PodcastConfigDialog::accept(), DumpCommand(), get_marquee_object(), libvlc_toggle_teletext(), libvlc_video_get_teletext(), libvlc_video_set_teletext(), PostProcessSetFilterQuality(), RunIntf(), VLCExtended::sliderActionAdjustImage:, InputManager::telexSetPage(), InputManager::telexSetTransparency(), VLCControls::telxNavLink:, VLCControls::telxTransparent:, and vlclua_object_find_name().

#define VLC_OBJECT_GENERIC (-666)

#define vlc_object_get_name ( o ) vlc_object_get_name(VLC_OBJECT(o))

Referenced by DumpObject(), objnamecmp(), and PrintObject().

#define vlc_object_hold ( a ) __vlc_object_hold( VLC_OBJECT(a) )

Referenced by __ACL_Create(), __ACL_Duplicate(), __osd_MenuCreate(), __pl_Hold(), __vlc_list_children(), __vlc_object_attach(), __vlc_object_find(), __vlm_New(), __vout_Request(), access_GetParentInput(), CmdLabeled::CmdLabeled(), demux_GetParentInput(), DemuxOpen(), dialog_GetProvider(), FindObject(), FindObjectName(), HoldAout(), HoldVout(), HoldVouts(), VLCAutoGeneratedMenuContent::initWithVariableName:ofObject:andValue:ofType:, libvlc_get_input_thread(), libvlc_get_vlc_instance(), ListReplace(), MenuItemData::MenuItemData(), onSystrayChange(), onTaskBarChange(), playlist_CurrentInput(), QVLCVariable::QVLCVariable(), request_video(), RequestAout(), set_input(), InputManager::setInput(), FullscreenControllerWidget::setVoutList(), sout_AnnounceRegisterSDP(), vlc_object_find_name(), VLCAutoGeneratedMenuContent::vlcObject, VoutWindow::VoutWindow(), and WindowOpen().

#define vlc_object_kill ( a ) __vlc_object_kill( VLC_OBJECT(a) )

#define vlc_object_release ( a ) __vlc_object_release( VLC_OBJECT(a) )

#define vlc_object_set_destructor	(	a,
		b		)	__vlc_object_set_destructor( VLC_OBJECT(a), b )

Referenced by __aout_New(), __vlm_New(), __vout_Create(), Create(), playlist_Create(), sout_AnnounceRegisterSDP(), and vlc_sd_Create().

#define VLC_OBJECT_VOUT (-9)

Referenced by __vout_Create(), __vout_OSDMessage(), CreateFilter(), demux_sys_t::EventThread(), GetVideoSize(), HandleKey(), ObjectKillChildrens(), Interface::OnVideoOnTop(), OpenWindow(), PopupMenu(), RefreshVideoMenu(), RunIntf(), vlc_object_type_from_string(), vlclua_fullscreen(), vlclua_spu_channel_clear(), vlclua_spu_channel_register(), vout_Destructor(), vout_OSDIcon(), and vout_OSDSlider().

Typedef Documentation

typedef void(* vlc_destructor_t)(struct vlc_object_t *)

Function Documentation

vlc_list_t* __vlc_list_children ( vlc_object_t * obj )

Gets the list of children of an objects, and increment their reference count.

Returns:: a list (possibly empty) or NULL in case of error.

References i, vlc_object_internals_t::i_children, vlc_list_t::i_count, libvlc_lock(), libvlc_unlock(), NewList(), vlc_object_t::p_libvlc, vlc_value_t::p_object, vlc_list_t::p_values, vlc_object_internals_t::pp_children, vlc_internals, and vlc_object_hold.

void __vlc_object_attach	(	vlc_object_t *	p_this,
		vlc_object_t *	p_parent
	)

attach object to a parent object

This function sets p_this as a child of p_parent, and p_parent as a parent of p_this. This link can be undone using vlc_object_detach.

References vlc_object_internals_t::i_children, INSERT_ELEM, libvlc_lock(), libvlc_unlock(), vlc_object_t::p_libvlc, vlc_object_t::p_parent, vlc_object_internals_t::pp_children, vlc_internals, and vlc_object_hold.

void* __vlc_object_create	(	vlc_object_t *	p_this,
		int	i_type
	)

Allocates and initializes a vlc object.

Parameters:

i_type

known object type (all of them are negative integer values), or object byte size (always positive).

Returns:: the new object, or NULL on error.

References psz_type, vlc_custom_create, VLC_OBJECT_AOUT, VLC_OBJECT_DECODER, and VLC_OBJECT_GENERIC.

void __vlc_object_detach ( vlc_object_t * p_this )

detach object from its parent

This function removes all links between an object and its parent.

References libvlc_lock(), libvlc_unlock(), vlc_object_t::p_libvlc, vlc_object_t::p_parent, vlc_object_detach_unlocked(), and vlc_object_release.

void* __vlc_object_find	(	vlc_object_t *	,
		int	,
		int
	)

References FIND_ANYWHERE, FIND_CHILD, FIND_STRICT, FindObject(), libvlc_lock(), libvlc_unlock(), vlc_object_t::p_libvlc, vlc_internals, vlc_object_find, and vlc_object_hold.

void* __vlc_object_hold ( vlc_object_t * )

Increment an object reference counter.

References vlc_object_internals_t::i_refcount, vlc_object_internals_t::ref_spin, vlc_internals, vlc_spin_lock, and vlc_spin_unlock.

void __vlc_object_kill ( vlc_object_t * p_this )

Requests termination of an object, cancels the object thread, and make the object wait pipe (if it exists) readable.

Not a cancellation point.

References vlc_object_t::b_die, msg_Dbg, pipe_lock, vlc_object_internals_t::pipes, vlc_internals, vlc_mutex_lock(), vlc_mutex_unlock(), vlc_restorecancel(), vlc_savecancel(), and vlc_thread_cancel().

void __vlc_object_release ( vlc_object_t * )

References vlc_object_internals_t::i_children, vlc_object_internals_t::i_refcount, libvlc_lock(), libvlc_unlock(), vlc_object_t::p_libvlc, vlc_object_t::p_parent, vlc_object_internals_t::ref_spin, vlc_internals, vlc_object_destroy(), vlc_object_detach_unlocked(), vlc_object_release, vlc_restorecancel(), vlc_savecancel(), vlc_spin_lock, and vlc_spin_unlock.

void __vlc_object_set_destructor	(	vlc_object_t *	p_this,
		vlc_destructor_t	pf_destructor
	)

Set the destructor of a vlc object.

This function sets the destructor of the vlc object. It will be called when the object is destroyed when the its refcount reaches 0. (It is called by the internal function vlc_object_destroy())

References vlc_object_internals_t::pf_destructor, vlc_object_internals_t::ref_spin, vlc_internals, vlc_spin_lock, and vlc_spin_unlock.

void vlc_list_release ( vlc_list_t * )

References vlc_list_t::i_count, vlc_value_t::p_object, vlc_list_t::p_values, and vlc_object_release.

Referenced by ConfigItem::ConfigItem(), DumpObject(), ObjectKillChildrens(), and PreferencesWindow::PreferencesWindow().

static bool vlc_object_alive ( const vlc_object_t * obj ) [inline, static]

vlc_object_t* vlc_object_find_name	(	vlc_object_t *	p_this,
		const char *	psz_name,
		int	i_mode
	)

Finds a named object and increment its reference count.

Beware that objects found in this manner can be "owned" by another thread, be of _any_ type, and be attached to any module (if any). With such an object reference, you can set or get object variables, emit log messages, and read write-once object parameters (psz_object_type, etc). You CANNOT cast the object to a more specific object type, and you definitely cannot invoke object type-specific callbacks with this.

Parameters: