PipeWire: param.h Source File

PipeWire 0.3.66

Loading...
Searching...
No Matches
param.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_PARAM_H
26#define SPA_PARAM_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
41#include <spa/utils/defs.h>
42
44enum spa_param_type {
45 SPA_PARAM_Invalid,
46 SPA_PARAM_PropInfo,
47 SPA_PARAM_Props,
48 SPA_PARAM_EnumFormat,
49 SPA_PARAM_Format,
50 SPA_PARAM_Buffers,
51 SPA_PARAM_Meta,
52 SPA_PARAM_IO,
53 SPA_PARAM_EnumProfile,
54 SPA_PARAM_Profile,
55 SPA_PARAM_EnumPortConfig,
56 SPA_PARAM_PortConfig,
57 SPA_PARAM_EnumRoute,
58 SPA_PARAM_Route,
59 SPA_PARAM_Control,
60 SPA_PARAM_Latency,
61 SPA_PARAM_ProcessLatency,
62};
63
65 struct spa_param_info {
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
82 enum spa_param_bitorder {
83 SPA_PARAM_BITORDER_unknown,
84 SPA_PARAM_BITORDER_msb,
85 SPA_PARAM_BITORDER_lsb,
86};
87
88enum spa_param_availability {
89 SPA_PARAM_AVAILABILITY_unknown,
90 SPA_PARAM_AVAILABILITY_no,
91 SPA_PARAM_AVAILABILITY_yes,
92};
93
94#include <spa/param/buffers.h>
95#include <spa/param/profile.h>
96#include <spa/param/port-config.h>
97#include <spa/param/route.h>
98
103#ifdef __cplusplus
104} /* extern "C" */
105#endif
106
107#endif /* SPA_PARAM_H */
defs.h
spa/utils/defs.h
spa_param_bitorder
spa_param_bitorder
Definition: param.h:92
spa_param_type
spa_param_type
different parameter types that can be queried
Definition: param.h:49
spa_param_availability
spa_param_availability
Definition: param.h:98
SPA_PARAM_BITORDER_unknown
@ SPA_PARAM_BITORDER_unknown
unknown bitorder
Definition: param.h:93
SPA_PARAM_BITORDER_msb
@ SPA_PARAM_BITORDER_msb
most significant bit
Definition: param.h:94
SPA_PARAM_BITORDER_lsb
@ SPA_PARAM_BITORDER_lsb
least significant bit
Definition: param.h:95
SPA_PARAM_Route
@ SPA_PARAM_Route
routing configuration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:63
SPA_PARAM_Format
@ SPA_PARAM_Format
configured format as SPA_TYPE_OBJECT_Format
Definition: param.h:54
SPA_PARAM_EnumRoute
@ SPA_PARAM_EnumRoute
routing enumeration as SPA_TYPE_OBJECT_ParamRoute
Definition: param.h:62
SPA_PARAM_Meta
@ SPA_PARAM_Meta
allowed metadata for buffers as SPA_TYPE_OBJECT_ParamMeta
Definition: param.h:56
SPA_PARAM_IO
@ SPA_PARAM_IO
configurable IO areas as SPA_TYPE_OBJECT_ParamIO
Definition: param.h:57
SPA_PARAM_EnumProfile
@ SPA_PARAM_EnumProfile
profile enumeration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:58
SPA_PARAM_EnumPortConfig
@ SPA_PARAM_EnumPortConfig
port configuration enumeration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:60
SPA_PARAM_EnumFormat
@ SPA_PARAM_EnumFormat
available formats as SPA_TYPE_OBJECT_Format
Definition: param.h:53
SPA_PARAM_Profile
@ SPA_PARAM_Profile
profile configuration as SPA_TYPE_OBJECT_ParamProfile
Definition: param.h:59
SPA_PARAM_Latency
@ SPA_PARAM_Latency
latency reporting, a SPA_TYPE_OBJECT_ParamLatency
Definition: param.h:65
SPA_PARAM_PortConfig
@ SPA_PARAM_PortConfig
port configuration as SPA_TYPE_OBJECT_ParamPortConfig
Definition: param.h:61
SPA_PARAM_Control
@ SPA_PARAM_Control
Control parameter, a SPA_TYPE_Sequence.
Definition: param.h:64
SPA_PARAM_Props
@ SPA_PARAM_Props
properties as SPA_TYPE_OBJECT_Props
Definition: param.h:52
SPA_PARAM_PropInfo
@ SPA_PARAM_PropInfo
property information as SPA_TYPE_OBJECT_PropInfo
Definition: param.h:51
SPA_PARAM_Buffers
@ SPA_PARAM_Buffers
buffer configurations as SPA_TYPE_OBJECT_ParamBuffers
Definition: param.h:55
SPA_PARAM_ProcessLatency
@ SPA_PARAM_ProcessLatency
processing latency, a SPA_TYPE_OBJECT_ParamProcessLatency
Definition: param.h:66
SPA_PARAM_Invalid
@ SPA_PARAM_Invalid
invalid
Definition: param.h:50
SPA_PARAM_AVAILABILITY_unknown
@ SPA_PARAM_AVAILABILITY_unknown
unknown availability
Definition: param.h:99
SPA_PARAM_AVAILABILITY_yes
@ SPA_PARAM_AVAILABILITY_yes
available
Definition: param.h:101
SPA_PARAM_AVAILABILITY_no
@ SPA_PARAM_AVAILABILITY_no
not available
Definition: param.h:100
port-config.h
spa/param/port-config.h
profile.h
spa/param/profile.h
route.h
spa/param/route.h
buffers.h
spa/param/buffers.h
spa_param_info
information about a parameter
Definition: param.h:70
spa_param_info::flags
uint32_t flags
Definition: param.h:81
spa_param_info::padding
uint32_t padding[4]
Definition: param.h:86
spa_param_info::user
uint32_t user
private user field.
Definition: param.h:82
spa_param_info::id
uint32_t id
enum spa_param_type
Definition: param.h:71
spa_param_info::seq
int32_t seq
private seq field.
Definition: param.h:84