Loading...
Searching...
No Matches
latency-utils.h
Go to the documentation of this file.
/* Simple Plugin API */
/* SPDX-FileCopyrightText: Copyright © 2021 Wim Taymans */
/* SPDX-License-Identifier: MIT */
#ifndef SPA_PARAM_LATENCY_UTILS_H
#define SPA_PARAM_LATENCY_UTILS_H
#include <float.h>
#include <spa/pod/builder.h>
#include <spa/pod/parser.h>
#include <spa/param/latency.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef SPA_API_LATENCY_UTILS
#ifdef SPA_API_IMPL
#define SPA_API_LATENCY_UTILS SPA_API_IMPL
#else
#define SPA_API_LATENCY_UTILS static inline
#endif
#endif
SPA_API_LATENCY_UTILS int
spa_latency_info_compare(const struct spa_latency_info *a, const struct spa_latency_info *b)
{
if (a->min_quantum == b->min_quantum &&
a->max_quantum == b->max_quantum &&
a->min_rate == b->min_rate &&
a->max_rate == b->max_rate &&
a->min_ns == b->min_ns &&
a->max_ns == b->max_ns)
return 0;
return 1;
}
SPA_API_LATENCY_UTILS void
spa_latency_info_combine_start(struct spa_latency_info *info, enum spa_direction direction)
{
*info = SPA_LATENCY_INFO_UNSET(direction);
}
SPA_API_LATENCY_UTILS void
spa_latency_info_combine_finish(struct spa_latency_info *info)
{
struct spa_latency_info unset = SPA_LATENCY_INFO_UNSET(info->direction);
if (info->min_quantum == unset.min_quantum)
info->min_quantum = 0;
if (info->max_quantum == unset.max_quantum)
info->max_quantum = 0;
if (info->min_rate == unset.min_rate)
info->min_rate = 0;
if (info->max_rate == unset.max_rate)
info->max_rate = 0;
if (info->min_ns == unset.min_ns)
info->min_ns = 0;
if (info->max_ns == unset.max_ns)
info->max_ns = 0;
}
SPA_API_LATENCY_UTILS int
spa_latency_info_combine(struct spa_latency_info *info, const struct spa_latency_info *other)
{
if (info->direction != other->direction)
return -EINVAL;
if (other->min_quantum < info->min_quantum)
info->min_quantum = other->min_quantum;
if (other->max_quantum > info->max_quantum)
info->max_quantum = other->max_quantum;
if (other->min_rate < info->min_rate)
info->min_rate = other->min_rate;
if (other->max_rate > info->max_rate)
info->max_rate = other->max_rate;
if (other->min_ns < info->min_ns)
info->min_ns = other->min_ns;
if (other->max_ns > info->max_ns)
info->max_ns = other->max_ns;
return 0;
}
SPA_API_LATENCY_UTILS int
spa_latency_parse(const struct spa_pod *latency, struct spa_latency_info *info)
{
int res;
spa_zero(*info);
if ((res = spa_pod_parse_object(latency,
SPA_TYPE_OBJECT_ParamLatency, NULL,
SPA_PARAM_LATENCY_direction, SPA_POD_Id(&info->direction),
SPA_PARAM_LATENCY_minQuantum, SPA_POD_OPT_Float(&info->min_quantum),
SPA_PARAM_LATENCY_maxQuantum, SPA_POD_OPT_Float(&info->max_quantum),
SPA_PARAM_LATENCY_minRate, SPA_POD_OPT_Int(&info->min_rate),
SPA_PARAM_LATENCY_maxRate, SPA_POD_OPT_Int(&info->max_rate),
SPA_PARAM_LATENCY_minNs, SPA_POD_OPT_Long(&info->min_ns),
SPA_PARAM_LATENCY_maxNs, SPA_POD_OPT_Long(&info->max_ns))) < 0)
return res;
info->direction = (enum spa_direction)(info->direction & 1);
return 0;
}
SPA_API_LATENCY_UTILS struct spa_pod *
spa_latency_build(struct spa_pod_builder *builder, uint32_t id, const struct spa_latency_info *info)
{
return (struct spa_pod *)spa_pod_builder_add_object(builder,
SPA_TYPE_OBJECT_ParamLatency, id,
SPA_PARAM_LATENCY_direction, SPA_POD_Id(info->direction),
SPA_PARAM_LATENCY_minQuantum, SPA_POD_Float(info->min_quantum),
SPA_PARAM_LATENCY_maxQuantum, SPA_POD_Float(info->max_quantum),
SPA_PARAM_LATENCY_minRate, SPA_POD_Int(info->min_rate),
SPA_PARAM_LATENCY_maxRate, SPA_POD_Int(info->max_rate),
SPA_PARAM_LATENCY_minNs, SPA_POD_Long(info->min_ns),
SPA_PARAM_LATENCY_maxNs, SPA_POD_Long(info->max_ns));
}
SPA_API_LATENCY_UTILS int
spa_process_latency_parse(const struct spa_pod *latency, struct spa_process_latency_info *info)
{
int res;
spa_zero(*info);
if ((res = spa_pod_parse_object(latency,
SPA_TYPE_OBJECT_ParamProcessLatency, NULL,
SPA_PARAM_PROCESS_LATENCY_quantum, SPA_POD_OPT_Float(&info->quantum),
SPA_PARAM_PROCESS_LATENCY_rate, SPA_POD_OPT_Int(&info->rate),
SPA_PARAM_PROCESS_LATENCY_ns, SPA_POD_OPT_Long(&info->ns))) < 0)
return res;
return 0;
}
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)
{
return (struct spa_pod *)spa_pod_builder_add_object(builder,
SPA_TYPE_OBJECT_ParamProcessLatency, id,
SPA_PARAM_PROCESS_LATENCY_quantum, SPA_POD_Float(info->quantum),
SPA_PARAM_PROCESS_LATENCY_rate, SPA_POD_Int(info->rate),
SPA_PARAM_PROCESS_LATENCY_ns, SPA_POD_Long(info->ns));
}
SPA_API_LATENCY_UTILS int
spa_process_latency_info_add(const struct spa_process_latency_info *process,
struct spa_latency_info *info)
{
info->min_quantum += process->quantum;
info->max_quantum += process->quantum;
info->min_rate += process->rate;
info->max_rate += process->rate;
info->min_ns += process->ns;
info->max_ns += process->ns;
return 0;
}
SPA_API_LATENCY_UTILS int
spa_process_latency_info_compare(const struct spa_process_latency_info *a,
const struct spa_process_latency_info *b)
{
if (a->quantum == b->quantum &&
a->rate == b->rate &&
a->ns == b->ns)
return 0;
return 1;
}
#ifdef __cplusplus
} /* extern "C" */
#endif
#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