1 /* 2 * Copyright 2019 HIMSA II K/S - www.himsa.com. Represented by EHIMA - 3 * www.ehima.com 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 */ 17 18 /* 19 * This file contains the Audio Stream Control (LE_AUDIO) API function external 20 * definitions. 21 */ 22 23 #pragma once 24 25 #include <memory> 26 #include <vector> 27 28 #include "le_audio_types.h" 29 30 namespace bluetooth::le_audio { 31 namespace client_parser { 32 namespace ascs { 33 /* 34 * All structures and defines are described in Audio Stream Control Service 35 * specification 36 */ 37 38 constexpr uint8_t kCtpResponseCodeSuccess = 0x00; 39 constexpr uint8_t kCtpResponseCodeUnsupportedOpcode = 0x01; 40 constexpr uint8_t kCtpResponseCodeInvalidLength = 0x02; 41 constexpr uint8_t kCtpResponseCodeInvalidAseId = 0x03; 42 constexpr uint8_t kCtpResponseCodeInvalidAseStateMachineTransition = 0x04; 43 constexpr uint8_t kCtpResponseCodeInvalidAseDirection = 0x05; 44 constexpr uint8_t kCtpResponseCodeUnsupportedAudioCapabilities = 0x06; 45 constexpr uint8_t kCtpResponseCodeUnsupportedConfigurationParameterValue = 0x07; 46 constexpr uint8_t kCtpResponseCodeRejectedConfigurationParameterValue = 0x08; 47 constexpr uint8_t kCtpResponseCodeInvalidConfigurationParameterValue = 0x09; 48 constexpr uint8_t kCtpResponseCodeUnsupportedMetadata = 0x0A; 49 constexpr uint8_t kCtpResponseCodeRejectedMetadata = 0x0B; 50 constexpr uint8_t kCtpResponseCodeInvalidMetadata = 0x0C; 51 constexpr uint8_t kCtpResponseCodeInsufficientResources = 0x0D; 52 constexpr uint8_t kCtpResponseCodeUnspecifiedError = 0x0E; 53 54 constexpr uint8_t kCtpResponseNoReason = 0x00; 55 constexpr uint8_t kCtpResponseCodecId = 0x01; 56 constexpr uint8_t kCtpResponseCodecSpecificConfiguration = 0x02; 57 constexpr uint8_t kCtpResponseSduInterval = 0x03; 58 constexpr uint8_t kCtpResponseFraming = 0x04; 59 constexpr uint8_t kCtpResponsePhy = 0x05; 60 constexpr uint8_t kCtpResponseMaximumSduSize = 0x06; 61 constexpr uint8_t kCtpResponseRetransmissionNumber = 0x07; 62 constexpr uint8_t kCtpResponseMaxTransportLatency = 0x08; 63 constexpr uint8_t kCtpResponsePresentationDelay = 0x09; 64 constexpr uint8_t kCtpResponseInvalidAseCisMapping = 0x0A; 65 66 constexpr uint8_t kCtpMetadataResponsePreferredAudioContexts = 0x01; 67 constexpr uint8_t kCtpMetadataResponseStreamingAudioContexts = 0x02; 68 constexpr uint8_t kCtpMetadataResponseProgramInfo = 0x03; 69 constexpr uint8_t kCtpMetadataResponseLanguage = 0x04; 70 constexpr uint8_t kCtpMetadataResponseCcidList = 0x05; 71 constexpr uint8_t kCtpMetadataResponseParentalRating = 0x06; 72 constexpr uint8_t kCtpMetadataResponseProgramInfoUri = 0x07; 73 constexpr uint8_t kCtpMetadataResponseExtendedMetadata = 0xFE; 74 constexpr uint8_t kCtpMetadataResponseVendorSpecific = 0xFF; 75 76 constexpr uint8_t kLeAudioErrorCtpUnsupporterdOpcode = 0xFF; 77 constexpr uint8_t kLeAudioErrorCtpTruncatedOperation = 0xFE; 78 constexpr uint8_t kLeAudioErrorCtpCtpErr = 0xFD; 79 80 /* ASE states */ 81 constexpr uint8_t kAseStateIdle = 0x00; 82 constexpr uint8_t kAseStateCodecConfigured = 0x01; 83 constexpr uint8_t kAseStateQosConfigured = 0x02; 84 constexpr uint8_t kAseStateEnabling = 0x03; 85 constexpr uint8_t kAseStateStreaming = 0x04; 86 constexpr uint8_t kAseStateDisabling = 0x05; 87 constexpr uint8_t kAseStateReleasing = 0x06; 88 89 /* Control point opcodes */ 90 constexpr uint8_t kCtpOpcodeCodecConfiguration = 0x01; 91 constexpr uint8_t kCtpOpcodeQosConfiguration = 0x02; 92 constexpr uint8_t kCtpOpcodeEnable = 0x03; 93 constexpr uint8_t kCtpOpcodeReceiverStartReady = 0x04; 94 constexpr uint8_t kCtpOpcodeDisable = 0x05; 95 constexpr uint8_t kCtpOpcodeReceiverStopReady = 0x06; 96 constexpr uint8_t kCtpOpcodeUpdateMetadata = 0x07; 97 constexpr uint8_t kCtpOpcodeRelease = 0x08; 98 99 /* ASE status masks */ 100 static constexpr uint32_t kAseRspHeaderMaskCtrlStatusFailureOpcode = 0x00FF0000; 101 static constexpr uint32_t kAseRspHeaderMaskCtrlStatusErrorCode = 0x0000FF00; 102 static constexpr uint32_t kAseRspHeaderMaskCtrlStatusErrorReason = 0x000000FF; 103 104 constexpr uint16_t kAseStatusCodecConfMinLen = 23; 105 struct ase_codec_configured_state_params { 106 uint8_t framing; 107 uint8_t preferred_phy; 108 uint8_t preferred_retrans_nb; 109 uint16_t max_transport_latency; 110 uint32_t pres_delay_min; 111 uint32_t pres_delay_max; 112 uint32_t preferred_pres_delay_min; 113 uint32_t preferred_pres_delay_max; 114 types::LeAudioCodecId codec_id; 115 std::vector<uint8_t> codec_spec_conf; 116 }; 117 118 constexpr uint16_t kAseStatusCodecQosConfMinLen = 15; 119 struct ase_qos_configured_state_params { 120 uint8_t cig_id; 121 uint8_t cis_id; 122 uint32_t sdu_interval; 123 uint8_t framing; 124 uint8_t phy; 125 uint16_t max_sdu; 126 uint8_t retrans_nb; 127 uint16_t max_transport_latency; 128 uint32_t pres_delay; 129 }; 130 131 constexpr uint16_t kAseStatusTransMinLen = 3; 132 struct ase_transient_state_params { 133 uint8_t cig_id; 134 uint8_t cis_id; 135 std::vector<uint8_t> metadata; 136 }; 137 138 constexpr uint16_t kCtpAseEntryMinLen = 3; 139 struct ctp_ase_entry { 140 uint8_t ase_id; 141 uint8_t response_code; 142 uint8_t reason; 143 }; 144 145 constexpr uint16_t kCtpNtfMinLen = 2; 146 struct ctp_ntf { 147 uint8_t op; 148 std::vector<struct ctp_ase_entry> entries; 149 }; 150 151 constexpr uint16_t kAseRspHdrMinLen = 2; 152 struct ase_rsp_hdr { 153 uint8_t id; 154 uint8_t state; 155 }; 156 157 constexpr uint8_t kCtpOpSize = 1; 158 constexpr uint8_t kAseNumSize = 1; 159 constexpr uint8_t kAseIdSize = 1; 160 161 constexpr uint16_t kCtpCodecConfMinLen = 9; 162 struct ctp_codec_conf { 163 uint8_t ase_id; 164 uint8_t target_latency; 165 uint8_t target_phy; 166 types::LeAudioCodecId codec_id; 167 std::vector<uint8_t> codec_config; 168 }; 169 170 constexpr uint16_t kCtpQosConfMinLen = 16; 171 struct ctp_qos_conf { 172 uint8_t ase_id; 173 uint8_t cig; 174 uint8_t cis; 175 uint32_t sdu_interval; 176 uint8_t framing; 177 uint8_t phy; 178 uint16_t max_sdu; 179 uint8_t retrans_nb; 180 uint16_t max_transport_latency; 181 uint32_t pres_delay; 182 }; 183 184 constexpr uint16_t kCtpEnableMinLen = 2; 185 struct ctp_enable { 186 uint8_t ase_id; 187 std::vector<uint8_t> metadata; 188 }; 189 190 constexpr uint16_t kCtpUpdateMetadataMinLen = 2; 191 struct ctp_update_metadata { 192 uint8_t ase_id; 193 std::vector<uint8_t> metadata; 194 }; 195 196 /* Device control and common functions */ 197 bool ParseAseStatusHeader(ase_rsp_hdr& rsp, uint16_t len, const uint8_t* value); 198 bool ParseAseStatusCodecConfiguredStateParams(struct ase_codec_configured_state_params& rsp, 199 uint16_t len, const uint8_t* value); 200 bool ParseAseStatusQosConfiguredStateParams(struct ase_qos_configured_state_params& rsp, 201 uint16_t len, const uint8_t* value); 202 bool ParseAseStatusTransientStateParams(struct ase_transient_state_params& rsp, uint16_t len, 203 const uint8_t* value); 204 bool ParseAseCtpNotification(struct ctp_ntf& ntf, uint16_t len, const uint8_t* value); 205 bool PrepareAseCtpCodecConfig(const std::vector<struct ctp_codec_conf>& confs, 206 std::vector<uint8_t>& value); 207 bool PrepareAseCtpConfigQos(const std::vector<struct ctp_qos_conf>& confs, 208 std::vector<uint8_t>& value); 209 bool PrepareAseCtpEnable(const std::vector<struct ctp_enable>& confs, std::vector<uint8_t>& value); 210 bool PrepareAseCtpAudioReceiverStartReady(const std::vector<uint8_t>& ids, 211 std::vector<uint8_t>& value); 212 bool PrepareAseCtpDisable(const std::vector<uint8_t>& ids, std::vector<uint8_t>& value); 213 bool PrepareAseCtpAudioReceiverStopReady(const std::vector<uint8_t>& ids, 214 std::vector<uint8_t>& value); 215 bool PrepareAseCtpUpdateMetadata(const std::vector<struct ctp_update_metadata>& confs, 216 std::vector<uint8_t>& value); 217 bool PrepareAseCtpRelease(const std::vector<uint8_t>& ids, std::vector<uint8_t>& value); 218 } // namespace ascs 219 220 namespace pacs { 221 222 constexpr uint16_t kAcsPacRecordMinLen = 7; 223 constexpr uint8_t kAcsPacMetadataLenLen = 1; 224 constexpr uint16_t kAcsPacDiscoverRspMinLen = 1; 225 226 constexpr uint16_t kAudioLocationsRspMinLen = 4; 227 228 constexpr uint16_t kAseAudioAvailRspMinLen = 4; 229 230 constexpr uint16_t kAseAudioSuppContRspMinLen = 4; 231 232 int ParseSinglePac(std::vector<struct types::acs_ac_record>& pac_recs, uint16_t len, 233 const uint8_t* value); 234 bool ParsePacs(std::vector<struct types::acs_ac_record>& pac_recs, uint16_t len, 235 const uint8_t* value); 236 bool ParseAudioLocations(types::AudioLocations& audio_locations, uint16_t len, 237 const uint8_t* value); 238 bool ParseAvailableAudioContexts(types::BidirectionalPair<types::AudioContexts>& rsp, uint16_t len, 239 const uint8_t* value); 240 bool ParseSupportedAudioContexts(types::BidirectionalPair<types::AudioContexts>& rsp, uint16_t len, 241 const uint8_t* value); 242 } // namespace pacs 243 244 namespace tmap { 245 246 constexpr uint16_t kTmapRoleLen = 2; 247 248 bool ParseTmapRole(std::bitset<16>& role, uint16_t len, const uint8_t* value); 249 250 } // namespace tmap 251 } // namespace client_parser 252 } // namespace bluetooth::le_audio 253