Loading...
Searching...
No Matches
tag-utils.h
Go to the documentation of this file.
/* Simple Plugin API */
/* SPDX-FileCopyrightText: Copyright © 2023 Wim Taymans */
/* SPDX-License-Identifier: MIT */
#ifndef SPA_PARAM_TAG_UTILS_H
#define SPA_PARAM_TAG_UTILS_H
#ifdef __cplusplus
extern "C" {
#endif
#include <float.h>
#include <spa/utils/dict.h>
#include <spa/pod/builder.h>
#include <spa/pod/parser.h>
#include <spa/param/tag.h>
static inline int
spa_tag_compare(const struct spa_pod *a, const struct spa_pod *b)
{
return ((a == b) || (a && b && SPA_POD_SIZE(a) == SPA_POD_SIZE(b) &&
memcmp(a, b, SPA_POD_SIZE(b)) == 0)) ? 0 : 1;
}
static inline int
spa_tag_parse(const struct spa_pod *tag, struct spa_tag_info *info, void **state)
{
int res;
const struct spa_pod_object *obj = (const struct spa_pod_object*)tag;
const struct spa_pod_prop *first, *start, *cur;
spa_zero(*info);
if ((res = spa_pod_parse_object(tag,
SPA_TYPE_OBJECT_ParamTag, NULL,
SPA_PARAM_TAG_direction, SPA_POD_Id(&info->direction))) < 0)
return res;
first = spa_pod_prop_first(&obj->body);
start = *state ? spa_pod_prop_next((struct spa_pod_prop*)*state) : first;
res = 0;
for (cur = start; spa_pod_prop_is_inside(&obj->body, obj->pod.size, cur);
cur = spa_pod_prop_next(cur)) {
if (cur->key == SPA_PARAM_TAG_info) {
info->info = &cur->value;
*state = (void*)cur;
return 1;
}
}
return 0;
}
static inline int
spa_tag_info_parse(const struct spa_tag_info *info, struct spa_dict *dict, struct spa_dict_item *items)
{
struct spa_pod_parser prs;
uint32_t n, n_items;
const char *key, *value;
struct spa_pod_frame f[1];
spa_pod_parser_pod(&prs, info->info);
if (spa_pod_parser_push_struct(&prs, &f[0]) < 0 ||
spa_pod_parser_get_int(&prs, (int32_t*)&n_items) < 0)
return -EINVAL;
if (items == NULL) {
dict->n_items = n_items;
return 0;
}
n_items = SPA_MIN(dict->n_items, n_items);
for (n = 0; n < n_items; n++) {
if (spa_pod_parser_get(&prs,
SPA_POD_String(&key),
SPA_POD_String(&value),
NULL) < 0)
break;
items[n].key = key;
items[n].value = value;
}
dict->items = items;
spa_pod_parser_pop(&prs, &f[0]);
return 0;
}
static inline void
spa_tag_build_start(struct spa_pod_builder *builder, struct spa_pod_frame *f,
uint32_t id, enum spa_direction direction)
{
spa_pod_builder_push_object(builder, f, SPA_TYPE_OBJECT_ParamTag, id);
spa_pod_builder_add(builder,
SPA_PARAM_TAG_direction, SPA_POD_Id(direction),
0);
}
static inline void
spa_tag_build_add_info(struct spa_pod_builder *builder, const struct spa_pod *info)
{
spa_pod_builder_add(builder,
SPA_PARAM_TAG_info, SPA_POD_Pod(info),
0);
}
static inline void
spa_tag_build_add_dict(struct spa_pod_builder *builder, const struct spa_dict *dict)
{
uint32_t i, n_items;
struct spa_pod_frame f;
n_items = dict ? dict->n_items : 0;
spa_pod_builder_prop(builder, SPA_PARAM_TAG_info, SPA_POD_PROP_FLAG_HINT_DICT);
spa_pod_builder_push_struct(builder, &f);
spa_pod_builder_int(builder, n_items);
for (i = 0; i < n_items; i++) {
spa_pod_builder_string(builder, dict->items[i].key);
spa_pod_builder_string(builder, dict->items[i].value);
}
spa_pod_builder_pop(builder, &f);
}
static inline struct spa_pod *
spa_tag_build_end(struct spa_pod_builder *builder, struct spa_pod_frame *f)
{
return (struct spa_pod*)spa_pod_builder_pop(builder, f);
}
#ifdef __cplusplus
} /* extern "C" */
#endif
#endif /* SPA_PARAM_TAG_UTILS_H */
builder.h
spa/pod/builder.h
spa_tag_build_add_info
static void spa_tag_build_add_info(struct spa_pod_builder *builder, const struct spa_pod *info)
Definition tag-utils.h:109
spa_tag_build_add_dict
static void spa_tag_build_add_dict(struct spa_pod_builder *builder, const struct spa_dict *dict)
Definition tag-utils.h:117
spa_tag_compare
static int spa_tag_compare(const struct spa_pod *a, const struct spa_pod *b)
Definition tag-utils.h:30
spa_tag_parse
static int spa_tag_parse(const struct spa_pod *tag, struct spa_tag_info *info, void **state)
Definition tag-utils.h:37
spa_tag_info_parse
static int spa_tag_info_parse(const struct spa_tag_info *info, struct spa_dict *dict, struct spa_dict_item *items)
Definition tag-utils.h:66
spa_tag_build_start
static void spa_tag_build_start(struct spa_pod_builder *builder, struct spa_pod_frame *f, uint32_t id, enum spa_direction direction)
Definition tag-utils.h:99
spa_tag_build_end
static struct spa_pod * spa_tag_build_end(struct spa_pod_builder *builder, struct spa_pod_frame *f)
Definition tag-utils.h:135
SPA_PARAM_TAG_direction
@ SPA_PARAM_TAG_direction
direction, input/output (Id enum spa_direction)
Definition tag.h:27
SPA_PARAM_TAG_info
@ SPA_PARAM_TAG_info
Struct( Int: n_items (String: key ...
Definition tag.h:28
spa_pod_builder_prop
static int spa_pod_builder_prop(struct spa_pod_builder *builder, uint32_t key, uint32_t flags)
Definition builder.h:450
spa_pod_parser_pod
static void spa_pod_parser_pod(struct spa_pod_parser *parser, const struct spa_pod *pod)
Definition parser.h:50
SPA_POD_String
#define SPA_POD_String(val)
Definition vararg.h:94
spa_pod_builder_string
static int spa_pod_builder_string(struct spa_pod_builder *builder, const char *str)
Definition builder.h:305
spa_pod_parser_get
static int spa_pod_parser_get(struct spa_pod_parser *parser,...)
Definition parser.h:505
spa_pod_builder_add
static int spa_pod_builder_add(struct spa_pod_builder *builder,...)
Definition builder.h:647
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:49
spa_pod_parser_get_int
static int spa_pod_parser_get_int(struct spa_pod_parser *parser, int32_t *value)
Definition parser.h:148
spa_pod_builder_pop
static void * spa_pod_builder_pop(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:168
spa_pod_parser_push_struct
static int spa_pod_parser_push_struct(struct spa_pod_parser *parser, struct spa_pod_frame *frame)
Definition parser.h:247
spa_pod_builder_push_struct
static int spa_pod_builder_push_struct(struct spa_pod_builder *builder, struct spa_pod_frame *frame)
Definition builder.h:422
spa_pod_prop_next
static struct spa_pod_prop * spa_pod_prop_next(const struct spa_pod_prop *iter)
Definition iter.h:57
spa_pod_builder_int
static int spa_pod_builder_int(struct spa_pod_builder *builder, int32_t val)
Definition builder.h:247
spa_pod_builder_push_object
static int spa_pod_builder_push_object(struct spa_pod_builder *builder, struct spa_pod_frame *frame, uint32_t type, uint32_t id)
Definition builder.h:435
SPA_POD_PROP_FLAG_HINT_DICT
#define SPA_POD_PROP_FLAG_HINT_DICT
contains a dictionary struct as (Struct( Int : n_items,...
Definition pod.h:216
spa_pod_prop_first
static struct spa_pod_prop * spa_pod_prop_first(const struct spa_pod_object_body *body)
Definition iter.h:45
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition parser.h:576
SPA_POD_Pod
#define SPA_POD_Pod(val)
Definition vararg.h:128
SPA_POD_SIZE
#define SPA_POD_SIZE(pod)
Definition pod.h:30
spa_pod_parser_pop
static int spa_pod_parser_pop(struct spa_pod_parser *parser, struct spa_pod_frame *frame)
Definition parser.h:122
spa_pod_prop_is_inside
static bool spa_pod_prop_is_inside(const struct spa_pod_object_body *body, uint32_t size, const struct spa_pod_prop *iter)
Definition iter.h:50
SPA_TYPE_OBJECT_ParamTag
@ SPA_TYPE_OBJECT_ParamTag
Definition type.h:86
SPA_MIN
#define SPA_MIN(a, b)
Definition defs.h:151
spa_zero
#define spa_zero(x)
Definition defs.h:421
spa_direction
spa_direction
Definition defs.h:92
parser.h
spa/pod/parser.h
spa_dict_item
Definition dict.h:31
spa_dict_item::key
const char * key
Definition dict.h:32
spa_dict_item::value
const char * value
Definition dict.h:33
spa_dict
Definition dict.h:39
spa_dict::items
const struct spa_dict_item * items
Definition dict.h:44
spa_dict::n_items
uint32_t n_items
Definition dict.h:43
spa_pod_builder
Definition builder.h:53
spa_pod_frame
Definition iter.h:27
spa_pod_object
Definition pod.h:183
spa_pod_object::pod
struct spa_pod pod
Definition pod.h:184
spa_pod_object::body
struct spa_pod_object_body body
Definition pod.h:185
spa_pod_parser
Definition parser.h:34
spa_pod_prop
Definition pod.h:208
spa_pod_prop::key
uint32_t key
key of property, list of valid keys depends on the object type
Definition pod.h:209
spa_pod_prop::value
struct spa_pod value
Definition pod.h:226
spa_pod
Definition pod.h:43
spa_pod::type
uint32_t type
Definition pod.h:45
spa_pod::size
uint32_t size
Definition pod.h:44
spa_tag_info
helper structure for managing tag objects
Definition tag.h:36
spa_tag_info::direction
enum spa_direction direction
Definition tag.h:37
spa_tag_info::info
const struct spa_pod * info
Definition tag.h:38
tag.h
spa/param/tag.h
dict.h
spa/utils/dict.h