VLC  3.0.0-git
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Modules | Files | Macros | Functions
Variables

VLC object variables and callbacks. More...

Collaboration diagram for Variables:

Modules

 Variable types
 These are the different types a vlc variable can have.
 
 Additive flags
 These flags are added to the type field of the variable.
 
 Variable actions
 These are the different actions that can be used with var_Change().
 

Files

file  vlc_variables.h
 VLC object variables and callbacks interface.
 

Macros

#define VLC_VAR_TYPE   0x00ff
 
#define VLC_VAR_CLASS   0x00f0
 
#define VLC_VAR_FLAGS   0xff00
 
#define var_Create(a, b, c)   var_Create( VLC_OBJECT(a), b, c )
 
#define var_Destroy(a, b)   var_Destroy( VLC_OBJECT(a), b )
 
#define var_Change(a, b, c, d, e)   var_Change( VLC_OBJECT(a), b, c, d, e )
 
#define var_Type(a, b)   var_Type( VLC_OBJECT(a), b )
 
#define var_Set(a, b, c)   var_Set( VLC_OBJECT(a), b, c )
 
#define var_Get(a, b, c)   var_Get( VLC_OBJECT(a), b, c )
 
#define var_SetChecked(o, n, t, v)   var_SetChecked(VLC_OBJECT(o),n,t,v)
 
#define var_GetChecked(o, n, t, v)   var_GetChecked(VLC_OBJECT(o),n,t,v)
 
#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 )
 
#define var_AddListCallback(a, b, c, d)   var_AddListCallback( VLC_OBJECT(a), b, c, d )
 
#define var_DelListCallback(a, b, c, d)   var_DelListCallback( VLC_OBJECT(a), b, c, d )
 
#define var_SetCoords(o, n, x, y)   var_SetCoords(VLC_OBJECT(o),n,x,y)
 
#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_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)
 
#define var_GetCoords(o, n, x, y)   var_GetCoords(VLC_OBJECT(o),n,x,y)
 
#define var_IncInteger(a, b)   var_IncInteger( VLC_OBJECT(a), b )
 
#define var_DecInteger(a, b)   var_DecInteger( VLC_OBJECT(a), b )
 
#define var_OrInteger(a, b, c)   var_OrInteger(VLC_OBJECT(a),b,c)
 
#define var_NAndInteger(a, b, c)   var_NAndInteger(VLC_OBJECT(a),b,c)
 
#define var_CreateGetInteger(a, b)   var_CreateGetInteger( VLC_OBJECT(a),b)
 
#define var_CreateGetBool(a, b)   var_CreateGetBool( 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)
 
#define var_CreateGetIntegerCommand(a, b)   var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 
#define var_CreateGetBoolCommand(a, b)   var_CreateGetBoolCommand( 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)
 
#define var_CountChoices(a, b)   var_CountChoices( VLC_OBJECT(a),b)
 
#define var_ToggleBool(a, b)   var_ToggleBool( VLC_OBJECT(a),b )
 
#define var_InheritBool(o, n)   var_InheritBool(VLC_OBJECT(o), n)
 
#define var_InheritInteger(o, n)   var_InheritInteger(VLC_OBJECT(o), n)
 
#define var_InheritFloat(o, n)   var_InheritFloat(VLC_OBJECT(o), n)
 
#define var_InheritString(o, n)   var_InheritString(VLC_OBJECT(o), n)
 
#define var_InheritAddress(o, n)   var_InheritAddress(VLC_OBJECT(o), n)
 
#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_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)
 
#define var_LocationParse(o, m, p)   var_LocationParse(VLC_OBJECT(o), m, p)
 

Functions

int var_Create (vlc_object_t *, const char *, int)
 Initialize a vlc variable. More...
 
void var_Destroy (((vlc_object_t *)(vlc_object_t *)), const char *)
 
int var_Change (vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t *)
 Perform an action on a variable. More...
 
int var_Type (vlc_object_t *, const char *)
 Request a variable's type. More...
 
int var_Set (vlc_object_t *, const char *, vlc_value_t)
 Set a variable's value. More...
 
int var_Get (vlc_object_t *, const char *, vlc_value_t *)
 Get a variable's value. More...
 
int var_SetChecked (vlc_object_t *, const char *, int, vlc_value_t)
 
int var_GetChecked (vlc_object_t *, const char *, int, vlc_value_t *)
 
