xref: /btstack/src/classic/a2dp_sink.c (revision b28dc8004dd8d4fb9020a6dcd2bc81f05d36a008)
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 #define BTSTACK_FILE__ "a2dp_sink.c"
39 
40 #include <stdint.h>
41 #include <string.h>
42 
43 #include "bluetooth_psm.h"
44 #include "bluetooth_sdp.h"
45 #include "btstack_debug.h"
46 #include "btstack_event.h"
47 #include "classic/a2dp_sink.h"
48 #include "classic/avdtp_sink.h"
49 #include "classic/avdtp_util.h"
50 #include "classic/sdp_util.h"
51 
52 static const char * a2dp_sink_default_service_name = "BTstack A2DP Sink Service";
53 static const char * a2dp_sink_default_service_provider_name = "BTstack A2DP Sink Service Provider";
54 
55 static uint16_t a2dp_sink_cid;
56 static bool a2dp_sink_outgoing_active = false;
57 static bool a2dp_sink_stream_endpoint_configured = false;
58 
59 static btstack_packet_handler_t a2dp_sink_packet_handler_user;
60 static uint8_t (*a2dp_sink_media_config_validator)(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size);
61 
62 static void a2dp_sink_packet_handler_internal(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
63 
64 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){
65     uint8_t* attribute;
66     de_create_sequence(service);
67 
68     // 0x0000 "Service Record Handle"
69     de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_HANDLE);
70     de_add_number(service, DE_UINT, DE_SIZE_32, service_record_handle);
71 
72     // 0x0001 "Service Class ID List"
73     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST);
74     attribute = de_push_sequence(service);
75     {
76         de_add_number(attribute, DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_AUDIO_SINK);
77     }
78     de_pop_sequence(service, attribute);
79 
80     // 0x0004 "Protocol Descriptor List"
81     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST);
82     attribute = de_push_sequence(service);
83     {
84         uint8_t* l2cpProtocol = de_push_sequence(attribute);
85         {
86             de_add_number(l2cpProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_L2CAP);
87             de_add_number(l2cpProtocol,  DE_UINT, DE_SIZE_16, BLUETOOTH_PSM_AVDTP);
88         }
89         de_pop_sequence(attribute, l2cpProtocol);
90 
91         uint8_t* avProtocol = de_push_sequence(attribute);
92         {
93             de_add_number(avProtocol,  DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_AVDTP);  // avProtocol_service
94             de_add_number(avProtocol,  DE_UINT, DE_SIZE_16,  0x0103);  // version
95         }
96         de_pop_sequence(attribute, avProtocol);
97     }
98     de_pop_sequence(service, attribute);
99 
100     // 0x0005 "Public Browse Group"
101     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_BROWSE_GROUP_LIST); // public browse group
102     attribute = de_push_sequence(service);
103     {
104         de_add_number(attribute,  DE_UUID, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_PUBLIC_BROWSE_ROOT);
105     }
106     de_pop_sequence(service, attribute);
107 
108     // 0x0009 "Bluetooth Profile Descriptor List"
109     de_add_number(service,  DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_BLUETOOTH_PROFILE_DESCRIPTOR_LIST);
110     attribute = de_push_sequence(service);
111     {
112         uint8_t *a2dProfile = de_push_sequence(attribute);
113         {
114             de_add_number(a2dProfile,  DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_ADVANCED_AUDIO_DISTRIBUTION);
115             de_add_number(a2dProfile,  DE_UINT, DE_SIZE_16, 0x0103);
116         }
117         de_pop_sequence(attribute, a2dProfile);
118     }
119     de_pop_sequence(service, attribute);
120 
121 
122     // 0x0100 "Service Name"
123     de_add_number(service,  DE_UINT, DE_SIZE_16, 0x0100);
124     if (service_name){
125         de_add_data(service,  DE_STRING, strlen(service_name), (uint8_t *) service_name);
126     } else {
127         de_add_data(service, DE_STRING, strlen(a2dp_sink_default_service_name), (uint8_t *) a2dp_sink_default_service_name);
128     }
129 
130     // 0x0100 "Provider Name"
131     de_add_number(service,  DE_UINT, DE_SIZE_16, 0x0102);
132     if (service_provider_name){
133         de_add_data(service,  DE_STRING, strlen(service_provider_name), (uint8_t *) service_provider_name);
134     } else {
135         de_add_data(service, DE_STRING, strlen(a2dp_sink_default_service_provider_name), (uint8_t *) a2dp_sink_default_service_provider_name);
136     }
137 
138     // 0x0311 "Supported Features"
139     de_add_number(service, DE_UINT, DE_SIZE_16, 0x0311);
140     de_add_number(service, DE_UINT, DE_SIZE_16, supported_features);
141 }
142 
143 void a2dp_sink_register_packet_handler(btstack_packet_handler_t callback){
144     // avdtp_sink_register_packet_handler(callback);
145     // return;
146     if (callback == NULL){
147         log_error("a2dp_sink_register_packet_handler called with NULL callback");
148         return;
149     }
150     avdtp_sink_register_packet_handler(&a2dp_sink_packet_handler_internal);
151     a2dp_sink_packet_handler_user = callback;
152 }
153 
154 void a2dp_sink_register_media_handler(void (*callback)(uint8_t local_seid, uint8_t *packet, uint16_t size)){
155     if (callback == NULL){
156         log_error("a2dp_sink_register_media_handler called with NULL callback");
157         return;
158     }
159     avdtp_sink_register_media_handler(callback);
160 }
161 
162 void a2dp_sink_init(void){
163     avdtp_sink_init();
164 }
165 
166 void a2dp_sink_deinit(void){
167     avdtp_sink_deinit();
168 
169     a2dp_sink_cid = 0;
170     a2dp_sink_packet_handler_user = NULL;
171     a2dp_sink_media_config_validator = NULL;
172     a2dp_sink_outgoing_active = false;
173     a2dp_sink_stream_endpoint_configured = false;
174 }
175 
176 avdtp_stream_endpoint_t * a2dp_sink_create_stream_endpoint(avdtp_media_type_t media_type, avdtp_media_codec_type_t media_codec_type,
177                                                            const uint8_t *codec_capabilities, uint16_t codec_capabilities_len,
178                                                            uint8_t * codec_configuration, uint16_t codec_configuration_len){
179     avdtp_stream_endpoint_t * local_stream_endpoint = avdtp_sink_create_stream_endpoint(AVDTP_SINK, media_type);
180     if (!local_stream_endpoint){
181         return NULL;
182     }
183     avdtp_sink_register_media_transport_category(avdtp_stream_endpoint_seid(local_stream_endpoint));
184     avdtp_sink_register_media_codec_category(avdtp_stream_endpoint_seid(local_stream_endpoint), media_type, media_codec_type,
185         codec_capabilities, codec_capabilities_len);
186 	avdtp_sink_register_delay_reporting_category(avdtp_stream_endpoint_seid(local_stream_endpoint));
187 
188 	// store user codec configuration buffer
189 	local_stream_endpoint->media_codec_configuration_info = codec_configuration;
190 	local_stream_endpoint->media_codec_configuration_len  = codec_configuration_len;
191 
192     return local_stream_endpoint;
193 }
194 
195 void a2dp_sink_finalize_stream_endpoint(avdtp_stream_endpoint_t * stream_endpoint){
196     avdtp_sink_finalize_stream_endpoint(stream_endpoint);
197 }
198 
199 uint8_t a2dp_sink_establish_stream(bd_addr_t bd_addr, uint8_t local_seid, uint16_t * avdtp_cid){
200 	avdtp_stream_endpoint_t * stream_endpoint = avdtp_get_stream_endpoint_for_seid(local_seid);
201     if (stream_endpoint == NULL){
202         log_info("No local_stream_endpoint for seid %d", local_seid);
203         return ERROR_CODE_COMMAND_DISALLOWED;
204     }
205     // remember to tell client
206     a2dp_sink_outgoing_active = true;
207     return avdtp_sink_connect(bd_addr, avdtp_cid);
208 }
209 
210 #ifdef ENABLE_AVDTP_ACCEPTOR_EXPLICIT_START_STREAM_CONFIRMATION
211 uint8_t a2dp_sink_start_stream_accept(uint16_t a2dp_cid, uint8_t local_seid){
212     return avdtp_start_stream_accept(a2dp_cid, local_seid);
213 }
214 
215 uint8_t a2dp_sink_start_stream_reject(uint16_t a2dp_cid, uint8_t local_seid){
216     return avdtp_start_stream_reject(a2dp_cid, local_seid);
217 }
218 #endif
219 
220 void a2dp_sink_disconnect(uint16_t a2dp_cid){
221     avdtp_disconnect(a2dp_cid);
222 }
223 
224 static void a2dp_sink_packet_handler_internal(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
225     UNUSED(channel);
226     UNUSED(size);
227 
228     uint8_t status;
229     uint8_t local_seid;
230     uint8_t signal_identifier;
231     bool reconfigure;
232     uint8_t subevent_id;
233 
234     if (packet_type != HCI_EVENT_PACKET) return;
235     if (hci_event_packet_get_type(packet) != HCI_EVENT_AVDTP_META) return;
236 
237     switch (packet[2]){
238         case AVDTP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED:
239             if (a2dp_sink_stream_endpoint_configured) return;
240 
241             status = avdtp_subevent_signaling_connection_established_get_status(packet);
242             if (status != ERROR_CODE_SUCCESS){
243                 // only care for outgoing connections
244                 if (!a2dp_sink_outgoing_active) break;
245                 a2dp_sink_outgoing_active = false;
246                 a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED);
247                 log_info("A2DP sink signaling connection failed status %d", status);
248                 break;
249             }
250 
251             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED);
252             log_info("A2DP sink signaling connection established avdtp_cid 0x%02x", avdtp_subevent_signaling_connection_established_get_avdtp_cid(packet));
253             break;
254 
255         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION:
256         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_MPEG_AUDIO_CONFIGURATION:
257         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_MPEG_AAC_CONFIGURATION:
258         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_ATRAC_CONFIGURATION:
259         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_OTHER_CONFIGURATION:
260             reconfigure = avdtp_subevent_signaling_media_codec_other_configuration_get_reconfigure(packet) != 0;
261             // accept configure if not configured and reconfigure if already configured
262             if (a2dp_sink_stream_endpoint_configured != reconfigure) break;
263             a2dp_sink_stream_endpoint_configured = true;
264             a2dp_sink_cid = avdtp_subevent_signaling_media_codec_other_capability_get_avdtp_cid(packet);
265             subevent_id = a2dp_subevent_id_for_avdtp_subevent_id(packet[2]);
266             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, subevent_id);
267             break;
268 
269         case AVDTP_SUBEVENT_STREAMING_CONNECTION_ESTABLISHED:
270             if (a2dp_sink_stream_endpoint_configured == false) break;
271             if (a2dp_sink_cid != avdtp_subevent_streaming_connection_established_get_avdtp_cid(packet)) break;
272 
273             // about to notify client
274             a2dp_sink_outgoing_active = false;
275             status = avdtp_subevent_streaming_connection_established_get_status(packet);
276             if (status != ERROR_CODE_SUCCESS){
277                 log_info("A2DP sink streaming connection could not be established, avdtp_cid 0x%02x, status 0x%02x ---", a2dp_sink_cid, status);
278                 a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_ESTABLISHED);
279                 break;
280             }
281 
282             log_info("A2DP streaming connection established --- avdtp_cid 0x%02x, local seid %d, remote seid %d", a2dp_sink_cid,
283                 avdtp_subevent_streaming_connection_established_get_local_seid(packet),
284                 avdtp_subevent_streaming_connection_established_get_remote_seid(packet));
285 
286             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_ESTABLISHED);
287             break;
288 
289         case AVDTP_SUBEVENT_SIGNALING_ACCEPT:
290             if (a2dp_sink_stream_endpoint_configured == false) break;
291             if (a2dp_sink_cid != avdtp_subevent_signaling_accept_get_avdtp_cid(packet)) break;
292 
293             signal_identifier = avdtp_subevent_signaling_accept_get_signal_identifier(packet);
294             local_seid = avdtp_subevent_signaling_accept_get_local_seid(packet);
295 
296             switch (signal_identifier){
297                 case  AVDTP_SI_START:
298                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_STARTED);
299                     break;
300                 case AVDTP_SI_SUSPEND:
301                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_SUSPENDED);
302                     break;
303                 case AVDTP_SI_ABORT:
304                 case AVDTP_SI_CLOSE:
305                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_STOPPED);
306                     break;
307 #ifdef ENABLE_AVDTP_ACCEPTOR_EXPLICIT_START_STREAM_CONFIRMATION
308                 case AVDTP_SI_ACCEPT_START:
309                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_START_STREAM_REQUESTED);
310                     break;
311 #endif
312                 default:
313                     break;
314             }
315             break;
316 
317         case AVDTP_SUBEVENT_SIGNALING_REJECT:
318             if (a2dp_sink_stream_endpoint_configured == false) break;
319             if (a2dp_sink_cid != avdtp_subevent_signaling_reject_get_avdtp_cid(packet)) break;
320 
321             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_COMMAND_REJECTED);
322             break;
323 
324         case AVDTP_SUBEVENT_SIGNALING_GENERAL_REJECT:
325             if (a2dp_sink_stream_endpoint_configured == false) break;
326             if (a2dp_sink_cid != avdtp_subevent_signaling_general_reject_get_avdtp_cid(packet)) break;
327 
328             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_COMMAND_REJECTED);
329             break;
330 
331         case AVDTP_SUBEVENT_STREAMING_CONNECTION_RELEASED:
332             if (a2dp_sink_stream_endpoint_configured == false) break;
333             if (a2dp_sink_cid != avdtp_subevent_streaming_connection_released_get_avdtp_cid(packet)) break;
334 
335             a2dp_sink_stream_endpoint_configured = false;
336 
337             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_RELEASED);
338             break;
339 
340         case AVDTP_SUBEVENT_SIGNALING_CONNECTION_RELEASED:
341             if (a2dp_sink_cid != avdtp_subevent_signaling_connection_released_get_avdtp_cid(packet)) break;
342 
343             a2dp_sink_stream_endpoint_configured = false;
344             a2dp_sink_outgoing_active = false;
345 
346             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED);
347             break;
348         default:
349             break;
350     }
351 
352 }
353 
354 static uint8_t a2dp_sink_media_config_validator_callback(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size){
355     uint8_t error = 0;
356     if (a2dp_sink_media_config_validator != NULL) {
357         // update subevent id and call validator
358         uint8_t avdtp_subevent_id = event[2];
359         uint8_t a2dp_subevent_id = a2dp_subevent_id_for_avdtp_subevent_id(avdtp_subevent_id);
360         uint8_t * subevent_field = (uint8_t *) &event[2];
361         *subevent_field = a2dp_subevent_id;
362         error = (*a2dp_sink_media_config_validator)(stream_endpoint, event, size);
363         *subevent_field = avdtp_subevent_id;
364     }
365     return error;
366 }
367 
368 void a2dp_sink_register_media_config_validator(uint8_t (*callback)(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size)){
369     a2dp_sink_media_config_validator = callback;
370     avdtp_sink_register_media_config_validator(&a2dp_sink_media_config_validator_callback);
371 }
372