xref: /btstack/src/classic/avrcp_browsing_target.c (revision 19c436db875f03f4914a890fe707000d7dd8fcf0)
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__ "avrcp_browsing_target.c"
39 
40 #include <stdint.h>
41 #include <string.h>
42 #include <inttypes.h>
43 #include "classic/avrcp.h"
44 #include "classic/avrcp_browsing.h"
45 #include "classic/avrcp_browsing_target.h"
46 #include "classic/avrcp_target.h"
47 #include "classic/avrcp_controller.h"
48 
49 #include "bluetooth_sdp.h"
50 #include "btstack_debug.h"
51 #include "btstack_event.h"
52 
53 static void avrcp_browsing_target_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
54 
55 static int avrcp_browsing_target_handle_can_send_now(avrcp_browsing_connection_t * connection){
56     int pos = 0;
57 
58     // l2cap_reserve_packet_buffer();
59     // uint8_t * packet = l2cap_get_outgoing_buffer();
60     uint8_t packet[400];
61     connection->packet_type = AVRCP_SINGLE_PACKET;
62 
63     packet[pos++] = (connection->transaction_label << 4) | (connection->packet_type << 2) | (AVRCP_RESPONSE_FRAME << 1) | 0;
64     // Profile IDentifier (PID)
65     packet[pos++] = BLUETOOTH_SERVICE_CLASS_AV_REMOTE_CONTROL >> 8;
66     packet[pos++] = BLUETOOTH_SERVICE_CLASS_AV_REMOTE_CONTROL & 0x00FF;
67     (void)memcpy(packet + pos, connection->cmd_operands,
68                  connection->cmd_operands_length);
69 
70     pos += connection->cmd_operands_length;
71     connection->wait_to_send = false;
72     // return l2cap_send_prepared(connection->l2cap_browsing_cid, pos);
73     return l2cap_send(connection->l2cap_browsing_cid, packet, pos);
74 }
75 
76 
77 static uint8_t avrcp_browsing_target_response_general_reject(avrcp_browsing_connection_t * connection, avrcp_status_code_t status){
78     // AVRCP_CTYPE_RESPONSE_REJECTED
79     int pos = 0;
80     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GENERAL_REJECT;
81     // connection->message_body[pos++] = 0;
82     // param length
83     big_endian_store_16(connection->cmd_operands, pos, 1);
84     pos += 2;
85     connection->cmd_operands[pos++] = status;
86     connection->cmd_operands_length = 4;
87     connection->state = AVCTP_W2_SEND_RESPONSE;
88     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
89     return ERROR_CODE_SUCCESS;
90 }
91 
92 static void avrcp_browsing_target_emit_get_folder_items(btstack_packet_handler_t callback, uint16_t browsing_cid, avrcp_browsing_connection_t * connection){
93     btstack_assert(callback != NULL);
94 
95     uint8_t event[18];
96     int pos = 0;
97     event[pos++] = HCI_EVENT_AVRCP_META;
98     event[pos++] = sizeof(event) - 2;
99     event[pos++] = AVRCP_SUBEVENT_BROWSING_GET_FOLDER_ITEMS;
100     little_endian_store_16(event, pos, browsing_cid);
101     pos += 2;
102     event[pos++] = connection->scope;
103     big_endian_store_32(event, pos, connection->start_item);
104     pos += 4;
105     big_endian_store_32(event, pos, connection->end_item);
106     pos += 4;
107     big_endian_store_32(event, pos, connection->attr_bitmap);
108     pos += 4;
109     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
110 }
111 
112 static void avrcp_browsing_target_emit_get_total_num_items(btstack_packet_handler_t callback, uint16_t browsing_cid, avrcp_browsing_connection_t * connection){
113     btstack_assert(callback != NULL);
114 
115     uint8_t event[10];
116     int pos = 0;
117     event[pos++] = HCI_EVENT_AVRCP_META;
118     event[pos++] = sizeof(event) - 2;
119     event[pos++] = AVRCP_SUBEVENT_BROWSING_GET_TOTAL_NUM_ITEMS;
120     little_endian_store_16(event, pos, browsing_cid);
121     pos += 2;
122     event[pos++] = connection->scope;
123     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
124 }
125 
126 static void avrcp_browsing_target_emit_set_browsed_player(btstack_packet_handler_t callback, uint16_t browsing_cid, uint16_t browsed_player_id){
127     btstack_assert(callback != NULL);
128 
129     uint8_t event[10];
130     int pos = 0;
131     event[pos++] = HCI_EVENT_AVRCP_META;
132     event[pos++] = sizeof(event) - 2;
133     event[pos++] = AVRCP_SUBEVENT_BROWSING_SET_BROWSED_PLAYER;
134     little_endian_store_16(event, pos, browsing_cid);
135     pos += 2;
136     little_endian_store_16(event, pos, browsed_player_id);
137     pos += 2;
138     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
139 }
140 
141 
142 static void avrcp_browsing_target_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
143     UNUSED(size);
144     avrcp_browsing_connection_t * browsing_connection;
145 
146     switch (packet_type) {
147         case L2CAP_DATA_PACKET:{
148             browsing_connection = avrcp_get_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
149             if (!browsing_connection) break;
150             int pos = 0;
151             uint8_t transport_header = packet[pos++];
152             // Transaction label | Packet_type | C/R | IPID (1 == invalid profile identifier)
153             browsing_connection->transaction_label = transport_header >> 4;
154             avctp_packet_type_t avctp_packet_type = (avctp_packet_type_t)((transport_header & 0x0F) >> 2);
155             switch (avctp_packet_type){
156                 case AVCTP_SINGLE_PACKET:
157                 case AVCTP_START_PACKET:
158                     browsing_connection->subunit_type = packet[pos++] >> 2;
159                     browsing_connection->subunit_id = 0;
160                     browsing_connection->command_opcode = packet[pos++];
161                     browsing_connection->num_packets = 1;
162                     if (avctp_packet_type == AVCTP_START_PACKET){
163                         browsing_connection->num_packets = packet[pos++];
164                     }
165                     browsing_connection->pdu_id = packet[pos++];
166                     uint16_t parameter_length = big_endian_read_16(packet, pos);
167                     pos += 2;
168 
169                     switch(browsing_connection->pdu_id){
170                         case AVRCP_PDU_ID_GET_FOLDER_ITEMS:
171                             if (parameter_length < 10){
172                                 avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
173                                 break;
174                             }
175 
176                             browsing_connection->scope = packet[pos++];
177                             browsing_connection->start_item = big_endian_read_32(packet, pos);
178                             pos += 4;
179                             browsing_connection->end_item = big_endian_read_32(packet, pos);
180                             pos += 4;
181                             uint8_t attr_count = packet[pos++];
182                             browsing_connection->attr_bitmap = 0;
183 
184                             while (attr_count){
185                                 uint32_t attr_id = big_endian_read_32(packet, pos);
186                                 pos += 4;
187                                 browsing_connection->attr_bitmap |= (1 << attr_id);
188                                 attr_count--;
189                             }
190                             avrcp_browsing_target_emit_get_folder_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
191                             break;
192                         case AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS:{
193                             // send total num items
194                             if (parameter_length != 1){
195                                 avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_SCOPE);
196                                 break;
197                             }
198 
199                             browsing_connection->scope = packet[pos++];
200                             avrcp_browsing_target_emit_get_total_num_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
201                             break;
202                         }
203                         case AVRCP_PDU_ID_SET_BROWSED_PLAYER:
204                             // player_id (2)
205                             if (parameter_length != 2){
206                                 avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
207                                 break;
208                             }
209 
210                             if ( (pos + 2) > size ){
211                                 avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_PLAYER_ID);
212                                 break;
213                             }
214 
215                             avrcp_browsing_target_emit_set_browsed_player(avrcp_target_context.browsing_avrcp_callback, channel, big_endian_read_16(packet, pos));
216                             break;
217                         default:
218                             avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
219                             log_info("not parsed pdu ID 0x%02x", browsing_connection->pdu_id);
220                             break;
221                     }
222                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
223                     break;
224                 default:
225                     break;
226             }
227             break;
228         }
229 
230         case HCI_EVENT_PACKET:
231             switch (hci_event_packet_get_type(packet)){
232                 case L2CAP_EVENT_CAN_SEND_NOW:
233                     browsing_connection = avrcp_get_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
234                     if (browsing_connection->state != AVCTP_W2_SEND_RESPONSE) return;
235                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
236                     avrcp_browsing_target_handle_can_send_now(browsing_connection);
237                     break;
238                 default:
239                     break;
240             }
241             break;
242 
243         default:
244             break;
245     }
246 }
247 
248 void avrcp_browsing_target_init(void){
249     avrcp_target_context.browsing_packet_handler = avrcp_browsing_target_packet_handler;
250     avrcp_browsing_register_target_packet_handler(avrcp_browsing_target_packet_handler);
251 }
252 
253 void avrcp_browsing_target_deinit(void){
254     avrcp_controller_context.browsing_packet_handler = NULL;
255 }
256 
257 void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t callback){
258     btstack_assert(callback != NULL);
259     avrcp_target_context.browsing_avrcp_callback = callback;
260 }
261 
262 uint8_t avrcp_browsing_target_send_get_folder_items_response(uint16_t avrcp_browsing_cid, uint16_t uid_counter, uint8_t * attr_list, uint16_t attr_list_size, uint16_t num_items){
263     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
264     if (!avrcp_connection){
265         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
266         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
267     }
268 
269     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
270     if (!connection){
271         log_info("Could not find a browsing connection.");
272         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
273     }
274     if (connection->state != AVCTP_CONNECTION_OPENED){
275         return ERROR_CODE_COMMAND_DISALLOWED;
276     }
277 
278     // TODO: handle response to SetAddressedPlayer
279 
280     uint16_t pos = 0;
281     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_FOLDER_ITEMS;
282     uint8_t param_length = 5;
283     uint8_t param_length_pos = pos;
284     pos += 2;
285 
286     avrcp_status_code_t status = AVRCP_STATUS_SUCCESS;
287     uint8_t status_pos = pos;
288     pos++;
289 
290     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
291     pos += 2;
292 
293     // TODO: fragmentation
294     if (attr_list_size >  sizeof(connection->cmd_operands)){
295         connection->attr_list = attr_list;
296         connection->attr_list_size = attr_list_size;
297         log_info(" todo: list too big, invoke fragmentation");
298         return 1;
299     }
300 
301     uint16_t items_byte_len = 0;
302     if (connection->start_item < num_items) {
303         if (connection->end_item < num_items) {
304             items_byte_len =  connection->end_item - connection->start_item + 1;
305         } else {
306             items_byte_len = num_items - connection->start_item;
307         }
308 
309     } else {
310         big_endian_store_16(connection->cmd_operands, pos, 0);
311         pos += 2;
312     }
313     big_endian_store_16(connection->cmd_operands, pos, items_byte_len);
314     pos += 2;
315     param_length += items_byte_len;
316 
317     if (items_byte_len > 0){
318         (void)memcpy(&connection->cmd_operands[pos], attr_list, attr_list_size);
319         pos += attr_list_size;
320     } else {
321         status = AVRCP_STATUS_RANGE_OUT_OF_BOUNDS;
322     }
323 
324     big_endian_store_16(connection->cmd_operands, param_length_pos, param_length);
325     connection->cmd_operands[status_pos] = status;
326 
327     btstack_assert(pos <= 400);
328     connection->cmd_operands_length = pos;
329 
330     connection->state = AVCTP_W2_SEND_RESPONSE;
331     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
332     return ERROR_CODE_SUCCESS;
333 }
334 
335 uint8_t avrcp_browsing_target_send_accept_set_browsed_player(uint16_t avrcp_browsing_cid, uint16_t uid_counter, uint16_t browsed_player_id, uint8_t * response, uint16_t response_size){
336     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
337     if (!avrcp_connection){
338         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
339         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
340     }
341 
342     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
343     if (!connection){
344         log_info("Could not find a browsing connection.");
345         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
346     }
347 
348     if (connection->state != AVCTP_CONNECTION_OPENED) {
349         log_info("Browsing connection wrong state.");
350         return ERROR_CODE_COMMAND_DISALLOWED;
351     }
352 
353     connection->browsed_player_id = browsed_player_id;
354 
355     uint16_t pos = 0;
356     connection->cmd_operands[pos++] = AVRCP_PDU_ID_SET_BROWSED_PLAYER;
357     big_endian_store_16(connection->cmd_operands, pos, response_size + 2 + 1); // uuid counter + status
358     pos += 2;
359 
360     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
361     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
362     pos += 2;
363 
364     // TODO: fragmentation
365     if (response_size >  sizeof(connection->cmd_operands)){
366         connection->attr_list = response;
367         connection->attr_list_size = response_size;
368         log_info(" todo: list too big, invoke fragmentation");
369         return 1;
370     }
371 
372     (void)memcpy(&connection->cmd_operands[pos], response, response_size);
373     pos += response_size;
374 	btstack_assert(pos <= 255);
375     connection->cmd_operands_length = (uint8_t) pos;
376 
377     connection->state = AVCTP_W2_SEND_RESPONSE;
378     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
379     return ERROR_CODE_SUCCESS;
380 }
381 
382 uint8_t avrcp_browsing_target_send_reject_set_browsed_player(uint16_t avrcp_browsing_cid, avrcp_status_code_t status){
383     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
384     if (!avrcp_connection){
385         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
386         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
387     }
388 
389     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
390     if (!connection){
391         log_info("Could not find a browsing connection.");
392         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
393     }
394 
395     if (connection->state != AVCTP_CONNECTION_OPENED) {
396         log_info("Browsing connection wrong state.");
397         return ERROR_CODE_COMMAND_DISALLOWED;
398     }
399 
400     int pos = 0;
401     connection->cmd_operands[pos++] = AVRCP_PDU_ID_SET_BROWSED_PLAYER;
402     big_endian_store_16(connection->cmd_operands, pos, 1);
403     pos += 2;
404     connection->cmd_operands[pos++] = status;
405     connection->cmd_operands_length = pos;
406 
407     connection->state = AVCTP_W2_SEND_RESPONSE;
408     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
409     return ERROR_CODE_SUCCESS;
410 }
411 
412 uint8_t avrcp_browsing_target_send_get_total_num_items_response(uint16_t avrcp_browsing_cid, uint16_t uid_counter, uint32_t total_num_items){
413     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
414     if (!avrcp_connection){
415         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
416         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
417     }
418 
419     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
420     if (!connection){
421         log_info("Could not find a browsing connection.");
422         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
423     }
424 
425     if (connection->state != AVCTP_CONNECTION_OPENED) {
426         log_info("Browsing connection wrong state.");
427         return ERROR_CODE_COMMAND_DISALLOWED;
428     }
429 
430     int pos = 0;
431     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS;
432     big_endian_store_16(connection->cmd_operands, pos, 7);
433     pos += 2;
434     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
435     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
436     pos += 2;
437     big_endian_store_32(connection->cmd_operands, pos, total_num_items);
438     pos += 4;
439     connection->cmd_operands_length = pos;
440 
441     connection->state = AVCTP_W2_SEND_RESPONSE;
442     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
443     return ERROR_CODE_SUCCESS;
444 }
445 
446