a2dp_xq.h

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "esp_err.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define A2DP_XQ_VERSION_MAJOR 0
#define A2DP_XQ_VERSION_MINOR 1
#define A2DP_XQ_VERSION_PATCH 0
#define A2DP_XQ_VERSION_STRING "0.1.0"
 
#define A2DP_XQ_SAMPLE_RATE 44100u
 
typedef enum {
    A2DP_XQ_STATE_OFF = 0,     
    A2DP_XQ_STATE_IDLE,        
    A2DP_XQ_STATE_SCANNING,    
    A2DP_XQ_STATE_CONNECTING,
    A2DP_XQ_STATE_CONNECTED,
} a2dp_xq_state_t;
 
typedef struct {
    char name[64];
    char addr[18];   
    int8_t rssi;     
    bool paired;
    bool connected;
} a2dp_xq_device_t;
 
typedef struct {
    a2dp_xq_state_t state;
    char device_name[64];   
    char device_addr[18];
    char codec[16];         
    char mode[24];          
    uint8_t bitpool;
    uint16_t bitrate_kbps;
    uint32_t sample_rate;
} a2dp_xq_status_t;
 
typedef enum {
    A2DP_XQ_REMOTE_PLAY_PAUSE = 0,
    A2DP_XQ_REMOTE_PLAY,
    A2DP_XQ_REMOTE_PAUSE,
    A2DP_XQ_REMOTE_STOP,
    A2DP_XQ_REMOTE_NEXT,
    A2DP_XQ_REMOTE_PREV,
    A2DP_XQ_REMOTE_VOL_UP,
    A2DP_XQ_REMOTE_VOL_DOWN,
    A2DP_XQ_REMOTE_VOLUME_ABS,  
    A2DP_XQ_REMOTE_LINK_DOWN,   
} a2dp_xq_remote_t;
 
typedef enum {
    A2DP_XQ_EVENT_STATE = 0,       
    A2DP_XQ_EVENT_DEVICE_FOUND,    
    A2DP_XQ_EVENT_PAIRING_FAILED,  
    A2DP_XQ_EVENT_CODEC,           
} a2dp_xq_event_type_t;
 
typedef struct {
    a2dp_xq_event_type_t type;
    a2dp_xq_state_t state;
    a2dp_xq_device_t device;
} a2dp_xq_event_t;
 
typedef void (*a2dp_xq_event_cb_t)(const a2dp_xq_event_t *event, void *user);
typedef void (*a2dp_xq_remote_cb_t)(a2dp_xq_remote_t cmd, int value, void *user);
 
typedef struct {
    const char *device_name;       
    bool allow_sbc_xq;             
    bool auto_reconnect;           
    const char *last_device;       
    const char *state_dir;         
    a2dp_xq_event_cb_t event_cb;
    void *event_user;
    a2dp_xq_remote_cb_t remote_cb;  
    void *remote_user;
    int8_t worker_core;            
} a2dp_xq_config_t;
 
#define A2DP_XQ_CONFIG_DEFAULT()                                                                             \
    {                                                                                                        \
        .device_name = "ESP32", .allow_sbc_xq = true, .auto_reconnect = true, .last_device = NULL,           \
        .state_dir = NULL, .event_cb = NULL, .event_user = NULL, .remote_cb = NULL, .remote_user = NULL,     \
        .worker_core = 0,                                                                                    \
    }
 
bool a2dp_xq_supported(void);
 
// ------------------------------------------------------------------- lifecycle ----
esp_err_t a2dp_xq_init(const a2dp_xq_config_t *cfg);
void a2dp_xq_deinit(void);
bool a2dp_xq_is_initialized(void);
 
// ----------------------------------------------------------------------- audio ----
esp_err_t a2dp_xq_start(void);
void a2dp_xq_stop(void);
void a2dp_xq_pause(bool paused);
 
int32_t a2dp_xq_write_s16(const int16_t *pcm, uint32_t frames, uint32_t timeout_ms);
int32_t a2dp_xq_write_q31(const int32_t *pcm, uint32_t frames, uint32_t timeout_ms);
void a2dp_xq_flush(void);
uint32_t a2dp_xq_buffered_frames(void);
 
// ---------------------------------------------------------------------- volume ----
void a2dp_xq_set_volume_db(float db);
float a2dp_xq_volume_to_db(int v127);
uint8_t a2dp_xq_volume_from_db(float db);
 
// ------------------------------------------------------------- devices and link ----
void a2dp_xq_get_status(a2dp_xq_status_t *out);
void a2dp_xq_describe(char *out, size_t out_size);
void a2dp_xq_scan(bool start);
uint32_t a2dp_xq_devices(a2dp_xq_device_t *out, uint32_t max);
esp_err_t a2dp_xq_connect(const char *addr);
void a2dp_xq_disconnect(void);
void a2dp_xq_forget(const char *addr);
esp_err_t a2dp_xq_set_xq_allowed(const char *addr, bool allowed);
 
typedef struct {
    uint32_t underruns;          
    uint32_t underrun_frames;    
    uint32_t fifo_frames;        
    uint32_t fifo_limit_frames;  
    bool streaming;              
    bool abs_volume;             
    uint8_t remote_volume;       
    uint16_t sink_delay_ms;      
} a2dp_xq_stats_t;
void a2dp_xq_get_stats(a2dp_xq_stats_t *out);
 
#ifdef __cplusplus
}
#endif