audio.h File Reference

Bluetooth Audio handling. More...

#include <zephyr/sys/atomic.h>
#include <zephyr/bluetooth/buf.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/hci.h>
#include <zephyr/bluetooth/iso.h>
#include <zephyr/bluetooth/gatt.h>
#include <zephyr/bluetooth/audio/lc3.h>

Go to the source code of this file.

Data Structures
struct	bt_codec_data
	Codec configuration structure. More...
struct	bt_codec
	Codec structure. More...
struct	bt_audio_base_bis_data
struct	bt_audio_base_subgroup
struct	bt_audio_base
struct	bt_codec_qos
	Codec QoS structure. More...
struct	bt_codec_qos_pref
	Audio Stream Quality of Service Preference structure. More...
struct	bt_audio_lc3_preset
struct	bt_audio_stream
	Audio stream structure. More...
struct	bt_audio_unicast_server_cb
struct	bt_audio_broadcast_sink_cb
struct	bt_audio_stream_ops
	Stream operation. More...
struct	bt_audio_discover_params

Macros
#define	BT_AUDIO_BROADCAST_ID_SIZE   3 /* octets */
#define	BT_AUDIO_CONTEXT_TYPE_PROHIBITED   0
	Audio Context Type, Generic Audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED   BIT(0)
	Unspecified type. More...
#define	BT_AUDIO_CONTEXT_TYPE_CONVERSATIONAL   BIT(1)
	Conversational audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_MEDIA   BIT(2)
	Media. More...
#define	BT_AUDIO_CONTEXT_TYPE_GAME   BIT(3)
	Game audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_INSTRUCTIONAL   BIT(4)
	Instructional audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_VOICE_ASSISTANTS   BIT(5)
	Voice assistant audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_LIVE   BIT(6)
	Live audio. More...
#define	BT_AUDIO_CONTEXT_TYPE_SOUND_EFFECTS   BIT(7)
	Sound effects. More...
#define	BT_AUDIO_CONTEXT_TYPE_NOTIFICATIONS   BIT(8)
	Notification and reminder sounds. More...
#define	BT_AUDIO_CONTEXT_TYPE_RINGTONE   BIT(9)
	Ringtone as in a call alert. More...
#define	BT_AUDIO_CONTEXT_TYPE_ALERTS   BIT(10)
	Alarms and timers. More...
#define	BT_AUDIO_CONTEXT_TYPE_EMERGENCY_ALARM   BIT(11)
	Emergency alarm. More...
#define	BT_AUDIO_CONTEXT_TYPE_ANY
#define	BT_AUDIO_UNICAST_ANNOUNCEMENT_GENERAL   0x00
#define	BT_AUDIO_UNICAST_ANNOUNCEMENT_TARGETED   0x01
#define	BROADCAST_SNK_STREAM_CNT   0
#define	BROADCAST_SNK_SUBGROUP_CNT   0
#define	BT_CODEC_DATA(_type, _bytes...)
	Helper to declare elements of bt_codec_data arrays. More...
#define	BT_CODEC(_id, _cid, _vid, _data, _meta)
	Helper to declare bt_codec structure. More...
#define	BT_CODEC_QOS(_interval, _framing, _phy, _sdu, _rtn, _latency, _pd)
	Helper to declare elements of bt_codec_qos. More...
#define	BT_CODEC_QOS_UNFRAMED(_interval, _sdu, _rtn, _latency, _pd)
	Helper to declare Input Unframed bt_codec_qos. More...
#define	BT_CODEC_QOS_FRAMED(_interval, _sdu, _rtn, _latency, _pd)
	Helper to declare Input Framed bt_codec_qos. More...
#define	BT_CODEC_QOS_PREF(_unframed_supported, _phy, _rtn, _latency, _pd_min, _pd_max, _pref_pd_min, _pref_pd_max)
	Helper to declare elements of bt_codec_qos_pref. More...
#define	BT_AUDIO_LC3_PRESET(_codec, _qos)
#define	BT_AUDIO_LC3_UNICAST_PRESET_8_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_8_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_16_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_16_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_24_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_24_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_32_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_32_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_441_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_441_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_1_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_2_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_3_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_4_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_5_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_6_1
#define	BT_AUDIO_LC3_UNICAST_PRESET_8_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_8_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_16_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_16_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_24_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_24_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_32_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_32_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_441_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_441_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_1_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_2_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_3_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_4_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_5_2
#define	BT_AUDIO_LC3_UNICAST_PRESET_48_6_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_8_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_8_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_16_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_16_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_24_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_24_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_32_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_32_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_441_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_441_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_1_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_2_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_3_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_4_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_5_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_6_1
#define	BT_AUDIO_LC3_BROADCAST_PRESET_8_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_8_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_16_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_16_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_24_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_24_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_32_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_32_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_441_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_441_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_1_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_2_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_3_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_4_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_5_2
#define	BT_AUDIO_LC3_BROADCAST_PRESET_48_6_2

