Debian Codegraph @

lib/wp/spa-pod.h

raw
1 /* WirePlumber
2 *
3 * Copyright © 2020 Collabora Ltd.
4 * @author Julian Bouzas <[email protected]>
5 *
6 * SPDX-License-Identifier: MIT
7 */
8
9 #ifndef __WIREPLUMBER_SPA_POD_H__
10 #define __WIREPLUMBER_SPA_POD_H__
11
12 #include <gio/gio.h>
13
14 #include "defs.h"
15 #include "iterator.h"
16 #include "spa-type.h"
17
18 G_BEGIN_DECLS
19
20 struct spa_pod;
21
22 /*!
23 * \brief The WpSpaPod GType
24 * \ingroup wpspapod
25 */
26 #define WP_TYPE_SPA_POD (wp_spa_pod_get_type ())
27 WP_API
28 GType wp_spa_pod_get_type (void);
29
30 typedef struct _WpSpaPod WpSpaPod;
31
32 WP_API
33 WpSpaPod *wp_spa_pod_ref (WpSpaPod *self);
34
35 WP_API
36 void wp_spa_pod_unref (WpSpaPod *self);
37
38 WP_API
39 WpSpaPod * wp_spa_pod_new_wrap (struct spa_pod *pod);
40
41 WP_API
42 WpSpaPod * wp_spa_pod_new_wrap_const (const struct spa_pod *pod);
43
44 WP_API
45 const struct spa_pod * wp_spa_pod_get_spa_pod (const WpSpaPod *self);
46
47 WP_API
48 WpSpaType wp_spa_pod_get_spa_type (WpSpaPod *self);
49
50 WP_API
51 WpSpaIdValue wp_spa_pod_get_choice_type (WpSpaPod *self);
52
53 WP_API
54 WpSpaPod *wp_spa_pod_copy (WpSpaPod *other);
55
56 WP_API
57 gboolean wp_spa_pod_is_unique_owner (WpSpaPod *self);
58
59 WP_API
60 WpSpaPod *wp_spa_pod_ensure_unique_owner (WpSpaPod *self);
61
62 WP_API
63 WpSpaPod *wp_spa_pod_new_none (void);
64
65 WP_API
66 WpSpaPod *wp_spa_pod_new_boolean (gboolean value);
67
68 WP_API
69 WpSpaPod *wp_spa_pod_new_id (guint32 value);
70
71 WP_API
72 WpSpaPod *wp_spa_pod_new_int (gint32 value);
73
74 WP_API
75 WpSpaPod *wp_spa_pod_new_long (gint64 value);
76
77 WP_API
78 WpSpaPod *wp_spa_pod_new_float (float value);
79
80 WP_API
81 WpSpaPod *wp_spa_pod_new_double (double value);
82
83 WP_API
84 WpSpaPod *wp_spa_pod_new_string (const char *value);
85
86 WP_API
87 WpSpaPod *wp_spa_pod_new_bytes (gconstpointer value, guint32 len);
88
89 WP_API
90 WpSpaPod *wp_spa_pod_new_pointer (const char *type_name, gconstpointer value);
91
92 WP_API
93 WpSpaPod *wp_spa_pod_new_fd (gint64 value);
94
95 WP_API
96 WpSpaPod *wp_spa_pod_new_rectangle (guint32 width, guint32 height);
97
98 WP_API
99 WpSpaPod *wp_spa_pod_new_fraction (guint32 num, guint32 denom);
100
101 WP_API
102 WpSpaPod *wp_spa_pod_new_choice (const char *choice_type, ...)
103 G_GNUC_NULL_TERMINATED;
104
105 WP_API
106 WpSpaPod *wp_spa_pod_new_choice_valist (const char *choice_type, va_list args);
107
108 WP_API
109 WpSpaPod *wp_spa_pod_new_object (const char *type_name, const char *id_name,
110 ...) G_GNUC_NULL_TERMINATED;
111
112 WP_API
113 WpSpaPod *wp_spa_pod_new_object_valist (const char *type_name,
114 const char *id_name, va_list args);
115
116 WP_API
117 WpSpaPod *wp_spa_pod_new_sequence (guint unit, ...) G_GNUC_NULL_TERMINATED;
118
119 WP_API
120 WpSpaPod *wp_spa_pod_new_sequence_valist (guint unit, va_list args);
121
122 WP_API
123 gboolean wp_spa_pod_is_none (WpSpaPod *self);
124
125 WP_API
126 gboolean wp_spa_pod_is_boolean (WpSpaPod *self);
127
128 WP_API
129 gboolean wp_spa_pod_is_id (WpSpaPod *self);
130
131 WP_API
132 gboolean wp_spa_pod_is_int (WpSpaPod *self);
133
134 WP_API
135 gboolean wp_spa_pod_is_long (WpSpaPod *self);
136
137 WP_API
138 gboolean wp_spa_pod_is_float (WpSpaPod *self);
139
140 WP_API
141 gboolean wp_spa_pod_is_double (WpSpaPod *self);
142
143 WP_API
144 gboolean wp_spa_pod_is_string (WpSpaPod *self);
145
146 WP_API
147 gboolean wp_spa_pod_is_bytes (WpSpaPod *self);
148
149 WP_API
150 gboolean wp_spa_pod_is_pointer (WpSpaPod *self);
151
152 WP_API
153 gboolean wp_spa_pod_is_fd (WpSpaPod *self);
154
155 WP_API
156 gboolean wp_spa_pod_is_rectangle (WpSpaPod *self);
157
158 WP_API
159 gboolean wp_spa_pod_is_fraction (WpSpaPod *self);
160
161 WP_API
162 gboolean wp_spa_pod_is_array (WpSpaPod *self);
163
164 WP_API
165 gboolean wp_spa_pod_is_choice (WpSpaPod *self);
166
167 WP_API
168 gboolean wp_spa_pod_is_object (WpSpaPod *self);
169
170 WP_API
171 gboolean wp_spa_pod_is_struct (WpSpaPod *self);
172
173 WP_API
174 gboolean wp_spa_pod_is_sequence (WpSpaPod *self);
175
176 WP_API
177 gboolean wp_spa_pod_is_property (WpSpaPod *self);
178
179 WP_API
180 gboolean wp_spa_pod_is_control (WpSpaPod *self);
181
182 WP_API
183 gboolean wp_spa_pod_get_boolean (WpSpaPod *self, gboolean *value);
184
185 WP_API
186 gboolean wp_spa_pod_get_id (WpSpaPod *self, guint32 *value);
187
188 WP_API
189 gboolean wp_spa_pod_get_int (WpSpaPod *self, gint32 *value);
190
191 WP_API
192 gboolean wp_spa_pod_get_long (WpSpaPod *self, gint64 *value);
193
194 WP_API
195 gboolean wp_spa_pod_get_float (WpSpaPod *self, float *value);
196
197 WP_API
198 gboolean wp_spa_pod_get_double (WpSpaPod *self, double *value);
199
200 WP_API
201 gboolean wp_spa_pod_get_string (WpSpaPod *self, const char **value);
202
203 WP_API
204 gboolean wp_spa_pod_get_bytes (WpSpaPod *self, gconstpointer *value,
205 guint32 *len);
206
207 WP_API
208 gboolean wp_spa_pod_get_pointer (WpSpaPod *self, gconstpointer *value);
209
210 WP_API
211 gboolean wp_spa_pod_get_fd (WpSpaPod *self, gint64 *value);
212
213 WP_API
214 gboolean wp_spa_pod_get_rectangle (WpSpaPod *self, guint32 *width,
215 guint32 *height);
216
217 WP_API
218 gboolean wp_spa_pod_get_fraction (WpSpaPod *self, guint32 *num, guint32 *denom);
219
220 WP_API
221 gboolean wp_spa_pod_set_boolean (WpSpaPod *self, gboolean value);
222
223 WP_API
224 gboolean wp_spa_pod_set_id (WpSpaPod *self, guint32 value);
225
226 WP_API
227 gboolean wp_spa_pod_set_int (WpSpaPod *self, gint32 value);
228
229 WP_API
230 gboolean wp_spa_pod_set_long (WpSpaPod *self, gint64 value);
231
232 WP_API
233 gboolean wp_spa_pod_set_float (WpSpaPod *self, float value);
234
235 WP_API
236 gboolean wp_spa_pod_set_double (WpSpaPod *self, double value);
237
238 WP_API
239 gboolean wp_spa_pod_set_pointer (WpSpaPod *self, const char *type_name,
240 gconstpointer value);
241
242 WP_API
243 gboolean wp_spa_pod_set_fd (WpSpaPod *self, gint64 value);
244
245 WP_API
246 gboolean wp_spa_pod_set_rectangle (WpSpaPod *self, guint32 width,
247 guint32 height);
248
249 WP_API
250 gboolean wp_spa_pod_set_fraction (WpSpaPod *self, guint32 num, guint32 denom);
251
252 WP_API
253 gboolean wp_spa_pod_set_pod (WpSpaPod *self, WpSpaPod *pod);
254
255 WP_API
256 gboolean wp_spa_pod_equal (WpSpaPod *self, WpSpaPod *pod);
257
258 WP_API
259 gboolean wp_spa_pod_get_object (WpSpaPod *self,
260 const char **id_name, ...) G_GNUC_NULL_TERMINATED;
261
262 WP_API
263 gboolean wp_spa_pod_get_object_valist (WpSpaPod *self,
264 const char **id_name, va_list args);
265
266 WP_API
267 gboolean wp_spa_pod_get_struct (WpSpaPod *self, ...) G_GNUC_NULL_TERMINATED;
268
269 WP_API
270 gboolean wp_spa_pod_get_struct_valist (WpSpaPod *self, va_list args);
271
272 WP_API
273 gboolean wp_spa_pod_get_property (WpSpaPod *self, const char **key,
274 WpSpaPod **value);
275
276 WP_API
277 gboolean wp_spa_pod_get_control (WpSpaPod *self, guint32 *offset,
278 const char **ctl_type, WpSpaPod **value);
279
280 WP_API
281 WpSpaPod *wp_spa_pod_get_choice_child (WpSpaPod *self);
282
283 WP_API
284 WpSpaPod *wp_spa_pod_get_array_child (WpSpaPod *self);
285
286 WP_API
287 WpIterator *wp_spa_pod_new_iterator (WpSpaPod *pod);
288
289 WP_API
290 gboolean wp_spa_pod_fixate (WpSpaPod *self);
291
292 WP_API
293 WpSpaPod *wp_spa_pod_filter (WpSpaPod *self, WpSpaPod *filter);
294
295 G_DEFINE_AUTOPTR_CLEANUP_FUNC (WpSpaPod, wp_spa_pod_unref)
296
297
298 /*!
299 * \brief The WpSpaPodBuilder GType
300 * \ingroup wpspapod
301 */
302 #define WP_TYPE_SPA_POD_BUILDER (wp_spa_pod_builder_get_type ())
303 WP_API
304 GType wp_spa_pod_builder_get_type (void);
305
306 typedef struct _WpSpaPodBuilder WpSpaPodBuilder;
307
308 WP_API
309 WpSpaPodBuilder *wp_spa_pod_builder_ref (WpSpaPodBuilder *self);
310
311 WP_API
312 void wp_spa_pod_builder_unref (WpSpaPodBuilder *self);
313
314 WP_API
315 WpSpaPodBuilder *wp_spa_pod_builder_new_array (void);
316
317 WP_API
318 WpSpaPodBuilder *wp_spa_pod_builder_new_choice (const char *choice_type);
319
320 WP_API
321 WpSpaPodBuilder *wp_spa_pod_builder_new_object (const char *type_name,
322 const char *id_name);
323
324 WP_API
325 WpSpaPodBuilder *wp_spa_pod_builder_new_struct (void);
326
327 WP_API
328 WpSpaPodBuilder *wp_spa_pod_builder_new_sequence (guint unit);
329
330 WP_API
331 void wp_spa_pod_builder_add_none (WpSpaPodBuilder *self);
332
333 WP_API
334 void wp_spa_pod_builder_add_boolean (WpSpaPodBuilder *self, gboolean value);
335
336 WP_API
337 void wp_spa_pod_builder_add_id (WpSpaPodBuilder *self, guint32 value);
338
339 WP_API
340 void wp_spa_pod_builder_add_int (WpSpaPodBuilder *self, gint32 value);
341
342 WP_API
343 void wp_spa_pod_builder_add_long (WpSpaPodBuilder *self, gint64 value);
344
345 WP_API
346 void wp_spa_pod_builder_add_float (WpSpaPodBuilder *self, float value);
347
348 WP_API
349 void wp_spa_pod_builder_add_double (WpSpaPodBuilder *self, double value);
350
351 WP_API
352 void wp_spa_pod_builder_add_string (WpSpaPodBuilder *self, const char *value);
353
354 WP_API
355 void wp_spa_pod_builder_add_bytes (WpSpaPodBuilder *self, gconstpointer value,
356 guint32 len);
357
358 WP_API
359 void wp_spa_pod_builder_add_pointer (WpSpaPodBuilder *self,
360 const char *type_name, gconstpointer value);
361
362 WP_API
363 void wp_spa_pod_builder_add_fd (WpSpaPodBuilder *self, gint64 value);
364
365 WP_API
366 void wp_spa_pod_builder_add_rectangle (WpSpaPodBuilder *self, guint32 width,
367 guint32 height);
368
369 WP_API
370 void wp_spa_pod_builder_add_fraction (WpSpaPodBuilder *self, guint32 num,
371 guint32 denom);
372
373 WP_API
374 void wp_spa_pod_builder_add_pod (WpSpaPodBuilder *self, WpSpaPod *pod);
375
376 WP_API
377 void wp_spa_pod_builder_add_property (WpSpaPodBuilder *self, const char *key);
378
379 WP_API
380 void wp_spa_pod_builder_add_property_id (WpSpaPodBuilder *self, guint32 id);
381
382 WP_API
383 void wp_spa_pod_builder_add_control (WpSpaPodBuilder *self, guint32 offset,
384 const char *ctl_type);
385
386 WP_API
387 void wp_spa_pod_builder_add (WpSpaPodBuilder *self, ...) G_GNUC_NULL_TERMINATED;
388
389 WP_API
390 void wp_spa_pod_builder_add_valist (WpSpaPodBuilder *self, va_list args);
391
392 WP_API
393 WpSpaPod *wp_spa_pod_builder_end (WpSpaPodBuilder *self);
394
395 G_DEFINE_AUTOPTR_CLEANUP_FUNC (WpSpaPodBuilder, wp_spa_pod_builder_unref)
396
397
398 /*!
399 * \brief The WpSpaPodParser GType
400 * \ingroup wpspapod
401 */
402 #define WP_TYPE_SPA_POD_PARSER (wp_spa_pod_parser_get_type ())
403 WP_API
404 GType wp_spa_pod_parser_get_type (void);
405
406 typedef struct _WpSpaPodParser WpSpaPodParser;
407
408 WP_API
409 WpSpaPodParser *wp_spa_pod_parser_ref (WpSpaPodParser *self);
410
411 WP_API
412 void wp_spa_pod_parser_unref (WpSpaPodParser *self);
413
414 WP_API
415 WpSpaPodParser *wp_spa_pod_parser_new_object (WpSpaPod *pod,
416 const char **id_name);
417
418 WP_API
419 WpSpaPodParser *wp_spa_pod_parser_new_struct (WpSpaPod *pod);
420
421 WP_API
422 gboolean wp_spa_pod_parser_get_boolean (WpSpaPodParser *self, gboolean *value);
423
424 WP_API
425 gboolean wp_spa_pod_parser_get_id (WpSpaPodParser *self, guint32 *value);
426
427 WP_API
428 gboolean wp_spa_pod_parser_get_int (WpSpaPodParser *self, gint32 *value);
429
430 WP_API
431 gboolean wp_spa_pod_parser_get_long (WpSpaPodParser *self, gint64 *value);
432
433 WP_API
434 gboolean wp_spa_pod_parser_get_float (WpSpaPodParser *self, float *value);
435
436 WP_API
437 gboolean wp_spa_pod_parser_get_double (WpSpaPodParser *self, double *value);
438
439 WP_API
440 gboolean wp_spa_pod_parser_get_string (WpSpaPodParser *self,
441 const char **value);
442
443 WP_API
444 gboolean wp_spa_pod_parser_get_bytes (WpSpaPodParser *self,
445 gconstpointer *value, guint32 *len);
446
447 WP_API
448 gboolean wp_spa_pod_parser_get_pointer (WpSpaPodParser *self,
449 gconstpointer *value);
450
451 WP_API
452 gboolean wp_spa_pod_parser_get_fd (WpSpaPodParser *self, gint64 *value);
453
454 WP_API
455 gboolean wp_spa_pod_parser_get_rectangle (WpSpaPodParser *self, guint32 *width,
456 guint32 *height);
457
458 WP_API
459 gboolean wp_spa_pod_parser_get_fraction (WpSpaPodParser *self, guint32 *num,
460 guint32 *denom);
461
462 WP_API
463 WpSpaPod *wp_spa_pod_parser_get_pod (WpSpaPodParser *self);
464
465 WP_API
466 gboolean wp_spa_pod_parser_get (WpSpaPodParser *self, ...)
467 G_GNUC_NULL_TERMINATED;
468
469 WP_API
470 gboolean wp_spa_pod_parser_get_valist (WpSpaPodParser *self,
471 va_list args);
472
473 WP_API
474 void wp_spa_pod_parser_end (WpSpaPodParser *self);
475
476 G_DEFINE_AUTOPTR_CLEANUP_FUNC (WpSpaPodParser, wp_spa_pod_parser_unref)
477
478
479 G_END_DECLS
480
481 #endif