Data Structures | Defines | Typedefs | Enumerations | Functions

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...
union  vlc_atomic_t
 Memory storage space for an atom. More...
struct  gc_object_t

Defines

#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
#define VLC_ENOMEM   -1
#define VLC_ETIMEOUT   -3
#define VLC_ENOMOD   -10
#define VLC_ENOOBJ   -20
#define VLC_ENOVAR   -30
#define VLC_EBADVAR   -31
#define VLC_ENOITEM   -40
 Item not found.
#define VLC_EEXIT   -255
#define VLC_EEXITSUCCESS   -999
#define VLC_EGENERIC   -666
#define VLC_COMMON_MEMBERS
#define VLC_OBJECT(x)   ((vlc_object_t *)(x))
#define VLC_GC_MEMBERS   gc_object_t vlc_gc_data;
 These members are common to all objects that wish to be garbage-collected.
#define vlc_gc_init(a, b)   vlc_gc_init( &(a)->vlc_gc_data, (b) )
#define vlc_gc_incref(a)   vlc_hold( &(a)->vlc_gc_data )
#define vlc_gc_decref(a)   vlc_release( &(a)->vlc_gc_data )
#define vlc_priv(gc, t)   ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
#define CEIL(n, d)   ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
#define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
#define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
#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_memset   memset
#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 uint16_t audio_volume_t
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 playlist_view_t playlist_view_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 struct aout_input_t aout_input_t
typedef struct block_t aout_buffer_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_sys_t subpicture_sys_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_instance_sys_t sout_instance_sys_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_acl_t vlc_acl_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 httpd_t httpd_t
typedef struct httpd_host_t httpd_host_t
typedef struct httpd_url_t httpd_url_t
typedef struct httpd_client_t httpd_client_t
typedef struct httpd_callback_sys_t httpd_callback_sys_t
typedef struct httpd_message_t httpd_message_t
typedef int(* httpd_callback_t )(httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query)
typedef struct httpd_file_t httpd_file_t
typedef struct httpd_file_sys_t httpd_file_sys_t
typedef int(* httpd_file_callback_t )(httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data)
typedef struct httpd_handler_t httpd_handler_t
typedef struct httpd_handler_sys_t httpd_handler_sys_t
typedef int(* httpd_handler_callback_t )(httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data)
typedef struct httpd_redirect_t httpd_redirect_t
typedef struct httpd_stream_t httpd_stream_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 osd_menu_t osd_menu_t
typedef struct osd_state_t osd_state_t
typedef struct osd_event_t osd_event_t
typedef struct osd_button_t osd_button_t
typedef struct osd_menu_state_t osd_menu_state_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 struct update_iterator_t update_iterator_t
typedef struct meta_engine_t meta_engine_t
typedef int(* vlc_callback_t )(vlc_object_t *, char const *, vlc_value_t, vlc_value_t, void *)
typedef struct gc_object_t gc_object_t

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 fcc, char *psz_fourcc)
 Translate a vlc_fourcc into its string representation.
void * vlc_gc_init (gc_object_t *, void(*)(gc_object_t *))
 Atomically set the reference count to 1.
void * vlc_hold (gc_object_t *)
 Atomically increment the reference count.
void vlc_release (gc_object_t *)
 Atomically decrement the reference count and, if it reaches zero, destroy.
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 popcount (unsigned x)
 Bit weight.
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 *))
void * vlc_memcpy (void *, const void *, size_t)
 vlc_memcpy: fast CPU-dependent memcpy
char * vlc_gettext (const char *msgid)
 In-tree plugins share their gettext domain with LibVLC.
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)
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.

Define Documentation

#define __MAX (   a,
  b 
)    ( ((a) > (b)) ? (a) : (b) )