int var_GetAndSet (vlc_object_t *, const char *, int, vlc_value_t *)
 Perform a Get and Set on a variable. More...
 
int var_Inherit (vlc_object_t *, const char *, int, vlc_value_t *)
 Finds the value of a variable. More...
 
void var_FreeList (vlc_value_t *, vlc_value_t *)
 Free a list and the associated strings. More...
 
int var_AddCallback (vlc_object_t *, const char *, vlc_callback_t, void *)
 Register a callback in a variable. More...
 
int var_DelCallback (vlc_object_t *, const char *, vlc_callback_t, void *)
 Remove a callback from a variable. More...
 
int var_TriggerCallback (vlc_object_t *, const char *)
 Trigger callback on a variable. More...
 
int var_AddListCallback (vlc_object_t *, const char *, vlc_list_callback_t, void *)
 Register a callback for a list variable. More...
 
int var_DelListCallback (vlc_object_t *, const char *, vlc_list_callback_t, void *)
 Remove a callback from a list variable. More...
 
static int var_SetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, int64_t i)
 Set the value of an integer variable. More...
 
static int var_SetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, bool b)
 Set the value of an boolean variable. More...
 
static int var_SetCoords (((vlc_object_t *)(vlc_object_t *obj)), const char *name, int32_t x, int32_t y)
 
static int var_SetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, float f)
 Set the value of a float variable. More...
 
static int var_SetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, const char *psz_string)
 Set the value of a string variable. More...
 
static int var_SetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name, void *ptr)
 Set the value of a pointer variable. More...
 
static int64_t var_GetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Get an integer value. More...
 
static bool var_GetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Get a boolean value. More...
 
static void var_GetCoords (((vlc_object_t *)(vlc_object_t *obj)), const char *name, int32_t *px, int32_t *py)
 
static float var_GetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Get a float value. More...
 
static char * var_GetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Get a string value. More...
 
static char * var_GetNonEmptyString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static void * var_GetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static int64_t var_IncInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Increment an integer variable. More...
 
static int64_t var_DecInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Decrement an integer variable. More...
 
static uint64_t var_OrInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name, unsigned v)
 
static uint64_t var_NAndInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name, unsigned v)
 
static int64_t var_CreateGetInteger (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a integer variable with inherit and get its value. More...
 
static bool var_CreateGetBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a boolean variable with inherit and get its value. More...
 
static float var_CreateGetFloat (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a float variable with inherit and get its value. More...
 
static char * var_CreateGetString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a string variable with inherit and get its value. More...
 
static char * var_CreateGetNonEmptyString (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static void * var_CreateGetAddress (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create an address variable with inherit and get its value. More...
 
static int64_t var_CreateGetIntegerCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a integer command variable with inherit and get its value. More...
 
static bool var_CreateGetBoolCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a boolean command variable with inherit and get its value. More...
 
static float var_CreateGetFloatCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a float command variable with inherit and get its value. More...
 
static char * var_CreateGetStringCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 Create a string command variable with inherit and get its value. More...
 
static char * var_CreateGetNonEmptyStringCommand (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static int var_CountChoices (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static bool var_ToggleBool (((vlc_object_t *)(vlc_object_t *p_obj)), const char *psz_name)
 
static bool var_InheritBool (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
 
static int64_t var_InheritInteger (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
 
static float var_InheritFloat (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
 
static char * var_InheritString (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
 
static void * var_InheritAddress (((vlc_object_t *)(vlc_object_t *obj)), const char *name)
 
int var_InheritURational (((vlc_object_t *)(vlc_object_t *)), unsigned *num, unsigned *den, const char *var)
 
int var_LocationParse (vlc_object_t *, const char *mrl, const char *prefix)
 Parses a set of colon-separated or semicolon-separated name=value pairs. More...
 

Detailed Description

VLC object variables and callbacks.

Macro Definition Documentation

#define var_AddCallback (   a,
  b,
  c,
 
)    var_AddCallback( VLC_OBJECT(a), b, c, d )
#define var_AddListCallback (   a,
  b,
  c,
 
)    var_AddListCallback( VLC_OBJECT(a), b, c, d )
#define var_Change (   a,
  b,
  c,
  d,
 
)    var_Change( VLC_OBJECT(a), b, c, d, e )
#define var_CountChoices (   a,
 
)    var_CountChoices( VLC_OBJECT(a),b)

Referenced by EsOutSetRecord().

#define var_Create (   a,
  b,
 
)    var_Create( VLC_OBJECT(a), b, c )
#define var_CreateGetAddress (   a,
 
)    var_CreateGetAddress( VLC_OBJECT(a),b)
#define var_CreateGetBool (   a,
 
)    var_CreateGetBool( VLC_OBJECT(a),b)
#define var_CreateGetBoolCommand (   a,
 
)    var_CreateGetBoolCommand( VLC_OBJECT(a),b)
#define var_CreateGetFloat (   a,
 
)    var_CreateGetFloat( VLC_OBJECT(a),b)

Referenced by LoadSubtitles(), and VoutGetDisplayCfg().

#define var_CreateGetFloatCommand (   a,
 
)    var_CreateGetFloatCommand( VLC_OBJECT(a),b)
#define var_CreateGetInteger (   a,
 
)    var_CreateGetInteger( VLC_OBJECT(a),b)
#define var_CreateGetIntegerCommand (   a,
 
)    var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyString (   a,
 
)    var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
#define var_CreateGetNonEmptyStringCommand (   a,
 
)    var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
#define var_CreateGetString (   a,
 
)    var_CreateGetString( VLC_OBJECT(a),b)
#define var_CreateGetStringCommand (   a,
 
)    var_CreateGetStringCommand( VLC_OBJECT(a),b)
#define var_DecInteger (   a,
 
)    var_DecInteger( VLC_OBJECT(a), b )

