vlc_common.h File Reference

This file is a collection of common definitions and types. More...

Include dependency graph for vlc_common.h:

Go to the source code of this file.

Data Structures
union	vlc_value_t
	VLC value structure. More...
struct	vlc_list_t
	VLC list structure. More...

Macros
#define	VLC_GCC_VERSION(maj, min)   (0)
#define	VLC_DEPRECATED
#define	VLC_FORMAT(x, y)
#define	VLC_FORMAT_ARG(x)
#define	VLC_MALLOC
#define	VLC_NORETURN
#define	VLC_USED
#define	likely(p)   (!!(p))
#define	unlikely(p)   (!!(p))
#define	VLC_EXTERN
#define	VLC_EXPORT
#define	VLC_API   VLC_EXTERN VLC_EXPORT
#define	VLC_FOURCC(a, b, c, d)
#define	VLC_TWOCC(a, b)   ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
#define	vlc_fourcc_to_char(a, b)   vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
#define	VLC_SUCCESS   (-0)
	No error.
#define	VLC_EGENERIC   (-1)
	Unspecified error.
#define	VLC_ENOMEM   (-2)
	Not enough memory.
#define	VLC_ETIMEOUT   (-3)
	Timeout.
#define	VLC_ENOMOD   (-4)
	Module not found.
#define	VLC_ENOOBJ   (-5)
	Object not found.
#define	VLC_ENOVAR   (-6)
	Variable not found.
#define	VLC_EBADVAR   (-7)
	Bad variable value.
#define	VLC_ENOITEM   (-8)
	Item not found.
#define	VLC_COMMON_MEMBERS
#define	VLC_OBJECT(x)   ((vlc_object_t *)(x))
#define	CEIL(n, d)   ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
#define	PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
#define	VLC_CLIP(v, min, max)   __MIN(__MAX((v), (min)), (max))
#define	clz8(x)   (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
#define	clz16(x)   (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
#define	clz32(x)   (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
#define	FREENULL(a)   do { free( a ); a = NULL; } while(0)
#define	EMPTY_STR(str)   (!str || !*str)
#define	hton16(i)   bswap16(i)
#define	hton32(i)   bswap32(i)
#define	hton64(i)   bswap64(i)
#define	ntoh16(i)   hton16(i)
#define	ntoh32(i)   hton32(i)
#define	ntoh64(i)   hton64(i)
#define	GetWBE(p)   U16_AT(p)
#define	GetDWBE(p)   U32_AT(p)
#define	GetQWBE(p)   U64_AT(p)
#define	VLC_UNUSED(x)   (void)(x)
#define	vlc_free(base)   free(base)
#define	vlc_pgettext(ctx, id)   vlc_pgettext_aux( ctx "\004" id, id )
#define	DIR_SEP_CHAR   '/'
#define	DIR_SEP   "/"
#define	PATH_SEP_CHAR   ':'
#define	PATH_SEP   ":"
#define	LICENSE_MSG

Typedefs
typedef int64_t	mtime_t
	High precision date or time interval.
typedef uint32_t	vlc_fourcc_t
	The vlc_fourcc_t type.
typedef struct vlc_list_t	vlc_list_t
typedef struct vlc_object_t	vlc_object_t
typedef struct libvlc_int_t	libvlc_int_t
typedef struct date_t	date_t
typedef struct playlist_t	playlist_t
typedef struct playlist_item_t	playlist_item_t
typedef struct services_discovery_t	services_discovery_t
typedef struct services_discovery_sys_t	services_discovery_sys_t
typedef struct playlist_add_t	playlist_add_t
typedef struct module_t	module_t
typedef struct module_config_t	module_config_t
typedef struct config_category_t	config_category_t
typedef struct input_thread_t	input_thread_t
typedef struct input_item_t	input_item_t
typedef struct input_item_node_t	input_item_node_t
typedef struct access_t	access_t
typedef struct access_sys_t	access_sys_t
typedef struct stream_t	stream_t
typedef struct stream_sys_t	stream_sys_t
typedef struct demux_t	demux_t
typedef struct demux_sys_t	demux_sys_t
typedef struct es_out_t	es_out_t
typedef struct es_out_id_t	es_out_id_t
typedef struct es_out_sys_t	es_out_sys_t
typedef struct seekpoint_t	seekpoint_t
typedef struct info_t	info_t
typedef struct info_category_t	info_category_t
typedef struct input_attachment_t	input_attachment_t
typedef struct audio_format_t	audio_format_t
typedef struct video_format_t	video_format_t
typedef struct subs_format_t	subs_format_t
typedef struct es_format_t	es_format_t
typedef struct video_palette_t	video_palette_t
typedef struct audio_output	audio_output_t
typedef struct aout_sys_t	aout_sys_t
typedef struct aout_fifo_t	aout_fifo_t
typedef audio_format_t	audio_sample_format_t
typedef struct vout_thread_t	vout_thread_t
typedef video_format_t	video_frame_format_t
typedef struct picture_t	picture_t
typedef struct picture_sys_t	picture_sys_t
typedef struct spu_t	spu_t
typedef struct subpicture_t	subpicture_t
typedef struct subpicture_region_t	subpicture_region_t
typedef struct image_handler_t	image_handler_t
typedef struct sout_instance_t	sout_instance_t
typedef struct sout_input_t	sout_input_t
typedef struct sout_packetizer_input_t	sout_packetizer_input_t
typedef struct sout_access_out_t	sout_access_out_t
typedef struct sout_access_out_sys_t	sout_access_out_sys_t
typedef struct sout_mux_t	sout_mux_t
typedef struct sout_mux_sys_t	sout_mux_sys_t
typedef struct sout_stream_t	sout_stream_t
typedef struct sout_stream_sys_t	sout_stream_sys_t
typedef struct config_chain_t	config_chain_t
typedef struct session_descriptor_t	session_descriptor_t
typedef struct decoder_t	decoder_t
typedef struct decoder_sys_t	decoder_sys_t
typedef struct decoder_synchro_t	decoder_synchro_t
typedef struct encoder_t	encoder_t
typedef struct encoder_sys_t	encoder_sys_t
typedef struct filter_t	filter_t
typedef struct filter_sys_t	filter_sys_t
typedef struct virtual_socket_t	v_socket_t
typedef struct vlc_url_t	vlc_url_t
typedef struct iso639_lang_t	iso639_lang_t
typedef struct block_t	block_t
typedef struct block_fifo_t	block_fifo_t
typedef struct md5_s	md5_t
typedef struct xml_t	xml_t
typedef struct xml_sys_t	xml_sys_t
typedef struct xml_reader_t	xml_reader_t
typedef struct xml_reader_sys_t	xml_reader_sys_t
typedef struct vod_t	vod_t
typedef struct vod_sys_t	vod_sys_t
typedef struct vod_media_t	vod_media_t
typedef struct vlm_t	vlm_t
typedef struct vlm_message_t	vlm_message_t
typedef struct vlc_meta_t	vlc_meta_t
typedef struct input_stats_t	input_stats_t
typedef struct update_t	update_t
typedef int(*	vlc_callback_t )(vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *)

