PipeWire  1.6.4
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
15 extern "C" {
16 #endif
17 
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 
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 
46 {
47  *info = SPA_LATENCY_INFO_UNSET(direction);
48 }
49 
52 {
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 
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 
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,
102  return res;
103  info->direction = (enum spa_direction)(info->direction & 1);
104  return 0;
105 }
106 
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,
119 }
120 
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,
131  return res;
132  return 0;
133 }
134 
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,
144 }
145 
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 
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 
174 #ifdef __cplusplus
175 } /* extern "C" */
176 #endif
177 
178 #endif /* SPA_PARAM_LATENCY_UTILS_H */
spa/pod/builder.h
uint32_t int int res
Definition: core.h:433
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_API_LATENCY_UTILS void spa_latency_info_combine_finish(struct spa_latency_info *info)
Definition: latency-utils.h:58
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_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_API_LATENCY_UTILS int spa_process_latency_parse(const struct spa_pod *latency, struct spa_process_latency_info *info)
Definition: latency-utils.h:129
#define SPA_LATENCY_INFO_UNSET(dir)
Definition: latency.h:66
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
#define SPA_API_LATENCY_UTILS
Definition: latency-utils.h:34
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_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 int spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
Definition: latency-utils.h:96
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
latency (Int) relative to graph rate
Definition: latency.h:80
@ SPA_PARAM_PROCESS_LATENCY_ns
latency (Long) in nanoseconds
Definition: latency.h:81
@ SPA_PARAM_PROCESS_LATENCY_quantum
latency relative to quantum (Float)
Definition: latency.h:79
@ SPA_PARAM_LATENCY_maxNs
max latency (Long) in nanoseconds
Definition: latency.h:50
@ SPA_PARAM_LATENCY_minRate
min latency (Int) relative to graph rate
Definition: latency.h:47
@ SPA_PARAM_LATENCY_minQuantum
min latency relative to quantum (Float)
Definition: latency.h:45
@ SPA_PARAM_LATENCY_maxRate
max latency (Int) relative to graph rate
Definition: latency.h:48
@ SPA_PARAM_LATENCY_maxQuantum
max latency relative to quantum (Float)
Definition: latency.h:46
@ SPA_PARAM_LATENCY_direction
direction, input/output (Id enum spa_direction)
Definition: latency.h:44
@ SPA_PARAM_LATENCY_minNs
min latency (Long) in nanoseconds
Definition: latency.h:49
#define SPA_POD_OPT_Float(val)
Definition: parser.h:870
#define SPA_POD_Long(val)
Definition: vararg.h:71
#define SPA_POD_Id(val)
Definition: vararg.h:53
#define SPA_POD_OPT_Int(val)
Definition: parser.h:866
#define spa_pod_builder_add_object(b, type, id,...)
Definition: builder.h:725
#define SPA_POD_Float(val)
Definition: vararg.h:84
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:935
#define SPA_POD_Int(val)
Definition: vararg.h:58
#define SPA_POD_OPT_Long(val)
Definition: parser.h:868
@ SPA_TYPE_OBJECT_ParamLatency
Definition: type.h:95
@ SPA_TYPE_OBJECT_ParamProcessLatency
Definition: type.h:96
#define spa_zero(x)
Definition: defs.h:512
spa_direction
Definition: defs.h:106
spa/param/latency.h
spa/pod/parser.h
helper structure for managing latency objects
Definition: latency.h:54
int32_t min_rate
Definition: latency.h:58
int64_t min_ns
Definition: latency.h:60
int32_t max_rate
Definition: latency.h:59
enum spa_direction direction
Definition: latency.h:55
float max_quantum
Definition: latency.h:57
float min_quantum
Definition: latency.h:56
int64_t max_ns
Definition: latency.h:61
Definition: builder.h:63
Definition: pod.h:57
Helper structure for managing process latency objects.
Definition: latency.h:85
int64_t ns
Definition: latency.h:88
float quantum
Definition: latency.h:86
int32_t rate
Definition: latency.h:87