2 * This file is part of MPlayer.
4 * MPlayer is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * MPlayer is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef MPLAYER_M_OPTION_H
20 #define MPLAYER_M_OPTION_H
28 // m_option allows to parse, print and copy data of various types.
30 typedef struct m_option_type m_option_type_t
;
31 typedef struct m_option m_option_t
;
34 ///////////////////////////// Options types declarations ////////////////////
37 extern const m_option_type_t m_option_type_flag
;
38 extern const m_option_type_t m_option_type_int
;
39 extern const m_option_type_t m_option_type_int64
;
40 extern const m_option_type_t m_option_type_intpair
;
41 extern const m_option_type_t m_option_type_float
;
42 extern const m_option_type_t m_option_type_double
;
43 extern const m_option_type_t m_option_type_string
;
44 extern const m_option_type_t m_option_type_string_list
;
45 extern const m_option_type_t m_option_type_position
;
46 extern const m_option_type_t m_option_type_time
;
47 extern const m_option_type_t m_option_type_time_size
;
48 extern const m_option_type_t m_option_type_choice
;
50 extern const m_option_type_t m_option_type_print
;
51 extern const m_option_type_t m_option_type_print_indirect
;
52 extern const m_option_type_t m_option_type_print_func
;
53 extern const m_option_type_t m_option_type_subconfig
;
54 extern const m_option_type_t m_option_type_imgfmt
;
55 extern const m_option_type_t m_option_type_afmt
;
58 extern const m_option_type_t m_option_type_func_param
;
59 extern const m_option_type_t m_option_type_func
;
61 // Callback used to reset func options.
62 typedef void (*m_opt_default_func_t
)(const m_option_t
*, const char *);
64 // Callback used by m_option_type_func_full options.
65 typedef int (*m_opt_func_full_t
)(const m_option_t
*, const char *, const char *);
67 // Callback used by m_option_type_func_param options.
68 typedef int (*m_opt_func_param_t
)(const m_option_t
*, const char *);
70 // Callback used by m_option_type_func options.
71 typedef int (*m_opt_func_t
)(const m_option_t
*);
73 // Backwards compatibility
74 typedef m_opt_default_func_t cfg_default_func_t
;
75 typedef m_opt_func_full_t cfg_func_arg_param_t
;
76 typedef m_opt_func_param_t cfg_func_param_t
;
77 typedef m_opt_func_t cfg_func_t
;
87 // Extra definition needed for \ref m_option_type_obj_settings_list options.
89 // Pointer to an array of pointer to some object type description struct.
91 // Offset of the object type name (char*) in the description struct.
93 // Offset of the object type info string (char*) in the description struct.
95 // Offset of the object type parameter description (\ref m_struct_st)
96 // in the description struct.
100 // The data type used by \ref m_option_type_obj_settings_list.
101 typedef struct m_obj_settings
{
102 // Type of the object.
104 // NULL terminated array of parameter/value pairs.
108 // A parser to set up a list of objects.
109 /** It creates a NULL terminated array \ref m_obj_settings. The option priv
110 * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing
111 * the available object types.
113 extern const m_option_type_t m_option_type_obj_settings_list
;
115 // Extra definition needed for \ref m_option_type_obj_presets options.
117 // Description of the struct holding the presets.
118 const struct m_struct_st
*in_desc
;
119 // Description of the struct that should be set by the presets.
120 const struct m_struct_st
*out_desc
;
121 // Pointer to an array of structs defining the various presets.
123 // Offset of the preset's name inside the in_struct.
127 // Set several fields in a struct at once.
128 /** For this two struct descriptions are used. One for the struct holding the
129 * preset and one for the struct beeing set. Every field present in both
130 * structs will be copied from the preset struct to the destination one.
131 * The option priv field (\ref m_option::priv) must point to a correctly
132 * filled \ref m_obj_presets_t.
134 extern const m_option_type_t m_option_type_obj_presets
;
136 // Parse an URL into a struct.
137 /** The option priv field (\ref m_option::priv) must point to a
138 * \ref m_struct_st describing which fields of the URL must be used.
140 extern const m_option_type_t m_option_type_custom_url
;
142 // Extra definition needed for \ref m_option_type_obj_params options.
144 // Field descriptions.
145 const struct m_struct_st
*desc
;
146 // Field separator to use.
150 // Parse a set of parameters.
151 /** Parameters are separated by the given separator and each one
152 * successively sets a field from the struct. The option priv field
153 * (\ref m_option::priv) must point to a \ref m_obj_params_t.
155 extern const m_option_type_t m_option_type_obj_params
;
161 // Ready made settings to parse a \ref m_span_t with a start-end syntax.
162 extern const m_obj_params_t m_span_params_def
;
164 struct m_opt_choice_alternatives
{
170 // FIXME: backward compatibility
171 #define CONF_TYPE_FLAG (&m_option_type_flag)
172 #define CONF_TYPE_INT (&m_option_type_int)
173 #define CONF_TYPE_INT64 (&m_option_type_int64)
174 #define CONF_TYPE_FLOAT (&m_option_type_float)
175 #define CONF_TYPE_DOUBLE (&m_option_type_double)
176 #define CONF_TYPE_STRING (&m_option_type_string)
177 #define CONF_TYPE_FUNC (&m_option_type_func)
178 #define CONF_TYPE_FUNC_PARAM (&m_option_type_func_param)
179 #define CONF_TYPE_PRINT (&m_option_type_print)
180 #define CONF_TYPE_PRINT_INDIRECT (&m_option_type_print_indirect)
181 #define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func)
182 #define CONF_TYPE_SUBCONFIG (&m_option_type_subconfig)
183 #define CONF_TYPE_STRING_LIST (&m_option_type_string_list)
184 #define CONF_TYPE_POSITION (&m_option_type_position)
185 #define CONF_TYPE_IMGFMT (&m_option_type_imgfmt)
186 #define CONF_TYPE_AFMT (&m_option_type_afmt)
187 #define CONF_TYPE_SPAN (&m_option_type_span)
188 #define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list)
189 #define CONF_TYPE_OBJ_PRESETS (&m_option_type_obj_presets)
190 #define CONF_TYPE_CUSTOM_URL (&m_option_type_custom_url)
191 #define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params)
192 #define CONF_TYPE_TIME (&m_option_type_time)
193 #define CONF_TYPE_TIME_SIZE (&m_option_type_time_size)
195 ////////////////////////////////////////////////////////////////////////////
197 // Option type description
198 struct m_option_type
{
200 // Syntax description, etc
201 const char *comments
;
202 // Size needed for the data.
204 // See \ref OptionTypeFlags.
207 // Parse the data from a string.
208 /** It is the only required function, all others can be NULL.
210 * \param opt The option that is parsed.
211 * \param name The full option name.
212 * \param param The parameter to parse.
213 * \param ambiguous_param: "param" old cmdline style, "param" may or
214 * may not be an argument meant for this option
215 * \param dst Pointer to the memory where the data should be written.
216 * If NULL the parameter validity should still be checked.
217 * \return On error a negative value is returned, on success the number
218 * of arguments consumed. For details see \ref OptionParserReturn.
220 int (*parse
)(const m_option_t
*opt
, const char *name
, const char *param
,
221 bool ambiguous_param
, void *dst
);
223 // Print back a value in string form.
224 /** \param opt The option to print.
225 * \param val Pointer to the memory holding the data to be printed.
226 * \return An allocated string containing the text value or (void*)-1
229 char *(*print
)(const m_option_t
*opt
, const void *val
);
232 * These functions are called to save/set/restore the status of the
233 * variables. The difference between the 3 only matters for types like
234 * \ref m_option_type_func where 'setting' needs to do more than just
239 // Update a save slot (dst) from the current value in the program (src).
240 /** \param opt The option to copy.
241 * \param dst Pointer to the destination memory.
242 * \param src Pointer to the source memory.
244 void (*save
)(const m_option_t
*opt
, void *dst
, const void *src
);
246 // Set the value in the program (dst) from a save slot.
247 /** \param opt The option to copy.
248 * \param dst Pointer to the destination memory.
249 * \param src Pointer to the source memory.
251 void (*set
)(const m_option_t
*opt
, void *dst
, const void *src
);
253 // Copy the data between two save slots. If NULL and size is > 0 a memcpy will be used.
254 /** \param opt The option to copy.
255 * \param dst Pointer to the destination memory.
256 * \param src Pointer to the source memory.
258 void (*copy
)(const m_option_t
*opt
, void *dst
, const void *src
);
261 // Free the data allocated for a save slot.
262 /** This is only needed for dynamic types like strings.
263 * \param dst Pointer to the data, usually a pointer that should be freed and
266 void (*free
)(void *dst
);
269 // Option description
274 // Reserved for higher level APIs, it shouldn't be used by parsers.
275 /** The suboption parser and func types do use it. They should instead
276 * use the priv field but this was inherited from older versions of the
282 const m_option_type_t
*type
;
284 // See \ref OptionFlags.
287 // \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must
291 // \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must
295 // Type dependent data (for all kinds of extended settings).
296 /** This used to be a function pointer to hold a 'reverse to defaults' func.
297 * Now it can be used to pass any type of extra args needed by the parser.
298 * Passing a 'default func' is still valid for all func based option types.
308 // The option has a minimum set in \ref m_option::min.
309 #define M_OPT_MIN (1 << 0)
311 // The option has a maximum set in \ref m_option::max.
312 #define M_OPT_MAX (1 << 1)
314 // The option has a minimum and maximum in m_option::min and m_option::max.
315 #define M_OPT_RANGE (M_OPT_MIN | M_OPT_MAX)
317 // The option is forbidden in config files.
318 #define M_OPT_NOCFG (1 << 2)
320 // The option is forbidden on the command line.
321 #define M_OPT_NOCMD (1 << 3)
323 // The option is global in the \ref Config.
324 /** It won't be saved on push and the command line parser will set it when
325 * it's parsed (i.e. it won't be set later)
326 * e.g options : -v, -quiet
328 #define M_OPT_GLOBAL (1 << 4)
330 // The \ref Config won't save this option on push.
331 /** It won't be saved on push but the command line parser will add it with
332 * its entry (i.e. it may be set later)
333 * e.g options : -include
335 #define M_OPT_NOSAVE (1 << 5)
337 // The option should be set during command line pre-parsing
338 #define M_OPT_PRE_PARSE (1 << 6)
340 // These are kept for compatibility with older code.
341 #define CONF_MIN M_OPT_MIN
342 #define CONF_MAX M_OPT_MAX
343 #define CONF_RANGE M_OPT_RANGE
344 #define CONF_NOCFG M_OPT_NOCFG
345 #define CONF_NOCMD M_OPT_NOCMD
346 #define CONF_GLOBAL M_OPT_GLOBAL
347 #define CONF_NOSAVE M_OPT_NOSAVE
348 #define CONF_PRE_PARSE M_OPT_PRE_PARSE
350 // These flags are used to describe special parser capabilities or behavior.
352 // Suboption parser flag.
353 /** When this flag is set, m_option::p should point to another m_option
354 * array. Only the parse function will be called. If dst is set, it should
355 * create/update an array of char* containg opt/val pairs. The options in
356 * the child array will then be set automatically by the \ref Config.
357 * Also note that suboptions may be directly accessed by using
358 * -option:subopt blah.
360 #define M_OPT_TYPE_HAS_CHILD (1 << 0)
362 // Wildcard matching flag.
363 /** If set the option type has a use for option names ending with a *
364 * (used for -aa*), this only affects the option name matching.
366 #define M_OPT_TYPE_ALLOW_WILDCARD (1 << 1)
368 // Dynamic data type.
369 /** This flag indicates that the data is dynamically allocated (m_option::p
370 * points to a pointer). It enables a little hack in the \ref Config wich
371 * replaces the initial value of such variables with a dynamic copy in case
372 * the initial value is statically allocated (pretty common with strings).
374 #define M_OPT_TYPE_DYNAMIC (1 << 2)
376 // Indirect option type.
377 /** If this is set the parse function doesn't directly return
378 * the wanted thing. Options use this if for some reasons they have to wait
379 * until the set call to be able to correctly set the target var.
380 * So for those types new values must first be parsed, then set to the target
381 * var. If this flag isn't set then new values can be parsed directly to the
382 * target var. It's used by the callback-based options as the callback call
383 * may append later on.
385 #define M_OPT_TYPE_INDIRECT (1 << 3)
387 ///////////////////////////// Parser flags /////////////////////////////////
389 // On success parsers return the number of arguments consumed: 0 or 1.
391 // To indicate that MPlayer should exit without playing anything,
392 // parsers return M_OPT_EXIT minus the number of parameters they
393 // consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1.
395 // On error one of the following (negative) error codes is returned:
397 // For use by higher level APIs when the option name is invalid.
398 #define M_OPT_UNKNOWN -1
400 // Returned when a parameter is needed but wasn't provided.
401 #define M_OPT_MISSING_PARAM -2
403 // Returned when the given parameter couldn't be parsed.
404 #define M_OPT_INVALID -3
406 // Returned if the value is "out of range". The exact meaning may
407 // vary from type to type.
408 #define M_OPT_OUT_OF_RANGE -4
410 // Returned if the parser failed for any other reason than a bad parameter.
411 #define M_OPT_PARSER_ERR -5
413 // Returned when MPlayer should exit. Used by various help stuff.
414 /** M_OPT_EXIT must be the lowest number on this list.
416 #define M_OPT_EXIT -6
418 // These are kept for compatibility with older code.
420 #define ERR_NOT_AN_OPTION M_OPT_UNKNOWN
421 #define ERR_MISSING_PARAM M_OPT_MISSING_PARAM
422 #define ERR_OUT_OF_RANGE M_OPT_OUT_OF_RANGE
423 #define ERR_FUNC_ERR M_OPT_PARSER_ERR
425 // Find the option matching the given name in the list.
427 * This function takes the possible wildcards into account (see
428 * \ref M_OPT_TYPE_ALLOW_WILDCARD).
430 * \param list Pointer to an array of \ref m_option.
431 * \param name Name of the option.
432 * \return The matching option or NULL.
434 const m_option_t
*m_option_list_find(const m_option_t
*list
, const char *name
);
436 static inline void *m_option_get_ptr(const struct m_option
*opt
,
439 return opt
->new ? (char *) optstruct
+ opt
->offset
: opt
->p
;
442 // Helper to parse options, see \ref m_option_type::parse.
443 static inline int m_option_parse(const m_option_t
*opt
, const char *name
,
444 const char *param
, bool ambiguous_param
,
447 return opt
->type
->parse(opt
, name
, param
, ambiguous_param
, dst
);
450 // Helper to print options, see \ref m_option_type::print.
451 static inline char *m_option_print(const m_option_t
*opt
, const void *val_ptr
)
453 if (opt
->type
->print
)
454 return opt
->type
->print(opt
, val_ptr
);
459 // Helper around \ref m_option_type::copy.
460 static inline void m_option_copy(const m_option_t
*opt
, void *dst
,
464 opt
->type
->copy(opt
, dst
, src
);
465 else if (opt
->type
->size
> 0)
466 memcpy(dst
, src
, opt
->type
->size
);
469 // Helper around \ref m_option_type::free.
470 static inline void m_option_free(const m_option_t
*opt
, void *dst
)
473 opt
->type
->free(dst
);
479 * Parse a string as a timestamp.
481 * @param[in] str the string to parse.
482 * @param[out] time parsed time.
483 * @param[in] endchar return an error of the next character after the
484 * timestamp is neither nul nor endchar.
485 * @return Number of chars in the timestamp.
487 int parse_timestring(const char *str
, double *time
, char endchar
);
489 #define OPTION_LIST_SEPARATOR ','
492 #define OPTION_PATH_SEPARATOR ';'
494 #define OPTION_PATH_SEPARATOR ':'
497 #define OPT_FLAG_ON(optname, varname, flags) {optname, NULL, &m_option_type_flag, flags, 0, 1, NULL, 1, offsetof(struct MPOpts, varname)}
498 #define OPT_FLAG_OFF(optname, varname, flags) {optname, NULL, &m_option_type_flag, flags, 1, 0, NULL, 1, offsetof(struct MPOpts, varname)}
499 #define OPT_MAKE_FLAGS(optname, varname, flags) OPT_FLAG_ON(optname, varname, flags), OPT_FLAG_OFF("no" optname, varname, flags)
500 #define OPT_FLAG_CONSTANTS(optname, varname, flags, offvalue, value) {optname, NULL, &m_option_type_flag, flags, offvalue, value, NULL, 1, offsetof(struct MPOpts, varname)}
501 #define OPT_STRINGLIST(optname, varname, flags) {optname, NULL, &m_option_type_string_list, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
502 #define OPT_PATHLIST(optname, varname, flags) {optname, NULL, &m_option_type_string_list, flags, 0, 0, (void *)&(const char){OPTION_PATH_SEPARATOR}, 1, offsetof(struct MPOpts, varname)}
503 #define OPT_INT(optname, varname, flags) {optname, NULL, &m_option_type_int, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
504 #define OPT_INTRANGE(optname, varname, flags, min, max) {optname, NULL, &m_option_type_int, (flags) | CONF_RANGE, min, max, NULL, 1, offsetof(struct MPOpts, varname)}
505 #define OPT_INTPAIR(optname, varname, flags) {optname, NULL, &m_option_type_intpair, (flags), 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
506 #define OPT_FLOATRANGE(optname, varname, flags, min, max) {optname, NULL, &m_option_type_float, (flags) | CONF_RANGE, min, max, NULL, 1, offsetof(struct MPOpts, varname)}
507 #define OPT_STRING(optname, varname, flags) {optname, NULL, &m_option_type_string, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
508 #define OPT_SETTINGSLIST(optname, varname, flags, objlist) {optname, NULL, &m_option_type_obj_settings_list, flags, 0, 0, objlist, 1, offsetof(struct MPOpts, varname)}
509 #define OPT_AUDIOFORMAT(optname, varname, flags) {optname, NULL, &m_option_type_afmt, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
510 #define OPT_HELPER_REMOVEPAREN(...) __VA_ARGS__
511 #define OPT_CHOICE(optname, varname, flags, choices) {optname, NULL, &m_option_type_choice, flags, 0, 0, (void *)&(const struct m_opt_choice_alternatives[]){OPT_HELPER_REMOVEPAREN choices, {NULL}}, 1, offsetof(struct MPOpts, varname)}
513 #endif /* MPLAYER_M_OPTION_H */