Enumerations
enum	playlist_command_t {   PLAYLIST_PLAY, PLAYLIST_VIEWPLAY, PLAYLIST_PAUSE, PLAYLIST_STOP,   PLAYLIST_SKIP }
	Playlist commands. More...

Functions
static void	vlc_fourcc_to_char ((vlc_fourcc_t)(vlc_fourcc_t fcc),(char *)(char *psz_fourcc))
	Translate a vlc_fourcc into its string representation.
static int64_t	GCD (int64_t a, int64_t b)
static uint8_t	clip_uint8_vlc (int32_t a)
static unsigned	clz (unsigned x)
	Count leading zeroes.
static unsigned	ctz (unsigned x)
	Count trailing zeroes.
static unsigned	popcount (unsigned x)
	Bit weight.
static unsigned	parity (unsigned x)
static uint16_t	bswap16 (uint16_t x)
	Byte swap (16 bits)
static uint32_t	bswap32 (uint32_t x)
	Byte swap (32 bits)
static uint64_t	bswap64 (uint64_t x)
	Byte swap (64 bits)
char const *	vlc_error (int)
static uint16_t	U16_AT (const void *p)
	Reads 16 bits in network byte order.
static uint32_t	U32_AT (const void *p)
	Reads 32 bits in network byte order.
static uint64_t	U64_AT (const void *p)
	Reads 64 bits in network byte order.
static uint16_t	GetWLE (const void *p)
	Reads 16 bits in little-endian order.
static uint32_t	GetDWLE (const void *p)
	Reads 32 bits in little-endian order.
static uint64_t	GetQWLE (const void *p)
	Reads 64 bits in little-endian order.
static void	SetWBE (void *p, uint16_t w)
	Writes 16 bits in network byte order.
static void	SetDWBE (void *p, uint32_t dw)
	Writes 32 bits in network byte order.
static void	SetQWBE (void *p, uint64_t qw)
	Writes 64 bits in network byte order.
static void	SetWLE (void *p, uint16_t w)
	Writes 16 bits in little endian order.
static void	SetDWLE (void *p, uint32_t dw)
	Writes 32 bits in little endian order.
static void	SetQWLE (void *p, uint64_t qw)
	Writes 64 bits in little endian order.
bool	vlc_ureduce (unsigned *, unsigned *, uint64_t, uint64_t, uint64_t)
static void *	vlc_memalign (size_t align, size_t size)
void	vlc_tdestroy (void *, void(*)(void *))
char *	vlc_gettext (const char *msgid)
	In-tree plugins share their gettext domain with LibVLC.
char *	vlc_ngettext (const char *s, const char *p, unsigned long n)
static const char *	vlc_pgettext_aux (const char *ctx, const char *id)
static void *	xmalloc (size_t len)
static void *	xrealloc (void *ptr, size_t len)
static void *	xcalloc (size_t n, size_t size)
static char *	xstrdup (const char *str)
const char *	VLC_CompileBy (void)
const char *	VLC_CompileHost (void)
const char *	VLC_Compiler (void)

Detailed Description

This file is a collection of common definitions and types.

Macro Definition Documentation

#define CEIL	(		n,
			d
	)		( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

#define clz16

(

x

)

(clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))

#define clz32

(

x

)

(clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))

#define clz8

(

x

)

(clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))

Referenced by vlc_towc().

#define DIR_SEP   "/"

Referenced by ArtCacheGetDirPath(), ArtCacheName(), config_GetConfigFile(), GetDirByItemUIDs(), GetFileByItemUID(), GetTmpPath(), input_CreateFilename(), playlist_FindArtInCache(), playlist_MLDump(), playlist_MLLoad(), subtitles_Detect(), vlc_bindtextdomain(), vlc_path2uri(), and vout_snapshot_SaveImage().

#define DIR_SEP_CHAR   '/'

Referenced by ArtCacheCreateDir(), config_CreateDir(), path_sanitize(), subtitles_Detect(), and vlc_path2uri().

#define EMPTY_STR

(

str

)

(!str || !*str)