Typedefs
typedef void(*	bt_audio_discover_func_t) (struct bt_conn *conn, struct bt_codec *codec, struct bt_audio_ep *ep, struct bt_audio_discover_params *params)
	Discover Audio capabilities and endpoints callback function. More...

Enumerations
enum	bt_audio_meta_type {   BT_CODEC_META_PREFER_CONTEXT = 0x01 , BT_CODEC_META_CONTEXT = 0x02 , BT_CODEC_META_PROGRAM_INFO = 0x03 , BT_CODEC_META_LANGUAGE = 0x04 ,   BT_CODEC_META_CCID_LIST = 0x05 , BT_CODEC_META_PARENTAL_RATING = 0x06 , BT_CODEC_META_PROGRAM_INFO_URI = 0x07 , BT_CODEC_META_EXTENDED_METADATA = 0xFE ,   BT_CODEC_META_VENDOR_SPECIFIC = 0xFF }
	Meta data type ids used for LTV encoded metadata. More...
enum	bt_audio_location {   BT_AUDIO_LOCATION_FRONT_LEFT = BIT(0) , BT_AUDIO_LOCATION_FRONT_RIGHT = BIT(1) , BT_AUDIO_LOCATION_FRONT_CENTER = BIT(2) , BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_1 = BIT(3) ,   BT_AUDIO_LOCATION_BACK_LEFT = BIT(4) , BT_AUDIO_LOCATION_BACK_RIGHT = BIT(5) , BT_AUDIO_LOCATION_FRONT_LEFT_OF_CENTER = BIT(6) , BT_AUDIO_LOCATION_FRONT_RIGHT_OF_CENTER = BIT(7) ,   BT_AUDIO_LOCATION_BACK_CENTER = BIT(8) , BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_2 = BIT(9) , BT_AUDIO_LOCATION_SIDE_LEFT = BIT(10) , BT_AUDIO_LOCATION_SIDE_RIGHT = BIT(11) ,   BT_AUDIO_LOCATION_TOP_FRONT_LEFT = BIT(12) , BT_AUDIO_LOCATION_TOP_FRONT_RIGHT = BIT(13) , BT_AUDIO_LOCATION_TOP_FRONT_CENTER = BIT(14) , BT_AUDIO_LOCATION_TOP_CENTER = BIT(15) ,   BT_AUDIO_LOCATION_TOP_BACK_LEFT = BIT(16) , BT_AUDIO_LOCATION_TOP_BECK_RIGHT = BIT(17) , BT_AUDIO_LOCATION_TOP_SIDE_LEFT = BIT(18) , BT_AUDIO_LOCATION_TOP_SIDE_RIGHT = BIT(19) ,   BT_AUDIO_LOCATION_TOP_BACK_CENTER = BIT(20) , BT_AUDIO_LOCATION_BOTTOM_FRONT_CENTER = BIT(21) , BT_AUDIO_LOCATION_BOTTOM_FRONT_LEFT = BIT(22) , BT_AUDIO_LOCATION_BOTTOM_FRONT_RIGHT = BIT(23) ,   BT_AUDIO_LOCATION_FRONT_LEFT_WIDE = BIT(24) , BT_AUDIO_LOCATION_FRONT_RIGHT_WIDE = BIT(25) , BT_AUDIO_LOCATION_LEFT_SURROUND = BIT(26) , BT_AUDIO_LOCATION_RIGHT_SURROUND = BIT(27) }
	Location values for BT Audio. More...
enum	bt_audio_dir { BT_AUDIO_DIR_SINK = 0x01 , BT_AUDIO_DIR_SOURCE = 0x02 }
	Audio Capability type. More...
enum	{ BT_CODEC_QOS_UNFRAMED = 0x00 , BT_CODEC_QOS_FRAMED = 0x01 }
	Codec QoS Framing. More...
enum	{ BT_CODEC_QOS_1M = BIT(0) , BT_CODEC_QOS_2M = BIT(1) , BT_CODEC_QOS_CODED = BIT(2) }
	Codec QoS Preferred PHY. More...
enum	bt_audio_codec_parse_err { BT_AUDIO_CODEC_PARSE_ERR_SUCCESS = 0 , BT_AUDIO_CODEC_PARSE_ERR_TYPE_NOT_FOUND = -1 , BT_AUDIO_CODEC_PARSE_ERR_INVALID_VALUE_FOUND = -2 , BT_AUDIO_CODEC_PARSE_ERR_INVALID_PARAM = -3 }
	Codec parser error codes for Codec config parsing APIs. More...

Functions
void	bt_audio_stream_cb_register (struct bt_audio_stream *stream, struct bt_audio_stream_ops *ops)
	Register Audio callbacks for a stream. More...
int	bt_audio_unicast_server_register_cb (const struct bt_audio_unicast_server_cb *cb)
	Register unicast server callbacks. More...
int	bt_audio_unicast_server_unregister_cb (const struct bt_audio_unicast_server_cb *cb)
	Unregister unicast server callbacks. More...
int	bt_audio_unicast_server_location_changed (enum bt_audio_dir dir)
	Notify location changed. More...
