X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_variables.h;h=9015b0b3290034295baa7b48e4655af6dbdca102;hb=8f83ef4b74b37d92e95fc9bcebabf67e9aeef291;hp=f484b83eb749ab1794b8fc7b416781ae59df8876;hpb=ba4f253bd953d82e177434327541ed8c2cc70a8f;p=vlc

diff --git a/include/vlc_variables.h b/include/vlc_variables.h
index f484b83eb7..9015b0b329 100644
--- a/include/vlc_variables.h
+++ b/include/vlc_variables.h
@@ -22,9 +22,15 @@
  * 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
+
+#include <assert.h>
+
+/**
+ * \file
+ * This file defines functions and structures for dynamic variables in vlc
+ */
 
 /**
  * \defgroup variables Variables
@@ -41,6 +47,7 @@
  * 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
@@ -91,6 +98,10 @@
 #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
@@ -103,6 +114,8 @@
 
 #define VLC_VAR_INHERITVALUE        0x0030
 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
+
+#define VLC_VAR_SETISCOMMAND        0x0040
 /**@}*/
 
 /*****************************************************************************
@@ -113,12 +126,31 @@ VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
 
 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 * ) );
 
-#define var_OptionParse(a,b) __var_OptionParse( VLC_OBJECT( a ) , b )
-VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
+#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 ** ) );
+
+VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) LIBVLC_USED );
+#ifdef __GNUC__
+static
+__attribute__((unused))
+__attribute__((noinline))
+__attribute__((error("variable mutex name leaks memory at run-time")))
+const char *nonconst_mutex_name( const char *str )
+{
+    return str;
+}
+
+# define check_named_mutex( m ) \
+    (__builtin_constant_p(m) ? m : nonconst_mutex_name(m))
+#else
+# define check_named_mutex( m ) (m)
+#endif
+
+#define var_AcquireMutex( n ) var_AcquireMutex(check_named_mutex(n))
 
 /**
  * __var_Create() with automatic casting.
@@ -158,6 +190,7 @@ VLC_EXPORT( void, __var_OptionParse, ( vlc_object_t *, const char * ) );
  *****************************************************************************/
 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
@@ -169,10 +202,26 @@ VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback
  */
 #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
  *****************************************************************************/
 
+/**
+ * This function assert the variable is of the expected type or it
+ * is not defined
+ */
+static inline void __var_AssertType( vlc_object_t *p_obj, const char *psz_name,
+                                     int i_expected )
+{
+    const int i_type = __var_Type( p_obj, psz_name ) & VLC_VAR_CLASS;
+    assert( i_type == 0 || i_type == (i_expected&VLC_VAR_CLASS) );
+}
+
 /**
  * Set the value of an integer variable
  *
@@ -184,6 +233,7 @@ static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, i
 {
     vlc_value_t val;
     val.i_int = i;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
     return __var_Set( p_obj, psz_name, val );
 }
 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
@@ -194,10 +244,11 @@ static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, i
  * \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;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -212,6 +263,7 @@ static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int6
 {
     vlc_value_t val;
     val.i_time = i;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -226,6 +278,7 @@ static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, flo
 {
     vlc_value_t val;
     val.f_float = f;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -240,6 +293,7 @@ static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, co
 {
     vlc_value_t val;
     val.psz_string = (char *)psz_string;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
     return __var_Set( p_obj, psz_name, val );
 }
 
@@ -252,7 +306,8 @@ static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, co
 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
-    val.b_bool = VLC_TRUE;
+    val.b_bool = true;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_VOID );
     return __var_Set( p_obj, psz_name, val );
 }
 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
@@ -281,9 +336,11 @@ static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
  * \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;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.i_int;
     else
@@ -296,13 +353,16 @@ static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_USED
 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val; val.b_bool = VLC_FALSE;
+    vlc_value_t val; val.b_bool = false;
+
+    __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.b_bool;
     else
-        return VLC_FALSE;
+        return false;
 }
 
 /**
@@ -311,9 +371,11 @@ static inline int __var_GetBool( vlc_object_t *p_obj, const char *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_GetTime( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.i_time = 0L;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.i_time;
     else
@@ -326,9 +388,11 @@ static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
  * \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;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.f_float;
     else
@@ -341,23 +405,27 @@ static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
  * \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;
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
+    if( __var_Get( p_obj, psz_name, &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))
+    __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
+    if( __var_Get( p_obj, psz_name, &val ) )
         return NULL;
-    if (*val.psz_string)
+    if( *val.psz_string )
         return val.psz_string;
-    free (val.psz_string);
+    free( val.psz_string );
     return NULL;
 }
 
@@ -416,15 +484,11 @@ static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
  * \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 )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.i_int;
-    else
-        return 0;
+    return __var_GetInteger( p_obj, psz_name );
 }
 
 /**
@@ -433,15 +497,11 @@ static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_n
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
+LIBVLC_USED
 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.b_bool;
-    else
-        return VLC_FALSE;
+    return __var_GetBool( p_obj, psz_name );
 }
 
 /**
@@ -450,15 +510,11 @@ static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *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 )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.i_time;
-    else
-        return 0;
+    return __var_GetTime( p_obj, psz_name );
 }
 
 /**
@@ -467,15 +523,11 @@ static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_
  * \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 )
 {
-    vlc_value_t val;
-
     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.f_float;
-    else
-        return 0.0;
+    return __var_GetFloat( p_obj, psz_name );
 }
 
 /**
@@ -484,15 +536,20 @@ static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_n
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
-static inline char *__var_CreateGetString( vlc_object_t *p_obj, const char *psz_name )
+LIBVLC_USED
+static inline char *__var_CreateGetString( vlc_object_t *p_obj,
+                                           const char *psz_name )
 {
-    vlc_value_t val;
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
+    return __var_GetString( p_obj, psz_name );
+}
 
+LIBVLC_USED
+static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
+                                                   const char *psz_name )
+{
     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
-    if( !__var_Get( p_obj, psz_name, &val ) )
-        return val.psz_string;
-    else
-        return strdup( "" );
+    return __var_GetNonEmptyString( p_obj, psz_name );
 }
 
 /**
@@ -515,8 +572,110 @@ static inline char *__var_CreateGetString( vlc_object_t *p_obj, const char *psz_
  * __var_CreateGetString() 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)
 
 /**
- * @}
+ * 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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetInteger( p_obj, psz_name );
+}
+
+/**
+ * Create a boolean 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_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 );
+    return __var_GetBool( p_obj, psz_name );
+}
+
+/**
+ * Create a time 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 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
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetTime( p_obj, psz_name );
+}
+
+/**
+ * Create a float 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 float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
+{
+    __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetFloat( p_obj, psz_name );
+}
+
+/**
+ * Create a string 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 char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
+                                           const char *psz_name )
+{
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetString( p_obj, psz_name );
+}
 
+LIBVLC_USED
+static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
+                                                   const char *psz_name )
+{
+    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
+                                   | VLC_VAR_ISCOMMAND );
+    return __var_GetNonEmptyString( p_obj, psz_name );
+}
+
+/**
+ * __var_CreateGetInteger() with automatic casting
+ */
+#define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetBoolCommand() with automatic casting
+ */
+#define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetTimeCommand() with automatic casting
+ */
+#define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetFloat() with automatic casting
+ */
+#define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
+/**
+ * __var_CreateGetStringCommand() with automatic casting
+ */
+#define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
+#define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
+/**
+ * @}
+ */
+#endif /*  _VLC_VARIABLES_H */