Referenced by ArtCacheCreateDir(), ArtCacheGetDirPath(), ArtCachePath(), GoAndPreparse(), input_item_GetTitleFbName(), PlayItem(), playlist_sd_item_added(), and str_format_meta().

#define FREENULL

(

a

)

do { free( a ); a = NULL; } while(0)

Referenced by config_ChainDestroy(), http_auth_Reset(), ml_CopyMedia(), ml_FreeMediaContent(), mrl_Clean(), sout_DeleteInstance(), sout_MuxNew(), sout_NewInstance(), and sout_StreamDelete().

#define GetDWBE

(

p

)

U32_AT(p)

#define GetQWBE

(

p

)

U64_AT(p)

#define GetWBE

(

p

)

U16_AT(p)

#define hton16

(

i

)

bswap16(i)

Referenced by SetWBE().

#define hton32

(

i

)

bswap32(i)

Referenced by SetDWBE().

#define hton64

(

i

)

bswap64(i)

Referenced by SetQWBE().

#define LICENSE_MSG

Value:

_("This program comes with NO WARRANTY, to the extent permitted by " \
    "law.\nYou may redistribute it under the terms of the GNU General " \
    "Public License;\nsee the file named COPYING for details.\n" \
    "Written by the VideoLAN team; see the AUTHORS file.\n")

Referenced by Version().

#define likely

(

p

)

(!!(p))

Referenced by aout_DecNewBuffer(), aout_New(), aout_ReplayGainSelect(), convert_xml_special_chars(), encode_URI_bytes(), encode_URI_component(), EnsureUTF8(), ImageWrite(), input_DecoderChangePause(), IsUTF8(), module_InitBank(), module_InitStaticModules(), psz_md5_hash(), utf8_vfprintf(), var_GetCoords(), var_LocationParse(), vlc_cancel_self(), vlc_custom_create(), vlc_dup(), vlc_gettext(), vlc_list_children(), vlc_module_load(), vlc_ngettext(), vlc_object_release(), vlc_sem_destroy(), vlc_sem_post(), vlc_sem_wait(), vlm_New(), and vout_InitInterlacingSupport().

#define ntoh16

(

i

)

hton16(i)

Referenced by U16_AT().

#define ntoh32

(

i

)

hton32(i)

Referenced by U32_AT().

#define ntoh64

(

i

)

hton64(i)

Referenced by U64_AT().

#define PAD	(		n,
			d
	)		( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

#define PATH_SEP   ":"

#define PATH_SEP_CHAR   ':'

#define unlikely

(

p

)

(!!(p))

Referenced by aout_CheckReady(), aout_DecPlay(), aout_DecSilence(), aout_DeviceSet(), aout_New(), aout_new_buffer(), aout_volume_Amplify(), aout_volume_New(), aout_volume_SetFormat(), aout_volume_SetVolume(), block_Alloc(), config_FindConfig(), config_GetDataDir(), config_GetIntChoices(), config_SortConfig(), convert_xml_special_chars(), CreateDecoder(), CreateFilter(), DecoderGetInputAttachments(), DecoderPlayAudio(), encode_URI_bytes(), FindFilter(), input_item_NewWithType(), libvlc_InternalInit(), make_path(), mdate(), mdate_interrupt(), module_find(), module_get_object(), module_gettext(), module_InitStatic(), module_list_cap(), module_list_get(), mwait(), net_Write(), pl_Get(), playlist_AskForArtEnqueue(), playlist_Create(), playlist_PreparseEnqueue(), secstotimestr(), SelectClockSource(), ToCharset(), utf8_vfprintf(), var_Create(), vlc_AddMapping(), vlc_bindtextdomain(), vlc_clone_attr(), vlc_cond_init(), vlc_cond_init_daytime(), vlc_custom_create(), vlc_DeinitActions(), vlc_dictionary_all_keys(), vlc_dup(), vlc_GetCPUCount(), vlc_getcwd(), vlc_gl_Create(), vlc_idna_to_ascii(), vlc_InitActions(), vlc_loaddir(), vlc_mkdir(), vlc_module_load(), vlc_mutex_init(), vlc_mutex_init_recursive(), vlc_object_destroy(), vlc_opendir(), vlc_path2uri(), vlc_plugin_setter(), vlc_probe(), vlc_probe_add(), vlc_readdir(), vlc_restorecancel(), vlc_rwlock_init(), vlc_sd_GetNames(), vlc_sd_probe_Add(), vlc_sem_init(), vlc_sem_post(), vlc_statEx(), vlc_strcasestr(), vlc_threadvar_create(), vlc_timer_create(), vlc_tls_ClientCreate(), vlc_tls_ServerCreate(), vlc_towc(), vlc_unlink(), vlc_UrlParse(), vlc_WaitForMultipleObjects(), vlc_xlib_init(), xmalloc(), and xml_ReaderCreate().

#define VLC_API   VLC_EXTERN VLC_EXPORT

#define VLC_CLIP	(		v,
			min,
			max
	)		__MIN(__MAX((v), (min)), (max))

Referenced by AStreamReadBlock(), AStreamReadNoSeekStream(), OSDWidget(), vout_InitInterlacingSupport(), vout_ManageDisplay(), and vout_OSDEpgSlider().

#define VLC_COMMON_MEMBERS

Value:

/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
    const char *psz_object_type;                                            \
                                                                            \
    /* Messages header */                                                   \
    char *psz_header;                                                       \
    int  i_flags;                                                           \
                                                                            \
    /* Object properties */                                                 \
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
                                                                            \
    /* Stuff related to the libvlc structure */                             \
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
                                                                            \
    vlc_object_t *  p_parent;                            /**< our parent */ \
                                                                            \
