fourcc: add entry for Android opaque buffer type.
[vlc.git] / include / vlc_variables.h
index 5c84a7a..241185d 100644 (file)
@@ -1,25 +1,25 @@
 /*****************************************************************************
- * variables.h: variables handling
+ * vlc_variables.h: variables handling
  *****************************************************************************
- * Copyright (C) 2002-2004 the VideoLAN team
+ * Copyright (C) 2002-2004 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Samuel Hocevar <sam@zoy.org>
  *          Gildas Bazin <gbazin@netcourrier.com>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * 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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 #ifndef VLC_VARIABLES_H
  * @{
  */
 
-/*****************************************************************************
- * Variable types - probably very incomplete
- *****************************************************************************/
 #define VLC_VAR_TYPE      0x00ff
 #define VLC_VAR_CLASS     0x00f0
 #define VLC_VAR_FLAGS     0xff00
 
+/**
+ * \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_VARIABLE  0x0044
+#define VLC_VAR_FLOAT     0x0050
+#define VLC_VAR_TIME      0x0060
+#define VLC_VAR_ADDRESS   0x0070
+#define VLC_VAR_COORDS    0x00A0
+/**@}*/
+
 /** \defgroup var_flags Additive flags
  * These flags are added to the type field of the variable. Most as a result of
- * a __var_Change() call, but some may be added at creation time
+ * a var_Change() call, but some may be added at creation time
  * @{
  */
 #define VLC_VAR_HASCHOICE 0x0100
@@ -68,9 +82,9 @@
 
 /**
  * \defgroup var_action Variable actions
- * These are the different actions that can be used with __var_Change().
+ * These are the different actions that can be used with var_Change().
  * The parameters given are the meaning of the two last parameters of
- * __var_Change() when this action is being used.
+ * var_Change() when this action is being used.
  * @{
  */
 
 #define VLC_VAR_GETLIST             0x0025
 #define VLC_VAR_CHOICESCOUNT        0x0026
 
-#define VLC_VAR_INHERITVALUE        0x0030
-
 #define VLC_VAR_SETISCOMMAND        0x0040
 /**@}*/
 
 /** \defgroup var_GetAndSet Variable actions
- * These are the different actions that can be used with __var_GetAndSet()
+ * 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
+enum {
+    VLC_VAR_BOOL_TOGGLE, /**< Invert a boolean value (param ignored) */
+    VLC_VAR_INTEGER_ADD, /**< Add parameter to an integer value */
+    VLC_VAR_INTEGER_OR,  /**< Binary OR over an integer bits field */
+    VLC_VAR_INTEGER_NAND,/**< Binary NAND over an integer bits field */
+};
 /**@}*/
 
 /*****************************************************************************
  * Prototypes
  *****************************************************************************/
-VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
-VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
+VLC_API int var_Create( vlc_object_t *, const char *, int );
+#define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c )
 
-VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
+VLC_API int var_Destroy( vlc_object_t *, const char * );
+#define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )
 
-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_API int var_Change( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * );
+#define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )
 
-#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_API int var_Type( vlc_object_t *, const char * ) VLC_USED;
+#define var_Type(a,b) var_Type( VLC_OBJECT(a), b )
 
-VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
+VLC_API int var_Set( vlc_object_t *, const char *, vlc_value_t );
+#define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c )
 
-/**
- * __var_Create() with automatic casting.
- */
-#define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
-/**
- * __var_Destroy() with automatic casting
- */
-#define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
+VLC_API int var_Get( vlc_object_t *, const char *, vlc_value_t * );
+#define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c )
 
-/**
- * __var_Change() with automatic casting
- */
-#define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
+VLC_API int var_SetChecked( vlc_object_t *, const char *, int, vlc_value_t );
+#define var_SetChecked(o,n,t,v) var_SetChecked(VLC_OBJECT(o),n,t,v)
+VLC_API int var_GetChecked( vlc_object_t *, const char *, int, vlc_value_t * );
+#define var_GetChecked(o,n,t,v) var_GetChecked(VLC_OBJECT(o),n,t,v)
+VLC_API int var_GetAndSet( vlc_object_t *, const char *, int, vlc_value_t * );
+
+VLC_API int var_Inherit( vlc_object_t *, const char *, int, vlc_value_t * );
+
+VLC_API void var_FreeList( vlc_value_t *, vlc_value_t * );
 
