Codec config parsing APIs

Audio codec Config APIs. More...

Functions
int	bt_audio_codec_cfg_freq_to_freq_hz (enum bt_audio_codec_config_freq freq)
	Convert assigned numbers frequency to frequency value.
int	bt_audio_codec_cfg_freq_hz_to_freq (uint32_t freq_hz)
	Convert frequency value to assigned numbers frequency.
int	bt_audio_codec_cfg_get_freq (const struct bt_audio_codec_cfg *codec_cfg)
	Extract the frequency from a codec configuration.
int	bt_audio_codec_cfg_set_freq (struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_config_freq freq)
	Set the frequency of a codec configuration.
int	bt_audio_codec_cfg_get_frame_duration_us (const struct bt_audio_codec_cfg *codec_cfg)
	Extract frame duration from BT codec config.
int	bt_audio_codec_cfg_get_chan_allocation (const struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_location *chan_allocation)
	Extract channel allocation from BT codec config.
int	bt_audio_codec_cfg_set_chan_allocation (struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_location chan_allocation)
	Set the channel allocation of a codec configuration.
int	bt_audio_codec_cfg_get_octets_per_frame (const struct bt_audio_codec_cfg *codec_cfg)
	Extract frame size in octets from BT codec config.
int	bt_audio_codec_cfg_set_octets_per_frame (struct bt_audio_codec_cfg *codec_cfg, uint16_t octets_per_frame)
	Set the octets per codec frame of a codec configuration.
int	bt_audio_codec_cfg_get_frame_blocks_per_sdu (const struct bt_audio_codec_cfg *codec_cfg, bool fallback_to_default)
	Extract number of audio frame blockss in each SDU from BT codec config.
int	bt_audio_codec_cfg_set_frame_blocks_per_sdu (struct bt_audio_codec_cfg *codec_cfg, uint8_t frame_blocks)
	Set the frame blocks per SDU of a codec configuration.
uint8_t	bt_audio_codec_cfg_get_val (const struct bt_audio_codec_cfg *codec_cfg, uint8_t type, const uint8_t **data)
	Lookup a specific codec configuration value.
int	bt_audio_codec_cfg_set_val (struct bt_audio_codec_cfg *codec_cfg, uint8_t type, const uint8_t *data, size_t data_len)
	Set or add a specific codec configuration value.
int	bt_audio_codec_cfg_meta_get_val (const struct bt_audio_codec_cfg *codec_cfg, uint8_t type, const uint8_t **data)
	Lookup a specific metadata value based on type.
int	bt_audio_codec_cfg_meta_get_pref_context (const struct bt_audio_codec_cfg *codec_cfg)
	Extract preferred contexts.
int	bt_audio_codec_cfg_meta_get_stream_context (const struct bt_audio_codec_cfg *codec_cfg)
	Extract stream contexts.
int	bt_audio_codec_cfg_meta_get_program_info (const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **program_info)
	Extract program info.
int	bt_audio_codec_cfg_meta_get_stream_lang (const struct bt_audio_codec_cfg *codec_cfg)
	Extract stream language.
int	bt_audio_codec_cfg_meta_get_ccid_list (const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **ccid_list)
	Extract CCID list.
int	bt_audio_codec_cfg_meta_get_parental_rating (const struct bt_audio_codec_cfg *codec_cfg)
	Extract parental rating.
int	bt_audio_codec_cfg_meta_get_program_info_uri (const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **program_info_uri)
	Extract program info URI.
int	bt_audio_codec_cfg_meta_get_audio_active_state (const struct bt_audio_codec_cfg *codec_cfg)
	Extract audio active state.
int	bt_audio_codec_cfg_meta_get_bcast_audio_immediate_rend_flag (const struct bt_audio_codec_cfg *codec_cfg)
	Extract broadcast audio immediate rendering flag.
int	bt_audio_codec_cfg_meta_get_extended (const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **extended_meta)
	Extract extended metadata.
int	bt_audio_codec_cfg_meta_get_vendor (const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **vendor_meta)
	Extract vendor specific metadata.

Detailed Description

Audio codec Config APIs.

Functions to parse codec config data when formatted as LTV wrapped into Codec config parsing APIs.

