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 MATTHIAS 24 * RINGWALD 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 * a2dp_source.h 40 * 41 * Advanced Audio Distribution Transport Profile (A2DP) Source 42 * 43 * A2DP Source is a device that streames media data. 44 */ 45 46 #ifndef A2DP_SOURCE_H 47 #define A2DP_SOURCE_H 48 49 #include <stdint.h> 50 #include "classic/avdtp.h" 51 52 #if defined __cplusplus 53 extern "C" { 54 #endif 55 56 /* API_START */ 57 58 /** 59 * @brief Create A2DP Source service record. 60 * @param service 61 * @param service_record_handle 62 * @param supported_features 16-bit bitmap, see AVDTP_SOURCE_SF_* values in avdtp.h 63 * @param service_name 64 * @param service_provider_name 65 */ 66 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); 67 68 /** 69 * @brief Initialize up A2DP Source device. 70 */ 71 void a2dp_source_init(void); 72 73 /** 74 * @brief Create a stream endpoint of type SOURCE, and register media codec by specifying its capabilities and the default configuration. 75 * @param media_type See avdtp_media_type_t values in avdtp.h (audio, video or multimedia). 76 * @param media_codec_type See avdtp_media_codec_type_t values in avdtp.h 77 * @param codec_capabilities Media codec capabilities as defined in A2DP spec, section 4 - Audio Codec Interoperability Requirements. 78 * @param codec_capabilities_len Media codec capabilities length. 79 * @param codec_configuration Default media codec configuration. 80 * @param codec_configuration_len Media codec configuration length. 81 * 82 * @return local_stream_endpoint 83 */ 84 avdtp_stream_endpoint_t * a2dp_source_create_stream_endpoint(avdtp_media_type_t media_type, avdtp_media_codec_type_t media_codec_type, 85 uint8_t * codec_capabilities, uint16_t codec_capabilities_len, 86 uint8_t * codec_configuration, uint16_t codec_configuration_len); 87 88 /** 89 * @brief Unregister stream endpoint and free it's memory 90 * @param stream_endpoint created by a2dp_source_create_stream_endpoint 91 */ 92 void a2dp_source_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint); 93 94 /** 95 * @brief Register callback for the A2DP Source client. It will receive following subevents of HCI_EVENT_A2DP_META HCI event type: 96 * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW: Indicates that the next media packet can be sent. 97 * 98 * - A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED Received when signaling connection with a remote is established. 99 * - A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED Received when signaling connection with a remote is released 100 * - A2DP_SUBEVENT_STREAM_ESTABLISHED Received when stream to a remote device is established. 101 * - A2DP_SUBEVENT_STREAM_STARTED Received when stream is started. 102 * - A2DP_SUBEVENT_STREAM_SUSPENDED Received when stream is paused. 103 * - A2DP_SUBEVENT_STREAM_STOPED received when stream is aborted or stopped. 104 * - A2DP_SUBEVENT_STREAM_RELEASED Received when stream is released. 105 * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORTING_CAPABILITY Currently the only capability that is passed to client 106 * - A2DP_SUBEVENT_SIGNALING_CAPABILITIES_DONE Signals that all capabilities are reported 107 * - A2DP_SUBEVENT_SIGNALING_DELAY_REPORT Delay report 108 * - A2DP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION SBC configuration 109 * - A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW Signals that a media packet can be sent 110 * - A2DP_SUBEVENT_COMMAND_REJECTED Command reject 111 * @param callback 112 */ 113 void a2dp_source_register_packet_handler(btstack_packet_handler_t callback); 114 115 /** 116 * @brief Open stream. 117 * @param remote 118 * @param local_seid ID assigned to a local stream endpoint 119 * @param out_a2dp_cid Assigned A2DP channel identifyer used for furhter A2DP commands. 120 */ 121 uint8_t a2dp_source_establish_stream(bd_addr_t remote, uint8_t local_seid, uint16_t * out_a2dp_cid); 122 123 /** 124 * @brief Reconfigure stream. 125 * @param local_seid ID assigned to a local stream endpoint 126 * @param sampling_frequency New sampling frequency to use. Cannot be called while stream is active 127 */ 128 uint8_t a2dp_source_reconfigure_stream_sampling_frequency(uint16_t a2dp_cid, uint32_t sampling_frequency); 129 130 /** 131 * @brief Start stream. 132 * @param a2dp_cid A2DP channel identifyer. 133 * @param local_seid ID of a local stream endpoint. 134 */ 135 uint8_t a2dp_source_start_stream(uint16_t a2dp_cid, uint8_t local_seid); 136 137 /** 138 * @brief Pause stream. 139 * @param a2dp_cid A2DP channel identifyer. 140 * @param local_seid ID of a local stream endpoint. 141 */ 142 uint8_t a2dp_source_pause_stream(uint16_t a2dp_cid, uint8_t local_seid); 143 144 /** 145 * @brief Release stream and disconnect from remote. 146 * @param a2dp_cid A2DP channel identifyer. 147 */ 148 uint8_t a2dp_source_disconnect(uint16_t a2dp_cid); 149 150 /** 151 * @brief Request to send a media packet. Packet can be then sent on reception of A2DP_SUBEVENT_STREAMING_CAN_SEND_MEDIA_PACKET_NOW event. 152 * @param a2dp_cid A2DP channel identifyer. 153 * @param local_seid ID of a local stream endpoint. 154 */ 155 void a2dp_source_stream_endpoint_request_can_send_now(uint16_t a2dp_cid, uint8_t local_seid); 156 157 /** 158 * @brief Return maximal media payload size, does not include media header. 159 * @param a2dp_cid A2DP channel identifyer. 160 * @param local_seid ID of a local stream endpoint. 161 * @return max_media_payload_size_without_media_header 162 */ 163 int a2dp_max_media_payload_size(uint16_t a2dp_cid, uint8_t local_seid); 164 165 /** 166 * @brief Send media payload. 167 * @param a2dp_cid A2DP channel identifyer. 168 * @param local_seid ID of a local stream endpoint. 169 * @param storage 170 * @param num_bytes_to_copy 171 * @param num_frames 172 * @param marker 173 * @return max_media_payload_size_without_media_header 174 */ 175 int a2dp_source_stream_send_media_payload(uint16_t a2dp_cid, uint8_t local_seid, uint8_t * storage, int num_bytes_to_copy, uint8_t num_frames, uint8_t marker); 176 177 /* API_END */ 178 179 #if defined __cplusplus 180 } 181 #endif 182 183 #endif // A2DP_SOURCE_H 184