PipeWire 0.3.65
debug/pod.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2018 Wim Taymans
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 */
24
25#ifndef SPA_DEBUG_POD_H
26#define SPA_DEBUG_POD_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/debug/context.h>
38#include <spa/debug/mem.h>
39#include <spa/debug/types.h>
40#include <spa/pod/pod.h>
41#include <spa/pod/iter.h>
42
43static inline int
44spa_debugc_pod_value(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info,
45 uint32_t type, void *body, uint32_t size)
46{
47 switch (type) {
48 case SPA_TYPE_Bool:
49 spa_debugc(ctx, "%*s" "Bool %s", indent, "", (*(int32_t *) body) ? "true" : "false");
50 break;
51 case SPA_TYPE_Id:
52 spa_debugc(ctx, "%*s" "Id %-8d (%s)", indent, "", *(int32_t *) body,
53 spa_debug_type_find_name(info, *(int32_t *) body));
54 break;
55 case SPA_TYPE_Int:
56 spa_debugc(ctx, "%*s" "Int %d", indent, "", *(int32_t *) body);
57 break;
58 case SPA_TYPE_Long:
59 spa_debugc(ctx, "%*s" "Long %" PRIi64 "", indent, "", *(int64_t *) body);
60 break;
61 case SPA_TYPE_Float:
62 spa_debugc(ctx, "%*s" "Float %f", indent, "", *(float *) body);
63 break;
64 case SPA_TYPE_Double:
65 spa_debugc(ctx, "%*s" "Double %f", indent, "", *(double *) body);
66 break;
67 case SPA_TYPE_String:
68 spa_debugc(ctx, "%*s" "String \"%s\"", indent, "", (char *) body);
69 break;
70 case SPA_TYPE_Fd:
71 spa_debugc(ctx, "%*s" "Fd %d", indent, "", *(int *) body);
72 break;
74 {
75 struct spa_pod_pointer_body *b = (struct spa_pod_pointer_body *)body;
76 spa_debugc(ctx, "%*s" "Pointer %s %p", indent, "",
78 break;
79 }
81 {
82 struct spa_rectangle *r = (struct spa_rectangle *)body;
83 spa_debugc(ctx, "%*s" "Rectangle %dx%d", indent, "", r->width, r->height);
84 break;
85 }
87 {
88 struct spa_fraction *f = (struct spa_fraction *)body;
89 spa_debugc(ctx, "%*s" "Fraction %d/%d", indent, "", f->num, f->denom);
90 break;
91 }
92 case SPA_TYPE_Bitmap:
93 spa_debugc(ctx, "%*s" "Bitmap", indent, "");
94 break;
95 case SPA_TYPE_Array:
96 {
97 struct spa_pod_array_body *b = (struct spa_pod_array_body *)body;
98 void *p;
100
101 spa_debugc(ctx, "%*s" "Array: child.size %d, child.type %s", indent, "",
102 b->child.size, ti ? ti->name : "unknown");
103
104 info = info && info->values ? info->values : info;
106 spa_debugc_pod_value(ctx, indent + 2, info, b->child.type, p, b->child.size);
107 break;
108 }
109 case SPA_TYPE_Choice:
110 {
111 struct spa_pod_choice_body *b = (struct spa_pod_choice_body *)body;
112 void *p;
113 const struct spa_type_info *ti = spa_debug_type_find(spa_type_choice, b->type);
114
115 spa_debugc(ctx, "%*s" "Choice: type %s, flags %08x %d %d", indent, "",
116 ti ? ti->name : "unknown", b->flags, size, b->child.size);
117
119 spa_debugc_pod_value(ctx, indent + 2, info, b->child.type, p, b->child.size);
120 break;
121 }
122 case SPA_TYPE_Struct:
123 {
124 struct spa_pod *b = (struct spa_pod *)body, *p;
125 spa_debugc(ctx, "%*s" "Struct: size %d", indent, "", size);
126 SPA_POD_FOREACH(b, size, p)
127 spa_debugc_pod_value(ctx, indent + 2, info, p->type, SPA_POD_BODY(p), p->size);
128 break;
129 }
130 case SPA_TYPE_Object:
131 {
132 struct spa_pod_object_body *b = (struct spa_pod_object_body *)body;
133 struct spa_pod_prop *p;
134 const struct spa_type_info *ti, *ii;
135
136 ti = spa_debug_type_find(info, b->type);
137 ii = ti ? spa_debug_type_find(ti->values, 0) : NULL;
138 ii = ii ? spa_debug_type_find(ii->values, b->id) : NULL;
139
140 spa_debugc(ctx, "%*s" "Object: size %d, type %s (%d), id %s (%d)", indent, "", size,
141 ti ? ti->name : "unknown", b->type, ii ? ii->name : "unknown", b->id);
142
143 info = ti ? ti->values : info;
144
145 SPA_POD_OBJECT_BODY_FOREACH(b, size, p) {
146 ii = spa_debug_type_find(info, p->key);
147
148 spa_debugc(ctx, "%*s" "Prop: key %s (%d), flags %08x", indent+2, "",
149 ii ? ii->name : "unknown", p->key, p->flags);
150
151 spa_debugc_pod_value(ctx, indent + 4, ii ? ii->values : NULL,
152 p->value.type,
154 p->value.size);
155 }
156 break;
157 }
159 {
160 struct spa_pod_sequence_body *b = (struct spa_pod_sequence_body *)body;
161 const struct spa_type_info *ti, *ii;
162 struct spa_pod_control *c;
163
164 ti = spa_debug_type_find(info, b->unit);
165
166 spa_debugc(ctx, "%*s" "Sequence: size %d, unit %s", indent, "", size,
167 ti ? ti->name : "unknown");
168
171
172 spa_debugc(ctx, "%*s" "Control: offset %d, type %s", indent+2, "",
173 c->offset, ii ? ii->name : "unknown");
174
175 spa_debugc_pod_value(ctx, indent + 4, ii ? ii->values : NULL,
176 c->value.type,
178 c->value.size);
179 }
180 break;
181 }
182 case SPA_TYPE_Bytes:
183 spa_debugc(ctx, "%*s" "Bytes", indent, "");
184 spa_debugc_mem(ctx, indent + 2, body, size);
185 break;
186 case SPA_TYPE_None:
187 spa_debugc(ctx, "%*s" "None", indent, "");
188 spa_debugc_mem(ctx, indent + 2, body, size);
189 break;
190 default:
191 spa_debugc(ctx, "%*s" "unhandled POD type %d", indent, "", type);
192 break;
193 }
194 return 0;
195}
196
197static inline int spa_debugc_pod(struct spa_debug_context *ctx, int indent,
198 const struct spa_type_info *info, const struct spa_pod *pod)
199{
200 return spa_debugc_pod_value(ctx, indent, info ? info : SPA_TYPE_ROOT,
201 SPA_POD_TYPE(pod),
203 SPA_POD_BODY_SIZE(pod));
204}
205
206static inline int
207spa_debug_pod_value(int indent, const struct spa_type_info *info,
208 uint32_t type, void *body, uint32_t size)
209{
210 return spa_debugc_pod_value(NULL, indent, info, type, body, size);
211}
213static inline int spa_debug_pod(int indent,
214 const struct spa_type_info *info, const struct spa_pod *pod)
215{
216 return spa_debugc_pod(NULL, indent, info, pod);
217}
223#ifdef __cplusplus
224} /* extern "C" */
225#endif
226
227#endif /* SPA_DEBUG_POD_H */
static const struct spa_type_info spa_type_control[]
Definition: control/type-info.h:52
static int spa_debugc_pod(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info, const struct spa_pod *pod)
Definition: debug/pod.h:202
#define spa_debugc(_c, _fmt,...)
Definition: spa/include/spa/debug/context.h:57
static int spa_debug_pod(int indent, const struct spa_type_info *info, const struct spa_pod *pod)
Definition: debug/pod.h:218
static const struct spa_type_info * spa_debug_type_find(const struct spa_type_info *info, uint32_t type)
Definition: types.h:46
static const char * spa_debug_type_find_name(const struct spa_type_info *info, uint32_t type)
Definition: types.h:73
static int spa_debug_pod_value(int indent, const struct spa_type_info *info, uint32_t type, void *body, uint32_t size)
Definition: debug/pod.h:212
static 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: debug/pod.h:49
static int spa_debugc_mem(struct spa_debug_context *ctx, int indent, const void *data, size_t size)
Definition: spa/include/spa/debug/mem.h:46
#define SPA_POD_OBJECT_BODY_FOREACH(body, size, iter)
Definition: iter.h:123
#define SPA_POD_CHOICE_BODY_FOREACH(body, _size, iter)
Definition: iter.h:107
#define SPA_POD_BODY(pod)
Definition: pod/pod.h:59
#define SPA_POD_TYPE(pod)
Definition: pod/pod.h:48
#define SPA_POD_BODY_SIZE(pod)
Definition: pod/pod.h:46
#define SPA_POD_FOREACH(pod, size, iter)
Definition: iter.h:115
#define SPA_POD_CONTENTS(type, pod)
Definition: pod/pod.h:55
#define SPA_POD_SEQUENCE_BODY_FOREACH(body, size, iter)
Definition: iter.h:131
#define SPA_POD_ARRAY_BODY_FOREACH(body, _size, iter)
Definition: iter.h:99
#define SPA_TYPE_ROOT
Definition: utils/type-info.h:46
@ SPA_TYPE_Int
Definition: spa/include/spa/utils/type.h:54
@ SPA_TYPE_Rectangle
Definition: spa/include/spa/utils/type.h:60
@ SPA_TYPE_Long
Definition: spa/include/spa/utils/type.h:55
@ SPA_TYPE_Bool
Definition: spa/include/spa/utils/type.h:52
@ SPA_TYPE_Bytes
Definition: spa/include/spa/utils/type.h:59
@ SPA_TYPE_Bitmap
Definition: spa/include/spa/utils/type.h:62
@ SPA_TYPE_Object
Definition: spa/include/spa/utils/type.h:65
@ SPA_TYPE_Float
Definition: spa/include/spa/utils/type.h:56
@ SPA_TYPE_Fraction
Definition: spa/include/spa/utils/type.h:61
@ SPA_TYPE_None
Definition: spa/include/spa/utils/type.h:51
@ SPA_TYPE_Sequence
Definition: spa/include/spa/utils/type.h:66
@ SPA_TYPE_Double
Definition: spa/include/spa/utils/type.h:57
@ SPA_TYPE_Id
Definition: spa/include/spa/utils/type.h:53
@ SPA_TYPE_Choice
Definition: spa/include/spa/utils/type.h:69
@ SPA_TYPE_Pointer
Definition: spa/include/spa/utils/type.h:67
@ SPA_TYPE_Array
Definition: spa/include/spa/utils/type.h:63
@ SPA_TYPE_String
Definition: spa/include/spa/utils/type.h:58
@ SPA_TYPE_Fd
Definition: spa/include/spa/utils/type.h:68
@ SPA_TYPE_Struct
Definition: spa/include/spa/utils/type.h:64
spa/pod/iter.h
spa/pod/pod.h
spa/debug/context.h
spa/debug/mem.h
Definition: spa/include/spa/debug/context.h:53
Definition: defs.h:139
uint32_t num
Definition: defs.h:140
uint32_t denom
Definition: defs.h:141
Definition: pod/pod.h:141
struct spa_pod child
Definition: pod/pod.h:142
Definition: pod/pod.h:174
struct spa_pod child
Definition: pod/pod.h:177
uint32_t type
type of choice, one of enum spa_choice_type
Definition: pod/pod.h:175
uint32_t flags
extra flags
Definition: pod/pod.h:176
Definition: pod/pod.h:254
struct spa_pod value
control value, depends on type
Definition: pod/pod.h:257
uint32_t type
type of control, enum spa_control_type
Definition: pod/pod.h:256
uint32_t offset
media offset
Definition: pod/pod.h:255
Definition: pod/pod.h:197
uint32_t type
one of enum spa_type
Definition: pod/pod.h:198
uint32_t id
id of the object, depends on the object type
Definition: pod/pod.h:199
Definition: pod/pod.h:208
const void * value
Definition: pod/pod.h:211
uint32_t type
pointer id, one of enum spa_type
Definition: pod/pod.h:209
Definition: pod/pod.h:228
uint32_t key
key of property, list of valid keys depends on the object type
Definition: pod/pod.h:229
uint32_t flags
flags for property
Definition: pod/pod.h:245
struct spa_pod value
Definition: pod/pod.h:246
Definition: pod/pod.h:261
uint32_t unit
Definition: pod/pod.h:262
Definition: pod/pod.h:63
uint32_t type
Definition: pod/pod.h:65
uint32_t size
Definition: pod/pod.h:64
Definition: defs.h:118
uint32_t width
Definition: defs.h:119
uint32_t height
Definition: defs.h:120
Definition: spa/include/spa/utils/type.h:162
const struct spa_type_info * values
Definition: spa/include/spa/utils/type.h:166
spa/debug/types.h