* This file is a collection of common definitions and types
*/
+#ifndef VLC_COMMON_H
+# define VLC_COMMON_H 1
+
/*****************************************************************************
* Required vlc headers
*****************************************************************************/
#include <string.h>
#include <stdio.h>
+#include <inttypes.h>
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h>
+#ifndef __cplusplus
+# include <stdbool.h>
#endif
/*****************************************************************************
* Basic types definitions
*****************************************************************************/
-#if 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
- /* 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 uint64_t;
- typedef signed long long int64_t;
-# endif
- typedef uint32_t uintptr_t;
- typedef int32_t intptr_t;
-#endif
-
-/* 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
-
#if defined( WIN32 ) || defined( UNDER_CE )
# include <malloc.h>
# ifndef PATH_MAX
/* Counter for statistics and profiling */
typedef unsigned long count_t;
-/* DCT elements types */
-typedef int16_t dctelem_t;
-
-/* Video buffer types */
-typedef uint8_t yuv_data_t;
-
/* Audio volume */
typedef uint16_t audio_volume_t;
*****************************************************************************/
/* Internal types */
-typedef struct libvlc_global_data_t libvlc_global_data_t;
+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 variable_t variable_t;
typedef struct date_t date_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 */
/* Video */
typedef struct vout_thread_t vout_thread_t;
typedef struct vout_sys_t vout_sys_t;
-typedef struct chroma_sys_t chroma_sys_t;
typedef video_format_t video_frame_format_t;
typedef struct picture_t picture_t;
struct stat;
#endif
+/**
+ * VLC value structure
+ */
+typedef union
+{
+ int i_int;
+ bool b_bool;
+ float f_float;
+ char * psz_string;
+ void * p_address;
+ vlc_object_t * p_object;
+ vlc_list_t * p_list;
+ mtime_t i_time;
+
+ struct { char *psz_name; int i_object_id; } var;
+
+ /* Make sure the structure is at least 64bits */
+ struct { char a, b, c, d, e, f, g, h; } padding;
+
+} vlc_value_t;
+
+/**
+ * VLC list structure
+ */
+struct vlc_list_t
+{
+ int i_count;
+ vlc_value_t * p_values;
+ int * pi_types;
+
+};
+
+/**
+ * \defgroup var_type Variable types
+ * These are the different types a vlc variable can have.
+ * @{
+ */
+#define VLC_VAR_VOID 0x0010
+#define VLC_VAR_BOOL 0x0020
+#define VLC_VAR_INTEGER 0x0030
+#define VLC_VAR_HOTKEY 0x0031
+#define VLC_VAR_STRING 0x0040
+#define VLC_VAR_MODULE 0x0041
+#define VLC_VAR_FILE 0x0042
+#define VLC_VAR_DIRECTORY 0x0043
+#define VLC_VAR_VARIABLE 0x0044
+#define VLC_VAR_FLOAT 0x0050
+#define VLC_VAR_TIME 0x0060
+#define VLC_VAR_ADDRESS 0x0070
+#define VLC_VAR_MUTEX 0x0080
+#define VLC_VAR_LIST 0x0090
+/**@}*/
+
+/*****************************************************************************
+ * Error values (shouldn't be exposed)
+ *****************************************************************************/
+#define VLC_SUCCESS -0 /* No error */
+#define VLC_ENOMEM -1 /* Not enough memory */
+#define VLC_ETHREAD -2 /* Thread error */
+#define VLC_ETIMEOUT -3 /* Timeout */
+
+#define VLC_ENOMOD -10 /* Module not found */
+
+#define VLC_ENOOBJ -20 /* Object not found */
+
+#define VLC_ENOVAR -30 /* Variable not found */
+#define VLC_EBADVAR -31 /* Bad variable value */
+
+#define VLC_ENOITEM -40 /**< Item not found */
+
+#define VLC_EEXIT -255 /* Program exited */
+#define VLC_EEXITSUCCESS -999 /* Program exited successfully */
+#define VLC_EGENERIC -666 /* Generic error */
+
/*****************************************************************************
* Variable callbacks
*****************************************************************************/
* Plug-in stuff
*****************************************************************************/
-#include "vlc_modules_macros.h"
-
+#ifdef __cplusplus
+# define LIBVLC_EXTERN extern "C"
+#else
+# define LIBVLC_EXTERN extern
+#endif
#if defined (WIN32) && defined (DLL_EXPORT)
-# ifdef __cplusplus
-# define VLC_PUBLIC_API extern "C" __declspec(dllexport)
-# define VLC_PRIVATE_API extern "C" __declspec(dllexport)
-# define VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
-# define VLC_INTERNAL( type, name, args ) extern "C" type name args
-# else
-# define VLC_PUBLIC_API extern __declspec(dllexport)
-# define VLC_PRIVATE_API extern __declspec(dllexport)
-# define VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
-# define VLC_INTERNAL( type, name, args ) type name args
-# endif
+# define LIBVLC_EXPORT __declspec(dllexport)
#else
-# ifdef __cplusplus
-# ifdef HAVE_ATTRIBUTE_VISIBILITY
-# define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
-# define VLC_PRIVATE_API extern "C" __attribute__((visibility("default")))
-# define VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
-# define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
-# else
-# define VLC_PUBLIC_API extern "C"
-# define VLC_EXPORT( type, name, args ) extern "C" type name args
-# define VLC_INTERNAL( type, name, args ) extern "C" type name args
-# endif
-# else
-# ifdef HAVE_ATTRIBUTE_VISIBILITY
-# define VLC_PUBLIC_API extern __attribute__((visibility("default")))
-# define VLC_PRIVATE_API extern __attribute__((visibility("default")))
-# define VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
-# define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
-# else
-# define VLC_PUBLIC_API extern
-# define VLC_PRIVATE_API extern
-# define VLC_EXPORT( type, name, args ) extern type name args
-# define VLC_INTERNAL( type, name, args ) type name args
-# endif
-# endif
+# define LIBVLC_EXPORT
#endif
+#define VLC_EXPORT( type, name, args ) \
+ LIBVLC_EXTERN LIBVLC_EXPORT type name args
/*****************************************************************************
* OS-specific headers and thread types
# endif
#endif
+#include "vlc_mtime.h"
#include "vlc_threads.h"
typedef struct vlc_object_internals_t vlc_object_internals_t;
* these members are common for all vlc objects \
*/ \
/**@{*/ \
- vlc_object_internals_t *p_internals; \
int i_object_id; \
int i_object_type; \
const char *psz_object_type; \
char *psz_header; \
int i_flags; \
\
- /* Object access lock */ \
- vlc_mutex_t object_lock; \
- vlc_cond_t object_wait; \
- \
/* Object properties */ \
volatile bool b_error; /**< set by the object */ \
volatile bool b_die; /**< set by the outside */ \
libvlc_int_t *p_libvlc; /**< (root of all evil) - 1 */ \
\
vlc_object_t * p_parent; /**< our parent */ \
- vlc_object_t ** pp_children; /**< our children */ \
- volatile int i_children; \
\
/* Private data */ \
void * p_private; \
/* VLC_OBJECT: attempt at doing a clever cast */
#define VLC_OBJECT( x ) \
- ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
+ (((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct)
#define VLC_GC_MEMBERS \
/** \name VLC_GC_MEMBERS \
struct gc_object_t
{
- VLC_GC_MEMBERS
+ VLC_GC_MEMBERS
};
-#include <assert.h> /* FIXME: should not be included here */
-
-static inline void __vlc_gc_incref( gc_object_t * p_gc )
-{
- assert( p_gc->i_gc_refcount > 0 );
-
- p_gc->i_gc_refcount ++;
-};
-
-static inline void __vlc_gc_decref( gc_object_t *p_gc )
-{
- if( !p_gc ) return;
-
- assert( p_gc->i_gc_refcount > 0 );
-
- 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 ! */
- }
-}
-
-static inline void
-__vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
- void * arg)
-{
- p_gc->i_gc_refcount = 1;
- p_gc->pf_destructor = pf_destructor;
- p_gc->p_destructor_arg = arg;
-}
+VLC_EXPORT(void, __vlc_gc_incref, ( gc_object_t * p_gc ));
+VLC_EXPORT(void, __vlc_gc_decref, ( gc_object_t * p_gc ));
+VLC_EXPORT(void, __vlc_gc_init, ( gc_object_t * p_gc,
+ void (*pf_destructor)( gc_object_t * ), void * arg));
#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
/*****************************************************************************
* Macros and inline functions
*****************************************************************************/
-#ifdef NTOHL_IN_SYS_PARAM_H
-# include <sys/param.h>
-
-#elif !defined(WIN32) && !defined( UNDER_CE )
-# include <netinet/in.h>
-
-#endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d) ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
#include <vlc_arrays.h>
/* 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. */
+ * MSB, and should be used for both network communications and files. */
static inline uint16_t U16_AT( const void * _p )
{
const uint8_t * p = (const uint8_t *)_p;
SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
-#ifdef WORDS_BIGENDIAN
-# define hton16(i) ( i )
-# define hton32(i) ( i )
-# define hton64(i) ( i )
-# define ntoh16(i) ( i )
-# define ntoh32(i) ( i )
-# define ntoh64(i) ( i )
-#else
-# define hton16(i) U16_AT(&i)
-# define hton32(i) U32_AT(&i)
-# define hton64(i) U64_AT(&i)
-# define ntoh16(i) U16_AT(&i)
-# define ntoh32(i) U32_AT(&i)
-# define ntoh64(i) U64_AT(&i)
-#endif
+#define hton16(i) htons(i)
+#define hton32(i) htonl(i)
+#define ntoh16(i) ntohs(i)
+#define ntoh32(i) ntohl(i)
-/* 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
+static inline uint64_t ntoh64 (uint64_t ll)
+{
+ union { uint64_t qw; uint8_t b[16]; } v = { ll };
+ return ((uint64_t)v.b[0] << 56)
+ | ((uint64_t)v.b[1] << 48)
+ | ((uint64_t)v.b[2] << 40)
+ | ((uint64_t)v.b[3] << 32)
+ | ((uint64_t)v.b[4] << 24)
+ | ((uint64_t)v.b[5] << 16)
+ | ((uint64_t)v.b[6] << 8)
+ | ((uint64_t)v.b[7] << 0);
+}
+#define hton64(i) ntoh64(i)
-/* Alignment of critical static data structures */
-#ifdef ATTRIBUTE_ALIGNED_MAX
-# define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
+/* Format string sanity checks */
+#ifdef __GNUC__
+# define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
#else
-# define ATTR_ALIGN(align)
-#endif
-
-#ifdef HAVE_ATTRIBUTE_PACKED
-# define ATTR_PACKED __attribute__((__packed__))
+# define LIBVLC_FORMAT(x,y)
#endif
/* */
#define VLC_UNUSED(x) (void)(x)
/* Stuff defined in src/extras/libc.c */
-VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
-VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
-VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
-VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
-VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
-VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
-VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
-VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
-
-#if defined(SYS_BEOS) \
- || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
- typedef struct {
- long long quot; /* Quotient. */
- long long rem; /* Remainder. */
- } lldiv_t;
-#endif
-VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
-
-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 ) );
-
-VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
+VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
-VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
-VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
-#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
-# define rewinddir vlc_rewindir
-# define seekdir vlc_seekdir
-# define telldir vlc_telldir
- VLC_EXPORT( void *, vlc_opendir, ( const char * ) );
- VLC_EXPORT( void *, vlc_readdir, ( void * ) );
- VLC_EXPORT( int, vlc_closedir, ( void * ) );
- VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
- VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
- VLC_INTERNAL( long, vlc_telldir, ( void * ) );
-#endif
-
-#if defined (WIN32)
-# include <dirent.h>
- VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
- VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
- VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
- VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
- VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
- VLC_INTERNAL( long, vlc_telldir, ( void * ) );
-# define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
-# define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
-# define closedir vlc_wclosedir
-# define _wopendir vlc_wopendir
-# define _wreaddir vlc_wreaddir
-# define _wclosedir vlc_wclosedir
-# define rewinddir vlc_rewinddir
-# define seekdir vlc_seekdir
-# define telldir vlc_telldir
-#endif
-
#if defined(WIN32) || defined(UNDER_CE)
/* win32, cl and icl support */
# if defined( _MSC_VER ) || !defined( __MINGW32__ )
#endif
VLC_EXPORT( bool, 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( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *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)
+/* dir wrappers (defined in src/extras/libc.c) */
+VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
+
/*****************************************************************************
* CPU capabilities
*****************************************************************************/
#define CPU_CAPABILITY_FPU (1<<31)
VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
+typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
+typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
+
+VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
+VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
+VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
+
/*****************************************************************************
* I18n stuff
*****************************************************************************/
-#ifdef WIN32
- 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)||\
- defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
- defined(MODULE_NAME_IS_pda))
- /* Declare nothing: gnome.h will do it for us */
-#elif defined( ENABLE_NLS )
-# include <libintl.h>
-# undef _
-# ifdef WIN32
-# define _(String) vlc_dgettext (PACKAGE_NAME, String)
-# else
-# define _(String) dgettext(PACKAGE_NAME, String)
-# endif
-# define N_(String) (String)
-#else
-# define _(String) (String)
-# define N_(String) (String)
-#endif
+VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
/*****************************************************************************
* libvlc features
#include "vlc_messages.h"
#include "vlc_variables.h"
#include "vlc_objects.h"
-#include "vlc_mtime.h"
-#include "vlc_threads_funcs.h"
#include "vlc_modules.h"
-#include "main.h"
+#include "vlc_main.h"
#include "vlc_configuration.h"
#if defined( WIN32 ) || defined( UNDER_CE )
# define PATH_SEP_CHAR ':'
# define PATH_SEP ":"
#endif
+
+#define LICENSE_MSG \
+ _("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")
+
+#endif /* !VLC_COMMON_H */