properties.h

Go to the documentation of this file.

/* PipeWire */
/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
/* SPDX-License-Identifier: MIT */
 
#ifndef PIPEWIRE_PROPERTIES_H
#define PIPEWIRE_PROPERTIES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdarg.h>
 
#include <spa/utils/cleanup.h>
#include <spa/utils/dict.h>
#include <spa/utils/string.h>
 
struct pw_properties {
        struct spa_dict dict;   
        uint32_t flags;         
};
 
struct pw_properties *
pw_properties_new(const char *key, ...) SPA_SENTINEL;
 
struct pw_properties *
pw_properties_new_dict(const struct spa_dict *dict);
 
struct pw_properties *
pw_properties_new_string(const char *args);
 
struct pw_properties *
pw_properties_new_string_checked(const char *args, size_t size,
                struct spa_error_location *loc);
 
struct pw_properties *
pw_properties_copy(const struct pw_properties *properties);
 
int pw_properties_update_keys(struct pw_properties *props,
                     const struct spa_dict *dict, const char * const keys[]);
int pw_properties_update_ignore(struct pw_properties *props,
                const struct spa_dict *dict, const char * const ignore[]);
 
/* Update props with all key/value pairs from dict */
int pw_properties_update(struct pw_properties *props,
                     const struct spa_dict *dict);
 
/* Update props with all key/value pairs from str */
int pw_properties_update_string(struct pw_properties *props,
                const char *str, size_t size);
 
int pw_properties_update_string_checked(struct pw_properties *props,
                const char *str, size_t size, struct spa_error_location *loc);
 
int pw_properties_add(struct pw_properties *oldprops,
                     const struct spa_dict *dict);
int pw_properties_add_keys(struct pw_properties *oldprops,
                     const struct spa_dict *dict, const char * const keys[]);
 
void pw_properties_clear(struct pw_properties *properties);
 
void
pw_properties_free(struct pw_properties *properties);
 
int
pw_properties_set(struct pw_properties *properties, const char *key, const char *value);
 
int
pw_properties_setf(struct pw_properties *properties,
                   const char *key, const char *format, ...) SPA_PRINTF_FUNC(3, 4);
int
pw_properties_setva(struct pw_properties *properties,
                   const char *key, const char *format, va_list args) SPA_PRINTF_FUNC(3,0);
const char *
pw_properties_get(const struct pw_properties *properties, const char *key);
 
int
pw_properties_fetch_uint32(const struct pw_properties *properties, const char *key, uint32_t *value);
 
int
pw_properties_fetch_int32(const struct pw_properties *properties, const char *key, int32_t *value);
 
int
pw_properties_fetch_uint64(const struct pw_properties *properties, const char *key, uint64_t *value);
 
int
pw_properties_fetch_int64(const struct pw_properties *properties, const char *key, int64_t *value);
 
int
pw_properties_fetch_bool(const struct pw_properties *properties, const char *key, bool *value);
 
static inline uint32_t
pw_properties_get_uint32(const struct pw_properties *properties, const char *key, uint32_t deflt)
{
        uint32_t val = deflt;
        pw_properties_fetch_uint32(properties, key, &val);
        return val;
}
 
static inline int32_t
pw_properties_get_int32(const struct pw_properties *properties, const char *key, int32_t deflt)
{
        int32_t val = deflt;
        pw_properties_fetch_int32(properties, key, &val);
        return val;
}
 
static inline uint64_t
pw_properties_get_uint64(const struct pw_properties *properties, const char *key, uint64_t deflt)
{
        uint64_t val = deflt;
        pw_properties_fetch_uint64(properties, key, &val);
        return val;
}
 
static inline int64_t
pw_properties_get_int64(const struct pw_properties *properties, const char *key, int64_t deflt)
{
        int64_t val = deflt;
        pw_properties_fetch_int64(properties, key, &val);
        return val;
}
 
 
static inline bool
pw_properties_get_bool(const struct pw_properties *properties, const char *key, bool deflt)
{
        bool val = deflt;
        pw_properties_fetch_bool(properties, key, &val);
        return val;
}
 
const char *
pw_properties_iterate(const struct pw_properties *properties, void **state);
 
#define PW_PROPERTIES_FLAG_NL           (1<<0)
#define PW_PROPERTIES_FLAG_RECURSE      (1<<1)
#define PW_PROPERTIES_FLAG_ENCLOSE      (1<<2)
#define PW_PROPERTIES_FLAG_ARRAY        (1<<3)
#define PW_PROPERTIES_FLAG_COLORS       (1<<4)
int pw_properties_serialize_dict(FILE *f, const struct spa_dict *dict, uint32_t flags);
 
static inline bool pw_properties_parse_bool(const char *value) {
        return spa_atob(value);
}
 
static inline int pw_properties_parse_int(const char *value) {
        int v;
        return spa_atoi32(value, &v, 0) ? v: 0;
}
 
static inline int64_t pw_properties_parse_int64(const char *value) {
        int64_t v;
        return spa_atoi64(value, &v, 0) ? v : 0;
}
 
static inline uint64_t pw_properties_parse_uint64(const char *value) {
        uint64_t v;
        return spa_atou64(value, &v, 0) ? v : 0;
}
 
static inline float pw_properties_parse_float(const char *value) {
        float v;
        return spa_atof(value, &v) ? v : 0.0f;
}
 
static inline double pw_properties_parse_double(const char *value) {
        double v;
        return spa_atod(value, &v) ? v : 0.0;
}
 
SPA_DEFINE_AUTOPTR_CLEANUP(pw_properties, struct pw_properties, {
        spa_clear_ptr(*thing, pw_properties_free);
})
 
#ifdef __cplusplus
}
#endif
 
#endif /* PIPEWIRE_PROPERTIES_H */