1 /*****************************************************************************
2 * variables.h: object variables typedefs
3 *****************************************************************************
4 * Copyright (C) 1999-2012 VLC authors and VideoLAN
6 * Authors: Samuel Hocevar <sam@zoy.org>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU Lesser General Public License as published by
10 * the Free Software Foundation; either version 2.1 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public License
19 * along with this program; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
21 *****************************************************************************/
23 #ifndef LIBVLC_VARIABLES_H
24 # define LIBVLC_VARIABLES_H 1
26 # include <vlc_atomic.h>
29 * Private LibVLC data for each object.
31 typedef struct vlc_object_internals vlc_object_internals_t;
33 struct vlc_object_internals
35 char *psz_name; /* given name */
37 /* Object variables */
42 /* Objects thread synchronization */
46 /* Objects management */
48 vlc_destructor_t pf_destructor;
50 /* Objects tree structure */
51 vlc_object_internals_t *next; /* next sibling */
52 vlc_object_internals_t *prev; /* previous sibling */
53 vlc_object_internals_t *first; /* first child */
56 # define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
57 # define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
60 typedef struct callback_entry_t callback_entry_t;
62 typedef struct variable_ops_t
64 int (*pf_cmp) ( vlc_value_t, vlc_value_t );
65 void (*pf_dup) ( vlc_value_t * );
66 void (*pf_free) ( vlc_value_t * );
70 * The structure describing a variable.
71 * \note vlc_value_t is the common union for variable values
75 char * psz_name; /**< The variable unique name (must be first) */
77 /** The variable's exported value */
80 /** The variable display name, mainly for use by the interfaces */
83 const variable_ops_t *ops;
85 int i_type; /**< The type of the variable */
86 unsigned i_usage; /**< Reference count */
88 /** If the variable has min/max/step values */
89 vlc_value_t min, max, step;
91 /** Index of the default choice, if the variable is to be chosen in
94 /** List of choices */
96 /** List of friendly names for the choices */
97 vlc_list_t choices_text;
99 /** Set to TRUE if the variable is in a callback */
102 /** Number of registered callbacks */
104 /** Array of registered callbacks */
105 callback_entry_t * p_entries;
108 extern void var_DestroyAll( vlc_object_t * );