xref: /btstack/src/classic/avrcp_browsing_target.c (revision 9ea49f801ca9d49a65636d9ce376c8a09ffa18c0)
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__ "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[300];
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->cmd_operands[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[10];
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->attr_bitmap);
104     pos += 4;
105     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
106 }
107 
108 static void avrcp_browsing_target_emit_get_total_num_items(btstack_packet_handler_t callback, uint16_t browsing_cid, avrcp_browsing_connection_t * connection){
109     btstack_assert(callback != NULL);
110 
111     uint8_t event[10];
112     int pos = 0;
113     event[pos++] = HCI_EVENT_AVRCP_META;
114     event[pos++] = sizeof(event) - 2;
115     event[pos++] = AVRCP_SUBEVENT_BROWSING_GET_TOTAL_NUM_ITEMS;
116     little_endian_store_16(event, pos, browsing_cid);
117     pos += 2;
118     event[pos++] = connection->scope;
119     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
120 }
121 
122 static void avrcp_browsing_target_emit_set_browsed_player(btstack_packet_handler_t callback, uint16_t browsing_cid, uint16_t browsed_player_id){
123     btstack_assert(callback != NULL);
124 
125     uint8_t event[10];
126     int pos = 0;
127     event[pos++] = HCI_EVENT_AVRCP_META;
128     event[pos++] = sizeof(event) - 2;
129     event[pos++] = AVRCP_SUBEVENT_BROWSING_SET_BROWSED_PLAYER;
130     little_endian_store_16(event, pos, browsing_cid);
131     pos += 2;
132     little_endian_store_16(event, pos, browsed_player_id);
133     pos += 2;
134     (*callback)(HCI_EVENT_PACKET, 0, event, sizeof(event));
135 }
136 
137 
138 static void avrcp_browsing_target_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
139     UNUSED(size);
140     avrcp_browsing_connection_t * browsing_connection;
141 
142     switch (packet_type) {
143         case L2CAP_DATA_PACKET:{
144             browsing_connection = avrcp_get_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
145             if (!browsing_connection) break;
146             int pos = 0;
147             uint8_t transport_header = packet[pos++];
148             // Transaction label | Packet_type | C/R | IPID (1 == invalid profile identifier)
149             browsing_connection->transaction_label = transport_header >> 4;
150             avrcp_packet_type_t avctp_packet_type = (transport_header & 0x0F) >> 2;
151             switch (avctp_packet_type){
152                 case AVRCP_SINGLE_PACKET:
153                 case AVRCP_START_PACKET:
154                     browsing_connection->subunit_type = packet[pos++] >> 2;
155                     browsing_connection->subunit_id = 0;
156                     browsing_connection->command_opcode = packet[pos++];
157                     browsing_connection->num_packets = 1;
158                     if (avctp_packet_type == AVRCP_START_PACKET){
159                         browsing_connection->num_packets = packet[pos++];
160                     }
161                     browsing_connection->pdu_id = packet[pos++];
162                     break;
163                 default:
164                     break;
165             }
166             switch (avctp_packet_type){
167                 case AVRCP_SINGLE_PACKET:
168                 case AVRCP_END_PACKET:
169                     switch(browsing_connection->pdu_id){
170                         case AVRCP_PDU_ID_GET_FOLDER_ITEMS:
171                             browsing_connection->scope = packet[pos++];
172                             browsing_connection->start_item = big_endian_read_32(packet, pos);
173                             pos += 4;
174                             browsing_connection->end_item = big_endian_read_32(packet, pos);
175                             pos += 4;
176                             uint8_t attr_count = packet[pos++];
177 
178                             while (attr_count){
179                                 uint32_t attr_id = big_endian_read_32(packet, pos);
180                                 pos += 4;
181                                 browsing_connection->attr_bitmap |= (1 << attr_id);
182                                 attr_count--;
183                             }
184                             avrcp_browsing_target_emit_get_folder_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
185                             break;
186                         case AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS:{
187                             // send total num items
188                             browsing_connection->scope = packet[pos++];
189                             avrcp_browsing_target_emit_get_total_num_items(avrcp_target_context.browsing_avrcp_callback, channel, browsing_connection);
190                             break;
191                         }
192                         case AVRCP_PDU_ID_SET_BROWSED_PLAYER:
193                             // param length (2), player_id (2)
194                             if (big_endian_read_16(packet, pos) != 2){
195                                 avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
196                                 break;
197                             }
198                             avrcp_browsing_target_emit_set_browsed_player(avrcp_target_context.browsing_avrcp_callback, channel, big_endian_read_16(packet, pos+2));
199                             break;
200                         default:
201                             avrcp_browsing_target_response_general_reject(browsing_connection, AVRCP_STATUS_INVALID_COMMAND);
202                             log_info("not parsed pdu ID 0x%02x", browsing_connection->pdu_id);
203                             break;
204                     }
205                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
206                     break;
207                 default:
208                     break;
209             }
210             break;
211         }
212 
213         case HCI_EVENT_PACKET:
214             switch (hci_event_packet_get_type(packet)){
215                 case L2CAP_EVENT_CAN_SEND_NOW:
216                     browsing_connection = avrcp_get_browsing_connection_for_l2cap_cid_for_role(AVRCP_TARGET, channel);
217                     if (browsing_connection->state != AVCTP_W2_SEND_RESPONSE) return;
218                     browsing_connection->state = AVCTP_CONNECTION_OPENED;
219                     avrcp_browsing_target_handle_can_send_now(browsing_connection);
220                     break;
221                 default:
222                     break;
223             }
224             break;
225 
226         default:
227             break;
228     }
229 }
230 
231 void avrcp_browsing_target_init(void){
232     avrcp_target_context.browsing_packet_handler = avrcp_browsing_target_packet_handler;
233     avrcp_browsing_register_target_packet_handler(avrcp_browsing_target_packet_handler);
234 }
235 
236 void avrcp_browsing_target_deinit(void){
237     avrcp_controller_context.browsing_packet_handler = NULL;
238 }
239 
240 void avrcp_browsing_target_register_packet_handler(btstack_packet_handler_t callback){
241     btstack_assert(callback != NULL);
242     avrcp_target_context.browsing_avrcp_callback = callback;
243 }
244 
245 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){
246     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
247     if (!avrcp_connection){
248         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
249         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
250     }
251 
252     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
253     if (!connection){
254         log_info("Could not find a browsing connection.");
255         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
256     }
257     if (connection->state != AVCTP_CONNECTION_OPENED) return ERROR_CODE_COMMAND_DISALLOWED;
258 
259     // TODO: handle response to SetAddressedPlayer
260 
261     uint16_t pos = 0;
262     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_FOLDER_ITEMS;
263     big_endian_store_16(connection->cmd_operands, pos, attr_list_size);
264     pos += 2;
265 
266     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
267     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
268     pos += 2;
269 
270     // TODO: fragmentation
271     if (attr_list_size >  sizeof(connection->cmd_operands)){
272         connection->attr_list = attr_list;
273         connection->attr_list_size = attr_list_size;
274         log_info(" todo: list too big, invoke fragmentation");
275         return 1;
276     }
277     (void)memcpy(&connection->cmd_operands[pos], attr_list, attr_list_size);
278     pos += attr_list_size;
279     connection->cmd_operands_length = pos;
280 
281     connection->state = AVCTP_W2_SEND_RESPONSE;
282     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
283     return ERROR_CODE_SUCCESS;
284 }
285 
286 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){
287     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
288     if (!avrcp_connection){
289         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
290         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
291     }
292 
293     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
294     if (!connection){
295         log_info("Could not find a browsing connection.");
296         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
297     }
298 
299     if (connection->state != AVCTP_CONNECTION_OPENED) {
300         log_info("Browsing connection wrong state.");
301         return ERROR_CODE_COMMAND_DISALLOWED;
302     }
303 
304     connection->browsed_player_id = browsed_player_id;
305 
306     uint16_t pos = 0;
307     connection->cmd_operands[pos++] = AVRCP_PDU_ID_SET_BROWSED_PLAYER;
308     big_endian_store_16(connection->cmd_operands, pos, response_size + 2 + 1); // uuid counter + status
309     pos += 2;
310 
311     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
312     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
313     pos += 2;
314 
315     // TODO: fragmentation
316     if (response_size >  sizeof(connection->cmd_operands)){
317         connection->attr_list = response;
318         connection->attr_list_size = response_size;
319         log_info(" todo: list too big, invoke fragmentation");
320         return 1;
321     }
322 
323     (void)memcpy(&connection->cmd_operands[pos], response, response_size);
324     pos += response_size;
325     connection->cmd_operands_length = pos;
326 
327     connection->state = AVCTP_W2_SEND_RESPONSE;
328     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
329     return ERROR_CODE_SUCCESS;
330 }
331 
332 uint8_t avrcp_browsing_target_send_reject_set_browsed_player(uint16_t avrcp_browsing_cid, avrcp_status_code_t status){
333     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
334     if (!avrcp_connection){
335         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
336         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
337     }
338 
339     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
340     if (!connection){
341         log_info("Could not find a browsing connection.");
342         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
343     }
344 
345     if (connection->state != AVCTP_CONNECTION_OPENED) {
346         log_info("Browsing connection wrong state.");
347         return ERROR_CODE_COMMAND_DISALLOWED;
348     }
349 
350     int pos = 0;
351     connection->cmd_operands[pos++] = AVRCP_PDU_ID_SET_BROWSED_PLAYER;
352     big_endian_store_16(connection->cmd_operands, pos, 1);
353     connection->cmd_operands[pos++] = status;
354     connection->cmd_operands_length = pos;
355 
356     connection->state = AVCTP_W2_SEND_RESPONSE;
357     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
358     return ERROR_CODE_SUCCESS;
359 }
360 
361 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){
362     avrcp_connection_t * avrcp_connection = avrcp_get_connection_for_browsing_cid_for_role(AVRCP_TARGET, avrcp_browsing_cid);
363     if (!avrcp_connection){
364         log_error("Could not find an AVRCP Target connection for browsing_cid 0x%02x.", avrcp_browsing_cid);
365         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
366     }
367 
368     avrcp_browsing_connection_t * connection = avrcp_connection->browsing_connection;
369     if (!connection){
370         log_info("Could not find a browsing connection.");
371         return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER;
372     }
373 
374     if (connection->state != AVCTP_CONNECTION_OPENED) {
375         log_info("Browsing connection wrong state.");
376         return ERROR_CODE_COMMAND_DISALLOWED;
377     }
378 
379     int pos = 0;
380     connection->cmd_operands[pos++] = AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS;
381     big_endian_store_16(connection->cmd_operands, pos, 7);
382     pos += 2;
383     connection->cmd_operands[pos++] = AVRCP_STATUS_SUCCESS;
384     big_endian_store_16(connection->cmd_operands, pos, uid_counter);
385     pos += 2;
386     big_endian_store_32(connection->cmd_operands, pos, total_num_items);
387     pos += 4;
388     connection->cmd_operands_length = pos;
389 
390     connection->state = AVCTP_W2_SEND_RESPONSE;
391     avrcp_browsing_request_can_send_now(connection, connection->l2cap_browsing_cid);
392     return ERROR_CODE_SUCCESS;
393 }
394 
395