xref: /btstack/src/classic/a2dp_sink.c (revision 77fc16ac1cd75d5c4040068fe473d4ee8878d298)
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 #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 void a2dp_sink_disconnect(uint16_t a2dp_cid){
211     avdtp_disconnect(a2dp_cid);
212 }
213 
214 static void a2dp_sink_packet_handler_internal(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
215     UNUSED(channel);
216     UNUSED(size);
217 
218     uint8_t status;
219     uint8_t local_seid;
220     uint8_t signal_identifier;
221     bool reconfigure;
222     uint8_t subevent_id;
223 
224     if (packet_type != HCI_EVENT_PACKET) return;
225     if (hci_event_packet_get_type(packet) != HCI_EVENT_AVDTP_META) return;
226 
227     switch (packet[2]){
228         case AVDTP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED:
229             if (a2dp_sink_stream_endpoint_configured) return;
230 
231             status = avdtp_subevent_signaling_connection_established_get_status(packet);
232             if (status != ERROR_CODE_SUCCESS){
233                 // only care for outgoing connections
234                 if (!a2dp_sink_outgoing_active) break;
235                 a2dp_sink_outgoing_active = false;
236                 a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED);
237                 log_info("A2DP sink signaling connection failed status %d", status);
238                 break;
239             }
240 
241             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_ESTABLISHED);
242             log_info("A2DP sink signaling connection established avdtp_cid 0x%02x", avdtp_subevent_signaling_connection_established_get_avdtp_cid(packet));
243             break;
244 
245         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_SBC_CONFIGURATION:
246         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_MPEG_AUDIO_CONFIGURATION:
247         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_MPEG_AAC_CONFIGURATION:
248         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_ATRAC_CONFIGURATION:
249         case AVDTP_SUBEVENT_SIGNALING_MEDIA_CODEC_OTHER_CONFIGURATION:
250             reconfigure = avdtp_subevent_signaling_media_codec_other_configuration_get_reconfigure(packet) != 0;
251             // accept configure if not configured and reconfigure if already configured
252             if (a2dp_sink_stream_endpoint_configured != reconfigure) break;
253             a2dp_sink_stream_endpoint_configured = true;
254             a2dp_sink_cid = avdtp_subevent_signaling_media_codec_other_capability_get_avdtp_cid(packet);
255             subevent_id = a2dp_subevent_id_for_avdtp_subevent_id(packet[2]);
256             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, subevent_id);
257             break;
258 
259         case AVDTP_SUBEVENT_STREAMING_CONNECTION_ESTABLISHED:
260             if (a2dp_sink_stream_endpoint_configured == false) break;
261             if (a2dp_sink_cid != avdtp_subevent_streaming_connection_established_get_avdtp_cid(packet)) break;
262 
263             // about to notify client
264             a2dp_sink_outgoing_active = false;
265             status = avdtp_subevent_streaming_connection_established_get_status(packet);
266             if (status != ERROR_CODE_SUCCESS){
267                 log_info("A2DP sink streaming connection could not be established, avdtp_cid 0x%02x, status 0x%02x ---", a2dp_sink_cid, status);
268                 a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_ESTABLISHED);
269                 break;
270             }
271 
272             log_info("A2DP streaming connection established --- avdtp_cid 0x%02x, local seid %d, remote seid %d", a2dp_sink_cid,
273                 avdtp_subevent_streaming_connection_established_get_local_seid(packet),
274                 avdtp_subevent_streaming_connection_established_get_remote_seid(packet));
275 
276             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_ESTABLISHED);
277             break;
278 
279         case AVDTP_SUBEVENT_SIGNALING_ACCEPT:
280             if (a2dp_sink_stream_endpoint_configured == false) break;
281             if (a2dp_sink_cid != avdtp_subevent_signaling_accept_get_avdtp_cid(packet)) break;
282 
283             signal_identifier = avdtp_subevent_signaling_accept_get_signal_identifier(packet);
284             local_seid = avdtp_subevent_signaling_accept_get_local_seid(packet);
285 
286             switch (signal_identifier){
287                 case  AVDTP_SI_START:
288                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_STARTED);
289                     break;
290                 case AVDTP_SI_SUSPEND:
291                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_SUSPENDED);
292                     break;
293                 case AVDTP_SI_ABORT:
294                 case AVDTP_SI_CLOSE:
295                     a2dp_emit_stream_event(a2dp_sink_packet_handler_user, a2dp_sink_cid, local_seid, A2DP_SUBEVENT_STREAM_STOPPED);
296                     break;
297                 default:
298                     break;
299             }
300             break;
301 
302         case AVDTP_SUBEVENT_SIGNALING_REJECT:
303             if (a2dp_sink_stream_endpoint_configured == false) break;
304             if (a2dp_sink_cid != avdtp_subevent_signaling_reject_get_avdtp_cid(packet)) break;
305 
306             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_COMMAND_REJECTED);
307             break;
308 
309         case AVDTP_SUBEVENT_SIGNALING_GENERAL_REJECT:
310             if (a2dp_sink_stream_endpoint_configured == false) break;
311             if (a2dp_sink_cid != avdtp_subevent_signaling_general_reject_get_avdtp_cid(packet)) break;
312 
313             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_COMMAND_REJECTED);
314             break;
315 
316         case AVDTP_SUBEVENT_STREAMING_CONNECTION_RELEASED:
317             if (a2dp_sink_stream_endpoint_configured == false) break;
318             if (a2dp_sink_cid != avdtp_subevent_streaming_connection_released_get_avdtp_cid(packet)) break;
319 
320             a2dp_sink_stream_endpoint_configured = false;
321 
322             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_STREAM_RELEASED);
323             break;
324 
325         case AVDTP_SUBEVENT_SIGNALING_CONNECTION_RELEASED:
326             if (a2dp_sink_cid != avdtp_subevent_signaling_connection_released_get_avdtp_cid(packet)) break;
327 
328             a2dp_sink_stream_endpoint_configured = false;
329             a2dp_sink_outgoing_active = false;
330 
331             a2dp_replace_subevent_id_and_emit_cmd(a2dp_sink_packet_handler_user, packet, size, A2DP_SUBEVENT_SIGNALING_CONNECTION_RELEASED);
332             break;
333         default:
334             break;
335     }
336 
337 }
338 
339 static uint8_t a2dp_sink_media_config_validator_callback(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size){
340     uint8_t error = 0;
341     if (a2dp_sink_media_config_validator != NULL) {
342         // update subevent id and call validator
343         uint8_t avdtp_subevent_id = event[2];
344         uint8_t a2dp_subevent_id = a2dp_subevent_id_for_avdtp_subevent_id(avdtp_subevent_id);
345         uint8_t * subevent_field = (uint8_t *) &event[2];
346         *subevent_field = a2dp_subevent_id;
347         error = (*a2dp_sink_media_config_validator)(stream_endpoint, event, size);
348         *subevent_field = avdtp_subevent_id;
349     }
350     return error;
351 }
352 
353 void a2dp_sink_register_media_config_validator(uint8_t (*callback)(const avdtp_stream_endpoint_t * stream_endpoint, const uint8_t * event, uint16_t size)){
354     a2dp_sink_media_config_validator = callback;
355     avdtp_sink_register_media_config_validator(&a2dp_sink_media_config_validator_callback);
356 }
357