PipeWire 1.1.81
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};
35pw_properties_new(const char *key, ...) SPA_SENTINEL;
36
37struct pw_properties *
39
40struct pw_properties *
41pw_properties_new_string(const char *args);
42
43struct pw_properties *
44pw_properties_new_string_checked(const char *args, size_t size,
45 struct spa_error_location *loc);
46
47struct pw_properties *
48pw_properties_copy(const struct pw_properties *properties);
49
51 const struct spa_dict *dict, const char * const keys[]);
53 const struct spa_dict *dict, const char * const ignore[]);
54
55/* Update props with all key/value pairs from dict */
56int pw_properties_update(struct pw_properties *props,
57 const struct spa_dict *dict);
58
59/* Update props with all key/value pairs from str */
61 const char *str, size_t size);
62
64 const char *str, size_t size, struct spa_error_location *loc);
65
66int pw_properties_add(struct pw_properties *oldprops,
67 const struct spa_dict *dict);
68int pw_properties_add_keys(struct pw_properties *oldprops,
69 const struct spa_dict *dict, const char * const keys[]);
70
71void pw_properties_clear(struct pw_properties *properties);
72
73void
74pw_properties_free(struct pw_properties *properties);
75
76int
77pw_properties_set(struct pw_properties *properties, const char *key, const char *value);
78
79int
80pw_properties_setf(struct pw_properties *properties,
81 const char *key, const char *format, ...) SPA_PRINTF_FUNC(3, 4);
82int
83pw_properties_setva(struct pw_properties *properties,
84 const char *key, const char *format, va_list args) SPA_PRINTF_FUNC(3,0);
85const char *
86pw_properties_get(const struct pw_properties *properties, const char *key);
87
88int
89pw_properties_fetch_uint32(const struct pw_properties *properties, const char *key, uint32_t *value);
90
91int
92pw_properties_fetch_int32(const struct pw_properties *properties, const char *key, int32_t *value);
93
94int
95pw_properties_fetch_uint64(const struct pw_properties *properties, const char *key, uint64_t *value);
96
97int
98pw_properties_fetch_int64(const struct pw_properties *properties, const char *key, int64_t *value);
99
100int
101pw_properties_fetch_bool(const struct pw_properties *properties, const char *key, bool *value);
102
103static inline uint32_t
104pw_properties_get_uint32(const struct pw_properties *properties, const char *key, uint32_t deflt)
105{
106 uint32_t val = deflt;
107 pw_properties_fetch_uint32(properties, key, &val);
108 return val;
109}
110
111static inline int32_t
112pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
113{
114 int32_t val = deflt;
115 pw_properties_fetch_int32(properties, key, &val);
116 return val;
117}
118
119static inline uint64_t
120pw_properties_get_uint64(const struct pw_properties *properties, const char *key, uint64_t deflt)
121{
122 uint64_t val = deflt;
123 pw_properties_fetch_uint64(properties, key, &val);
124 return val;
125}
126
127static inline int64_t
128pw_properties_get_int64(const struct pw_properties *properties, const char *key, int64_t deflt)
129{
130 int64_t val = deflt;
131 pw_properties_fetch_int64(properties, key, &val);
132 return val;
133}
134
135
136static inline bool
137pw_properties_get_bool(const struct pw_properties *properties, const char *key, bool deflt)
138{
139 bool val = deflt;
140 pw_properties_fetch_bool(properties, key, &val);
141 return val;
142}
143
144const char *
145pw_properties_iterate(const struct pw_properties *properties, void **state);
146
147#define PW_PROPERTIES_FLAG_NL (1<<0)
148#define PW_PROPERTIES_FLAG_RECURSE (1<<1)
149#define PW_PROPERTIES_FLAG_ENCLOSE (1<<2)
150#define PW_PROPERTIES_FLAG_ARRAY (1<<3)
151#define PW_PROPERTIES_FLAG_COLORS (1<<4)
152int pw_properties_serialize_dict(FILE *f, const struct spa_dict *dict, uint32_t flags);
153
154static inline bool pw_properties_parse_bool(const char *value) {
155 return spa_atob(value);
157
158static inline int pw_properties_parse_int(const char *value) {
159 int v;
160 return spa_atoi32(value, &v, 0) ? v: 0;
161}
162
163static inline int64_t pw_properties_parse_int64(const char *value) {
164 int64_t v;
165 return spa_atoi64(value, &v, 0) ? v : 0;
166}
168static inline uint64_t pw_properties_parse_uint64(const char *value) {
169 uint64_t v;
170 return spa_atou64(value, &v, 0) ? v : 0;
171}
173static inline float pw_properties_parse_float(const char *value) {
174 float v;
175 return spa_atof(value, &v) ? v : 0.0f;
176}
178static inline double pw_properties_parse_double(const char *value) {
179 double v;
180 return spa_atod(value, &v) ? v : 0.0;
181}
187#ifdef __cplusplus
188}
189#endif
190
191#endif /* PIPEWIRE_PROPERTIES_H */
void pw_properties_free(struct pw_properties *properties)
Free a properties object.
Definition properties.c:562
struct pw_properties * pw_properties_new(const char *key,...)
Make a new properties object.
Definition properties.c:96
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:304
static bool pw_properties_get_bool(const struct pw_properties *properties, const char *key, bool deflt)
Definition properties.h:141
static int64_t pw_properties_parse_int64(const char *value)
Definition properties.h:172
static int pw_properties_parse_int(const char *value)
Definition properties.h:167
int pw_properties_add(struct pw_properties *oldprops, const struct spa_dict *dict)
Add properties.
Definition properties.c:506
static bool pw_properties_parse_bool(const char *value)
Definition properties.h:163
int pw_properties_fetch_bool(const struct pw_properties *properties, const char *key, bool *value)
Fetch a property as boolean value.
Definition properties.c:765
int pw_properties_update_ignore(struct pw_properties *props, const struct spa_dict *dict, const char *const ignore[])
Definition properties.c:437
int pw_properties_update(struct pw_properties *props, const struct spa_dict *dict)
Update properties.
Definition properties.c:481
const char * pw_properties_iterate(const struct pw_properties *properties, void **state)
Iterate property values.
Definition properties.c:789
struct pw_properties * pw_properties_new_dict(const struct spa_dict *dict)
Make a new properties object from the given dictionary.
Definition properties.c:131
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:711
int pw_properties_setf(struct pw_properties *properties, const char *key, const char *format,...)
Set a property value by format.
Definition properties.c:620
static float pw_properties_parse_float(const char *value)
Definition properties.h:182
const char * pw_properties_get(const struct pw_properties *properties, const char *key)
Get a property.
Definition properties.c:641
struct pw_properties * pw_properties_new_string(const char *args)
Make a new properties object from the given str.
Definition properties.c:349
static uint64_t pw_properties_get_uint64(const struct pw_properties *properties, const char *key, uint64_t deflt)
Definition properties.h:124
int pw_properties_set(struct pw_properties *properties, const char *key, const char *value)
Set a property value.
Definition properties.c:589
static int64_t pw_properties_get_int64(const struct pw_properties *properties, const char *key, int64_t deflt)
Definition properties.h:132
static int32_t pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
Definition properties.h:116
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:408
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:738
static uint64_t pw_properties_parse_uint64(const char *value)
Definition properties.h:177
void pw_properties_clear(struct pw_properties *properties)
Clear a properties object.
Definition properties.c:460
static double pw_properties_parse_double(const char *value)
Definition properties.h:187
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:657
int pw_properties_update_string_checked(struct pw_properties *props, const char *str, size_t size, struct spa_error_location *loc)
Check str is a well-formed properties JSON string and update the properties on success.
Definition properties.c:330
int pw_properties_setva(struct pw_properties *properties, const char *key, const char *format, va_list args)
Definition properties.c:595
int pw_properties_add_keys(struct pw_properties *oldprops, const struct spa_dict *dict, const char *const keys[])
Add keys.
Definition properties.c:536
static uint32_t pw_properties_get_uint32(const struct pw_properties *properties, const char *key, uint32_t deflt)
Definition properties.h:108
struct pw_properties * pw_properties_copy(const struct pw_properties *properties)
Copy a properties object.
Definition properties.c:395
struct pw_properties * pw_properties_new_string_checked(const char *args, size_t size, struct spa_error_location *loc)
Definition properties.c:370
int pw_properties_serialize_dict(FILE *f, const struct spa_dict *dict, uint32_t flags)
Definition properties.c:920
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:684
static bool spa_atod(const char *str, double *val)
Convert str to a double and store the result in val.
Definition string.h:337
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
static bool spa_atob(const char *str)
Convert str to a boolean.
Definition string.h:204
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
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
static bool spa_atof(const char *str, float *val)
Convert str to a float and store the result in val.
Definition string.h:287
#define SPA_PRINTF_FUNC(fmt, arg1)
Definition defs.h:285
#define SPA_SENTINEL
Definition defs.h:295
spa/utils/string.h
Definition properties.h:33
struct spa_dict dict
dictionary of key/values
Definition properties.h:34
uint32_t flags
extra flags
Definition properties.h:35
Definition dict.h:39
Definition defs.h:404
spa/utils/dict.h