PipeWire: spa/debug/format.h Source File

PipeWire 1.6.8

Loading...
Searching...
No Matches
format.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_FORMAT_H
6#define SPA_DEBUG_FORMAT_H
7
8#include <inttypes.h>
9
10#include <spa/pod/iter.h>
11#include <spa/utils/string.h>
12#include <spa/debug/context.h>
13#include <spa/debug/types.h>
14#include <spa/param/type-info.h>
15#include <spa/param/format-utils.h>
16
17#ifdef __cplusplus
18extern "C" {
19#endif
20
25
26#ifndef SPA_API_DEBUG_FORMAT
27 #ifdef SPA_API_IMPL
28 #define SPA_API_DEBUG_FORMAT SPA_API_IMPL
29 #else
30 #define SPA_API_DEBUG_FORMAT static inline
31 #endif
32#endif
33
34
35 SPA_API_DEBUG_FORMAT int
36 spa_debug_strbuf_format_value(struct spa_strbuf *buffer, const struct spa_type_info *info,
37 uint32_t type, void *body, uint32_t size)
38{
39
40 switch (type) {
41 case SPA_TYPE_Bool:
42 spa_strbuf_append(buffer, "%s", *(int32_t *) body ? "true" : "false");
43 break;
44 case SPA_TYPE_Id:
45 {
46 uint32_t value = *(uint32_t *) body;
47 const char *str = spa_debug_type_find_short_name(info, value);
48 char tmp[64];
49 if (str == NULL) {
50 snprintf(tmp, sizeof(tmp), "%" PRIu32, value);
51 str = tmp;
52 }
53 spa_strbuf_append(buffer, "%s", str);
54 break;
55 }
56 case SPA_TYPE_Int:
57 spa_strbuf_append(buffer, "%d", *(int32_t *) body);
58 break;
59 case SPA_TYPE_Long:
60 spa_strbuf_append(buffer, "%" PRIi64, *(int64_t *) body);
61 break;
62 case SPA_TYPE_Float:
63 spa_strbuf_append(buffer, "%f", *(float *) body);
64 break;
65 case SPA_TYPE_Double:
66 spa_strbuf_append(buffer, "%f", *(double *) body);
67 break;
68 case SPA_TYPE_String:
69 spa_strbuf_append(buffer, "%-*s", size, (char *) body);
70 break;
71 case SPA_TYPE_Rectangle:
72 {
73 struct spa_rectangle *r = (struct spa_rectangle *)body;
74 spa_strbuf_append(buffer, "%" PRIu32 "x%" PRIu32, r->width, r->height);
75 break;
76 }
77 case SPA_TYPE_Fraction:
78 {
79 struct spa_fraction *f = (struct spa_fraction *)body;
80 spa_strbuf_append(buffer, "%" PRIu32 "/%" PRIu32, f->num, f->denom);
81 break;
82 }
83 case SPA_TYPE_Bitmap:
84 spa_strbuf_append(buffer, "Bitmap");
85 break;
86 case SPA_TYPE_Bytes:
87 spa_strbuf_append(buffer, "Bytes");
88 break;
89 case SPA_TYPE_Array:
90 {
91 void *p;
92 struct spa_pod_array_body *b = (struct spa_pod_array_body *)body;
93 int i = 0;
94 info = info && info->values ? info->values : info;
95 spa_strbuf_append(buffer, "< ");
96 if (b->child.size >= spa_pod_type_size(b->child.type)) {
97 SPA_POD_ARRAY_BODY_FOREACH(b, size, p) {
98 if (i++ > 0)
99 spa_strbuf_append(buffer, ", ");
100 spa_debug_strbuf_format_value(buffer, info, b->child.type, p, b->child.size);
101 }
102 }
103 spa_strbuf_append(buffer, " >");
104 break;
105 }
106 default:
107 spa_strbuf_append(buffer, "INVALID type %d", type);
108 break;
109 }
110 return 0;
111}
112
113 SPA_API_DEBUG_FORMAT int
114 spa_debug_format_value(const struct spa_type_info *info,
115 uint32_t type, void *body, uint32_t size)
116{
117 char buffer[1024];
118 struct spa_strbuf buf;
119 spa_strbuf_init(&buf, buffer, sizeof(buffer));
120 spa_debug_strbuf_format_value(&buf, info, type, body, size);
121 spa_debugn("%s", buffer);
122 return 0;
123}
124
125 SPA_API_DEBUG_FORMAT int spa_debugc_format(struct spa_debug_context *ctx, int indent,
126 const struct spa_type_info *info, const struct spa_pod *format)
127{
128 const char *media_type;
129 const char *media_subtype;
130 struct spa_pod_prop *prop;
131 uint32_t mtype, mstype;
132
133 if (info == NULL)
134 info = spa_type_format;
135
136 if (format == NULL || format->type != SPA_TYPE_Object)
137 return -EINVAL;
138
139 if (spa_format_parse(format, &mtype, &mstype) < 0)
140 return -EINVAL;
141
142 media_type = spa_debug_type_find_name(spa_type_media_type, mtype);
143 media_subtype = spa_debug_type_find_name(spa_type_media_subtype, mstype);
144
145 spa_debugc(ctx, "%*s %s/%s", indent, "",
146 media_type ? spa_debug_type_short_name(media_type) : "unknown",
147 media_subtype ? spa_debug_type_short_name(media_subtype) : "unknown");
148
149 SPA_POD_OBJECT_FOREACH((struct spa_pod_object*)format, prop) {
150 const char *key;
151 const struct spa_type_info *ti;
152 uint32_t i, type, size, n_vals, choice;
153 const struct spa_pod *val;
154 void *vals;
155 char buffer[1024];
156 struct spa_strbuf buf;
157
158 if (prop->key == SPA_FORMAT_mediaType ||
159 prop->key == SPA_FORMAT_mediaSubtype)
160 continue;
161
162 val = spa_pod_get_values(&prop->value, &n_vals, &choice);
163
164 type = val->type;
165 size = val->size;
166
167 if (type < SPA_TYPE_None || type >= _SPA_TYPE_LAST || n_vals < 1)
168 continue;
169
170 vals = SPA_POD_BODY(val);
171 ti = spa_debug_type_find(info, prop->key);
172 key = ti ? ti->name : NULL;
173
174 spa_strbuf_init(&buf, buffer, sizeof(buffer));
175 spa_strbuf_append(&buf, "%*s %16s : (%s) ", indent, "",
176 key ? spa_debug_type_short_name(key) : "unknown",
177 spa_debug_type_short_name(spa_types[type].name));
178
179 if (choice == SPA_CHOICE_None) {
180 spa_debug_strbuf_format_value(&buf, ti ? ti->values : NULL, type, vals, size);
181 } else {
182 const char *ssep, *esep, *sep;
183
184 switch (choice) {
185 case SPA_CHOICE_Range:
186 case SPA_CHOICE_Step:
187 ssep = "[ ";
188 sep = ", ";
189 esep = " ]";
190 break;
191 default:
192 case SPA_CHOICE_Enum:
193 case SPA_CHOICE_Flags:
194 ssep = "{ ";
195 sep = ", ";
196 esep = " }";
197 break;
198 }
199
200 spa_strbuf_append(&buf, "%s", ssep);
201
202 for (i = 1; i < n_vals; i++) {
203 vals = SPA_PTROFF(vals, size, void);
204 if (i > 1)
205 spa_strbuf_append(&buf, "%s", sep);
206 spa_debug_strbuf_format_value(&buf, ti ? ti->values : NULL, type, vals, size);
207 }
208 spa_strbuf_append(&buf, "%s", esep);
209 }
210 spa_debugc(ctx, "%s", buffer);
211 }
212 return 0;
213}
214
215 SPA_API_DEBUG_FORMAT int spa_debug_format(int indent,
216 const struct spa_type_info *info, const struct spa_pod *format)
217{
218 return spa_debugc_format(NULL, indent, info, format);
219}
221
222 */
223
224#ifdef __cplusplus
225} /* extern "C" */
226#endif
227
228#endif /* SPA_DEBUG_FORMAT_H */
format-utils.h
r
uint32_t int int const char int r
Definition core.h:447
spa_debug_type_find_short_name
SPA_API_DEBUG_TYPES const char * spa_debug_type_find_short_name(const struct spa_type_info *info, uint32_t type)
Definition types.h:68
spa_debugn
#define spa_debugn(_fmt,...)
Definition context.h:29
spa_debugc
#define spa_debugc(_c, _fmt,...)
Definition context.h:50
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_format
SPA_API_DEBUG_FORMAT int spa_debug_format(int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition format.h:222
spa_debug_format_value
SPA_API_DEBUG_FORMAT int spa_debug_format_value(const struct spa_type_info *info, uint32_t type, void *body, uint32_t size)
Definition format.h:121
spa_debug_strbuf_format_value
SPA_API_DEBUG_FORMAT int spa_debug_strbuf_format_value(struct spa_strbuf *buffer, const struct spa_type_info *info, uint32_t type, void *body, uint32_t size)
Definition format.h:43
SPA_API_DEBUG_FORMAT
#define SPA_API_DEBUG_FORMAT
Definition format.h:37
spa_debugc_format
SPA_API_DEBUG_FORMAT int spa_debugc_format(struct spa_debug_context *ctx, int indent, const struct spa_type_info *info, const struct spa_pod *format)
Definition format.h:132
spa_debug_type_short_name
SPA_API_DEBUG_TYPES const char * spa_debug_type_short_name(const char *name)
Definition types.h:56
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_type_media_subtype
static const struct spa_type_info spa_type_media_subtype[]
Definition format-types.h:55
spa_type_format
static const struct spa_type_info spa_type_format[]
Definition format-types.h:148
spa_format_parse
SPA_API_FORMAT_UTILS int spa_format_parse(const struct spa_pod *format, uint32_t *media_type, uint32_t *media_subtype)
Definition format-utils.h:37
spa_type_media_type
static const struct spa_type_info spa_type_media_type[]
Definition format-types.h:39
SPA_FORMAT_mediaType
@ SPA_FORMAT_mediaType
media type (Id enum spa_media_type)
Definition format.h:99
SPA_FORMAT_mediaSubtype
@ SPA_FORMAT_mediaSubtype
media subtype (Id enum spa_media_subtype)
Definition format.h:100
spa_pod_get_values
SPA_API_POD_ITER struct spa_pod * spa_pod_get_values(const struct spa_pod *pod, uint32_t *n_vals, uint32_t *choice)
Definition iter.h:229
SPA_POD_OBJECT_FOREACH
#define SPA_POD_OBJECT_FOREACH(obj, iter)
Definition iter.h:118
SPA_POD_BODY
#define SPA_POD_BODY(pod)
Definition pod.h:44
spa_pod_type_size
SPA_API_POD_BODY uint32_t spa_pod_type_size(uint32_t type)
Definition body.h:45
SPA_POD_ARRAY_BODY_FOREACH
#define SPA_POD_ARRAY_BODY_FOREACH(body, _size, iter)
Definition iter.h:89
SPA_CHOICE_Step
@ SPA_CHOICE_Step
range with step: default, min, max, step
Definition pod.h:163
SPA_CHOICE_None
@ SPA_CHOICE_None
no choice, first value is current
Definition pod.h:161
SPA_CHOICE_Flags
@ SPA_CHOICE_Flags
flags: first value is flags
Definition pod.h:165
SPA_CHOICE_Range
@ SPA_CHOICE_Range
range: default, min, max
Definition pod.h:162
SPA_CHOICE_Enum
@ SPA_CHOICE_Enum
list: default, alternative,...
Definition pod.h:164
spa_strbuf_append
SPA_API_STRING int spa_strbuf_append(struct spa_strbuf *buf, const char *fmt,...)
Definition string.h:391
spa_strbuf_init
SPA_API_STRING void spa_strbuf_init(struct spa_strbuf *buf, char *buffer, size_t maxsize)
Definition string.h:381
spa_types
static const struct spa_type_info spa_types[]
Definition type-info.h:37
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_LAST
@ _SPA_TYPE_LAST
not part of ABI
Definition type.h:62
SPA_TYPE_Double
@ SPA_TYPE_Double
Definition type.h:48
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition type.h:44
SPA_TYPE_Array
@ SPA_TYPE_Array
Definition type.h:54
SPA_TYPE_String
@ SPA_TYPE_String
Definition type.h:49
SPA_PTROFF
#define SPA_PTROFF(ptr_, offset_, type_)
Return the address (buffer + offset) as pointer of type.
Definition defs.h:222
iter.h
spa/pod/iter.h
context.h
spa/debug/context.h
string.h
spa/utils/string.h
spa_debug_context
Definition context.h:46
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:135
spa_pod_array_body::child
struct spa_pod child
Definition pod.h:136
spa_pod_object
Definition pod.h:202
spa_pod_prop
Definition pod.h:227
spa_pod_prop::key
uint32_t key
key of property, list of valid keys depends on the object type
Definition pod.h:228
spa_pod_prop::value
struct spa_pod value
Definition pod.h:249
spa_pod
Definition pod.h:57
spa_pod::type
uint32_t type
Definition pod.h:59
spa_pod::size
uint32_t size
Definition pod.h:58
spa_rectangle
Definition defs.h:116
spa_strbuf
Definition string.h:375
spa_type_info
Definition type.h:156
spa_type_info::type
uint32_t type
Definition type.h:157
spa_type_info::values
const struct spa_type_info * values
Definition type.h:160
types.h
spa/debug/types.h