* Collection of useful common types and macros definitions
*****************************************************************************
* Copyright (C) 1998, 1999, 2000 VideoLAN
- * $Id: vlc_common.h,v 1.30 2002/10/16 15:10:39 sam Exp $
+ * $Id: vlc_common.h,v 1.67 2003/06/05 11:52:19 gbazin Exp $
*
* Authors: Samuel Hocevar <sam@via.ecp.fr>
* Vincent Seguin <seguin@via.ecp.fr>
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
- *
+ *
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
#if defined( __BORLANDC__ )
# undef HAVE_VARIADIC_MACROS
# undef HAVE_STDINT_H
+# undef HAVE_INTTYPES_H
+# undef off_t
#endif
#include "vlc_config.h"
/*****************************************************************************
* Basic types definitions
*****************************************************************************/
-#ifdef HAVE_STDINT_H
+#if defined( HAVE_STDINT_H )
# include <stdint.h>
- typedef uint8_t u8;
- typedef int8_t s8;
-
- typedef uint16_t u16;
- typedef int16_t s16;
-
- typedef uint32_t u32;
- typedef int32_t s32;
-
- typedef uint64_t u64;
- typedef int64_t s64;
+#elif defined( HAVE_INTTYPES_H )
+# include <inttypes.h>
+#elif defined( SYS_CYGWIN )
+# include <sys/types.h>
+ /* Cygwin only defines half of these... */
+ typedef u_int8_t uint8_t;
+ typedef u_int16_t uint16_t;
+ typedef u_int32_t uint32_t;
+ typedef u_int64_t uint64_t;
#else
- typedef unsigned char u8;
- typedef signed char s8;
-
- typedef unsigned short u16;
- typedef signed short s16;
-
- typedef unsigned int u32;
- typedef signed int s32;
-
-# if defined( _MSC_VER ) || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
- typedef unsigned __int64 u64;
- typedef signed __int64 s64;
+ /* Fallback types (very x86-centric, sorry) */
+ typedef unsigned char uint8_t;
+ typedef signed char int8_t;
+ typedef unsigned short uint16_t;
+ typedef signed short int16_t;
+ typedef unsigned int uint32_t;
+ typedef signed int int32_t;
+# if defined( _MSC_VER ) \
+ || defined( UNDER_CE ) \
+ || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
+ typedef unsigned __int64 uint64_t;
+ typedef signed __int64 int64_t;
# else
- typedef unsigned long long u64;
- typedef signed long long s64;
+ typedef unsigned long long uint64_t;
+ typedef signed long long int64_t;
# endif
#endif
-typedef u8 byte_t;
+typedef uint8_t byte_t;
/* ptrdiff_t definition */
#ifdef HAVE_STDDEF_H
#endif
#if defined( WIN32 )
+# include <malloc.h>
+#endif
+
+#if defined( WIN32 ) || defined( UNDER_CE )
typedef int ssize_t;
#endif
typedef unsigned long count_t;
/* DCT elements types */
-typedef s16 dctelem_t;
+typedef int16_t dctelem_t;
/* Video buffer types */
-typedef u8 yuv_data_t;
+typedef uint8_t yuv_data_t;
/* Audio volume */
-typedef u16 audio_volume_t;
+typedef uint16_t audio_volume_t;
+
+#ifndef HAVE_SOCKLEN_T
+typedef int socklen_t;
+#endif
+
+/*****************************************************************************
+ * Old types definitions
+ *****************************************************************************
+ * We still provide these types because most of the VLC code uses them
+ * instead of the C9x types. They should be removed when the transition is
+ * complete (probably in 10 years).
+ *****************************************************************************/
+typedef uint8_t u8;
+typedef int8_t s8;
+typedef uint16_t u16;
+typedef int16_t s16;
+typedef uint32_t u32;
+typedef int32_t s32;
+typedef uint64_t u64;
+typedef int64_t s64;
/*****************************************************************************
* mtime_t: high precision date or time interval
*****************************************************************************
- * Store an high precision date or time interval. The maximum precision is the
- * micro-second, and a 64 bits integer is used to avoid any overflow (maximum
+ * 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). Date are stored as a time interval since a common date.
- * Note that date and time intervals can be manipulated using regular
+ * 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 s64 mtime_t;
+typedef int64_t mtime_t;
/*****************************************************************************
* The vlc_fourcc_t type.
*****************************************************************************
* See http://www.webartz.com/fourcc/ for a very detailed list.
*****************************************************************************/
-typedef u32 vlc_fourcc_t;
+typedef uint32_t vlc_fourcc_t;
#ifdef WORDS_BIGENDIAN
# define VLC_FOURCC( a, b, c, d ) \
- ( ((u32)d) | ( ((u32)c) << 8 ) | ( ((u32)b) << 16 ) | ( ((u32)a) << 24 ) )
+ ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
+ | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
# define VLC_TWOCC( a, b ) \
- ( (u16)(b) | ( (u16)(a) << 8 ) )
+ ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
#else
# define VLC_FOURCC( a, b, c, d ) \
- ( ((u32)a) | ( ((u32)b) << 8 ) | ( ((u32)c) << 16 ) | ( ((u32)d) << 24 ) )
+ ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
+ | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
# define VLC_TWOCC( a, b ) \
- ( (u16)(a) | ( (u16)(b) << 8 ) )
+ ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
#endif
/* Internal types */
typedef struct libvlc_t libvlc_t;
typedef struct vlc_t vlc_t;
-typedef struct vlc_list_t vlc_list_t;
-typedef struct vlc_object_t vlc_object_t;
typedef struct variable_t variable_t;
/* Messages */
typedef struct picture_heap_t picture_heap_t;
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
+typedef struct vout_synchro_t vout_synchro_t;
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
typedef struct sout_fifo_t sout_fifo_t;
-
+typedef struct sout_input_t sout_input_t;
+typedef struct sout_packetizer_input_t sout_packetizer_input_t;
+typedef struct sout_buffer_t sout_buffer_t;
+typedef struct sout_access_out_t sout_access_out_t;
+typedef struct sout_mux_t sout_mux_t;
+typedef struct sout_stream_t sout_stream_t;
+typedef struct sout_cfg_t sout_cfg_t;
+typedef struct sout_format_t sout_format_t;
+typedef struct sap_session_t sap_session_t;
/* Decoders */
typedef struct decoder_fifo_t decoder_fifo_t;
typedef struct network_socket_t network_socket_t;
typedef struct iso639_lang_t iso639_lang_t;
+/*****************************************************************************
+ * Variable callbacks
+ *****************************************************************************/
+typedef int ( * vlc_callback_t ) ( vlc_object_t *, /* variable's object */
+ char const *, /* variable name */
+ vlc_value_t, /* old value */
+ vlc_value_t, /* new value */
+ void * ); /* callback data */
+
/*****************************************************************************
* Plug-in stuff
*****************************************************************************/
/*****************************************************************************
* OS-specific headers and thread types
*****************************************************************************/
-#if defined( WIN32 )
+#if defined( WIN32 ) || defined( UNDER_CE )
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
+# define IS_WINNT ( GetVersion() < 0x80000000 )
#endif
#include "vlc_threads.h"
#ifdef NTOHL_IN_SYS_PARAM_H
# include <sys/param.h>
-#elif !defined(WIN32) /* NTOHL_IN_SYS_PARAM_H || WIN32 */
+#elif !defined(WIN32) && !defined( UNDER_CE )
# include <netinet/in.h>
#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
# define __MIN(a, b) ( ((a) < (b)) ? (a) : (b) )
#endif
+/* Dynamic array handling: realloc array, move data, increment position */
+#define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem ) \
+ do \
+ { \
+ if( i_oldsize ) \
+ { \
+ (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
+ } \
+ else \
+ { \
+ (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) ); \
+ } \
+ if( (i_oldsize) - (i_pos) ) \
+ { \
+ memmove( (p_ar) + (i_pos) + 1, \
+ (p_ar) + (i_pos), \
+ ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \
+ } \
+ (p_ar)[i_pos] = elem; \
+ (i_oldsize)++; \
+ } \
+ while( 0 )
+
+#define REMOVE_ELEM( p_ar, i_oldsize, i_pos ) \
+ do \
+ { \
+ if( (i_oldsize) - (i_pos) - 1 ) \
+ { \
+ memmove( (p_ar) + (i_pos), \
+ (p_ar) + (i_pos) + 1, \
+ ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) ); \
+ } \
+ if( i_oldsize > 1 ) \
+ { \
+ (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) ); \
+ } \
+ else \
+ { \
+ free( p_ar ); \
+ (p_ar) = NULL; \
+ } \
+ (i_oldsize)--; \
+ } \
+ while( 0 )
+
+
/* MSB (big endian)/LSB (little endian) conversions - network order is always
* MSB, and should be used for both network communications and files. Note that
* byte orders other than little and big endians are not supported, but only
* the VAX seems to have such exotic properties. */
-static inline u16 U16_AT( void * _p )
+static inline uint16_t U16_AT( void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u16)p[0] << 8) | p[1] );
+ uint8_t * p = (uint8_t *)_p;
+ return ( ((uint16_t)p[0] << 8) | p[1] );
}
-static inline u32 U32_AT( void * _p )
+static inline uint32_t U32_AT( void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u32)p[0] << 24) | ((u32)p[1] << 16) | ((u32)p[2] << 8) | p[3] );
+ uint8_t * p = (uint8_t *)_p;
+ return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
+ | ((uint32_t)p[2] << 8) | p[3] );
}
-static inline u64 U64_AT( void * _p )
+static inline uint64_t U64_AT( void * _p )
{
- u8 * p = (u8 *)_p;
- return ( ((u64)p[0] << 56) | ((u64)p[1] << 48) | ((u64)p[2] << 40)
- | ((u64)p[3] << 32) | ((u64)p[4] << 24) | ((u64)p[5] << 16)
- | ((u64)p[6] << 8) | p[7] );
+ uint8_t * p = (uint8_t *)_p;
+ return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
+ | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
+ | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
+ | ((uint64_t)p[6] << 8) | p[7] );
}
#if WORDS_BIGENDIAN
# define hton16(i) ( i )
# define ntoh64(i) U64_AT(&i)
#endif
+/* Format string sanity checks */
+#ifdef HAVE_ATTRIBUTE_FORMAT
+# define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
+#else
+# define ATTRIBUTE_FORMAT(x,y)
+#endif
+
/* Alignment of critical static data structures */
#ifdef ATTRIBUTE_ALIGNED_MAX
# define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
#endif
-/* strndup (defined in src/misc/extras.c) */
+/* Stuff defined in src/extras/libc.c */
+#ifndef HAVE_STRDUP
+# define strdup vlc_strdup
+ VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
+#elif !defined(__PLUGIN__)
+# define vlc_strdup NULL
+#endif
+
#ifndef HAVE_STRNDUP
-char * strndup( const char *s, size_t n );
+# if defined(STRNDUP_IN_GNOME_H) && \
+ (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
+ defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
+ /* Do nothing: gnome.h defines strndup for us */
+# else
+# define strndup vlc_strndup
+ VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
+# endif
+#elif !defined(__PLUGIN__)
+# define vlc_strndup NULL
+#endif
+
+#ifndef HAVE_ATOF
+# define atof vlc_atof
+ VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
+#elif !defined(__PLUGIN__)
+# define vlc_atof NULL
+#endif
+
+#ifndef HAVE_GETENV
+# define getenv vlc_getenv
+ VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
+#elif !defined(__PLUGIN__)
+# define vlc_getenv NULL
#endif
+#ifndef HAVE_STRCASECMP
+# ifdef HAVE_STRICMP
+# define strcasecmp stricmp
+# if !defined(__PLUGIN__)
+# define vlc_strcasecmp NULL
+# endif
+# elif !defined(__PLUGIN__)
+# define strcasecmp vlc_strcasecmp
+ VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
+# endif
+#elif !defined(__PLUGIN__)
+# define vlc_strcasecmp NULL
+#endif
+
+#ifndef HAVE_STRNCASECMP
+# ifdef HAVE_STRNICMP
+# define strncasecmp strnicmp
+# if !defined(__PLUGIN__)
+# define vlc_strncasecmp NULL
+# endif
+# elif !defined(__PLUGIN__)
+# define strncasecmp vlc_strncasecmp
+ VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
+# endif
+#elif !defined(__PLUGIN__)
+# define vlc_strncasecmp NULL
+#endif
-#define I64C(x) x##LL
+/* Format type specifiers for 64 bits numbers */
+#if !defined(WIN32) && !defined(UNDER_CE)
+# define I64Fd "%lld"
+# define I64Fi "%lli"
+# define I64Fo "%llo"
+# define I64Fu "%llu"
+# define I64Fx "%llx"
+# define I64FX "%llX"
+#else
+# define I64Fd "%I64d"
+# define I64Fi "%I64i"
+# define I64Fo "%I64o"
+# define I64Fu "%I64u"
+# define I64Fx "%I64x"
+# define I64FX "%I64X"
+#endif /* defined(WIN32)||defined(UNDER_CE) */
+
+/* 64 bits integer constant suffix */
+#if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
+# define I64C(x) x##LL
+#else
+# define I64C(x) x##i64
+#endif /* defined(WIN32)||defined(UNDER_CE) */
-#ifdef WIN32
+#if defined(WIN32) || defined(UNDER_CE)
/* win32, cl and icl support */
# if defined( _MSC_VER ) || !defined( __MINGW32__ )
# define __attribute__(x)
# define __inline__ __inline
-# define strncasecmp strnicmp
-# define strcasecmp stricmp
# define S_IFBLK 0x3000 /* Block */
# define S_ISBLK(m) (0)
# define S_ISCHR(m) (0)
# define S_ISFIFO(m) (((m)&_S_IFMT) == _S_IFIFO)
# define S_ISREG(m) (((m)&_S_IFMT) == _S_IFREG)
-# undef I64C
-# define I64C(x) x##i64
# endif
/* several type definitions */
typedef _off_t off_t;
# define _OFF_T_
# else
+# ifdef off_t
+# undef off_t
+# endif
# define off_t long long
# endif
# endif
# ifndef O_NONBLOCK
# define O_NONBLOCK 0
+# endif
+
+# ifndef alloca
+# define alloca _alloca
# endif
/* These two are not defined in mingw32 (bug?) */
#endif
+/* lseek (defined in src/extras/libc.c) */
+#ifndef HAVE_LSEEK
+# define lseek vlc_lseek
+ VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
+#elif !defined(__PLUGIN__)
+# define vlc_lseek NULL
+#endif
+
/*****************************************************************************
* CPU capabilities
*****************************************************************************/
/*****************************************************************************
* I18n stuff
*****************************************************************************/
-#if defined( ENABLE_NLS ) \
- && ( defined(HAVE_GETTEXT) || defined(HAVE_INCLUDED_GETTEXT) )
+VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
+
+#if defined( ENABLE_NLS ) && \
+ (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
+ defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
+ /* Declare nothing: gnome.h will do it for us */
+#elif defined( ENABLE_NLS )
+#if defined( HAVE_INCLUDED_GETTEXT )
+# include "libintl.h"
+#else
# include <libintl.h>
+#endif
# undef _
-# define _(String) dgettext (PACKAGE, String)
-# ifdef gettext_noop
-# define N_(String) gettext_noop (String)
-# else
-# define N_(String) (String)
-# endif
-#elif !defined( NEED_GNOMESUPPORT_H )
-# define _(String) (String)
-# define N_(String) (String)
+#if defined( __BORLANDC__ )
+#define _(String) vlc_dgettext (PACKAGE_TARNAME, String)
+#else
+# define _(String) vlc_dgettext (PACKAGE, String)
+#endif
+# define N_(String) ((char*)(String))
+#else
+# define _(String) ((char*)(String))
+# define N_(String) ((char*)(String))
#endif
/*****************************************************************************