VLC objects

Collaboration diagram for VLC objects:

Modules
	Object resources
	The object resource functions tie resource allocation to an instance of a module through a VLC object.
	Variables
	VLC object variables and callbacks.

Files
file	vlc_objects.h
	Common VLC object defintions.

Data Structures
struct	vlc_object_t
	VLC object common members. More...
struct	libvlc_int_t

Macros
#define	VLC_OBJECT(x)
	Type-safe vlc_object_t cast. More...
#define	vlc_object_cast(t)
#define	vlc_object_delete(obj)   vlc_object_delete(VLC_OBJECT(obj))
#define	vlc_object_parent(o)   vlc_object_parent(VLC_OBJECT(o))
#define	vlc_object_logger(o)   vlc_object_logger(VLC_OBJECT(o))
#define	vlc_object_get_name(obj)   var_GetString(obj, "module-name")
	Tries to get the name of module bound to an object. More...
#define	vlc_object_create(a, b)   vlc_object_create( VLC_OBJECT(a), b )
#define	vlc_object_find_name(a, b)   vlc_object_find_name( VLC_OBJECT(a),b)
#define	vlc_object_instance(o)   vlc_object_instance(VLC_OBJECT(o))

Functions
void *	vlc_object_create (_Generic((vlc_object_t *) ->obj, struct vlc_object_marker *:(vlc_object_t *), default:(&((vlc_object_t *) ->obj))), size_t)
	Allocates and initializes a vlc object. More...
void	vlc_object_delete (_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))))
	Drops the strong reference to an object. More...
size_t	vlc_list_children (vlc_object_t *, vlc_object_t **, size_t)
const char *	vlc_object_typename (const vlc_object_t *obj)
	Returns the object type name. More...
vlc_object_t *	vlc_object_parent (_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))))
	Gets the parent of an object. More...
static struct vlc_logger *	vlc_object_logger (_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))))
static libvlc_int_t *	vlc_object_instance (_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))))
vout_thread_t *	vout_Hold (vout_thread_t *vout)
void	vout_Release (vout_thread_t *vout)
audio_output_t *	aout_Hold (audio_output_t *aout)
void	aout_Release (audio_output_t *aout)
static void *	vlc_object_hold (vlc_object_t *o)
static void	vlc_object_release (vlc_object_t *o)

Detailed Description

Macro Definition Documentation

VLC_OBJECT

#define VLC_OBJECT

(

x

)

Value:

_Generic((x)->obj, \
        struct vlc_object_marker *: (x), \
        default: (&((x)->obj)) \
    )

Type-safe vlc_object_t cast.

This macro attempts to cast a pointer to a compound type to a vlc_object_t pointer in a type-safe manner. It checks if the compound type actually starts with an embedded vlc_object_t structure.

Referenced by aout_CheckReady(), aout_DecNew(), aout_filter_GetVout(), aout_Release(), ConvertRGB32AndBlend(), Create(), demux_FilterNew(), demux_Probe(), Destroy(), EsOutCreateDecoder(), EsOutSetRecord(), EsOutVaControlLocked(), filter_AddProxyCallbacks(), filter_DelProxyCallbacks(), GetUpdateFile(), input_DecoderSetCcState(), input_ExtractAttachmentAndCacheArt(), input_resource_GetVoutDecoderDevice(), InputDemuxNew(), libvlc_GetMainPlaylist(), libvlc_InternalActionsInit(), libvlc_InternalCleanup(), libvlc_InternalInit(), libvlc_InternalKeystoreInit(), libvlc_InternalPlay(), libvlc_MlCreate(), spu_Create(), stream_AccessNew(), StreamExtractorAttach(), ThreadDisplayRenderPicture(), tls_client_load(), tls_server_load(), update_DownloadReal(), vlc_decoder_device_Release(), vlc_demux_chained_Thread(), vlc_gl_Create(), vlc_gl_Release(), vlc_gl_start(), vlc_logger_load(), vlc_LogInit(), vlc_LogModuleClose(), vlc_LogModuleCreate(), vlc_LogPreinit(), vlc_LogSet(), vlc_mta_acquire(), vlc_mta_release(), vlc_player_GetObject(), vlc_player_New(), vlc_threads_setup(), vlc_tls_ClientDelete(), vlc_tls_ServerDelete(), vlm_ControlMediaAdd(), vlm_New(), vlm_OnMediaUpdate(), vout_Close(), vout_display_Delete(), vout_display_New(), vout_display_start(), vout_GetSnapshot(), vout_OpenWrapper(), vout_OSDEpg(), vout_Release(), vout_Start(), vout_UpdateSourceCrop(), vout_window_Delete(), vout_window_New(), vout_window_start(), and VoutSnapshotPip().

