1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
* 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_PROPERTY_H
#define MPLAYER_M_PROPERTY_H
#include <stdbool.h>
struct m_option;
enum mp_property_action {
// Get the property type. This defines the fundamental data type read from
// or written to the property.
// If unimplemented, the m_option entry that defines the property is used.
// arg: m_option*
M_PROPERTY_GET_TYPE,
// Get the current value.
// arg: pointer to a variable of the type according to the property type
M_PROPERTY_GET,
// Set a new value. The property wrapper will make sure that only valid
// values are set (e.g. according to the property type's min/max range).
// If unimplemented, the property is read-only.
// arg: pointer to a variable of the type according to the property type
M_PROPERTY_SET,
// Get human readable string representing the current value.
// If unimplemented, the property wrapper uses the property type as
// fallback.
// arg: char**
M_PROPERTY_PRINT,
// Switch the property up/down by a given value.
// If unimplemented, the property wrapper uses the property type as
// fallback.
// arg: struct m_property_switch_arg*
M_PROPERTY_SWITCH,
// Get a string containing a parsable representation.
// Can't be overridden by property implementations.
// arg: char**
M_PROPERTY_GET_STRING,
// Set a new value from a string. The property wrapper parses this using the
// parse function provided by the property type.
// Can't be overridden by property implementations.
// arg: char*
M_PROPERTY_SET_STRING,
// Pass down an action to a sub-property.
// arg: struct m_property_action_arg*
M_PROPERTY_KEY_ACTION,
};
// Argument for M_PROPERTY_SWITCH
struct m_property_switch_arg {
double inc; // value to add to property, or cycle direction
bool wrap; // whether value should wrap around on over/underflow
};
// Argument for M_PROPERTY_KEY_ACTION
struct m_property_action_arg {
const char* key;
int action;
void* arg;
};
enum mp_property_return {
// Returned on success.
M_PROPERTY_OK = 1,
// Returned on error.
M_PROPERTY_ERROR = 0,
// Returned when the property can't be used, for example video related
// properties while playing audio only.
M_PROPERTY_UNAVAILABLE = -1,
// Returned if the requested action is not implemented.
M_PROPERTY_NOT_IMPLEMENTED = -2,
// Returned when asking for a property that doesn't exist.
M_PROPERTY_UNKNOWN = -3,
};
// Access a property.
// action: one of m_property_action
// ctx: opaque value passed through to property implementation
// returns: one of mp_property_return
int m_property_do(const struct m_option* prop_list, const char* property_name,
int action, void* arg, void *ctx);
// Print a list of properties.
void m_properties_print_help_list(const struct m_option* list);
// Expand a property string.
/* This function allows to print strings containing property values.
* ${NAME} is expanded to the value of property NAME or an empty
* string in case of error. $(NAME:STR) expand STR only if the property
* NAME is available.
*/
char* m_properties_expand_string(const struct m_option* prop_list, char* str,
void *ctx);
// Trivial helpers for implementing properties.
int m_property_int_ro(const struct m_option* prop, int action, void* arg,
int var);
int m_property_float_ro(const struct m_option* prop, int action, void* arg,
float var);
int m_property_double_ro(const struct m_option* prop, int action, void* arg,
double var);
#endif /* MPLAYER_M_PROPERTY_H */
|
