driver vs1053b basic header file More...

#include "driver_vs1053b_interface.h"

Include dependency graph for driver_vs1053b_basic.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	VS1053B_BASIC_DEFAULT_PLAY_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_3P5_XTALI
	vs1053b basic example default definition
#define	VS1053B_BASIC_DEFAULT_PLAY_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_2P0_XTALI
#define	VS1053B_BASIC_DEFAULT_PLAY_CLOCK_FREQUENCY 8000000.0f
#define	VS1053B_BASIC_DEFAULT_PLAY_DIFF VS1053B_DIFF_NORMAL
#define	VS1053B_BASIC_DEFAULT_PLAY_MPEG_LAYER_I_AND_II VS1053B_BOOL_TRUE
#define	VS1053B_BASIC_DEFAULT_PLAY_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
#define	VS1053B_BASIC_DEFAULT_PLAY_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
#define	VS1053B_BASIC_DEFAULT_PLAY_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_SELECTOR VS1053B_SELECTOR_MICP
#define	VS1053B_BASIC_DEFAULT_PLAY_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
#define	VS1053B_BASIC_DEFAULT_PLAY_DO_NOT_JUMP VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_SWING 0.0f
#define	VS1053B_BASIC_DEFAULT_PLAY_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
#define	VS1053B_BASIC_DEFAULT_PLAY_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
#define	VS1053B_BASIC_DEFAULT_PLAY_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
#define	VS1053B_BASIC_DEFAULT_PLAY_TREBLE_CONTROL 22.5f
#define	VS1053B_BASIC_DEFAULT_PLAY_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 10000
#define	VS1053B_BASIC_DEFAULT_PLAY_BASS_ENHANCEMENT 15
#define	VS1053B_BASIC_DEFAULT_PLAY_LOWER_LIMIT_FREQUENCY_IN_10_HZ 60
#define	VS1053B_BASIC_DEFAULT_PLAY_VOL -10.0f
#define	VS1053B_BASIC_DEFAULT_PLAY_SPEED VS1053B_PLAY_SPEED_1P0_X
#define	VS1053B_BASIC_DEFAULT_PLAY_IIS_OUTPUT VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_PLAY_IIS_MCLK_OUTPUT VS1053B_BOOL_TRUE
#define	VS1053B_BASIC_DEFAULT_PLAY_IIS_RATE VS1053B_IIS_RATE_48KHZ
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_2P0_XTALI
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_FREQUENCY 8000000.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_DO_NOT_JUMP VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_SWING 0.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_TREBLE_CONTROL 0.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 0
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_BASS_ENHANCEMENT 0
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_LOWER_LIMIT_FREQUENCY_IN_10_HZ 0
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_VOL -100.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_SAMPLE 8000
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_TIMES 1024 * 5
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_GAIN 0
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_CHANNEL
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_DIFF VS1053B_DIFF_NORMAL
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_MPEG_LAYER_I_AND_II VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_SELECTOR VS1053B_SELECTOR_MICP
#define	VS1053B_BASIC_DEFAULT_RECORD_WAV_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_MULTIPLIER VS1053B_CLOCK_MULTIPLIER_4P5_XTALI
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_ALLOWED_MULTIPLIER_ADDITION VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_FREQUENCY 8000000.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_DO_NOT_JUMP VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_SWING 0.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_OVERLOAD_DETECTION VS1053B_BOOL_TRUE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_ANALOG_DRIVER_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_ANALOG_INTERNAL_POWER_DOWN VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_AD_CLOCK VS1053B_AD_CLOCK_6MHZ
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_REFERENCE_VOLTAGE VS1053B_REFERENCE_VOLTAGE_1P23V
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_TREBLE_CONTROL 0.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_LOWER_LIMIT_FREQUENCY_IN_1000_HZ 0
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_BASS_ENHANCEMENT 0
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_LOWER_LIMIT_FREQUENCY_IN_10_HZ 0
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_VOL -100.0f
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_SAMPLE 44100
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_TIMES 1024 * 5
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_GAIN 0
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_CONTROL 0
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_DIFF VS1053B_DIFF_NORMAL
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_MPEG_LAYER_I_AND_II VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_CANCEL_DECODING_CURRENT_FILE VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_EAR_SPEAKER_LOW_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_EAR_SPEAKER_HIGH_SETTING VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_DCLK_EDGE VS1053B_DCLK_EDGE_RISING
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_BIT_ORDER VS1053B_BIT_ORDER_MSB_FIRST
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_SHARE_SPI_CHIP_SELECT VS1053B_BOOL_FALSE
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_SELECTOR VS1053B_SELECTOR_MICP
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_CLOCK_RANGE VS1053B_CLOCK_RANGE_12MHZ_13MHZ
#define	VS1053B_BASIC_DEFAULT_RECORD_OGG_VENC VS1053B_PATCH_OGG_VENC44K2Q05

Enumerations
enum	vs1053b_mode_t { VS1053B_MODE_PLAY = 0x00 , VS1053B_MODE_RECORD = 0x01 }
	vs1053b mode enumeration definition More...

Functions
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
uint8_t	vs1053b_basic_deinit (void)
	basic example deinit
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_play (char *path)
	basic example play
uint8_t	vs1053b_basic_record (char *path)
	basic example record
uint8_t	vs1053b_basic_pause (void)
	basic example pause
uint8_t	vs1053b_basic_stop (void)
	basic example stop
uint8_t	vs1053b_basic_set_vol (float vol)
	basic example set vol
uint8_t	vs1053b_basic_get_decode_time (uint16_t *decode_time)
	basic example get decode time
uint8_t	vs1053b_basic_get_bytes_rate (uint16_t *rate)
	basic example get bytes rate
uint8_t	vs1053b_basic_get_sample_rate (uint16_t rate, vs1053b_channel_t channel)
	basic example get sample rate
uint8_t	vs1053b_basic_get_info (vs1053b_audio_info_t *info)
	basic example get info

Detailed Description

driver vs1053b basic header file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2023-06-30

history

Date	Version	Author	Description
2023/06/30	1.0	Shifeng Li	first upload

Definition in file driver_vs1053b_basic.h.

Macros

Enumerations

Functions

Detailed Description

history