5#ifndef PIPEWIRE_PROPERTIES_H
6#define PIPEWIRE_PROPERTIES_H
14#include <spa/utils/cleanup.h>
54 const struct
spa_dict *
dict, const
char * const ignore[]);
62 const
char *str,
size_t size);
85 const
char *key, const
char *format, va_list args)
SPA_PRINTF_FUNC(3,0);
104static inline uint32_t
107 uint32_t val = deflt;
120static inline uint64_t
123 uint64_t val = deflt;
148#define PW_PROPERTIES_FLAG_NL (1<<0)
149#define PW_PROPERTIES_FLAG_RECURSE (1<<1)
150#define PW_PROPERTIES_FLAG_ENCLOSE (1<<2)
151#define PW_PROPERTIES_FLAG_ARRAY (1<<3)
152#define PW_PROPERTIES_FLAG_COLORS (1<<4)
176 return spa_atof(value, &v) ? v : 0.0f;
181 return spa_atod(value, &v) ? v : 0.0;
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:142
static int64_t pw_properties_parse_int64(const char *value)
Definition properties.h:173
static int pw_properties_parse_int(const char *value)
Definition properties.h:168
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:164
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:183
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:125
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:133
static int32_t pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
Definition properties.h:117
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:178
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:188
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:109
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:295
#define SPA_SENTINEL
Definition defs.h:305
Definition properties.h:34
struct spa_dict dict
dictionary of key/values
Definition properties.h:35
uint32_t flags
extra flags
Definition properties.h:36