PipeWire  0.3.29
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
29 extern "C" {
30 #endif
31 
32 
33 #include <spa/pod/parser.h>
34 
37  float min_quantum;
38  float max_quantum;
39  uint32_t min_rate;
40  uint32_t max_rate;
41  uint64_t min_ns;
42  uint64_t max_ns;
43 };
44 
45 #define SPA_LATENCY_INFO(dir) (struct spa_latency_info) { .direction = (dir) }
46 
47 /* static */ inline int
49 {
50  if (a->min_quantum == b->min_quantum &&
51  a->max_quantum == b->max_quantum &&
52  a->min_rate == b->min_rate &&
53  a->max_rate == b->max_rate &&
54  a->min_ns == b->min_ns &&
55  a->max_ns == b->max_ns)
56  return 0;
57  return 1;
58 }
59 
60 /* static */ inline int
62 {
63  if (info->direction != other->direction)
64  return -EINVAL;
65  if (info->min_quantum == 0.0f || other->min_quantum < info->min_quantum)
66  info->min_quantum = other->min_quantum;
67  if (other->max_quantum > info->max_quantum)
68  info->max_quantum = other->max_quantum;
69  if (info->min_rate == 0U || other->min_rate < info->min_rate)
70  info->min_rate = other->min_rate;
71  if (other->max_rate > info->max_rate)
72  info->max_rate = other->max_rate;
73  if (info->min_ns == 0UL || other->min_ns < info->min_ns)
74  info->min_ns = other->min_ns;
75  if (other->max_ns > info->max_ns)
76  info->max_ns = other->max_ns;
77  return 0;
78 }
79 
80 /* static */ inline int
81 spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
82 {
83  int res;
84  spa_zero(*info);
85  if ((res = spa_pod_parse_object(latency,
94  return res;
95  info->direction &= 1;
96  return 0;
97 }
98 
99 /* static */ inline struct spa_pod *
100 spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
101 {
102  return spa_pod_builder_add_object(builder,
111 }
112 
113 #ifdef __cplusplus
114 } /* extern "C" */
115 #endif
116 
117 #endif /* SPA_PARAM_LATENCY_UTILS_H */
#define SPA_POD_OPT_Long(val)
Definition: parser.h:522
int spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
Definition: latency-utils.h:61
direction, input/output (Id enum spa_direction)
Definition: param.h:180
#define SPA_POD_Int(val)
Definition: vararg.h:59
#define SPA_POD_Float(val)
Definition: vararg.h:71
Definition: latency-utils.h:35
spa_direction
Definition: defs.h:77
int spa_latency_info_compare(const struct spa_latency_info *a, struct spa_latency_info *b)
Definition: latency-utils.h:48
max latency (Long) in nanoseconds
Definition: param.h:186
#define SPA_POD_OPT_Float(val)
Definition: parser.h:523
min latency relative to quantum (Float)
Definition: param.h:181
int spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
Definition: latency-utils.h:81
min latency (Long) in nanoseconds
Definition: param.h:185
static uint32_t int int res
Definition: core.h:328
float min_quantum
Definition: latency-utils.h:37
max latency (Int) relative to rate
Definition: param.h:184
#define SPA_POD_OPT_Int(val)
Definition: parser.h:521
enum spa_direction direction
Definition: latency-utils.h:36
uint64_t max_ns
Definition: latency-utils.h:42
struct spa_pod * spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
Definition: latency-utils.h:100
uint32_t min_rate
Definition: latency-utils.h:39
float max_quantum
Definition: latency-utils.h:38
Definition: pod/pod.h:50
#define spa_pod_parse_object(pod, type, id,...)
Definition: parser.h:560
#define spa_zero(x)
Definition: defs.h:288
uint64_t min_ns
Definition: latency-utils.h:41
min latency (Int) relative to rate
Definition: param.h:183
Definition: builder.h:63
uint32_t max_rate
Definition: latency-utils.h:40
max latency relative to quantum (Float)
Definition: param.h:182
#define SPA_POD_Id(val)
Definition: vararg.h:56
Definition: x86_64-redhat-linux-gnu/doc/spa/utils/type.h:98
#define spa_pod_builder_add_object(b, type, id,...)
Definition: builder.h:650
#define SPA_POD_Long(val)
Definition: vararg.h:65