lc3.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2020 Intel Corporation
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_LC3_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_LC3_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_CODEC_LC3_ID                  0x06
 
/* TODO: Remove base once LTV types are defined */
#define BT_CODEC_LC3_CAP_BASE            0x01
 
#define BT_CODEC_LC3_FREQ                (BT_CODEC_LC3_CAP_BASE)
#define BT_CODEC_LC3_FREQ_8KHZ           BIT(0)
#define BT_CODEC_LC3_FREQ_11KHZ          BIT(1)
#define BT_CODEC_LC3_FREQ_16KHZ          BIT(2)
#define BT_CODEC_LC3_FREQ_22KHZ          BIT(3)
#define BT_CODEC_LC3_FREQ_24KHZ          BIT(4)
#define BT_CODEC_LC3_FREQ_32KHZ          BIT(5)
#define BT_CODEC_LC3_FREQ_44KHZ          BIT(6)
#define BT_CODEC_LC3_FREQ_48KHZ          BIT(7)
#define BT_CODEC_LC3_FREQ_ANY            (BT_CODEC_LC3_FREQ_8KHZ | \
                                          BT_CODEC_LC3_FREQ_16KHZ | \
                                          BT_CODEC_LC3_FREQ_24KHZ | \
                                          BT_CODEC_LC3_FREQ_32KHZ | \
                                          BT_CODEC_LC3_FREQ_44KHZ | \
                                          BT_CODEC_LC3_FREQ_48KHZ)
 
#define BT_CODEC_LC3_DURATION            (BT_CODEC_LC3_CAP_BASE + 1)
#define BT_CODEC_LC3_DURATION_7_5        BIT(0)
#define BT_CODEC_LC3_DURATION_10         BIT(1)
#define BT_CODEC_LC3_DURATION_ANY        (BT_CODEC_LC3_DURATION_7_5 | \
                                          BT_CODEC_LC3_DURATION_10)
#define BT_CODEC_LC3_DURATION_PREFER_7_5 BIT(4)
#define BT_CODEC_LC3_DURATION_PREFER_10  BIT(5)
 
 
#define BT_CODEC_LC3_CHAN_COUNT          (BT_CODEC_LC3_CAP_BASE + 2)
#define BT_CODEC_LC3_CHAN_COUNT_SUPPORT  BIT(0)
 
#define BT_CODEC_LC3_FRAME_LEN           (BT_CODEC_LC3_CAP_BASE + 3)
 
#define BT_CODEC_LC3_FRAME_COUNT         (BT_CODEC_LC3_CAP_BASE + 4)
 
/* TODO: Remove base once LTV types are defined */
#define BT_CODEC_LC3_CONFIG_BASE         0x01
 
struct bt_codec_lc3_frame_len {
        uint16_t min;
        uint16_t max;
};
 
#define BT_CODEC_CONFIG_LC3_FREQ         (BT_CODEC_LC3_CONFIG_BASE)
#define BT_CODEC_CONFIG_LC3_FREQ_8KHZ    0x01
#define BT_CODEC_CONFIG_LC3_FREQ_11KHZ   0x02
#define BT_CODEC_CONFIG_LC3_FREQ_16KHZ   0x03
#define BT_CODEC_CONFIG_LC3_FREQ_22KHZ   0x04
#define BT_CODEC_CONFIG_LC3_FREQ_24KHZ   0x05
#define BT_CODEC_CONFIG_LC3_FREQ_32KHZ   0x06
#define BT_CODEC_CONFIG_LC3_FREQ_44KHZ   0x07
#define BT_CODEC_CONFIG_LC3_FREQ_48KHZ   0x08
 
#define BT_CODEC_CONFIG_LC3_DURATION     (BT_CODEC_LC3_CONFIG_BASE + 1)
#define BT_CODEC_CONFIG_LC3_DURATION_7_5 0x00
#define BT_CODEC_CONFIG_LC3_DURATION_10  0x01
 
#define BT_CODEC_CONFIG_LC3_CHAN_ALLOC   (BT_CODEC_LC3_CONFIG_BASE + 2)
 
#define BT_CODEC_CONFIG_LC3_FRAME_LEN    (BT_CODEC_LC3_CONFIG_BASE + 3)
 
#define BT_CODEC_LC3_DATA(_freq, _duration, _chan_count, _len_min, _len_max) \
{ \
         BT_CODEC_DATA(BT_CODEC_LC3_FREQ, _freq, _freq >> 8), \
         BT_CODEC_DATA(BT_CODEC_LC3_DURATION, _duration), \
         BT_CODEC_DATA(BT_CODEC_LC3_CHAN_COUNT, _chan_count), \
         BT_CODEC_DATA(BT_CODEC_LC3_FRAME_LEN, _len_min, _len_min >> 8, \
                       _len_max, _len_max >> 8,) \
}
 
#define BT_CODEC_LC3_META(_prefer_context, _context) \
{ \
         BT_CODEC_DATA(BT_CODEC_META_PREFER_CONTEXT, _prefer_context & 0xff, \
                       _prefer_context >> 8), \
         BT_CODEC_DATA(BT_CODEC_META_CONTEXT, _context & 0xff, _context >> 8) \
}
 
#define BT_CODEC_LC3(_freq, _duration, _chan_count, _len_min, _len_max, \
                     _frames, _prefer_context, _context) \
        BT_CODEC(BT_CODEC_LC3_ID, 0x0000, 0x0000, \
                 BT_CODEC_LC3_DATA(_freq, _duration, _chan_count, _len_min, \
                                   _len_max), \
                 BT_CODEC_LC3_META(_prefer_context, _context))
 
#define BT_CODEC_LC3_CONFIG_DATA(_freq, _duration, _loc, _len) \
{ \
         BT_CODEC_DATA(BT_CODEC_CONFIG_LC3_FREQ, _freq), \
         BT_CODEC_DATA(BT_CODEC_CONFIG_LC3_DURATION, _duration), \
         BT_CODEC_DATA(BT_CODEC_CONFIG_LC3_CHAN_ALLOC, _loc, _loc >> 8, \
                       _loc >> 16, _loc >> 24), \
         BT_CODEC_DATA(BT_CODEC_CONFIG_LC3_FRAME_LEN, _len, _len >> 8) \
}
 
#define BT_CODEC_LC3_CONFIG_META(_context) \
{ \
         BT_CODEC_DATA(BT_CODEC_META_CONTEXT, _context, _context >> 8), \
}
 
#define BT_CODEC_LC3_CONFIG_N(_freq, _duration, _loc, _len, _context) \
        BT_CODEC(BT_CODEC_LC3_ID, 0x0000, 0x0000, \
                 BT_CODEC_LC3_CONFIG_DATA(_freq, _duration, _loc, _len), \
                 BT_CODEC_LC3_CONFIG_META(_context))
 
#define BT_CODEC_LC3_CONFIG(_freq, _duration, _len, _context) \
        BT_CODEC_LC3_CONFIG_N(_freq, _duration, 0x000000000, _len, _context)
 
#define BT_CODEC_LC3_CONFIG_8_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_8KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 26u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_8_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_8KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 30u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_16_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_16KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 30u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_16_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_16KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 40u, \
                            BT_CODEC_META_CONTEXT_VOICE)
 
#define BT_CODEC_LC3_CONFIG_24_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_24KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 45u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_24_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_24KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 60u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_32_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_32KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 60u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_32_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_32KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 80u, \
                            BT_CODEC_META_CONTEXT_VOICE)
#define BT_CODEC_LC3_CONFIG_441_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_44KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 98u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_441_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_44KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 130u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_1 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 75u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_2 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 100u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_3 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_LC3_DURATION_7_5, 90u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_4 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 120u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_5 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_7_5, 117u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_CONFIG_48_6 \
        BT_CODEC_LC3_CONFIG(BT_CODEC_CONFIG_LC3_FREQ_48KHZ, \
                            BT_CODEC_CONFIG_LC3_DURATION_10, 155u, \
                            BT_CODEC_META_CONTEXT_MEDIA)
#define BT_CODEC_LC3_QOS_7_5(_dir, _framing, _sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS(_dir, 7500u, _framing, BT_CODEC_QOS_2M, _sdu, _rtn, \
                     _latency, _pd)
#define BT_CODEC_LC3_QOS_7_5_IN_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_IN_UNFRAMED(7500u, _sdu, _rtn, _latency, _pd)
#define BT_CODEC_LC3_QOS_7_5_OUT_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_OUT_UNFRAMED(7500u, _sdu, _rtn, _latency, _pd)
#define BT_CODEC_LC3_QOS_7_5_INOUT_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_INOUT_UNFRAMED(7500u, _sdu, _rtn, _latency, _pd)
#define BT_CODEC_LC3_QOS_10(_dir, _framing, _sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS(_dir, 10000u, _framing, BT_CODEC_QOS_2M, _sdu, _rtn, \
                     _latency, _pd)
#define BT_CODEC_LC3_QOS_10_IN_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_IN_UNFRAMED(10000u, _sdu, _rtn, _latency, _pd)
#define BT_CODEC_LC3_QOS_10_OUT_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_OUT_UNFRAMED(10000u, _sdu, _rtn, _latency, _pd)
#define BT_CODEC_LC3_QOS_10_INOUT_UNFRAMED(_sdu, _rtn, _latency, _pd) \
        BT_CODEC_QOS_INOUT_UNFRAMED(10000u, _sdu, _rtn, _latency, _pd)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_LC3_H_ */