Function Documentation

bt_audio_codec_cfg_freq_hz_to_freq()

int bt_audio_codec_cfg_freq_hz_to_freq

(

uint32_t

freq_hz

)

#include <zephyr/bluetooth/audio/audio.h>

Convert frequency value to assigned numbers frequency.

Parameters

freq_hz

The frequency value to convert.

Return values

-EINVAL	if arguments are invalid.
The	assigned numbers frequency (bt_audio_codec_config_freq).

bt_audio_codec_cfg_freq_to_freq_hz()

int bt_audio_codec_cfg_freq_to_freq_hz

(

enum bt_audio_codec_config_freq

freq

)

#include <zephyr/bluetooth/audio/audio.h>

Convert assigned numbers frequency to frequency value.

Parameters

freq	The assigned numbers frequency to convert.

Return values

-EINVAL	if arguments are invalid.
The	converted frequency value in Hz.

bt_audio_codec_cfg_get_chan_allocation()

int bt_audio_codec_cfg_get_chan_allocation	(	const struct bt_audio_codec_cfg *	codec_cfg,
		enum bt_audio_location *	chan_allocation
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract channel allocation from BT codec config.

The value returned is a bit field representing one or more audio locations as specified by bt_audio_location Shall match one or more of the bits set in BT_PAC_SNK_LOC/BT_PAC_SRC_LOC.

Up to the configured BT_AUDIO_CODEC_LC3_CHAN_COUNT number of channels can be present.

Parameters

codec_cfg	The codec configuration to extract data from.
chan_allocation	Pointer to the variable to store the extracted value in.

Return values

0	if value is found and stored in the pointer provided
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size or value

bt_audio_codec_cfg_get_frame_blocks_per_sdu()

int bt_audio_codec_cfg_get_frame_blocks_per_sdu	(	const struct bt_audio_codec_cfg *	codec_cfg,
		bool	fallback_to_default
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract number of audio frame blockss in each SDU from BT codec config.

The overall SDU size will be octets_per_frame * frame_blocks_per_sdu * number-of-channels.

If this value is not present a default value of 1 shall be used.

A frame block is one or more frames that represents data for the same period of time but for different channels. If the stream have two audio channels and this value is two there will be four frames in the SDU.

Parameters

codec_cfg	The codec configuration to extract data from.
fallback_to_default	If true this function will return the default value of 1 if the type is not found. In this case the function will only fail if a NULL pointer is provided.

Return values

The	count of codec frames in each SDU if value is found else of fallback_to_default is true then the value 1 is returned if frames per sdu is not found.
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size or value

bt_audio_codec_cfg_get_frame_duration_us()

int bt_audio_codec_cfg_get_frame_duration_us

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract frame duration from BT codec config.

Parameters

codec_cfg

The codec configuration to extract data from.

Return values

Frame	duration in microseconds
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size or value

bt_audio_codec_cfg_get_freq()

int bt_audio_codec_cfg_get_freq

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract the frequency from a codec configuration.

Parameters

codec_cfg

The codec configuration to extract data from.

Return values

A	bt_audio_codec_config_freq value
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size or value

bt_audio_codec_cfg_get_octets_per_frame()

int bt_audio_codec_cfg_get_octets_per_frame

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract frame size in octets from BT codec config.

The overall SDU size will be octets_per_frame * blocks_per_sdu.

The Bluetooth specificationa are not clear about this value - it does not state that the codec shall use this SDU size only. A codec like LC3 supports variable bit-rate (per SDU) hence it might be allowed for an encoder to reduce the frame size below this value. Hence it is recommended to use the received SDU size and divide by blocks_per_sdu rather than relying on this octets_per_sdu value to be fixed.

Parameters

codec_cfg

The codec configuration to extract data from.

Return values

Frame	length in octets
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size or value

bt_audio_codec_cfg_get_val()

uint8_t bt_audio_codec_cfg_get_val	(	const struct bt_audio_codec_cfg *	codec_cfg,
		uint8_t	type,
		const uint8_t **	data
	)

#include <zephyr/bluetooth/audio/audio.h>

Lookup a specific codec configuration value.

Parameters

[in]	codec_cfg	The codec data to search in.
[in]	type	The type id to look for
[out]	data	Pointer to the data-pointer to update when item is found

Returns

Length of found data or 0 if not found

bt_audio_codec_cfg_meta_get_audio_active_state()

int bt_audio_codec_cfg_meta_get_audio_active_state

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract audio active state.

See BT_AUDIO_METADATA_TYPE_AUDIO_STATE for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

The	preferred context type if positive or 0
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size

bt_audio_codec_cfg_meta_get_bcast_audio_immediate_rend_flag()

int bt_audio_codec_cfg_meta_get_bcast_audio_immediate_rend_flag

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract broadcast audio immediate rendering flag.

See BT_AUDIO_METADATA_TYPE_BROADCAST_IMMEDIATE for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

0	if the flag was found
-EINVAL	if arguments are invalid
-ENODATA	if not the flag was not found

bt_audio_codec_cfg_meta_get_ccid_list()

int bt_audio_codec_cfg_meta_get_ccid_list	(	const struct bt_audio_codec_cfg *	codec_cfg,
		const uint8_t **	ccid_list
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract CCID list.

See BT_AUDIO_METADATA_TYPE_CCID_LIST for more information about this value.

Parameters

[in]	codec_cfg	The codec data to search in.
[out]	ccid_list	Pointer to the array containing 8-bit CCIDs.

Return values

The	length of the ccid_list (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_meta_get_extended()

int bt_audio_codec_cfg_meta_get_extended	(	const struct bt_audio_codec_cfg *	codec_cfg,
		const uint8_t **	extended_meta
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract extended metadata.

See BT_AUDIO_METADATA_TYPE_EXTENDED for more information about this value.

Parameters

[in]	codec_cfg	The codec data to search in.
[out]	extended_meta	Pointer to the extended metadata.

Return values

The	length of the ccid_list (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_meta_get_parental_rating()

int bt_audio_codec_cfg_meta_get_parental_rating

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract parental rating.

See BT_AUDIO_METADATA_TYPE_PARENTAL_RATING for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

The	parental rating if positive or 0
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size

bt_audio_codec_cfg_meta_get_pref_context()

int bt_audio_codec_cfg_meta_get_pref_context

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract preferred contexts.

See BT_AUDIO_METADATA_TYPE_PREF_CONTEXT for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

The	preferred context type if positive or 0
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size

bt_audio_codec_cfg_meta_get_program_info()

int bt_audio_codec_cfg_meta_get_program_info	(	const struct bt_audio_codec_cfg *	codec_cfg,
		const uint8_t **	program_info
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract program info.

See BT_AUDIO_METADATA_TYPE_PROGRAM_INFO for more information about this value.

Parameters

[in]	codec_cfg	The codec data to search in.
[out]	program_info	Pointer to the UTF-8 formatted program info.

Return values

The	length of the program_info (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_meta_get_program_info_uri()

int bt_audio_codec_cfg_meta_get_program_info_uri	(	const struct bt_audio_codec_cfg *	codec_cfg,
		const uint8_t **	program_info_uri
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract program info URI.

See BT_AUDIO_METADATA_TYPE_PROGRAM_INFO_URI for more information about this value.

Parameters

[in]	codec_cfg	The codec data to search in.
[out]	program_info_uri	Pointer to the UTF-8 formatted program info URI.

Return values

The	length of the ccid_list (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_meta_get_stream_context()

int bt_audio_codec_cfg_meta_get_stream_context

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract stream contexts.

See BT_AUDIO_METADATA_TYPE_STREAM_CONTEXT for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

The	stream context type if positive or 0
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size

bt_audio_codec_cfg_meta_get_stream_lang()

int bt_audio_codec_cfg_meta_get_stream_lang

(

const struct bt_audio_codec_cfg *

codec_cfg

)

#include <zephyr/bluetooth/audio/audio.h>

Extract stream language.

See BT_AUDIO_METADATA_TYPE_STREAM_LANG for more information about this value.

Parameters

codec_cfg

The codec data to search in.

Return values

The	stream language if positive or 0
-EINVAL	if arguments are invalid
-ENODATA	if not found
-EBADMSG	if found value has invalid size

bt_audio_codec_cfg_meta_get_val()

int bt_audio_codec_cfg_meta_get_val	(	const struct bt_audio_codec_cfg *	codec_cfg,
		uint8_t	type,
		const uint8_t **	data
	)

#include <zephyr/bluetooth/audio/audio.h>

Lookup a specific metadata value based on type.

Parameters

[in]	codec_cfg	The codec data to search in.
[in]	type	The type id to look for
[out]	data	Pointer to the data-pointer to update when item is found

Return values

Length	of found data (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_meta_get_vendor()

int bt_audio_codec_cfg_meta_get_vendor	(	const struct bt_audio_codec_cfg *	codec_cfg,
		const uint8_t **	vendor_meta
	)

#include <zephyr/bluetooth/audio/audio.h>

Extract vendor specific metadata.

See BT_AUDIO_METADATA_TYPE_VENDOR for more information about this value.

Parameters

[in]	codec_cfg	The codec data to search in.
[out]	vendor_meta	Pointer to the vendor specific metadata.

Return values

The	length of the ccid_list (may be 0)
-EINVAL	if arguments are invalid
-ENODATA	if not found

bt_audio_codec_cfg_set_chan_allocation()

int bt_audio_codec_cfg_set_chan_allocation	(	struct bt_audio_codec_cfg *	codec_cfg,
		enum bt_audio_location	chan_allocation
	)

#include <zephyr/bluetooth/audio/audio.h>

Set the channel allocation of a codec configuration.

Parameters

codec_cfg	The codec configuration to set data for.
chan_allocation	The channel allocation to set.

Return values

The	data_len of codec_cfg on success
-EINVAL	if arguments are invalid
-ENOMEM	if the new value could not set or added due to memory

bt_audio_codec_cfg_set_frame_blocks_per_sdu()

int bt_audio_codec_cfg_set_frame_blocks_per_sdu	(	struct bt_audio_codec_cfg *	codec_cfg,
		uint8_t	frame_blocks
	)

#include <zephyr/bluetooth/audio/audio.h>

Set the frame blocks per SDU of a codec configuration.

Parameters

codec_cfg	The codec configuration to set data for.
frame_blocks	The frame blocks per SDU to set.

Return values

The	data_len of codec_cfg on success
-EINVAL	if arguments are invalid
-ENOMEM	if the new value could not set or added due to memory

bt_audio_codec_cfg_set_freq()

int bt_audio_codec_cfg_set_freq	(	struct bt_audio_codec_cfg *	codec_cfg,
		enum bt_audio_codec_config_freq	freq
	)

#include <zephyr/bluetooth/audio/audio.h>

Set the frequency of a codec configuration.

Parameters

codec_cfg	The codec configuration to set data for.
freq	The assigned numbers frequency to set.

Return values

The	data_len of codec_cfg on success
-EINVAL	if arguments are invalid
-ENOMEM	if the new value could not set or added due to memory

bt_audio_codec_cfg_set_octets_per_frame()

int bt_audio_codec_cfg_set_octets_per_frame	(	struct bt_audio_codec_cfg *	codec_cfg,
		uint16_t	octets_per_frame
	)

#include <zephyr/bluetooth/audio/audio.h>

Set the octets per codec frame of a codec configuration.

Parameters

codec_cfg	The codec configuration to set data for.
octets_per_frame	The octets per codec frame to set.

Return values

The	data_len of codec_cfg on success
-EINVAL	if arguments are invalid
-ENOMEM	if the new value could not set or added due to memory

bt_audio_codec_cfg_set_val()

int bt_audio_codec_cfg_set_val	(	struct bt_audio_codec_cfg *	codec_cfg,
		uint8_t	type,
		const uint8_t *	data,
		size_t	data_len
	)

#include <zephyr/bluetooth/audio/audio.h>

Set or add a specific codec configuration value.

Parameters

codec_cfg	The codec data to set the value in.
type	The type id to set
data	Pointer to the data-pointer to set
data_len	Length of data

Return values

The	data_len of codec_cfg on success
-EINVAL	if arguments are invalid
-ENOMEM	if the new value could not set or added due to memory