PipeWire: spa/param/latency-utils.h Source File

PipeWire 1.6.4

Loading...
Searching...
No Matches
latency-utils.h
Go to the documentation of this file.
1/* Simple Plugin API */
2/* SPDX-FileCopyrightText: Copyright © 2021 Wim Taymans */
3/* SPDX-License-Identifier: MIT */
4
5#ifndef SPA_PARAM_LATENCY_UTILS_H
6#define SPA_PARAM_LATENCY_UTILS_H
7
8#include <float.h>
9
10#include <spa/pod/builder.h>
11#include <spa/pod/parser.h>
12#include <spa/param/latency.h>
13
14#ifdef __cplusplus
15extern "C" {
16#endif
17
22
23#ifndef SPA_API_LATENCY_UTILS
24 #ifdef SPA_API_IMPL
25 #define SPA_API_LATENCY_UTILS SPA_API_IMPL
26 #else
27 #define SPA_API_LATENCY_UTILS static inline
28 #endif
29#endif
30
31 SPA_API_LATENCY_UTILS int
32 spa_latency_info_compare(const struct spa_latency_info *a, const struct spa_latency_info *b)
33{
34 if (a->min_quantum == b->min_quantum &&
35 a->max_quantum == b->max_quantum &&
36 a->min_rate == b->min_rate &&
37 a->max_rate == b->max_rate &&
38 a->min_ns == b->min_ns &&
39 a->max_ns == b->max_ns)
40 return 0;
41 return 1;
42}
43
44 SPA_API_LATENCY_UTILS void
45 spa_latency_info_combine_start(struct spa_latency_info *info, enum spa_direction direction)
46{
47 *info = SPA_LATENCY_INFO_UNSET(direction);
48}
49
50 SPA_API_LATENCY_UTILS void
51 spa_latency_info_combine_finish(struct spa_latency_info *info)
52{
53 struct spa_latency_info unset = SPA_LATENCY_INFO_UNSET(info->direction);
54 if (info->min_quantum == unset.min_quantum)
55 info->min_quantum = 0;
56 if (info->max_quantum == unset.max_quantum)
57 info->max_quantum = 0;
58 if (info->min_rate == unset.min_rate)
59 info->min_rate = 0;
60 if (info->max_rate == unset.max_rate)
61 info->max_rate = 0;
62 if (info->min_ns == unset.min_ns)
63 info->min_ns = 0;
64 if (info->max_ns == unset.max_ns)
65 info->max_ns = 0;
66}
67
68 SPA_API_LATENCY_UTILS int
69 spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
70{
71 if (info->direction != other->direction)
72 return -EINVAL;
73 if (other->min_quantum < info->min_quantum)
74 info->min_quantum = other->min_quantum;
75 if (other->max_quantum > info->max_quantum)
76 info->max_quantum = other->max_quantum;
77 if (other->min_rate < info->min_rate)
78 info->min_rate = other->min_rate;
79 if (other->max_rate > info->max_rate)
80 info->max_rate = other->max_rate;
81 if (other->min_ns < info->min_ns)
82 info->min_ns = other->min_ns;
83 if (other->max_ns > info->max_ns)
84 info->max_ns = other->max_ns;
85 return 0;
86}
87
88 SPA_API_LATENCY_UTILS int
89 spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
90{
91 int res;
92 spa_zero(*info);
93 if ((res = spa_pod_parse_object(latency,
94 SPA_TYPE_OBJECT_ParamLatency, NULL,
95 SPA_PARAM_LATENCY_direction, SPA_POD_Id(&info->direction),
96 SPA_PARAM_LATENCY_minQuantum, SPA_POD_OPT_Float(&info->min_quantum),
97 SPA_PARAM_LATENCY_maxQuantum, SPA_POD_OPT_Float(&info->max_quantum),
98 SPA_PARAM_LATENCY_minRate, SPA_POD_OPT_Int(&info->min_rate),
99 SPA_PARAM_LATENCY_maxRate, SPA_POD_OPT_Int(&info->max_rate),
100 SPA_PARAM_LATENCY_minNs, SPA_POD_OPT_Long(&info->min_ns),
101 SPA_PARAM_LATENCY_maxNs, SPA_POD_OPT_Long(&info->max_ns))) < 0)
102 return res;
103 info->direction = (enum spa_direction)(info->direction & 1);
104 return 0;
105}
106
107 SPA_API_LATENCY_UTILS struct spa_pod *
108 spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
109{
110 return (struct spa_pod *)spa_pod_builder_add_object(builder,
111 SPA_TYPE_OBJECT_ParamLatency, id,
112 SPA_PARAM_LATENCY_direction, SPA_POD_Id(info->direction),
113 SPA_PARAM_LATENCY_minQuantum, SPA_POD_Float(info->min_quantum),
114 SPA_PARAM_LATENCY_maxQuantum, SPA_POD_Float(info->max_quantum),
115 SPA_PARAM_LATENCY_minRate, SPA_POD_Int(info->min_rate),
116 SPA_PARAM_LATENCY_maxRate, SPA_POD_Int(info->max_rate),
117 SPA_PARAM_LATENCY_minNs, SPA_POD_Long(info->min_ns),
118 SPA_PARAM_LATENCY_maxNs, SPA_POD_Long(info->max_ns));
119}
120
121 SPA_API_LATENCY_UTILS int
122 spa_process_latency_parse(const struct spa_pod *latency, struct spa_process_latency_info *info)
123{
124 int res;
125 spa_zero(*info);
126 if ((res = spa_pod_parse_object(latency,
127 SPA_TYPE_OBJECT_ParamProcessLatency, NULL,
128 SPA_PARAM_PROCESS_LATENCY_quantum, SPA_POD_OPT_Float(&info->quantum),
129 SPA_PARAM_PROCESS_LATENCY_rate, SPA_POD_OPT_Int(&info->rate),
130 SPA_PARAM_PROCESS_LATENCY_ns, SPA_POD_OPT_Long(&info->ns))) < 0)
131 return res;
132 return 0;
133}
134
135 SPA_API_LATENCY_UTILS struct spa_pod *
136 spa_process_latency_build(struct spa_pod_builder *builder, uint32_t id,
137 const struct spa_process_latency_info *info)
138{
139 return (struct spa_pod *)spa_pod_builder_add_object(builder,
140 SPA_TYPE_OBJECT_ParamProcessLatency, id,
141 SPA_PARAM_PROCESS_LATENCY_quantum, SPA_POD_Float(info->quantum),
142 SPA_PARAM_PROCESS_LATENCY_rate, SPA_POD_Int(info->rate),
143 SPA_PARAM_PROCESS_LATENCY_ns, SPA_POD_Long(info->ns));
144}
145
146 SPA_API_LATENCY_UTILS int
147 spa_process_latency_info_add(const struct spa_process_latency_info *process,
148 struct spa_latency_info *info)
149{
150 info->min_quantum += process->quantum;
151 info->max_quantum += process->quantum;
152 info->min_rate += process->rate;
153 info->max_rate += process->rate;
154 info->min_ns += process->ns;
155 info->max_ns += process->ns;
156 return 0;
157}
158
159 SPA_API_LATENCY_UTILS int
160 spa_process_latency_info_compare(const struct spa_process_latency_info *a,
161 const struct spa_process_latency_info *b)
162{
163 if (a->quantum == b->quantum &&
164 a->rate == b->rate &&
165 a->ns == b->ns)
166 return 0;
167 return 1;
168}
169
173
174#ifdef __cplusplus
175} /* extern "C" */
176#endif
177
178#endif /* SPA_PARAM_LATENCY_UTILS_H */
builder.h
spa/pod/builder.h
res
uint32_t int int res
Definition core.h:433
spa_latency_build
SPA_API_LATENCY_UTILS struct spa_pod * spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
Definition latency-utils.h:115
spa_latency_info_combine_finish
SPA_API_LATENCY_UTILS void spa_latency_info_combine_finish(struct spa_latency_info *info)
Definition latency-utils.h:58
spa_process_latency_info_add
SPA_API_LATENCY_UTILS int spa_process_latency_info_add(const struct spa_process_latency_info *process, struct spa_latency_info *info)
Definition latency-utils.h:154
spa_latency_info_combine
SPA_API_LATENCY_UTILS int spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
Definition latency-utils.h:76
spa_process_latency_parse
SPA_API_LATENCY_UTILS int spa_process_latency_parse(const struct spa_pod *latency, struct spa_process_latency_info *info)
Definition latency-utils.h:129
SPA_LATENCY_INFO_UNSET
#define SPA_LATENCY_INFO_UNSET(dir)
Definition latency.h:66
spa_process_latency_info_compare
SPA_API_LATENCY_UTILS int spa_process_latency_info_compare(const struct spa_process_latency_info *a, const struct spa_process_latency_info *b)
Definition latency-utils.h:167
spa_process_latency_build
SPA_API_LATENCY_UTILS struct spa_pod * spa_process_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_process_latency_info *info)
Definition latency-utils.h:143
SPA_API_LATENCY_UTILS
#define SPA_API_LATENCY_UTILS
Definition latency-utils.h:34
spa_latency_info_compare
SPA_API_LATENCY_UTILS int spa_latency_info_compare(const struct spa_latency_info *a, const struct spa_latency_info *b)
Definition latency-utils.h:39
spa_latency_parse
SPA_API_LATENCY_UTILS int spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
Definition latency-utils.h:96
spa_latency_info_combine_start
SPA_API_LATENCY_UTILS void spa_latency_info_combine_start(struct spa_latency_info *info, enum spa_direction direction)
Definition latency-utils.h:52
SPA_PARAM_PROCESS_LATENCY_rate
@ SPA_PARAM_PROCESS_LATENCY_rate
latency (Int) relative to graph rate
Definition latency.h:80
SPA_PARAM_PROCESS_LATENCY_ns
@ SPA_PARAM_PROCESS_LATENCY_ns
latency (Long) in nanoseconds
Definition latency.h:81
SPA_PARAM_PROCESS_LATENCY_quantum
@ SPA_PARAM_PROCESS_LATENCY_quantum
latency relative to quantum (Float)
Definition latency.h:79
SPA_PARAM_LATENCY_maxNs
@ SPA_PARAM_LATENCY_maxNs
max latency (Long) in nanoseconds
Definition latency.h:50
SPA_PARAM_LATENCY_minRate
@ SPA_PARAM_LATENCY_minRate
min latency (Int) relative to graph rate
Definition latency.h:47
SPA_PARAM_LATENCY_minQuantum
@ SPA_PARAM_LATENCY_minQuantum
min latency relative to quantum (Float)
Definition latency.h:45
SPA_PARAM_LATENCY_maxRate
@ SPA_PARAM_LATENCY_maxRate
max latency (Int) relative to graph rate
Definition latency.h:48
SPA_PARAM_LATENCY_maxQuantum
@ SPA_PARAM_LATENCY_maxQuantum
max latency relative to quantum (Float)
Definition latency.h:46
SPA_PARAM_LATENCY_direction
@ SPA_PARAM_LATENCY_direction
direction, input/output (Id enum spa_direction)
Definition latency.h:44
SPA_PARAM_LATENCY_minNs
@ SPA_PARAM_LATENCY_minNs
min latency (Long) in nanoseconds
Definition latency.h:49
SPA_POD_OPT_Float
#define SPA_POD_OPT_Float(val)
Definition parser.h:870
SPA_POD_Long
#define SPA_POD_Long(val)
Definition vararg.h:71
SPA_POD_Id
#define SPA_POD_Id(val)
Definition vararg.h:53
SPA_POD_OPT_Int
#define SPA_POD_OPT_Int(val)
Definition parser.h:866
spa_pod_builder_add_object
#define spa_pod_builder_add_object(b, type, id,...)
Definition builder.h:725
SPA_POD_Float
#define SPA_POD_Float(val)
Definition vararg.h:84
spa_pod_parse_object
#define spa_pod_parse_object(pod, type, id,...)
Definition parser.h:935
SPA_POD_Int
#define SPA_POD_Int(val)
Definition vararg.h:58
SPA_POD_OPT_Long
#define SPA_POD_OPT_Long(val)
Definition parser.h:868
SPA_TYPE_OBJECT_ParamLatency
@ SPA_TYPE_OBJECT_ParamLatency
Definition type.h:95
SPA_TYPE_OBJECT_ParamProcessLatency
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition type.h:96
spa_zero
#define spa_zero(x)
Definition defs.h:512
spa_direction
spa_direction
Definition defs.h:106
latency.h
spa/param/latency.h
parser.h
spa/pod/parser.h
spa_latency_info
helper structure for managing latency objects
Definition latency.h:54
spa_latency_info::min_rate
int32_t min_rate
Definition latency.h:58
spa_latency_info::min_ns
int64_t min_ns
Definition latency.h:60
spa_latency_info::max_rate
int32_t max_rate
Definition latency.h:59
spa_latency_info::direction
enum spa_direction direction
Definition latency.h:55
spa_latency_info::max_quantum
float max_quantum
Definition latency.h:57
spa_latency_info::min_quantum
float min_quantum
Definition latency.h:56
spa_latency_info::max_ns
int64_t max_ns
Definition latency.h:61
spa_pod_builder
Definition builder.h:63
spa_pod
Definition pod.h:57
spa_process_latency_info
Helper structure for managing process latency objects.
Definition latency.h:85
spa_process_latency_info::ns
int64_t ns
Definition latency.h:88
spa_process_latency_info::quantum
float quantum
Definition latency.h:86
spa_process_latency_info::rate
int32_t rate
Definition latency.h:87