PipeWire 1.3.0
Loading...
Searching...
No Matches
type.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_TYPE_H
6#define SPA_TYPE_H
7
8#ifdef __cplusplus
9extern "C" {
10#endif
11
12#include <spa/utils/defs.h>
13#include <spa/utils/string.h>
14
24enum {
25 /* Basic types */
26 SPA_TYPE_START = 0x00000,
49 /* Pointers */
56 /* Events */
62 /* Commands */
68 /* Objects */
85 /* vendor extensions */
89};
90
91#define SPA_TYPE_INFO_BASE "Spa:"
92
93#define SPA_TYPE_INFO_Flags SPA_TYPE_INFO_BASE "Flags"
94#define SPA_TYPE_INFO_FLAGS_BASE SPA_TYPE_INFO_Flags ":"
95
96#define SPA_TYPE_INFO_Enum SPA_TYPE_INFO_BASE "Enum"
97#define SPA_TYPE_INFO_ENUM_BASE SPA_TYPE_INFO_Enum ":"
98
99#define SPA_TYPE_INFO_Pod SPA_TYPE_INFO_BASE "Pod"
100#define SPA_TYPE_INFO_POD_BASE SPA_TYPE_INFO_Pod ":"
101
102#define SPA_TYPE_INFO_Struct SPA_TYPE_INFO_POD_BASE "Struct"
103#define SPA_TYPE_INFO_STRUCT_BASE SPA_TYPE_INFO_Struct ":"
104
105#define SPA_TYPE_INFO_Object SPA_TYPE_INFO_POD_BASE "Object"
106#define SPA_TYPE_INFO_OBJECT_BASE SPA_TYPE_INFO_Object ":"
108#define SPA_TYPE_INFO_Pointer SPA_TYPE_INFO_BASE "Pointer"
109#define SPA_TYPE_INFO_POINTER_BASE SPA_TYPE_INFO_Pointer ":"
111#define SPA_TYPE_INFO_Interface SPA_TYPE_INFO_POINTER_BASE "Interface"
112#define SPA_TYPE_INFO_INTERFACE_BASE SPA_TYPE_INFO_Interface ":"
113
114#define SPA_TYPE_INFO_Event SPA_TYPE_INFO_OBJECT_BASE "Event"
115#define SPA_TYPE_INFO_EVENT_BASE SPA_TYPE_INFO_Event ":"
116
117#define SPA_TYPE_INFO_Command SPA_TYPE_INFO_OBJECT_BASE "Command"
118#define SPA_TYPE_INFO_COMMAND_BASE SPA_TYPE_INFO_Command ":"
119
121 uint32_t type;
122 uint32_t parent;
123 const char *name;
124 const struct spa_type_info *values;
126
127static inline bool spa_type_is_a(const char *type, const char *parent)
128{
129 return type != NULL && parent != NULL && strncmp(type, parent, strlen(parent)) == 0;
131
132static inline const char *spa_type_short_name(const char *name)
133{
134 const char *h;
135 if ((h = strrchr(name, ':')) != NULL)
136 name = h + 1;
137 return name;
138}
139
140static inline uint32_t spa_type_from_short_name(const char *name,
141 const struct spa_type_info *info, uint32_t unknown)
143 int i;
144 for (i = 0; info[i].name; i++) {
145 if (spa_streq(name, spa_type_short_name(info[i].name)))
146 return info[i].type;
147 }
148 return unknown;
149}
150static inline const char * spa_type_to_name(uint32_t type,
151 const struct spa_type_info *info, const char *unknown)
152{
153 int i;
154 for (i = 0; info[i].name; i++) {
155 if (info[i].type == type)
156 return info[i].name;
157 }
158 return unknown;
159}
160
161static inline const char * spa_type_to_short_name(uint32_t type,
162 const struct spa_type_info *info, const char *unknown)
163{
164 const char *n = spa_type_to_name(type, info, unknown);
165 return n ? spa_type_short_name(n) : NULL;
166}
167
172#ifdef __cplusplus
173} /* extern "C" */
174#endif
175
176#endif /* SPA_TYPE_H */
spa/utils/defs.h
static bool spa_streq(const char *s1, const char *s2)
Definition string.h:41
static bool spa_type_is_a(const char *type, const char *parent)
Definition type.h:151
static const char * spa_type_to_short_name(uint32_t type, const struct spa_type_info *info, const char *unknown)
Definition type.h:185
static const char * spa_type_to_name(uint32_t type, const struct spa_type_info *info, const char *unknown)
Definition type.h:174
static uint32_t spa_type_from_short_name(const char *name, const struct spa_type_info *info, uint32_t unknown)
Definition type.h:164
static const char * spa_type_short_name(const char *name)
Definition type.h:156
@ SPA_TYPE_POINTER_Buffer
Definition type.h:56
@ SPA_TYPE_OBJECT_ParamPortConfig
Definition type.h:82
@ SPA_TYPE_Int
Definition type.h:35
@ SPA_TYPE_OBJECT_ParamProfile
Definition type.h:81
@ SPA_TYPE_COMMAND_START
Definition type.h:68
@ SPA_TYPE_POINTER_START
Definition type.h:55
@ SPA_TYPE_Rectangle
Definition type.h:41
@ SPA_TYPE_Long
Definition type.h:36
@ SPA_TYPE_Bool
Definition type.h:33
@ SPA_TYPE_Bytes
Definition type.h:40
@ SPA_TYPE_VENDOR_Other
Definition type.h:93
@ SPA_TYPE_EVENT_Device
Definition type.h:63
@ SPA_TYPE_Pod
Definition type.h:51
@ SPA_TYPE_OBJECT_PropInfo
Definition type.h:75
@ SPA_TYPE_OBJECT_START
Definition type.h:74
@ SPA_TYPE_Bitmap
Definition type.h:43
@ SPA_TYPE_Object
Definition type.h:46
@ SPA_TYPE_POINTER_Dict
Definition type.h:58
@ SPA_TYPE_Float
Definition type.h:37
@ SPA_TYPE_COMMAND_Device
Definition type.h:69
@ SPA_TYPE_OBJECT_ParamBuffers
Definition type.h:78
@ SPA_TYPE_Fraction
Definition type.h:42
@ SPA_TYPE_None
Definition type.h:32
@ SPA_TYPE_OBJECT_ParamIO
Definition type.h:80
@ _SPA_TYPE_LAST
not part of ABI
Definition type.h:52
@ SPA_TYPE_OBJECT_Props
Definition type.h:76
@ SPA_TYPE_Sequence
Definition type.h:47
@ SPA_TYPE_Double
Definition type.h:38
@ SPA_TYPE_OBJECT_Profiler
Definition type.h:84
@ SPA_TYPE_OBJECT_ParamLatency
Definition type.h:85
@ SPA_TYPE_Id
Definition type.h:34
@ SPA_TYPE_EVENT_START
Definition type.h:62
@ SPA_TYPE_Choice
Definition type.h:50
@ SPA_TYPE_EVENT_Node
Definition type.h:64
@ SPA_TYPE_Pointer
Definition type.h:48
@ _SPA_TYPE_OBJECT_LAST
not part of ABI
Definition type.h:88
@ SPA_TYPE_Array
Definition type.h:44
@ _SPA_TYPE_EVENT_LAST
not part of ABI
Definition type.h:65
@ SPA_TYPE_String
Definition type.h:39
@ SPA_TYPE_VENDOR_PipeWire
Definition type.h:91
@ SPA_TYPE_POINTER_Meta
Definition type.h:57
@ _SPA_TYPE_COMMAND_LAST
not part of ABI
Definition type.h:71
@ SPA_TYPE_COMMAND_Node
Definition type.h:70
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition type.h:86
@ SPA_TYPE_Fd
Definition type.h:49
@ SPA_TYPE_OBJECT_ParamMeta
Definition type.h:79
@ SPA_TYPE_OBJECT_ParamTag
Definition type.h:87
@ SPA_TYPE_OBJECT_ParamRoute
Definition type.h:83
@ _SPA_TYPE_POINTER_LAST
not part of ABI
Definition type.h:59
@ SPA_TYPE_Struct
Definition type.h:45
@ SPA_TYPE_OBJECT_Format
Definition type.h:77
@ SPA_TYPE_START
Definition type.h:31
spa/utils/string.h
Definition type.h:144
uint32_t type
Definition type.h:145
uint32_t parent
Definition type.h:146
const struct spa_type_info * values
Definition type.h:148