/**@}*/                                                                     \

#define VLC_DEPRECATED

#define VLC_EBADVAR   (-7)

Bad variable value.

Referenced by PlaylistVAControl(), and vlc_error().

#define VLC_EGENERIC   (-1)

Unspecified error.

Referenced by __ml_GetValue(), access_vaControl(), AllocatePicture(), AStreamControl(), AStreamRefillBlock(), AStreamRefillStream(), AStreamSeekBlock(), AStreamSeekStream(), block_FindStartcodeFromOffset(), block_GetByte(), block_GetBytes(), block_PeekByte(), block_PeekBytes(), block_PeekOffsetBytes(), block_SkipByte(), block_SkipBytes(), block_WaitBytes(), CmdExecuteControl(), CmdExecuteSend(), CmdInitAdd(), CmdInitControl(), config_LoadConfigFile(), Control(), ControlLocked(), ControlLockedSetPauseState(), ControlLockedSetRate(), ControlLockedSetTime(), ControlPop(), decoder_GetInputAttachments(), DeinterlaceCallback(), DeleteFromInput(), demux_vaControlHelper(), dialog_ExtensionUpdate(), dialog_Register(), dialog_Unregister(), DownloadArt(), DStreamControl(), EsOutControlLocked(), EsOutProgramDel(), EsOutSetRecord(), filter_Blend(), filter_chain_MouseEvent(), filter_chain_MouseFilter(), filter_ConfigureBlend(), filter_GetInputAttachments(), FindArt(), http_auth_ParseAuthenticationInfoHeader(), httpd_StreamCallBack(), ImageWriteUrl(), info_category_DeleteInfo(), Init(), input_clock_ConvertTS(), input_clock_GetState(), input_DecoderGetCcState(), input_DecoderSetCcState(), input_item_AddOption(), input_item_DelInfo(), input_item_WriteMeta(), input_Preparse(), input_Read(), input_Start(), input_vaControl(), InputItemVaAddInfo(), InputSourceInit(), intf_Create(), libvlc_InternalAddIntf(), libvlc_InternalInit(), MainLoopTryRepeat(), ml_CopyMedia(), ml_CreateAppendPersonAdv(), module_load(), net_GetPeerAddress(), net_GetSockAddress(), net_SetCSCov(), net_SetMcastHopLimit(), OSDEpgValidate(), OSDTextValidate(), OSDWidgetValidate(), picture_Export(), picture_Setup(), playlist_AddInput(), playlist_DeleteFromItemId(), playlist_Export(), playlist_FindArtInCache(), playlist_FindArtInCacheUsingItemUID(), playlist_Import(), playlist_MLDump(), playlist_MLLoad(), playlist_NodeEmpty(), playlist_NodeRemoveItem(), playlist_SaveArt(), playlist_ServicesDiscoveryAdd(), playlist_ServicesDiscoveryControl(), playlist_ServicesDiscoveryRemove(), playlist_TreeMove(), playlist_TreeMoveMany(), PlaylistVAControl(), SAP_Add(), SocksHandshakeTCP(), SocksNegotiate(), sout_AccessOutControl(), sout_AccessOutRead(), SplitterControl(), SplitterPictureNew(), spu_get_attachments(), SpuHeapDeleteSubpicture(), SpuHeapPush(), StateCallback(), stream_Control(), stream_DemuxControlVa(), SubSourceAllocationInit(), ThreadDisplayPicture(), ThreadDisplayPreparePicture(), ThreadDisplayRenderPicture(), ThreadReinit(), ThreadStart(), TsPopCmdLocked(), TsStart(), UpdateVideoBufferFunctions(), var_Change(), var_Command(), var_DelCallback(), var_GetAndSet(), var_InheritURational(), vlc_error(), vlc_sd_control(), vlc_set_priority(), vlm_ControlMediaAdd(), vlm_ControlMediaChange(), vlm_ControlMediaDel(), vlm_ControlMediaGet(), vlm_ControlMediaGetId(), vlm_ControlMediaInstanceClear(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstanceGetTimePosition(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceSetTimePosition(), vlm_ControlMediaInstanceStart(), vlm_ControlMediaInstanceStop(), vlm_MediaDescriptionCheck(), vlm_MediaVodControl(), vlm_vaControlInternal(), vod_MediaControl(), vout_control_Pop(), vout_GetSnapshot(), vout_InitWrapper(), vout_OpenWrapper(), vout_OSDEpg(), vout_snapshot_SaveImage(), VoutSnapshotPip(), and VoutValidateFormat().

#define VLC_ENOITEM   (-8)

Item not found.

Referenced by playlist_DeleteFromInput().

#define VLC_ENOMEM   (-2)

Not enough memory.

Referenced by AddIntfCallback(), AllocatePicture(), config_SortConfig(), input_item_AddOption(), input_item_WriteMeta(), InputItemVaAddInfo(), intf_Create(), libvlc_InternalInit(), playlist_AddExt(), playlist_AddInput(), playlist_AskForArtEnqueue(), playlist_Export(), playlist_MLLoad(), playlist_PreparseEnqueue(), playlist_ServicesDiscoveryAdd(), var_Create(), var_LocationParse(), video_format_Copy(), vlc_error(), vlc_event_attach(), vlc_event_manager_register_event_type(), vlc_object_set_name(), vlc_probe_add(), vlc_sd_probe_Add(), vlm_ControlMediaAdd(), and vlm_ControlMediaInstanceStart().

#define VLC_ENOMOD   (-4)

Module not found.

Referenced by libvlc_InternalInit(), and vlc_error().

#define VLC_ENOOBJ   (-5)

Object not found.

Referenced by DecoderGetInputAttachments(), DumpCommand(), var_Command(), var_Inherit(), and vlc_error().

#define VLC_ENOVAR   (-6)

Variable not found.

Referenced by var_AddCallback(), var_Change(), var_DelCallback(), var_Destroy(), var_GetAndSet(), var_GetChecked(), var_SetChecked(), var_TriggerCallback(), and vlc_error().

#define VLC_ETIMEOUT   (-3)

Timeout.

Referenced by vlc_error(), and vlc_module_load().

#define VLC_EXPORT

#define VLC_EXTERN

#define VLC_FORMAT	(		x,
			y
	)

#define VLC_FORMAT_ARG

(

x

)

#define VLC_FOURCC	(		a,
			b,
			c,
			d
	)

