/*****************************************************************************
* variables.c: routines for object variables handling
*****************************************************************************
- * Copyright (C) 2002-2006 the VideoLAN team
+ * Copyright (C) 2002-2009 the VideoLAN team
* $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
#include "libvlc.h"
#include "vlc_interface.h"
+#include <assert.h>
/*****************************************************************************
* Private types
* Local duplication functions, and local deallocation functions
*****************************************************************************/
static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
-static void DupString( vlc_value_t *p_val ) { if( p_val->psz_string ) p_val->psz_string = strdup( p_val->psz_string ); }
+static void DupString( vlc_value_t *p_val )
+{
+ p_val->psz_string = strdup( p_val->psz_string ? p_val->psz_string : "" );
+}
static void DupList( vlc_value_t *p_val )
{
static uint32_t HashString ( const char * );
static int Insert ( variable_t *, int, const char * );
static int InsertInner ( variable_t *, int, uint32_t );
-static int Lookup ( variable_t *, int, const char * );
-static int LookupInner ( variable_t *, int, uint32_t );
+static int Lookup ( variable_t *, size_t, const char * );
static void CheckValue ( variable_t *, vlc_value_t * );
static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
int );
+static int TriggerCallback( vlc_object_t *, variable_t **, const char *,
+ vlc_value_t );
/**
* Initialize a vlc variable
if( i_new >= 0 )
{
/* If the types differ, variable creation failed. */
- if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
+ if( (i_type & VLC_VAR_TYPE) != (p_priv->p_vars[i_new].i_type & VLC_VAR_TYPE) )
{
vlc_mutex_unlock( &p_priv->var_lock );
return VLC_EBADVAR;
}
p_priv->p_vars[i_new].i_usage++;
- if( i_type & VLC_VAR_ISCOMMAND )
- p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
+ p_priv->p_vars[i_new].i_type |= ( i_type & VLC_VAR_ISCOMMAND );
+ p_priv->p_vars[i_new].i_type |= ( i_type & VLC_VAR_HASCHOICE );
vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
p_var->psz_text = NULL;
p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
- memset( &p_var->val, 0, sizeof(vlc_value_t) );
p_var->i_usage = 1;
}
}
break;
- case VLC_VAR_FREELIST:
- FreeList( p_val );
- if( p_val2 && p_val2->p_list )
- {
- for( i = 0; i < p_val2->p_list->i_count; i++ )
- free( p_val2->p_list->p_values[i].psz_string );
- if( p_val2->p_list->i_count )
- {
- free( p_val2->p_list->p_values );
- free( p_val2->p_list->pi_types );
- }
- free( p_val2->p_list );
- }
- break;
case VLC_VAR_SETTEXT:
free( p_var->psz_text );
if( p_val && p_val->psz_string )
p_var->psz_text = strdup( p_val->psz_string );
+ else
+ p_var->psz_text = NULL;
break;
case VLC_VAR_GETTEXT:
p_val->psz_string = NULL;
}
}
break;
- case VLC_VAR_TRIGGER_CALLBACKS:
- {
- /* Deal with callbacks. Tell we're in a callback, release the lock,
- * call stored functions, retake the lock. */
- if( p_var->i_entries )
- {
- int i_var;
- int i_entries = p_var->i_entries;
- callback_entry_t *p_entries = p_var->p_entries;
-
- p_var->b_incallback = true;
- vlc_mutex_unlock( &p_priv->var_lock );
-
- /* The real calls */
- for( ; i_entries-- ; )
- {
- p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
- p_entries[i_entries].p_data );
- }
-
- vlc_mutex_lock( &p_priv->var_lock );
-
- i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
- if( i_var < 0 )
- {
- msg_Err( p_this, "variable %s has disappeared", psz_name );
- vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_ENOVAR;
- }
-
- p_var = &p_priv->p_vars[i_var];
- p_var->b_incallback = false;
- }
- }
- break;
case VLC_VAR_SETISCOMMAND:
p_var->i_type |= VLC_VAR_ISCOMMAND;
return VLC_SUCCESS;
}
+
+/**
+ * Perform a Get and Set on a variable
+ *
+ * \param p_this: The object that hold the variable
+ * \param psz_name: the name of the variable
+ * \param i_action: the action to perform
+ * \param p_val: The action parameter
+ * \return vlc error codes
+ */
+int __var_GetAndSet( vlc_object_t *p_this, const char *psz_name, int i_action,
+ vlc_value_t val )
+{
+ int i_var;
+ int i_ret = VLC_SUCCESS;
+ variable_t *p_var;
+ vlc_value_t oldval;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
+
+ vlc_mutex_lock( &p_priv->var_lock );
+ i_var = GetUnused( p_this, psz_name );
+ if( i_var < 0 )
+ {
+ vlc_mutex_unlock( &p_priv->var_lock );
+ return i_var;
+ }
+
+ p_var = &p_priv->p_vars[i_var];
+
+ /* Duplicated data if needed */
+ //p_var->ops->pf_dup( &val );
+
+ /* Backup needed stuff */
+ oldval = p_var->val;
+
+ /* depending of the action requiered */
+ switch( i_action )
+ {
+ case VLC_VAR_TOGGLE_BOOL:
+ assert( ( p_var->i_type & VLC_VAR_BOOL ) == VLC_VAR_BOOL );
+ p_var->val.b_bool = !p_var->val.b_bool;
+ break;
+ case VLC_VAR_INTEGER_INCDEC:
+ assert( ( p_var->i_type & VLC_VAR_INTEGER ) == VLC_VAR_INTEGER );
+ p_var->val.i_int += val.i_int;
+ break;
+ default:
+ vlc_mutex_unlock( &p_priv->var_lock );
+ return VLC_EGENERIC;
+ }
+
+ /* Check boundaries */
+ CheckValue( p_var, &p_var->val );
+
+ /* Deal with callbacks.*/
+ if( p_var->i_entries )
+ i_ret = TriggerCallback( p_this, &p_var, psz_name, oldval );
+
+ vlc_mutex_unlock( &p_priv->var_lock );
+
+ return i_ret;
+}
+
+
/**
* Request a variable's type
*
return i_type;
}
-/**
- * Set a variable's value
- *
- * \param p_this The object that hold the variable
- * \param psz_name The name of the variable
- * \param val the value to set
- */
-int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
+int var_SetChecked( vlc_object_t *p_this, const char *psz_name,
+ int expected_type, vlc_value_t val )
{
int i_var;
+ int i_ret = VLC_SUCCESS;
variable_t *p_var;
vlc_value_t oldval;
vlc_object_internals_t *p_priv = vlc_internals( p_this );
}
p_var = &p_priv->p_vars[i_var];
+ assert( (p_var->i_type & VLC_VAR_CLASS) == 0 || expected_type == 0 ||
+ (p_var->i_type & VLC_VAR_CLASS) == expected_type );
/* Duplicate data if needed */
p_var->ops->pf_dup( &val );
/* Set the variable */
p_var->val = val;
- /* Deal with callbacks. Tell we're in a callback, release the lock,
- * call stored functions, retake the lock. */
+ /* Deal with callbacks */
if( p_var->i_entries )
- {
- int i_var;
- int i_entries = p_var->i_entries;
- callback_entry_t *p_entries = p_var->p_entries;
-
- p_var->b_incallback = true;
- vlc_mutex_unlock( &p_priv->var_lock );
-
- /* The real calls */
- for( ; i_entries-- ; )
- {
- p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
- p_entries[i_entries].p_data );
- }
-
- vlc_mutex_lock( &p_priv->var_lock );
-
- i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
- if( i_var < 0 )
- {
- msg_Err( p_this, "variable %s has disappeared", psz_name );
- vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_ENOVAR;
- }
-
- p_var = &p_priv->p_vars[i_var];
- p_var->b_incallback = false;
- }
+ i_ret = TriggerCallback( p_this, &p_var, psz_name, oldval );
/* Free data if needed */
p_var->ops->pf_free( &oldval );
vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_SUCCESS;
+ return i_ret;
}
+
/**
- * Get a variable's value
+ * Set a variable's value
*
- * \param p_this The object that holds the variable
+ * \param p_this The object that hold the variable
* \param psz_name The name of the variable
- * \param p_val Pointer to a vlc_value_t that will hold the variable's value
- * after the function is finished
+ * \param val the value to set
*/
-int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
+int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
+{
+ return var_SetChecked( p_this, psz_name, 0, val );
+}
+
+int var_GetChecked( vlc_object_t *p_this, const char *psz_name,
+ int expected_type, vlc_value_t *p_val )
{
- int i_var;
- variable_t *p_var;
vlc_object_internals_t *p_priv = vlc_internals( p_this );
+ int i_var, err = VLC_SUCCESS;
vlc_mutex_lock( &p_priv->var_lock );
i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
-
- if( i_var < 0 )
+ if( i_var >= 0 )
{
- vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_ENOVAR;
- }
+ variable_t *p_var = &p_priv->p_vars[i_var];
- p_var = &p_priv->p_vars[i_var];
+ assert( (p_var->i_type & VLC_VAR_CLASS) == 0 || expected_type == 0 ||
+ (p_var->i_type & VLC_VAR_CLASS) == expected_type );
- /* Really get the variable */
- *p_val = p_var->val;
+ /* Really get the variable */
+ *p_val = p_var->val;
- /* Duplicate value if needed */
- p_var->ops->pf_dup( p_val );
+ /* Duplicate value if needed */
+ p_var->ops->pf_dup( p_val );
+ }
+ else
+ err = VLC_ENOVAR;
vlc_mutex_unlock( &p_priv->var_lock );
-
- return VLC_SUCCESS;
+ return err;
}
-
-#undef var_AcquireMutex
/**
- * Finds a process-wide mutex, creates it if needed, and locks it.
- * Unlock with vlc_mutex_unlock().
+ * Get a variable's value
+ *
+ * \param p_this The object that holds the variable
+ * \param psz_name The name of the variable
+ * \param p_val Pointer to a vlc_value_t that will hold the variable's value
+ * after the function is finished
*/
-vlc_mutex_t *var_AcquireMutex( const char *name )
+int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
{
- libvlc_global_data_t *p_global = vlc_global();
- vlc_value_t val;
-
- if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
- return NULL;
-
- var_Get( p_global, name, &val );
- vlc_mutex_lock( val.p_address );
- return val.p_address;
+ return var_GetChecked( p_this, psz_name, 0, p_val );
}
-
/**
* Register a callback in a variable
*
int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
{
int i_var;
+ int i_ret = VLC_SUCCESS;
variable_t *p_var;
- vlc_value_t oldval;
vlc_object_internals_t *p_priv = vlc_internals( p_this );
vlc_mutex_lock( &p_priv->var_lock );
p_var = &p_priv->p_vars[i_var];
- /* Backup needed stuff */
- oldval = p_var->val;
-
/* Deal with callbacks. Tell we're in a callback, release the lock,
* call stored functions, retake the lock. */
if( p_var->i_entries )
- {
- int i_var;
- int i_entries = p_var->i_entries;
- callback_entry_t *p_entries = p_var->p_entries;
-
- p_var->b_incallback = true;
- vlc_mutex_unlock( &p_priv->var_lock );
-
- /* The real calls */
- for( ; i_entries-- ; )
- {
- p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
- p_entries[i_entries].p_data );
- }
-
- vlc_mutex_lock( &p_priv->var_lock );
-
- i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
- if( i_var < 0 )
- {
- msg_Err( p_this, "variable %s has disappeared", psz_name );
- vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_ENOVAR;
- }
-
- p_var = &p_priv->p_vars[i_var];
- p_var->b_incallback = false;
- }
+ i_ret = TriggerCallback( p_this, &p_var, psz_name, p_var->val );
vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_SUCCESS;
+ return i_ret;
}
/** Parse a stringified option
if( !trusted )
{
module_config_t *p_config = config_FindConfig( p_obj, psz_name );
- if( !p_config->b_safe )
+ if( !p_config || !p_config->b_safe )
{
msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
"security reasons", psz_name );
var_Set( p_obj, psz_name, val );
- // If that's a list, remove all elements allocated
+ /* If that's a list, remove all elements allocated */
if( i_type == VLC_VAR_LIST )
FreeList( &val );
/* Following functions are local */
/*****************************************************************************
- * GetUnused: find an unused variable from its name
+ * GetUnused: find an unused (not in callback) variable from its name
*****************************************************************************
* We do i_tries tries before giving up, just in case the variable is being
* modified and called from a callback.
*****************************************************************************/
static int GetUnused( vlc_object_t *p_this, const char *psz_name )
{
- int i_var, i_tries = 0;
vlc_object_internals_t *p_priv = vlc_internals( p_this );
while( true )
{
+ int i_var;
+
i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var < 0 )
{
return i_var;
}
- if( i_tries++ > 100 )
- {
- msg_Err( p_this, "caught in a callback deadlock? ('%s')", psz_name );
- return VLC_ETIMEOUT;
- }
-
- vlc_mutex_unlock( &p_priv->var_lock );
- msleep( THREAD_SLEEP );
- vlc_mutex_lock( &p_priv->var_lock );
+ mutex_cleanup_push( &p_priv->var_lock );
+ vlc_cond_wait( &p_priv->var_wait, &p_priv->var_lock );
+ vlc_cleanup_pop( );
}
}
return i_middle + 1;
}
+static int u32cmp( const void *key, const void *data )
+{
+ const variable_t *p_var = data;
+ uint32_t hash = *(const uint32_t *)key ;
+
+ if( hash > p_var->i_hash )
+ return 1;
+ if( hash < p_var->i_hash )
+ return -1;
+ return 0;
+}
+
/*****************************************************************************
* Lookup: find an existing variable given its name
*****************************************************************************
* We use a recursive inner function indexed on the hash. Care is taken of
* possible hash collisions.
- * XXX: does this really need to be written recursively?
*****************************************************************************/
-static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
+static int Lookup( variable_t *p_vars, size_t i_count, const char *psz_name )
{
+ variable_t *p_var;
uint32_t i_hash;
- int i, i_pos;
-
- if( i_count == 0 )
- {
- return -1;
- }
i_hash = HashString( psz_name );
-
- i_pos = LookupInner( p_vars, i_count, i_hash );
+ p_var = bsearch( &i_hash, p_vars, i_count, sizeof( *p_var ), u32cmp );
/* Hash not found */
- if( i_hash != p_vars[i_pos].i_hash )
- {
+ if( p_var == NULL )
return -1;
- }
- /* Hash found, entry found */
- if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
- {
- return i_pos;
- }
+ assert( i_count > 0 );
- /* Hash collision! This should be very rare, but we cannot guarantee
- * it will never happen. Just do an exhaustive search amongst all
- * entries with the same hash. */
- for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
- {
- if( !strcmp( psz_name, p_vars[i].psz_name ) )
- {
- return i;
- }
- }
+ /* Find the first entry with the right hash */
+ while( (p_var > p_vars) && (i_hash == p_var[-1].i_hash) )
+ p_var--;
- for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
+ assert( p_var->i_hash == i_hash );
+
+ /* Hash collision should be very unlikely, but we cannot guarantee
+ * it will never happen. So we do an exhaustive search amongst all
+ * entries with the same hash. Typically, there is only one anyway. */
+ for( variable_t *p_end = p_vars + i_count;
+ (p_var < p_end) && (i_hash == p_var->i_hash);
+ p_var++ )
{
- if( !strcmp( psz_name, p_vars[i].psz_name ) )
- {
- return i;
- }
+ if( !strcmp( psz_name, p_var->psz_name ) )
+ return p_var - p_vars;
}
/* Hash found, but entry not found */
return -1;
}
-static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
-{
- int i_middle;
-
- if( i_hash <= p_vars[0].i_hash )
- {
- return 0;
- }
-
- if( i_hash >= p_vars[i_count-1].i_hash )
- {
- return i_count - 1;
- }
-
- i_middle = i_count / 2;
-
- /* We know that 0 < i_middle */
- if( i_hash < p_vars[i_middle].i_hash )
- {
- return LookupInner( p_vars, i_middle, i_hash );
- }
-
- /* We know that i_middle + 1 < i_count */
- if( i_hash > p_vars[i_middle].i_hash )
- {
- return i_middle + LookupInner( p_vars + i_middle,
- i_count - i_middle,
- i_hash );
- }
-
- return i_middle;
-}
-
/*****************************************************************************
* CheckValue: check that a value is valid wrt. a variable
*****************************************************************************
int i_var;
variable_t *p_var;
- if( p_this->p_parent || ( p_this->p_libvlc && p_this != p_this->p_libvlc ) )
+ if( p_this->p_parent || ( p_this->p_libvlc && p_this != (vlc_object_t*) p_this->p_libvlc ) )
{
vlc_object_internals_t *p_priv;
/* Duplicate value if needed */
p_var->ops->pf_dup( p_val );
+ /*msg_Dbg( p_this, "Inherited value for var %s from object %s",
+ psz_name ? psz_name : "(null)",
+ p_this->psz_object_name
+ ? p_this->psz_object_name : "(Unknown)" );*/
return VLC_SUCCESS;
}
else if ( p_this->p_parent ) /* We are still not there */
break;
}
default:
+ msg_Warn( p_this, "Could not inherit value for var %s "
+ "from config. Invalid Type", psz_name );
return VLC_ENOOBJ;
break;
}
+ /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/
return VLC_SUCCESS;
}
+
+/**********************************************************************
+ * Trigger the callbacks.
+ * Tell we're in a callback, release the lock, call stored functions,
+ * retake the lock.
+ **********************************************************************/
+static int TriggerCallback( vlc_object_t *p_this, variable_t **pp_var,
+ const char *psz_name, vlc_value_t oldval )
+{
+ int i_var;
+ int i_entries = (*pp_var)->i_entries;
+ callback_entry_t *p_entries = (*pp_var)->p_entries;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
+
+ (*pp_var)->b_incallback = true;
+ vlc_mutex_unlock( &p_priv->var_lock );
+
+ /* The real calls */
+ for( ; i_entries-- ; )
+ {
+ p_entries[i_entries].pf_callback( p_this, psz_name, oldval, (*pp_var)->val,
+ p_entries[i_entries].p_data );
+ }
+
+ vlc_mutex_lock( &p_priv->var_lock );
+
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
+ if( i_var < 0 )
+ {
+ msg_Err( p_this, "variable %s has disappeared", psz_name );
+ return VLC_ENOVAR;
+ }
+
+ *pp_var = &p_priv->p_vars[i_var];
+ (*pp_var)->b_incallback = false;
+ vlc_cond_broadcast( &p_priv->var_wait );
+
+ return VLC_SUCCESS;
+}
+
+
/**********************************************************************
* Execute a var command on an object identified by its name
**********************************************************************/
if( psz_msg )
{
- *psz_msg = (char*)malloc( 80 );
- sprintf( *psz_msg, "%s on object %s returned %i (%s)",
- psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );
+ if( asprintf( psz_msg, "%s on object %s returned %i (%s)",
+ psz_cmd, psz_name, i_ret, vlc_error( i_ret ) ) == -1)
+ *psz_msg = NULL;
}
return i_ret;
}
+
+
+/**
+ * Free a list and the associated strings
+ * @param p_val: the list variable
+ * @param p_val2: the variable associated or NULL
+ */
+void var_FreeList( vlc_value_t *p_val, vlc_value_t *p_val2 )
+{
+ FreeList( p_val );
+ if( p_val2 && p_val2->p_list )
+ {
+ for( int i = 0; i < p_val2->p_list->i_count; i++ )
+ free( p_val2->p_list->p_values[i].psz_string );
+ if( p_val2->p_list->i_count )
+ {
+ free( p_val2->p_list->p_values );
+ free( p_val2->p_list->pi_types );
+ }
+ free( p_val2->p_list );
+ }
+}
projects / vlc / blobdiff