summaryrefslogtreecommitdiffstats
path: root/m_option.h
diff options
context:
space:
mode:
authorwm4 <wm4@nowhere>2012-11-05 17:02:04 +0100
committerwm4 <wm4@nowhere>2012-11-12 20:06:14 +0100
commitd4bdd0473d6f43132257c9fb3848d829755167a3 (patch)
tree8021c2f7da1841393c8c832105e20cd527826d6c /m_option.h
parentbd48deba77bd5582c5829d6fe73a7d2571088aba (diff)
downloadmpv-d4bdd0473d6f43132257c9fb3848d829755167a3.tar.bz2
mpv-d4bdd0473d6f43132257c9fb3848d829755167a3.tar.xz
Rename directories, move files (step 1 of 2) (does not compile)
Tis drops the silly lib prefixes, and attempts to organize the tree in a more logical way. Make the top-level directory less cluttered as well. Renames the following directories: libaf -> audio/filter libao2 -> audio/out libvo -> video/out libmpdemux -> demux Split libmpcodecs: vf* -> video/filter vd*, dec_video.* -> video/decode mp_image*, img_format*, ... -> video/ ad*, dec_audio.* -> audio/decode libaf/format.* is moved to audio/ - this is similar to how mp_image.* is located in video/. Move most top-level .c/.h files to core. (talloc.c/.h is left on top- level, because it's external.) Park some of the more annoying files in compat/. Some of these are relicts from the time mplayer used ffmpeg internals. sub/ is not split, because it's too much of a mess (subtitle code is mixed with OSD display and rendering). Maybe the organization of core is not ideal: it mixes playback core (like mplayer.c) and utility helpers (like bstr.c/h). Should the need arise, the playback core will be moved somewhere else, while core contains all helper and common code.
Diffstat (limited to 'm_option.h')
-rw-r--r--m_option.h519
1 files changed, 0 insertions, 519 deletions
diff --git a/m_option.h b/m_option.h
deleted file mode 100644
index 75f1c709d1..0000000000
--- a/m_option.h
+++ /dev/null
@@ -1,519 +0,0 @@
-/*
- * This file is part of MPlayer.
- *
- * MPlayer 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
- * (at your option) any later version.
- *
- * MPlayer 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.
- *
- * You should have received a copy of the GNU General Public License along
- * with MPlayer; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
- */
-
-#ifndef MPLAYER_M_OPTION_H
-#define MPLAYER_M_OPTION_H
-
-#include <string.h>
-#include <stddef.h>
-#include <stdbool.h>
-
-#include "config.h"
-#include "bstr.h"
-
-// m_option allows to parse, print and copy data of various types.
-
-typedef struct m_option_type m_option_type_t;
-typedef struct m_option m_option_t;
-struct m_struct_st;
-
-///////////////////////////// Options types declarations ////////////////////
-
-// Simple types
-extern const m_option_type_t m_option_type_flag;
-extern const m_option_type_t m_option_type_int;
-extern const m_option_type_t m_option_type_int64;
-extern const m_option_type_t m_option_type_intpair;
-extern const m_option_type_t m_option_type_float;
-extern const m_option_type_t m_option_type_double;
-extern const m_option_type_t m_option_type_string;
-extern const m_option_type_t m_option_type_string_list;
-extern const m_option_type_t m_option_type_time;
-extern const m_option_type_t m_option_type_time_size;
-extern const m_option_type_t m_option_type_choice;
-
-extern const m_option_type_t m_option_type_print;
-extern const m_option_type_t m_option_type_print_func;
-extern const m_option_type_t m_option_type_print_func_param;
-extern const m_option_type_t m_option_type_subconfig;
-extern const m_option_type_t m_option_type_subconfig_struct;
-extern const m_option_type_t m_option_type_imgfmt;
-extern const m_option_type_t m_option_type_afmt;
-
-// Callback used by m_option_type_print_func options.
-typedef int (*m_opt_func_full_t)(const m_option_t *, const char *, const char *);
-
-#define END_AT_NONE 0
-#define END_AT_TIME 1
-#define END_AT_SIZE 2
-typedef struct {
- double pos;
- int type;
-} m_time_size_t;
-
-// Extra definition needed for \ref m_option_type_obj_settings_list options.
-typedef struct {
- // Pointer to an array of pointer to some object type description struct.
- void **list;
- // Offset of the object type name (char*) in the description struct.
- void *name_off;
- // Offset of the object type info string (char*) in the description struct.
- void *info_off;
- // Offset of the object type parameter description (\ref m_struct_st)
- // in the description struct.
- void *desc_off;
-} m_obj_list_t;
-
-// The data type used by \ref m_option_type_obj_settings_list.
-typedef struct m_obj_settings {
- // Type of the object.
- char *name;
- // NULL terminated array of parameter/value pairs.
- char **attribs;
-} m_obj_settings_t;
-
-// A parser to set up a list of objects.
-/** It creates a NULL terminated array \ref m_obj_settings. The option priv
- * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing
- * the available object types.
- */
-extern const m_option_type_t m_option_type_obj_settings_list;
-
-// Extra definition needed for \ref m_option_type_obj_presets options.
-typedef struct {
- // Description of the struct holding the presets.
- const struct m_struct_st *in_desc;
- // Description of the struct that should be set by the presets.
- const struct m_struct_st *out_desc;
- // Pointer to an array of structs defining the various presets.
- const void *presets;
- // Offset of the preset's name inside the in_struct.
- void *name_off;
-} m_obj_presets_t;
-
-// Set several fields in a struct at once.
-/** For this two struct descriptions are used. One for the struct holding the
- * preset and one for the struct beeing set. Every field present in both
- * structs will be copied from the preset struct to the destination one.
- * The option priv field (\ref m_option::priv) must point to a correctly
- * filled \ref m_obj_presets_t.
- */
-extern const m_option_type_t m_option_type_obj_presets;
-
-// Parse an URL into a struct.
-/** The option priv field (\ref m_option::priv) must point to a
- * \ref m_struct_st describing which fields of the URL must be used.
- */
-extern const m_option_type_t m_option_type_custom_url;
-
-// Extra definition needed for \ref m_option_type_obj_params options.
-typedef struct {
- // Field descriptions.
- const struct m_struct_st *desc;
- // Field separator to use.
- char separator;
-} m_obj_params_t;
-
-// Parse a set of parameters.
-/** Parameters are separated by the given separator and each one
- * successively sets a field from the struct. The option priv field
- * (\ref m_option::priv) must point to a \ref m_obj_params_t.
- */
-extern const m_option_type_t m_option_type_obj_params;
-
-typedef struct {
- int start;
- int end;
-} m_span_t;
-// Ready made settings to parse a \ref m_span_t with a start-end syntax.
-extern const m_obj_params_t m_span_params_def;
-
-struct m_opt_choice_alternatives {
- char *name;
- int value;
-};
-
-// m_option.priv points to this if M_OPT_TYPE_USE_SUBSTRUCT is used
-struct m_sub_options {
- const struct m_option *opts;
- size_t size;
- const void *defaults;
-};
-
-// FIXME: backward compatibility
-#define CONF_TYPE_FLAG (&m_option_type_flag)
-#define CONF_TYPE_INT (&m_option_type_int)
-#define CONF_TYPE_INT64 (&m_option_type_int64)
-#define CONF_TYPE_FLOAT (&m_option_type_float)
-#define CONF_TYPE_DOUBLE (&m_option_type_double)
-#define CONF_TYPE_STRING (&m_option_type_string)
-#define CONF_TYPE_PRINT (&m_option_type_print)
-#define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func)
-#define CONF_TYPE_SUBCONFIG (&m_option_type_subconfig)
-#define CONF_TYPE_STRING_LIST (&m_option_type_string_list)
-#define CONF_TYPE_IMGFMT (&m_option_type_imgfmt)
-#define CONF_TYPE_AFMT (&m_option_type_afmt)
-#define CONF_TYPE_SPAN (&m_option_type_span)
-#define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list)
-#define CONF_TYPE_OBJ_PRESETS (&m_option_type_obj_presets)
-#define CONF_TYPE_CUSTOM_URL (&m_option_type_custom_url)
-#define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params)
-#define CONF_TYPE_TIME (&m_option_type_time)
-#define CONF_TYPE_TIME_SIZE (&m_option_type_time_size)
-
-// Possible option values. Code is allowed to access option data without going
-// through this union. It serves for self-documentation and to get minimal
-// size/alignment requirements for option values in general.
-union m_option_value {
- int flag; // not the C type "bool"!
- int int_;
- int64_t int64;
- float float_;
- double double_;
- char *string;
- char **string_list;
- int imgfmt;
- int afmt;
- m_span_t span;
- m_obj_settings_t *obj_settings_list;
- double time;
- m_time_size_t time_size;
-};
-
-////////////////////////////////////////////////////////////////////////////
-
-// Option type description
-struct m_option_type {
- const char *name;
- // Size needed for the data.
- unsigned int size;
- // One of M_OPT_TYPE*.
- unsigned int flags;
-
- // Parse the data from a string.
- /** It is the only required function, all others can be NULL.
- *
- * \param opt The option that is parsed.
- * \param name The full option name.
- * \param param The parameter to parse.
- * may not be an argument meant for this option
- * \param dst Pointer to the memory where the data should be written.
- * If NULL the parameter validity should still be checked.
- * \return On error a negative value is returned, on success the number
- * of arguments consumed. For details see \ref OptionParserReturn.
- */
- int (*parse)(const m_option_t *opt, struct bstr name, struct bstr param,
- void *dst);
-
- // Print back a value in string form.
- /** \param opt The option to print.
- * \param val Pointer to the memory holding the data to be printed.
- * \return An allocated string containing the text value or (void*)-1
- * on error.
- */
- char *(*print)(const m_option_t *opt, const void *val);
-
- // Print the value in a human readable form. Unlike print(), it doesn't
- // necessarily return the exact value, and is generally not parseable with
- // parse().
- char *(*pretty_print)(const m_option_t *opt, const void *val);
-
- // Copy data between two locations. Deep copy if the data has pointers.
- /** \param opt The option to copy.
- * \param dst Pointer to the destination memory.
- * \param src Pointer to the source memory.
- */
- void (*copy)(const m_option_t *opt, void *dst, const void *src);
-
- // Free the data allocated for a save slot.
- /** This is only needed for dynamic types like strings.
- * \param dst Pointer to the data, usually a pointer that should be freed and
- * set to NULL.
- */
- void (*free)(void *dst);
-
- // Add the value add to the value in val. For types that are not numeric,
- // add gives merely the direction. The wrap parameter determines whether
- // the value is clipped, or wraps around to the opposite max/min.
- void (*add)(const m_option_t *opt, void *val, double add, bool wrap);
-
- // Clamp the value in val to the option's valid value range.
- // Return values:
- // M_OPT_OUT_OF_RANGE: val was invalid, and modified (clamped) to be valid
- // M_OPT_INVALID: val was invalid, and can't be made valid
- // 0: val was already valid and is unchanged
- int (*clamp)(const m_option_t *opt, void *val);
-};
-
-// Option description
-struct m_option {
- // Option name.
- const char *name;
-
- // Reserved for higher level APIs, it shouldn't be used by parsers.
- /** The suboption parser and func types do use it. They should instead
- * use the priv field but this was inherited from older versions of the
- * config code.
- */
- void *p;
-
- // Option type.
- const m_option_type_t *type;
-
- // See \ref OptionFlags.
- unsigned int flags;
-
- // \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must
- // also be set.
- double min;
-
- // \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must
- // also be set.
- double max;
-
- // Type dependent data (for all kinds of extended settings).
- /** This used to be a function pointer to hold a 'reverse to defaults' func.
- * Now it can be used to pass any type of extra args needed by the parser.
- */
- void *priv;
-
- int new;
-
- int offset;
-
- // Initialize variable to given default before parsing options
- void *defval;
-};
-
-
-// The option has a minimum set in \ref m_option::min.
-#define M_OPT_MIN (1 << 0)
-
-// The option has a maximum set in \ref m_option::max.
-#define M_OPT_MAX (1 << 1)
-
-// The option has a minimum and maximum in m_option::min and m_option::max.
-#define M_OPT_RANGE (M_OPT_MIN | M_OPT_MAX)
-
-// The option is forbidden in config files.
-#define M_OPT_NOCFG (1 << 2)
-
-// This option can't be set per-file when used with struct m_config.
-#define M_OPT_GLOBAL (1 << 4)
-
-// This option is always considered per-file when used with struct m_config.
-// When playback of a file ends, the option value will be restored to the value
-// from before playback begin.
-#define M_OPT_LOCAL (1 << 5)
-
-// The option should be set during command line pre-parsing
-#define M_OPT_PRE_PARSE (1 << 6)
-
-// For options with children, add all children as top-level arguments
-// (e.g. "--parent=child=value" becomes "--parent-child=value")
-#define M_OPT_PREFIXED (1 << 8)
-
-// Similar to M_OPT_PREFIXED, but drop the prefix.
-// (e.g. "--parent=child=value" becomes "--child=value")
-#define M_OPT_MERGE (1 << 9)
-
-// These are kept for compatibility with older code.
-#define CONF_MIN M_OPT_MIN
-#define CONF_MAX M_OPT_MAX
-#define CONF_RANGE M_OPT_RANGE
-#define CONF_NOCFG M_OPT_NOCFG
-#define CONF_GLOBAL M_OPT_GLOBAL
-#define CONF_PRE_PARSE M_OPT_PRE_PARSE
-
-// These flags are used to describe special parser capabilities or behavior.
-
-// Suboption parser flag.
-/** When this flag is set, m_option::p should point to another m_option
- * array. Only the parse function will be called. If dst is set, it should
- * create/update an array of char* containg opt/val pairs. The options in
- * the child array will then be set automatically by the \ref Config.
- * Also note that suboptions may be directly accessed by using
- * -option:subopt blah.
- */
-#define M_OPT_TYPE_HAS_CHILD (1 << 0)
-
-// Wildcard matching flag.
-/** If set the option type has a use for option names ending with a *
- * (used for -aa*), this only affects the option name matching.
- */
-#define M_OPT_TYPE_ALLOW_WILDCARD (1 << 1)
-
-// Dynamic data type.
-/** This flag indicates that the data is dynamically allocated (m_option::p
- * points to a pointer). It enables a little hack in the \ref Config wich
- * replaces the initial value of such variables with a dynamic copy in case
- * the initial value is statically allocated (pretty common with strings).
- */
-#define M_OPT_TYPE_DYNAMIC (1 << 2)
-
-// The parameter is optional and by default no parameter is preferred. If the
-// "old syntax" is used, the command line parser will assume that the argument
-// takes no parameter.
-#define M_OPT_TYPE_OLD_SYNTAX_NO_PARAM (1 << 3)
-
-// modify M_OPT_TYPE_HAS_CHILD so that m_option::p points to
-// struct m_sub_options, instead of a direct m_option array.
-#define M_OPT_TYPE_USE_SUBSTRUCT (1 << 4)
-
-///////////////////////////// Parser flags /////////////////////////////////
-
-// On success parsers return the number of arguments consumed: 0 or 1.
-//
-// To indicate that MPlayer should exit without playing anything,
-// parsers return M_OPT_EXIT minus the number of parameters they
-// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1.
-//
-// On error one of the following (negative) error codes is returned:
-
-// For use by higher level APIs when the option name is invalid.
-#define M_OPT_UNKNOWN -1
-
-// Returned when a parameter is needed but wasn't provided.
-#define M_OPT_MISSING_PARAM -2
-
-// Returned when the given parameter couldn't be parsed.
-#define M_OPT_INVALID -3
-
-// Returned if the value is "out of range". The exact meaning may
-// vary from type to type.
-#define M_OPT_OUT_OF_RANGE -4
-
-// Returned if the parser failed for any other reason than a bad parameter.
-#define M_OPT_PARSER_ERR -5
-
-// Returned when MPlayer should exit. Used by various help stuff.
-/** M_OPT_EXIT must be the lowest number on this list.
- */
-#define M_OPT_EXIT -6
-
-char *m_option_strerror(int code);
-
-// Find the option matching the given name in the list.
-/** \ingroup Options
- * This function takes the possible wildcards into account (see
- * \ref M_OPT_TYPE_ALLOW_WILDCARD).
- *
- * \param list Pointer to an array of \ref m_option.
- * \param name Name of the option.
- * \return The matching option or NULL.
- */
-const m_option_t *m_option_list_find(const m_option_t *list, const char *name);
-
-// Helper to parse options, see \ref m_option_type::parse.
-static inline int m_option_parse(const m_option_t *opt, struct bstr name,
- struct bstr param, void *dst)
-{
- return opt->type->parse(opt, name, param, dst);
-}
-
-// Helper to print options, see \ref m_option_type::print.
-static inline char *m_option_print(const m_option_t *opt, const void *val_ptr)
-{
- if (opt->type->print)
- return opt->type->print(opt, val_ptr);
- else
- return NULL;
-}
-
-static inline char *m_option_pretty_print(const m_option_t *opt,
- const void *val_ptr)
-{
- if (opt->type->pretty_print)
- return opt->type->pretty_print(opt, val_ptr);
- else
- return m_option_print(opt, val_ptr);
-}
-
-// Helper around \ref m_option_type::copy.
-static inline void m_option_copy(const m_option_t *opt, void *dst,
- const void *src)
-{
- if (opt->type->copy)
- opt->type->copy(opt, dst, src);
-}
-
-// Helper around \ref m_option_type::free.
-static inline void m_option_free(const m_option_t *opt, void *dst)
-{
- if (opt->type->free)
- opt->type->free(dst);
-}
-
-/*@}*/
-
-#define OPTION_LIST_SEPARATOR ','
-
-#if HAVE_DOS_PATHS
-#define OPTION_PATH_SEPARATOR ';'
-#else
-#define OPTION_PATH_SEPARATOR ':'
-#endif
-
-#define OPTDEF_STR(s) .defval = (void *)&(char * const){s}
-#define OPTDEF_INT(i) .defval = (void *)&(const int){i}
-
-#define OPT_GENERAL(optname, varname, flagv, ...) {.name = optname, .flags = flagv, .new = 1, .offset = offsetof(OPT_BASE_STRUCT, varname), __VA_ARGS__}
-
-/* The OPT_FLAG_CONSTANTS->OPT_FLAG_CONSTANTS_ kind of redirection exists to
- * make the code fully standard-conforming: the C standard requires that
- * __VA_ARGS__ has at least one argument (though GCC for example would accept
- * 0). Thus the first OPT_FLAG_CONSTANTS is a wrapper which just adds one
- * argument to ensure __VA_ARGS__ is not empty when calling the next macro.
- */
-#define OPT_FLAG_ON(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_flag, .max = 1)
-#define OPT_FLAG_OFF(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_flag, .min = 1)
-#define OPT_MAKE_FLAGS OPT_FLAG_ON
-#define OPT_FLAG_CONSTANTS(...) OPT_FLAG_CONSTANTS_(__VA_ARGS__, .type = &m_option_type_flag)
-#define OPT_FLAG_CONSTANTS_(optname, varname, flags, offvalue, value, ...) OPT_GENERAL(optname, varname, flags, .min = offvalue, .max = value, __VA_ARGS__)
-#define OPT_STRINGLIST(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_string_list)
-#define OPT_PATHLIST(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_string_list, .priv = (void *)&(const char){OPTION_PATH_SEPARATOR})
-#define OPT_INT(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_int)
-#define OPT_INTRANGE(...) OPT_RANGE_(__VA_ARGS__, .type = &m_option_type_int)
-#define OPT_RANGE_(optname, varname, flags, minval, maxval, ...) OPT_GENERAL(optname, varname, (flags) | CONF_RANGE, .min = minval, .max = maxval, __VA_ARGS__)
-#define OPT_INTPAIR(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_intpair)
-#define OPT_FLOAT(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_float)
-#define OPT_FLOATRANGE(...) OPT_RANGE_(__VA_ARGS__, .type = &m_option_type_float)
-#define OPT_STRING(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_string)
-#define OPT_SETTINGSLIST(optname, varname, flags, objlist) OPT_GENERAL(optname, varname, flags, .type = &m_option_type_obj_settings_list, .priv = objlist)
-#define OPT_AUDIOFORMAT(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_afmt)
-#define OPT_HELPER_REMOVEPAREN(...) __VA_ARGS__
-#define M_CHOICES(choices) .priv = (void *)&(const struct m_opt_choice_alternatives[]){OPT_HELPER_REMOVEPAREN choices, {NULL}}
-#define OPT_CHOICE(...) OPT_CHOICE_(__VA_ARGS__, .type = &m_option_type_choice)
-#define OPT_CHOICE_(optname, varname, flags, choices, ...) OPT_GENERAL(optname, varname, flags, M_CHOICES(choices), __VA_ARGS__)
-// Union of choices and an int range. The choice values can be included in the
-// int range, or be completely separate - both works.
-#define OPT_CHOICE_OR_INT(...) OPT_CHOICE_OR_INT_(__VA_ARGS__, .type = &m_option_type_choice)
-#define OPT_CHOICE_OR_INT_(optname, varname, flags, minval, maxval, choices, ...) OPT_GENERAL(optname, varname, (flags) | CONF_RANGE, .min = minval, .max = maxval, M_CHOICES(choices), __VA_ARGS__)
-#define OPT_TIME(...) OPT_GENERAL(__VA_ARGS__, .type = &m_option_type_time)
-
-#define OPT_TRACKCHOICE(name, var) OPT_CHOICE_OR_INT(name, var, 0, 0, 8190, ({"no", -2}, {"auto", -1}))
-
-// subconf must have the type struct m_sub_options.
-// flagv should be M_OPT_MERGE or M_OPT_FLATTEN.
-// varname refers to the field, that must be a pointer to a field described by
-// the subconf struct.
-#define OPT_SUBSTRUCT(varname, subconf, flagv) OPT_GENERAL("-", varname, flagv, .type = &m_option_type_subconfig_struct, .priv = (void*)&subconf)
-
-#define OPT_BASE_STRUCT struct MPOpts
-
-#endif /* MPLAYER_M_OPTION_H */