| /* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| */ |
| |
| #ifndef H_BLE_AUDIO_COMMON_ |
| #define H_BLE_AUDIO_COMMON_ |
| |
| /** |
| * @file ble_audio_common.h |
| * |
| * @brief Bluetooth Low Energy Audio Common API |
| * |
| * @defgroup bt_le_audio_common Bluetooth LE Audio Common |
| * @ingroup bt_host |
| * @{ |
| */ |
| |
| #include "stdint.h" |
| #include "os/queue.h" |
| |
| /** |
| * @cond |
| * Helper macros for BLE_AUDIO_BUILD_CODEC_CONFIG |
| * @{ |
| */ |
| #define FIELD_LEN_2(_len, _type, _field) _len, _type, _field, |
| #define FIELD_LEN_5(_len, _type, _field) _len, _type, _field, \ |
| _field >> 8, _field >> 16, \ |
| _field >> 24, |
| |
| #define FIELD_TESTED_0(_len, _type, _field) |
| #define FIELD_TESTED_1(_len, _type, _field) FIELD_LEN_ ## _len(_len, \ |
| _type, \ |
| _field) |
| #define EMPTY() FIELD_TESTED_0 |
| #define PRESENT(X) FIELD_TESTED_1 |
| #define TEST(x, A, FUNC, ...) FUNC |
| #define TEST_FIELD(...) TEST(, ## __VA_ARGS__, \ |
| PRESENT(__VA_ARGS__), \ |
| EMPTY(__VA_ARGS__)) |
| #define FIELD_TESTED(_test, _len, _type, _field) _test(_len, _type, _field) |
| #define OPTIONAL_FIELD(_len, _type, ...) FIELD_TESTED(TEST_FIELD \ |
| (__VA_ARGS__), \ |
| _len, \ |
| _type, \ |
| __VA_ARGS__) |
| |
| /** |
| * @} |
| * @endcond |
| */ |
| |
| /** Broadcast Audio Announcement Service UUID. */ |
| #define BLE_BROADCAST_AUDIO_ANNOUNCEMENT_SVC_UUID 0x1852 |
| |
| /** Public Broadcast Announcement Service UUID. */ |
| #define BLE_BROADCAST_PUB_ANNOUNCEMENT_SVC_UUID 0x1856 |
| |
| /** |
| * @defgroup ble_audio_sampling_rates Bluetooth Low Energy Audio Sampling Rates |
| * @{ |
| */ |
| |
| /** LE Audio Sampling Rate: 8000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_8000_HZ 0x01 |
| |
| /** LE Audio Sampling Rate: 11025 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_11025_HZ 0x02 |
| |
| /** LE Audio Sampling Rate: 16000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_16000_HZ 0x03 |
| |
| /** LE Audio Sampling Rate: 22050 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_22050_HZ 0x04 |
| |
| /** LE Audio Sampling Rate: 24000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_24000_HZ 0x05 |
| |
| /** LE Audio Sampling Rate: 32000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_32000_HZ 0x06 |
| |
| /** LE Audio Sampling Rate: 44100 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_44100_HZ 0x07 |
| |
| /** LE Audio Sampling Rate: 48000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_48000_HZ 0x08 |
| |
| /** LE Audio Sampling Rate: 88200 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_88200_HZ 0x09 |
| |
| /** LE Audio Sampling Rate: 96000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_96000_HZ 0x0A |
| |
| /** LE Audio Sampling Rate: 176400 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_176400_HZ 0x0B |
| |
| /** LE Audio Sampling Rate: 192000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_192000_HZ 0x0C |
| |
| /** LE Audio Sampling Rate: 384000 Hz. */ |
| #define BLE_AUDIO_SAMPLING_RATE_384000_HZ 0x0D |
| |
| /** @} */ |
| |
| /** |
| * @defgroup ble_audio_frame_durations Bluetooth Low Energy Audio Frame Durations |
| * @{ |
| */ |
| |
| /** LE Audio Frame Duration: 7.5 ms. */ |
| #define BLE_AUDIO_SELECTED_FRAME_DURATION_7_5_MS 0x00 |
| |
| /** LE Audio Frame Duration: 10 ms. */ |
| #define BLE_AUDIO_SELECTED_FRAME_DURATION_10_MS 0x01 |
| |
| /** @} */ |
| |
| /** |
| * @defgroup ble_audio_locations Bluetooth Low Energy Audio Locations |
| * @{ |
| */ |
| |
| /** LE Audio Location: Front Left. */ |
| #define BLE_AUDIO_LOCATION_FRONT_LEFT (1ULL) |
| |
| /** LE Audio Location: Front Right. */ |
| #define BLE_AUDIO_LOCATION_FRONT_RIGHT (1ULL << 1) |
| |
| /** LE Audio Location: Front Center. */ |
| #define BLE_AUDIO_LOCATION_FRONT_CENTER (1ULL << 2) |
| |
| /** LE Audio Location: Low Frequency Effects 1. */ |
| #define BLE_AUDIO_LOCATION_LOW_FREQ_EFFECTS_1 (1ULL << 3) |
| |
| /** LE Audio Location: Back Left. */ |
| #define BLE_AUDIO_LOCATION_BACK_LEFT (1ULL << 4) |
| |
| /** LE Audio Location: Front Left Center. */ |
| #define BLE_AUDIO_LOCATION_FRONT_LEFT_CENTER (1ULL << 5) |
| |
| /** LE Audio Location: Front Right Center. */ |
| #define BLE_AUDIO_LOCATION_FRONT_RIGHT_CENTER (1ULL << 6) |
| |
| /** LE Audio Location: Back Center. */ |
| #define BLE_AUDIO_LOCATION_BACK_CENTER (1ULL << 7) |
| |
| /** LE Audio Location: Low Frequency Effects 2. */ |
| #define BLE_AUDIO_LOCATION_LOW_FREQ_EFFECTS_2 (1ULL << 8) |
| |
| /** LE Audio Location: Side Left. */ |
| #define BLE_AUDIO_LOCATION_SIDE_LEFT (1ULL << 9) |
| |
| /** LE Audio Location: Side Right. */ |
| #define BLE_AUDIO_LOCATION_SIDE_RIGHT (1ULL << 10) |
| |
| /** LE Audio Location: Top Front Left. */ |
| #define BLE_AUDIO_LOCATION_TOP_FRONT_LEFT (1ULL << 11) |
| |
| /** LE Audio Location: Top Front Right. */ |
| #define BLE_AUDIO_LOCATION_TOP_FRONT_RIGHT (1ULL << 12) |
| |
| /** LE Audio Location: Top Front Center. */ |
| #define BLE_AUDIO_LOCATION_TOP_FRONT_CENTER (1ULL << 13) |
| |
| /** LE Audio Location: Top Center. */ |
| #define BLE_AUDIO_LOCATION_TOP_CENTER (1ULL << 14) |
| |
| /** LE Audio Location: Top Back Left. */ |
| #define BLE_AUDIO_LOCATION_TOP_BACK_LEFT (1ULL << 15) |
| |
| /** LE Audio Location: Top Back Right. */ |
| #define BLE_AUDIO_LOCATION_TOP_BACK_RIGHT (1ULL << 16) |
| |
| /** LE Audio Location: Top Side Left. */ |
| #define BLE_AUDIO_LOCATION_TOP_SIDE_LEFT (1ULL << 17) |
| |
| /** LE Audio Location: Top Side Right. */ |
| #define BLE_AUDIO_LOCATION_TOP_SIDE_RIGHT (1ULL << 18) |
| |
| /** LE Audio Location: Top Back Center. */ |
| #define BLE_AUDIO_LOCATION_TOP_BACK_CENTER (1ULL << 19) |
| |
| /** LE Audio Location: Bottom Front Center. */ |
| #define BLE_AUDIO_LOCATION_BOTTOM_FRONT_CENTER (1ULL << 20) |
| |
| /** LE Audio Location: Bottom Front Left. */ |
| #define BLE_AUDIO_LOCATION_BOTTOM_FRONT_LEFT (1ULL << 21) |
| |
| /** LE Audio Location: Bottom Front Right. */ |
| #define BLE_AUDIO_LOCATION_BOTTOM_FRONT_RIGHT (1ULL << 22) |
| |
| /** LE Audio Location: Left Surround. */ |
| #define BLE_AUDIO_LOCATION_LEFT_SURROUND (1ULL << 23) |
| |
| /** LE Audio Location: Right Surround. */ |
| #define BLE_AUDIO_LOCATION_RIGHT_SURROUND (1ULL << 24) |
| |
| /** @} */ |
| |
| /** |
| * @defgroup ble_audio_codec_config Bluetooth Low Energy Audio Codec Specific Config |
| * @{ |
| */ |
| |
| /** LE Audio Codec Config Type: Sampling Frequency. */ |
| #define BLE_AUDIO_CODEC_SAMPLING_FREQ_TYPE 0x01 |
| |
| /** LE Audio Codec Config Type: Frame Duration. */ |
| #define BLE_AUDIO_CODEC_FRAME_DURATION_TYPE 0x02 |
| |
| /** LE Audio Codec Config Type: Channel Allocation. */ |
| #define BLE_AUDIO_CODEC_AUDIO_CHANNEL_ALLOCATION_TYPE 0x03 |
| |
| /** LE Audio Codec Config Type: Octets Per Codec Frame. */ |
| #define BLE_AUDIO_CODEC_OCTETS_PER_CODEC_FRAME_TYPE 0x04 |
| |
| /** LE Audio Codec Config Type: Frame Blocks Per SDU. */ |
| #define BLE_AUDIO_CODEC_FRAME_BLOCKS_PER_SDU_TYPE 0x05 |
| |
| /** @} */ |
| |
| /** |
| * @brief Helper macro used to build LTV array of Codec_Specific_Configuration. |
| * |
| * @param _sampling_freq Sampling_Frequency - single octet value |
| * @param _frame_duration Frame_Duration - single octet value |
| * @param _audio_channel_alloc Audio_Channel_Allocation - |
| * four octet value |
| * @param _octets_per_codec_frame Octets_Per_Codec_Frame - |
| * two octet value |
| * @param _codec_frame_blocks_per_sdu Codec_Frame_Blocks_Per_SDU - |
| * single octet value |
| * |
| * @return Pointer to a `ble_uuid16_t` structure. |
| */ |
| #define BLE_AUDIO_BUILD_CODEC_CONFIG(_sampling_freq, \ |
| _frame_duration, \ |
| _audio_channel_alloc, \ |
| _octets_per_codec_frame, \ |
| _codec_frame_blocks_per_sdu) \ |
| { \ |
| 2, BLE_AUDIO_CODEC_SAMPLING_FREQ_TYPE, _sampling_freq, \ |
| 2, BLE_AUDIO_CODEC_FRAME_DURATION_TYPE, _frame_duration, \ |
| OPTIONAL_FIELD(5, BLE_AUDIO_CODEC_AUDIO_CHANNEL_ALLOCATION_TYPE, \ |
| _audio_channel_alloc) \ |
| 3, BLE_AUDIO_CODEC_OCTETS_PER_CODEC_FRAME_TYPE, \ |
| (_octets_per_codec_frame), ((_octets_per_codec_frame) >> 8), \ |
| OPTIONAL_FIELD(2, BLE_AUDIO_CODEC_FRAME_BLOCKS_PER_SDU_TYPE, \ |
| _codec_frame_blocks_per_sdu) \ |
| } |
| |
| /** Codec Information */ |
| struct ble_audio_codec_id { |
| /** Coding Format */ |
| uint8_t format; |
| |
| /** Company ID */ |
| uint16_t company_id; |
| |
| /** Vendor Specific Codec ID */ |
| uint16_t vendor_specific; |
| }; |
| |
| /** Broadcast Isochronous Streams (BIS) */ |
| struct ble_audio_bis { |
| /** Pointer to next BIS in subgroup */ |
| STAILQ_ENTRY(ble_audio_bis) next; |
| |
| /** BIS index */ |
| uint8_t idx; |
| |
| /** BIS level Codec Specific Configuration length */ |
| uint8_t codec_spec_config_len; |
| |
| /** BIS level Codec Specific Configuration */ |
| uint8_t *codec_spec_config; |
| }; |
| |
| /** Broadcast Isochronous Group (BIG) Subgroup */ |
| struct ble_audio_big_subgroup { |
| /** Pointer to next subgroup in BIG */ |
| STAILQ_ENTRY(ble_audio_big_subgroup) next; |
| |
| /** Number of BISes in subgroup */ |
| uint8_t bis_cnt; |
| |
| /** Codec ID */ |
| struct ble_audio_codec_id codec_id; |
| |
| /** Subgroup level Codec Specific Configuration */ |
| uint8_t *codec_spec_config; |
| |
| /** Subgroup level Codec Specific Configuration length */ |
| uint8_t codec_spec_config_len; |
| |
| /** Subgroup Metadata */ |
| uint8_t *metadata; |
| |
| /** Subgroup Metadata length*/ |
| uint8_t metadata_len; |
| |
| /** Link list of BISes */ |
| STAILQ_HEAD(, ble_audio_bis) bises; |
| }; |
| |
| /** Broadcast Audio Source Endpoint */ |
| struct ble_audio_base { |
| /** Broadcast ID */ |
| uint32_t broadcast_id; |
| |
| /** Presentation Delay */ |
| uint32_t presentation_delay; |
| |
| /** Number of subgroups in BIG */ |
| uint8_t num_subgroups; |
| |
| /** Link list of subgroups */ |
| STAILQ_HEAD(, ble_audio_big_subgroup) subs; |
| }; |
| |
| /** |
| * @} |
| */ |
| |
| #endif /* H_BLE_AUDIO_COMMON_ */ |
