1 /* 2 * Copyright (C) 2016 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title A2DP Source 40 * 41 * Audio/Video Distribution Transport Protocol A2DP Source is a device that streames media data. 42 * 43 */ 44 45 #ifndef A2DP_SOURCE_H 46 #define A2DP_SOURCE_H 47 48 #include <stdint.h> 49 #include "classic/avdtp.h" 50 51 #if defined __cplusplus 52 extern "C" { 53 #endif 54 55 /* API_START */ 56 57 /** 58 * @brief Create A2DP Source service record. 59 * @param service 60 * @param service_record_handle 61 * @param supported_features 16-bit bitmap, see AVDTP_SOURCE_SF_* values in avdtp.h 62 * @param service_name or NULL for default value. Provide "" (empty string) to skip attribute 63 * @param service_provider_name or NULL for default value. Provide "" (empty string) to skip attribute 64 */ 65 void a2dp_source_create_sdp_record(uint8_t * service, uint32_t service_record_handle, uint16_t supported_features, const char * service_name, const char * service_provider_name); 66 67 /** 68 * @brief Initialize up A2DP Source device. 69 */ 70 void a2dp_source_init(void); 71 72 /** 73 * @brief Create a stream endpoint of type SOURCE, and register media codec by specifying its capabilities and the default configuration. 74 * @param media_type See avdtp_media_type_t values in avdtp.h (audio, video or multimedia). 75 * @param media_codec_type See avdtp_media_codec_type_t values in avdtp.h 76 * @param codec_capabilities Media codec capabilities as defined in A2DP spec, section 4 - Audio Codec Interoperability Requirements. 77 * @param codec_capabilities_len Media codec capabilities length. 78 * @param codec_configuration Default media codec configuration. 79 * @param codec_configuration_len Media codec configuration length. 80 * 81 * @return local_stream_endpoint 82 */ 83 avdtp_stream_endpoint_t * a2dp_source_create_stream_endpoint(avdtp_media_type_t media_type, avdtp_media_codec_type_t media_codec_type, 84 const uint8_t *codec_capabilities, uint16_t codec_capabilities_len, 85 uint8_t * codec_configuration, uint16_t codec_configuration_len); 86 87 /** 88 * @brief Unregister stream endpoint and free it's memory 89 * @param stream_endpoint created by a2dp_source_create_stream_endpoint 90 */ 91 void a2dp_source_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint); 92 93 /** 94 * @brief Register callback for the A2DP Source client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type: 95 * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW: Indicates that the next media packet can be sent. 96 * 97 * - A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED Received when signaling connection with a remote is established. 98 * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED Received when signaling connection with a remote is released 99 * - A2DP_SUBEVENT_STREAM_ESTABLISHED Received when stream to a remote device is established. 100 * - A2DP_SUBEVENT_STREAM_STARTED Received when stream is started. 101 * - A2DP_SUBEVENT_STREAM_SUSPENDED Received when stream is paused. 102 * - A2DP_SUBEVENT_STREAM_STOPED received when stream is aborted or stopped. 103 * - A2DP_SUBEVENT_STREAM_RELEASED Received when stream is released. 104 * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORTING_CAPABILITY Currently the only capability that is passed to client 105 * - A2DP_SUBEVENT_SIGNALING_CAPABILITIES_DONE Signals that all capabilities are reported 106 * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORT Delay report 107 * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION SBC configuration 108 * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW Signals that a media packet can be sent 109 * - A2DP_SUBEVENT_COMMAND_REJECTED Command reject 110 * @param callback 111 */ 112 void a2dp_source_register_packet_handler(btstack_packet_handler_t callback); 113 114 /** 115 * @brief Open stream. 116 * @param remote_addr 117 * @param avdtp_cid Assigned A2DP channel identifier used for further A2DP commands. 118 */ 119 uint8_t a2dp_source_establish_stream(bd_addr_t remote_addr, uint16_t *avdtp_cid); 120 121 /** 122 * @brief Reconfigure stream. 123 * @param local_seid ID assigned to a local stream endpoint 124 * @param sampling_frequency New sampling frequency to use. Cannot be called while stream is active 125 */ 126 uint8_t a2dp_source_reconfigure_stream_sampling_frequency(uint16_t a2dp_cid, uint32_t sampling_frequency); 127 128 /** 129 * @brief Start stream. 130 * @param a2dp_cid A2DP channel identifier. 131 * @param local_seid ID of a local stream endpoint. 132 */ 133 uint8_t a2dp_source_start_stream(uint16_t a2dp_cid, uint8_t local_seid); 134 135 /** 136 * @brief Pause stream. 137 * @param a2dp_cid A2DP channel identifier. 138 * @param local_seid ID of a local stream endpoint. 139 */ 140 uint8_t a2dp_source_pause_stream(uint16_t a2dp_cid, uint8_t local_seid); 141 142 /** 143 * @brief Release stream and disconnect from remote. 144 * @param a2dp_cid A2DP channel identifier. 145 */ 146 uint8_t a2dp_source_disconnect(uint16_t a2dp_cid); 147 148 /** 149 * @brief Request to send a media packet. Packet can be then sent on reception of A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW event. 150 * @param a2dp_cid A2DP channel identifier. 151 * @param local_seid ID of a local stream endpoint. 152 */ 153 void a2dp_source_stream_endpoint_request_can_send_now(uint16_t a2dp_cid, uint8_t local_seid); 154 155 /** 156 * @brief Return maximal media payload size, does not include media header. 157 * @param a2dp_cid A2DP channel identifier. 158 * @param local_seid ID of a local stream endpoint. 159 * @return max_media_payload_size_without_media_header 160 */ 161 int a2dp_max_media_payload_size(uint16_t a2dp_cid, uint8_t local_seid); 162 163 /** 164 * @brief Send media payload. 165 * @param a2dp_cid A2DP channel identifier. 166 * @param local_seid ID of a local stream endpoint. 167 * @param marker 168 * @param timestamp in sample rate units 169 * @param payload 170 * @param payload_size 171 * @param marker 172 * @return status 173 */ 174 uint8_t a2dp_source_stream_send_media_payload_rtp(uint16_t a2dp_cid, uint8_t local_seid, uint8_t marker, uint32_t timestamp, 175 uint8_t *payload, uint16_t payload_size); 176 177 /** 178 * @brief Send media packet 179 * @param a2dp_cid A2DP channel identifier. 180 * @param local_seid ID of a local stream endpoint. 181 * @param packet 182 * @param size 183 * @return status 184 */ 185 uint8_t a2dp_source_stream_send_media_packet(uint16_t a2dp_cid, uint8_t local_seid, const uint8_t * packet, uint16_t size); 186 187 /** 188 * @brief Select and configure SBC endpoint 189 * @param a2dp_cid A2DP channel identifier. 190 * @param local_seid ID of a local stream endpoint. 191 * @param remote_seid ID of a remote stream endpoint. 192 * @param configuration SBC Configuration 193 * @return status 194 */ 195 uint8_t a2dp_source_set_config_sbc(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_sbc_t * configuration); 196 197 /** 198 * @brief Select and configure MPEG AUDIO endpoint 199 * @param a2dp_cid A2DP channel identifier. 200 * @param local_seid ID of a local stream endpoint. 201 * @param remote_seid ID of a remote stream endpoint. 202 * @param configuration MPEG AUDIO Configuration 203 * @return status 204 */ 205 uint8_t a2dp_source_set_config_mpeg_audio(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_mpeg_audio_t * configuration); 206 207 /** 208 * @brief Select and configure MPEG AAC endpoint 209 * @param a2dp_cid A2DP channel identifier. 210 * @param local_seid ID of a local stream endpoint. 211 * @param remote_seid ID of a remote stream endpoint. 212 * @param configuration MPEG AAC Configuration 213 * @return status 214 */ 215 uint8_t a2dp_source_set_config_mpeg_aac(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_mpeg_aac_t * configuration); 216 217 /** 218 * @brief Select and configure ATRAC endpoint 219 * @param a2dp_cid A2DP channel identifier. 220 * @param local_seid ID of a local stream endpoint. 221 * @param remote_seid ID of a remote stream endpoint. 222 * @param configuration ATRAC Configuration 223 * @return status 224 */ 225 uint8_t a2dp_source_set_config_atrac(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const avdtp_configuration_atrac_t * configuration); 226 227 /** 228 * @brief Select and configure Non-A2DP endpoint. Bytes 0-3 of codec information contain Vendor ID, bytes 4-5 contain Vendor Specific Codec ID (little endian) 229 * @param a2dp_cid A2DP channel identifier. 230 * @param local_seid ID of a local stream endpoint. 231 * @param remote_seid ID of a remote stream endpoint. 232 * @param media_codec_information 233 * @param media_codec_information_len 234 * @return status 235 */ 236 uint8_t a2dp_source_set_config_other(uint16_t a2dp_cid, uint8_t local_seid, uint8_t remote_seid, const uint8_t * media_codec_information, uint8_t media_codec_information_len); 237 238 /** 239 * @brief Register media configuration validator. Can reject insuitable configuration or report stream endpoint as currently busy 240 * @note validator has to return AVDTP error codes like: AVDTP_ERROR_CODE_SEP_IN_USE or AVDTP_ERROR_CODE_UNSUPPORTED_CONFIGURATION 241 * the callback receives the media configuration in the same format as the existing A2dP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION 242 * and similar 243 * @param callback 244 */ 245 void a2dp_source_register_media_config_validator(uint8_t (*callback)(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size)); 246 247 /** 248 * @brief De-Init A2DP Source device. 249 */ 250 void a2dp_source_deinit(void); 251 252 /* API_END */ 253 254 #if defined __cplusplus 255 } 256 #endif 257 258 #endif // A2DP_SOURCE_H 259