int	bt_audio_discover (struct bt_conn *conn, struct bt_audio_discover_params *params)
	Discover remote capabilities and endpoints. More...
int	bt_audio_stream_config (struct bt_conn *conn, struct bt_audio_stream *stream, struct bt_audio_ep *ep, struct bt_codec *codec)
	Configure Audio Stream. More...
int	bt_audio_stream_reconfig (struct bt_audio_stream *stream, struct bt_codec *codec)
	Reconfigure Audio Stream. More...
int	bt_audio_stream_qos (struct bt_conn *conn, struct bt_audio_unicast_group *group, struct bt_codec_qos *qos)
	Configure Audio Stream QoS. More...
int	bt_audio_stream_enable (struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)
	Enable Audio Stream. More...
int	bt_audio_stream_metadata (struct bt_audio_stream *stream, struct bt_codec_data *meta, size_t meta_count)
	Change Audio Stream Metadata. More...
int	bt_audio_stream_disable (struct bt_audio_stream *stream)
	Disable Audio Stream. More...
int	bt_audio_stream_start (struct bt_audio_stream *stream)
	Start Audio Stream. More...
int	bt_audio_stream_stop (struct bt_audio_stream *stream)
	Stop Audio Stream. More...
int	bt_audio_stream_release (struct bt_audio_stream *stream, bool cache)
	Release Audio Stream. More...
int	bt_audio_stream_send (struct bt_audio_stream *stream, struct net_buf *buf)
	Send data to Audio stream. More...
int	bt_audio_unicast_group_create (struct bt_audio_stream *streams[], size_t num_stream, struct bt_audio_unicast_group **unicast_group)
	Create audio unicast group. More...
int	bt_audio_unicast_group_add_streams (struct bt_audio_unicast_group *unicast_group, struct bt_audio_stream *streams[], size_t num_stream)
	Add streams to a unicast group as a unicast client. More...
int	bt_audio_unicast_group_remove_streams (struct bt_audio_unicast_group *unicast_group, struct bt_audio_stream *streams[], size_t num_stream)
	Remove streams from a unicast group as a unicast client. More...
int	bt_audio_unicast_group_delete (struct bt_audio_unicast_group *unicast_group)
	Delete audio unicast group. More...
int	bt_audio_broadcast_source_create (struct bt_audio_stream *streams[], size_t num_stream, struct bt_codec *codec, struct bt_codec_qos *qos, struct bt_audio_broadcast_source **source)
	Create audio broadcast source. More...
int	bt_audio_broadcast_source_reconfig (struct bt_audio_broadcast_source *source, struct bt_codec *codec, struct bt_codec_qos *qos)
	Reconfigure audio broadcast source. More...
int	bt_audio_broadcast_source_start (struct bt_audio_broadcast_source *source)
	Start audio broadcast source. More...
int	bt_audio_broadcast_source_stop (struct bt_audio_broadcast_source *source)
	Stop audio broadcast source. More...
int	bt_audio_broadcast_source_delete (struct bt_audio_broadcast_source *source)
	Delete audio broadcast source. More...
void	bt_audio_broadcast_sink_register_cb (struct bt_audio_broadcast_sink_cb *cb)
	Register Broadcast sink callbacks *. More...
int	bt_audio_broadcast_sink_scan_start (const struct bt_le_scan_param *param)
	Start scan for broadcast sources. More...
int	bt_audio_broadcast_sink_scan_stop (void)
	Stop scan for broadcast sources. More...
int	bt_audio_broadcast_sink_sync (struct bt_audio_broadcast_sink *sink, uint32_t indexes_bitfield, struct bt_audio_stream *streams[], struct bt_codec *codec, const uint8_t broadcast_code[16])
	Sync to a broadcaster's audio. More...
int	bt_audio_broadcast_sink_stop (struct bt_audio_broadcast_sink *sink)
	Stop audio broadcast sink. More...
int	bt_audio_broadcast_sink_delete (struct bt_audio_broadcast_sink *sink)
	Release a broadcast sink. More...
int	bt_codec_cfg_get_freq (const struct bt_codec *codec)
	Extract the frequency from a codec configuration. More...
int	bt_codec_cfg_get_frame_duration_us (const struct bt_codec *codec)
	Extract frame duration from BT codec config. More...
int	bt_codec_cfg_get_chan_allocation_val (const struct bt_codec *codec, uint32_t *chan_allocation)
	Extract channel allocation from BT codec config. More...
int	bt_codec_cfg_get_octets_per_frame (const struct bt_codec *codec)
	Extract frame size in octets from BT codec config. More...
int	bt_codec_cfg_get_frame_blocks_per_sdu (const struct bt_codec *codec, bool fallback_to_default)
	Extract number of audio frame blockss in each SDU from BT codec config. More...
bool	bt_codec_get_val (const struct bt_codec *codec, uint8_t type, const struct bt_codec_data **data)
	Lookup a specific value based on type. More...

Detailed Description

Bluetooth Audio handling.