Referenced by aout_PolicyNotify().

#define var_DelCallback (   a,
  b,
  c,
 
)    var_DelCallback( VLC_OBJECT(a), b, c, d )
#define var_DelListCallback (   a,
  b,
  c,
 
)    var_DelListCallback( VLC_OBJECT(a), b, c, d )
#define var_Destroy (   a,
 
)    var_Destroy( VLC_OBJECT(a), b )
#define var_Get (   a,
  b,
 
)    var_Get( VLC_OBJECT(a), b, c )
#define var_GetAddress (   a,
 
)    var_GetAddress( VLC_OBJECT(a),b)
#define var_GetBool (   a,
 
)    var_GetBool( VLC_OBJECT(a),b)
#define var_GetChecked (   o,
  n,
  t,
 
)    var_GetChecked(VLC_OBJECT(o),n,t,v)
#define var_GetCoords (   o,
  n,
  x,
 
)    var_GetCoords(VLC_OBJECT(o),n,x,y)
#define var_GetFloat (   a,
 
)    var_GetFloat( VLC_OBJECT(a),b)
#define var_GetInteger (   a,
 
)    var_GetInteger( VLC_OBJECT(a),b)
#define var_GetNonEmptyString (   a,
 
)    var_GetNonEmptyString( VLC_OBJECT(a),b)
#define var_GetString (   a,
 
)    var_GetString( VLC_OBJECT(a),b)
#define var_IncInteger (   a,
 
)    var_IncInteger( VLC_OBJECT(a), b )

Referenced by aout_PolicyNotify().

#define var_InheritAddress (   o,
 
)    var_InheritAddress(VLC_OBJECT(o), n)
#define var_InheritBool (   o,
 
)    var_InheritBool(VLC_OBJECT(o), n)
#define var_InheritFloat (   o,
 
)    var_InheritFloat(VLC_OBJECT(o), n)
#define var_InheritInteger (   o,
 
)    var_InheritInteger(VLC_OBJECT(o), n)
#define var_InheritString (   o,
 
)    var_InheritString(VLC_OBJECT(o), n)
#define var_InheritURational (   a,
  b,
  c,
 
)    var_InheritURational(VLC_OBJECT(a), b, c, d)

Referenced by VoutGetDisplayCfg().

