PipeWire  0.3.63
param.h
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_PARAM_H
26 #define SPA_PARAM_H
27 
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 
41 #include <spa/utils/defs.h>
42 
44 enum spa_param_type {
62 };
63 
66  uint32_t id;
67 #define SPA_PARAM_INFO_SERIAL (1<<0)
69 #define SPA_PARAM_INFO_READ (1<<1)
70 #define SPA_PARAM_INFO_WRITE (1<<2)
71 #define SPA_PARAM_INFO_READWRITE (SPA_PARAM_INFO_WRITE|SPA_PARAM_INFO_READ)
72  uint32_t flags;
73  uint32_t user;
75  int32_t seq;
77  uint32_t padding[4];
78 };
79 
80 #define SPA_PARAM_INFO(id,flags) ((struct spa_param_info){ (id), (flags) })
81 
91 };
92 
98 };
99 
105 };
111 };
136 };
145 };
155 };
156 
158 enum spa_param_route {
177 };
178 
181 enum spa_param_latency {
190 };
191 
198 };
204 };
210 #ifdef __cplusplus
211 } /* extern "C" */
212 #endif
214 #endif /* SPA_PARAM_H */
number of buffers (Int)
Definition: param.h:96
the expected maximum size the meta (Int)
Definition: param.h:108
direction, input/output (Id enum spa_direction)
Definition: param.h:194
profile name (String)
Definition: param.h:128
invalid
Definition: param.h:50
size of the io area (Int)
Definition: param.h:115
spa_param_process_latency
properties for SPA_TYPE_OBJECT_ParamProcessLatency
Definition: param.h:204
spa_param_buffers
properties for SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:94
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:59
availability of the profile (Id enum spa_param_availability)
Definition: param.h:131
type ID, uniquely identifies the io area (Id enum spa_io_type)
Definition: param.h:114
direction, input/output (Id enum spa_direction)
Definition: param.h:161
unknown bitorder
Definition: param.h:212
latency relative to quantum (Float)
Definition: param.h:206
possible memory types (Int, mask of enum spa_data_type)
Definition: param.h:101
(Object) format filter
Definition: param.h:165
max latency (Long) in nanoseconds
Definition: param.h:200
uint32_t flags
Definition: param.h:82
int32_t seq
private seq field.
Definition: param.h:85
Definition: param.h:126
processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency
Definition: param.h:66
min latency relative to quantum (Float)
Definition: param.h:195
Definition: param.h:106
Definition: param.h:193
priority of the destination (Int)
Definition: param.h:176
associated device indexes (Array of Int)
Definition: param.h:185
Definition: param.h:205
min latency (Long) in nanoseconds
Definition: param.h:199
latency (Int) relative to rate
Definition: param.h:207
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:133
size of a data block memory (Int)
Definition: param.h:98
properties as SPA_TYPE_OBJECT_Props
Definition: param.h:52
index of the routing destination (Int)
Definition: param.h:171
spa_param_type
different parameter types that can be queried
Definition: param.h:49
max latency (Int) relative to rate
Definition: param.h:198
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:60
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:54
convert configuration
Definition: param.h:152
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:65
availability of the destination (Id enum spa_param_availability)
Definition: param.h:177
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:61
dsp configuration, depending on the external format.
Definition: param.h:153
If route should be saved (Bool)
Definition: param.h:187
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:62
properties SPA_TYPE_OBJECT_Props
Definition: param.h:184
available
Definition: param.h:121
If profile should be saved (Bool)
Definition: param.h:146
(Bool) enable monitor output ports on input ports
Definition: param.h:163
information about a parameter
Definition: param.h:70
Definition: param.h:160
spa_param_availability
Definition: param.h:118
spa_param_meta
properties for SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:105
spa_param_port_config_mode
Definition: param.h:149
spa_param_port_config
properties for SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:159
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:58
info (Struct( Int : n_items, (String : key, String : value)*))
Definition: param.h:179
profile description (String)
Definition: param.h:129
uint32_t id
enum spa_param_type
Definition: param.h:71
spa_param_route
properties for SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:169
direction, input/output (Id enum spa_direction)
Definition: param.h:172
the metadata, one of enum spa_meta_type (Id enum spa_meta_type)
Definition: param.h:107
associated profile indexes (Array of Int)
Definition: param.h:183
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition: param.h:57
least significant bit
Definition: param.h:214
(Id enum spa_param_port_config_mode) mode
Definition: param.h:162
uint32_t user
private user field.
Definition: param.h:83
min latency (Int) relative to rate
Definition: param.h:197
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:53
spa_param_bitorder
Definition: param.h:211
Definition: param.h:95
unknown availability
Definition: param.h:119
property information as SPA_TYPE_OBJECT_PropInfo
Definition: param.h:51
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:56
spa_param_profile
properties for SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:125
description of the destination (String)
Definition: param.h:175
spa_param_io
properties for SPA_TYPE_OBJECT_ParamIO
Definition: param.h:112
profile index (Int)
Definition: param.h:127
most significant bit
Definition: param.h:213
name of the routing destination (String)
Definition: param.h:174
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:63
max latency relative to quantum (Float)
Definition: param.h:196
Definition: param.h:113
profile priority (Int)
Definition: param.h:130
Control parameter, a SPA_TYPE_Sequence.
Definition: param.h:64
(Bool) enable control ports
Definition: param.h:164
node classes provided by this profile (Struct( Int : number of items following Struct( String : class...
Definition: param.h:137
spa_param_latency
properties for SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:192
device id (Int)
Definition: param.h:173
not available
Definition: param.h:120
alignment of data block memory (Int)
Definition: param.h:100
uint32_t padding[4]
Definition: param.h:87
no configuration
Definition: param.h:150
number of data blocks per buffer (Int)
Definition: param.h:97
passthrough configuration
Definition: param.h:151
stride of data block memory (Int)
Definition: param.h:99
Definition: param.h:170
latency (Long) in nanoseconds
Definition: param.h:208
profile id (Int)
Definition: param.h:186
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:55