]> git.sesse.net Git - vlc/blobdiff - include/vlc_variables.h
Usefull coment instead of "Gruik" (evenif I like the previous one...)
[vlc] / include / vlc_variables.h
index 607b86176e6a9f71dbecbcbf29a566dd956b91af..04196fdd86aae28c5447c02cf2cbfc24546d0204 100644 (file)
@@ -22,9 +22,8 @@
  * 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
 
 /**
  * \defgroup variables Variables
 #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_INHERITVALUE        0x0030
 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
+
+#define VLC_VAR_SETISCOMMAND        0x0040
 /**@}*/
 
 /*****************************************************************************
@@ -117,8 +122,10 @@ VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) );
 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 * ) );
 
 /**
  * __var_Create() with automatic casting.
@@ -158,6 +165,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,6 +177,11 @@ 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
  *****************************************************************************/
@@ -194,7 +207,7 @@ 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;
@@ -252,7 +265,7 @@ 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;
     return __var_Set( p_obj, psz_name, val );
 }
 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
@@ -298,11 +311,11 @@ static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
  */
 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;
     if( !__var_Get( p_obj, psz_name, &val ) )
         return val.b_bool;
     else
-        return VLC_FALSE;
+        return false;
 }
 
 /**
@@ -344,20 +357,20 @@ static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 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_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 )
 {
     vlc_value_t val;
-    if (__var_Get (obj, name, &val))
+    if( __var_Get( obj, 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;
 }
 
@@ -501,6 +514,101 @@ static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
 #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
+ */
+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
+ */
+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
+ */
+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
  */
+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
+ */
+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 );
+}
+
+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 */