#define var_LocationParse (   o,
  m,
  p 
)    var_LocationParse(VLC_OBJECT(o), m, p)
#define var_NAndInteger (   a,
  b,
 
)    var_NAndInteger(VLC_OBJECT(a),b,c)
#define var_OrInteger (   a,
  b,
 
)    var_OrInteger(VLC_OBJECT(a),b,c)
#define var_Set (   a,
  b,
 
)    var_Set( VLC_OBJECT(a), b, c )
#define var_SetAddress (   o,
  n,
  p 
)    var_SetAddress(VLC_OBJECT(o), n, p)
#define var_SetBool (   a,
  b,
 
)    var_SetBool( VLC_OBJECT(a),b,c)
#define var_SetChecked (   o,
  n,
  t,
 
)    var_SetChecked(VLC_OBJECT(o),n,t,v)
#define var_SetCoords (   o,
  n,
  x,
 
)    var_SetCoords(VLC_OBJECT(o),n,x,y)
#define var_SetFloat (   a,
  b,
 
)    var_SetFloat( VLC_OBJECT(a),b,c)
#define var_SetInteger (   a,
  b,
 
)    var_SetInteger( VLC_OBJECT(a),b,c)
#define var_SetString (   a,
  b,
 
)    var_SetString( VLC_OBJECT(a),b,c)
#define var_ToggleBool (   a,
 
)    var_ToggleBool( VLC_OBJECT(a),b )
#define var_TriggerCallback (   a,
 
)    var_TriggerCallback( VLC_OBJECT(a), b )
#define var_Type (   a,
 
)    var_Type( VLC_OBJECT(a), b )

Referenced by input_ControlVarTitle().

#define VLC_VAR_CLASS   0x00f0
#define VLC_VAR_FLAGS   0xff00
#define VLC_VAR_TYPE   0x00ff

Referenced by CheckValue(), and DumpVariable().

Function Documentation

int var_AddCallback ( vlc_object_t p_this,
const char *  psz_name,
vlc_callback_t  pf_callback,
void *  p_data 
)

Register a callback in a variable.

We store a function pointer that will be called upon variable modification.

Parameters
p_thisThe object that holds the variable
psz_nameThe name of the variable
pf_callbackThe function pointer
p_dataA generic pointer that will be passed as the last argument to the callback function.
Warning
The callback function is run in the thread that calls var_Set on the variable. Use proper locking. This thread may not have much time to spare, so keep callback functions short.

References AddCallback(), callback_entry_t::p_data, callback_entry_t::pf_value_callback, callback_entry_t::u, and vlc_value_callback.

int var_AddListCallback ( vlc_object_t p_this,
const char *  psz_name,
vlc_list_callback_t  pf_callback,
void *  p_data 
)

Register a callback for a list variable.

The callback is triggered when an element is added/removed from the list or when the list is cleared.

See var_AddCallback().

References AddCallback(), callback_entry_t::p_data, callback_entry_t::pf_list_callback, callback_entry_t::u, and vlc_list_callback.

int var_Change ( vlc_object_t p_this,
const char *  psz_name,
int  i_action,
vlc_value_t p_val,
vlc_value_t p_val2 
)
static int var_CountChoices ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
int var_Create ( vlc_object_t p_this,
const char *  psz_name,
int  i_type 
)
static void* var_CreateGetAddress ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create an address variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetAddress, VLC_VAR_ADDRESS, and VLC_VAR_DOINHERIT.

static bool var_CreateGetBool ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a boolean variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetBool, VLC_VAR_BOOL, and VLC_VAR_DOINHERIT.

static bool var_CreateGetBoolCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a boolean command variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetBool, VLC_VAR_BOOL, VLC_VAR_DOINHERIT, and VLC_VAR_ISCOMMAND.

static float var_CreateGetFloat ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a float variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetFloat, VLC_VAR_DOINHERIT, and VLC_VAR_FLOAT.

static float var_CreateGetFloatCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a float command variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetFloat, VLC_VAR_DOINHERIT, VLC_VAR_FLOAT, and VLC_VAR_ISCOMMAND.

static int64_t var_CreateGetInteger ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a integer variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetInteger, VLC_VAR_DOINHERIT, and VLC_VAR_INTEGER.

static int64_t var_CreateGetIntegerCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a integer command variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetInteger, VLC_VAR_DOINHERIT, VLC_VAR_INTEGER, and VLC_VAR_ISCOMMAND.

static char* var_CreateGetNonEmptyString ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
static char* var_CreateGetNonEmptyStringCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
static char* var_CreateGetString ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a string variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetString, VLC_VAR_DOINHERIT, and VLC_VAR_STRING.

static char* var_CreateGetStringCommand ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Create a string command variable with inherit and get its value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References var_Create, var_GetString, VLC_VAR_DOINHERIT, VLC_VAR_ISCOMMAND, and VLC_VAR_STRING.

static int64_t var_DecInteger ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Decrement an integer variable.

Parameters
p_objthe object that holds the variable
psz_namethe name of the variable

References vlc_value_t::i_int, var_GetAndSet(), and VLC_VAR_INTEGER_ADD.