vlc_object_cast

#define vlc_object_cast

(

t

)

vlc_object_create

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

Referenced by vlc_decoder_device_Create(), vlc_readdir_helper_init(), and vlm_MediaInstanceNew().

vlc_object_delete

#define vlc_object_delete

(

obj

)

vlc_object_delete(VLC_OBJECT(obj))

Referenced by addons_manager_WriteCatalog(), aout_FiltersPipelineDestroy(), aout_New(), aout_Release(), aout_volume_Delete(), AppendFilter(), CreateDecoder(), CreateFilter(), decoder_Destroy(), DeleteConverter(), DeleteEncoder(), demux_PacketizerDestroy(), demux_PacketizerNew(), Destroy(), filter_chain_AppendInner(), filter_chain_DeleteFilter(), filter_DeleteBlend(), FilterRelease(), FinderThread(), fingerprinter_Create(), fingerprinter_Destroy(), httpd_HostCreate(), httpd_HostDelete(), input_item_WriteMeta(), InputSourceMeta(), installOrRemoveAddon(), intf_Create(), intf_DestroyAll(), InvokeModule(), keystore_create(), libvlc_InternalDestroy(), libvlc_MlCreate(), libvlc_MlRelease(), LoadLocalStorage(), ReleaseObject(), se_Release(), sout_AccessOutDelete(), sout_AccessOutNew(), sout_DeleteInstance(), sout_MuxDelete(), sout_MuxNew(), sout_NewInstance(), sout_StreamDelete(), spu_Create(), spu_Destroy(), SpuRenderCreateAndLoadScale(), SpuRenderCreateAndLoadText(), stream_AccessNew(), stream_CommonDelete(), update_Delete(), update_Download(), video_splitter_Delete(), vlc_decoder_device_Create(), vlc_decoder_device_Release(), vlc_gl_Create(), vlc_gl_Release(), vlc_inhibit_Create(), vlc_inhibit_Destroy(), vlc_keystore_release(), vlc_LogModuleClose(), vlc_LogModuleCreate(), vlc_player_Delete(), vlc_player_New(), vlc_playlist_Export(), vlc_probe(), vlc_rd_new(), vlc_rd_release(), vlc_readdir_helper_init(), vlc_sd_Destroy(), vlc_tls_ClientCreate(), vlc_tls_ClientDelete(), vlc_tls_ServerCreate(), vlc_tls_ServerDelete(), vlm_ControlMediaAdd(), vlm_ControlMediaDel(), vlm_Delete(), vlm_MediaInstanceDelete(), vlm_MediaInstanceNew(), vlm_New(), vout_Create(), vout_display_Delete(), vout_display_New(), vout_Release(), vout_window_Delete(), vout_window_New(), xml_Create(), xml_Delete(), xml_ReaderCreate(), and xml_ReaderDelete().

vlc_object_find_name

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

vlc_object_get_name

#define vlc_object_get_name

(

obj

)

var_GetString(obj, "module-name")

Tries to get the name of module bound to an object.

Warning

This function is intrinsically race-prone, as a module may be bound or unbound asynchronously by another thread. Do not trust the result for any purpose other than debugging/tracing.

Returns

Normally, this returns a heap-allocated nul-terminated string which is the name of the module. If no module are bound to the object, it returns NULL. It also returns NULL on error.

vlc_object_instance

#define vlc_object_instance

(

o

)

vlc_object_instance(VLC_OBJECT(o))

Referenced by AddIntfCallback(), get_dialog_provider(), get_memory_keystore(), player_on_state_changed(), update_DownloadReal(), update_New(), vlc_actions_get_key_names(), vlc_intf_GetMainPlaylist(), vlc_ml_instance_get(), vlc_mta_acquire(), vlc_mta_release(), vlc_player_input_HandleState(), vlc_player_UpdateMLStates(), vlc_playlist_New(), vlm_Delete(), vout_display_window_KeyboardEvent(), and VoutSaveSnapshot().

vlc_object_logger

#define vlc_object_logger

(

o

)

vlc_object_logger(VLC_OBJECT(o))

vlc_object_parent

#define vlc_object_parent

(

o

)

vlc_object_parent(VLC_OBJECT(o))

Referenced by aout_Destroy(), aout_PolicyNotify(), aout_volume_Delete(), Init(), se_AttachWrapper(), sout_StreamDelete(), StreamExtractorAttach(), var_Inherit(), vlc_https_connect_proxy(), vlc_inhibit_GetWindow(), vlc_object_instance(), and vlc_stream_FilterNew().

Function Documentation

aout_Hold()

audio_output_t* aout_Hold

(

audio_output_t *

aout

)

