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_
 
#include <stdint.h>
#include <stdbool.h>

enum audio_rate_control_state {
        AUDIO_RATE_CONTROL_STATE_EMPTY = 0,
        AUDIO_RATE_CONTROL_STATE_UNINITIALIZED,
        AUDIO_RATE_CONTROL_STATE_INITIALIZED,
};

enum audio_rate_control_type {
        AUDIO_PLL = 0,
        USB_ASYNC = 1,
        I2S = 2,
        AUDIO_RATE_CONTROL_TYPE_COUNT,
};

struct audio_rate_control_cfg;

struct audio_rate_control_ops {
        int (*initialize)(void);

        int (*uninitialize)(void);

        int (*reset)(void);

        int (*cfg_set)(struct audio_rate_control_cfg const *const cfg);

        int (*cfg_get)(struct audio_rate_control_cfg *cfg);

        int (*update)(void *const control_val_u);
};

struct audio_rate_control_ctx {
        /* Audio rate_control state */
        enum audio_rate_control_state state;
 
        /* Callbacks for the rate control implementation */
        struct audio_rate_control_ops ops;
};

int audio_rate_control_reset(enum audio_rate_control_type type);

int audio_rate_control_cfg_set(enum audio_rate_control_type type,
                               struct audio_rate_control_cfg const *const cfg);

int audio_rate_control_cfg_get(enum audio_rate_control_type type,
                               struct audio_rate_control_cfg *const cfg);

int audio_rate_control_update(enum audio_rate_control_type type, void *const control_val_u);

int audio_rate_control_register(enum audio_rate_control_type type,
                                struct audio_rate_control_ops const *const imp_ops);

int audio_rate_control_uninit(enum audio_rate_control_type type);

int audio_rate_control_init(enum audio_rate_control_type type);

 
#endif /* _AUDIO_RATE_CONTROL_H_ */