X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_common.h;h=7dff7b401fad67a7661b435153281fb30275e0d0;hb=560105460d6436d8fb7270a30c53167d7b10bd6e;hp=6337b11629be8443e72ffb0e4cc9341774165791;hpb=f9d5e2baf5e771718cd9a342b127efdd8404ebca;p=vlc diff --git a/include/vlc_common.h b/include/vlc_common.h index 6337b11629..7dff7b401f 100644 --- a/include/vlc_common.h +++ b/include/vlc_common.h @@ -2,7 +2,7 @@ * common.h: common definitions * Collection of useful common types and macros definitions ***************************************************************************** - * Copyright (C) 1998-2004 VideoLAN + * Copyright (C) 1998-2005 the VideoLAN team * $Id$ * * Authors: Samuel Hocevar @@ -21,9 +21,10 @@ * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA. *****************************************************************************/ + /** * \file * This file is a collection of common definitions and types @@ -110,6 +111,15 @@ typedef uint8_t byte_t; +/* Systems that don't have stdint.h may not define INT64_MIN and + INT64_MAX */ +#ifndef INT64_MIN +#define INT64_MIN (-9223372036854775807LL-1) +#endif +#ifndef INT64_MAX +#define INT64_MAX (9223372036854775807LL) +#endif + /* ptrdiff_t definition */ #ifdef HAVE_STDDEF_H # include @@ -189,13 +199,17 @@ typedef uint32_t vlc_fourcc_t; *****************************************************************************/ /* Internal types */ -typedef struct libvlc_t libvlc_t; -typedef struct vlc_t vlc_t; +typedef struct libvlc_global_data_t libvlc_global_data_t; +typedef struct libvlc_int_t libvlc_int_t; typedef struct variable_t variable_t; typedef struct date_t date_t; +typedef struct dict_entry_t dict_entry_t; +typedef struct dict_t dict_t; +typedef struct gc_object_t gc_object_t ; /* Messages */ typedef struct msg_bank_t msg_bank_t; +typedef struct msg_queue_t msg_queue_t; typedef struct msg_subscription_t msg_subscription_t; /* Playlist */ @@ -206,14 +220,12 @@ typedef struct msg_subscription_t msg_subscription_t; */ typedef enum { PLAYLIST_PLAY, /**< No arg. res=can fail*/ - PLAYLIST_VIEWPLAY, /**< arg1= int, arg2= playlist_item_t*,*/ - /** arg3 = playlist_item_t* , res=can fail */ - PLAYLIST_ITEMPLAY, /** be_sure_to_add_VLC_COMMON_MEMBERS_to_struct +#define VLC_GC_MEMBERS \ +/** \name VLC_GC_MEMBERS \ + * these members are common to all objects that wish to be garbage-collected \ + */ \ +/**@{*/ \ + int i_gc_refcount; \ + void (*pf_destructor) ( gc_object_t * ); \ + void *p_destructor_arg; \ +/**@}*/ + +struct gc_object_t +{ + VLC_GC_MEMBERS +}; + +static inline void __vlc_gc_incref( gc_object_t * p_gc ) +{ + p_gc->i_gc_refcount ++; +}; + +static inline void __vlc_gc_decref( gc_object_t *p_gc ) +{ + p_gc->i_gc_refcount -- ; + + if( p_gc->i_gc_refcount == 0 ) + { + p_gc->pf_destructor( p_gc ); + /* Do not use the p_gc pointer from now on ! */ + } +} + +#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a ) +#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a ) +#define vlc_gc_init( a,b,c ) { ((gc_object_t *)a)->i_gc_refcount = 0; \ + ((gc_object_t *)a)->pf_destructor = b; \ + ((gc_object_t *)a)->p_destructor_arg = c; } + + /***************************************************************************** * Macros and inline functions *****************************************************************************/ @@ -501,22 +612,39 @@ static int64_t GCD( int64_t a, int64_t b ) else return a; } +/* Malloc with automatic error */ +#define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \ + if( !var ) return; } +#define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \ + if( !var ) return NULL; } +#define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \ + if( !var ) return VLC_ENOMEM; } +#define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \ + if( !var ) goto error; } +#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\ + if( !var ) return; +#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\ + if( !var ) return VLC_ENOMEM; +#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\ + if( !var ) return NULL; + +#define FREENULL(a) if( a ) { free( a ); a = NULL; } +#define FREE(a) if( a ) { free( a ); } + /* Dynamic array handling: realloc array, move data, increment position */ +#if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE ) +# define VLCCVP (void**) /* Work-around for broken compiler */ +#else +# define VLCCVP +#endif #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 ) (p_ar) = NULL; \ + (p_ar) = VLCCVP realloc( p_ar, ((i_oldsize) + 1) * sizeof(*(p_ar)) ); \ if( (i_oldsize) - (i_pos) ) \ { \ - memmove( (p_ar) + (i_pos) + 1, \ - (p_ar) + (i_pos), \ + memmove( (p_ar) + (i_pos) + 1, (p_ar) + (i_pos), \ ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) ); \ } \ (p_ar)[i_pos] = elem; \ @@ -594,6 +722,45 @@ static int64_t GCD( int64_t a, int64_t b ) } \ } +/* Binary search in an array */ +#define BSEARCH( entries, count, elem, zetype, key, answer ) { \ + int low = 0, high = count - 1; \ + answer = -1; \ + while( low <= high ) {\ + int mid = (low + high ) / 2; /* Just don't care about 2^30 tables */ \ + zetype mid_val = entries[mid] elem;\ + if( mid_val < key ) \ + low = mid + 1; \ + else if ( mid_val > key ) \ + high = mid -1; \ + else \ + { \ + answer = mid; break; \ + }\ + } \ +} + +/* Dictionnary handling */ +struct dict_entry_t +{ + int i_int; + char *psz_string; + uint64_t i_hash; + void *p_data; +}; + +struct dict_t +{ + dict_entry_t *p_entries; + int i_entries; +}; + +VLC_EXPORT( dict_t *, vlc_DictNew, (void) ); +VLC_EXPORT( void, vlc_DictClear, (dict_t * ) ); +VLC_EXPORT( void, vlc_DictInsert, (dict_t *, int, const char *, void * ) ); +VLC_EXPORT( void*, vlc_DictGet, (dict_t *, int, const char * ) ); +VLC_EXPORT( int, vlc_DictLookup, (dict_t *, int, const char * ) ); + /* 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 @@ -752,14 +919,14 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) # define vlc_strdup NULL #endif -#if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS) +#if !defined(HAVE_VASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) # define vasprintf vlc_vasprintf VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) ); #elif !defined(__PLUGIN__) # define vlc_vasprintf NULL #endif -#if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS) +#if !defined(HAVE_ASPRINTF) || defined(__APPLE__) || defined(SYS_BEOS) # define asprintf vlc_asprintf VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ); #elif !defined(__PLUGIN__) @@ -779,6 +946,13 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) # define vlc_strndup NULL #endif +#ifndef HAVE_STRLCPY +# define strlcpy vlc_strlcpy + VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) ); +#elif !defined(__PLUGIN__) +# define vlc_strlcpy NULL +#endif + #ifndef HAVE_ATOF # define atof vlc_atof VLC_EXPORT( double, vlc_atof, ( const char *nptr ) ); @@ -806,6 +980,28 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) # define vlc_strtoll NULL #endif +#if defined(SYS_BEOS) + typedef struct { + long long quot; /* Quotient. */ + long long rem; /* Remainder. */ + } lldiv_t; +# define lldiv vlc_lldiv + VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) ); +#elif !defined(__PLUGIN__) +# define vlc_lldiv NULL +#endif + +#ifndef HAVE_SCANDIR +# define scandir vlc_scandir +# define alphasort vlc_alphasort + struct dirent; + VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) ); + VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) ); +#elif !defined(__PLUGIN__) +# define vlc_scandir NULL +# define vlc_alphasort NULL +#endif + #ifndef HAVE_GETENV # define getenv vlc_getenv VLC_EXPORT( char *, vlc_getenv, ( const char *name ) ); @@ -855,14 +1051,54 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) # define vlc_strcasestr NULL #endif +#ifndef HAVE_DIRENT_H + typedef void DIR; +# ifndef FILENAME_MAX +# define FILENAME_MAX (260) +# endif + struct dirent + { + long d_ino; /* Always zero. */ + unsigned short d_reclen; /* Always zero. */ + unsigned short d_namlen; /* Length of name in d_name. */ + char d_name[FILENAME_MAX]; /* File name. */ + }; +# define opendir vlc_opendir +# define readdir vlc_readdir +# define closedir vlc_closedir + VLC_EXPORT( void *, vlc_opendir, ( const char * ) ); + VLC_EXPORT( void *, vlc_readdir, ( void * ) ); + VLC_EXPORT( int, vlc_closedir, ( void * ) ); +#else + struct dirent; /* forward declaration for vlc_symbols.h */ +# if !defined(__PLUGIN__) +# define vlc_opendir NULL +# define vlc_readdir NULL +# define vlc_closedir NULL +# endif +#endif + + VLC_EXPORT( void *, vlc_opendir_wrapper, ( const char * ) ); + VLC_EXPORT( struct dirent *, vlc_readdir_wrapper, ( void * ) ); + VLC_EXPORT( int, vlc_closedir_wrapper, ( void * ) ); + /* 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" +#if defined(__CYGWIN32__) || (!defined(WIN32) && !defined(UNDER_CE)) +# if defined(__WORDSIZE) && __WORDSIZE == 64 +# define I64Fd "%ld" +# define I64Fi "%li" +# define I64Fo "%lo" +# define I64Fu "%lu" +# define I64Fx "%lx" +# define I64FX "%lX" +# else +# define I64Fd "%lld" +# define I64Fi "%lli" +# define I64Fo "%llo" +# define I64Fu "%llu" +# define I64Fx "%llx" +# define I64FX "%llX" +# endif #else # define I64Fd "%I64d" # define I64Fi "%I64i" @@ -874,8 +1110,13 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) /* 64 bits integer constant suffix */ #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE)) -# define I64C(x) x##LL -# define UI64C(x) x##ULL +# if defined(__WORDSIZE) && __WORDSIZE == 64 +# define I64C(x) x##L +# define UI64C(x) x##UL +# else +# define I64C(x) x##LL +# define UI64C(x) x##ULL +# endif #else # define I64C(x) x##i64 # define UI64C(x) x##ui64 @@ -896,8 +1137,8 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw ) /* several type definitions */ # if defined( __MINGW32__ ) # if !defined( _OFF_T_ ) -typedef long long _off_t; -typedef _off_t off_t; + typedef long long _off_t; + typedef _off_t off_t; # define _OFF_T_ # else # ifdef off_t @@ -907,11 +1148,12 @@ typedef _off_t off_t; # endif # endif -# if defined( _MSC_VER ) +# if defined( _MSC_VER ) && !defined( __WXMSW__ ) # if !defined( _OFF_T_DEFINED ) -typedef __int64 off_t; + typedef __int64 off_t; # define _OFF_T_DEFINED # else + /* for wx compatibility typedef long off_t; */ # define off_t __int64 # endif # endif @@ -937,28 +1179,26 @@ typedef __int64 off_t; # define vsnprintf _vsnprintf # endif +# include #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 - -VLC_EXPORT( vlc_bool_t, vlc_reduce, ( int *, int *, int64_t, int64_t, int64_t ) ); +VLC_EXPORT( vlc_bool_t, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) ); +VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) ); /* vlc_wraptext (defined in src/extras/libc.c) */ #define wraptext vlc_wraptext -VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) ); +VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) ); /* iconv wrappers (defined in src/extras/libc.c) */ typedef void *vlc_iconv_t; VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) ); -VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) ); +VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) ); VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) ); +/* execve wrapper (defined in src/extras/libc.c) */ +VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char **pp_argv, char **pp_env, char *psz_cwd, char *p_in, int i_in, char **pp_data, int *pi_data ) ); +#define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i) + /***************************************************************************** * CPU capabilities *****************************************************************************/ @@ -977,7 +1217,9 @@ VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) ); /***************************************************************************** * I18n stuff *****************************************************************************/ +#if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC) VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) ); +#endif #if defined( ENABLE_NLS ) && \ (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\ @@ -991,17 +1233,36 @@ VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) ); # include # endif # undef _ -# define _(String) vlc_dgettext (PACKAGE_NAME, String) -# define N_(String) ((char*)(String)) +# if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC) +# define _(String) vlc_dgettext (PACKAGE_NAME, String) +# else +# define _(String) dgettext(PACKAGE_NAME, String) +# endif +# define N_(String) (String) #else -# define _(String) ((char*)(String)) -# define N_(String) ((char*)(String)) +# define _(String) (String) +# define N_(String) (String) #endif +/***************************************************************************** + * libvlc features + *****************************************************************************/ +VLC_EXPORT( const char *, VLC_Version, ( void ) ); +VLC_EXPORT( const char *, VLC_CompileBy, ( void ) ); +VLC_EXPORT( const char *, VLC_CompileHost, ( void ) ); +VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) ); +VLC_EXPORT( const char *, VLC_Compiler, ( void ) ); +VLC_EXPORT( const char *, VLC_Error, ( int ) ); + /***************************************************************************** * Additional vlc stuff *****************************************************************************/ -#include "vlc_symbols.h" +#ifndef HAVE_SHARED_LIBVLC +VLC_EXPORT( const char *, VLC_Changeset, ( void ) ); +# include "vlc_symbols.h" +#else +# define VLC_Changeset( ) ("exported") +#endif #include "os_specific.h" #include "vlc_messages.h" #include "variables.h"