Value:

( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )

Referenced by CreateFourcc(), input_DecoderSetCcState(), vlc_fourcc_GetCodecAudio(), and vlc_fourcc_GetCodecFromString().

#define vlc_fourcc_to_char	(		a,
			b
	)		vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )

#define vlc_free

(

base

)

free(base)

Referenced by PictureDestroy().

#define VLC_GCC_VERSION	(		maj,
			min
	)		(0)

#define VLC_MALLOC

#define VLC_NORETURN

#define VLC_OBJECT

(

x

)

((vlc_object_t *)(x))

Referenced by AddIntfCallback(), aout_FiltersNew(), aout_New(), Control(), Create(), DisplayNew(), DumpCommand(), EsOutControlLocked(), EsOutSetRecord(), httpd_HostCreate(), input_DecoderNew(), input_DecoderSetCcState(), input_ExtractAttachmentAndCacheArt(), input_Stop(), InputSourceInit(), libvlc_InternalCleanup(), libvlc_InternalInit(), ObjectKillChildrens(), pl_Get(), playlist_Create(), playlist_EnableAudioFilter(), playlist_ServicesDiscoveryAdd(), RequestVout(), SAP_Add(), sout_AnnounceRegisterSDP(), spu_Create(), stream_AccessNew(), stream_DemuxNew(), stream_FilterNew(), ThreadDisplayRenderPicture(), ThreadStart(), vlc_InitActions(), vlc_object_destroy(), vlc_threads_setup(), vlm_ControlMediaAdd(), vout_GetSnapshot(), vout_InitInterlacingSupport(), vout_ManageDisplay(), vout_NewDisplayWindow(), vout_NewSplitter(), vout_window_New(), VoutDisplayNewWindow(), VoutSaveSnapshot(), and VoutSnapshotPip().

#define vlc_pgettext	(		ctx,
			id
	)		vlc_pgettext_aux( ctx "\004" id, id )

#define VLC_SUCCESS   (-0)

No error.

