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 Sink 40 * 41 * Audio/Video Distribution Transport Protocol A2DP Sink is a device that accepts streamed media data. 42 * 43 */ 44 45 #ifndef A2DP_SINK_H 46 #define A2DP_SINK_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 Sink service record. 59 * @param service 60 * @param service_record_handle 61 * @param supported_features 16-bit bitmap, see AVDTP_SINK_SF_* values in avdtp.h 62 * @param service_name 63 * @param service_provider_name 64 */ 65 void a2dp_sink_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 Sink device. 69 */ 70 void a2dp_sink_init(void); 71 72 /** 73 * @brief Create a stream endpoint of type SINK, 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_sink_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_sink_create_stream_endpoint 90 */ 91 void a2dp_sink_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint); 92 93 /** 94 * @brief Register callback for the A2DP Sink client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type: 95 * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION: indicates from remote chosen SBC media codec configuration 96 * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_OTHER_CONFIGURATION: indicates from remote chosen other then SBC media codec configuration 97 * - A2DP_SUBEVENT_STREAM_ESTABLISHED: received when stream to a remote device is established 98 * - A2DP_SUBEVENT_STREAM_STARTED: received when stream is started 99 * - A2DP_SUBEVENT_STREAM_SUSPENDED: received when stream is paused 100 * - A2DP_SUBEVENT_STREAM_STOPED: received when stream is aborted or stopped 101 * - A2DP_SUBEVENT_STREAM_RELEASED: received when stream is released 102 * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED: received when signaling channel is disconnected 103 * 104 * @param callback 105 */ 106 void a2dp_sink_register_packet_handler(btstack_packet_handler_t callback); 107 108 /** 109 * @brief Register media handler for the A2DP Sink client. 110 * @param callback 111 * @param packet 112 * @param size 113 */ 114 void a2dp_sink_register_media_handler(void (*callback)(uint8_t local_seid, uint8_t *packet, uint16_t size)); 115 116 /** 117 * @brief Establish stream. 118 * @param remote 119 * @param local_seid ID of a local stream endpoint. 120 * @param out_a2dp_cid Assigned A2DP channel identifier used for furhter A2DP commands. 121 */ 122 uint8_t a2dp_sink_establish_stream(bd_addr_t remote, uint8_t local_seid, uint16_t * out_a2dp_cid); 123 124 #ifdef ENABLE_AVDTP_ACCEPTOR_EXPLICIT_START_STREAM_CONFIRMATION 125 /** 126 * @brief Accept starting the stream on A2DP_SUBEVENT_START_STREAM_REQUESTED event. 127 * @param a2dp_cid A2DP channel identifier. 128 * @param local_seid ID of a local stream endpoint. 129 */ 130 uint8_t a2dp_sink_start_stream_accept(uint16_t a2dp_cid, uint8_t local_seid); 131 132 /** 133 * @brief Reject starting the stream on A2DP_SUBEVENT_START_STREAM_REQUESTED event. 134 * @param a2dp_cid A2DP channel identifier. 135 * @param local_seid ID of a local stream endpoint. 136 */ 137 uint8_t a2dp_sink_start_stream_reject(uint16_t a2dp_cid, uint8_t local_seid); 138 #endif 139 140 /** 141 * @brief Release stream and disconnect from remote. 142 * @param a2dp_cid A2DP channel identifier. 143 */ 144 void a2dp_sink_disconnect(uint16_t a2dp_cid); 145 146 /** 147 * @brief Register media configuration validator. Can reject insuitable configuration or report stream endpoint as currently busy 148 * @note validator has to return AVDTP error codes like: AVDTP_ERROR_CODE_SEP_IN_USE or AVDTP_ERROR_CODE_UNSUPPORTED_CONFIGURATION 149 * the callback receives the media configuration in the same format as the existing A2dP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION 150 * and similar 151 * @param callback 152 */ 153 void a2dp_sink_register_media_config_validator(uint8_t (*callback)(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size)); 154 155 /** 156 * @brief De-Init A2DP Sink device. 157 */ 158 void a2dp_sink_deinit(void); 159 160 /* API_END */ 161 162 163 #if defined __cplusplus 164 } 165 #endif 166 167 #endif // A2DP_SINK_H 168