PipeWire 1.6.8

Loading...
Searching...
No Matches
param-types.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_PARAM_TYPES_H
6#define SPA_PARAM_TYPES_H
7
8#include <spa/param/props.h>
9#include <spa/param/format.h>
10#include <spa/buffer/type-info.h>
11
12#ifdef __cplusplus
13 extern "C" {
14#endif
15
20
21/* base for parameter object enumerations */
22#define SPA_TYPE_INFO_ParamId SPA_TYPE_INFO_ENUM_BASE "ParamId"
23#define SPA_TYPE_INFO_PARAM_ID_BASE SPA_TYPE_INFO_ParamId ":"
24
25 static const struct spa_type_info spa_type_param[] = {
26 { SPA_PARAM_Invalid, SPA_TYPE_None, SPA_TYPE_INFO_PARAM_ID_BASE "Invalid", NULL },
27 { SPA_PARAM_PropInfo, SPA_TYPE_OBJECT_PropInfo, SPA_TYPE_INFO_PARAM_ID_BASE "PropInfo", NULL },
28 { SPA_PARAM_Props, SPA_TYPE_OBJECT_Props, SPA_TYPE_INFO_PARAM_ID_BASE "Props", NULL },
29 { SPA_PARAM_EnumFormat, SPA_TYPE_OBJECT_Format, SPA_TYPE_INFO_PARAM_ID_BASE "EnumFormat", NULL },
30 { SPA_PARAM_Format, SPA_TYPE_OBJECT_Format, SPA_TYPE_INFO_PARAM_ID_BASE "Format", NULL },
31 { SPA_PARAM_Buffers, SPA_TYPE_OBJECT_ParamBuffers, SPA_TYPE_INFO_PARAM_ID_BASE "Buffers", NULL },
32 { SPA_PARAM_Meta, SPA_TYPE_OBJECT_ParamMeta, SPA_TYPE_INFO_PARAM_ID_BASE "Meta", NULL },
33 { SPA_PARAM_IO, SPA_TYPE_OBJECT_ParamIO, SPA_TYPE_INFO_PARAM_ID_BASE "IO", NULL },
34 { SPA_PARAM_EnumProfile, SPA_TYPE_OBJECT_ParamProfile, SPA_TYPE_INFO_PARAM_ID_BASE "EnumProfile", NULL },
35 { SPA_PARAM_Profile, SPA_TYPE_OBJECT_ParamProfile, SPA_TYPE_INFO_PARAM_ID_BASE "Profile", NULL },
36 { SPA_PARAM_EnumPortConfig, SPA_TYPE_OBJECT_ParamPortConfig, SPA_TYPE_INFO_PARAM_ID_BASE "EnumPortConfig", NULL },
37 { SPA_PARAM_PortConfig, SPA_TYPE_OBJECT_ParamPortConfig, SPA_TYPE_INFO_PARAM_ID_BASE "PortConfig", NULL },
38 { SPA_PARAM_EnumRoute, SPA_TYPE_OBJECT_ParamRoute, SPA_TYPE_INFO_PARAM_ID_BASE "EnumRoute", NULL },
39 { SPA_PARAM_Route, SPA_TYPE_OBJECT_ParamRoute, SPA_TYPE_INFO_PARAM_ID_BASE "Route", NULL },
40 { SPA_PARAM_Control, SPA_TYPE_Sequence, SPA_TYPE_INFO_PARAM_ID_BASE "Control", NULL },
41 { SPA_PARAM_Latency, SPA_TYPE_OBJECT_ParamLatency, SPA_TYPE_INFO_PARAM_ID_BASE "Latency", NULL },
42 { SPA_PARAM_ProcessLatency, SPA_TYPE_OBJECT_ParamProcessLatency, SPA_TYPE_INFO_PARAM_ID_BASE "ProcessLatency", NULL },
43 { SPA_PARAM_Tag, SPA_TYPE_OBJECT_ParamTag, SPA_TYPE_INFO_PARAM_ID_BASE "Tag", NULL },
44 { SPA_PARAM_PeerEnumFormat, SPA_TYPE_OBJECT_PeerParam, SPA_TYPE_INFO_PARAM_ID_BASE "PeerEnumFormat", NULL },
45 { SPA_PARAM_Capability, SPA_TYPE_OBJECT_ParamDict, SPA_TYPE_INFO_PARAM_ID_BASE "Capability", NULL },
46 { SPA_PARAM_PeerCapability, SPA_TYPE_OBJECT_PeerParam, SPA_TYPE_INFO_PARAM_ID_BASE "PeerCapability", NULL },
47 { 0, 0, NULL, NULL },
48};
49
50/* base for parameter objects */
51#define SPA_TYPE_INFO_Param SPA_TYPE_INFO_OBJECT_BASE "Param"
52#define SPA_TYPE_INFO_PARAM_BASE SPA_TYPE_INFO_Param ":"
53
54#include <spa/param/audio/type-info.h>
55
56 static const struct spa_type_info spa_type_prop_float_array[] = {
57 { SPA_PROP_START, SPA_TYPE_Float, SPA_TYPE_INFO_BASE "floatArray", NULL, },
58 { 0, 0, NULL, NULL },
59};
60
61 static const struct spa_type_info spa_type_prop_int_array[] = {
62 { SPA_PROP_START, SPA_TYPE_Int, SPA_TYPE_INFO_BASE "intArray", NULL, },
63 { 0, 0, NULL, NULL },
64};
65
66 static const struct spa_type_info spa_type_prop_channel_map[] = {
67 { SPA_PROP_START, SPA_TYPE_Id, SPA_TYPE_INFO_BASE "channelMap", spa_type_audio_channel, },
68 { 0, 0, NULL, NULL },
69};
70
71 static const struct spa_type_info spa_type_prop_iec958_codec[] = {
72 { SPA_PROP_START, SPA_TYPE_Id, SPA_TYPE_INFO_BASE "iec958Codec", spa_type_audio_iec958_codec, },
73 { 0, 0, NULL, NULL },
74};
75
76#define SPA_TYPE_INFO_ParamBitorder SPA_TYPE_INFO_ENUM_BASE "ParamBitorder"
77#define SPA_TYPE_INFO_PARAM_BITORDER_BASE SPA_TYPE_INFO_ParamBitorder ":"
78
79 static const struct spa_type_info spa_type_param_bitorder[] = {
80 { SPA_PARAM_BITORDER_unknown, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "unknown", NULL },
81 { SPA_PARAM_BITORDER_msb, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "msb", NULL },
82 { SPA_PARAM_BITORDER_lsb, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "lsb", NULL },
83 { 0, 0, NULL, NULL },
84};
85
86#define SPA_TYPE_INFO_ParamAvailability SPA_TYPE_INFO_ENUM_BASE "ParamAvailability"
87#define SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE SPA_TYPE_INFO_ParamAvailability ":"
88
89 static const struct spa_type_info spa_type_param_availability[] = {
90 { SPA_PARAM_AVAILABILITY_unknown, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "unknown", NULL },
91 { SPA_PARAM_AVAILABILITY_no, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "no", NULL },
92 { SPA_PARAM_AVAILABILITY_yes, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "yes", NULL },
93 { 0, 0, NULL, NULL },
94};
95
96
99
100#ifdef __cplusplus
101} /* extern "C" */
102#endif
103
104#endif /* SPA_PARAM_TYPES_H */
type-info.h
spa/buffer/type-info.h
spa_type_prop_channel_map
static const struct spa_type_info spa_type_prop_channel_map[]
Definition param-types.h:75
spa_type_prop_int_array
static const struct spa_type_info spa_type_prop_int_array[]
Definition param-types.h:70
spa_type_param_availability
static const struct spa_type_info spa_type_param_availability[]
Definition param-types.h:102
SPA_TYPE_INFO_PARAM_BITORDER_BASE
#define SPA_TYPE_INFO_PARAM_BITORDER_BASE
Definition param-types.h:88
spa_type_prop_float_array
static const struct spa_type_info spa_type_prop_float_array[]
Definition param-types.h:65
SPA_TYPE_INFO_PARAM_ID_BASE
#define SPA_TYPE_INFO_PARAM_ID_BASE
Definition param-types.h:30
spa_type_audio_channel
static const struct spa_type_info spa_type_audio_channel[]
Definition raw-types.h:174
SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE
#define SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE
Definition param-types.h:100
spa_type_param_bitorder
static const struct spa_type_info spa_type_param_bitorder[]
Definition param-types.h:90
spa_type_audio_iec958_codec
static const struct spa_type_info spa_type_audio_iec958_codec[]
Definition iec958-types.h:40
spa_type_param
static const struct spa_type_info spa_type_param[]
Definition param-types.h:32
spa_type_prop_iec958_codec
static const struct spa_type_info spa_type_prop_iec958_codec[]
Definition param-types.h:80
SPA_PROP_START
@ SPA_PROP_START
Definition props.h:42
SPA_PARAM_BITORDER_unknown
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition param.h:79
SPA_PARAM_BITORDER_msb
@ SPA_PARAM_BITORDER_msb
most significant bit
Definition param.h:80
SPA_PARAM_BITORDER_lsb
@ SPA_PARAM_BITORDER_lsb
least significant bit
Definition param.h:81
SPA_PARAM_Route
@ SPA_PARAM_Route
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition param.h:43
SPA_PARAM_Capability
@ SPA_PARAM_Capability
capability info, a SPA_TYPE_OBJECT_ParamDict, Since 1.5.84
Definition param.h:50
SPA_PARAM_PeerCapability
@ SPA_PARAM_PeerCapability
peer capabilities, a SPA_TYPE_OBJECT_PeerParam with SPA_TYPE_OBJECT_ParamDict, since 1....
Definition param.h:51
SPA_PARAM_Tag
@ SPA_PARAM_Tag
tag reporting, a SPA_TYPE_OBJECT_ParamTag.
Definition param.h:47
SPA_PARAM_Format
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition param.h:34
SPA_PARAM_EnumRoute
@ SPA_PARAM_EnumRoute
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition param.h:42
SPA_PARAM_Meta
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition param.h:36
SPA_PARAM_IO
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition param.h:37
SPA_PARAM_EnumProfile
@ SPA_PARAM_EnumProfile
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition param.h:38
SPA_PARAM_EnumPortConfig
@ SPA_PARAM_EnumPortConfig
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition param.h:40
SPA_PARAM_EnumFormat
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition param.h:33
SPA_PARAM_Profile
@ SPA_PARAM_Profile
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition param.h:39
SPA_PARAM_Latency
@ SPA_PARAM_Latency
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition param.h:45
SPA_PARAM_PeerEnumFormat
@ SPA_PARAM_PeerEnumFormat
peer formats, a SPA_TYPE_OBJECT_PeerParam with SPA_TYPE_OBJECT_Format.
Definition param.h:48
SPA_PARAM_PortConfig
@ SPA_PARAM_PortConfig
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition param.h:41
SPA_PARAM_Control
@ SPA_PARAM_Control
Control parameter, a SPA_TYPE_Sequence.
Definition param.h:44
SPA_PARAM_Props
@ SPA_PARAM_Props
properties as SPA_TYPE_OBJECT_Props
Definition param.h:32
SPA_PARAM_PropInfo
@ SPA_PARAM_PropInfo
property information as SPA_TYPE_OBJECT_PropInfo
Definition param.h:31
SPA_PARAM_Buffers
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition param.h:35
SPA_PARAM_ProcessLatency
@ SPA_PARAM_ProcessLatency
processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency
Definition param.h:46
SPA_PARAM_Invalid
@ SPA_PARAM_Invalid
invalid
Definition param.h:30
SPA_PARAM_AVAILABILITY_unknown
@ SPA_PARAM_AVAILABILITY_unknown
unknown availability
Definition param.h:85
SPA_PARAM_AVAILABILITY_yes
@ SPA_PARAM_AVAILABILITY_yes
available
Definition param.h:87
SPA_PARAM_AVAILABILITY_no
@ SPA_PARAM_AVAILABILITY_no
not available
Definition param.h:86
SPA_TYPE_INFO_BASE
#define SPA_TYPE_INFO_BASE
Definition type.h:109
SPA_TYPE_OBJECT_ParamPortConfig
@ SPA_TYPE_OBJECT_ParamPortConfig
Definition type.h:92
SPA_TYPE_Int
@ SPA_TYPE_Int
Definition type.h:45
SPA_TYPE_OBJECT_ParamProfile
@ SPA_TYPE_OBJECT_ParamProfile
Definition type.h:91
SPA_TYPE_OBJECT_PropInfo
@ SPA_TYPE_OBJECT_PropInfo
Definition type.h:85
SPA_TYPE_OBJECT_ParamDict
@ SPA_TYPE_OBJECT_ParamDict
Definition type.h:99
SPA_TYPE_Float
@ SPA_TYPE_Float
Definition type.h:47
SPA_TYPE_OBJECT_ParamBuffers
@ SPA_TYPE_OBJECT_ParamBuffers
Definition type.h:88
SPA_TYPE_None
@ SPA_TYPE_None
Definition type.h:42
SPA_TYPE_OBJECT_ParamIO
@ SPA_TYPE_OBJECT_ParamIO
Definition type.h:90
SPA_TYPE_OBJECT_Props
@ SPA_TYPE_OBJECT_Props
Definition type.h:86
SPA_TYPE_Sequence
@ SPA_TYPE_Sequence
Definition type.h:57
SPA_TYPE_OBJECT_ParamLatency
@ SPA_TYPE_OBJECT_ParamLatency
Definition type.h:95
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition type.h:44
SPA_TYPE_OBJECT_ParamProcessLatency
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition type.h:96
SPA_TYPE_OBJECT_PeerParam
@ SPA_TYPE_OBJECT_PeerParam
Definition type.h:98
SPA_TYPE_OBJECT_ParamMeta
@ SPA_TYPE_OBJECT_ParamMeta
Definition type.h:89
SPA_TYPE_OBJECT_ParamTag
@ SPA_TYPE_OBJECT_ParamTag
Definition type.h:97
SPA_TYPE_OBJECT_ParamRoute
@ SPA_TYPE_OBJECT_ParamRoute
Definition type.h:93
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition type.h:87
format.h
spa/param/format.h
props.h
spa_type_info
Definition type.h:156