Referenced by aout_InputNew(), AStreamPeekBlock(), EsOutDecodersStopBuffering(), input_clock_GetJitter(), input_clock_SetJitter(), input_clock_Update(), input_EsOutTimeshiftNew(), OSDIcon(), OSDSlider(), spu_area_overlap(), SpuRenderRegion(), SpuSelectSubpictures(), TsStoragePack(), UpdatePtsDelay(), vlc_timer_schedule(), vout_chrono_GetLow(), vout_ControlChangeCropBorder(), vout_ControlChangeCropWindow(), and vout_InitWrapper().

#define __MIN (   a,
  b 
)    ( ((a) < (b)) ? (a) : (b) )

Referenced by AStreamPeekBlock(), AStreamPrebufferStream(), AStreamReadNoSeekStream(), AStreamRefillStream(), AStreamSeekStream(), AvgUpdate(), block_ChainExtract(), block_GetBytes(), block_PeekBytes(), block_PeekOffsetBytes(), block_SkipBytes(), block_WaitBytes(), Control(), DecoderUpdatePreroll(), DStreamControl(), DStreamPeek(), DStreamRead(), EsOutControlLocked(), httpd_StreamCallBack(), httpd_StreamSend(), input_clock_GetJitter(), MainLoop(), OSDIcon(), OSDSlider(), Peek(), plane_CopyPixels(), Read(), SocksHandshakeTCP(), SocksNegotiate(), spu_area_overlap(), SpuRenderRegion(), stream_BlockRemaining(), ThreadDisplayPicture(), UpdatePtsDelay(), vlc_timer_schedule(), vout_control_Pop(), and vout_display_PlacePicture().

#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(), GetTmpPath(), input_CreateFilename(), make_URI(), playlist_FindArtInCache(), playlist_MLDump(), playlist_MLLoad(), subtitles_Detect(), vlc_bindtextdomain(), and vout_snapshot_SaveImage().

#define DIR_SEP_CHAR   '/'

Referenced by ArtCacheCreateDir(), config_CreateDir(), make_URI(), and subtitles_Detect().

#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(), 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_CheckRestart(), aout_DecGetResetLost(), aout_DecNewBuffer(), aout_ReplayGainSelect(), aout_Shutdown(), convert_xml_special_chars(), EnsureUTF8(), ImageWrite(), IsUTF8(), module_InitBank(), psz_md5_hash(), ReleaseAout(), utf8_vfprintf(), var_GetCoords(), var_LocationParse(), vlc_cancel_self(), vlc_custom_create(), vlc_dup(), vlc_list_children(), vlc_module_load(), vlc_object_release(), vlc_sem_destroy(), vlc_sem_post(), vlc_sem_wait(), and vlm_New().

#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 AllocateAout(), aout_DecPlay(), aout_FifoInit(), aout_InputNew(), aout_MixerNew(), aout_New(), aout_OutputSlice(), block_Alloc(), config_FindConfig(), config_SortConfig(), convert_xml_special_chars(), CreateDecoder(), DecoderGetInputAttachments(), findAout(), make_path(), mdate(), module_find(), module_get_object(), module_gettext(), module_InitStatic(), module_provides(), mwait(), net_Write(), playlist_AskForArtEnqueue(), playlist_Create(), playlist_PreparseEnqueue(), secstotimestr(), ToCharset(), utf8_vfprintf(), var_Create(), var_Inherit(), vlc_bindtextdomain(), vlc_clone_attr(), vlc_cond_init(), vlc_cond_init_daytime(), vlc_custom_create(), vlc_DeinitActions(), vlc_dup(), vlc_GetCPUCount(), vlc_getcwd(), vlc_gettext(), vlc_gl_Create(), vlc_InitActions(), vlc_loaddir(), vlc_MapAction(), vlc_memalign(), vlc_mkdir(), vlc_mutex_init(), vlc_mutex_init_recursive(), vlc_object_destroy(), vlc_opendir(), vlc_plugin_setter(), vlc_probe(), vlc_probe_add(), vlc_readdir(), vlc_restorecancel(), vlc_rwlock_init(), vlc_rwlock_rdlock(), 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_WaitForMultipleObjects(), vlc_xlib_init(), xcalloc(), xmalloc(), xml_ReaderCreate(), and xrealloc().

