latency.h

Go to the documentation of this file.

/* Simple Plugin API */
/* SPDX-FileCopyrightText: Copyright © 2023 Wim Taymans */
/* SPDX-License-Identifier: MIT */
 
#ifndef SPA_PARAM_LATENY_H
#define SPA_PARAM_LATENY_H
 
#include <spa/param/param.h>
 
#ifdef __cplusplus
extern "C" {
#endif


enum spa_param_latency {
        SPA_PARAM_LATENCY_START,
        SPA_PARAM_LATENCY_direction,            
        SPA_PARAM_LATENCY_minQuantum,           
        SPA_PARAM_LATENCY_maxQuantum,           
        SPA_PARAM_LATENCY_minRate,              
        SPA_PARAM_LATENCY_maxRate,              
        SPA_PARAM_LATENCY_minNs,                
        SPA_PARAM_LATENCY_maxNs,                
};

struct spa_latency_info {
        enum spa_direction direction;
        float min_quantum;
        float max_quantum;
        int32_t min_rate;
        int32_t max_rate;
        int64_t min_ns;
        int64_t max_ns;
};
 
#define SPA_LATENCY_INFO(dir,...) ((struct spa_latency_info) { .direction = (dir), ## __VA_ARGS__ })
#define SPA_LATENCY_INFO_UNSET(dir) SPA_LATENCY_INFO(dir,       \
                .min_quantum = FLT_MAX, .max_quantum = FLT_MIN, \
                .min_rate = INT32_MAX, .max_rate = INT32_MIN,   \
                .min_ns = INT64_MAX, .max_ns = INT64_MIN)

 * Properties for SPA_TYPE_OBJECT_ParamProcessLatency
 *
 * The processing latency indicates logical time delay between a sample in an input port,
 * and a corresponding sample in an output port, relative to the graph time.
 */
enum spa_param_process_latency {
        SPA_PARAM_PROCESS_LATENCY_START,
        SPA_PARAM_PROCESS_LATENCY_quantum,      
        SPA_PARAM_PROCESS_LATENCY_rate,         
        SPA_PARAM_PROCESS_LATENCY_ns,           
};

struct spa_process_latency_info {
        float quantum;
        int32_t rate;
        int64_t ns;
};
 
#define SPA_PROCESS_LATENCY_INFO_INIT(...)      ((struct spa_process_latency_info) { __VA_ARGS__ })

 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif /* SPA_PARAM_LATENY_H */