References aout_owner(), and aout_owner_t::refs.

Referenced by input_resource_HoldAout(), and vlc_object_hold().

aout_Release()

void aout_Release

(

audio_output_t *

aout

)

References aout_owner(), aout_owner_t::dev, aout_owner_t::list, aout_owner_t::lock, aout_dev::next, aout_owner_t::refs, vlc_mutex_destroy(), VLC_OBJECT, vlc_object_delete, and aout_owner_t::vp.

Referenced by aout_Destroy(), ControlNav(), ViewpointApply(), vlc_object_release(), vlc_player_aout_AddCallbacks(), vlc_player_aout_DelCallbacks(), vlc_player_aout_EnableFilter(), vlc_player_aout_GetVolume(), vlc_player_aout_IncrementVolume(), vlc_player_aout_IsMuted(), vlc_player_aout_Mute(), vlc_player_aout_SetVolume(), and vlc_strfplayer().

vlc_list_children()

size_t vlc_list_children	(	vlc_object_t *	,
		vlc_object_t **	,
		size_t
	)

vlc_object_create()

void* vlc_object_create	(	_Generic((vlc_object_t *) ->obj, struct vlc_object_marker *:(vlc_object_t *), default:(&((vlc_object_t *) ->obj)))	,
		size_t
	)

Allocates and initializes a vlc object.

Parameters

i_size

object byte size

Returns

the new object, or NULL on error.

vlc_object_delete()

void vlc_object_delete

(

_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj)))

)

Drops the strong reference to an object.

This removes the initial strong reference to a given object. This must be called exactly once per allocated object after it is no longer needed, matching vlc_object_create() or vlc_custom_create().

vlc_object_hold()

static void* vlc_object_hold ( vlc_object_t *  o )

inlinestatic

References aout_Hold(), vlc_object_typename(), and vout_Hold().

Referenced by vlc_list_children().

vlc_object_instance()

static libvlc_int_t* vlc_object_instance ( _Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj)))  )

inlinestatic

References vlc_object_t::obj, and vlc_object_parent.

vlc_object_logger()

static struct vlc_logger* vlc_object_logger ( _Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj)))  )

static

References vlc_object_t::logger.

vlc_object_parent()

vlc_object_t* vlc_object_parent

(

_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj)))

)

Gets the parent of an object.

Returns

the parent object (NULL if none)

Note

The returned parent object pointer is valid as long as the child is.

vlc_object_release()

static void vlc_object_release ( vlc_object_t *  o )

inlinestatic

References aout_Release(), VLC_API, VLC_MALLOC, vlc_obj_calloc(), vlc_obj_free(), vlc_obj_malloc(), vlc_obj_strdup(), vlc_object_typename(), and vout_Release().

vlc_object_typename()

const char* vlc_object_typename

(

const vlc_object_t *

obj

)

Returns the object type name.

This returns a nul-terminated string identifying the object type. The string is valid for at least as long as the object reference.

Parameters

obj	object whose type name to get

References vlc_internals.

Referenced by vlc_object_hold(), vlc_object_release(), and vlc_object_vaLog().

vout_Hold()

vout_thread_t* vout_Hold

(

vout_thread_t *

vout

)

References vout_thread_t::p, and vout_thread_sys_t::refs.

Referenced by input_resource_HoldDummyVout(), input_resource_HoldVout(), input_resource_HoldVouts(), and vlc_object_hold().

vout_Release()

void vout_Release

(

vout_thread_t *

vout

)

References vout_thread_sys_t::control, vout_thread_sys_t::dec_device, vout_thread_sys_t::display_cfg, vout_thread_sys_t::display_lock, vout_thread_sys_t::dummy, vout_thread_sys_t::filter, vout_thread_sys_t::lock, vout_thread_sys_t::original, vout_thread_t::p, vout_thread_sys_t::refs, vout_thread_sys_t::snapshot, vout_thread_sys_t::splitter_name, vout_thread_sys_t::statistic, video_format_Clean(), vlc_decoder_device_Release(), vlc_mutex_destroy(), VLC_OBJECT, vlc_object_delete, vout_control_Clean(), vout_display_window_Delete(), vout_snapshot_Destroy(), vout_statistic_Clean(), vout_display_cfg::window, vout_thread_sys_t::window_enabled, and vout_thread_sys_t::window_lock.

Referenced by ControlNav(), DeleteDecoder(), input_resource_Release(), ModuleThread_NewSpuBuffer(), ViewpointApply(), vlc_object_release(), vlc_player_input_RestoreMlStates(), vlc_player_osd_ReleaseAll(), vlc_player_vout_SetVar(), vlc_player_vout_TriggerOption(), and vout_Close().