PipeWire  0.3.29
utils/type-info.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_INFO_H
26 #define SPA_TYPE_INFO_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
32 #include <spa/utils/defs.h>
33 
39 #ifndef SPA_TYPE_ROOT
40 #define SPA_TYPE_ROOT spa_types
41 #endif
42 
43 /* static */ inline bool spa_type_is_a(const char *type, const char *parent)
44 {
45  return type != NULL && parent != NULL && strncmp(type, parent, strlen(parent)) == 0;
46 }
47 
48 #include <spa/utils/type.h>
49 
50 /* base for parameter object enumerations */
51 #define SPA_TYPE_INFO_Direction SPA_TYPE_INFO_ENUM_BASE "Direction"
52 #define SPA_TYPE_INFO_DIRECTION_BASE SPA_TYPE_INFO_Direction ":"
53 
54 /* static */ const struct spa_type_info spa_type_direction[] = {
57  { 0, 0, NULL, NULL }
58 };
59 
60 #include <spa/monitor/type-info.h>
61 #include <spa/node/type-info.h>
62 #include <spa/param/type-info.h>
63 #include <spa/control/type-info.h>
64 
65 /* base for parameter object enumerations */
66 #define SPA_TYPE_INFO_Choice SPA_TYPE_INFO_ENUM_BASE "Choice"
67 #define SPA_TYPE_INFO_CHOICE_BASE SPA_TYPE_INFO_Choice ":"
68 
69 /* static */ const struct spa_type_info spa_type_choice[] = {
75  { 0, 0, NULL, NULL }
76 };
77 
78 /* static */ const struct spa_type_info spa_types[] = {
79  /* Basic types */
101 
106 
110 
114 
127 
128  { 0, 0, NULL, NULL }
129 };
130 
135 #ifdef __cplusplus
136 } /* extern "C" */
137 #endif
138 
139 #endif /* SPA_TYPE_INFO_H */
const struct spa_type_info spa_type_node_command[]
Definition: node/type-info.h:92
const struct spa_type_info spa_type_node_event[]
Definition: node/type-info.h:70
const struct spa_type_info spa_type_param_profile[]
Definition: param/type-info.h:314
const struct spa_type_info spa_type_prop_info[]
Definition: param/type-info.h:139
#define SPA_TYPE_INFO_PARAM_Meta
Definition: param/type-info.h:150
const struct spa_type_info spa_type_param_io[]
Definition: param/type-info.h:166
const struct spa_type_info spa_type_param_port_config[]
Definition: param/type-info.h:341
#define SPA_TYPE_INFO_PARAM_Profile
Definition: param/type-info.h:311
const struct spa_type_info spa_type_param_latency[]
Definition: param/type-info.h:390
#define SPA_TYPE_INFO_PARAM_IO
Base for parameters that describe IO areas to exchange data, control and properties with a node.
Definition: param/type-info.h:163
const struct spa_type_info spa_type_format[]
Definition: param/type-info.h:243
const struct spa_type_info spa_type_param_meta[]
Definition: param/type-info.h:153
const struct spa_type_info spa_type_props[]
Definition: param/type-info.h:87
const struct spa_type_info spa_type_param_buffers[]
Definition: param/type-info.h:290
#define SPA_TYPE_INFO_PropInfo
Enum Property info.
Definition: param/type-info.h:136
#define SPA_TYPE_INFO_PARAM_Buffers
Definition: param/type-info.h:284
#define SPA_TYPE_INFO_PARAM_Latency
Definition: param/type-info.h:387
#define SPA_TYPE_INFO_Format
Definition: param/type-info.h:173
#define SPA_TYPE_INFO_Profiler
Definition: param/type-info.h:375
#define SPA_TYPE_INFO_PARAM_Route
Definition: param/type-info.h:352
#define SPA_TYPE_INFO_Props
Definition: param/type-info.h:70
const struct spa_type_info spa_type_profiler[]
Definition: param/type-info.h:378
const struct spa_type_info spa_type_param_route[]
Definition: param/type-info.h:355
#define SPA_TYPE_INFO_PARAM_PortConfig
Definition: param/type-info.h:338
@ SPA_CHOICE_Step
range with step: default, min, max, step
Definition: pod/pod.h:143
@ SPA_CHOICE_None
no choice, first value is current
Definition: pod/pod.h:141
@ SPA_CHOICE_Flags
flags: default, possible flags,...
Definition: pod/pod.h:145
@ SPA_CHOICE_Range
range: default, min, max
Definition: pod/pod.h:142
@ SPA_CHOICE_Enum
list: default, alternative,...
Definition: pod/pod.h:144
#define SPA_TYPE_INFO_EVENT_BASE
Definition: output/doc/spa/utils/type.h:131
#define SPA_TYPE_INFO_BASE
Definition: output/doc/spa/utils/type.h:107
#define SPA_TYPE_INFO_CHOICE_BASE
Definition: utils/type-info.h:67
const struct spa_type_info spa_type_choice[]
Definition: utils/type-info.h:69
#define SPA_TYPE_INFO_POD_BASE
Definition: output/doc/spa/utils/type.h:116
#define SPA_TYPE_INFO_Struct
Definition: output/doc/spa/utils/type.h:118
#define SPA_TYPE_INFO_Event
Definition: output/doc/spa/utils/type.h:130
#define SPA_TYPE_INFO_Pointer
Definition: output/doc/spa/utils/type.h:124
#define SPA_TYPE_INFO_Pod
Definition: output/doc/spa/utils/type.h:115
bool spa_type_is_a(const char *type, const char *parent)
Definition: utils/type-info.h:43
#define SPA_TYPE_INFO_Command
Definition: output/doc/spa/utils/type.h:133
#define SPA_TYPE_INFO_DIRECTION_BASE
Definition: utils/type-info.h:52
#define SPA_TYPE_INFO_POINTER_BASE
Definition: output/doc/spa/utils/type.h:125
#define SPA_TYPE_INFO_Object
Definition: output/doc/spa/utils/type.h:121
const struct spa_type_info spa_types[]
Definition: utils/type-info.h:78
#define SPA_TYPE_INFO_COMMAND_BASE
Definition: output/doc/spa/utils/type.h:134
const struct spa_type_info spa_type_direction[]
Definition: utils/type-info.h:54
@ 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_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_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_Array
Definition: output/doc/spa/utils/type.h:57
@ SPA_TYPE_String
Definition: output/doc/spa/utils/type.h:52
@ SPA_TYPE_POINTER_Meta
Definition: output/doc/spa/utils/type.h:70
@ 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_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
@ SPA_DIRECTION_INPUT
Definition: defs.h:78
@ SPA_DIRECTION_OUTPUT
Definition: defs.h:79
const struct spa_type_info spa_type_device_event[]
Definition: monitor/type-info.h:47
Definition: output/doc/spa/utils/type.h:136