PipeWire: param-types.h Source File

PipeWire 0.3.79

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#ifdef __cplusplus
9extern "C" {
10#endif
11
17#include <spa/param/props.h>
18#include <spa/param/format.h>
19#include <spa/buffer/type-info.h>
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
25static 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 { 0, 0, NULL, NULL },
44};
45
46/* base for parameter objects */
47#define SPA_TYPE_INFO_Param SPA_TYPE_INFO_OBJECT_BASE "Param"
48#define SPA_TYPE_INFO_PARAM_BASE SPA_TYPE_INFO_Param ":"
49
50#include <spa/param/audio/type-info.h>
51
52static const struct spa_type_info spa_type_prop_float_array[] = {
53 { SPA_PROP_START, SPA_TYPE_Float, SPA_TYPE_INFO_BASE "floatArray", NULL, },
54 { 0, 0, NULL, NULL },
55};
56
57 static const struct spa_type_info spa_type_prop_channel_map[] = {
58 { SPA_PROP_START, SPA_TYPE_Id, SPA_TYPE_INFO_BASE "channelMap", spa_type_audio_channel, },
59 { 0, 0, NULL, NULL },
60};
61
62static const struct spa_type_info spa_type_prop_iec958_codec[] = {
63 { SPA_PROP_START, SPA_TYPE_Id, SPA_TYPE_INFO_BASE "iec958Codec", spa_type_audio_iec958_codec, },
64 { 0, 0, NULL, NULL },
65};
66
67#define SPA_TYPE_INFO_ParamBitorder SPA_TYPE_INFO_ENUM_BASE "ParamBitorder"
68#define SPA_TYPE_INFO_PARAM_BITORDER_BASE SPA_TYPE_INFO_ParamBitorder ":"
69
70static const struct spa_type_info spa_type_param_bitorder[] = {
71 { SPA_PARAM_BITORDER_unknown, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "unknown", NULL },
72 { SPA_PARAM_BITORDER_msb, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "msb", NULL },
73 { SPA_PARAM_BITORDER_lsb, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_BITORDER_BASE "lsb", NULL },
74 { 0, 0, NULL, NULL },
75};
76
77#define SPA_TYPE_INFO_ParamAvailability SPA_TYPE_INFO_ENUM_BASE "ParamAvailability"
78#define SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE SPA_TYPE_INFO_ParamAvailability ":"
79
80static const struct spa_type_info spa_type_param_availability[] = {
81 { SPA_PARAM_AVAILABILITY_unknown, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "unknown", NULL },
82 { SPA_PARAM_AVAILABILITY_no, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "no", NULL },
83 { SPA_PARAM_AVAILABILITY_yes, SPA_TYPE_Int, SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE "yes", NULL },
84 { 0, 0, NULL, NULL },
85};
86
91#ifdef __cplusplus
92} /* extern "C" */
93#endif
94
95#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:66
spa_type_param_availability
static const struct spa_type_info spa_type_param_availability[]
Definition param-types.h:93
SPA_TYPE_INFO_PARAM_BITORDER_BASE
#define SPA_TYPE_INFO_PARAM_BITORDER_BASE
Definition param-types.h:79
spa_type_prop_float_array
static const struct spa_type_info spa_type_prop_float_array[]
Definition param-types.h:61
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 audio/raw-types.h:154
SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE
#define SPA_TYPE_INFO_PARAM_AVAILABILITY_BASE
Definition param-types.h:91
spa_type_param_bitorder
static const struct spa_type_info spa_type_param_bitorder[]
Definition param-types.h:81
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:71
SPA_PROP_START
@ SPA_PROP_START
Definition props.h:42
SPA_PARAM_BITORDER_unknown
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition param.h:73
SPA_PARAM_BITORDER_msb
@ SPA_PARAM_BITORDER_msb
most significant bit
Definition param.h:74
SPA_PARAM_BITORDER_lsb
@ SPA_PARAM_BITORDER_lsb
least significant bit
Definition param.h:75
SPA_PARAM_Route
@ SPA_PARAM_Route
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition param.h:43
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_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:79
SPA_PARAM_AVAILABILITY_yes
@ SPA_PARAM_AVAILABILITY_yes
available
Definition param.h:81
SPA_PARAM_AVAILABILITY_no
@ SPA_PARAM_AVAILABILITY_no
not available
Definition param.h:80
SPA_TYPE_INFO_BASE
#define SPA_TYPE_INFO_BASE
Definition spa/include/spa/utils/type.h:95
SPA_TYPE_OBJECT_ParamPortConfig
@ SPA_TYPE_OBJECT_ParamPortConfig
Definition spa/include/spa/utils/type.h:81
SPA_TYPE_Int
@ SPA_TYPE_Int
Definition spa/include/spa/utils/type.h:34
SPA_TYPE_OBJECT_ParamProfile
@ SPA_TYPE_OBJECT_ParamProfile
Definition spa/include/spa/utils/type.h:80
SPA_TYPE_OBJECT_PropInfo
@ SPA_TYPE_OBJECT_PropInfo
Definition spa/include/spa/utils/type.h:74
SPA_TYPE_Float
@ SPA_TYPE_Float
Definition spa/include/spa/utils/type.h:36
SPA_TYPE_OBJECT_ParamBuffers
@ SPA_TYPE_OBJECT_ParamBuffers
Definition spa/include/spa/utils/type.h:77
SPA_TYPE_None
@ SPA_TYPE_None
Definition spa/include/spa/utils/type.h:31
SPA_TYPE_OBJECT_ParamIO
@ SPA_TYPE_OBJECT_ParamIO
Definition spa/include/spa/utils/type.h:79
SPA_TYPE_OBJECT_Props
@ SPA_TYPE_OBJECT_Props
Definition spa/include/spa/utils/type.h:75
SPA_TYPE_Sequence
@ SPA_TYPE_Sequence
Definition spa/include/spa/utils/type.h:46
SPA_TYPE_OBJECT_ParamLatency
@ SPA_TYPE_OBJECT_ParamLatency
Definition spa/include/spa/utils/type.h:84
SPA_TYPE_Id
@ SPA_TYPE_Id
Definition spa/include/spa/utils/type.h:33
SPA_TYPE_OBJECT_ParamProcessLatency
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition spa/include/spa/utils/type.h:85
SPA_TYPE_OBJECT_ParamMeta
@ SPA_TYPE_OBJECT_ParamMeta
Definition spa/include/spa/utils/type.h:78
SPA_TYPE_OBJECT_ParamRoute
@ SPA_TYPE_OBJECT_ParamRoute
Definition spa/include/spa/utils/type.h:82
SPA_TYPE_OBJECT_Format
@ SPA_TYPE_OBJECT_Format
Definition spa/include/spa/utils/type.h:76
format.h
spa/param/format.h
props.h
spa_type_info
Definition spa/include/spa/utils/type.h:142
spa_type_info::type
uint32_t type
Definition spa/include/spa/utils/type.h:143