#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 */                                                 \
    volatile bool b_die;                   /**< set by the outside */ \
    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   -31

Referenced by vlc_error().

#define VLC_EEXIT   -255

Referenced by vlc_error().

#define VLC_EEXITSUCCESS   -999
#define VLC_EGENERIC   -666

Referenced by filter_chain_MouseEvent(), filter_chain_MouseFilter(), FindArt(), ImageWriteUrl(), input_vaControl(), net_GetPeerAddress(), net_GetSockAddress(), net_SetCSCov(), and vlc_error().

#define VLC_ENOITEM   -40

Item not found.

Referenced by playlist_DeleteFromInput().

#define VLC_ENOMEM   -1

Referenced by AddIntfCallback(), vlc_error(), and vlc_probe_add().

#define VLC_ENOMOD   -10

Referenced by vlc_error().

#define VLC_ENOOBJ   -20

Referenced by vlc_error().

#define VLC_ENOVAR   -30

Referenced by vlc_error().

#define VLC_ETIMEOUT   -3

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_gc_decref (   a  )     vlc_release( &(a)->vlc_gc_data )

Referenced by Destructor(), input_resource_Release(), playlist_AddExt(), playlist_Destroy(), playlist_fetcher_Delete(), playlist_MLLoad(), playlist_NodeCreate(), playlist_preparser_Delete(), RecursiveInsertCopy(), RecursiveNodeDelete(), Thread(), vlm_ControlMediaDel(), vlm_MediaInstanceDelete(), and vlm_OnMediaUpdate().

#define vlc_gc_incref (   a  )     vlc_hold( &(a)->vlc_gc_data )

Referenced by Create(), input_item_node_Create(), input_resource_Hold(), playlist_fetcher_Push(), playlist_ItemNewFromInput(), and playlist_preparser_Push().

#define vlc_gc_init (   a,
  b 
)    vlc_gc_init( &(a)->vlc_gc_data, (b) )

Referenced by input_item_NewWithType(), and input_resource_New().

#define VLC_GC_MEMBERS   gc_object_t vlc_gc_data;

These members are common to all objects that wish to be garbage-collected.

#define VLC_GCC_VERSION (   maj,
  min 
)    (0)
#define VLC_MALLOC
#define vlc_memset   memset

Referenced by aout_OutputSlice().

#define VLC_NORETURN
#define VLC_OBJECT (   x  )     ((vlc_object_t *)(x))

Referenced by AddIntfCallback(), aout_EnableFilter(), aout_New(), Control(), Create(), DisplayNew(), DumpCommand(), EsOutControlLocked(), EsOutSetRecord(), FindArt(), httpd_HostCreate(), httpd_HostThread(), input_DecoderNew(), input_DecoderSetCcState(), input_Stop(), InputSourceInit(), libvlc_InternalCleanup(), libvlc_InternalInit(), ObjectKillChildrens(), osd_MenuActivate(), osd_MenuDelete(), osd_MenuDown(), osd_MenuUp(), PlayItem(), playlist_FindInput(), playlist_ServicesDiscoveryAdd(), prepareVolume(), Preparse(), RequestVout(), SAP_Add(), sout_AnnounceRegisterSDP(), spu_Create(), stream_AccessNew(), stream_DemuxNew(), stream_FilterNew(), ThreadDisplayRenderPicture(), ThreadStart(), var_Inherit(), vlc_InitActions(), vlc_object_destroy(), 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_priv (   gc,
  t 
)    ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))

Referenced by Destructor(), and input_item_Destroy().

#define VLC_SUCCESS   -0

Referenced by __extension_GetBool(), __ml_GetInt(), __ml_GetPsz(), __ml_GetValue(), AllocatePicture(), EsOutControlLocked(), ml_CopyPersons(), mrl_Parse(), playlist_DeleteFromInput(), playlist_FindArtInCache(), playlist_NodeRemoveItem(), sout_InputDelete(), sql_GetColumnBlob(), sql_GetColumnDouble(), sql_GetColumnInteger(), sql_GetColumnText(), UpdateSPU(), var_Inherit(), vlc_error(), vlc_module_load(), vlc_object_set_name(), vlm_ControlMediaInstanceStart(), and vout_control_Pop().

