vlc_configuration.h 12.1 KB
Newer Older
Gildas Bazin's avatar
 
Gildas Bazin committed
1 2 3 4 5
/*****************************************************************************
 * configuration.h : configuration management module
 * This file describes the programming interface for the configuration module.
 * It includes functions allowing to declare, get or set configuration options.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
6
 * Copyright (C) 1999-2006 VLC authors and VideoLAN
7
 * $Id$
Gildas Bazin's avatar
 
Gildas Bazin committed
8
 *
9
 * Authors: Gildas Bazin <gbazin@videolan.org>
Gildas Bazin's avatar
 
Gildas Bazin committed
10
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
11 12 13
 * 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
Gildas Bazin's avatar
 
Gildas Bazin committed
14
 * (at your option) any later version.
Clément Stenac's avatar
Clément Stenac committed
15
 *
Gildas Bazin's avatar
 
Gildas Bazin committed
16 17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
Gildas Bazin's avatar
 
Gildas Bazin committed
20
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
21 22 23
 * 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.
Gildas Bazin's avatar
 
Gildas Bazin committed
24 25
 *****************************************************************************/

26 27
#ifndef VLC_CONFIGURATION_H
#define VLC_CONFIGURATION_H 1
28

29 30 31 32 33
/**
 * \file
 * This file describes the programming interface for the configuration module.
 * It includes functions allowing to declare, get or set configuration options.
 */
34

