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