codec.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_AUDIO_CODEC_H_
#define ZEPHYR_INCLUDE_AUDIO_CODEC_H_
 
#include <zephyr/drivers/i2s.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
        AUDIO_PCM_RATE_8K       = 8000,
        AUDIO_PCM_RATE_16K      = 16000,
        AUDIO_PCM_RATE_24K      = 24000,
        AUDIO_PCM_RATE_32K      = 32000,
        AUDIO_PCM_RATE_44P1K    = 44100,
        AUDIO_PCM_RATE_48K      = 48000,
        AUDIO_PCM_RATE_96K      = 96000,
        AUDIO_PCM_RATE_192K     = 192000,
} audio_pcm_rate_t;
 
typedef enum {
        AUDIO_PCM_WIDTH_16_BITS = 16,
        AUDIO_PCM_WIDTH_20_BITS = 20,
        AUDIO_PCM_WIDTH_24_BITS = 24,
        AUDIO_PCM_WIDTH_32_BITS = 32,
} audio_pcm_width_t;
 
typedef enum {
        AUDIO_DAI_TYPE_I2S,     /* I2S Interface */
        AUDIO_DAI_TYPE_INVALID, /* Other interfaces can be added here */
} audio_dai_type_t;
 
typedef enum {
        AUDIO_PROPERTY_OUTPUT_VOLUME,
        AUDIO_PROPERTY_OUTPUT_MUTE,
} audio_property_t;
 
typedef enum {
        AUDIO_CHANNEL_FRONT_LEFT,
        AUDIO_CHANNEL_FRONT_RIGHT,
        AUDIO_CHANNEL_LFE,
        AUDIO_CHANNEL_FRONT_CENTER,
        AUDIO_CHANNEL_REAR_LEFT,
        AUDIO_CHANNEL_REAR_RIGHT,
        AUDIO_CHANNEL_REAR_CENTER,
        AUDIO_CHANNEL_SIDE_LEFT,
        AUDIO_CHANNEL_SIDE_RIGHT,
        AUDIO_CHANNEL_ALL,
} audio_channel_t;
 
typedef union {
        struct i2s_config i2s;  /* I2S configuration */
                                /* Other DAI types go here */
} audio_dai_cfg_t;
 
struct audio_codec_cfg {
        uint32_t                        mclk_freq;      /* MCLK input frequency in Hz */
        audio_dai_type_t        dai_type;       /* Digital interface type */
        audio_dai_cfg_t         dai_cfg;        /* DAI configuration info */
};
 
typedef union {
        int     vol;    /* Volume level in 0.5dB resolution */
        bool    mute;   /* mute if true, unmute if false */
} audio_property_value_t;
 
struct audio_codec_api {
        int (*configure)(const struct device *dev,
                         struct audio_codec_cfg *cfg);
        void (*start_output)(const struct device *dev);
        void (*stop_output)(const struct device *dev);
        int (*set_property)(const struct device *dev,
                            audio_property_t property,
                            audio_channel_t channel,
                            audio_property_value_t val);
        int (*apply_properties)(const struct device *dev);
};
static inline int audio_codec_configure(const struct device *dev,
                                        struct audio_codec_cfg *cfg)
{
        const struct audio_codec_api *api =
                (const struct audio_codec_api *)dev->api;
 
        return api->configure(dev, cfg);
}
 
static inline void audio_codec_start_output(const struct device *dev)
{
        const struct audio_codec_api *api =
                (const struct audio_codec_api *)dev->api;
 
        api->start_output(dev);
}
 
static inline void audio_codec_stop_output(const struct device *dev)
{
        const struct audio_codec_api *api =
                (const struct audio_codec_api *)dev->api;
 
        api->stop_output(dev);
}
 
static inline int audio_codec_set_property(const struct device *dev,
                                           audio_property_t property,
                                           audio_channel_t channel,
                                           audio_property_value_t val)
{
        const struct audio_codec_api *api =
                (const struct audio_codec_api *)dev->api;
 
        return api->set_property(dev, property, channel, val);
}
 
static inline int audio_codec_apply_properties(const struct device *dev)
{
        const struct audio_codec_api *api =
                (const struct audio_codec_api *)dev->api;
 
        return api->apply_properties(dev);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_AUDIO_CODEC_H_ */