Referenced by __extension_GetBool(), __ml_GetInt(), __ml_GetPsz(), __ml_GetValue(), AllocatePicture(), AllocatorInit(), AspectCallback(), AStreamControl(), AStreamRefillBlock(), AStreamRefillStream(), AStreamSeekBlock(), AStreamSeekStream(), block_FindStartcodeFromOffset(), block_GetByte(), block_GetBytes(), block_PeekByte(), block_PeekBytes(), block_PeekOffsetBytes(), block_SkipByte(), block_SkipBytes(), block_WaitBytes(), BookmarkCallback(), CmdInitAdd(), CmdInitControl(), CmdInitDel(), config_SortConfig(), Control(), ControlLocked(), ControlLockedGetBuffering(), ControlLockedGetEmpty(), ControlLockedGetWakeup(), ControlPause(), ControlPop(), ControlUnpause(), CorksCallback(), CropBorderCallback(), CropCallback(), DeinterlaceCallback(), demux_vaControlHelper(), dialog_Register(), dialog_Unregister(), DownloadArt(), DStreamControl(), DumpCommand(), EqualizerCallback(), es_format_Copy(), ESCallback(), EsDelayCallback(), EsOutControlLocked(), EsOutProgramDel(), EsOutSend(), EsOutSetRecord(), extension_DialogCommand(), filter_Blend(), filter_chain_DeleteFilterInternal(), filter_chain_MouseEvent(), filter_chain_MouseFilter(), filter_ConfigureBlend(), FilterAllocationInit(), FindArt(), FrameNextCallback(), FullscreenCallback(), http_auth_ParseAuthenticationInfoHeader(), httpd_FileCallBack(), httpd_HandlerCallBack(), httpd_RedirectCallBack(), httpd_StreamCallBack(), httpd_StreamHeader(), httpd_StreamSend(), httpd_UrlCatch(), ImageWriteUrl(), info_category_DeleteInfo(), Init(), input_clock_ConvertTS(), input_clock_GetState(), input_DecoderSetCcState(), input_item_AddOption(), input_item_DelInfo(), input_item_WriteMeta(), input_Preparse(), input_Read(), input_Start(), input_vaControl(), InputEvent(), InputEventPreparse(), InputItemVaAddInfo(), InputSourceInit(), InternalVideoInit(), intf_Create(), libvlc_InternalInit(), Lock(), MainLoopTryRepeat(), ml_CopyMedia(), ml_CopyPersons(), ml_CreateAppendPersonAdv(), module_load(), module_start(), mrl_Parse(), NavigationCallback(), net_SetCSCov(), net_SetMcastHopLimit(), OnTopCallback(), OSDEpgValidate(), OSDTextValidate(), OSDWidgetValidate(), picture_Export(), picture_Setup(), PlayItem(), playlist_AddInput(), playlist_AskForArtEnqueue(), playlist_DeleteFromInput(), playlist_Export(), playlist_FindArtInCache(), playlist_FindArtInCacheUsingItemUID(), playlist_ItemRelease(), playlist_LiveSearchUpdate(), playlist_MLDump(), playlist_MLLoad(), playlist_NodeDelete(), playlist_NodeEmpty(), playlist_NodeInsert(), playlist_NodeRemoveItem(), playlist_PreparseEnqueue(), playlist_SaveArt(), playlist_ServicesDiscoveryAdd(), playlist_ServicesDiscoveryRemove(), playlist_TreeMove(), playlist_TreeMoveMany(), PlaylistVAControl(), PositionCallback(), ProgramCallback(), RandomCallback(), RateCallback(), RateOffsetCallback(), RecordCallback(), recursiveNodeSort(), ReplayGainCallback(), SAP_Add(), ScalingCallback(), SeekpointCallback(), Send(), SnapshotCallback(), SocksHandshakeTCP(), SocksNegotiate(), sout_InputDelete(), sout_InputSendBuffer(), SplitterPictureNew(), spu_ProcessMouse(), SpuHeapDeleteSubpicture(), SpuHeapPush(), sql_GetColumnBlob(), sql_GetColumnDouble(), sql_GetColumnInteger(), sql_GetColumnText(), StateCallback(), stream_DemuxControlVa(), SubFilterCallback(), SubMarginCallback(), SubSourceAllocationInit(), SubSourceCallback(), ThreadDisplayPreparePicture(), ThreadDisplayRenderPicture(), ThreadReinit(), ThreadStart(), TimeCallback(), TitleCallback(), TriggerCallback(), TsPopCmdLocked(), TsStart(), UpdateBufferFunctions(), UpdateSPU(), UpdateVideoBufferFunctions(), var_AddCallback(), var_Change(), var_Create(), var_DelCallback(), var_Destroy(), var_GetChecked(), var_Inherit(), var_InheritURational(), var_LocationParse(), var_SetChecked(), video_format_Copy(), video_splitter_Mouse(), VideoFilterCallback(), VideoSplitterCallback(), VisualizationCallback(), vlc_error(), vlc_event_attach(), vlc_event_manager_init(), vlc_event_manager_register_event_type(), vlc_gl_Lock(), vlc_key_to_action(), vlc_module_load(), vlc_object_set_name(), vlc_probe_add(), vlc_set_priority(), vlc_tls_SessionCreate(), vlm_ControlMediaClear(), vlm_ControlMediaDel(), vlm_ControlMediaGet(), vlm_ControlMediaGetId(), vlm_ControlMediaGets(), vlm_ControlMediaInstanceClear(), vlm_ControlMediaInstanceGets(), vlm_ControlMediaInstanceGetTimePosition(), vlm_ControlMediaInstancePause(), vlm_ControlMediaInstanceStart(), vlm_ControlMediaInstanceStop(), vlm_ControlScheduleClear(), vlm_MediaDescriptionCheck(), vlm_OnMediaUpdate(), vout_control_Pop(), vout_GetSnapshot(), vout_InitWrapper(), vout_OpenWrapper(), vout_OSDEpg(), vout_snapshot_SaveImage(), VoutSnapshotPip(), VoutValidateFormat(), VoutVideoFilterInteractiveAllocationSetup(), and VoutVideoFilterStaticAllocationSetup().

#define VLC_TWOCC	(		a,
			b
	)		( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )

#define VLC_UNUSED

(

x

)

(void)(x)

Referenced by _DLL_InitTerm(), AspectCallback(), AvgClean(), BookmarkCallback(), config_FindConfig(), config_ResetAll(), CropBorderCallback(), CropCallback(), DeinterlaceCallback(), ESCallback(), EsDelayCallback(), EsDestroyDecoder(), FrameNextCallback(), input_item_changed(), InputEvent(), InputEventPreparse(), InputSourceNew(), InternalVideoInit(), media_New(), ml_DeletePersonTypeFromMedia(), ml_FtreeSpec(), ml_Get(), ml_GetPersonsFromMedia(), ml_OpConnectChilds(), ml_UpdateSimple(), NavigationCallback(), net_SetCSCov(), OSDEpgUpdate(), OSDEpgValidate(), OSDTextUpdate(), OSDTextValidate(), OSDWidgetUpdate(), OSDWidgetValidate(), playlist_sd_item_removeall(), PositionCallback(), ProgramCallback(), RateCallback(), RateOffsetCallback(), RecordCallback(), ReplayGainCallback(), SeekpointCallback(), SnapshotCallback(), spu_del_video_buffer(), spu_new_video_buffer(), StateCallback(), sub_del_buffer(), SubFilterCallback(), SubMarginCallback(), SubSourceCallback(), TimeCallback(), TitleCallback(), VideoBufferDelete(), VideoFilterCallback(), VideoSplitterCallback(), vlc_meta_FreeExtraKey(), vlm_Control(), vlm_Delete(), vlm_ExecuteCommand(), vlm_MessageAdd(), vlm_MessageDelete(), vlm_MessageNew(), vlm_MessageSimpleNew(), vout_chrono_Clean(), vout_DeleteDisplayWindow(), vout_NewDisplayWindow(), vout_SendEventMouseHidden(), vout_SendEventMouseVisible(), vout_SendEventOnTop(), vout_SendEventSourceAspect(), vout_SendEventSourceCrop(), vout_SendEventZoom(), and VoutVideoFilterDelPicture().

#define VLC_USED

Typedef Documentation

typedef struct access_sys_t access_sys_t

typedef struct access_t access_t

typedef struct aout_fifo_t aout_fifo_t

typedef struct aout_sys_t aout_sys_t

typedef struct audio_format_t audio_format_t

typedef struct audio_output audio_output_t

typedef audio_format_t audio_sample_format_t

typedef struct block_fifo_t block_fifo_t

typedef struct block_t block_t

typedef struct config_category_t config_category_t

typedef struct config_chain_t config_chain_t

typedef struct date_t date_t

typedef struct decoder_synchro_t decoder_synchro_t

typedef struct decoder_sys_t decoder_sys_t

typedef struct decoder_t decoder_t

typedef struct demux_sys_t demux_sys_t

typedef struct demux_t demux_t

typedef struct encoder_sys_t encoder_sys_t

typedef struct encoder_t encoder_t

typedef struct es_format_t es_format_t

typedef struct es_out_id_t es_out_id_t

typedef struct es_out_sys_t es_out_sys_t

typedef struct es_out_t es_out_t

typedef struct filter_sys_t filter_sys_t

typedef struct filter_t filter_t

typedef struct image_handler_t image_handler_t

typedef struct info_category_t info_category_t

typedef struct info_t info_t

typedef struct input_attachment_t input_attachment_t

typedef struct input_item_node_t input_item_node_t

typedef struct input_item_t input_item_t

typedef struct input_stats_t input_stats_t

typedef struct input_thread_t input_thread_t

typedef struct iso639_lang_t iso639_lang_t

typedef struct libvlc_int_t libvlc_int_t

typedef struct md5_s md5_t

typedef struct module_config_t module_config_t

typedef struct module_t module_t

typedef int64_t mtime_t

High precision date or time interval.

Store a high precision date or time interval. The maximum precision is the microsecond, and a 64 bits integer is used to avoid overflows (maximum time interval is then 292271 years, which should be long enough for any video). Dates are stored as microseconds since a common date (usually the epoch). Note that date and time intervals can be manipulated using regular arithmetic operators, and that no special functions are required.

typedef struct picture_sys_t picture_sys_t

typedef struct picture_t picture_t

typedef struct playlist_add_t playlist_add_t

typedef struct playlist_item_t playlist_item_t

typedef struct playlist_t playlist_t

typedef struct seekpoint_t seekpoint_t

typedef struct services_discovery_sys_t services_discovery_sys_t

typedef struct services_discovery_t services_discovery_t

typedef struct session_descriptor_t session_descriptor_t

typedef struct sout_access_out_sys_t sout_access_out_sys_t

typedef struct sout_access_out_t sout_access_out_t

typedef struct sout_input_t sout_input_t

typedef struct sout_instance_t sout_instance_t

typedef struct sout_mux_sys_t sout_mux_sys_t

typedef struct sout_mux_t sout_mux_t

typedef struct sout_packetizer_input_t sout_packetizer_input_t

typedef struct sout_stream_sys_t sout_stream_sys_t

typedef struct sout_stream_t sout_stream_t

typedef struct spu_t spu_t

typedef struct stream_sys_t stream_sys_t

typedef struct stream_t stream_t

typedef struct subpicture_region_t subpicture_region_t

typedef struct subpicture_t subpicture_t

typedef struct subs_format_t subs_format_t

typedef struct update_t update_t

typedef struct virtual_socket_t v_socket_t

typedef struct video_format_t video_format_t

typedef video_format_t video_frame_format_t

typedef struct video_palette_t video_palette_t

typedef int( * vlc_callback_t)(vlc_object_t *,char const *,vlc_value_t,vlc_value_t,void *)

typedef uint32_t vlc_fourcc_t

The vlc_fourcc_t type.

See http://www.webartz.com/fourcc/ for a very detailed list.

typedef struct vlc_list_t vlc_list_t

typedef struct vlc_meta_t vlc_meta_t

typedef struct vlc_object_t vlc_object_t

typedef struct vlc_url_t vlc_url_t

typedef struct vlm_message_t vlm_message_t

typedef struct vlm_t vlm_t

typedef struct vod_media_t vod_media_t

typedef struct vod_sys_t vod_sys_t

typedef struct vod_t vod_t

typedef struct vout_thread_t vout_thread_t

typedef struct xml_reader_sys_t xml_reader_sys_t

typedef struct xml_reader_t xml_reader_t

typedef struct xml_sys_t xml_sys_t

typedef struct xml_t xml_t

Enumeration Type Documentation

enum playlist_command_t

Playlist commands.

Enumerator:

PLAYLIST_PLAY	No arg. res=can fail
PLAYLIST_VIEWPLAY	arg1= playlist_item_t*,
PLAYLIST_PAUSE	arg2 = playlist_item_t* , res=can fail No arg res=can fail
PLAYLIST_STOP	No arg res=can fail.
PLAYLIST_SKIP	arg1=int, res=can fail

Function Documentation

static uint16_t bswap16 ( uint16_t  x )

inlinestatic

Byte swap (16 bits)

Referenced by GetWLE(), and SetWLE().

static uint32_t bswap32 ( uint32_t  x )

inlinestatic

Byte swap (32 bits)

Referenced by GetDWLE(), and SetDWLE().

static uint64_t bswap64 ( uint64_t  x )

inlinestatic

Byte swap (64 bits)

Referenced by GetQWLE(), and SetQWLE().

static uint8_t clip_uint8_vlc ( int32_t  a )

inlinestatic

static unsigned clz ( unsigned  x )

inlinestatic

Count leading zeroes.

