Arduino AudioKit HAL
Public Member Functions | Public Attributes | List of all members
AudioKitConfig Struct Reference

Configuation for AudioKit. More...

#include <AudioKitHAL.h>

Public Member Functions

bool isMaster ()
 Returns true if the CODEC is the master. More...
 
int bitsPerSample ()
 provides the bits per sample More...
 
uint32_t sampleRate ()
 Provides the sample rate in samples per second. More...
 

Public Attributes

i2s_port_t i2s_num = (i2s_port_t)0
 
gpio_num_t mclk_gpio = (gpio_num_t)0
 
bool sd_active = true
 
bool auto_clear = true
 
bool use_apll = true
 
int buffer_count = 6
 
int buffer_size = 512
 
audio_hal_adc_input_t adc_input = AUDIOKIT_DEFAULT_INPUT
 
audio_hal_dac_output_t dac_output =AUDIOKIT_DEFAULT_OUTPUT
 
audio_hal_codec_mode_t codec_mode
 
audio_hal_iface_mode_t master_slave_mode = AUDIOKIT_DEFAULT_MASTER_SLAVE
 
audio_hal_iface_format_t fmt = AUDIOKIT_DEFAULT_I2S_FMT
 
audio_hal_iface_samples_t sample_rate = AUDIOKIT_DEFAULT_RATE
 
audio_hal_iface_bits_t bits_per_sample = AUDIOKIT_DEFAULT_BITSIZE
 

Detailed Description

Configuation for AudioKit.

Definition at line 60 of file AudioKitHAL.h.

Member Function Documentation

◆ bitsPerSample()

int AudioKitConfig::bitsPerSample ( )
inline

provides the bits per sample

Definition at line 82 of file AudioKitHAL.h.

82 {
83 switch (bits_per_sample) {
84 case AUDIO_HAL_BIT_LENGTH_16BITS:
85 return 16;
86 case AUDIO_HAL_BIT_LENGTH_24BITS:
87 return 24;
88 case AUDIO_HAL_BIT_LENGTH_32BITS:
89 return 32;
90 }
91 KIT_LOGE("bits_per_sample not supported: %d", bits_per_sample);
92 return 0;
93 }
audio_hal_iface_bits_t bits_per_sample
Definition: AudioKitHAL.h:76

◆ isMaster()

bool AudioKitConfig::isMaster ( )
inline

Returns true if the CODEC is the master.

Definition at line 79 of file AudioKitHAL.h.

79{ return master_slave_mode == AUDIO_HAL_MODE_MASTER; }
audio_hal_iface_mode_t master_slave_mode
Definition: AudioKitHAL.h:73

◆ sampleRate()

uint32_t AudioKitConfig::sampleRate ( )
inline

Provides the sample rate in samples per second.

< set to 8k samples per second

< set to 11.025k samples per second

< set to 16k samples in per second

< set to 22.050k samples per second

< set to 24k samples in per second

< set to 32k samples in per second

< set to 44.1k samples per second

< set to 48k samples per second

Definition at line 96 of file AudioKitHAL.h.

96 {
97 switch (sample_rate) {
98 case AUDIO_HAL_08K_SAMPLES: /*!< set to 8k samples per second */
99 return 8000;
100 case AUDIO_HAL_11K_SAMPLES: /*!< set to 11.025k samples per second */
101 return 11025;
102 case AUDIO_HAL_16K_SAMPLES: /*!< set to 16k samples in per second */
103 return 16000;
104 case AUDIO_HAL_22K_SAMPLES: /*!< set to 22.050k samples per second */
105 return 22050;
106 case AUDIO_HAL_24K_SAMPLES: /*!< set to 24k samples in per second */
107 return 24000;
108 case AUDIO_HAL_32K_SAMPLES: /*!< set to 32k samples in per second */
109 return 32000;
110 case AUDIO_HAL_44K_SAMPLES: /*!< set to 44.1k samples per second */
111 return 44100;
112 case AUDIO_HAL_48K_SAMPLES: /*!< set to 48k samples per second */
113 return 48000;
114 }
115 KIT_LOGE("sample rate not supported: %d", sample_rate);
116 return 0;
117 }
audio_hal_iface_samples_t sample_rate
Definition: AudioKitHAL.h:75

Member Data Documentation

◆ adc_input

audio_hal_adc_input_t AudioKitConfig::adc_input = AUDIOKIT_DEFAULT_INPUT

set adc channel with audio_hal_adc_input_t

Definition at line 70 of file AudioKitHAL.h.

◆ auto_clear

bool AudioKitConfig::auto_clear = true

Definition at line 64 of file AudioKitHAL.h.

◆ bits_per_sample

audio_hal_iface_bits_t AudioKitConfig::bits_per_sample = AUDIOKIT_DEFAULT_BITSIZE

i2s interface number of bits per sample

Definition at line 76 of file AudioKitHAL.h.

◆ buffer_count

int AudioKitConfig::buffer_count = 6

Definition at line 66 of file AudioKitHAL.h.

◆ buffer_size

int AudioKitConfig::buffer_size = 512

Definition at line 67 of file AudioKitHAL.h.

◆ codec_mode

audio_hal_codec_mode_t AudioKitConfig::codec_mode

select codec mode: adc, dac or both

Definition at line 72 of file AudioKitHAL.h.

◆ dac_output

audio_hal_dac_output_t AudioKitConfig::dac_output =AUDIOKIT_DEFAULT_OUTPUT

set dac channel

Definition at line 71 of file AudioKitHAL.h.

◆ fmt

audio_hal_iface_format_t AudioKitConfig::fmt = AUDIOKIT_DEFAULT_I2S_FMT

I2S interface format

Definition at line 74 of file AudioKitHAL.h.

◆ i2s_num

i2s_port_t AudioKitConfig::i2s_num = (i2s_port_t)0

Definition at line 61 of file AudioKitHAL.h.

◆ master_slave_mode

audio_hal_iface_mode_t AudioKitConfig::master_slave_mode = AUDIOKIT_DEFAULT_MASTER_SLAVE

audio codec chip mode

Definition at line 73 of file AudioKitHAL.h.

◆ mclk_gpio

gpio_num_t AudioKitConfig::mclk_gpio = (gpio_num_t)0

Definition at line 62 of file AudioKitHAL.h.

◆ sample_rate

audio_hal_iface_samples_t AudioKitConfig::sample_rate = AUDIOKIT_DEFAULT_RATE

I2S interface samples per second

Definition at line 75 of file AudioKitHAL.h.

◆ sd_active

bool AudioKitConfig::sd_active = true

Definition at line 63 of file AudioKitHAL.h.

◆ use_apll

bool AudioKitConfig::use_apll = true

Definition at line 65 of file AudioKitHAL.h.


The documentation for this struct was generated from the following file: