Zephyr API Documentation 4.0.0-rc3
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
audio.h
Go to the documentation of this file.
1
6/*
7 * Copyright (c) 2020 Intel Corporation
8 * Copyright (c) 2020-2024 Nordic Semiconductor ASA
9 *
10 * SPDX-License-Identifier: Apache-2.0
11 */
12#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_AUDIO_H_
13#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_AUDIO_H_
14
22#include <stdbool.h>
23#include <stddef.h>
24#include <stdint.h>
25
26#include <zephyr/autoconf.h>
34#include <zephyr/sys/atomic.h>
35#include <zephyr/sys/util.h>
37
38#ifdef __cplusplus
39extern "C" {
40#endif
41
43#define BT_AUDIO_BROADCAST_ID_SIZE 3
45#define BT_AUDIO_BROADCAST_ID_MAX 0xFFFFFFU
47#define BT_AUDIO_PD_PREF_NONE 0x000000U
49#define BT_AUDIO_PD_MAX 0xFFFFFFU
51#define BT_AUDIO_RTN_PREF_NONE 0xFFU
53#define BT_AUDIO_BROADCAST_NAME_LEN_MIN 4
55#define BT_AUDIO_BROADCAST_NAME_LEN_MAX 128
56
58#define BT_AUDIO_LANG_SIZE 3
59
82
134
163
197
199#define BT_AUDIO_CODEC_CAP_CHAN_COUNT_MIN 1
201#define BT_AUDIO_CODEC_CAP_CHAN_COUNT_MAX 8
202
213#define BT_AUDIO_CODEC_CAP_CHAN_COUNT_SUPPORT(...) \
214 ((enum bt_audio_codec_cap_chan_count)((FOR_EACH(BIT, (|), __VA_ARGS__)) >> 1))
215
223
246
288
297
355
359#define BT_AUDIO_CONTEXT_TYPE_ANY (BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED | \
360 BT_AUDIO_CONTEXT_TYPE_CONVERSATIONAL | \
361 BT_AUDIO_CONTEXT_TYPE_MEDIA | \
362 BT_AUDIO_CONTEXT_TYPE_GAME | \
363 BT_AUDIO_CONTEXT_TYPE_INSTRUCTIONAL | \
364 BT_AUDIO_CONTEXT_TYPE_VOICE_ASSISTANTS | \
365 BT_AUDIO_CONTEXT_TYPE_LIVE | \
366 BT_AUDIO_CONTEXT_TYPE_SOUND_EFFECTS | \
367 BT_AUDIO_CONTEXT_TYPE_NOTIFICATIONS | \
368 BT_AUDIO_CONTEXT_TYPE_RINGTONE | \
369 BT_AUDIO_CONTEXT_TYPE_ALERTS | \
370 BT_AUDIO_CONTEXT_TYPE_EMERGENCY_ALARM)
371
412
420
426
507
513#define BT_AUDIO_METADATA_TYPE_IS_KNOWN(_type) \
514 (IN_RANGE((_type), BT_AUDIO_METADATA_TYPE_PREF_CONTEXT, \
515 BT_AUDIO_METADATA_TYPE_BROADCAST_IMMEDIATE) || \
516 (_type) == BT_AUDIO_METADATA_TYPE_EXTENDED || (_type) == BT_AUDIO_METADATA_TYPE_VENDOR)
517
523#define BT_AUDIO_UNICAST_ANNOUNCEMENT_GENERAL 0x00
525#define BT_AUDIO_UNICAST_ANNOUNCEMENT_TARGETED 0x01
536#define BT_AUDIO_CODEC_DATA(_type, _bytes...) \
537 (sizeof((uint8_t)_type) + sizeof((uint8_t[]){_bytes})), (_type), _bytes
538
548#define BT_AUDIO_CODEC_CFG(_id, _cid, _vid, _data, _meta) \
549 ((struct bt_audio_codec_cfg){ \
550 /* Use HCI data path as default, can be overwritten by application */ \
551 .path_id = BT_ISO_DATA_PATH_HCI, \
552 .ctlr_transcode = false, \
553 .id = _id, \
554 .cid = _cid, \
555 .vid = _vid, \
556 .data_len = sizeof((uint8_t[])_data), \
557 .data = _data, \
558 .meta_len = sizeof((uint8_t[])_meta), \
559 .meta = _meta, \
560 })
561
571#define BT_AUDIO_CODEC_CAP(_id, _cid, _vid, _data, _meta) \
572 ((struct bt_audio_codec_cap){ \
573 /* Use HCI data path as default, can be overwritten by application */ \
574 .path_id = BT_ISO_DATA_PATH_HCI, \
575 .ctlr_transcode = false, \
576 .id = (_id), \
577 .cid = (_cid), \
578 .vid = (_vid), \
579 .data_len = sizeof((uint8_t[])_data), \
580 .data = _data, \
581 .meta_len = sizeof((uint8_t[])_meta), \
582 .meta = _meta, \
583 })
584
650
654#define BT_AUDIO_LOCATION_ANY (BT_AUDIO_LOCATION_FRONT_LEFT | \
655 BT_AUDIO_LOCATION_FRONT_RIGHT | \
656 BT_AUDIO_LOCATION_FRONT_CENTER | \
657 BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_1 | \
658 BT_AUDIO_LOCATION_BACK_LEFT | \
659 BT_AUDIO_LOCATION_BACK_RIGHT | \
660 BT_AUDIO_LOCATION_FRONT_LEFT_OF_CENTER | \
661 BT_AUDIO_LOCATION_FRONT_RIGHT_OF_CENTER | \
662 BT_AUDIO_LOCATION_BACK_CENTER | \
663 BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_2 | \
664 BT_AUDIO_LOCATION_SIDE_LEFT | \
665 BT_AUDIO_LOCATION_SIDE_RIGHT | \
666 BT_AUDIO_LOCATION_TOP_FRONT_LEFT | \
667 BT_AUDIO_LOCATION_TOP_FRONT_RIGHT | \
668 BT_AUDIO_LOCATION_TOP_FRONT_CENTER | \
669 BT_AUDIO_LOCATION_TOP_CENTER | \
670 BT_AUDIO_LOCATION_TOP_BACK_LEFT | \
671 BT_AUDIO_LOCATION_TOP_BACK_RIGHT | \
672 BT_AUDIO_LOCATION_TOP_SIDE_LEFT | \
673 BT_AUDIO_LOCATION_TOP_SIDE_RIGHT | \
674 BT_AUDIO_LOCATION_TOP_BACK_CENTER | \
675 BT_AUDIO_LOCATION_BOTTOM_FRONT_CENTER | \
676 BT_AUDIO_LOCATION_BOTTOM_FRONT_LEFT | \
677 BT_AUDIO_LOCATION_BOTTOM_FRONT_RIGHT | \
678 BT_AUDIO_LOCATION_FRONT_LEFT_WIDE | \
679 BT_AUDIO_LOCATION_FRONT_RIGHT_WIDE | \
680 BT_AUDIO_LOCATION_LEFT_SURROUND | \
681 BT_AUDIO_LOCATION_RIGHT_SURROUND)
682
703#if CONFIG_BT_AUDIO_CODEC_CAP_MAX_DATA_SIZE > 0 || defined(__DOXYGEN__)
705 size_t data_len;
707 uint8_t data[CONFIG_BT_AUDIO_CODEC_CAP_MAX_DATA_SIZE];
708#endif /* CONFIG_BT_AUDIO_CODEC_CAP_MAX_DATA_SIZE > 0 */
709#if defined(CONFIG_BT_AUDIO_CODEC_CAP_MAX_METADATA_SIZE) || defined(__DOXYGEN__)
711 size_t meta_len;
713 uint8_t meta[CONFIG_BT_AUDIO_CODEC_CAP_MAX_METADATA_SIZE];
714#endif /* CONFIG_BT_AUDIO_CODEC_CAP_MAX_METADATA_SIZE */
715};
716
737#if CONFIG_BT_AUDIO_CODEC_CFG_MAX_DATA_SIZE > 0 || defined(__DOXYGEN__)
739 size_t data_len;
741 uint8_t data[CONFIG_BT_AUDIO_CODEC_CFG_MAX_DATA_SIZE];
742#endif /* CONFIG_BT_AUDIO_CODEC_CFG_MAX_DATA_SIZE > 0 */
743#if CONFIG_BT_AUDIO_CODEC_CFG_MAX_METADATA_SIZE > 0 || defined(__DOXYGEN__)
745 size_t meta_len;
747 uint8_t meta[CONFIG_BT_AUDIO_CODEC_CFG_MAX_METADATA_SIZE];
748#endif /* CONFIG_BT_AUDIO_CODEC_CFG_MAX_METADATA_SIZE > 0 */
749};
750
765int bt_audio_data_parse(const uint8_t ltv[], size_t size,
766 bool (*func)(struct bt_data *data, void *user_data), void *user_data);
767
783int bt_audio_data_get_val(const uint8_t ltv_data[], size_t size, uint8_t type,
784 const uint8_t **data);
785
794
812
831
841
853
865 enum bt_audio_codec_cfg_freq freq);
866
876
886
898
910 enum bt_audio_codec_cfg_frame_dur frame_dur);
911
933 enum bt_audio_location *chan_allocation,
934 bool fallback_to_default);
935
947 enum bt_audio_location chan_allocation);
948
969
981 uint16_t octets_per_frame);
982
1004 bool fallback_to_default);
1005
1017 uint8_t frame_blocks);
1018
1031 enum bt_audio_codec_cfg_type type, const uint8_t **data);
1032
1046 enum bt_audio_codec_cfg_type type, const uint8_t *data,
1047 size_t data_len);
1048
1061 enum bt_audio_codec_cfg_type type);
1062
1076 const uint8_t **data);
1077
1091 enum bt_audio_metadata_type type, const uint8_t *data,
1092 size_t data_len);
1093
1106 enum bt_audio_metadata_type type);
1123 bool fallback_to_default);
1124
1136 enum bt_audio_context ctx);
1137
1151
1163 enum bt_audio_context ctx);
1164
1178 const uint8_t **program_info);
1179
1192 const uint8_t *program_info, size_t program_info_len);
1193
1208 const uint8_t **lang);
1209
1221 const uint8_t lang[BT_AUDIO_LANG_SIZE]);
1222
1236 const uint8_t **ccid_list);
1237
1250 const uint8_t *ccid_list, size_t ccid_list_len);
1251
1265
1277 enum bt_audio_parental_rating parental_rating);
1278
1292 const uint8_t **program_info_uri);
1293
1306 const uint8_t *program_info_uri,
1307 size_t program_info_uri_len);
1308
1322
1335
1348 const struct bt_audio_codec_cfg *codec_cfg);
1349
1360 struct bt_audio_codec_cfg *codec_cfg);
1361
1375 const struct bt_audio_codec_cfg *codec_cfg);
1376
1388 struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_assisted_listening_stream val);
1389
1403 const uint8_t **broadcast_name);
1404
1417 const uint8_t *broadcast_name,
1418 size_t broadcast_name_len);
1419
1433 const uint8_t **extended_meta);
1434
1447 const uint8_t *extended_meta, size_t extended_meta_len);
1448
1462 const uint8_t **vendor_meta);
1463
1476 const uint8_t *vendor_meta, size_t vendor_meta_len);
1477 /* End of bt_audio_codec_cfg */
1478
1501 enum bt_audio_codec_cap_type type, const uint8_t **data);
1502
1516 enum bt_audio_codec_cap_type type, const uint8_t *data,
1517 size_t data_len);
1518
1531 enum bt_audio_codec_cap_type type);
1532
1544
1556 enum bt_audio_codec_cap_freq freq);
1557
1569
1581 enum bt_audio_codec_cap_frame_dur frame_dur);
1582
1596 bool fallback_to_default);
1597
1609 struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_chan_count chan_count);
1610
1623 const struct bt_audio_codec_cap *codec_cap,
1624 struct bt_audio_codec_octets_per_codec_frame *codec_frame);
1625
1637 struct bt_audio_codec_cap *codec_cap,
1638 const struct bt_audio_codec_octets_per_codec_frame *codec_frame);
1639
1653 bool fallback_to_default);
1654
1666 uint8_t codec_frames_per_sdu);
1667
1680 const uint8_t **data);
1681
1695 enum bt_audio_metadata_type type, const uint8_t *data,
1696 size_t data_len);
1697
1710 enum bt_audio_metadata_type type);
1711
1725
1737 enum bt_audio_context ctx);
1738
1752
1764 enum bt_audio_context ctx);
1765
1779 const uint8_t **program_info);
1780
1793 const uint8_t *program_info, size_t program_info_len);
1794
1809 const uint8_t **lang);
1810
1822 const uint8_t lang[BT_AUDIO_LANG_SIZE]);
1823
1837 const uint8_t **ccid_list);
1838
1851 const uint8_t *ccid_list, size_t ccid_list_len);
1852
1866
1878 enum bt_audio_parental_rating parental_rating);
1879
1893 const uint8_t **program_info_uri);
1894
1907 const uint8_t *program_info_uri,
1908 size_t program_info_uri_len);
1909
1923
1936
1949 const struct bt_audio_codec_cap *codec_cap);
1950
1961 struct bt_audio_codec_cap *codec_cap);
1962
1976 const struct bt_audio_codec_cap *codec_cap);
1977
1989 struct bt_audio_codec_cap *codec_cap, enum bt_audio_assisted_listening_stream val);
1990
2004 const uint8_t **broadcast_name);
2005
2018 const uint8_t *broadcast_name,
2019 size_t broadcast_name_len);
2033 const uint8_t **extended_meta);
2034
2047 const uint8_t *extended_meta, size_t extended_meta_len);
2048
2062 const uint8_t **vendor_meta);
2063
2076 const uint8_t *vendor_meta, size_t vendor_meta_len);
2077
2078 /* End of bt_audio_codec_cap */
2079
2098static inline char *bt_audio_context_bit_to_str(enum bt_audio_context context)
2099{
2100 switch (context) {
2102 return "Prohibited";
2104 return "Unspecified";
2106 return "Conversational";
2108 return "Media";
2110 return "Game";
2112 return "Instructional";
2114 return "Voice assistant";
2116 return "Live";
2118 return "Sound effects";
2120 return "Notifications";
2122 return "Ringtone";
2124 return "Alerts";
2126 return "Emergency alarm";
2127 default:
2128 return "Unknown context";
2129 }
2130}
2131
2139static inline char *bt_audio_parental_rating_to_str(enum bt_audio_parental_rating parental_rating)
2140{
2141 switch (parental_rating) {
2143 return "No rating";
2145 return "Any";
2147 return "Age 5 or above";
2149 return "Age 6 or above";
2151 return "Age 7 or above";
2153 return "Age 8 or above";
2155 return "Age 9 or above";
2157 return "Age 10 or above";
2159 return "Age 11 or above";
2161 return "Age 12 or above";
2163 return "Age 13 or above";
2165 return "Age 14 or above";
2167 return "Age 15 or above";
2169 return "Age 16 or above";
2171 return "Age 17 or above";
2173 return "Age 18 or above";
2174 default:
2175 return "Unknown rating";
2176 }
2177}
2178
2187{
2188 switch (state) {
2190 return "Disabled";
2192 return "Enabled";
2193 default:
2194 return "Unknown active state";
2195 }
2196}
2197
2208{
2209 switch (freq) {
2211 return "8000 Hz";
2213 return "11025 Hz";
2215 return "16000 Hz";
2217 return "22050 Hz";
2219 return "24000 Hz";
2221 return "32000 Hz";
2223 return "44100 Hz";
2225 return "48000 Hz";
2227 return "88200 Hz";
2229 return "96000 Hz";
2231 return "176400 Hz";
2233 return "192000 Hz";
2235 return "384000 Hz";
2236 default:
2237 return "Unknown supported frequency";
2238 }
2239}
2240
2250static inline char *
2252{
2253 switch (frame_dur) {
2255 return "7.5 ms";
2257 return "10 ms";
2259 return "7.5 ms preferred";
2261 return "10 ms preferred";
2262 default:
2263 return "Unknown frame duration";
2264 }
2265}
2266
2276static inline char *
2278{
2279 switch (chan_count) {
2281 return "1 channel";
2283 return "2 channels";
2285 return "3 channels";
2287 return "4 channels";
2289 return "5 channels";
2291 return "6 channels";
2293 return "7 channels";
2295 return "8 channels";
2296 default:
2297 return "Unknown channel count";
2298 }
2299}
2300
2310static inline char *bt_audio_location_bit_to_str(enum bt_audio_location location)
2311{
2312 switch (location) {
2314 return "Mono";
2316 return "Front left";
2318 return "Front right";
2320 return "Front center";
2322 return "Low frequency effects 1";
2324 return "Back left";
2326 return "Back right";
2328 return "Front left of center";
2330 return "Front right of center";
2332 return "Back center";
2334 return "Low frequency effects 2";
2336 return "Side left";
2338 return "Side right";
2340 return "Top front left";
2342 return "Top front right";
2344 return "Top front center";
2346 return "Top center";
2348 return "Top back left";
2350 return "Top back right";
2352 return "Top side left";
2354 return "Top side right";
2356 return "Top back center";
2358 return "Bottom front center";
2360 return "Bottom front left";
2362 return "Bottom front right";
2364 return "Front left wide";
2366 return "Front right wde";
2368 return "Left surround";
2370 return "Right surround";
2371 default:
2372 return "Unknown location";
2373 }
2374}
2375
2376 /* End of bt_audio_to_str */
2377#ifdef __cplusplus
2378}
2379#endif
2380
2381 /* end of bt_audio */
2382
2383#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_H_ */
Bluetooth subsystem core APIs.
Bluetooth data buffer API.
Bluetooth connection handling.
Generic Attribute Profile handling.
int bt_audio_codec_cap_meta_set_ccid_list(struct bt_audio_codec_cap *codec_cap, const uint8_t *ccid_list, size_t ccid_list_len)
Set the CCID list of a codec capability metadata.
int bt_audio_codec_cap_set_val(struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_type type, const uint8_t *data, size_t data_len)
Set or add a specific codec capability value.
int bt_audio_codec_cap_get_frame_dur(const struct bt_audio_codec_cap *codec_cap)
Extract the frequency from a codec capability.
int bt_audio_codec_cap_get_max_codec_frames_per_sdu(const struct bt_audio_codec_cap *codec_cap, bool fallback_to_default)
Extract the maximum codec frames per SDU from a codec capability.
int bt_audio_codec_cap_meta_set_vendor(struct bt_audio_codec_cap *codec_cap, const uint8_t *vendor_meta, size_t vendor_meta_len)
Set the vendor specific metadata of a codec capability metadata.
int bt_audio_codec_cap_meta_set_val(struct bt_audio_codec_cap *codec_cap, enum bt_audio_metadata_type type, const uint8_t *data, size_t data_len)
Set or add a specific codec capability metadata value.
int bt_audio_codec_cap_meta_get_ccid_list(const struct bt_audio_codec_cap *codec_cap, const uint8_t **ccid_list)
Extract CCID list.
int bt_audio_codec_cap_meta_set_assisted_listening_stream(struct bt_audio_codec_cap *codec_cap, enum bt_audio_assisted_listening_stream val)
Set the assisted listening stream value of a codec capability metadata.
int bt_audio_codec_cap_meta_get_program_info(const struct bt_audio_codec_cap *codec_cap, const uint8_t **program_info)
Extract program info.
int bt_audio_codec_cap_set_max_codec_frames_per_sdu(struct bt_audio_codec_cap *codec_cap, uint8_t codec_frames_per_sdu)
Set the maximum codec frames per SDU of a codec capability.
int bt_audio_codec_cap_meta_get_broadcast_name(const struct bt_audio_codec_cap *codec_cap, const uint8_t **broadcast_name)
Extract broadcast name.
int bt_audio_codec_cap_meta_unset_val(struct bt_audio_codec_cap *codec_cap, enum bt_audio_metadata_type type)
Unset a specific codec capability metadata value.
int bt_audio_codec_cap_meta_set_program_info(struct bt_audio_codec_cap *codec_cap, const uint8_t *program_info, size_t program_info_len)
Set the program info of a codec capability metadata.
int bt_audio_codec_cap_meta_set_broadcast_name(struct bt_audio_codec_cap *codec_cap, const uint8_t *broadcast_name, size_t broadcast_name_len)
Set the broadcast name of a codec capability metadata.
int bt_audio_codec_cap_meta_get_assisted_listening_stream(const struct bt_audio_codec_cap *codec_cap)
Extract assisted listening stream.
int bt_audio_codec_cap_set_frame_dur(struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_frame_dur frame_dur)
Set the frame duration of a codec capability.
int bt_audio_codec_cap_meta_get_val(const struct bt_audio_codec_cap *codec_cap, uint8_t type, const uint8_t **data)
Lookup a specific metadata value based on type.
int bt_audio_codec_cap_meta_set_stream_context(struct bt_audio_codec_cap *codec_cap, enum bt_audio_context ctx)
Set the stream context of a codec capability metadata.
int bt_audio_codec_cap_meta_set_parental_rating(struct bt_audio_codec_cap *codec_cap, enum bt_audio_parental_rating parental_rating)
Set the parental rating of a codec capability metadata.
int bt_audio_codec_cap_get_supported_audio_chan_counts(const struct bt_audio_codec_cap *codec_cap, bool fallback_to_default)
Extract the frequency from a codec capability.
int bt_audio_codec_cap_meta_get_extended(const struct bt_audio_codec_cap *codec_cap, const uint8_t **extended_meta)
Extract extended metadata.
int bt_audio_codec_cap_meta_set_pref_context(struct bt_audio_codec_cap *codec_cap, enum bt_audio_context ctx)
Set the preferred context of a codec capability metadata.
int bt_audio_codec_cap_meta_set_lang(struct bt_audio_codec_cap *codec_cap, const uint8_t lang[3])
Set the language of a codec capability metadata.
int bt_audio_codec_cap_meta_get_audio_active_state(const struct bt_audio_codec_cap *codec_cap)
Extract audio active state.
int bt_audio_codec_cap_meta_get_stream_context(const struct bt_audio_codec_cap *codec_cap)
Extract stream contexts.
int bt_audio_codec_cap_meta_set_bcast_audio_immediate_rend_flag(struct bt_audio_codec_cap *codec_cap)
Set the broadcast audio immediate rendering flag of a codec capability metadata.
int bt_audio_codec_cap_get_freq(const struct bt_audio_codec_cap *codec_cap)
Extract the frequency from a codec capability.
int bt_audio_codec_cap_get_octets_per_frame(const struct bt_audio_codec_cap *codec_cap, struct bt_audio_codec_octets_per_codec_frame *codec_frame)
Extract the supported octets per codec frame from a codec capability.
int bt_audio_codec_cap_meta_get_pref_context(const struct bt_audio_codec_cap *codec_cap)
Extract preferred contexts.
int bt_audio_codec_cap_meta_get_parental_rating(const struct bt_audio_codec_cap *codec_cap)
Extract parental rating.
int bt_audio_codec_cap_meta_get_bcast_audio_immediate_rend_flag(const struct bt_audio_codec_cap *codec_cap)
Extract broadcast audio immediate rendering flag.
int bt_audio_codec_cap_meta_get_vendor(const struct bt_audio_codec_cap *codec_cap, const uint8_t **vendor_meta)
Extract vendor specific metadata.
int bt_audio_codec_cap_unset_val(struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_type type)
Unset a specific codec capability value.
int bt_audio_codec_cap_meta_set_extended(struct bt_audio_codec_cap *codec_cap, const uint8_t *extended_meta, size_t extended_meta_len)
Set the extended metadata of a codec capability metadata.
int bt_audio_codec_cap_set_freq(struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_freq freq)
Set the supported frequencies of a codec capability.
int bt_audio_codec_cap_set_octets_per_frame(struct bt_audio_codec_cap *codec_cap, const struct bt_audio_codec_octets_per_codec_frame *codec_frame)
Set the octets per codec frame of a codec capability.
int bt_audio_codec_cap_get_val(const struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_type type, const uint8_t **data)
Lookup a specific value based on type.
int bt_audio_codec_cap_meta_set_audio_active_state(struct bt_audio_codec_cap *codec_cap, enum bt_audio_active_state state)
Set the audio active state of a codec capability metadata.
int bt_audio_codec_cap_meta_get_program_info_uri(const struct bt_audio_codec_cap *codec_cap, const uint8_t **program_info_uri)
Extract program info URI.
int bt_audio_codec_cap_set_supported_audio_chan_counts(struct bt_audio_codec_cap *codec_cap, enum bt_audio_codec_cap_chan_count chan_count)
Set the channel count of a codec capability.
int bt_audio_codec_cap_meta_get_lang(const struct bt_audio_codec_cap *codec_cap, const uint8_t **lang)
Extract language.
int bt_audio_codec_cap_meta_set_program_info_uri(struct bt_audio_codec_cap *codec_cap, const uint8_t *program_info_uri, size_t program_info_uri_len)
Set the program info URI of a codec capability metadata.
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_frame_dur_us_to_frame_dur(uint32_t frame_dur_us)
Convert frame duration in microseconds to assigned numbers frame duration.
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_extended(const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **extended_meta)
Extract extended metadata.
int bt_audio_codec_cfg_frame_dur_to_frame_dur_us(enum bt_audio_codec_cfg_frame_dur frame_dur)
Convert assigned numbers frame duration to duration in microseconds.
int bt_audio_codec_cfg_meta_get_assisted_listening_stream(const struct bt_audio_codec_cfg *codec_cfg)
Extract assisted listening stream.
int bt_audio_codec_cfg_meta_set_program_info(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *program_info, size_t program_info_len)
Set the program info of a codec configuration metadata.
int bt_audio_codec_cfg_get_frame_dur(const struct bt_audio_codec_cfg *codec_cfg)
Extract frame duration from BT codec config.
int bt_audio_codec_cfg_freq_to_freq_hz(enum bt_audio_codec_cfg_freq freq)
Convert assigned numbers frequency to frequency value.
int bt_audio_codec_cfg_meta_set_val(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_metadata_type type, const uint8_t *data, size_t data_len)
Set or add a specific codec configuration metadata value.
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.
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_set_broadcast_name(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *broadcast_name, size_t broadcast_name_len)
Set the broadcast name of a codec configuration metadata.
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_meta_set_lang(struct bt_audio_codec_cfg *codec_cfg, const uint8_t lang[3])
Set the language of a codec configuration metadata.
int bt_audio_codec_cfg_meta_get_lang(const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **lang)
Extract language.
int bt_audio_codec_cfg_meta_set_ccid_list(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *ccid_list, size_t ccid_list_len)
Set the CCID list of a codec configuration metadata.
int bt_audio_codec_cfg_meta_set_stream_context(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_context ctx)
Set the stream context of a codec configuration metadata.
int bt_audio_codec_cfg_meta_get_broadcast_name(const struct bt_audio_codec_cfg *codec_cfg, const uint8_t **broadcast_name)
Extract broadcast name.
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_set_assisted_listening_stream(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_assisted_listening_stream val)
Set the assisted listening stream value of a codec configuration metadata.
int bt_audio_codec_cfg_meta_set_vendor(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *vendor_meta, size_t vendor_meta_len)
Set the vendor specific metadata of a codec configuration metadata.
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_get_val(const struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_cfg_type type, const uint8_t **data)
Lookup a specific codec configuration value.
int bt_audio_codec_cfg_set_frame_dur(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_cfg_frame_dur frame_dur)
Set the frame duration of a codec configuration.
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_meta_set_program_info_uri(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *program_info_uri, size_t program_info_uri_len)
Set the program info URI of a codec configuration metadata.
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_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_set_val(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_cfg_type type, const uint8_t *data, size_t data_len)
Set or add a specific codec configuration value.
int bt_audio_codec_cfg_meta_set_pref_context(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_context ctx)
Set the preferred context of a codec configuration metadata.
int bt_audio_codec_cfg_meta_unset_val(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_metadata_type type)
Unset a specific codec configuration metadata value.
int bt_audio_codec_cfg_meta_set_parental_rating(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_parental_rating parental_rating)
Set the parental rating of a codec configuration metadata.
int bt_audio_codec_cfg_set_freq(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_cfg_freq freq)
Set the frequency of a codec configuration.
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.
int bt_audio_codec_cfg_unset_val(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_codec_cfg_type type)
Unset a specific codec configuration value.
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_get_frame_blocks_per_sdu(const struct bt_audio_codec_cfg *codec_cfg, bool fallback_to_default)
Extract number of audio frame blocks in each SDU from BT codec config.
int bt_audio_codec_cfg_meta_set_extended(struct bt_audio_codec_cfg *codec_cfg, const uint8_t *extended_meta, size_t extended_meta_len)
Set the extended metadata of a codec configuration metadata.
int bt_audio_codec_cfg_get_chan_allocation(const struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_location *chan_allocation, bool fallback_to_default)
Extract channel allocation from BT codec config.
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, bool fallback_to_default)
Extract preferred contexts.
int bt_audio_codec_cfg_meta_set_bcast_audio_immediate_rend_flag(struct bt_audio_codec_cfg *codec_cfg)
Set the broadcast audio immediate rendering flag of a codec configuration metadata.
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_set_audio_active_state(struct bt_audio_codec_cfg *codec_cfg, enum bt_audio_active_state state)
Set the audio active state of a codec configuration metadata.
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.
static char * bt_audio_active_state_to_str(enum bt_audio_active_state state)
Returns a string representation of a bt_audio_active_state value.
Definition audio.h:2186
static char * bt_audio_context_bit_to_str(enum bt_audio_context context)
Returns a string representation of a specific bt_audio_context bit.
Definition audio.h:2098
static char * bt_audio_parental_rating_to_str(enum bt_audio_parental_rating parental_rating)
Returns a string representation of a bt_audio_parental_rating value.
Definition audio.h:2139
static char * bt_audio_codec_cap_frame_dur_bit_to_str(enum bt_audio_codec_cap_frame_dur frame_dur)
Returns a string representation of a specific bt_audio_codec_cap_frame_dur bit.
Definition audio.h:2251
static char * bt_audio_codec_cap_chan_count_bit_to_str(enum bt_audio_codec_cap_chan_count chan_count)
Returns a string representation of a specific bt_audio_codec_cap_chan_count bit.
Definition audio.h:2277
static char * bt_audio_location_bit_to_str(enum bt_audio_location location)
Returns a string representation of a specific bt_audio_location bit.
Definition audio.h:2310
static char * bt_audio_codec_cap_freq_bit_to_str(enum bt_audio_codec_cap_freq freq)
Returns a string representation of a specific bt_audio_codec_cap_freq bit.
Definition audio.h:2207
bt_audio_active_state
Audio Active State defined by the Generic Audio assigned numbers (bluetooth.com).
Definition audio.h:414
bt_audio_assisted_listening_stream
Assisted Listening Stream defined by the Generic Audio assigned numbers (bluetooth....
Definition audio.h:422
bt_audio_dir
Audio direction from the perspective of the BAP Unicast Server / BAP Broadcast Sink.
Definition audio.h:796
bt_audio_location
Location values for BT Audio.
Definition audio.h:590
bt_audio_parental_rating
Parental rating defined by the Generic Audio assigned numbers (bluetooth.com).
Definition audio.h:378
bt_audio_codec_cfg_frame_dur
Codec configuration frame duration.
Definition audio.h:290
uint8_t bt_audio_get_chan_count(enum bt_audio_location chan_allocation)
Function to get the number of channels from the channel allocation.
bt_audio_codec_cfg_freq
Codec configuration sampling freqency.
Definition audio.h:248
bt_audio_codec_cfg_type
Codec configuration types.
Definition audio.h:230
bt_audio_codec_cap_freq
Supported frequencies bitfield.
Definition audio.h:84
bt_audio_metadata_type
Codec metadata type IDs.
Definition audio.h:432
#define BT_AUDIO_LANG_SIZE
Size of the stream language value, e.g.
Definition audio.h:58
int bt_audio_data_get_val(const uint8_t ltv_data[], size_t size, uint8_t type, const uint8_t **data)
Get the value of a specific data type in an length-type-value data array.
bt_audio_codec_cap_chan_count
Supported audio capabilities channel count bitfield.
Definition audio.h:165
bt_audio_codec_cap_frame_dur
Supported frame durations bitfield.
Definition audio.h:136
bt_audio_codec_cap_type
Codec capability types.
Definition audio.h:66
bt_audio_context
Audio Context Type for Generic Audio.
Definition audio.h:303
int bt_audio_data_parse(const uint8_t ltv[], size_t size, bool(*func)(struct bt_data *data, void *user_data), void *user_data)
Helper for parsing length-type-value data.
@ BT_AUDIO_ACTIVE_STATE_ENABLED
Audio data is being transmitted.
Definition audio.h:418
@ BT_AUDIO_ACTIVE_STATE_DISABLED
No audio data is being transmitted.
Definition audio.h:416
@ BT_AUDIO_ASSISTED_LISTENING_STREAM_UNSPECIFIED
Unspecified audio enhancement.
Definition audio.h:424
@ BT_AUDIO_DIR_SINK
Audio direction sink.
Definition audio.h:803
@ BT_AUDIO_DIR_SOURCE
Audio direction source.
Definition audio.h:810
@ BT_AUDIO_LOCATION_FRONT_CENTER
Front Center.
Definition audio.h:598
@ BT_AUDIO_LOCATION_TOP_BACK_LEFT
Top Back Left.
Definition audio.h:626
@ BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_2
Low Frequency Effects 2.
Definition audio.h:612
@ BT_AUDIO_LOCATION_TOP_SIDE_RIGHT
Top Side Right.
Definition audio.h:632
@ BT_AUDIO_LOCATION_FRONT_RIGHT
Front Right.
Definition audio.h:596
@ BT_AUDIO_LOCATION_BOTTOM_FRONT_RIGHT
Bottom Front Right.
Definition audio.h:640
@ BT_AUDIO_LOCATION_BACK_RIGHT
Back Right.
Definition audio.h:604
@ BT_AUDIO_LOCATION_TOP_CENTER
Top Center.
Definition audio.h:624
@ BT_AUDIO_LOCATION_LEFT_SURROUND
Left Surround.
Definition audio.h:646
@ BT_AUDIO_LOCATION_TOP_FRONT_RIGHT
Top Front Right.
Definition audio.h:620
@ BT_AUDIO_LOCATION_FRONT_RIGHT_OF_CENTER
Front Right of Center.
Definition audio.h:608
@ BT_AUDIO_LOCATION_FRONT_RIGHT_WIDE
Front Right Wide.
Definition audio.h:644
@ BT_AUDIO_LOCATION_TOP_BACK_RIGHT
Top Back Right.
Definition audio.h:628
@ BT_AUDIO_LOCATION_MONO_AUDIO
Mono Audio (no specified Audio Location)
Definition audio.h:592
@ BT_AUDIO_LOCATION_BACK_LEFT
Back Left.
Definition audio.h:602
@ BT_AUDIO_LOCATION_RIGHT_SURROUND
Right Surround.
Definition audio.h:648
@ BT_AUDIO_LOCATION_SIDE_RIGHT
Side Right.
Definition audio.h:616
@ BT_AUDIO_LOCATION_TOP_FRONT_LEFT
Top Front Left.
Definition audio.h:618
@ BT_AUDIO_LOCATION_SIDE_LEFT
Side Left.
Definition audio.h:614
@ BT_AUDIO_LOCATION_BOTTOM_FRONT_LEFT
Bottom Front Left.
Definition audio.h:638
@ BT_AUDIO_LOCATION_TOP_FRONT_CENTER
Top Front Center.
Definition audio.h:622
@ BT_AUDIO_LOCATION_LOW_FREQ_EFFECTS_1
Low Frequency Effects 1.
Definition audio.h:600
@ BT_AUDIO_LOCATION_FRONT_LEFT
Front Left.
Definition audio.h:594
@ BT_AUDIO_LOCATION_FRONT_LEFT_WIDE
Front Left Wide.
Definition audio.h:642
@ BT_AUDIO_LOCATION_BOTTOM_FRONT_CENTER
Bottom Front Center.
Definition audio.h:636
@ BT_AUDIO_LOCATION_BACK_CENTER
Back Center.
Definition audio.h:610
@ BT_AUDIO_LOCATION_TOP_SIDE_LEFT
Top Side Left.
Definition audio.h:630
@ BT_AUDIO_LOCATION_TOP_BACK_CENTER
Top Back Center.
Definition audio.h:634
@ BT_AUDIO_LOCATION_FRONT_LEFT_OF_CENTER
Front Left of Center.
Definition audio.h:606
@ BT_AUDIO_PARENTAL_RATING_AGE_18_OR_ABOVE
Recommended for listeners of age 18 and above.
Definition audio.h:410
@ BT_AUDIO_PARENTAL_RATING_AGE_15_OR_ABOVE
Recommended for listeners of age 15 and above.
Definition audio.h:404
@ BT_AUDIO_PARENTAL_RATING_AGE_10_OR_ABOVE
Recommended for listeners of age 10 and above.
Definition audio.h:394
@ BT_AUDIO_PARENTAL_RATING_AGE_7_OR_ABOVE
Recommended for listeners of age 7 and above.
Definition audio.h:388
@ BT_AUDIO_PARENTAL_RATING_AGE_16_OR_ABOVE
Recommended for listeners of age 16 and above.
Definition audio.h:406
@ BT_AUDIO_PARENTAL_RATING_AGE_17_OR_ABOVE
Recommended for listeners of age 17 and above.
Definition audio.h:408
@ BT_AUDIO_PARENTAL_RATING_AGE_5_OR_ABOVE
Recommended for listeners of age 5 and above.
Definition audio.h:384
@ BT_AUDIO_PARENTAL_RATING_AGE_8_OR_ABOVE
Recommended for listeners of age 8 and above.
Definition audio.h:390
@ BT_AUDIO_PARENTAL_RATING_AGE_13_OR_ABOVE
Recommended for listeners of age 13 and above.
Definition audio.h:400
@ BT_AUDIO_PARENTAL_RATING_AGE_9_OR_ABOVE
Recommended for listeners of age 9 and above.
Definition audio.h:392
@ BT_AUDIO_PARENTAL_RATING_AGE_11_OR_ABOVE
Recommended for listeners of age 11 and above.
Definition audio.h:396
@ BT_AUDIO_PARENTAL_RATING_AGE_12_OR_ABOVE
Recommended for listeners of age 12 and above.
Definition audio.h:398
@ BT_AUDIO_PARENTAL_RATING_AGE_6_OR_ABOVE
Recommended for listeners of age 6 and above.
Definition audio.h:386
@ BT_AUDIO_PARENTAL_RATING_AGE_ANY
For all ages.
Definition audio.h:382
@ BT_AUDIO_PARENTAL_RATING_NO_RATING
No rating.
Definition audio.h:380
@ BT_AUDIO_PARENTAL_RATING_AGE_14_OR_ABOVE
Recommended for listeners of age 14 and above.
Definition audio.h:402
@ BT_AUDIO_CODEC_CFG_DURATION_10
10 msec Frame Duration configuration
Definition audio.h:295
@ BT_AUDIO_CODEC_CFG_DURATION_7_5
7.5 msec Frame Duration configuration
Definition audio.h:292
@ BT_AUDIO_CODEC_CFG_FREQ_24KHZ
24 Khz codec sampling frequency
Definition audio.h:262
@ BT_AUDIO_CODEC_CFG_FREQ_48KHZ
48 Khz codec sampling frequency
Definition audio.h:271
@ BT_AUDIO_CODEC_CFG_FREQ_32KHZ
32 Khz codec sampling frequency
Definition audio.h:265
@ BT_AUDIO_CODEC_CFG_FREQ_384KHZ
384 Khz codec sampling frequency
Definition audio.h:286
@ BT_AUDIO_CODEC_CFG_FREQ_22KHZ
22.05 Khz codec sampling frequency
Definition audio.h:259
@ BT_AUDIO_CODEC_CFG_FREQ_8KHZ
8 Khz codec sampling frequency
Definition audio.h:250
@ BT_AUDIO_CODEC_CFG_FREQ_96KHZ
96 Khz codec sampling frequency
Definition audio.h:277
@ BT_AUDIO_CODEC_CFG_FREQ_176KHZ
176.4 Khz codec sampling frequency
Definition audio.h:280
@ BT_AUDIO_CODEC_CFG_FREQ_44KHZ
44.1 Khz codec sampling frequency
Definition audio.h:268
@ BT_AUDIO_CODEC_CFG_FREQ_192KHZ
192 Khz codec sampling frequency
Definition audio.h:283
@ BT_AUDIO_CODEC_CFG_FREQ_11KHZ
11.025 Khz codec sampling frequency
Definition audio.h:253
@ BT_AUDIO_CODEC_CFG_FREQ_16KHZ
16 Khz codec sampling frequency
Definition audio.h:256
@ BT_AUDIO_CODEC_CFG_FREQ_88KHZ
88.2 Khz codec sampling frequency
Definition audio.h:274
@ BT_AUDIO_CODEC_CFG_FREQ
Sampling frequency.
Definition audio.h:232
@ BT_AUDIO_CODEC_CFG_FRAME_LEN
Octets per codec frame.
Definition audio.h:241
@ BT_AUDIO_CODEC_CFG_DURATION
Frame duration.
Definition audio.h:235
@ BT_AUDIO_CODEC_CFG_FRAME_BLKS_PER_SDU
Codec frame blocks per SDU.
Definition audio.h:244
@ BT_AUDIO_CODEC_CFG_CHAN_ALLOC
Audio channel allocation.
Definition audio.h:238
@ BT_AUDIO_CODEC_CAP_FREQ_176KHZ
176.4 Khz sampling frequency
Definition audio.h:116
@ BT_AUDIO_CODEC_CAP_FREQ_192KHZ
192 Khz sampling frequency
Definition audio.h:119
@ BT_AUDIO_CODEC_CAP_FREQ_88KHZ
88.2 Khz sampling frequency
Definition audio.h:110
@ BT_AUDIO_CODEC_CAP_FREQ_8KHZ
8 Khz sampling frequency
Definition audio.h:86
@ BT_AUDIO_CODEC_CAP_FREQ_11KHZ
11.025 Khz sampling frequency
Definition audio.h:89
@ BT_AUDIO_CODEC_CAP_FREQ_32KHZ
32 Khz sampling frequency
Definition audio.h:101
@ BT_AUDIO_CODEC_CAP_FREQ_48KHZ
48 Khz sampling frequency
Definition audio.h:107
@ BT_AUDIO_CODEC_CAP_FREQ_24KHZ
24 Khz sampling frequency
Definition audio.h:98
@ BT_AUDIO_CODEC_CAP_FREQ_16KHZ
16 Khz sampling frequency
Definition audio.h:92
@ BT_AUDIO_CODEC_CAP_FREQ_44KHZ
44.1 Khz sampling frequency
Definition audio.h:104
@ BT_AUDIO_CODEC_CAP_FREQ_22KHZ
22.05 Khz sampling frequency
Definition audio.h:95
@ BT_AUDIO_CODEC_CAP_FREQ_ANY
Any frequency capability.
Definition audio.h:125
@ BT_AUDIO_CODEC_CAP_FREQ_384KHZ
384 Khz sampling frequency
Definition audio.h:122
@ BT_AUDIO_CODEC_CAP_FREQ_96KHZ
96 Khz sampling frequency
Definition audio.h:113
@ BT_AUDIO_METADATA_TYPE_PROGRAM_INFO
UTF-8 encoded title or summary of stream content.
Definition audio.h:458
@ BT_AUDIO_METADATA_TYPE_EXTENDED
Extended metadata.
Definition audio.h:502
@ BT_AUDIO_METADATA_TYPE_VENDOR
Vendor specific metadata.
Definition audio.h:505
@ BT_AUDIO_METADATA_TYPE_CCID_LIST
Array of 8-bit CCID values.
Definition audio.h:469
@ BT_AUDIO_METADATA_TYPE_ASSISTED_LISTENING_STREAM
Assisted listening stream.
Definition audio.h:496
@ BT_AUDIO_METADATA_TYPE_BROADCAST_IMMEDIATE
Broadcast Audio Immediate Rendering flag
Definition audio.h:489
@ BT_AUDIO_METADATA_TYPE_PROGRAM_INFO_URI
UTF-8 encoded URI for additional Program information.
Definition audio.h:479
@ BT_AUDIO_METADATA_TYPE_PARENTAL_RATING
Parental rating.
Definition audio.h:476
@ BT_AUDIO_METADATA_TYPE_STREAM_CONTEXT
Streaming audio context.
Definition audio.h:455
@ BT_AUDIO_METADATA_TYPE_PREF_CONTEXT
Preferred audio context.
Definition audio.h:443
@ BT_AUDIO_METADATA_TYPE_BROADCAST_NAME
UTF-8 encoded Broadcast name.
Definition audio.h:499
@ BT_AUDIO_METADATA_TYPE_AUDIO_STATE
Audio active state.
Definition audio.h:486
@ BT_AUDIO_METADATA_TYPE_LANG
Language.
Definition audio.h:466
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_4
Supporting 4 channel.
Definition audio.h:176
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_2
Supporting 2 channel.
Definition audio.h:170
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_1
Supporting 1 channel.
Definition audio.h:167
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_3
Supporting 3 channel.
Definition audio.h:173
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_8
Supporting 8 channel.
Definition audio.h:188
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_7
Supporting 7 channel.
Definition audio.h:185
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_ANY
Supporting all channels.
Definition audio.h:191
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_5
Supporting 5 channel.
Definition audio.h:179
@ BT_AUDIO_CODEC_CAP_CHAN_COUNT_6
Supporting 6 channel.
Definition audio.h:182
@ BT_AUDIO_CODEC_CAP_DURATION_7_5
7.5 msec frame duration capability
Definition audio.h:138
@ BT_AUDIO_CODEC_CAP_DURATION_PREFER_7_5
7.5 msec preferred frame duration capability.
Definition audio.h:153
@ BT_AUDIO_CODEC_CAP_DURATION_ANY
Any frame duration capability.
Definition audio.h:144
@ BT_AUDIO_CODEC_CAP_DURATION_PREFER_10
10 msec preferred frame duration capability
Definition audio.h:161
@ BT_AUDIO_CODEC_CAP_DURATION_10
10 msec frame duration capability
Definition audio.h:141
@ BT_AUDIO_CODEC_CAP_TYPE_CHAN_COUNT
Supported audio channel counts.
Definition audio.h:74
@ BT_AUDIO_CODEC_CAP_TYPE_DURATION
Supported frame durations.
Definition audio.h:71
@ BT_AUDIO_CODEC_CAP_TYPE_FRAME_COUNT
Supported maximum codec frames per SDU
Definition audio.h:80
@ BT_AUDIO_CODEC_CAP_TYPE_FRAME_LEN
Supported octets per codec frame.
Definition audio.h:77
@ BT_AUDIO_CODEC_CAP_TYPE_FREQ
Supported sampling frequencies.
Definition audio.h:68
@ BT_AUDIO_CONTEXT_TYPE_NOTIFICATIONS
Notification and reminder sounds; attention-seeking audio, for example, in beeps signaling the arriva...
Definition audio.h:341
@ BT_AUDIO_CONTEXT_TYPE_EMERGENCY_ALARM
Emergency alarm Emergency sounds, for example, fire alarms or other urgent alerts.
Definition audio.h:353
@ BT_AUDIO_CONTEXT_TYPE_INSTRUCTIONAL
Instructional audio, for example, in navigation, announcements, or user guidance.
Definition audio.h:324
@ BT_AUDIO_CONTEXT_TYPE_PROHIBITED
Prohibited.
Definition audio.h:305
@ BT_AUDIO_CONTEXT_TYPE_RINGTONE
Alerts the user to an incoming call, for example, an incoming telephony or video call,...
Definition audio.h:346
@ BT_AUDIO_CONTEXT_TYPE_LIVE
Live audio, for example, from a microphone where audio is perceived both through a direct acoustic pa...
Definition audio.h:331
@ BT_AUDIO_CONTEXT_TYPE_MEDIA
Media, for example, music playback, radio, podcast or movie soundtrack, or tv audio.
Definition audio.h:317
@ BT_AUDIO_CONTEXT_TYPE_GAME
Audio associated with video gaming, for example gaming media; gaming effects; music and in-game voice...
Definition audio.h:322
@ BT_AUDIO_CONTEXT_TYPE_SOUND_EFFECTS
Sound effects including keyboard and touch feedback; menu and user interface sounds; and other system...
Definition audio.h:336
@ BT_AUDIO_CONTEXT_TYPE_VOICE_ASSISTANTS
Man-machine communication, for example, with voice recognition or virtual assistants.
Definition audio.h:326
@ BT_AUDIO_CONTEXT_TYPE_CONVERSATIONAL
Conversation between humans, for example, in telephony or video calls, including traditional cellular...
Definition audio.h:315
@ BT_AUDIO_CONTEXT_TYPE_ALERTS
Alarms and timers; immediate alerts, for example, in a critical battery alarm, timer expiry or alarm ...
Definition audio.h:351
@ BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED
Identifies audio where the use case context does not match any other defined value,...
Definition audio.h:310
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
Bluetooth ISO handling.
Bluetooth LC3 codec handling.
state
Definition parser_state.h:29
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Codec capability structure.
Definition audio.h:684
uint16_t vid
Codec Company Vendor ID.
Definition audio.h:702
uint8_t data[CONFIG_BT_AUDIO_CODEC_CAP_MAX_DATA_SIZE]
Codec Specific Capabilities Data.
Definition audio.h:707
uint16_t cid
Codec Company ID.
Definition audio.h:700
uint8_t path_id
Data path ID.
Definition audio.h:690
bool ctlr_transcode
Whether or not the local controller should transcode.
Definition audio.h:696
uint8_t meta[CONFIG_BT_AUDIO_CODEC_CAP_MAX_METADATA_SIZE]
Codec Specific Capabilities Metadata.
Definition audio.h:713
size_t data_len
Codec Specific Capabilities Data count.
Definition audio.h:705
uint8_t id
Codec ID.
Definition audio.h:698
size_t meta_len
Codec Specific Capabilities Metadata count.
Definition audio.h:711
Codec specific configuration structure.
Definition audio.h:718
size_t meta_len
Codec Specific Capabilities Metadata count.
Definition audio.h:745
uint16_t vid
Codec Company Vendor ID.
Definition audio.h:736
uint8_t meta[CONFIG_BT_AUDIO_CODEC_CFG_MAX_METADATA_SIZE]
Codec Specific Capabilities Metadata.
Definition audio.h:747
uint16_t cid
Codec Company ID.
Definition audio.h:734
size_t data_len
Codec Specific Capabilities Data count.
Definition audio.h:739
uint8_t path_id
Data path ID.
Definition audio.h:724
bool ctlr_transcode
Whether or not the local controller should transcode.
Definition audio.h:730
uint8_t id
Codec ID.
Definition audio.h:732
uint8_t data[CONFIG_BT_AUDIO_CODEC_CFG_MAX_DATA_SIZE]
Codec Specific Capabilities Data.
Definition audio.h:741
struct to hold minimum and maximum supported codec frame sizes
Definition audio.h:217
uint16_t min
Minimum number of octets supported per codec frame.
Definition audio.h:219
uint16_t max
Maximum number of octets supported per codec frame.
Definition audio.h:221
Bluetooth data.
Definition bluetooth.h:456
Misc utilities.
Macro utilities.