#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_Create(), ml_DeletePersonTypeFromMedia(), ml_Destroy(), ml_FtreeSpec(), ml_Get(), ml_GetPersonsFromMedia(), ml_OpConnectChilds(), ml_PlaySmartPlaylistBasedOn(), ml_UpdateSimple(), NavigationCallback(), net_SetCSCov(), OSDEpgUpdate(), OSDEpgValidate(), OSDTextUpdate(), OSDTextValidate(), OSDWidgetUpdate(), OSDWidgetValidate(), PositionCallback(), PostProcessCallback(), ProgramCallback(), RateCallback(), RateOffsetCallback(), RecordCallback(), ReplayGainCallback(), RequestVout(), SeekpointCallback(), SnapshotCallback(), spu_del_video_buffer(), spu_new_video_buffer(), StateCallback(), sub_del_buffer(), SubFilterCallback(), SubMarginCallback(), SubSourceCallback(), system_Configure(), 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 block_t aout_buffer_t
typedef struct aout_fifo_t aout_fifo_t
typedef struct aout_input_t aout_input_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 uint16_t audio_volume_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 gc_object_t gc_object_t
typedef struct httpd_callback_sys_t httpd_callback_sys_t
typedef int(* httpd_callback_t)(httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query)
typedef struct httpd_client_t httpd_client_t
typedef int(* httpd_file_callback_t)(httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data)
typedef struct httpd_file_sys_t httpd_file_sys_t
typedef struct httpd_file_t httpd_file_t
typedef int(* httpd_handler_callback_t)(httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data)
typedef struct httpd_handler_sys_t httpd_handler_sys_t
typedef struct httpd_handler_t httpd_handler_t
typedef struct httpd_host_t httpd_host_t
typedef struct httpd_message_t httpd_message_t
typedef struct httpd_redirect_t httpd_redirect_t
typedef struct httpd_stream_t httpd_stream_t
typedef struct httpd_t httpd_t
typedef struct httpd_url_t httpd_url_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 meta_engine_t meta_engine_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 osd_button_t osd_button_t
typedef struct osd_event_t osd_event_t
typedef struct osd_menu_state_t osd_menu_state_t
typedef struct osd_menu_t osd_menu_t
typedef struct osd_state_t osd_state_t
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 playlist_view_t playlist_view_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_sys_t sout_instance_sys_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_sys_t subpicture_sys_t
typedef struct subpicture_t subpicture_t
typedef struct subs_format_t subs_format_t
typedef struct update_iterator_t update_iterator_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 struct vlc_acl_t vlc_acl_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  )  [inline, static]

Byte swap (16 bits).

Referenced by GetWLE(), and SetWLE().

static uint32_t bswap32 ( uint32_t  x  )  [inline, static]

Byte swap (32 bits).

Referenced by GetDWLE(), and SetDWLE().

static uint64_t bswap64 ( uint64_t  x  )  [inline, static]

Byte swap (64 bits).

Referenced by GetQWLE(), and SetQWLE().

static uint8_t clip_uint8_vlc ( int32_t  a  )  [inline, static]
static unsigned clz ( unsigned  x  )  [inline, static]

Count leading zeroes.

static int64_t GCD ( int64_t  a,
int64_t  b 
) [inline, static]

Referenced by LCM().

static uint32_t GetDWLE ( const void *  p  )  [inline, static]

Reads 32 bits in little-endian order.

References bswap32().

Referenced by SkipAPETag().

static uint64_t GetQWLE ( const void *  p  )  [inline, static]

Reads 64 bits in little-endian order.

References bswap64().

static uint16_t GetWLE ( const void *  p  )  [inline, static]

Reads 16 bits in little-endian order.

References bswap16().

static unsigned popcount ( unsigned  x  )  [inline, static]

Bit weight.