-/**
- * __var_Type() with automatic casting
- */
-#define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
-/**
- * __var_Set() with automatic casting
- */
-#define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
-/**
- * __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
@@ -191,22 +180,13 @@ VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
  *                 vlc_value_t newvalue,
  *                 void *p_data);
  *****************************************************************************/
-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 * ) );
+VLC_API int var_AddCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
+VLC_API int var_DelCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
+VLC_API 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 )
+#define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d )
+#define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d )
+#define var_TriggerCallback(a,b) var_TriggerCallback( VLC_OBJECT(a), b )
 
 /*****************************************************************************
  * helpers functions
@@ -219,7 +199,8 @@ VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
  * \param psz_name The name of the variable
  * \param i The new integer value of this variable
  */
-static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
+static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name,
+                                  int64_t i )
 {
     vlc_value_t val;
     val.i_int = i;
@@ -233,7 +214,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, bool 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;
@@ -247,13 +228,23 @@ static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool
  * \param psz_name The name of the variable
  * \param i The new time value of this variable
  */
-static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
+static inline int var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 {
     vlc_value_t val;
     val.i_time = i;
     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
 }
 
+static inline int var_SetCoords( vlc_object_t *obj, const char *name,
+                                 int32_t x, int32_t y )
+{
+    vlc_value_t val;
+    val.coords.x = x;
+    val.coords.y = y;
+    return var_SetChecked (obj, name, VLC_VAR_COORDS, val);
+}
+#define var_SetCoords(o,n,x,y) var_SetCoords(VLC_OBJECT(o),n,x,y)
+
 /**
  * Set the value of a float variable
  *
@@ -261,7 +252,7 @@ static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int6
  * \param psz_name The name of the variable
  * \param f The new float value of this variable
  */
-static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
+static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 {
     vlc_value_t val;
     val.f_float = f;
@@ -275,7 +266,7 @@ static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, flo
  * \param psz_name The name of the variable
  * \param psz_string The new string value of this variable
  */
-static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
+static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 {
     vlc_value_t val;
     val.psz_string = (char *)psz_string;
@@ -290,37 +281,19 @@ static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, co
  * \param ptr The new pointer value of this variable
  */
 static inline
-int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
+int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
 {
     vlc_value_t val;
     val.p_address = ptr;
     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
 }
 
-/**
- * __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)
-/**
- * __var_SetTime() with automatic casting
- */
-#define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
-/**
- * __var_SetFloat() with automatic casting
- */
-#define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
-/**
- * __var_SetString() with automatic casting
- */
-#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)
+#define var_SetInteger(a,b,c)   var_SetInteger( VLC_OBJECT(a),b,c)
+#define var_SetBool(a,b,c)      var_SetBool( VLC_OBJECT(a),b,c)
+#define var_SetTime(a,b,c)      var_SetTime( VLC_OBJECT(a),b,c)
+#define var_SetFloat(a,b,c)     var_SetFloat( VLC_OBJECT(a),b,c)
+#define var_SetString(a,b,c)    var_SetString( VLC_OBJECT(a),b,c)
+#define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
 
 
 /**
@@ -329,8 +302,8 @@ int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
  * \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_USED
+static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
@@ -345,8 +318,8 @@ 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 bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
+VLC_USED
+static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.b_bool = false;
 
@@ -362,8 +335,8 @@ static inline bool __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_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_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
@@ -372,14 +345,29 @@ static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
         return 0;
 }
 
+static inline void var_GetCoords( vlc_object_t *obj, const char *name,
+                                  int32_t *px, int32_t *py )
+{
+    vlc_value_t val;
+
+    if (likely(!var_GetChecked (obj, name, VLC_VAR_COORDS, &val)))
+    {
+        *px = val.coords.x;
+        *py = val.coords.y;
+    }
+    else
+        *px = *py = 0;
+}
+#define var_GetCoords(o,n,x,y) var_GetCoords(VLC_OBJECT(o),n,x,y)
+
 /**
  * Get a float value
  *
  * \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_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_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
@@ -394,8 +382,8 @@ 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_USED VLC_MALLOC
+static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val; val.psz_string = NULL;
     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
@@ -404,8 +392,8 @@ static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
         return val.psz_string;
 }
 
-LIBVLC_USED
-static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
+VLC_USED VLC_MALLOC
+static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
@@ -416,8 +404,8 @@ static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *ps
     return NULL;
 }
 
-LIBVLC_USED
-static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
+VLC_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 ) )
@@ -426,59 +414,53 @@ static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name
         return val.p_address;
 }
 
-/**
- * __var_GetInteger() with automatic casting
- */
-#define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
-/**
- * __var_GetBool() with automatic casting
- */
-#define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
-/**
- * __var_GetTime() with automatic casting
- */
-#define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
-/**
- * __var_GetFloat() with automatic casting
- */
-#define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
-/**
- * __var_GetString() 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)
-
-
-
 /**
  * Increment an integer variable
  * \param p_obj the object that holds the variable
  * \param psz_name the name of the variable
  */
-static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
+static inline int64_t var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
     val.i_int = 1;
-    __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
+    var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
+    return val.i_int;
 }
-#define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
+#define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
 
 /**
  * Decrement an integer variable
  * \param p_obj the object that holds the variable
  * \param psz_name the name of the variable
  */
-static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
+static inline int64_t var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 {
     vlc_value_t val;
     val.i_int = -1;
-    __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
+    var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
+    return val.i_int;
 }
-#define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
+#define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
+
+static inline uint64_t var_OrInteger( vlc_object_t *obj, const char *name,
+                                      unsigned v )
+{
+    vlc_value_t val;
+    val.i_int = v;
+    var_GetAndSet( obj, name, VLC_VAR_INTEGER_OR, &val );
+    return val.i_int;
+}
+#define var_OrInteger(a,b,c) var_OrInteger(VLC_OBJECT(a),b,c)
+
+static inline uint64_t var_NAndInteger( vlc_object_t *obj, const char *name,
+                                        unsigned v )
+{
+    vlc_value_t val;
+    val.i_int = v;
+    var_GetAndSet( obj, name, VLC_VAR_INTEGER_NAND, &val );
+    return val.i_int;
+}
+#define var_NAndInteger(a,b,c) var_NAndInteger(VLC_OBJECT(a),b,c)
 
 /**
  * Create a integer variable with inherit and get its value.
@@ -486,11 +468,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_USED
+static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 {
-    __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
-    return __var_GetInteger( p_obj, psz_name );
+    var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
+    return var_GetInteger( p_obj, psz_name );
 }
 
 /**
@@ -499,11 +481,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 bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
+VLC_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 );
+    var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
+    return var_GetBool( p_obj, psz_name );
 }
 
 /**
@@ -512,11 +494,11 @@ static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_nam
  * \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_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 );
-    return __var_GetTime( p_obj, psz_name );
+    var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
+    return var_GetTime( p_obj, psz_name );
 }
 
 /**
@@ -525,11 +507,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_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 );
-    return __var_GetFloat( p_obj, psz_name );
+    var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
+    return var_GetFloat( p_obj, psz_name );
 }
 
 /**
@@ -538,43 +520,43 @@ 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
  */
-LIBVLC_USED
-static inline char *__var_CreateGetString( vlc_object_t *p_obj,
+VLC_USED VLC_MALLOC
+static inline char *var_CreateGetString( vlc_object_t *p_obj,
                                            const char *psz_name )
 {
-    __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
-    return __var_GetString( p_obj, psz_name );
+    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,
+VLC_USED VLC_MALLOC
+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 );
-    return __var_GetNonEmptyString( p_obj, psz_name );
+    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
+    return var_GetNonEmptyString( p_obj, psz_name );
 }
 
 /**
- * __var_CreateGetInteger() with automatic casting
- */
-#define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
-/**
- * __var_CreateGetBool() with automatic casting
- */
-#define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
-/**
- * __var_CreateGetTime() with automatic casting
- */
-#define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
-/**
- * __var_CreateGetFloat() with automatic casting
- */
-#define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
-/**
- * __var_CreateGetString() with automatic casting
+ * 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
  */
-#define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
-#define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
+VLC_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 );
+}
+
+#define var_CreateGetInteger(a,b)   var_CreateGetInteger( VLC_OBJECT(a),b)
+#define var_CreateGetBool(a,b)   var_CreateGetBool( VLC_OBJECT(a),b)
+#define var_CreateGetTime(a,b)   var_CreateGetTime( VLC_OBJECT(a),b)
+#define var_CreateGetFloat(a,b)   var_CreateGetFloat( VLC_OBJECT(a),b)
+#define var_CreateGetString(a,b)   var_CreateGetString( VLC_OBJECT(a),b)
+#define var_CreateGetNonEmptyString(a,b)   var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
+#define var_CreateGetAddress(a,b)  var_CreateGetAddress( VLC_OBJECT(a),b)
 
 /**
  * Create a integer command variable with inherit and get its value.
@@ -582,12 +564,12 @@ static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
  * \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 )
+VLC_USED
+static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 {
-    __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
+    var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetInteger( p_obj, psz_name );
+    return var_GetInteger( p_obj, psz_name );
 }
 
 /**
@@ -596,12 +578,12 @@ static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char
  * \param p_obj The object that holds the variable
  * \param psz_name The name of the variable
  */
