Bluetooth LC3 codec

LC3. More...

Macros
#define	BT_AUDIO_CODEC_CAP_LC3_DATA(_freq, _duration, _chan_count, _len_min, _len_max, _max_frames_per_sdu)
	Helper to declare LC3 codec capability.
#define	BT_AUDIO_CODEC_CAP_LC3_META(_prefer_context)
	Helper to declare LC3 codec metadata.
#define	BT_AUDIO_CODEC_CAP_LC3(_freq, _duration, _chan_count, _len_min, _len_max, _max_frames_per_sdu, _prefer_context)
	Helper to declare LC3 codec.
#define	BT_AUDIO_CODEC_CFG_LC3_DATA(_freq, _duration, _loc, _len, _frames_per_sdu)
	Helper to declare LC3 codec data configuration.
#define	BT_AUDIO_CODEC_CFG_LC3_META(_stream_context)
	Helper to declare LC3 codec metadata configuration.
#define	BT_AUDIO_CODEC_LC3_CONFIG(_freq, _duration, _loc, _len, _frames_per_sdu, _stream_context)
	Helper to declare LC3 codec configuration.

Detailed Description

LC3.

Since

3.0

Version

0.8.0

Macro Definition Documentation

BT_AUDIO_CODEC_CAP_LC3

#define BT_AUDIO_CODEC_CAP_LC3	(		_freq,
			_duration,
			_chan_count,
			_len_min,
			_len_max,
			_max_frames_per_sdu,
			_prefer_context
	)

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

Value:

        BT_AUDIO_CODEC_CAP(BT_HCI_CODING_FORMAT_LC3, 0x0000, 0x0000,                               \
                           BT_AUDIO_CODEC_CAP_LC3_DATA(_freq, _duration, _chan_count, _len_min,    \
                                                       _len_max, _max_frames_per_sdu),             \
                           BT_AUDIO_CODEC_CAP_LC3_META(_prefer_context))

Helper to declare LC3 codec.

Parameters

_freq	Supported Sampling Frequencies bitfield (see BT_AUDIO_CODEC_CAP_FREQ_*)
_duration	Supported Frame Durations bitfield (see BT_AUDIO_CODEC_CAP_DURATION_*)
_chan_count	Supported channels (see BT_AUDIO_CODEC_CAP_CHAN_COUNT_SUPPORT)
_len_min	Minimum number of octets supported per codec frame
_len_max	Maximum number of octets supported per codec frame
_max_frames_per_sdu	Supported maximum codec frames per SDU
_prefer_context	Preferred contexts (bt_audio_context)

BT_AUDIO_CODEC_CAP_LC3_DATA

#define BT_AUDIO_CODEC_CAP_LC3_DATA	(		_freq,
			_duration,
			_chan_count,
			_len_min,
			_len_max,
			_max_frames_per_sdu
	)

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

Value:

        {                                                                                          \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CAP_TYPE_FREQ, BT_BYTES_LIST_LE16(_freq)),      \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CAP_TYPE_DURATION, (_duration)),                \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CAP_TYPE_CHAN_COUNT, (_chan_count)),            \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CAP_TYPE_FRAME_LEN,                             \
                                    BT_BYTES_LIST_LE16(_len_min),                                  \
                                    BT_BYTES_LIST_LE16(_len_max)),                                 \
                COND_CODE_1(_max_frames_per_sdu, (),                                               \
                            (BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CAP_TYPE_FRAME_COUNT,              \
                                                 (_max_frames_per_sdu))))                          \
        }

Helper to declare LC3 codec capability.

_max_frames_per_sdu is optional and will be included only if != 1

COND_CODE_1 is used to omit an LTV entry in case the _frames_per_sdu is 1. COND_CODE_1 will evaluate to second argument if the flag parameter(first argument) is 1

• removing one layer of paranteses. If the flags argument is != 1 it will evaluate to the third argument which inserts a LTV entry for the max_frames_per_sdu value.