int var_DelCallback ( vlc_object_t p_this,
const char *  psz_name,
vlc_callback_t  pf_callback,
void *  p_data 
)

Remove a callback from a variable.

pf_callback and p_data have to be given again, because different objects might have registered the same callback function.

References DelCallback(), callback_entry_t::p_data, callback_entry_t::pf_value_callback, callback_entry_t::u, and vlc_value_callback.

int var_DelListCallback ( vlc_object_t p_this,
const char *  psz_name,
vlc_list_callback_t  pf_callback,
void *  p_data 
)
void var_Destroy ( ((vlc_object_t *)(vlc_object_t *))  ,
const char *   
)
void var_FreeList ( vlc_value_t p_val,
vlc_value_t p_val2 
)

Free a list and the associated strings.

Parameters
p_valthe list variable
p_val2the variable associated or NULL

References vlc_list_t::i_count, vlc_list_t::i_type, vlc_value_t::p_list, vlc_list_t::p_values, vlc_value_t::psz_string, VLC_VAR_CLASS, and VLC_VAR_STRING.

Referenced by input_SubtitleAdd().

int var_Get ( vlc_object_t p_this,
const char *  psz_name,
vlc_value_t p_val 
)

Get a variable's value.

Parameters
p_thisThe object that holds the variable
psz_nameThe name of the variable
p_valPointer to a vlc_value_t that will hold the variable's value after the function is finished

References var_GetChecked().

static void* var_GetAddress ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
int var_GetAndSet ( vlc_object_t p_this,
const char *  psz_name,
int  i_action,
vlc_value_t p_val 
)

Perform a Get and Set on a variable.

Parameters
p_thisThe object that hold the variable
psz_namethe name of the variable
i_actionthe action to perform
p_valThe action parameter
Returns
vlc error codes

< Variable not found

< Unspecified error

< No error

References vlc_value_t::b_bool, CheckValue(), vlc_value_t::i_int, variable_t::i_type, Lookup(), TriggerCallback(), variable_t::val, vlc_object_internals::var_lock, VLC_EGENERIC, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, VLC_VAR_BOOL, VLC_VAR_BOOL_TOGGLE, VLC_VAR_INTEGER, VLC_VAR_INTEGER_ADD, VLC_VAR_INTEGER_NAND, VLC_VAR_INTEGER_OR, and WaitUnused().

Referenced by var_DecInteger(), var_IncInteger(), var_NAndInteger(), var_OrInteger(), and var_ToggleBool().

static bool var_GetBool ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Get a boolean value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References vlc_value_t::b_bool, var_GetChecked, and VLC_VAR_BOOL.

int var_GetChecked ( vlc_object_t ,
const char *  ,
int  ,
vlc_value_t  
)
static void var_GetCoords ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name,
int32_t *  px,
int32_t *  py 
)
inlinestatic
static float var_GetFloat ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Get a float value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References vlc_value_t::f_float, var_GetChecked, and VLC_VAR_FLOAT.

static int64_t var_GetInteger ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Get an integer value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References vlc_value_t::i_int, var_GetChecked, and VLC_VAR_INTEGER.

static char* var_GetNonEmptyString ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
static char* var_GetString ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Get a string value.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable

References vlc_value_t::psz_string, var_GetChecked, and VLC_VAR_STRING.

static int64_t var_IncInteger ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic

Increment an integer variable.

Parameters
p_objthe object that holds the variable
psz_namethe name of the variable

References vlc_value_t::i_int, var_GetAndSet(), and VLC_VAR_INTEGER_ADD.

int var_Inherit ( vlc_object_t p_this,
const char *  psz_name,
int  i_type,
vlc_value_t p_val 
)

Finds the value of a variable.

If the specified object does not hold a variable with the specified name, try the parent object, and iterate until the top of the tree. If no match is found, the value is read from the configuration.

< No error

< No error

< Object not found

< No error

References vlc_value_t::b_bool, config_GetFloat, config_GetInt, config_GetPsz, vlc_value_t::f_float, vlc_value_t::i_int, vlc_object_t::p_parent, vlc_value_t::psz_string, strdup(), var_GetChecked(), vlc_assert_unreachable, VLC_ENOOBJ, VLC_SUCCESS, VLC_VAR_ADDRESS, VLC_VAR_BOOL, VLC_VAR_CLASS, VLC_VAR_FLOAT, VLC_VAR_INTEGER, and VLC_VAR_STRING.