-LIBVLC_USED
-static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
+VLC_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
+    var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetBool( p_obj, psz_name );
+    return var_GetBool( p_obj, psz_name );
 }
 
 /**
@@ -610,12 +592,12 @@ static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *
  * \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 )
+VLC_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
+    var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetTime( p_obj, psz_name );
+    return var_GetTime( p_obj, psz_name );
 }
 
 /**
@@ -624,12 +606,12 @@ static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const cha
  * \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 )
+VLC_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
+    var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetFloat( p_obj, psz_name );
+    return var_GetFloat( p_obj, psz_name );
 }
 
 /**
@@ -638,69 +620,136 @@ static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char
  * \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,
+VLC_USED VLC_MALLOC
+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
+    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetString( p_obj, psz_name );
+    return var_GetString( p_obj, psz_name );
 }
 
-LIBVLC_USED
-static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
+VLC_USED VLC_MALLOC
+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
+    var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
                                    | VLC_VAR_ISCOMMAND );
-    return __var_GetNonEmptyString( p_obj, psz_name );
+    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)
+#define var_CreateGetIntegerCommand(a,b)   var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
+#define var_CreateGetBoolCommand(a,b)   var_CreateGetBoolCommand( VLC_OBJECT(a),b)
+#define var_CreateGetTimeCommand(a,b)   var_CreateGetTimeCommand( VLC_OBJECT(a),b)
+#define var_CreateGetFloatCommand(a,b)   var_CreateGetFloatCommand( VLC_OBJECT(a),b)
+#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_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 ) )
+    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)
+#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 )
+static inline bool 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_GetAndSet( p_obj, psz_name, VLC_VAR_BOOL_TOGGLE, &val );
+    return val.b_bool;
 }
-/**
- * __var_ToggleBool() with automatic casting
- */
-#define var_ToggleBool(a,b) __var_ToggleBool( VLC_OBJECT(a),b )
+#define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
+
+
+VLC_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)
+
+VLC_USED
+static inline int64_t 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)
+
+VLC_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)
+
+VLC_USED VLC_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)
+
+VLC_USED
+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)
+
+VLC_USED
+static inline void *var_InheritAddress( vlc_object_t *obj, const char *name )
+{
+    vlc_value_t val;
+
+    if( var_Inherit( obj, name, VLC_VAR_ADDRESS, &val ) )
+        val.p_address = NULL;
+    return val.p_address;
+}
+#define var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n)
+
+VLC_API int var_InheritURational( vlc_object_t *, unsigned *num, unsigned *den, const char *var );
+#define var_InheritURational(a,b,c,d) var_InheritURational(VLC_OBJECT(a), b, c, d)
+
+#define var_GetInteger(a,b)   var_GetInteger( VLC_OBJECT(a),b)
+#define var_GetBool(a,b)   var_GetBool( VLC_OBJECT(a),b)
+#define var_GetTime(a,b)   var_GetTime( VLC_OBJECT(a),b)
+#define var_GetFloat(a,b)   var_GetFloat( VLC_OBJECT(a),b)
+#define var_GetString(a,b)   var_GetString( VLC_OBJECT(a),b)
+#define var_GetNonEmptyString(a,b)   var_GetNonEmptyString( VLC_OBJECT(a),b)
+#define var_GetAddress(a,b)  var_GetAddress( VLC_OBJECT(a),b)
+
+VLC_API int var_LocationParse(vlc_object_t *, const char *mrl, const char *prefix);
+#define var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p)
+
 /**
  * @}
  */