/*****************************************************************************
* variables.c: routines for object variables handling
*****************************************************************************
- * Copyright (C) 2002-2009 the VideoLAN team
+ * Copyright (C) 2002-2009 VLC authors and VideoLAN
* $Id$
*
* Authors: Samuel Hocevar <sam@zoy.org>
*
- * 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.
*****************************************************************************/
/*****************************************************************************
# include "config.h"
#endif
+#ifdef HAVE_SEARCH_H
+# include <search.h>
+#endif
+#include <assert.h>
+#include <math.h>
+#include <limits.h>
+#ifdef __GLIBC__
+# include <dlfcn.h>
+#endif
+
#include <vlc_common.h>
#include <vlc_charset.h>
-#include "variables.h"
-
#include "libvlc.h"
-
-#include <search.h>
-#include <assert.h>
+#include "variables.h"
+#include "config/configuration.h"
/*****************************************************************************
* Private types
p_val->psz_string = strdup( p_val->psz_string ? 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->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_CLASS )
- {
- case VLC_VAR_STRING:
-
- DupString( &p_list->p_values[i] );
- break;
- default:
- break;
- }
- }
-
- p_val->p_list = p_list;
-}
-
static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
-static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
static void FreeList( vlc_value_t *p_val )
{
case VLC_VAR_STRING:
FreeString( &p_val->p_list->p_values[i] );
break;
- case VLC_VAR_MUTEX:
- FreeMutex( &p_val->p_list->p_values[i] );
- break;
default:
break;
}
bool_ops = { CmpBool, DupDummy, FreeDummy, },
float_ops = { CmpFloat, DupDummy, FreeDummy, },
int_ops = { CmpInt, DupDummy, FreeDummy, },
-list_ops = { CmpAddress, DupList, FreeList, },
-mutex_ops = { CmpAddress, DupDummy, FreeMutex, },
string_ops = { CmpString, DupString, FreeString, },
-time_ops = { CmpTime, DupDummy, FreeDummy, };
+time_ops = { CmpTime, DupDummy, FreeDummy, },
+coords_ops = { NULL, DupDummy, FreeDummy, };
/*****************************************************************************
* Local prototypes
free( p_var->choices.p_values );
free( p_var->choices_text.p_values );
}
+#if 0 // ndef NDEBUG
+ for (int i = 0; i < p_var->i_entries; i++)
+ {
+ const char *file = "?", *symbol = "?";
+ const void *addr = p_var->p_entries[i].pf_callback;
+# ifdef __GLIBC__
+ Dl_info info;
+
+ if (dladdr (addr, &info))
+ {
+ if (info.dli_fname) file = info.dli_fname;
+ if (info.dli_sname) symbol = info.dli_sname;
+ }
+# endif
+ fprintf (stderr, "Error: callback on \"%s\" dangling %s(%s)[%p]\n",
+ p_var->psz_name, file, symbol, addr);
+ }
+#endif
+
free( p_var->psz_name );
free( p_var->psz_text );
free( p_var->p_entries );
*/
int var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
{
- static vlc_list_t dummy_null_list = {0, NULL, NULL};
assert( p_this );
variable_t *p_var = calloc( 1, sizeof( *p_var ) );
p_var->ops = &time_ops;
p_var->val.i_time = 0;
break;
+ case VLC_VAR_COORDS:
+ p_var->ops = &coords_ops;
+ p_var->val.coords.x = p_var->val.coords.y = 0;
+ break;
case VLC_VAR_ADDRESS:
p_var->ops = &addr_ops;
p_var->val.p_address = NULL;
break;
- case VLC_VAR_MUTEX:
- p_var->ops = &mutex_ops;
- p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
- vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
- break;
- case VLC_VAR_LIST:
- p_var->ops = &list_ops;
- p_var->val.p_list = &dummy_null_list;
+ case VLC_VAR_VOID:
+ p_var->ops = &void_ops;
break;
default:
- p_var->ops = &void_ops;
-#ifndef NDEBUG
- if( (i_type & VLC_VAR_CLASS) != VLC_VAR_VOID )
- msg_Err( p_this, "Creating the variable '%s' without a type",
- psz_name );
-#endif
+ assert (0);
}
- if( i_type & VLC_VAR_DOINHERIT )
+ if( (i_type & VLC_VAR_DOINHERIT)
+ && var_Inherit( p_this, psz_name, i_type, &p_var->val ) == 0 )
{
- if( var_Inherit( p_this, psz_name, i_type, &p_var->val ) )
- msg_Err( p_this, "cannot inherit value for %s", psz_name );
- else if( i_type & VLC_VAR_HASCHOICE )
+ if( i_type & VLC_VAR_HASCHOICE )
{
/* We must add the inherited value to our choice list */
p_var->i_default = 0;
pp_var = tsearch( p_var, &p_priv->var_root, varcmp );
if( unlikely(pp_var == NULL) )
ret = VLC_ENOMEM;
- else if( (p_oldvar = *pp_var) == p_var )
- p_var = NULL;
- else if( unlikely((i_type ^ p_oldvar->i_type) & VLC_VAR_CLASS) )
- { /* If the types differ, variable creation failed. */
- msg_Err( p_this, "Variable '%s' (0x%04x) already exist "
- "but with a different type (0x%04x)",
- psz_name, p_oldvar->i_type, i_type );
- ret = VLC_EBADVAR;
- }
- else
+ else if( (p_oldvar = *pp_var) == p_var ) /* Variable create */
+ p_var = NULL; /* Variable created */
+ else /* Variable already exists */
{
+ assert (((i_type ^ p_oldvar->i_type) & VLC_VAR_CLASS) == 0);
p_oldvar->i_usage++;
p_oldvar->i_type |= i_type & (VLC_VAR_ISCOMMAND|VLC_VAR_HASCHOICE);
}
vlc_object_internals_t *priv = vlc_internals( obj );
tdestroy( priv->var_root, CleanupVar );
+ priv->var_root = NULL;
}
#undef var_Change
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;
+ int ret = VLC_SUCCESS;
variable_t *p_var;
vlc_value_t oldval;
vlc_value_t newval;
break;
case VLC_VAR_GETMIN:
if( p_var->i_type & VLC_VAR_HASMIN )
- {
*p_val = p_var->min;
- }
+ else
+ ret = VLC_EGENERIC;
break;
case VLC_VAR_SETMAX:
if( p_var->i_type & VLC_VAR_HASMAX )
break;
case VLC_VAR_GETMAX:
if( p_var->i_type & VLC_VAR_HASMAX )
- {
*p_val = p_var->max;
- }
+ else
+ ret = VLC_EGENERIC;
break;
case VLC_VAR_SETSTEP:
if( p_var->i_type & VLC_VAR_HASSTEP )
break;
case VLC_VAR_GETSTEP:
if( p_var->i_type & VLC_VAR_HASSTEP )
- {
*p_val = p_var->step;
- }
+ else
+ ret = VLC_EGENERIC;
break;
case VLC_VAR_ADDCHOICE:
- i = p_var->choices.i_count;
+ {
+ int 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:
+ {
+ int i;
+
for( i = 0 ; i < p_var->choices.i_count ; i++ )
- {
if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
- {
break;
- }
- }
if( i == p_var->choices.i_count )
{
}
if( p_var->i_default > i )
- {
p_var->i_default--;
- }
else if( p_var->i_default == i )
- {
p_var->i_default = -1;
- }
p_var->ops->pf_free( &p_var->choices.p_values[i] );
free( p_var->choices_text.p_values[i].psz_string );
CheckValue( p_var, &p_var->val );
break;
+ }
case VLC_VAR_CHOICESCOUNT:
p_val->i_int = p_var->choices.i_count;
break;
case VLC_VAR_CLEARCHOICES:
- for( i = 0 ; i < p_var->choices.i_count ; i++ )
- {
+ for( int i = 0 ; i < p_var->choices.i_count ; i++ )
p_var->ops->pf_free( &p_var->choices.p_values[i] );
- }
- for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
+ for( int 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 );
p_var->i_default = -1;
break;
case VLC_VAR_SETDEFAULT:
+ {
+ int i;
/* FIXME: the list is sorted, dude. Use something cleverer. */
for( i = 0 ; i < p_var->choices.i_count ; i++ )
- {
if( p_var->ops->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
- {
break;
- }
- }
if( i == p_var->choices.i_count )
- {
/* Not found */
break;
- }
p_var->i_default = i;
CheckValue( p_var, &p_var->val );
break;
+ }
case VLC_VAR_SETVALUE:
/* Duplicate data if needed */
newval = *p_val;
}
p_val->p_list->i_count = p_var->choices.i_count;
if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
- for( i = 0 ; i < p_var->choices.i_count ; i++ )
+ for( int i = 0 ; i < p_var->choices.i_count ; i++ )
{
p_val->p_list->p_values[i] = p_var->choices.p_values[i];
p_val->p_list->pi_types[i] = p_var->i_type;
vlc_mutex_unlock( &p_priv->var_lock );
- return VLC_SUCCESS;
+ return ret;
}
#undef var_GetAndSet
assert( expected_type == 0 ||
(p_var->i_type & VLC_VAR_CLASS) == expected_type );
+ assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
WaitUnused( p_this, p_var );
{
assert( expected_type == 0 ||
(p_var->i_type & VLC_VAR_CLASS) == expected_type );
+ assert ((p_var->i_type & VLC_VAR_CLASS) != VLC_VAR_VOID);
/* Really get the variable */
*p_val = p_var->val;
-#ifndef NDEBUG
- /* Alert if the type is VLC_VAR_VOID */
- if( ( p_var->i_type & VLC_VAR_TYPE ) == VLC_VAR_VOID )
- msg_Warn( p_this, "Calling var_GetVoid on the void variable '%s' (0x%04x)", psz_name, p_var->i_type );
-#endif
-
/* Duplicate value if needed */
p_var->ops->pf_dup( p_val );
}
p_var = Lookup( p_this, psz_name );
if( p_var == NULL )
{
-#ifndef NDEBUG
- msg_Warn( p_this, "Failed to add a callback to the non-existing "
- "variable '%s'", psz_name );
-#endif
vlc_mutex_unlock( &p_priv->var_lock );
+ msg_Err( p_this, "cannot add callback %p to nonexistent "
+ "variable '%s'", pf_callback, psz_name );
return VLC_ENOVAR;
}
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 );
-
+ i_type = config_GetType( p_obj, psz_name );
if( !i_type && !psz_value )
{
/* check for "no-foo" or "nofoo" */
( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
/* check if option is unsafe */
- if( !trusted )
+ if( !trusted && !config_IsSafe( psz_name ) )
{
- module_config_t *p_config = config_FindConfig( p_obj, psz_name );
- if( !p_config || !p_config->b_safe )
- {
- msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
- "security reasons", psz_name );
- free( psz_name );
- return;
- }
+ msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
+ "security reasons", psz_name );
+ free( psz_name );
+ return;
}
/* Create the variable in the input object.
break;
case VLC_VAR_INTEGER:
- val.i_int = strtol( psz_value, NULL, 0 );
+ val.i_int = strtoll( psz_value, NULL, 0 );
break;
case VLC_VAR_FLOAT:
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 );
- /* If that's a list, remove all elements allocated */
- if( i_type == VLC_VAR_LIST )
- FreeList( &val );
-
cleanup:
free( psz_name );
}
+#undef var_LocationParse
+/**
+ * Parses a set of colon-separated or semicolon-separated
+ * <variable 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.
+ *
+ * @param obj VLC object on which to set variables (and emit error messages)
+ * @param mrl string to parse
+ * @param pref prefix to prepend to option names in the string
+ *
+ * @return VLC_ENOMEM on error, VLC_SUCCESS on success.
+ */
+int var_LocationParse (vlc_object_t *obj, const char *mrl, const char *pref)
+{
+ int ret = VLC_SUCCESS;
+ size_t preflen = strlen (pref) + 1;
+
+ assert(mrl != NULL);
+ while (*mrl != '\0')
+ {
+ mrl += strspn (mrl, ":;"); /* skip leading colon(s) */
-/* Following functions are local */
+ size_t len = strcspn (mrl, ":;");
+ char *buf = malloc (preflen + len);
+
+ if (likely(buf != NULL))
+ {
+ /* NOTE: this does not support the "no-<varname>" bool syntax. */
+ /* DO NOT use asprintf() here; it won't work! Think again. */
+ snprintf (buf, preflen + len, "%s%s", pref, mrl);
+ var_OptionParse (obj, buf, false);
+ free (buf);
+ }
+ else
+ ret = VLC_ENOMEM;
+ mrl += len;
+ }
+
+ return ret;
+}
/**
* Waits until the variable is inactive (i.e. not executing a callback)
int var_Inherit( vlc_object_t *p_this, const char *psz_name, int i_type,
vlc_value_t *p_val )
{
-#ifndef NDEBUG
- if (p_this != VLC_OBJECT(p_this->p_libvlc)
- && unlikely(p_this->p_parent == NULL))
- {
- msg_Info (p_this, "%s(%s) on detached object", __func__, psz_name);
- //vlc_backtrace ();
- }
-#endif
i_type &= VLC_VAR_CLASS;
for( vlc_object_t *obj = p_this; obj != NULL; obj = obj->p_parent )
{
if( var_GetChecked( obj, psz_name, i_type, p_val ) == VLC_SUCCESS )
return VLC_SUCCESS;
-#ifndef NDEBUG
- if (obj != p_this && obj != VLC_OBJECT(p_this->p_libvlc)
- && unlikely(obj->p_parent == NULL))
- {
- msg_Info (p_this, "%s(%s) on detached tree [%p] %s", __func__,
- psz_name, obj, obj->psz_object_type);
- //vlc_backtrace ();
- }
-#endif
}
/* else take value from config */
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:
- msg_Warn( p_this, "Could not inherit value for var %s "
- "from config. Invalid Type", psz_name );
+ assert(0);
+ case VLC_VAR_ADDRESS:
return VLC_ENOOBJ;
}
- /*msg_Dbg( p_this, "Inherited value for var %s from config", psz_name );*/
return VLC_SUCCESS;
}
+/**
+ * It inherits a string as an unsigned rational number (it also accepts basic
+ * float number).
+ *
+ * It returns an error if the rational number cannot be parsed (0/0 is valid).
+ * The rational is already reduced.
+ */
+int (var_InheritURational)(vlc_object_t *object,
+ unsigned *num, unsigned *den,
+ const char *var)
+{
+ /* */
+ *num = 0;
+ *den = 0;
+
+ /* */
+ char *tmp = var_InheritString(object, var);
+ if (!tmp)
+ goto error;
+
+ char *next;
+ unsigned n = strtol(tmp, &next, 0);
+ unsigned d = strtol(*next ? &next[1] : "0", NULL, 0);
+
+ if (*next == '.') {
+ /* Interpret as a float number */
+ double r = us_atof(tmp);
+ double c = ceil(r);
+ if (c >= UINT_MAX)
+ goto error;
+ unsigned m = c;
+ if (m > 0) {
+ d = UINT_MAX / m;
+ n = r * d;
+ } else {
+ n = 0;
+ d = 0;
+ }
+ } else if ( *next == '\0' ) {
+ /* plain integer given */
+ *num = n;
+ *den = 1;
+ }
+
+ if (n > 0 && d > 0)
+ vlc_ureduce(num, den, n, d, 0);
+
+ free(tmp);
+ return VLC_SUCCESS;
+
+error:
+ free(tmp);
+ return VLC_EGENERIC;
+}
+
/**********************************************************************
* Trigger the callbacks.
* Tell we're in a callback, release the lock, call stored functions,
return VLC_SUCCESS;
}
-#undef var_Command
-/**********************************************************************
- * 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;
- }
-
- 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 &= VLC_VAR_CLASS;
- 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, us_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 )
- {
- 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
projects / vlc / blobdiff