LibDriver VS1053B
Loading...
Searching...
No Matches
driver_vs1053b_basic.h
Go to the documentation of this file.
1
36
37#ifndef DRIVER_VS1053B_BASIC_H
38#define DRIVER_VS1053B_BASIC_H
39
41
42#ifdef __cplusplus
43extern "C"{
44#endif
45
52
56#define VS1053B_BASIC_DEFAULT_PLAY_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_3P5_XTALI
57#define VS1053B_BASIC_DEFAULT_PLAY_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_2P0_XTALI
58#define VS1053B_BASIC_DEFAULT_PLAY_CLOCK_FREQUENCY 8000000.0f
59#define VS1053B_BASIC_DEFAULT_PLAY_DIFF VS1053B_DIFF_NORMAL
60#define VS1053B_BASIC_DEFAULT_PLAY_MPEG_LAYER_I_AND_II VS1053B_BOOL_TRUE
61#define VS1053B_BASIC_DEFAULT_PLAY_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
62#define VS1053B_BASIC_DEFAULT_PLAY_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
63#define VS1053B_BASIC_DEFAULT_PLAY_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
64#define VS1053B_BASIC_DEFAULT_PLAY_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
65#define VS1053B_BASIC_DEFAULT_PLAY_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
66#define VS1053B_BASIC_DEFAULT_PLAY_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
67#define VS1053B_BASIC_DEFAULT_PLAY_SELECTOR VS1053B_SELECTOR_MICP
68#define VS1053B_BASIC_DEFAULT_PLAY_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
69#define VS1053B_BASIC_DEFAULT_PLAY_DO_NOT_JUMP VS1053B_BOOL_FALSE
70#define VS1053B_BASIC_DEFAULT_PLAY_SWING 0.0f
71#define VS1053B_BASIC_DEFAULT_PLAY_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
72#define VS1053B_BASIC_DEFAULT_PLAY_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
73#define VS1053B_BASIC_DEFAULT_PLAY_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
74#define VS1053B_BASIC_DEFAULT_PLAY_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
75#define VS1053B_BASIC_DEFAULT_PLAY_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
76#define VS1053B_BASIC_DEFAULT_PLAY_TREBLE_CONTROL 22.5f
77#define VS1053B_BASIC_DEFAULT_PLAY_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 10000
78#define VS1053B_BASIC_DEFAULT_PLAY_BASS_ENHANCEMENT 15
79#define VS1053B_BASIC_DEFAULT_PLAY_LOWER_LIMIT_FREQUENCY_IN_10_HZ 60
80#define VS1053B_BASIC_DEFAULT_PLAY_VOL -10.0f
81#define VS1053B_BASIC_DEFAULT_PLAY_SPEED VS1053B_PLAY_SPEED_1P0_X
82#define VS1053B_BASIC_DEFAULT_PLAY_IIS_OUTPUT VS1053B_BOOL_FALSE
83#define VS1053B_BASIC_DEFAULT_PLAY_IIS_MCLK_OUTPUT VS1053B_BOOL_TRUE
84#define VS1053B_BASIC_DEFAULT_PLAY_IIS_RATE VS1053B_IIS_RATE_48KHZ
85#define VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_2P0_XTALI
86#define VS1053B_BASIC_DEFAULT_RECORD_WAV_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE
87#define VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_FREQUENCY 8000000.0f
88#define VS1053B_BASIC_DEFAULT_RECORD_WAV_DO_NOT_JUMP VS1053B_BOOL_FALSE
89#define VS1053B_BASIC_DEFAULT_RECORD_WAV_SWING 0.0f
90#define VS1053B_BASIC_DEFAULT_RECORD_WAV_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
91#define VS1053B_BASIC_DEFAULT_RECORD_WAV_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
92#define VS1053B_BASIC_DEFAULT_RECORD_WAV_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
93#define VS1053B_BASIC_DEFAULT_RECORD_WAV_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
94#define VS1053B_BASIC_DEFAULT_RECORD_WAV_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
95#define VS1053B_BASIC_DEFAULT_RECORD_WAV_TREBLE_CONTROL 0.0f
96#define VS1053B_BASIC_DEFAULT_RECORD_WAV_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 0
97#define VS1053B_BASIC_DEFAULT_RECORD_WAV_BASS_ENHANCEMENT 0
98#define VS1053B_BASIC_DEFAULT_RECORD_WAV_LOWER_LIMIT_FREQUENCY_IN_10_HZ 0
99#define VS1053B_BASIC_DEFAULT_RECORD_WAV_VOL -100.0f
100#define VS1053B_BASIC_DEFAULT_RECORD_WAV_SAMPLE 8000
101#define VS1053B_BASIC_DEFAULT_RECORD_WAV_TIMES 1024 * 5
102#define VS1053B_BASIC_DEFAULT_RECORD_WAV_GAIN 0
103#define VS1053B_BASIC_DEFAULT_RECORD_WAV_CHANNEL (VS1053B_AICTRL3_ADC_LEFT_CHANNEL | \
104 VS1053B_AICTRL3_MODE_LINEAR_PCM)
105#define VS1053B_BASIC_DEFAULT_RECORD_WAV_DIFF VS1053B_DIFF_NORMAL
106#define VS1053B_BASIC_DEFAULT_RECORD_WAV_MPEG_LAYER_I_AND_II VS1053B_BOOL_FALSE
107#define VS1053B_BASIC_DEFAULT_RECORD_WAV_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
108#define VS1053B_BASIC_DEFAULT_RECORD_WAV_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
109#define VS1053B_BASIC_DEFAULT_RECORD_WAV_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
110#define VS1053B_BASIC_DEFAULT_RECORD_WAV_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
111#define VS1053B_BASIC_DEFAULT_RECORD_WAV_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
112#define VS1053B_BASIC_DEFAULT_RECORD_WAV_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
113#define VS1053B_BASIC_DEFAULT_RECORD_WAV_SELECTOR VS1053B_SELECTOR_MICP
114#define VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
115#define VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_4P5_XTALI
116#define VS1053B_BASIC_DEFAULT_RECORD_OGG_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE
117#define VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_FREQUENCY 8000000.0f
118#define VS1053B_BASIC_DEFAULT_RECORD_OGG_DO_NOT_JUMP VS1053B_BOOL_FALSE
119#define VS1053B_BASIC_DEFAULT_RECORD_OGG_SWING 0.0f
120#define VS1053B_BASIC_DEFAULT_RECORD_OGG_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
121#define VS1053B_BASIC_DEFAULT_RECORD_OGG_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
122#define VS1053B_BASIC_DEFAULT_RECORD_OGG_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
123#define VS1053B_BASIC_DEFAULT_RECORD_OGG_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
124#define VS1053B_BASIC_DEFAULT_RECORD_OGG_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
125#define VS1053B_BASIC_DEFAULT_RECORD_OGG_TREBLE_CONTROL 0.0f
126#define VS1053B_BASIC_DEFAULT_RECORD_OGG_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 0
127#define VS1053B_BASIC_DEFAULT_RECORD_OGG_BASS_ENHANCEMENT 0
128#define VS1053B_BASIC_DEFAULT_RECORD_OGG_LOWER_LIMIT_FREQUENCY_IN_10_HZ 0
129#define VS1053B_BASIC_DEFAULT_RECORD_OGG_VOL -100.0f
130#define VS1053B_BASIC_DEFAULT_RECORD_OGG_SAMPLE 44100
131#define VS1053B_BASIC_DEFAULT_RECORD_OGG_TIMES 1024 * 5
132#define VS1053B_BASIC_DEFAULT_RECORD_OGG_GAIN 0
133#define VS1053B_BASIC_DEFAULT_RECORD_OGG_CONTROL 0
134#define VS1053B_BASIC_DEFAULT_RECORD_OGG_DIFF VS1053B_DIFF_NORMAL
135#define VS1053B_BASIC_DEFAULT_RECORD_OGG_MPEG_LAYER_I_AND_II VS1053B_BOOL_FALSE
136#define VS1053B_BASIC_DEFAULT_RECORD_OGG_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
137#define VS1053B_BASIC_DEFAULT_RECORD_OGG_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
138#define VS1053B_BASIC_DEFAULT_RECORD_OGG_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
139#define VS1053B_BASIC_DEFAULT_RECORD_OGG_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
140#define VS1053B_BASIC_DEFAULT_RECORD_OGG_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
141#define VS1053B_BASIC_DEFAULT_RECORD_OGG_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
142#define VS1053B_BASIC_DEFAULT_RECORD_OGG_SELECTOR VS1053B_SELECTOR_MICP
143#define VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
144#define VS1053B_BASIC_DEFAULT_RECORD_OGG_VENC VS1053B_PATCH_OGG_VENC44K2Q05
145
149typedef enum
150{
154
165uint8_t vs1053b_basic_init(vs1053b_mode_t mode, vs1053b_record_format_t format, void (*callback)(uint8_t type, uint32_t cur_pos));
166
174uint8_t vs1053b_basic_deinit(void);
175
184uint8_t vs1053b_basic_set_callback_period(uint32_t second);
185
193uint8_t vs1053b_basic_service(void);
194
203uint8_t vs1053b_basic_play(char *path);
204
213uint8_t vs1053b_basic_record(char *path);
214
222uint8_t vs1053b_basic_pause(void);
223
231uint8_t vs1053b_basic_stop(void);
232
241uint8_t vs1053b_basic_set_vol(float vol);
242
251uint8_t vs1053b_basic_get_decode_time(uint16_t *decode_time);
252
261uint8_t vs1053b_basic_get_bytes_rate(uint16_t *rate);
262
272uint8_t vs1053b_basic_get_sample_rate(uint16_t *rate, vs1053b_channel_t *channel);
273
283
287
288#ifdef __cplusplus
289}
290#endif
291
292#endif
driver vs1053b interface header file
vs1053b_record_format_t
vs1053b record format enumeration definition
struct vs1053b_audio_info_s vs1053b_audio_info_t
vs1053b audio info structure definition
vs1053b_channel_t
vs1053b channel enumeration definition
uint8_t vs1053b_basic_record(char *path)
basic example record
uint8_t vs1053b_basic_deinit(void)
basic example deinit
uint8_t vs1053b_basic_get_decode_time(uint16_t *decode_time)
basic example get decode time
uint8_t vs1053b_basic_get_info(vs1053b_audio_info_t *info)
basic example get info
uint8_t vs1053b_basic_set_callback_period(uint32_t second)
basic example set callback period
uint8_t vs1053b_basic_service(void)
basic example service
uint8_t vs1053b_basic_set_vol(float vol)
basic example set vol
uint8_t vs1053b_basic_pause(void)
basic example pause
uint8_t vs1053b_basic_init(vs1053b_mode_t mode, vs1053b_record_format_t format, void(*callback)(uint8_t type, uint32_t cur_pos))
basic example init
vs1053b_mode_t
vs1053b mode enumeration definition
uint8_t vs1053b_basic_stop(void)
basic example stop
uint8_t vs1053b_basic_get_sample_rate(uint16_t *rate, vs1053b_channel_t *channel)
basic example get sample rate
uint8_t vs1053b_basic_get_bytes_rate(uint16_t *rate)
basic example get bytes rate
uint8_t vs1053b_basic_play(char *path)
basic example play
@ VS1053B_MODE_PLAY
@ VS1053B_MODE_RECORD