References count.

Referenced by aout_FormatNbChannels(), and vlc_GetCPUCount().

static void SetDWBE ( void *  p,
uint32_t  dw 
) [inline, static]

Writes 32 bits in network byte order.

References hton32.

static void SetDWLE ( void *  p,
uint32_t  dw 
) [inline, static]

Writes 32 bits in little endian order.

References bswap32().

static void SetQWBE ( void *  p,
uint64_t  qw 
) [inline, static]

Writes 64 bits in network byte order.

References hton64.

static void SetQWLE ( void *  p,
uint64_t  qw 
) [inline, static]

Writes 64 bits in little endian order.

References bswap64().

static void SetWBE ( void *  p,
uint16_t  w 
) [inline, static]

Writes 16 bits in network byte order.

References hton16.

Referenced by SocksHandshakeTCP().

static void SetWLE ( void *  p,
uint16_t  w 
) [inline, static]

Writes 16 bits in little endian order.

References bswap16().

static uint16_t U16_AT ( const void *  p  )  [inline, static]

Reads 16 bits in network byte order.

References ntoh16.

Referenced by stream_ReadLine().

static uint32_t U32_AT ( const void *  p  )  [inline, static]

Reads 32 bits in network byte order.

References ntoh32.

static uint64_t U64_AT ( const void *  p  )  [inline, static]

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   ) 

References VLC_EBADVAR, VLC_EEXIT, 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  fcc,
char *  psz_fourcc 
) [inline, static]

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
void* vlc_gc_init ( gc_object_t *  p_gc,
void(*)(gc_object_t *)  pf_destruct 
)

Atomically set the reference count to 1.

Parameters:
p_gc reference counted object
pf_destruct destruction calback
Returns:
p_gc.

References gc_object_t::pf_destructor, gc_object_t::refs, and vlc_atomic_set().

char* vlc_gettext ( const char *  msgid  ) 

In-tree plugins share their gettext domain with LibVLC.

References unlikely.

Referenced by config_CategoryHelpGet(), config_CategoryNameGet(), config_Write(), decoder_New(), EsOutProgramMeta(), EsOutUpdateInfo(), vlc_meta_TypeToLocalizedString(), vlc_pgettext_aux(), and vout_InitInterlacingSupport().

void* vlc_hold ( gc_object_t *  p_gc  ) 

Atomically increment the reference count.

Parameters:
p_gc reference counted object
Returns:
p_gc.

References gc_object_t::refs, and vlc_atomic_inc().

static void* vlc_memalign ( size_t  align,
size_t  size 
) [inline, static]

References unlikely.

Referenced by AllocatePicture().

void* vlc_memcpy ( void *  ,
const void *  ,
size_t   
)

vlc_memcpy: fast CPU-dependent memcpy

References pf_vlc_memcpy.

Referenced by aout_OutputSlice(), and plane_CopyPixels().

static const char* vlc_pgettext_aux ( const char *  ctx,
const char *  id 
) [inline, static]

References vlc_gettext().

void vlc_release ( gc_object_t *  p_gc  ) 

Atomically decrement the reference count and, if it reaches zero, destroy.

Parameters:
p_gc reference counted object.

References gc_object_t::pf_destructor, gc_object_t::refs, and vlc_atomic_dec().

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 
) [inline, static]

References unlikely.

static void* xmalloc ( size_t  len  )  [inline, static]

References unlikely.

Referenced by config_StringEscape(), httpd_ClientInit(), httpd_ClientSend(), httpd_FileNew(), httpd_HandlerCallBack(), httpd_HandlerNew(), httpd_HostThread(), httpd_RedirectNew(), httpd_StreamCallBack(), httpd_StreamHeader(), httpd_StreamNew(), httpd_UrlNewPrivate(), SpuRenderCreateAndLoadText(), ThreadChangeFilters(), and vlc_plugin_setter().

static void* xrealloc ( void *  ptr,
size_t  len 
) [inline, static]

References unlikely.

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

 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Generated by  doxygen 1.7.1