PipeWire 0.3.39
latency-utils.h
Go to the documentation of this file.
1/* Simple Plugin API
2 *
3 * Copyright © 2021 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_LATENCY_UTILS_H
26#define SPA_PARAM_LATENCY_UTILS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
37#include <spa/pod/builder.h>
38#include <spa/pod/parser.h>
39#include <spa/param/param.h>
40
41struct spa_latency_info {
43 float min_quantum;
44 float max_quantum;
45 uint32_t min_rate;
46 uint32_t max_rate;
47 uint64_t min_ns;
48 uint64_t max_ns;
49};
51#define SPA_LATENCY_INFO(dir,...) (struct spa_latency_info) { .direction = (dir), ## __VA_ARGS__ }
53static inline int
55{
56 if (a->min_quantum == b->min_quantum &&
58 a->min_rate == b->min_rate &&
59 a->max_rate == b->max_rate &&
60 a->min_ns == b->min_ns &&
61 a->max_ns == b->max_ns)
62 return 0;
63 return 1;
64}
65
66static inline int
67spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
68{
69 if (info->direction != other->direction)
70 return -EINVAL;
71 if (info->min_quantum == 0.0f || other->min_quantum < info->min_quantum)
72 info->min_quantum = other->min_quantum;
73 if (other->max_quantum > info->max_quantum)
74 info->max_quantum = other->max_quantum;
75 if (info->min_rate == 0U || other->min_rate < info->min_rate)
76 info->min_rate = other->min_rate;
77 if (other->max_rate > info->max_rate)
78 info->max_rate = other->max_rate;
79 if (info->min_ns == 0UL || other->min_ns < info->min_ns)
80 info->min_ns = other->min_ns;
81 if (other->max_ns > info->max_ns)
82 info->max_ns = other->max_ns;
83 return 0;
84}
85
86static inline int
87spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
88{
89 int res;
90 spa_zero(*info);
91 if ((res = spa_pod_parse_object(latency,
100 return res;
101 info->direction = (enum spa_direction)(info->direction & 1);
102 return 0;
103}
104
105static inline struct spa_pod *
106spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
107{
108 return (struct spa_pod *)spa_pod_builder_add_object(builder,
117}
118
120 float quantum;
121 uint32_t rate;
122 uint64_t ns;
123};
124
125#define SPA_PROCESS_LATENCY_INFO_INIT(...) (struct spa_process_latency_info) { __VA_ARGS__ }
127static inline int
129{
130 int res;
131 spa_zero(*info);
132 if ((res = spa_pod_parse_object(latency,
137 return res;
138 return 0;
139}
140
141static inline struct spa_pod *
142spa_process_latency_build(struct spa_pod_builder *builder, uint32_t id,
143 const struct spa_process_latency_info *info)
144{
145 return (struct spa_pod *)spa_pod_builder_add_object(builder,
150}
151
152static inline int
154 struct spa_latency_info *info)
155{
156 info->min_quantum += process->quantum;
157 info->max_quantum += process->quantum;
158 info->min_rate += process->rate;
159 info->max_rate += process->rate;
160 info->min_ns += process->ns;
161 info->max_ns += process->ns;
162 return 0;
163}
164
169#ifdef __cplusplus
170} /* extern "C" */
171#endif
172
173#endif /* SPA_PARAM_LATENCY_UTILS_H */
spa/pod/builder.h
static int spa_latency_info_compare(const struct spa_latency_info *a, struct spa_latency_info *b)
Definition: latency-utils.h:60
static int spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
Definition: latency-utils.h:93
static 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:149
static int spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
Definition: latency-utils.h:73
static struct spa_pod * spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
Definition: latency-utils.h:112
static int spa_process_latency_info_add(const struct spa_process_latency_info *process, struct spa_latency_info *info)
Definition: latency-utils.h:160
static int spa_process_latency_parse(const struct spa_pod *latency, struct spa_process_latency_info *info)
Definition: latency-utils.h:135
@ SPA_PARAM_PROCESS_LATENCY_rate
latency (Int) relative to rate
Definition: param.h:204
@ SPA_PARAM_PROCESS_LATENCY_ns
latency (Long) in nanoseconds
Definition: param.h:205
@ SPA_PARAM_PROCESS_LATENCY_quantum
latency relative to quantum (Float)
Definition: param.h:203
@ SPA_PARAM_LATENCY_maxNs
max latency (Long) in nanoseconds
Definition: param.h:197
@ SPA_PARAM_LATENCY_minRate
min latency (Int) relative to rate
Definition: param.h:194
@ SPA_PARAM_LATENCY_minQuantum
min latency relative to quantum (Float)
Definition: param.h:192
@ SPA_PARAM_LATENCY_maxRate
max latency (Int) relative to rate
Definition: param.h:195
@ SPA_PARAM_LATENCY_maxQuantum
max latency relative to quantum (Float)
Definition: param.h:193
@ SPA_PARAM_LATENCY_direction
direction, input/output (Id enum spa_direction)
Definition: param.h:191
@ SPA_PARAM_LATENCY_minNs
min latency (Long) in nanoseconds
Definition: param.h:196
#define SPA_POD_OPT_Float(val)
Definition: parser.h:534
#define SPA_POD_Long(val)
Definition: vararg.h:85
#define SPA_POD_Id(val)
Definition: vararg.h:69
#define SPA_POD_OPT_Int(val)
Definition: parser.h:530
#define spa_pod_builder_add_object(b, type, id,...)
Definition: builder.h:677
#define SPA_POD_Float(val)
Definition: vararg.h:96
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:584
#define SPA_POD_Int(val)
Definition: vararg.h:74
#define SPA_POD_OPT_Long(val)
Definition: parser.h:532
@ SPA_TYPE_OBJECT_ParamLatency
Definition: type.h:104
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition: type.h:105
#define spa_zero(x)
Definition: defs.h:380
spa_direction
Definition: defs.h:90
spa/param/param.h
spa/pod/parser.h
Definition: latency-utils.h:46
uint32_t min_rate
Definition: latency-utils.h:50
uint32_t max_rate
Definition: latency-utils.h:51
enum spa_direction direction
Definition: latency-utils.h:47
float max_quantum
Definition: latency-utils.h:49
float min_quantum
Definition: latency-utils.h:48
uint64_t min_ns
Definition: latency-utils.h:52
uint64_t max_ns
Definition: latency-utils.h:53
Definition: builder.h:73
Definition: pod.h:63
Definition: latency-utils.h:125
float quantum
Definition: latency-utils.h:126
uint32_t rate
Definition: latency-utils.h:127
uint64_t ns
Definition: latency-utils.h:128