1 /****************************************************************************** 2 * 3 * Copyright (C) 2000-2012 Broadcom Corporation 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 /****************************************************************************** 20 * 21 * nterface to A2DP Application Programming Interface 22 * 23 ******************************************************************************/ 24 #ifndef A2D_API_H 25 #define A2D_API_H 26 #include "common/bt_defs.h" 27 #include "stack/sdp_api.h" 28 #if (A2D_INCLUDED == TRUE) 29 /***************************************************************************** 30 ** constants 31 *****************************************************************************/ 32 #define A2D_VERSION 0x0102 33 #define A2D_VERSION_1_3 0x0103 34 #define A2D_VERSION_1_4 0x0104 35 36 /* Profile supported features */ 37 #define A2D_SUPF_PLAYER 0x0001 38 #define A2D_SUPF_MIC 0x0002 39 #define A2D_SUPF_TUNER 0x0004 40 #define A2D_SUPF_MIXER 0x0008 41 42 #define A2D_SUPF_HEADPHONE 0x0001 43 #define A2D_SUPF_SPEAKER 0x0002 44 #define A2D_SUPF_RECORDER 0x0004 45 #define A2D_SUPF_AMP 0x0008 46 47 /* AV Media Types */ 48 #define A2D_MEDIA_TYPE_AUDIO 0x00 /* audio media type + RFA */ 49 #define A2D_MEDIA_TYPE_VIDEO 0x10 /* video media type + RFA */ 50 #define A2D_MEDIA_TYPE_MULTI 0x20 /* multimedia media type + RFA */ 51 52 /* AV Media Codec Type (Audio Codec ID) */ 53 #define A2D_MEDIA_CT_SBC 0x00 /* SBC media codec type */ 54 #define A2D_MEDIA_CT_M12 0x01 /* MPEG-1, 2 Audio media codec type */ 55 #define A2D_MEDIA_CT_M24 0x02 /* MPEG-2, 4 AAC media codec type */ 56 #define A2D_MEDIA_CT_ATRAC 0x04 /* ATRAC family media codec type */ 57 58 #define A2D_SUCCESS 0 /* Success */ 59 #define A2D_FAIL 0x0A /* Failed */ 60 #define A2D_BUSY 0x0B /* A2D_FindService is already in progress */ 61 #define A2D_INVALID_PARAMS 0x0C /* bad parameters */ 62 #define A2D_WRONG_CODEC 0x0D /* wrong codec info */ 63 #define A2D_BAD_CODEC_TYPE 0xC1 /* Media Codec Type is not valid */ 64 #define A2D_NS_CODEC_TYPE 0xC2 /* Media Codec Type is not supported */ 65 #define A2D_BAD_SAMP_FREQ 0xC3 /* Sampling Frequency is not valid or multiple values have been selected */ 66 #define A2D_NS_SAMP_FREQ 0xC4 /* Sampling Frequency is not supported */ 67 #define A2D_BAD_CH_MODE 0xC5 /* Channel Mode is not valid or multiple values have been selected */ 68 #define A2D_NS_CH_MODE 0xC6 /* Channel Mode is not supported */ 69 #define A2D_BAD_SUBBANDS 0xC7 /* None or multiple values have been selected for Number of Subbands */ 70 #define A2D_NS_SUBBANDS 0xC8 /* Number of Subbands is not supported */ 71 #define A2D_BAD_ALLOC_MTHD 0xC9 /* None or multiple values have been selected for Allocation Method */ 72 #define A2D_NS_ALLOC_MTHD 0xCA /* Allocation Method is not supported */ 73 #define A2D_BAD_MIN_BITPOOL 0xCB /* Minimum Bitpool Value is not valid */ 74 #define A2D_NS_MIN_BITPOOL 0xCC /* Minimum Bitpool Value is not supported */ 75 #define A2D_BAD_MAX_BITPOOL 0xCD /* Maximum Bitpool Value is not valid */ 76 #define A2D_NS_MAX_BITPOOL 0xCE /* Maximum Bitpool Value is not supported */ 77 #define A2D_BAD_LAYER 0xCF /* None or multiple values have been selected for Layer */ 78 #define A2D_NS_LAYER 0xD0 /* Layer is not supported */ 79 #define A2D_NS_CRC 0xD1 /* CRC is not supported */ 80 #define A2D_NS_MPF 0xD2 /* MPF-2 is not supported */ 81 #define A2D_NS_VBR 0xD3 /* VBR is not supported */ 82 #define A2D_BAD_BIT_RATE 0xD4 /* None or multiple values have been selected for Bit Rate */ 83 #define A2D_NS_BIT_RATE 0xD5 /* Bit Rate is not supported */ 84 #define A2D_BAD_OBJ_TYPE 0xD6 /* Either 1) Object type is not valid (b3-b0) or 2) None or multiple values have been selected for Object Type */ 85 #define A2D_NS_OBJ_TYPE 0xD7 /* Object type is not supported */ 86 #define A2D_BAD_CHANNEL 0xD8 /* None or multiple values have been selected for Channels */ 87 #define A2D_NS_CHANNEL 0xD9 /* Channels is not supported */ 88 #define A2D_BAD_BLOCK_LEN 0xDD /* None or multiple values have been selected for Block Length */ 89 #define A2D_BAD_CP_TYPE 0xE0 /* The requested CP Type is not supported. */ 90 #define A2D_BAD_CP_FORMAT 0xE1 /* The format of Content Protection Service Capability/Content Protection Scheme Dependent Data is not correct. */ 91 92 typedef UINT8 tA2D_STATUS; 93 94 /* the return values from A2D_BitsSet() */ 95 #define A2D_SET_ONE_BIT 1 /* one and only one bit is set */ 96 #define A2D_SET_ZERO_BIT 0 /* all bits clear */ 97 #define A2D_SET_MULTL_BIT 2 /* multiple bits are set */ 98 99 /***************************************************************************** 100 ** type definitions 101 *****************************************************************************/ 102 103 /* This data type is used in A2D_FindService() to initialize the SDP database 104 * to hold the result service search. */ 105 typedef struct { 106 UINT32 db_len; /* Length, in bytes, of the discovery database */ 107 UINT16 num_attr;/* The number of attributes in p_attrs */ 108 tSDP_DISCOVERY_DB *p_db; /* Pointer to the discovery database */ 109 UINT16 *p_attrs; /* The attributes filter. If NULL, A2DP API sets the attribute filter 110 * to be ATTR_ID_SERVICE_CLASS_ID_LIST, ATTR_ID_BT_PROFILE_DESC_LIST, 111 * ATTR_ID_SUPPORTED_FEATURES, ATTR_ID_SERVICE_NAME and ATTR_ID_PROVIDER_NAME. 112 * If not NULL, the input is taken as the filter. */ 113 } tA2D_SDP_DB_PARAMS; 114 115 /* This data type is used in tA2D_FIND_CBACK to report the result of the SDP discovery process. */ 116 typedef struct { 117 UINT16 service_len; /* Length, in bytes, of the service name */ 118 UINT16 provider_len; /* Length, in bytes, of the provider name */ 119 char *p_service_name; /* Pointer the service name. This character string may not be null terminated. 120 * Use the service_len parameter to safely copy this string */ 121 char *p_provider_name;/* Pointer the provider name. This character string may not be null terminated. 122 * Use the provider_len parameter to safely copy this string */ 123 UINT16 features; /* Profile supported features */ 124 UINT16 avdt_version; /* AVDTP protocol version */ 125 } tA2D_Service; 126 127 /* This is the callback to notify the result of the SDP discovery process. */ 128 typedef void (tA2D_FIND_CBACK)(BOOLEAN found, tA2D_Service *p_service); 129 130 131 /***************************************************************************** 132 ** external function declarations 133 *****************************************************************************/ 134 #ifdef __cplusplus 135 extern "C" 136 { 137 #endif 138 /****************************************************************************** 139 ** 140 ** Function A2D_AddRecord 141 ** 142 ** Description This function is called by a server application to add 143 ** SRC or SNK information to an SDP record. Prior to 144 ** calling this function the application must call 145 ** SDP_CreateRecord() to create an SDP record. 146 ** 147 ** Input Parameters: 148 ** service_uuid: Indicates SRC or SNK. 149 ** 150 ** p_service_name: Pointer to a null-terminated character 151 ** string containing the service name. 152 ** 153 ** p_provider_name: Pointer to a null-terminated character 154 ** string containing the provider name. 155 ** 156 ** features: Profile supported features. 157 ** 158 ** sdp_handle: SDP handle returned by SDP_CreateRecord(). 159 ** 160 ** Output Parameters: 161 ** None. 162 ** 163 ** Returns A2D_SUCCESS if function execution succeeded, 164 ** A2D_INVALID_PARAMS if bad parameters are given. 165 ** A2D_FAIL if function execution failed. 166 ** 167 ******************************************************************************/ 168 extern tA2D_STATUS A2D_AddRecord(UINT16 service_uuid, char *p_service_name, char *p_provider_name, 169 UINT16 features, UINT32 sdp_handle); 170 171 /****************************************************************************** 172 ** 173 ** Function A2D_FindService 174 ** 175 ** Description This function is called by a client application to 176 ** perform service discovery and retrieve SRC or SNK SDP 177 ** record information from a server. Information is 178 ** returned for the first service record found on the 179 ** server that matches the service UUID. The callback 180 ** function will be executed when service discovery is 181 ** complete. There can only be one outstanding call to 182 ** A2D_FindService() at a time; the application must wait 183 ** for the callback before it makes another call to 184 ** the function. 185 ** 186 ** Input Parameters: 187 ** service_uuid: Indicates SRC or SNK. 188 ** 189 ** bd_addr: BD address of the peer device. 190 ** 191 ** p_db: Pointer to the information to initialize 192 ** the discovery database. 193 ** 194 ** p_cback: Pointer to the A2D_FindService() 195 ** callback function. 196 ** 197 ** Output Parameters: 198 ** None. 199 ** 200 ** Returns A2D_SUCCESS if function execution succeeded, 201 ** A2D_INVALID_PARAMS if bad parameters are given. 202 ** A2D_BUSY if discovery is already in progress. 203 ** A2D_FAIL if function execution failed. 204 ** 205 ******************************************************************************/ 206 extern tA2D_STATUS A2D_FindService(UINT16 service_uuid, BD_ADDR bd_addr, 207 tA2D_SDP_DB_PARAMS *p_db, tA2D_FIND_CBACK *p_cback); 208 209 /****************************************************************************** 210 ** 211 ** Function A2D_SetTraceLevel 212 ** 213 ** Description Sets the trace level for A2D. If 0xff is passed, the 214 ** current trace level is returned. 215 ** 216 ** Input Parameters: 217 ** new_level: The level to set the A2D tracing to: 218 ** 0xff-returns the current setting. 219 ** 0-turns off tracing. 220 ** >= 1-Errors. 221 ** >= 2-Warnings. 222 ** >= 3-APIs. 223 ** >= 4-Events. 224 ** >= 5-Debug. 225 ** 226 ** Returns The new trace level or current trace level if 227 ** the input parameter is 0xff. 228 ** 229 ******************************************************************************/ 230 extern UINT8 A2D_SetTraceLevel (UINT8 new_level); 231 232 /****************************************************************************** 233 ** Function A2D_BitsSet 234 ** 235 ** Description Check the given num for the number of bits set 236 ** Returns A2D_SET_ONE_BIT, if one and only one bit is set 237 ** A2D_SET_ZERO_BIT, if all bits clear 238 ** A2D_SET_MULTL_BIT, if multiple bits are set 239 ******************************************************************************/ 240 extern UINT8 A2D_BitsSet(UINT8 num); 241 242 /******************************************************************************* 243 ** 244 ** Function A2D_Init 245 ** 246 ** Description This function is called at stack startup to allocate the 247 ** control block (if using dynamic memory), and initializes the 248 ** control block and tracing level. 249 ** 250 ** Returns void 251 ** 252 *******************************************************************************/ 253 extern bt_status_t A2D_Init(void); 254 255 /******************************************************************************* 256 ** 257 ** Function A2D_Deinit 258 ** 259 ** Description This function is called at stack startup to free the 260 ** control block (if using dynamic memory), and free the 261 ** control block and tracing level. 262 ** 263 ** Returns void 264 ** 265 *******************************************************************************/ 266 extern void A2D_Deinit(void); 267 268 /******************************************************************************* 269 ** 270 ** Function a2d_set_avdt_sdp_ver 271 ** 272 ** Description Used for change version of avdtp 273 ** 274 ** Returns void 275 ** 276 *******************************************************************************/ 277 extern void a2d_set_avdt_sdp_ver(UINT16 avdt_sdp_ver); 278 279 /******************************************************************************* 280 ** 281 ** Function a2d_set_a2dp_sdp_ver 282 ** 283 ** Description Used for change version of a2dp 284 ** 285 ** Returns void 286 ** 287 *******************************************************************************/ 288 extern void a2d_set_a2dp_sdp_ver(UINT16 a2dp_sdp_ver); 289 290 #ifdef __cplusplus 291 } 292 #endif 293 294 #endif ///A2D_INCLUDED 295 #endif /* A2D_API_H */ 296
