PipeWire 1.4.5 |

Loading...
Searching...
No Matches
pod.h
Go to the documentation of this file.
1/* Simple Plugin API */
2/* SPDX-FileCopyrightText: Copyright © 2018 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef SPA_DEBUG_POD_H
6#define SPA_DEBUG_POD_H
7
8#ifdef __cplusplus
9 extern "C" {
10#endif
11
16
17#include <spa/debug/context.h>
18#include <spa/debug/mem.h>
19#include <spa/debug/types.h>
20#include <spa/pod/pod.h>
21#include <spa/pod/iter.h>
22
23#ifndef SPA_API_DEBUG_POD
24 #ifdef SPA_API_IMPL
25 #define SPA_API_DEBUG_POD SPA_API_IMPL
26 #else
27 #define SPA_API_DEBUG_POD static inline
28 #endif
29#endif
30
31 SPA_API_DEBUG_POD int
32 spa_debugc_pod_value(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info,
33 uint32_t type, void *body, uint32_t size)
34{
35 switch (type) {
36 case SPA_TYPE_Bool:
37 spa_debugc(ctx, "%*s" "Bool %s", indent, "", (*(int32_t *) body) ? "true" : "false");
38 break;
39 case SPA_TYPE_Id:
40 spa_debugc(ctx, "%*s" "Id %-8d (%s)", indent, "", *(int32_t *) body,
41 spa_debug_type_find_name(info, *(int32_t *) body));
42 break;
43 case SPA_TYPE_Int:
44 spa_debugc(ctx, "%*s" "Int %d", indent, "", *(int32_t *) body);
45 break;
46 case SPA_TYPE_Long:
47 spa_debugc(ctx, "%*s" "Long %" PRIi64 "", indent, "", *(int64_t *) body);
48 break;
49 case SPA_TYPE_Float:
50 spa_debugc(ctx, "%*s" "Float %f", indent, "", *(float *) body);
51 break;
52 case SPA_TYPE_Double:
53 spa_debugc(ctx, "%*s" "Double %f", indent, "", *(double *) body);
54 break;
55 case SPA_TYPE_String:
56 spa_debugc(ctx, "%*s" "String \"%s\"", indent, "", (char *) body);
57 break;
58 case SPA_TYPE_Fd:
59 spa_debugc(ctx, "%*s" "Fd %d", indent, "", *(int *) body);
60 break;
61 case SPA_TYPE_Pointer:
62 {
63 struct spa_pod_pointer_body *b = (struct spa_pod_pointer_body *)body;
64 spa_debugc(ctx, "%*s" "Pointer %s %p", indent, "",
65 spa_debug_type_find_name(SPA_TYPE_ROOT, b->type), b->value);
66 break;
67 }
68 case SPA_TYPE_Rectangle:
69 {
70 struct spa_rectangle *r = (struct spa_rectangle *)body;
71 spa_debugc(ctx, "%*s" "Rectangle %" PRIu32 "x%" PRIu32 "", indent, "", r->width, r->height);
72 break;
73 }
74 case SPA_TYPE_Fraction:
75 {
76 struct spa_fraction *f = (struct spa_fraction *)body;
77 spa_debugc(ctx, "%*s" "Fraction %" PRIu32 "/%" PRIu32 "", indent, "", f->num, f->denom);
78 break;
79 }
80 case SPA_TYPE_Bitmap:
81 spa_debugc(ctx, "%*s" "Bitmap", indent, "");
82 break;
83 case SPA_TYPE_Array:
84 {
85 struct spa_pod_array_body *b = (struct spa_pod_array_body *)body;
86 void *p;
87 const struct spa_type_info *ti = spa_debug_type_find(SPA_TYPE_ROOT, b->child.type);
88
89 spa_debugc(ctx, "%*s" "Array: child.size %d, child.type %s", indent, "",
90 b->child.size, ti ? ti->name : "unknown");
91
92 info = info && info->values ? info->values : info;
93 SPA_POD_ARRAY_BODY_FOREACH(b, size, p)
94 spa_debugc_pod_value(ctx, indent + 2, info, b->child.type, p, b->child.size);
95 break;
96 }
97 case SPA_TYPE_Choice:
98 {
99 struct spa_pod_choice_body *b = (struct spa_pod_choice_body *)body;
100 void *p;
101 const struct spa_type_info *ti = spa_debug_type_find(spa_type_choice, b->type);
102
103 spa_debugc(ctx, "%*s" "Choice: type %s, flags %08x %d %d", indent, "",
104 ti ? ti->name : "unknown", b->flags, size, b->child.size);
105
106 SPA_POD_CHOICE_BODY_FOREACH(b, size, p)
107 spa_debugc_pod_value(ctx, indent + 2, info, b->child.type, p, b->child.size);
108 break;
109 }
110 case SPA_TYPE_Struct:
111 {
112 struct spa_pod *b = (struct spa_pod *)body, *p;
113 spa_debugc(ctx, "%*s" "Struct: size %d", indent, "", size);
114 SPA_POD_FOREACH(b, size, p)
115 spa_debugc_pod_value(ctx, indent + 2, info, p->type, SPA_POD_BODY(p), p->size);
116 break;
117 }
118 case SPA_TYPE_Object:
119 {
120 struct spa_pod_object_body *b = (struct spa_pod_object_body *)body;
121 struct spa_pod_prop *p;
122 const struct spa_type_info *ti, *ii;
123
124 ti = spa_debug_type_find(info, b->type);
125 ii = ti ? spa_debug_type_find(ti->values, 0) : NULL;
126 ii = ii ? spa_debug_type_find(ii->values, b->id) : NULL;
127
128 spa_debugc(ctx, "%*s" "Object: size %d, type %s (%d), id %s (%d)", indent, "", size,
129 ti ? ti->name : "unknown", b->type, ii ? ii->name : "unknown", b->id);
130
131 info = ti ? ti->values : info;
132
133 SPA_POD_OBJECT_BODY_FOREACH(b, size, p) {
134 ii = spa_debug_type_find(info, p->key);
135
136 spa_debugc(ctx, "%*s" "Prop: key %s (%d), flags %08x", indent+2, "",
137 ii ? ii->name : "unknown", p->key, p->flags);
138
139 spa_debugc_pod_value(ctx, indent + 4, ii ? ii->values : NULL,
140 p->value.type,
141 SPA_POD_CONTENTS(struct spa_pod_prop, p),
142 p->value.size);
143 }
144 break;
145 }
146 case SPA_TYPE_Sequence:
147 {
148 struct spa_pod_sequence_body *b = (struct spa_pod_sequence_body *)body;
149 const struct spa_type_info *ti, *ii;
150 struct spa_pod_control *c;
151
152 ti = spa_debug_type_find(info, b->unit);
153
154 spa_debugc(ctx, "%*s" "Sequence: size %d, unit %s", indent, "", size,
155 ti ? ti->name : "unknown");
156
157 SPA_POD_SEQUENCE_BODY_FOREACH(b, size, c) {
158 ii = spa_debug_type_find(spa_type_control, c->type);
159
160 spa_debugc(ctx, "%*s" "Control: offset %d, type %s", indent+2, "",
161 c->offset, ii ? ii->name : "unknown");
162
163 spa_debugc_pod_value(ctx, indent + 4, ii ? ii->values : NULL,
164 c->value.type,
165 SPA_POD_CONTENTS(struct spa_pod_control, c),
166 c->value.size);
167 }
168 break;
169 }
170 case SPA_TYPE_Bytes:
171 spa_debugc(ctx, "%*s" "Bytes", indent, "");
172 spa_debugc_mem(ctx, indent + 2, body, size);
173 break;
174 case SPA_TYPE_None:
175 spa_debugc(ctx, "%*s" "None", indent, "");
176 spa_debugc_mem(ctx, indent + 2, body, size);
177 break;
178 default:
179 spa_debugc(ctx, "%*s" "unhandled POD type %d", indent, "", type);
180 break;
181 }
182 return 0;
183}
184
185 SPA_API_DEBUG_POD int spa_debugc_pod(struct spa_debug_context *ctx, int indent,
186 const struct spa_type_info *info, const struct spa_pod *pod)
187{
188 return spa_debugc_pod_value(ctx, indent, info ? info : SPA_TYPE_ROOT,
189 SPA_POD_TYPE(pod),
190 SPA_POD_BODY(pod),
191 SPA_POD_BODY_SIZE(pod));
192}
193
194 SPA_API_DEBUG_POD int
195 spa_debug_pod_value(int indent, const struct spa_type_info *info,
196 uint32_t type, void *body, uint32_t size)
197{
198 return spa_debugc_pod_value(NULL, indent, info, type, body, size);
199}
200
201 SPA_API_DEBUG_POD int spa_debug_pod(int indent,
202 const struct spa_type_info *info, const struct spa_pod *pod)
203{
204 return spa_debugc_pod(NULL, indent, info, pod);
205}
207
208 */
209
210
211#ifdef __cplusplus
212} /* extern "C" */
213#endif
214
215#endif /* SPA_DEBUG_POD_H */
r
uint32_t int int const char int r
Definition core.h:447
spa_type_control
static const struct spa_type_info spa_type_control[]
Definition type-info.h:32
spa_debugc_mem
SPA_API_DEBUG_MEM int spa_debugc_mem(struct spa_debug_context *ctx, int indent, const void *data, size_t size)
Definition mem.h:36
SPA_API_DEBUG_POD
#define SPA_API_DEBUG_POD
Definition pod.h:34
spa_debugc
#define spa_debugc(_c, _fmt,...)
Definition context.h:49
spa_debug_type_find
SPA_API_DEBUG_TYPES const struct spa_type_info * spa_debug_type_find(const struct spa_type_info *info, uint32_t type)
Definition types.h:37
spa_debug_pod_value
SPA_API_DEBUG_POD int spa_debug_pod_value(int indent, const struct spa_type_info *info, uint32_t type, void *body, uint32_t size)
Definition pod.h:202
spa_debug_pod
SPA_API_DEBUG_POD int spa_debug_pod(int indent, const struct spa_type_info *info, const struct spa_pod *pod)
Definition pod.h:208
spa_debugc_pod
SPA_API_DEBUG_POD int spa_debugc_pod(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info, const struct spa_pod *pod)
Definition pod.h:192
spa_debugc_pod_value
SPA_API_DEBUG_POD int spa_debugc_pod_value(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info, uint32_t type, void *body, uint32_t size)
Definition pod.h:39
spa_debug_type_find_name
SPA_API_DEBUG_TYPES const char * spa_debug_type_find_name(const struct spa_type_info *info, uint32_t type)
Definition types.h:61
SPA_POD_OBJECT_BODY_FOREACH
#define SPA_POD_OBJECT_BODY_FOREACH(body, size, iter)
Definition iter.h:119
SPA_POD_CHOICE_BODY_FOREACH
#define SPA_POD_CHOICE_BODY_FOREACH(body, _size, iter)
Definition iter.h:103
SPA_POD_BODY
#define SPA_POD_BODY(pod)
Definition pod.h:39
SPA_POD_TYPE
#define SPA_POD_TYPE(pod)
Definition pod.h:28
SPA_POD_BODY_SIZE
#define SPA_POD_BODY_SIZE(pod)
Definition pod.h:26
SPA_POD_FOREACH
#define SPA_POD_FOREACH(pod, size, iter)
Definition iter.h:111
SPA_POD_CONTENTS
#define SPA_POD_CONTENTS(type, pod)
Definition pod.h:35
SPA_POD_SEQUENCE_BODY_FOREACH
#define SPA_POD_SEQUENCE_BODY_FOREACH(body, size, iter)
Definition iter.h:127
SPA_POD_ARRAY_BODY_FOREACH
#define SPA_POD_ARRAY_BODY_FOREACH(body, _size, iter)
Definition iter.h:95
spa_type_choice
static const struct spa_type_info spa_type_choice[]
Definition enum-types.h:41
SPA_TYPE_ROOT
#define SPA_TYPE_ROOT
Definition type-info.h:26
SPA_TYPE_Int
@ SPA_TYPE_Int
Definition type.h:45
SPA_TYPE_Rectangle
@ SPA_TYPE_Rectangle
Definition type.h:51
SPA_TYPE_Long
@ SPA_TYPE_Long
Definition type.h:46
SPA_TYPE_Bool
@ SPA_TYPE_Bool
Definition type.h:43
SPA_TYPE_Bytes
@ SPA_TYPE_Bytes
Definition type.h:50
SPA_TYPE_Bitmap
@ SPA_TYPE_Bitmap
Definition type.h:53
SPA_TYPE_Object
@ SPA_TYPE_Object
Definition type.h:56
SPA_TYPE_Float
@ SPA_TYPE_Float
Definition type.h:47
SPA_TYPE_Fraction
@ SPA_TYPE_Fraction
Definition type.h:52
SPA_TYPE_None
@ SPA_TYPE_None
Definition type.h:42
SPA_TYPE_Sequence
@ SPA_TYPE_Sequence
Definition type.h:57
SPA_TYPE_Double
@ SPA_TYPE_Double
Definition type.h:48
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition type.h:44
SPA_TYPE_Choice
@ SPA_TYPE_Choice
Definition type.h:60
SPA_TYPE_Pointer
@ SPA_TYPE_Pointer
Definition type.h:58
SPA_TYPE_Array
@ SPA_TYPE_Array
Definition type.h:54
SPA_TYPE_String
@ SPA_TYPE_String
Definition type.h:49
SPA_TYPE_Fd
@ SPA_TYPE_Fd
Definition type.h:59
SPA_TYPE_Struct
@ SPA_TYPE_Struct
Definition type.h:55
iter.h
spa/pod/iter.h
pod.h
spa/pod/pod.h
context.h
spa/debug/context.h
mem.h
spa/debug/mem.h
spa_debug_context
Definition context.h:45
spa_fraction
Definition defs.h:137
spa_fraction::num
uint32_t num
Definition defs.h:138
spa_fraction::denom
uint32_t denom
Definition defs.h:139
spa_pod_array_body
Definition pod.h:121
spa_pod_array_body::child
struct spa_pod child
Definition pod.h:122
spa_pod_choice_body
Definition pod.h:154
spa_pod_choice_body::child
struct spa_pod child
Definition pod.h:157
spa_pod_choice_body::type
uint32_t type
type of choice, one of enum spa_choice_type
Definition pod.h:155
spa_pod_choice_body::flags
uint32_t flags
extra flags
Definition pod.h:156
spa_pod_control
Definition pod.h:234
spa_pod_control::value
struct spa_pod value
control value, depends on type
Definition pod.h:237
spa_pod_control::type
uint32_t type
type of control, enum spa_control_type
Definition pod.h:236
spa_pod_control::offset
uint32_t offset
media offset
Definition pod.h:235
spa_pod_object_body
Definition pod.h:177
spa_pod_object_body::type
uint32_t type
one of enum spa_type
Definition pod.h:178
spa_pod_object_body::id
uint32_t id
id of the object, depends on the object type
Definition pod.h:179
spa_pod_pointer_body
Definition pod.h:188
spa_pod_pointer_body::value
const void * value
Definition pod.h:191
spa_pod_pointer_body::type
uint32_t type
pointer id, one of enum spa_type
Definition pod.h:189
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::flags
uint32_t flags
flags for property
Definition pod.h:225
spa_pod_prop::value
struct spa_pod value
Definition pod.h:226
spa_pod_sequence_body
Definition pod.h:241
spa_pod_sequence_body::unit
uint32_t unit
Definition pod.h:242
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_rectangle
Definition defs.h:116
spa_type_info
Definition type.h:154
spa_type_info::values
const struct spa_type_info * values
Definition type.h:158
types.h
spa/debug/types.h