audio_rate_control.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _AUDIO_RATE_CONTROL_H_
#define _AUDIO_RATE_CONTROL_H_
 
enum audio_rate_control_state {
        AUDIO_RATE_CONTROL_STATE_UNINITIALIZED = 0,
        AUDIO_RATE_CONTROL_STATE_INITIALIZED,
};
 
struct audio_rate_control_imp_ctx;
 
struct audio_rate_control_cfg;
 
struct audio_rate_control_ops {
        int (*initialize)(struct audio_rate_control_imp_ctx *const ctx);
 
        int (*uninitialize)(struct audio_rate_control_imp_ctx *ctx);
 
        int (*reset)(struct audio_rate_control_imp_ctx *const ctx);
 
        int (*cfg_set)(struct audio_rate_control_imp_ctx *const ctx,
                       struct audio_rate_control_cfg const *const cfg);
 
        int (*cfg_get)(struct audio_rate_control_imp_ctx const *const ctx,
                       struct audio_rate_control_cfg *cfg);
 
        int (*update)(struct audio_rate_control_imp_ctx *const ctx, void *const control_val_u);
};
 
struct audio_rate_control_ctx {
        /* Opaque structure to the implemented rate control context.
         * The structure and the pointer, must remain valid for the
         * lifetime of the instance of the module.
         */
        struct audio_rate_control_imp_ctx *imp_ctx;
 
        /* Audio rate_control state */
        enum audio_rate_control_state state;
 
        /* Callbacks for the rate control implementation */
        struct audio_rate_control_ops cb;
};
 
int audio_rate_control_init(struct audio_rate_control_ctx *const ctx,
                            struct audio_rate_control_imp_ctx *const imp_ctx,
                            struct audio_rate_control_ops const *const imp_cb);
 
int audio_rate_control_uninit(struct audio_rate_control_ctx *ctx);
 
int audio_rate_control_reset(struct audio_rate_control_ctx *const ctx);
 
int audio_rate_control_cfg_set(struct audio_rate_control_ctx *const ctx,
                               struct audio_rate_control_cfg const *const cfg);
 
int audio_rate_control_cfg_get(struct audio_rate_control_ctx const *const ctx,
                               struct audio_rate_control_cfg *const cfg);
 
int audio_rate_control_update(struct audio_rate_control_ctx *const ctx, void *const control_val_u);
 
#endif /* _AUDIO_RATE_CONTROL_H_ */