PipeWire: pipewire/properties.h Source File

PipeWire 1.0.3

Loading...
Searching...
No Matches
properties.h
Go to the documentation of this file.
1/* PipeWire */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef PIPEWIRE_PROPERTIES_H
6#define PIPEWIRE_PROPERTIES_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <stdarg.h>
13
14#include <spa/utils/dict.h>
15#include <spa/utils/string.h>
16
29struct pw_properties {
30 struct spa_dict dict;
31 uint32_t flags;
32};
33
34 struct pw_properties *
35 pw_properties_new(const char *key, ...) SPA_SENTINEL;
36
37struct pw_properties *
38 pw_properties_new_dict(const struct spa_dict *dict);
39
40struct pw_properties *
41 pw_properties_new_string(const char *args);
42
43struct pw_properties *
44 pw_properties_copy(const struct pw_properties *properties);
45
46int pw_properties_update_keys(struct pw_properties *props,
47 const struct spa_dict *dict, const char * const keys[]);
48int pw_properties_update_ignore(struct pw_properties *props,
49 const struct spa_dict *dict, const char * const ignore[]);
50
51/* Update props with all key/value pairs from dict */
52int pw_properties_update(struct pw_properties *props,
53 const struct spa_dict *dict);
54/* Update props with all key/value pairs from str */
55int pw_properties_update_string(struct pw_properties *props,
56 const char *str, size_t size);
57
58int pw_properties_add(struct pw_properties *oldprops,
59 const struct spa_dict *dict);
60int pw_properties_add_keys(struct pw_properties *oldprops,
61 const struct spa_dict *dict, const char * const keys[]);
62
63void pw_properties_clear(struct pw_properties *properties);
64
65void
66 pw_properties_free(struct pw_properties *properties);
67
68int
69 pw_properties_set(struct pw_properties *properties, const char *key, const char *value);
70
71int
72 pw_properties_setf(struct pw_properties *properties,
73 const char *key, const char *format, ...) SPA_PRINTF_FUNC(3, 4);
74int
75 pw_properties_setva(struct pw_properties *properties,
76 const char *key, const char *format, va_list args) SPA_PRINTF_FUNC(3,0);
77const char *
78 pw_properties_get(const struct pw_properties *properties, const char *key);
79
80int
81 pw_properties_fetch_uint32(const struct pw_properties *properties, const char *key, uint32_t *value);
82
83int
84 pw_properties_fetch_int32(const struct pw_properties *properties, const char *key, int32_t *value);
85
86int
87 pw_properties_fetch_uint64(const struct pw_properties *properties, const char *key, uint64_t *value);
88
89int
90 pw_properties_fetch_int64(const struct pw_properties *properties, const char *key, int64_t *value);
91
92int
93 pw_properties_fetch_bool(const struct pw_properties *properties, const char *key, bool *value);
94
95static inline uint32_t
96 pw_properties_get_uint32(const struct pw_properties *properties, const char *key, uint32_t deflt)
97{
98 uint32_t val = deflt;
99 pw_properties_fetch_uint32(properties, key, &val);
100 return val;
101}
102
103static inline int32_t
104 pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
105{
106 int32_t val = deflt;
107 pw_properties_fetch_int32(properties, key, &val);
108 return val;
109}
110
111static inline uint64_t
112 pw_properties_get_uint64(const struct pw_properties *properties, const char *key, uint64_t deflt)
113{
114 uint64_t val = deflt;
115 pw_properties_fetch_uint64(properties, key, &val);
116 return val;
117}
118
119static inline int64_t
120 pw_properties_get_int64(const struct pw_properties *properties, const char *key, int64_t deflt)
121{
122 int64_t val = deflt;
123 pw_properties_fetch_int64(properties, key, &val);
124 return val;
125}
126
127
128static inline bool
129 pw_properties_get_bool(const struct pw_properties *properties, const char *key, bool deflt)
130{
131 bool val = deflt;
132 pw_properties_fetch_bool(properties, key, &val);
133 return val;
134}
135
136const char *
137 pw_properties_iterate(const struct pw_properties *properties, void **state);
138
139#define PW_PROPERTIES_FLAG_NL (1<<0)
140#define PW_PROPERTIES_FLAG_RECURSE (1<<1)
141#define PW_PROPERTIES_FLAG_ENCLOSE (1<<2)
142#define PW_PROPERTIES_FLAG_ARRAY (1<<3)
143#define PW_PROPERTIES_FLAG_COLORS (1<<4)
144 int pw_properties_serialize_dict(FILE *f, const struct spa_dict *dict, uint32_t flags);
145
146 static inline bool pw_properties_parse_bool(const char *value) {
147 return spa_atob(value);
148}
149
150 static inline int pw_properties_parse_int(const char *value) {
151 int v;
152 return spa_atoi32(value, &v, 0) ? v: 0;
153}
154
155 static inline int64_t pw_properties_parse_int64(const char *value) {
156 int64_t v;
157 return spa_atoi64(value, &v, 0) ? v : 0;
158}
159
160static inline uint64_t pw_properties_parse_uint64(const char *value) {
161 uint64_t v;
162 return spa_atou64(value, &v, 0) ? v : 0;
163}
164
165static inline float pw_properties_parse_float(const char *value) {
166 float v;
167 return spa_atof(value, &v) ? v : 0.0f;
168}
169
170static inline double pw_properties_parse_double(const char *value) {
171 double v;
172 return spa_atod(value, &v) ? v : 0.0;
173}
174
179#ifdef __cplusplus
180}
181#endif
182
183#endif /* PIPEWIRE_PROPERTIES_H */
pw_properties_free
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition properties.c:351
pw_properties_new
struct pw_properties * pw_properties_new(const char *key,...) 1
Make a new properties object.
Definition properties.c:85
pw_properties_update_string
int pw_properties_update_string(struct pw_properties *props, const char *str, size_t size)
Update the properties from the given string, overwriting any existing keys with the new values from s...
Definition properties.c:141
pw_properties_get_bool
static bool pw_properties_get_bool(const struct pw_properties *properties, const char *key, bool deflt)
Definition properties.h:133
pw_properties_parse_int64
static int64_t pw_properties_parse_int64(const char *value)
Definition properties.h:164
pw_properties_parse_int
static int pw_properties_parse_int(const char *value)
Definition properties.h:159
pw_properties_add
int pw_properties_add(struct pw_properties *oldprops, const struct spa_dict *dict)
Add properties.
Definition properties.c:306
pw_properties_get
int int const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition properties.c:474
pw_properties_parse_bool
static bool pw_properties_parse_bool(const char *value)
Definition properties.h:155
pw_properties_fetch_bool
int pw_properties_fetch_bool(const struct pw_properties *properties, const char *key, bool *value)
Fetch a property as boolean value.
Definition properties.c:604
pw_properties_update_ignore
int pw_properties_update_ignore(struct pw_properties *props, const struct spa_dict *dict, const char *const ignore[])
Definition properties.c:246
pw_properties_setf
int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format,...) 1(3
pw_properties_update
int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition properties.c:285
pw_properties_iterate
const char * pw_properties_iterate(const struct pw_properties *properties, void **state)
Iterate property values.
Definition properties.c:628
pw_properties_new_dict
struct pw_properties * pw_properties_new_dict(const struct spa_dict *dict)
Make a new properties object from the given dictionary.
Definition properties.c:113
pw_properties_fetch_uint64
int pw_properties_fetch_uint64(const struct pw_properties *properties, const char *key, uint64_t *value)
Fetch a property as uint64_t.
Definition properties.c:550
pw_properties_parse_float
static float pw_properties_parse_float(const char *value)
Definition properties.h:174
pw_properties_new_string
struct pw_properties * pw_properties_new_string(const char *args)
Make a new properties object from the given str.
Definition properties.c:184
pw_properties_get_uint64
static uint64_t pw_properties_get_uint64(const struct pw_properties *properties, const char *key, uint64_t deflt)
Definition properties.h:116
pw_properties_set
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition properties.c:422
pw_properties_get_int64
static int64_t pw_properties_get_int64(const struct pw_properties *properties, const char *key, int64_t deflt)
Definition properties.h:124
pw_properties_get_int32
static int32_t pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
Definition properties.h:108
pw_properties_update_keys
int pw_properties_update_keys(struct pw_properties *props, const struct spa_dict *dict, const char *const keys[])
Copy multiple keys from one property to another.
Definition properties.c:222
pw_properties_fetch_int64
int pw_properties_fetch_int64(const struct pw_properties *properties, const char *key, int64_t *value)
Fetch a property as int64_t.
Definition properties.c:577
pw_properties_parse_uint64
static uint64_t pw_properties_parse_uint64(const char *value)
Definition properties.h:169
pw_properties_clear
void pw_properties_clear(struct pw_properties *properties)
Clear a properties object.
Definition properties.c:264
pw_properties_parse_double
static double pw_properties_parse_double(const char *value)
Definition properties.h:179
pw_properties_fetch_uint32
int pw_properties_fetch_uint32(const struct pw_properties *properties, const char *key, uint32_t *value)
Fetch a property as uint32_t.
Definition properties.c:496
pw_properties_setva
int int pw_properties_setva(struct pw_properties *properties, const char *key, const char *format, va_list args) 1(3
pw_properties_add_keys
int pw_properties_add_keys(struct pw_properties *oldprops, const struct spa_dict *dict, const char *const keys[])
Add keys.
Definition properties.c:330
pw_properties_get_uint32
static uint32_t pw_properties_get_uint32(const struct pw_properties *properties, const char *key, uint32_t deflt)
Definition properties.h:100
pw_properties_copy
struct pw_properties * pw_properties_copy(const struct pw_properties *properties)
Copy a properties object.
Definition properties.c:209
pw_properties_serialize_dict
int pw_properties_serialize_dict(FILE *f, const struct spa_dict *dict, uint32_t flags)
Definition properties.c:759
pw_properties_fetch_int32
int pw_properties_fetch_int32(const struct pw_properties *properties, const char *key, int32_t *value)
Fetch a property as int32_t.
Definition properties.c:523
spa_atod
static bool spa_atod(const char *str, double *val)
Convert str to a double and store the result in val.
Definition string.h:337
spa_atou64
static bool spa_atou64(const char *str, uint64_t *val, int base)
Convert str to an uint64_t with the given base and store the result in val.
Definition string.h:181
spa_atob
static bool spa_atob(const char *str)
Convert str to a boolean.
Definition string.h:204
spa_atoi64
static bool spa_atoi64(const char *str, int64_t *val, int base)
Convert str to an int64_t with the given base and store the result in val.
Definition string.h:156
spa_atoi32
static bool spa_atoi32(const char *str, int32_t *val, int base)
Convert str to an int32_t with the given base and store the result in val.
Definition string.h:100
spa_atof
static bool spa_atof(const char *str, float *val)
Convert str to a float and store the result in val.
Definition string.h:287
SPA_PRINTF_FUNC
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:277
SPA_SENTINEL
#define SPA_SENTINEL
Definition defs.h:287
string.h
spa/utils/string.h
pw_properties
Definition properties.h:33
pw_properties::dict
struct spa_dict dict
dictionary of key/values
Definition properties.h:34
pw_properties::flags
uint32_t flags
extra flags
Definition properties.h:35
spa_dict
Definition dict.h:39
dict.h
spa/utils/dict.h