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