static unsigned ctz ( unsigned  x )

inlinestatic

Count trailing zeroes.

static int64_t GCD ( int64_t  a, int64_t  b  )

inlinestatic

Referenced by LCM().

static uint32_t GetDWLE ( const void *  p )

inlinestatic

Reads 32 bits in little-endian order.

References bswap32().

Referenced by SkipAPETag().

static uint64_t GetQWLE ( const void *  p )

inlinestatic

Reads 64 bits in little-endian order.

References bswap64().

static uint16_t GetWLE ( const void *  p )

inlinestatic

Reads 16 bits in little-endian order.

References bswap16().

static unsigned parity ( unsigned  x )

inlinestatic

static unsigned popcount ( unsigned  x )

inlinestatic

Bit weight.

References count.

Referenced by aout_FormatNbChannels().

static void SetDWBE ( void *  p, uint32_t  dw  )

inlinestatic

Writes 32 bits in network byte order.

References hton32.

static void SetDWLE ( void *  p, uint32_t  dw  )

inlinestatic

Writes 32 bits in little endian order.

References bswap32().

static void SetQWBE ( void *  p, uint64_t  qw  )

inlinestatic

Writes 64 bits in network byte order.

References hton64.

static void SetQWLE ( void *  p, uint64_t  qw  )

inlinestatic

Writes 64 bits in little endian order.

References bswap64().

static void SetWBE ( void *  p, uint16_t  w  )

inlinestatic

Writes 16 bits in network byte order.

References hton16.

Referenced by SocksHandshakeTCP().

static void SetWLE ( void *  p, uint16_t  w  )

inlinestatic

Writes 16 bits in little endian order.

References bswap16().

static uint16_t U16_AT ( const void *  p )

inlinestatic

Reads 16 bits in network byte order.

References ntoh16.

Referenced by stream_ReadLine().

static uint32_t U32_AT ( const void *  p )

inlinestatic

Reads 32 bits in network byte order.

References ntoh32.

static uint64_t U64_AT ( const void *  p )

inlinestatic

Reads 64 bits in network byte order.

References ntoh64.

const char* VLC_CompileBy

(

void

)

Referenced by Version().

const char* VLC_CompileHost

(

void

)

Referenced by Version().

const char* VLC_Compiler

(

void

)

Referenced by Version().

char const* vlc_error

(

int

)

< No error

< Not enough memory

< Timeout

< Module not found

< Object not found

< Variable not found

< Bad variable value

< Unspecified error

References VLC_EBADVAR, VLC_EGENERIC, VLC_ENOMEM, VLC_ENOMOD, VLC_ENOOBJ, VLC_ENOVAR, VLC_ETIMEOUT, and VLC_SUCCESS.

Referenced by var_Command().

static void vlc_fourcc_to_char ( (vlc_fourcc_t)(vlc_fourcc_t fcc)  , (char *)(char *psz_fourcc)    )

inlinestatic

Translate a vlc_fourcc into its string representation.

This function assumes there is enough room in psz_fourcc to store 4 characters in.

Parameters

fcc	a vlc_fourcc_t
psz_fourcc	string to store string representation of vlc_fourcc in

char* vlc_gettext

(

const char *

msgid

)

In-tree plugins share their gettext domain with LibVLC.

References likely.

Referenced by aout_New(), config_CategoryHelpGet(), config_CategoryNameGet(), config_GetIntChoices(), config_GetPszChoices(), config_Write(), decoder_New(), EsOutProgramMeta(), EsOutUpdateInfo(), LanguageGetName(), vlc_keycode2str(), vlc_meta_TypeToLocalizedString(), vlc_pgettext_aux(), and vout_InitInterlacingSupport().

static void* vlc_memalign ( size_t  align, size_t  size  )

inlinestatic

Referenced by AllocatePicture().

char* vlc_ngettext	(	const char *	s,
		const char *	p,
		unsigned long	n
	)

References likely.

Referenced by Usage().

static const char* vlc_pgettext_aux ( const char *  ctx, const char *  id  )

inlinestatic

References vlc_gettext().

void vlc_tdestroy	(	void *	,
		void(*)(void *)
	)

bool vlc_ureduce	(	unsigned *	,
		unsigned *	,
		uint64_t	,
		uint64_t	,
		uint64_t
	)

Referenced by EsOutAdd(), SpuRenderSubpictures(), var_InheritURational(), video_format_ScaleCropAr(), video_format_Setup(), vout_ManageDisplay(), vout_new_buffer(), vout_SetDisplayAspect(), vout_UpdateDisplaySourceProperties(), VoutGetDisplayCfg(), and VoutValidateFormat().

static void* xcalloc ( size_t  n, size_t  size  )

inlinestatic

static void* xmalloc ( size_t  len )

inlinestatic

References unlikely.

Referenced by config_GetIntChoices(), config_GetPszChoices(), config_ListModules(), config_StringEscape(), EnumClockSource(), httpd_ClientInit(), httpd_ClientSend(), httpd_FileNew(), httpd_HandlerCallBack(), httpd_HandlerNew(), httpd_HostThread(), httpd_RedirectNew(), httpd_StreamCallBack(), httpd_StreamHeader(), httpd_StreamNew(), httpd_UrlNew(), SpuRenderCreateAndLoadText(), ThreadChangeFilters(), and vlc_plugin_setter().

static void* xrealloc ( void *  ptr, size_t  len  )

inlinestatic

Referenced by AppendAttachment(), EsOutControlLocked(), httpd_HandlerCallBack(), and net_Gets().

static char* xstrdup ( const char *  str )

inlinestatic