/*****************************************************************************
* variables.c: routines for object variables handling
*****************************************************************************
- * Copyright (C) 2002 VideoLAN
- * $Id: variables.c,v 1.27 2003/07/22 15:59:06 gbazin Exp $
+ * Copyright (C) 2002-2006 the VideoLAN team
+ * $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
*
* 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., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <vlc/vlc.h>
-
-#ifdef HAVE_STDLIB_H
-# include <stdlib.h> /* realloc() */
+#ifdef HAVE_CONFIG_H
+# include "config.h"
#endif
+#include <vlc_common.h>
+#include "variables.h"
+
+#include "libvlc.h"
+
+#include "vlc_interface.h"
+
/*****************************************************************************
* Private types
*****************************************************************************/
static int CmpInt( vlc_value_t v, vlc_value_t w ) { return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1; }
static int CmpTime( vlc_value_t v, vlc_value_t w )
{
- mtime_t v_time,w_time;
- v_time = ( (mtime_t)v.time.i_high << 32 ) + v.time.i_low;
- w_time = ( (mtime_t)w.time.i_high << 32 ) + w.time.i_low;
- return v_time == w_time ? 0 : v_time > w_time ? 1 : -1;
+ return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
+}
+static int CmpString( vlc_value_t v, vlc_value_t w )
+{
+ if( !v.psz_string )
+ return !w.psz_string ? 0 : -1;
+ else
+ return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
}
-static int CmpString( vlc_value_t v, vlc_value_t w ) { return strcmp( v.psz_string, w.psz_string ); }
static int CmpFloat( vlc_value_t v, vlc_value_t w ) { return v.f_float == w.f_float ? 0 : v.f_float > w.f_float ? 1 : -1; }
static int CmpAddress( vlc_value_t v, vlc_value_t w ) { return v.p_address == w.p_address ? 0 : v.p_address > w.p_address ? 1 : -1; }
* 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 ) { p_val->psz_string = strdup( p_val->psz_string ); }
+static void DupString( vlc_value_t *p_val ) { if( p_val->psz_string ) p_val->psz_string = strdup( p_val->psz_string ); }
static void DupList( vlc_value_t *p_val )
{
int i;
vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
+ p_list->i_count = p_val->p_list->i_count;
if( p_val->p_list->i_count )
{
- p_list->i_count = p_val->p_list->i_count;
p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
}
+ else
+ {
+ p_list->p_values = NULL;
+ p_list->pi_types = NULL;
+ }
for( i = 0; i < p_list->i_count; i++ )
{
p_list->p_values[i] = p_val->p_list->p_values[i];
+ p_list->pi_types[i] = p_val->p_list->pi_types[i];
switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
{
case VLC_VAR_STRING:
-
+
DupString( &p_list->p_values[i] );
break;
default:
static int InheritValue( vlc_object_t *, const char *, vlc_value_t *,
int );
-/*****************************************************************************
- * var_Create: initialize a vlc variable
- *****************************************************************************
+/**
+ * Initialize a vlc variable
+ *
* We hash the given string and insert it into the sorted list. The insertion
* may require slow memory copies, but think about what we gain in the log(n)
* lookup phase when setting/getting the variable value!
- *****************************************************************************/
+ *
+ * \param p_this The object in which to create the variable
+ * \param psz_name The name of the variable
+ * \param i_type The variables type. Must be one of \ref var_type combined with
+ * zero or more \ref var_flags
+ */
int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
{
int i_new;
variable_t *p_var;
static vlc_list_t dummy_null_list = {0, NULL, NULL};
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
/* FIXME: if the variable already exists, we don't duplicate it. But we
* duplicate the lookups. It's not that serious, but if anyone finds some
* time to rework Insert() so that only one lookup has to be done, feel
* free to do so. */
- i_new = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_new >= 0 )
{
/* If the types differ, variable creation failed. */
- if( i_type != p_this->p_vars[i_new].i_type )
+ if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_EBADVAR;
}
- p_this->p_vars[i_new].i_usage++;
- vlc_mutex_unlock( &p_this->var_lock );
+ 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;
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
- i_new = Insert( p_this->p_vars, p_this->i_vars, psz_name );
+ i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
- if( (p_this->i_vars & 15) == 15 )
+ if( (p_priv->i_vars & 15) == 15 )
{
- p_this->p_vars = realloc( p_this->p_vars,
- (p_this->i_vars+17) * sizeof(variable_t) );
+ p_priv->p_vars = realloc( p_priv->p_vars,
+ (p_priv->i_vars+17) * sizeof(variable_t) );
}
- memmove( p_this->p_vars + i_new + 1,
- p_this->p_vars + i_new,
- (p_this->i_vars - i_new) * sizeof(variable_t) );
+ memmove( p_priv->p_vars + i_new + 1,
+ p_priv->p_vars + i_new,
+ (p_priv->i_vars - i_new) * sizeof(variable_t) );
- p_this->i_vars++;
+ p_priv->i_vars++;
- p_var = &p_this->p_vars[i_new];
+ p_var = &p_priv->p_vars[i_new];
+ memset( p_var, 0, sizeof(*p_var) );
p_var->i_hash = HashString( psz_name );
p_var->psz_name = strdup( psz_name );
p_var->psz_text = NULL;
- p_var->i_type = i_type;
+ p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
memset( &p_var->val, 0, sizeof(vlc_value_t) );
p_var->pf_dup = DupDummy;
p_var->choices_text.i_count = 0;
p_var->choices_text.p_values = NULL;
- p_var->b_incallback = VLC_FALSE;
+ p_var->b_incallback = false;
p_var->i_entries = 0;
p_var->p_entries = NULL;
{
case VLC_VAR_BOOL:
p_var->pf_cmp = CmpBool;
- p_var->val.b_bool = VLC_FALSE;
+ p_var->val.b_bool = false;
break;
case VLC_VAR_INTEGER:
+ case VLC_VAR_HOTKEY:
p_var->pf_cmp = CmpInt;
p_var->val.i_int = 0;
break;
p_var->pf_cmp = CmpString;
p_var->pf_dup = DupString;
p_var->pf_free = FreeString;
- p_var->val.psz_string = "";
+ p_var->val.psz_string = NULL;
break;
case VLC_VAR_FLOAT:
p_var->pf_cmp = CmpFloat;
break;
case VLC_VAR_TIME:
p_var->pf_cmp = CmpTime;
- p_var->val.time.i_low = 0;
- p_var->val.time.i_high = 0;
+ p_var->val.i_time = 0;
break;
case VLC_VAR_ADDRESS:
p_var->pf_cmp = CmpAddress;
p_var->pf_cmp = CmpAddress;
p_var->pf_free = FreeMutex;
p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
- vlc_mutex_init( p_this, (vlc_mutex_t*)p_var->val.p_address );
+ vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
break;
case VLC_VAR_LIST:
p_var->pf_cmp = CmpAddress;
/* Duplicate the default data we stored. */
p_var->pf_dup( &p_var->val );
- vlc_mutex_unlock( &p_this->var_lock );
+ if( i_type & VLC_VAR_DOINHERIT )
+ {
+ vlc_value_t val;
+
+ if( InheritValue( p_this, psz_name, &val, p_var->i_type )
+ == VLC_SUCCESS )
+ {
+ /* Free data if needed */
+ p_var->pf_free( &p_var->val );
+ /* Set the variable */
+ p_var->val = val;
+
+ if( i_type & VLC_VAR_HASCHOICE )
+ {
+ /* We must add the inherited value to our choice list */
+ p_var->i_default = 0;
+
+ INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
+ 0, val );
+ INSERT_ELEM( p_var->choices_text.p_values,
+ p_var->choices_text.i_count, 0, val );
+ p_var->pf_dup( &p_var->choices.p_values[0] );
+ p_var->choices_text.p_values[0].psz_string = NULL;
+ }
+ }
+ }
+
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_Destroy: destroy a vlc variable
- *****************************************************************************
+/**
+ * Destroy a vlc variable
+ *
* Look for the variable and destroy it if it is found. As in var_Create we
* do a call to memmove() but we have performance counterparts elsewhere.
- *****************************************************************************/
+ *
+ * \param p_this The object that holds the variable
+ * \param psz_name The name of the variable
+ */
int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
{
int i_var, i;
variable_t *p_var;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
i_var = GetUnused( p_this, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return i_var;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
if( p_var->i_usage > 1 )
{
p_var->i_usage--;
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
p_var->pf_free( &p_var->choices.p_values[i] );
- if( p_var->choices_text.p_values[i].psz_string )
- free( p_var->choices_text.p_values[i].psz_string );
+ free( p_var->choices_text.p_values[i].psz_string );
}
free( p_var->choices.p_values );
free( p_var->choices_text.p_values );
}
free( p_var->psz_name );
- if( p_var->psz_text ) free( p_var->psz_text );
+ free( p_var->psz_text );
- memmove( p_this->p_vars + i_var,
- p_this->p_vars + i_var + 1,
- (p_this->i_vars - i_var - 1) * sizeof(variable_t) );
+ memmove( p_priv->p_vars + i_var,
+ p_priv->p_vars + i_var + 1,
+ (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
- if( (p_this->i_vars & 15) == 0 )
+ if( (p_priv->i_vars & 15) == 0 )
{
- p_this->p_vars = realloc( p_this->p_vars,
- (p_this->i_vars) * sizeof( variable_t ) );
+ p_priv->p_vars = realloc( p_priv->p_vars,
+ (p_priv->i_vars) * sizeof( variable_t ) );
}
- p_this->i_vars--;
+ p_priv->i_vars--;
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_Change: perform an action on a variable
- *****************************************************************************
+/**
+ * Perform an action on a variable
*
- *****************************************************************************/
+ * \param p_this The object that holds the variable
+ * \param psz_name The name of the variable
+ * \param i_action The action to perform. Must be one of \ref var_action
+ * \param p_val First action parameter
+ * \param p_val2 Second action parameter
+ */
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 )
{
int i_var, i;
variable_t *p_var;
vlc_value_t oldval;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
- i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_ENOVAR;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
switch( i_action )
{
p_var->pf_dup( &p_var->min );
CheckValue( p_var, &p_var->val );
break;
+ case VLC_VAR_GETMIN:
+ if( p_var->i_type & VLC_VAR_HASMIN )
+ {
+ *p_val = p_var->min;
+ }
+ break;
case VLC_VAR_SETMAX:
if( p_var->i_type & VLC_VAR_HASMAX )
{
p_var->pf_dup( &p_var->max );
CheckValue( p_var, &p_var->val );
break;
+ case VLC_VAR_GETMAX:
+ if( p_var->i_type & VLC_VAR_HASMAX )
+ {
+ *p_val = p_var->max;
+ }
+ break;
case VLC_VAR_SETSTEP:
if( p_var->i_type & VLC_VAR_HASSTEP )
{
p_var->pf_dup( &p_var->step );
CheckValue( p_var, &p_var->val );
break;
- case VLC_VAR_ADDCHOICE:
- /* FIXME: the list is sorted, dude. Use something cleverer. */
- for( i = p_var->choices.i_count ; i-- ; )
- {
- if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) < 0 )
- {
- break;
- }
- }
-
- /* The new place is i+1 */
- i++;
-
- if( p_var->i_default >= i )
+ case VLC_VAR_GETSTEP:
+ if( p_var->i_type & VLC_VAR_HASSTEP )
{
- p_var->i_default++;
+ *p_val = p_var->step;
}
+ break;
+ case VLC_VAR_ADDCHOICE:
+ i = p_var->choices.i_count;
INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
i, *p_val );
CheckValue( p_var, &p_var->val );
break;
case VLC_VAR_DELCHOICE:
- /* FIXME: the list is sorted, dude. Use something cleverer. */
for( i = 0 ; i < p_var->choices.i_count ; i++ )
{
if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
if( i == p_var->choices.i_count )
{
/* Not found */
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_EGENERIC;
}
}
p_var->pf_free( &p_var->choices.p_values[i] );
- if( p_var->choices_text.p_values[i].psz_string )
- free( p_var->choices_text.p_values[i].psz_string );
+ free( p_var->choices_text.p_values[i].psz_string );
REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
REMOVE_ELEM( p_var->choices_text.p_values,
p_var->choices_text.i_count, i );
{
p_var->pf_free( &p_var->choices.p_values[i] );
}
- if( p_var->choices.i_count )
- free( p_var->choices.p_values );
+ for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
+ free( p_var->choices_text.p_values[i].psz_string );
+
+ if( p_var->choices.i_count ) free( p_var->choices.p_values );
+ if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
p_var->choices.i_count = 0;
p_var->choices.p_values = NULL;
+ p_var->choices_text.i_count = 0;
+ p_var->choices_text.p_values = NULL;
p_var->i_default = -1;
break;
case VLC_VAR_SETDEFAULT:
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:
- if( p_var->psz_text ) free( p_var->psz_text );
+ free( p_var->psz_text );
if( p_val && p_val->psz_string )
p_var->psz_text = strdup( p_val->psz_string );
break;
{
vlc_value_t val;
- if( InheritValue( p_this, psz_name, &val, p_var->i_type )
- == VLC_SUCCESS );
+ if( InheritValue( p_this,
+ p_val2 ? p_val2->psz_string : psz_name,
+ &val, p_var->i_type )
+ == VLC_SUCCESS )
{
/* Duplicate already done */
}
}
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;
+ break;
default:
break;
}
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_Type: request a variable's type
- *****************************************************************************
- * This function returns the variable type if it exists, or 0 if the
+/**
+ * Request a variable's type
+ *
+ * \return The variable type if it exists, or 0 if the
* variable could not be found.
- *****************************************************************************/
+ * \see \ref var_type
+ */
int __var_Type( vlc_object_t *p_this, const char *psz_name )
{
int i_var, i_type;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_mutex_lock( &p_priv->var_lock );
- i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return 0;
}
- i_type = p_this->p_vars[i_var].i_type;
+ i_type = p_priv->p_vars[i_var].i_type;
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return i_type;
}
-/*****************************************************************************
- * var_Set: set a variable's value
- *****************************************************************************
+/**
+ * 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 i_var;
variable_t *p_var;
vlc_value_t oldval;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
i_var = GetUnused( p_this, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return i_var;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
/* Duplicate data if needed */
p_var->pf_dup( &val );
int i_entries = p_var->i_entries;
callback_entry_t *p_entries = p_var->p_entries;
- p_var->b_incallback = VLC_TRUE;
- vlc_mutex_unlock( &p_this->var_lock );
+ p_var->b_incallback = true;
+ vlc_mutex_unlock( &p_priv->var_lock );
/* The real calls */
for( ; i_entries-- ; )
p_entries[i_entries].p_data );
}
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_mutex_lock( &p_priv->var_lock );
- i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ 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_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_ENOVAR;
}
- p_var = &p_this->p_vars[i_var];
- p_var->b_incallback = VLC_FALSE;
+ p_var = &p_priv->p_vars[i_var];
+ p_var->b_incallback = false;
}
/* Free data if needed */
p_var->pf_free( &oldval );
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_Get: get a variable's value
- *****************************************************************************
+/**
+ * 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
+ */
int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
{
int i_var;
variable_t *p_var;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
- i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_ENOVAR;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
/* Really get the variable */
*p_val = p_var->val;
/* Duplicate value if needed */
p_var->pf_dup( p_val );
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_AddCallback: register a callback in a variable
- *****************************************************************************
- * We store a function pointer pf_callback that will be called upon variable
- * modification. p_data is a generic pointer that will be passed as additional
- * argument to the callback function.
- *****************************************************************************/
+
+/**
+ * Finds a process-wide mutex, creates it if needed, and locks it.
+ * Unlock with vlc_mutex_unlock().
+ */
+vlc_mutex_t *var_AcquireMutex( const char *name )
+{
+ 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;
+}
+
+
+/**
+ * Register a callback in a variable
+ *
+ * We store a function pointer that will be called upon variable
+ * modification.
+ *
+ * \param p_this The object that holds the variable
+ * \param psz_name The name of the variable
+ * \param pf_callback The function pointer
+ * \param p_data A 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.
+ */
int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
vlc_callback_t pf_callback, void *p_data )
{
int i_var;
variable_t *p_var;
callback_entry_t entry;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
+ vlc_refcheck( p_this );
entry.pf_callback = pf_callback;
entry.p_data = p_data;
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_mutex_lock( &p_priv->var_lock );
i_var = GetUnused( p_this, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return i_var;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
INSERT_ELEM( p_var->p_entries,
p_var->i_entries,
p_var->i_entries,
entry );
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
-/*****************************************************************************
- * var_DelCallback: remove a callback from a variable
- *****************************************************************************
+/**
+ * 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.
- *****************************************************************************/
+ */
int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
vlc_callback_t pf_callback, void *p_data )
{
int i_entry, i_var;
variable_t *p_var;
+ vlc_object_internals_t *p_priv = vlc_internals( p_this );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_refcheck( p_this );
+ vlc_mutex_lock( &p_priv->var_lock );
i_var = GetUnused( p_this, psz_name );
if( i_var < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return i_var;
}
- p_var = &p_this->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
for( i_entry = p_var->i_entries ; i_entry-- ; )
{
if( i_entry < 0 )
{
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_EGENERIC;
}
REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
+
+ return VLC_SUCCESS;
+}
+
+/**
+ * Trigger callback on a variable
+ *
+ * \param p_this The object that hold the variable
+ * \param psz_name The name of the variable
+ */
+int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
+{
+ int i_var;
+ 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];
+
+ /* 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;
+ }
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
+/** Parse a stringified option
+ * This function parse a string option and create the associated object
+ * variable
+ * The option must be of the form "[no[-]]foo[=bar]" where foo is the
+ * option name and bar is the value of the option.
+ * \param p_obj the object in which the variable must be created
+ * \param psz_option the option to parse
+ * \param trusted whether the option is set by a trusted input or not
+ * \return nothing
+ */
+void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
+ bool trusted )
+{
+ char *psz_name, *psz_value;
+ int i_type;
+ bool b_isno = false;
+ vlc_value_t val;
+
+ val.psz_string = NULL;
+
+ /* It's too much of a hassle to remove the ':' when we parse
+ * the cmd line :) */
+ if( psz_option[0] == ':' )
+ psz_option++;
+
+ if( !psz_option[0] )
+ return;
+
+ psz_name = strdup( psz_option );
+ if( psz_name == NULL )
+ return;
+
+ psz_value = strchr( psz_name, '=' );
+ if( psz_value != NULL )
+ *psz_value++ = '\0';
+
+ /* FIXME: :programs should be handled generically */
+ if( !strcmp( psz_name, "programs" ) )
+ i_type = VLC_VAR_LIST;
+ else
+ i_type = config_GetType( p_obj, psz_name );
+
+ if( !i_type && !psz_value )
+ {
+ /* check for "no-foo" or "nofoo" */
+ if( !strncmp( psz_name, "no-", 3 ) )
+ {
+ memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
+ }
+ else if( !strncmp( psz_name, "no", 2 ) )
+ {
+ memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
+ }
+ else goto cleanup; /* Option doesn't exist */
+
+ b_isno = true;
+ i_type = config_GetType( p_obj, psz_name );
+ }
+ if( !i_type ) goto cleanup; /* Option doesn't exist */
+
+ if( ( i_type != VLC_VAR_BOOL ) &&
+ ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
+
+ /* check if option is unsafe */
+ if( !trusted )
+ {
+ module_config_t *p_config = config_FindConfig( p_obj, psz_name );
+ if( !p_config->b_safe )
+ {
+ msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
+ "security reasons", psz_name );
+ return;
+ }
+ }
+
+ /* Create the variable in the input object.
+ * Children of the input object will be able to retreive this value
+ * thanks to the inheritance property of the object variables. */
+ var_Create( p_obj, psz_name, i_type );
+
+ switch( i_type )
+ {
+ case VLC_VAR_BOOL:
+ val.b_bool = !b_isno;
+ break;
+
+ case VLC_VAR_INTEGER:
+ val.i_int = strtol( psz_value, NULL, 0 );
+ break;
+
+ case VLC_VAR_FLOAT:
+ val.f_float = atof( psz_value );
+ break;
+
+ case VLC_VAR_STRING:
+ case VLC_VAR_MODULE:
+ case VLC_VAR_FILE:
+ case VLC_VAR_DIRECTORY:
+ val.psz_string = psz_value;
+ break;
+
+ case VLC_VAR_LIST:
+ {
+ char *psz_orig, *psz_var;
+ vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
+ val.p_list = p_list;
+ p_list->i_count = 0;
+
+ psz_var = psz_orig = strdup(psz_value);
+ while( psz_var && *psz_var )
+ {
+ char *psz_item = psz_var;
+ vlc_value_t val2;
+ while( *psz_var && *psz_var != ',' ) psz_var++;
+ if( *psz_var == ',' )
+ {
+ *psz_var = '\0';
+ psz_var++;
+ }
+ val2.i_int = strtol( psz_item, NULL, 0 );
+ INSERT_ELEM( p_list->p_values, p_list->i_count,
+ p_list->i_count, val2 );
+ /* p_list->i_count is incremented twice by INSERT_ELEM */
+ p_list->i_count--;
+ INSERT_ELEM( p_list->pi_types, p_list->i_count,
+ p_list->i_count, VLC_VAR_INTEGER );
+ }
+ free( psz_orig );
+ break;
+ }
+
+ default:
+ goto cleanup;
+ }
+
+ var_Set( p_obj, psz_name, val );
+
+cleanup:
+ free( psz_name );
+}
+
+
/* Following functions are local */
/*****************************************************************************
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( VLC_TRUE )
+ while( true )
{
- i_var = Lookup( p_this->p_vars, p_this->i_vars, psz_name );
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var < 0 )
{
return VLC_ENOVAR;
}
- if( ! p_this->p_vars[i_var].b_incallback )
+ if( ! p_priv->p_vars[i_var].b_incallback )
{
return i_var;
}
return VLC_ETIMEOUT;
}
- vlc_mutex_unlock( &p_this->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
msleep( THREAD_SLEEP );
- vlc_mutex_lock( &p_this->var_lock );
+ vlc_mutex_lock( &p_priv->var_lock );
}
}
* This function checks p_val's value against p_var's limitations such as
* minimal and maximal value, step, in-list position, and modifies p_val if
* necessary.
- *****************************************************************************/
+ ****************************************************************************/
static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
{
/* Check that our variable is in the list */
{
switch( i_type & VLC_VAR_TYPE )
{
+ case VLC_VAR_FILE:
+ case VLC_VAR_DIRECTORY:
case VLC_VAR_STRING:
+ case VLC_VAR_MODULE:
p_val->psz_string = config_GetPsz( p_this, psz_name );
if( !p_val->psz_string ) p_val->psz_string = strdup("");
break;
p_val->f_float = config_GetFloat( p_this, psz_name );
break;
case VLC_VAR_INTEGER:
+ case VLC_VAR_HOTKEY:
p_val->i_int = config_GetInt( p_this, psz_name );
break;
case VLC_VAR_BOOL:
p_val->b_bool = config_GetInt( p_this, psz_name );
break;
+ case VLC_VAR_LIST:
+ {
+ char *psz_orig, *psz_var;
+ vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
+ p_val->p_list = p_list;
+ p_list->i_count = 0;
+
+ psz_var = psz_orig = config_GetPsz( p_this, psz_name );
+ while( psz_var && *psz_var )
+ {
+ char *psz_item = psz_var;
+ vlc_value_t val;
+ while( *psz_var && *psz_var != ',' ) psz_var++;
+ if( *psz_var == ',' )
+ {
+ *psz_var = '\0';
+ psz_var++;
+ }
+ val.i_int = strtol( psz_item, NULL, 0 );
+ INSERT_ELEM( p_list->p_values, p_list->i_count,
+ p_list->i_count, val );
+ /* p_list->i_count is incremented twice by INSERT_ELEM */
+ p_list->i_count--;
+ INSERT_ELEM( p_list->pi_types, p_list->i_count,
+ p_list->i_count, VLC_VAR_INTEGER );
+ }
+ free( psz_orig );
+ break;
+ }
default:
return VLC_ENOOBJ;
break;
return VLC_SUCCESS;
}
+ vlc_object_internals_t *p_priv = vlc_internals( p_this->p_parent );
+
/* Look for the variable */
- vlc_mutex_lock( &p_this->p_parent->var_lock );
+ vlc_mutex_lock( &p_priv->var_lock );
- i_var = Lookup( p_this->p_parent->p_vars, p_this->p_parent->i_vars,
- psz_name );
+ i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
if( i_var >= 0 )
{
/* We found it! */
-
- p_var = &p_this->p_parent->p_vars[i_var];
+ p_var = &p_priv->p_vars[i_var];
/* Really get the variable */
*p_val = p_var->val;
/* Duplicate value if needed */
p_var->pf_dup( p_val );
- vlc_mutex_unlock( &p_this->p_parent->var_lock );
-
+ vlc_mutex_unlock( &p_priv->var_lock );
return VLC_SUCCESS;
}
- vlc_mutex_unlock( &p_this->p_parent->var_lock );
+ vlc_mutex_unlock( &p_priv->var_lock );
/* We're still not there */
return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
}
+
+/**********************************************************************
+ * Execute a var command on an object identified by its name
+ **********************************************************************/
+int __var_Command( vlc_object_t *p_this, const char *psz_name,
+ const char *psz_cmd, const char *psz_arg, char **psz_msg )
+{
+ vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
+ psz_name, FIND_CHILD );
+ int i_type, i_ret;
+
+ if( !p_obj )
+ {
+ if( psz_msg )
+ *psz_msg = strdup( "Unknown destination object." );
+ return VLC_ENOOBJ;
+ }
+
+ vlc_refcheck( p_this );
+ i_type = var_Type( p_obj, psz_cmd );
+ if( !( i_type&VLC_VAR_ISCOMMAND ) )
+ {
+ vlc_object_release( p_obj );
+ if( psz_msg )
+ *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
+ return VLC_EGENERIC;
+ }
+
+ i_type &= 0xf0;
+ switch( i_type )
+ {
+ case VLC_VAR_INTEGER:
+ i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
+ break;
+ case VLC_VAR_FLOAT:
+ i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
+ break;
+ case VLC_VAR_STRING:
+ i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
+ break;
+ case VLC_VAR_BOOL:
+ i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
+ break;
+ default:
+ i_ret = VLC_EGENERIC;
+ break;
+ }
+
+ vlc_object_release( p_obj );
+
+ 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 ) );
+ }
+
+ return i_ret;
+}
projects / vlc / blobdiff