Referenced by var_Create(), var_InheritAddress(), var_InheritBool(), var_InheritFloat(), var_InheritInteger(), and var_InheritString().

static void* var_InheritAddress ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name 
)
inlinestatic
static bool var_InheritBool ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name 
)
inlinestatic
static float var_InheritFloat ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name 
)
inlinestatic
static int64_t var_InheritInteger ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name 
)
inlinestatic
static char* var_InheritString ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name 
)
inlinestatic
int var_InheritURational ( ((vlc_object_t *)(vlc_object_t *))  ,
unsigned *  num,
unsigned *  den,
const char *  var 
)
int var_LocationParse ( vlc_object_t obj,
const char *  mrl,
const char *  pref 
)

Parses a set of colon-separated or semicolon-separated name=value pairs.

Some access (or access_demux) plugins uses this scheme in media resource location.

Note
Only trusted/safe variables are allowed. This is intended.
Warning
Only use this for plugins implementing VLC-specific resource location schemes. This would not make any sense for standardized ones.
Parameters
objVLC object on which to set variables (and emit error messages)
mrlstring to parse
prefprefix to prepend to option names in the string
Returns
VLC_ENOMEM on error, VLC_SUCCESS on success.

< No error

< Not enough memory

References likely, var_OptionParse(), VLC_ENOMEM, and VLC_SUCCESS.

static uint64_t var_NAndInteger ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name,
unsigned  v 
)
inlinestatic
static uint64_t var_OrInteger ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name,
unsigned  v 
)
inlinestatic
int var_Set ( vlc_object_t p_this,
const char *  psz_name,
vlc_value_t  val 
)

Set a variable's value.

Parameters
p_thisThe object that hold the variable
psz_nameThe name of the variable
valthe value to set

References var_SetChecked().

Referenced by var_OptionParse().

static int var_SetAddress ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name,
void *  ptr 
)
inlinestatic

Set the value of a pointer variable.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable
ptrThe new pointer value of this variable

References vlc_value_t::p_address, var_SetChecked, and VLC_VAR_ADDRESS.

static int var_SetBool ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name,
bool  b 
)
inlinestatic

Set the value of an boolean variable.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable
bThe new boolean value of this variable

References vlc_value_t::b_bool, var_SetChecked, and VLC_VAR_BOOL.

int var_SetChecked ( vlc_object_t ,
const char *  ,
int  ,
vlc_value_t   
)
static int var_SetCoords ( ((vlc_object_t *)(vlc_object_t *obj))  ,
const char *  name,
int32_t  x,
int32_t  y 
)
inlinestatic
static int var_SetFloat ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name,
float  f 
)
inlinestatic

Set the value of a float variable.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable
fThe new float value of this variable

References vlc_value_t::f_float, var_SetChecked, and VLC_VAR_FLOAT.

static int var_SetInteger ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name,
int64_t  i 
)
inlinestatic

Set the value of an integer variable.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable
iThe new integer value of this variable

References vlc_value_t::i_int, var_SetChecked, and VLC_VAR_INTEGER.

static int var_SetString ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name,
const char *  psz_string 
)
inlinestatic

Set the value of a string variable.

Parameters
p_objThe object that holds the variable
psz_nameThe name of the variable
psz_stringThe new string value of this variable

References vlc_value_t::psz_string, var_SetChecked, and VLC_VAR_STRING.

static bool var_ToggleBool ( ((vlc_object_t *)(vlc_object_t *p_obj))  ,
const char *  psz_name 
)
inlinestatic
int var_TriggerCallback ( vlc_object_t p_this,
const char *  psz_name 
)

Trigger callback on a variable.

Parameters
p_thisThe object that hold the variable
psz_nameThe name of the variable

< Variable not found

< No error

References Lookup(), TriggerCallback(), variable_t::val, vlc_object_internals::var_lock, VLC_ENOVAR, vlc_internals, vlc_mutex_unlock(), VLC_SUCCESS, and WaitUnused().

int var_Type ( vlc_object_t p_this,
const char *  psz_name 
)

Request a variable's type.

Returns
The variable type if it exists, or 0 if the variable could not be found.
See also
Variable types

References variable_t::choices, vlc_list_t::i_count, variable_t::i_type, i_type, Lookup(), vlc_object_internals::var_lock, vlc_internals, vlc_mutex_unlock(), and VLC_VAR_HASCHOICE.