* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#if !defined( __LIBVLC__ )
- #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_VARIABLES_H
+#define VLC_VARIABLES_H 1
-#ifndef _VLC_VARIABLES_H
-#define _VLC_VARIABLES_H 1
+/**
+ * \file
+ * This file defines functions and structures for dynamic variables in vlc
+ */
/**
* \defgroup variables Variables
* Variable types - probably very incomplete
*****************************************************************************/
#define VLC_VAR_TYPE 0x00ff
+#define VLC_VAR_CLASS 0x00f0
#define VLC_VAR_FLAGS 0xff00
/** \defgroup var_flags Additive flags
#define VLC_VAR_ISCOMMAND 0x2000
/** Creation flag */
+/* If the variable is not found on the current module
+ search all parents and finally module config until found */
#define VLC_VAR_DOINHERIT 0x8000
/**@}*/
#define VLC_VAR_SETTEXT 0x0014
#define VLC_VAR_GETTEXT 0x0015
+#define VLC_VAR_GETMIN 0x0016
+#define VLC_VAR_GETMAX 0x0017
+#define VLC_VAR_GETSTEP 0x0018
+
#define VLC_VAR_ADDCHOICE 0x0020
#define VLC_VAR_DELCHOICE 0x0021
#define VLC_VAR_CLEARCHOICES 0x0022
#define VLC_VAR_SETDEFAULT 0x0023
#define VLC_VAR_GETCHOICES 0x0024
-#define VLC_VAR_FREECHOICES 0x0025
-#define VLC_VAR_GETLIST 0x0026
-#define VLC_VAR_FREELIST 0x0027
-#define VLC_VAR_CHOICESCOUNT 0x0028
+#define VLC_VAR_GETLIST 0x0025
+#define VLC_VAR_CHOICESCOUNT 0x0026
-#define VLC_VAR_INHERITVALUE 0x0030
-#define VLC_VAR_TRIGGER_CALLBACKS 0x0035
+#define VLC_VAR_SETISCOMMAND 0x0040
+/**@}*/
+
+/** \defgroup var_GetAndSet Variable actions
+ * These are the different actions that can be used with __var_GetAndSet()
+ * @{
+ */
+/**
+ * Toggle the value of this boolean
+ * \param val Unused
+ */
+#define VLC_VAR_TOGGLE_BOOL 0x0010
+/**
+ * Increment or decrement an integer of a given value
+ * \param val the value
+ */
+#define VLC_VAR_INTEGER_INCDEC 0x0020
/**@}*/
/*****************************************************************************
VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
-VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
+VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
+VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
+VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
+VLC_EXPORT( int, __var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t ) );
+VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
+
+#define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
+VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
-#define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
-VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
+VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
/**
* __var_Create() with automatic casting.
* __var_Get() with automatic casting
*/
#define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
+/**
+ * __var_GetAndSet() with automatic casting
+ */
+#define var_GetAndSet(a,b,c,d) __var_GetAndSet(VLC_OBJECT(a), b, c, d)
/*****************************************************************************
* Variable callbacks
*****************************************************************************/
VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
+VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
/**
* __var_AddCallback() with automatic casting
*/
#define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
-
/**
* __var_DelCallback() with automatic casting
*/
#define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
+/**
+ * __var_TriggerCallback() with automatic casting
+ */
+#define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
/*****************************************************************************
* helpers functions
{
vlc_value_t val;
val.i_int = i;
- return __var_Set( p_obj, psz_name, val );
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
}
-#define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
+
/**
* Set the value of an boolean variable
*
* \param psz_name The name of the variable
* \param b The new boolean value of this variable
*/
-static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, vlc_bool_t b )
+static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
{
vlc_value_t val;
val.b_bool = b;
- return __var_Set( p_obj, psz_name, val );
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
}
/**
{
vlc_value_t val;
val.i_time = i;
- return __var_Set( p_obj, psz_name, val );
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
}
/**
{
vlc_value_t val;
val.f_float = f;
- return __var_Set( p_obj, psz_name, val );
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
}
/**
{
vlc_value_t val;
val.psz_string = (char *)psz_string;
- return __var_Set( p_obj, psz_name, val );
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
}
/**
- * Trigger the callbacks on a void variable
+ * Set the value of a pointer variable
*
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
+ * \param ptr The new pointer value of this variable
*/
-static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
+static inline
+int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
{
vlc_value_t val;
- val.b_bool = VLC_TRUE;
- return __var_Set( p_obj, psz_name, val );
+ val.p_address = ptr;
+ return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
}
-#define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
+/**
+ * __var_SetInteger() with automatic casting
+ */
+#define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
/**
* __var_SetBool() with automatic casting
*/
-#define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
-
+#define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
/**
* __var_SetTime() with automatic casting
*/
/**
* __var_SetString() with automatic casting
*/
-#define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
+#define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
+/**
+ * __var_SetAddress() with automatic casting
+ */
+#define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
+
/**
* Get an integer value
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
{
- vlc_value_t val;val.i_int = 0;
- if( !__var_Get( p_obj, psz_name, &val ) )
+ vlc_value_t val;
+ if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
return val.i_int;
else
return 0;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
+LIBVLC_USED
+static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
{
- vlc_value_t val; val.b_bool = VLC_FALSE;
- if( !__var_Get( p_obj, psz_name, &val ) )
+ vlc_value_t val; val.b_bool = false;
+
+ if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
return val.b_bool;
else
- return VLC_FALSE;
+ return false;
}
/**
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.i_time = 0L;
- if( !__var_Get( p_obj, psz_name, &val ) )
+ if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
return val.i_time;
else
return 0;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.f_float = 0.0;
- if( !__var_Get( p_obj, psz_name, &val ) )
+ if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
return val.f_float;
else
return 0.0;
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val; val.psz_string = NULL;
- if( !__var_Get( p_obj, psz_name, &val ) )
- return val.psz_string;
+ if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
+ return NULL;
else
- return strdup( "" );
+ return val.psz_string;
}
-static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
+LIBVLC_USED
+static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
{
vlc_value_t val;
- if (__var_Get (obj, name, &val))
+ if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
return NULL;
- if (*val.psz_string)
+ if( val.psz_string && *val.psz_string )
return val.psz_string;
- free (val.psz_string);
+ free( val.psz_string );
return NULL;
}
+LIBVLC_USED
+static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
+{
+ vlc_value_t val;
+ if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
+ return NULL;
+ else
+ return val.p_address;
+}
/**
* __var_GetInteger() with automatic casting
*/
#define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
#define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
+/**
+ * __var_GetAddress() with automatic casting
+ */
+#define var_GetAddress(a,b) __var_GetAddress( VLC_OBJECT(a),b)
*/
static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
{
- int i_val = __var_GetInteger( p_obj, psz_name );
- __var_SetInteger( p_obj, psz_name, ++i_val );
+ vlc_value_t val;
+ val.i_int = 1;
+ __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
}
#define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
*/
static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
{
- int i_val = __var_GetInteger( p_obj, psz_name );
- __var_SetInteger( p_obj, psz_name, --i_val );
+ vlc_value_t val;
+ val.i_int = -1;
+ __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
}
#define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
+LIBVLC_USED
+static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
return __var_GetBool( p_obj, psz_name );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline char *__var_CreateGetString( vlc_object_t *p_obj,
const char *psz_name )
{
return __var_GetString( p_obj, psz_name );
}
+LIBVLC_USED
static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
const char *psz_name )
{
return __var_GetNonEmptyString( p_obj, psz_name );
}
+/**
+ * Create an address variable with inherit and get its value.
+ *
+ * \param p_obj The object that holds the variable
+ * \param psz_name The name of the variable
+ */
+LIBVLC_USED
+static inline void *__var_CreateGetAddress( vlc_object_t *p_obj,
+ const char *psz_name )
+{
+ __var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
+ return __var_GetAddress( p_obj, psz_name );
+}
+
/**
* __var_CreateGetInteger() with automatic casting
*/
*/
#define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetString() with automatic casting
+ */
+#define var_CreateGetAddress(a,b) __var_CreateGetAddress( VLC_OBJECT(a),b)
/**
* Create a integer command variable with inherit and get its value.
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
-static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
+LIBVLC_USED
+static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
| VLC_VAR_ISCOMMAND );
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
{
__var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
* \param p_obj The object that holds the variable
* \param psz_name The name of the variable
*/
+LIBVLC_USED
static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
const char *psz_name )
{
return __var_GetString( p_obj, psz_name );
}
+LIBVLC_USED
static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
const char *psz_name )
{
*/
#define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
+
+LIBVLC_USED
+static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
+{
+ vlc_value_t count;
+ if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
+ return 0;
+ return count.i_int;
+}
+/**
+ * __var_CountChoices() with automatic casting
+ */
+#define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
+
+
+static inline int __var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
+{
+ vlc_value_t val;
+ return __var_GetAndSet( p_obj, psz_name, VLC_VAR_TOGGLE_BOOL, val );
+}
+/**
+ * __var_ToggleBool() with automatic casting
+ */
+#define var_ToggleBool(a,b) __var_ToggleBool( VLC_OBJECT(a),b )
+
+
+LIBVLC_USED
+static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
+{
+ vlc_value_t val;
+
+ if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
+ val.b_bool = false;
+ return val.b_bool;
+}
+#define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
+
+LIBVLC_USED
+static inline int var_InheritInteger( vlc_object_t *obj, const char *name )
+{
+ vlc_value_t val;
+
+ if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
+ val.i_int = 0;
+ return val.i_int;
+}
+#define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
+
+LIBVLC_USED
+static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
+{
+ vlc_value_t val;
+
+ if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
+ val.f_float = 0.;
+ return val.f_float;
+}
+#define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
+
+LIBVLC_USED LIBVLC_MALLOC
+static inline char *var_InheritString( vlc_object_t *obj, const char *name )
+{
+ vlc_value_t val;
+
+ if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
+ val.psz_string = NULL;
+ else if( val.psz_string && !*val.psz_string )
+ {
+ free( val.psz_string );
+ val.psz_string = NULL;
+ }
+ return val.psz_string;
+}
+#define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
+
+static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
+{
+ vlc_value_t val;
+
+ if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
+ val.i_time = 0;
+ return val.i_time;
+}
+#define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
+
/**
* @}
*/
projects / vlc / blobdiff