Parameters

_freq	Supported Sampling Frequencies bitfield (see BT_AUDIO_CODEC_CAP_FREQ_*)
_duration	Supported Frame Durations bitfield (see BT_AUDIO_CODEC_CAP_DURATION_*)
_chan_count	Supported channels (see BT_AUDIO_CODEC_CAP_CHAN_COUNT_SUPPORT)
_len_min	Minimum number of octets supported per codec frame
_len_max	Maximum number of octets supported per codec frame
_max_frames_per_sdu	Supported maximum codec frames per SDU

BT_AUDIO_CODEC_CAP_LC3_META

#define BT_AUDIO_CODEC_CAP_LC3_META

(

_prefer_context

)

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

Value:

        {                                                                                          \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_METADATA_TYPE_PREF_CONTEXT,                           \
                                    BT_BYTES_LIST_LE16(_prefer_context))                           \
        }

Helper to declare LC3 codec metadata.

Parameters

_prefer_context

Preferred contexts (bt_audio_context)

BT_AUDIO_CODEC_CFG_LC3_DATA

#define BT_AUDIO_CODEC_CFG_LC3_DATA	(		_freq,
			_duration,
			_loc,
			_len,
			_frames_per_sdu
	)

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

Value:

        {                                                                                          \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CFG_FREQ, (_freq)),                             \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CFG_DURATION, (_duration)),                     \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CFG_CHAN_ALLOC, BT_BYTES_LIST_LE32(_loc)),      \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CFG_FRAME_LEN, BT_BYTES_LIST_LE16(_len)),       \
                COND_CODE_1(_frames_per_sdu, (),                                                   \
                            (BT_AUDIO_CODEC_DATA(BT_AUDIO_CODEC_CFG_FRAME_BLKS_PER_SDU,            \
                                                 (_frames_per_sdu))))                              \
        }

Helper to declare LC3 codec data configuration.

Parameters

_freq	Sampling frequency (BT_AUDIO_CODEC_CFG_FREQ_*)
_duration	Frame duration (BT_AUDIO_CODEC_CFG_DURATION_*)
_loc	Audio channel location bitfield (bt_audio_location)
_len	Octets per frame (16-bit integer)
_frames_per_sdu	Frames per SDU (8-bit integer). This value is optional and will be included only if != 1

BT_AUDIO_CODEC_CFG_LC3_META

#define BT_AUDIO_CODEC_CFG_LC3_META

(

_stream_context

)

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

Value:

        {                                                                                          \
                BT_AUDIO_CODEC_DATA(BT_AUDIO_METADATA_TYPE_STREAM_CONTEXT,                         \
                                    BT_BYTES_LIST_LE16(_stream_context))                           \
        }

Helper to declare LC3 codec metadata configuration.

BT_AUDIO_CODEC_LC3_CONFIG

#define BT_AUDIO_CODEC_LC3_CONFIG	(		_freq,
			_duration,
			_loc,
			_len,
			_frames_per_sdu,
			_stream_context
	)

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

Value:

        BT_AUDIO_CODEC_CFG(                                                                        \
                BT_HCI_CODING_FORMAT_LC3, 0x0000, 0x0000,                                          \
                BT_AUDIO_CODEC_CFG_LC3_DATA(_freq, _duration, _loc, _len, _frames_per_sdu),        \
                BT_AUDIO_CODEC_CFG_LC3_META(_stream_context))

Helper to declare LC3 codec configuration.

Parameters

_freq	Sampling frequency (BT_AUDIO_CODEC_CFG_FREQ_*)
_duration	Frame duration (BT_AUDIO_CODEC_CFG_DURATION_*)
_loc	Audio channel location bitfield (bt_audio_location)
_len	Octets per frame (16-bit integer)
_frames_per_sdu	Frames per SDU (8-bit integer)
_stream_context	Stream context (BT_AUDIO_CONTEXT_*)