Clément Stenac's avatar
Clément Stenac committed
35 36 37 38
# ifdef __cplusplus
extern "C" {
# endif

Gildas Bazin's avatar
 
Gildas Bazin committed
39 40 41 42
/*****************************************************************************
 * Macros used to build the configuration structure.
 *****************************************************************************/

Gildas Bazin's avatar
 
Gildas Bazin committed
43
/* Configuration hint types */
44 45 46 47
#define CONFIG_HINT_CATEGORY                0x02  /* Start of new category */
#define CONFIG_HINT_SUBCATEGORY             0x03  /* Start of sub-category */
#define CONFIG_HINT_SUBCATEGORY_END         0x04  /* End of sub-category */
#define CONFIG_HINT_USAGE                   0x05  /* Usage information */
Gildas Bazin's avatar
 
Gildas Bazin committed
48

49 50 51
#define CONFIG_CATEGORY                     0x06 /* Set category */
#define CONFIG_SUBCATEGORY                  0x07 /* Set subcategory */
#define CONFIG_SECTION                      0x08 /* Start of new section */
Clément Stenac's avatar
Clément Stenac committed
52

Gildas Bazin's avatar
 
Gildas Bazin committed
53
/* Configuration item types */
54
#define CONFIG_ITEM_FLOAT                   0x20  /* Float option */
55
#define CONFIG_ITEM_INTEGER                 0x40  /* Integer option */
56
#define CONFIG_ITEM_RGB                     0x41  /* RGB color option */
57 58 59 60 61 62 63 64 65 66 67 68
#define CONFIG_ITEM_BOOL                    0x60  /* Bool option */
#define CONFIG_ITEM_STRING                  0x80  /* String option */
#define CONFIG_ITEM_PASSWORD                0x81  /* Password option (*) */
#define CONFIG_ITEM_KEY                     0x82  /* Hot key option */
#define CONFIG_ITEM_MODULE                  0x84  /* Module option */
#define CONFIG_ITEM_MODULE_CAT              0x85  /* Module option */
#define CONFIG_ITEM_MODULE_LIST             0x86  /* Module option */
#define CONFIG_ITEM_MODULE_LIST_CAT         0x87  /* Module option */
#define CONFIG_ITEM_LOADFILE                0x8C  /* Read file option */
#define CONFIG_ITEM_SAVEFILE                0x8D  /* Written file option */
#define CONFIG_ITEM_DIRECTORY               0x8E  /* Directory option */
#define CONFIG_ITEM_FONT                    0x8F  /* Font option */
Gildas Bazin's avatar
 
Gildas Bazin committed
69

70
#define CONFIG_ITEM(x) (((x) & ~0xF) != 0)
Gildas Bazin's avatar
 
Gildas Bazin committed
71

Clément Stenac's avatar
Clément Stenac committed
72 73 74 75 76
/*******************************************************************
 * All predefined categories and subcategories
 *******************************************************************/
#define CAT_INTERFACE 1
   #define SUBCAT_INTERFACE_GENERAL 101
Clément Stenac's avatar
Clément Stenac committed
77 78 79
   #define SUBCAT_INTERFACE_MAIN 102
   #define SUBCAT_INTERFACE_CONTROL 103
   #define SUBCAT_INTERFACE_HOTKEYS 104
Clément Stenac's avatar
Clément Stenac committed
80 81 82 83 84 85 86 87 88 89 90 91 92 93

#define CAT_AUDIO 2
   #define SUBCAT_AUDIO_GENERAL 201
   #define SUBCAT_AUDIO_AOUT 202
   #define SUBCAT_AUDIO_AFILTER 203
   #define SUBCAT_AUDIO_VISUAL 204
   #define SUBCAT_AUDIO_MISC 205

#define CAT_VIDEO 3
   #define SUBCAT_VIDEO_GENERAL 301
   #define SUBCAT_VIDEO_VOUT 302
   #define SUBCAT_VIDEO_VFILTER 303
   #define SUBCAT_VIDEO_TEXT 304
   #define SUBCAT_VIDEO_SUBPIC 305
94
   #define SUBCAT_VIDEO_VFILTER2 306
Clément Stenac's avatar
Clément Stenac committed
95 96

#define CAT_INPUT 4
97 98
   #define SUBCAT_INPUT_GENERAL 401
   #define SUBCAT_INPUT_ACCESS 402
Laurent Aimar's avatar
Laurent Aimar committed
99 100 101 102 103
   #define SUBCAT_INPUT_DEMUX 403
   #define SUBCAT_INPUT_VCODEC 404
   #define SUBCAT_INPUT_ACODEC 405
   #define SUBCAT_INPUT_SCODEC 406
   #define SUBCAT_INPUT_STREAM_FILTER 407
Clément Stenac's avatar
Clément Stenac committed
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124

#define CAT_SOUT 5
   #define SUBCAT_SOUT_GENERAL 501
   #define SUBCAT_SOUT_STREAM 502
   #define SUBCAT_SOUT_MUX 503
   #define SUBCAT_SOUT_ACO 504
   #define SUBCAT_SOUT_PACKETIZER 505
   #define SUBCAT_SOUT_SAP 506
   #define SUBCAT_SOUT_VOD 507

#define CAT_ADVANCED 6
   #define SUBCAT_ADVANCED_CPU 601
   #define SUBCAT_ADVANCED_MISC 602
   #define SUBCAT_ADVANCED_NETWORK 603
   #define SUBCAT_ADVANCED_XML 604

#define CAT_PLAYLIST 7
   #define SUBCAT_PLAYLIST_GENERAL 701
   #define SUBCAT_PLAYLIST_SD 702
   #define SUBCAT_PLAYLIST_EXPORT 703

125 126 127
#define CAT_OSD 8
   #define SUBCAT_OSD_IMPORT 801

Clément Stenac's avatar
Clément Stenac committed
128 129 130
struct config_category_t
{
    int         i_id;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
131 132
    const char *psz_name;
    const char *psz_help;
Clément Stenac's avatar
Clément Stenac committed
133 134
};

135 136
typedef union
{
137
    char       *psz;
138
    int64_t     i;
139 140 141
    float       f;
} module_value_t;

142
struct module_config_t
Gildas Bazin's avatar
 
Gildas Bazin committed
143
{
144 145 146 147
    char        *psz_type;                          /* Configuration subtype */
    char        *psz_name;                                    /* Option name */
    char        *psz_text;      /* Short comment on the configuration option */
    char        *psz_longtext;   /* Long comment on the configuration option */
148 149
    module_value_t value;                                    /* Option value */
    module_value_t orig;
150 151
    module_value_t min;
    module_value_t max;
Gildas Bazin's avatar
 
Gildas Bazin committed
152

153
    /* Values list */
154
    char **      ppsz_list;       /* List of possible values for the option */
Antoine Cellerier's avatar
Antoine Cellerier committed
155
    int         *pi_list;                              /* Idem for integers */
156
    char       **ppsz_list_text;          /* Friendly names for list values */
Antoine Cellerier's avatar
Antoine Cellerier committed
157
    int          i_list;                               /* Options list size */
158 159 160 161 162 163 164 165 166 167
    vlc_callback_t pf_update_list; /* Callback to initialize dropdown lists */
    uint8_t      i_type;                              /* Configuration type */
    char         i_short;                     /* Optional short option name */

    /* Misc */
    unsigned    b_dirty:1;        /* Dirty flag to indicate a config change */
    unsigned    b_advanced:1;        /* Flag to indicate an advanced option */
    unsigned    b_internal:1; /* Flag to indicate option is not to be shown */
    unsigned    b_unsaveable:1;               /* Config should not be saved */
    unsigned    b_safe:1;       /* Safe to use in web plugins and playlists */
Gildas Bazin's avatar
 
Gildas Bazin committed
168

169
    /* Actions list */
170
    int            i_action;                           /* actions list size */
171
    vlc_callback_t *ppf_action;    /* List of possible actions for a config */
172
    char          **ppsz_action_text;         /* Friendly names for actions */
173 174 175

    /* Deprecated */
    bool        b_removed;
176
};
Gildas Bazin's avatar
 
Gildas Bazin committed
177 178 179 180 181

/*****************************************************************************
 * Prototypes - these methods are used to get, set or manipulate configuration
 * data.
 *****************************************************************************/
182 183
VLC_API int config_GetType(vlc_object_t *, const char *) VLC_USED;
VLC_API int64_t config_GetInt(vlc_object_t *, const char *) VLC_USED;
184
VLC_API void config_PutInt(vlc_object_t *, const char *, int64_t);
185
VLC_API float config_GetFloat(vlc_object_t *, const char *) VLC_USED;
186
VLC_API void config_PutFloat(vlc_object_t *, const char *, float);
187
VLC_API char * config_GetPsz(vlc_object_t *, const char *) VLC_USED VLC_MALLOC;
188 189 190
VLC_API void config_PutPsz(vlc_object_t *, const char *, const char *);

VLC_API int config_SaveConfigFile( vlc_object_t * );
191 192
#define config_SaveConfigFile(a) config_SaveConfigFile(VLC_OBJECT(a))

193
VLC_API void config_ResetAll( vlc_object_t * );
194
#define config_ResetAll(a) config_ResetAll(VLC_OBJECT(a))
Gildas Bazin's avatar
 
Gildas Bazin committed
195

196 197
VLC_API module_config_t * config_FindConfig( vlc_object_t *, const char * ) VLC_USED;
VLC_API char * config_GetDataDir( vlc_object_t * ) VLC_USED VLC_MALLOC;
198
#define config_GetDataDir(a) config_GetDataDir(VLC_OBJECT(a))
199 200
VLC_API const char * config_GetLibDir( void ) VLC_USED;
VLC_API const char * config_GetConfDir( void ) VLC_USED;
201

202 203 204 205 206
typedef enum vlc_userdir
{
    VLC_HOME_DIR, /* User's home */
    VLC_CONFIG_DIR, /* VLC-specific configuration directory */
    VLC_DATA_DIR, /* VLC-specific data directory */
207
    VLC_CACHE_DIR, /* VLC-specific user cached data directory */
208
    /* Generic directories (same as XDG) */
209
    VLC_DESKTOP_DIR=0x80,
210 211 212 213 214 215 216
    VLC_DOWNLOAD_DIR,
    VLC_TEMPLATES_DIR,
    VLC_PUBLICSHARE_DIR,
    VLC_DOCUMENTS_DIR,
    VLC_MUSIC_DIR,
    VLC_PICTURES_DIR,
    VLC_VIDEOS_DIR,
217 218
} vlc_userdir_t;

219
VLC_API char * config_GetUserDir( vlc_userdir_t ) VLC_USED VLC_MALLOC;
Clément Stenac's avatar
Clément Stenac committed
220

221 222
VLC_API void config_AddIntf( vlc_object_t *, const char * );
VLC_API void config_RemoveIntf( vlc_object_t *, const char * );
223
VLC_API bool config_ExistIntf( vlc_object_t *, const char * ) VLC_USED;
224

225 226 227 228 229 230 231
#define config_GetType(a,b) config_GetType(VLC_OBJECT(a),b)
#define config_GetInt(a,b) config_GetInt(VLC_OBJECT(a),b)
#define config_PutInt(a,b,c) config_PutInt(VLC_OBJECT(a),b,c)
#define config_GetFloat(a,b) config_GetFloat(VLC_OBJECT(a),b)
#define config_PutFloat(a,b,c) config_PutFloat(VLC_OBJECT(a),b,c)
#define config_GetPsz(a,b) config_GetPsz(VLC_OBJECT(a),b)
#define config_PutPsz(a,b,c) config_PutPsz(VLC_OBJECT(a),b,c)
Gildas Bazin's avatar
 
Gildas Bazin committed
232

233 234 235
#define config_AddIntf(a,b) config_AddIntf(VLC_OBJECT(a),b)
#define config_RemoveIntf(a,b) config_RemoveIntf(VLC_OBJECT(a),b)
#define config_ExistIntf(a,b) config_ExistIntf(VLC_OBJECT(a),b)
236

237 238 239 240 241
/****************************************************************************
 * config_chain_t:
 ****************************************************************************/
struct config_chain_t
{
242
    config_chain_t *p_next;     /**< Pointer on the next config_chain_t element */
243

244 245
    char        *psz_name;      /**< Option name */
    char        *psz_value;     /**< Option value */
246 247
};

248 249 250 251 252 253 254
/**
 * This function will
 * - create all options in the array ppsz_options (var_Create).
 * - parse the given linked list of config_chain_t and set the value (var_Set).
 *
 * The option names will be created by adding the psz_prefix prefix.
 */
255
VLC_API void config_ChainParse( vlc_object_t *, const char *psz_prefix, const char *const *ppsz_options, config_chain_t * );
256
#define config_ChainParse( a, b, c, d ) config_ChainParse( VLC_OBJECT(a), b, c, d )
257 258 259 260 261 262 263 264 265 266 267 268

/**
 * This function will parse a configuration string (psz_string) and
 * - set the module name (*ppsz_name)
 * - set all options for this module in a chained list (*pp_cfg)
 * - returns a pointer on the next module if any.
 *
 * The string format is
 *   module{option=*,option=*}[:modulenext{option=*,...}]
 *
 * The options values are unescaped using config_StringUnescape.
 */
269
VLC_API char *config_ChainCreate( char **ppsz_name, config_chain_t **pp_cfg, const char *psz_string ) VLC_USED VLC_MALLOC;
270 271 272 273 274

/**
 * This function will release a linked list of config_chain_t
 * (Including the head)
 */
275
VLC_API void config_ChainDestroy( config_chain_t * );
276

277 278 279
/**
 * This function will duplicate a linked list of config_chain_t
 */
280
VLC_API config_chain_t * config_ChainDuplicate( const config_chain_t * ) VLC_USED VLC_MALLOC;
281

282 283 284 285 286 287 288 289 290
/**
 * This function will unescape a string in place and will return a pointer on
 * the given string.
 * No memory is allocated by it (unlike config_StringEscape).
 * If NULL is given as parameter nothing will be done (NULL will be returned).
 *
 * The following sequences will be unescaped (only one time):
 * \\ \' and \"
 */
291
VLC_API char * config_StringUnescape( char *psz_string );
292 293 294 295 296 297 298 299 300 301

/**
 * This function will escape a string that can be unescaped by
 * config_StringUnescape.
 * The returned value is allocated by it. You have to free it once you
 * do not need it anymore (unlike config_StringUnescape).
 * If NULL is given as parameter nothing will be done (NULL will be returned).
 *
 * The escaped characters are ' " and \
 */
302
VLC_API char * config_StringEscape( const char *psz_string ) VLC_USED VLC_MALLOC;
303

Clément Stenac's avatar
Clément Stenac committed
304 305 306
# ifdef __cplusplus
}
# endif
307 308

#endif /* _VLC_CONFIGURATION_H */