btstack_sbc: mark singleton interface as deprecated

This commit is contained in:
Matthias Ringwald 2023-11-17 15:09:06 +01:00
parent e1d1fb6000
commit a267701aa5

View File

@ -156,8 +156,10 @@ typedef struct {
/* API_START */
/* BTstack SBC decoder */
/**
* @brief Init SBC decoder
* @deprecated Please use btstack_sbc_decoder_bluedroid_init_instance() from btstack_sbc_bluedroid.h and call btstack_sbc_decoder->configure() instead
* @param state
* @param mode
* @param callback for decoded PCM data in host endianess
@ -168,6 +170,7 @@ void btstack_sbc_decoder_init(btstack_sbc_decoder_state_t * state, btstack_sbc_m
/**
* @brief Process received SBC data
* @deprecated Please use btstack_sbc_decoder->decode_signed_16() instead
* @param state
* @param packet_status_flag from SCO packet: 0 = OK, 1 = possibly invalid data, 2 = no data received, 3 = data partially lost
* @param buffer
@ -177,16 +180,19 @@ void btstack_sbc_decoder_process_data(btstack_sbc_decoder_state_t * state, int p
/**
* @brief Get number of samples per SBC frame
* @deprecated Please use btstack_sbc_decoder->num_samples_per_frame() instead
*/
int btstack_sbc_decoder_num_samples_per_frame(btstack_sbc_decoder_state_t * state);
/*
/**
* @brief Get number of channels
* @deprecated Please use btstack_sbc_decoder->num_channels() instead
*/
int btstack_sbc_decoder_num_channels(btstack_sbc_decoder_state_t * state);
/*
/**
* @brief Get sample rate in hz
* @deprecated Please use btstack_sbc_decoder->sample_rate() instead
*/
int btstack_sbc_decoder_sample_rate(btstack_sbc_decoder_state_t * state);
@ -194,6 +200,7 @@ int btstack_sbc_decoder_sample_rate(btstack_sbc_decoder_state_t * state);
/* BTstack SBC Encoder */
/**
* @brief Init SBC encoder
* @deprecated Please use btstack_sbc_encoder_bluedroid_init_instance() from btstack_sbc_bluedroid.h and call btstack_sbc_encoder->configure() instead
* @param state
* @param mode
* @param blocks
@ -209,22 +216,26 @@ void btstack_sbc_encoder_init(btstack_sbc_encoder_state_t * state, btstack_sbc_m
/**
* @brief Encode PCM data
* @deprecated Please use btstack_sbc_encoder->encode_signed_16() instead
* @param buffer with samples in host endianess
*/
void btstack_sbc_encoder_process_data(int16_t * input_buffer);
/**
* @brief Return SBC frame
* @deprecated not needed when using the codeec instance interface
*/
uint8_t * btstack_sbc_encoder_sbc_buffer(void);
/**
* @brief Return SBC frame length
* @deprecated Please use btstack_sbc_encoder->encode_signed_16() instead
*/
uint16_t btstack_sbc_encoder_sbc_buffer_length(void);
/**
* @brief Return number of audio frames required for one SBC packet
* @deprecated Please use btstack_sbc_encoder->encode_signed_16() instead
* @note each audio frame contains 2 sample values in stereo modes
*/
int btstack_sbc_encoder_num_audio_frames(void);