PipeWire  0.3.29
output/doc/spa/utils/type.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_TYPE_H
26 #define SPA_TYPE_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/defs.h>
33 
42 enum {
43  /* Basic types */
44  SPA_TYPE_START = 0x00000,
67  /* Pointers */
74  /* Events */
80  /* Commands */
86  /* Objects */
101  /* vendor extensions */
103 
104  SPA_TYPE_VENDOR_Other = 0x7f000000,
105 };
106 
107 #define SPA_TYPE_INFO_BASE "Spa:"
108 
109 #define SPA_TYPE_INFO_Flags SPA_TYPE_INFO_BASE "Flags"
110 #define SPA_TYPE_INFO_FLAGS_BASE SPA_TYPE_INFO_Flags ":"
111 
112 #define SPA_TYPE_INFO_Enum SPA_TYPE_INFO_BASE "Enum"
113 #define SPA_TYPE_INFO_ENUM_BASE SPA_TYPE_INFO_Enum ":"
114 
115 #define SPA_TYPE_INFO_Pod SPA_TYPE_INFO_BASE "Pod"
116 #define SPA_TYPE_INFO_POD_BASE SPA_TYPE_INFO_Pod ":"
117 
118 #define SPA_TYPE_INFO_Struct SPA_TYPE_INFO_POD_BASE "Struct"
119 #define SPA_TYPE_INFO_STRUCT_BASE SPA_TYPE_INFO_Struct ":"
120 
121 #define SPA_TYPE_INFO_Object SPA_TYPE_INFO_POD_BASE "Object"
122 #define SPA_TYPE_INFO_OBJECT_BASE SPA_TYPE_INFO_Object ":"
123 
124 #define SPA_TYPE_INFO_Pointer SPA_TYPE_INFO_BASE "Pointer"
125 #define SPA_TYPE_INFO_POINTER_BASE SPA_TYPE_INFO_Pointer ":"
126 
127 #define SPA_TYPE_INFO_Interface SPA_TYPE_INFO_POINTER_BASE "Interface"
128 #define SPA_TYPE_INFO_INTERFACE_BASE SPA_TYPE_INFO_Interface ":"
129 
130 #define SPA_TYPE_INFO_Event SPA_TYPE_INFO_OBJECT_BASE "Event"
131 #define SPA_TYPE_INFO_EVENT_BASE SPA_TYPE_INFO_Event ":"
132 
133 #define SPA_TYPE_INFO_Command SPA_TYPE_INFO_OBJECT_BASE "Command"
134 #define SPA_TYPE_INFO_COMMAND_BASE SPA_TYPE_INFO_Command ":"
135 
137  uint32_t type;
138  uint32_t parent;
139  const char *name;
140  const struct spa_type_info *values;
141 };
142 
147 #ifdef __cplusplus
148 } /* extern "C" */
149 #endif
150 
151 #endif /* SPA_TYPE_H */
@ SPA_TYPE_POINTER_Buffer
Definition: output/doc/spa/utils/type.h:69
@ SPA_TYPE_OBJECT_ParamPortConfig
Definition: output/doc/spa/utils/type.h:95
@ SPA_TYPE_Int
Definition: output/doc/spa/utils/type.h:48
@ SPA_TYPE_OBJECT_ParamProfile
Definition: output/doc/spa/utils/type.h:94
@ SPA_TYPE_COMMAND_START
Definition: output/doc/spa/utils/type.h:81
@ SPA_TYPE_POINTER_START
Definition: output/doc/spa/utils/type.h:68
@ SPA_TYPE_Rectangle
Definition: output/doc/spa/utils/type.h:54
@ SPA_TYPE_Long
Definition: output/doc/spa/utils/type.h:49
@ SPA_TYPE_Bool
Definition: output/doc/spa/utils/type.h:46
@ SPA_TYPE_Bytes
Definition: output/doc/spa/utils/type.h:53
@ SPA_TYPE_VENDOR_Other
Definition: output/doc/spa/utils/type.h:104
@ SPA_TYPE_EVENT_Device
Definition: output/doc/spa/utils/type.h:76
@ SPA_TYPE_Pod
Definition: output/doc/spa/utils/type.h:64
@ SPA_TYPE_OBJECT_PropInfo
Definition: output/doc/spa/utils/type.h:88
@ SPA_TYPE_OBJECT_START
Definition: output/doc/spa/utils/type.h:87
@ SPA_TYPE_Bitmap
Definition: output/doc/spa/utils/type.h:56
@ SPA_TYPE_Object
Definition: output/doc/spa/utils/type.h:59
@ SPA_TYPE_POINTER_Dict
Definition: output/doc/spa/utils/type.h:71
@ SPA_TYPE_Float
Definition: output/doc/spa/utils/type.h:50
@ SPA_TYPE_COMMAND_Device
Definition: output/doc/spa/utils/type.h:82
@ SPA_TYPE_OBJECT_ParamBuffers
Definition: output/doc/spa/utils/type.h:91
@ SPA_TYPE_Fraction
Definition: output/doc/spa/utils/type.h:55
@ SPA_TYPE_None
Definition: output/doc/spa/utils/type.h:45
@ SPA_TYPE_OBJECT_ParamIO
Definition: output/doc/spa/utils/type.h:93
@ _SPA_TYPE_LAST
not part of ABI
Definition: output/doc/spa/utils/type.h:65
@ SPA_TYPE_OBJECT_Props
Definition: output/doc/spa/utils/type.h:89
@ SPA_TYPE_Sequence
Definition: output/doc/spa/utils/type.h:60
@ SPA_TYPE_Double
Definition: output/doc/spa/utils/type.h:51
@ SPA_TYPE_OBJECT_Profiler
Definition: output/doc/spa/utils/type.h:97
@ SPA_TYPE_OBJECT_ParamLatency
Definition: output/doc/spa/utils/type.h:98
@ SPA_TYPE_Id
Definition: output/doc/spa/utils/type.h:47
@ SPA_TYPE_EVENT_START
Definition: output/doc/spa/utils/type.h:75
@ SPA_TYPE_Choice
Definition: output/doc/spa/utils/type.h:63
@ SPA_TYPE_EVENT_Node
Definition: output/doc/spa/utils/type.h:77
@ SPA_TYPE_Pointer
Definition: output/doc/spa/utils/type.h:61
@ _SPA_TYPE_OBJECT_LAST
not part of ABI
Definition: output/doc/spa/utils/type.h:99
@ SPA_TYPE_Array
Definition: output/doc/spa/utils/type.h:57
@ _SPA_TYPE_EVENT_LAST
not part of ABI
Definition: output/doc/spa/utils/type.h:78
@ SPA_TYPE_String
Definition: output/doc/spa/utils/type.h:52
@ SPA_TYPE_VENDOR_PipeWire
Definition: output/doc/spa/utils/type.h:102
@ SPA_TYPE_POINTER_Meta
Definition: output/doc/spa/utils/type.h:70
@ _SPA_TYPE_COMMAND_LAST
not part of ABI
Definition: output/doc/spa/utils/type.h:84
@ SPA_TYPE_COMMAND_Node
Definition: output/doc/spa/utils/type.h:83
@ SPA_TYPE_Fd
Definition: output/doc/spa/utils/type.h:62
@ SPA_TYPE_OBJECT_ParamMeta
Definition: output/doc/spa/utils/type.h:92
@ SPA_TYPE_OBJECT_ParamRoute
Definition: output/doc/spa/utils/type.h:96
@ _SPA_TYPE_POINTER_LAST
not part of ABI
Definition: output/doc/spa/utils/type.h:72
@ SPA_TYPE_Struct
Definition: output/doc/spa/utils/type.h:58
@ SPA_TYPE_OBJECT_Format
Definition: output/doc/spa/utils/type.h:90
@ SPA_TYPE_START
Definition: output/doc/spa/utils/type.h:44
Definition: output/doc/spa/utils/type.h:136
uint32_t type
Definition: output/doc/spa/utils/type.h:137
uint32_t parent
Definition: output/doc/spa/utils/type.h:138
const char * name
Definition: output/doc/spa/utils/type.h:139
const struct spa_type_info * values
Definition: output/doc/spa/utils/type.h:140