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_client.c" 39 40 /* 41 * avrcp_browsing_client.c 42 */ 43 44 // ***************************************************************************** 45 /* EXAMPLE_START(avrcp_browsing_client): Browse media players and media information on a remote device. 46 * 47 * @text This example demonstrates how to use the AVRCP Controller Browsing service to 48 * browse madia players and media information on a remote AVRCP Source device. 49 * 50 * @test To test with a remote device, e.g. a mobile phone, 51 * pair from the remote device with the demo, then use the UI for browsing (tap 52 * SPACE on the console to show the available AVRCP commands). 53 * 54 */ 55 // ***************************************************************************** 56 57 #include <stdint.h> 58 #include <inttypes.h> 59 #include <stdio.h> 60 #include <stdlib.h> 61 #include <string.h> 62 63 #include "btstack.h" 64 65 #ifdef HAVE_BTSTACK_STDIN 66 #include "btstack_stdin.h" 67 #endif 68 69 #define AVRCP_BROWSING_MAX_PLAYERS 10 70 #define AVRCP_BROWSING_MAX_FOLDERS 10 71 #define AVRCP_BROWSING_MAX_FOLDER_NAME_LEN 30 72 73 #ifdef HAVE_BTSTACK_STDIN 74 // mac 2011: static bd_addr_t remote = {0x04, 0x0C, 0xCE, 0xE4, 0x85, 0xD3}; 75 // pts: static bd_addr_t remote = {0x00, 0x1B, 0xDC, 0x08, 0x0A, 0xA5}; 76 // mac 2013: 77 // static const char * device_addr_string = "84:38:35:65:d1:15"; 78 // iPhone 5S: static const char * device_addr_string = "54:E4:3A:26:A2:39"; 79 // phone 2013: 80 static const char * device_addr_string = "D8:BB:2C:DF:F1:08"; 81 static bd_addr_t device_addr; 82 #endif 83 84 static uint16_t avrcp_cid = 0; 85 static uint8_t avrcp_connected = 0; 86 87 static uint16_t browsing_cid = 0; 88 static uint8_t avrcp_browsing_connected = 0; 89 static uint8_t sdp_avrcp_browsing_controller_service_buffer[200]; 90 91 static uint8_t browsing_query_active = 0; 92 static avrcp_media_item_context_t media_item_context; 93 94 typedef struct { 95 uint16_t charset; 96 uint8_t depth; 97 uint16_t name_len; 98 char name[AVRCP_BROWSING_MAX_FOLDER_NAME_LEN]; 99 } avrcp_browsing_root_folder_t; 100 101 typedef struct { 102 uint8_t uid[8]; 103 uint16_t name_len; 104 char name[AVRCP_BROWSING_MAX_FOLDER_NAME_LEN]; 105 } avrcp_browsing_folders_t; 106 107 static uint8_t parent_folder_set = 0; 108 static uint8_t parent_folder_uid[8]; 109 static char parent_folder_name[AVRCP_BROWSING_MAX_FOLDER_NAME_LEN]; 110 static avrcp_browsing_folders_t folders[AVRCP_BROWSING_MAX_FOLDERS]; 111 static int folder_index = -1; 112 static uint16_t players[AVRCP_BROWSING_MAX_PLAYERS]; 113 static int player_index = -1; 114 115 static btstack_packet_callback_registration_t hci_event_callback_registration; 116 117 static uint8_t ertm_buffer[10000]; 118 static l2cap_ertm_config_t ertm_config = { 119 1, // ertm mandatory 120 2, // max transmit, some tests require > 1 121 2000, 122 12000, 123 144, // l2cap ertm mtu 124 4, 125 4, 126 }; 127 128 129 static inline int next_index(int * index, int max_value){ 130 if ((*index) < max_value){ 131 (*index)++; 132 } else { 133 (*index) = 0; 134 } 135 return (*index); 136 } 137 138 static int next_folder_index(){ 139 return next_index(&folder_index, AVRCP_BROWSING_MAX_FOLDERS); 140 } 141 142 static int next_player_index(){ 143 return next_index(&player_index, AVRCP_BROWSING_MAX_PLAYERS); 144 } 145 146 147 /* @section Main Application Setup 148 * 149 * @text The Listing MainConfiguration shows how to setup AVRCP Controller Browsing service. 150 * To announce AVRCP Controller Browsing service, you need to create corresponding 151 * SDP record and register it with the SDP service. 152 * You'll also need to register several packet handlers: 153 * - stdin_process callback - used to trigger AVRCP commands, such are get media players, playlists, albums, etc. Requires HAVE_BTSTACK_STDIN. 154 * - avrcp_browsing_controller_packet_handler - used to receive answers for AVRCP commands. 155 * 156 */ 157 158 /* LISTING_START(MainConfiguration): Setup Audio Sink and AVRCP Controller services */ 159 static void avrcp_browsing_controller_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 160 #ifdef HAVE_BTSTACK_STDIN 161 static void stdin_process(char cmd); 162 #endif 163 164 #define BROWSING_ENABLED 1 165 166 int btstack_main(int argc, const char * argv[]); 167 int btstack_main(int argc, const char * argv[]){ 168 (void)argc; 169 (void)argv; 170 171 // Initialize L2CAP. 172 l2cap_init(); 173 174 // Initialize AVRCP Controller. 175 avrcp_controller_init(); 176 177 // Initialize AVRCP Browsing Controller, HCI events will be sent to the AVRCP Controller callback. 178 avrcp_browsing_controller_init(); 179 // // Register AVRCP for HCI events. 180 // avrcp_browsing_controller_register_packet_handler(&avrcp_browsing_controller_packet_handler); 181 182 // Initialize SDP. 183 sdp_init(); 184 185 // Create AVRCP service record and register it with SDP. 186 memset(sdp_avrcp_browsing_controller_service_buffer, 0, sizeof(sdp_avrcp_browsing_controller_service_buffer)); 187 avrcp_controller_create_sdp_record(sdp_avrcp_browsing_controller_service_buffer, 0x10001, BROWSING_ENABLED, 1, NULL, NULL); 188 sdp_register_service(sdp_avrcp_browsing_controller_service_buffer); 189 190 // Set local name with a template Bluetooth address, that will be automatically 191 // replaced with a actual address once it is available, i.e. when BTstack boots 192 // up and starts talking to a Bluetooth module. 193 gap_set_local_name("AVRCP Browsing Client 00:00:00:00:00:00"); 194 gap_discoverable_control(1); 195 gap_set_class_of_device(0x200408); 196 197 // Register for HCI events. 198 hci_event_callback_registration.callback = &avrcp_browsing_controller_packet_handler; 199 hci_add_event_handler(&hci_event_callback_registration); 200 201 // Register for AVRCP events. 202 avrcp_controller_register_packet_handler(&avrcp_browsing_controller_packet_handler); 203 204 205 #ifdef HAVE_BTSTACK_STDIN 206 // Parse human readable Bluetooth address. 207 sscanf_bd_addr(device_addr_string, device_addr); 208 btstack_stdin_setup(stdin_process); 209 #endif 210 printf("Starting BTstack ...\n"); 211 hci_power_control(HCI_POWER_ON); 212 return 0; 213 } 214 /* LISTING_END */ 215 216 static void avrcp_browsing_controller_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 217 UNUSED(channel); 218 int pos; 219 220 switch(packet_type){ 221 case AVRCP_BROWSING_DATA_PACKET: 222 pos = 0; 223 browsing_query_active = 1; 224 avrcp_browsing_item_type_t data_type = (avrcp_browsing_item_type_t)packet[pos++]; 225 pos += 2; // length 226 227 switch (data_type){ 228 case AVRCP_BROWSING_MEDIA_ROOT_FOLDER:{ 229 avrcp_browsing_root_folder_t root_folder; 230 root_folder.charset = big_endian_read_16(packet, pos); 231 pos += 2; 232 root_folder.depth = packet[pos++]; 233 root_folder.name_len = big_endian_read_16(packet, pos); 234 pos += 2; 235 236 memset(root_folder.name, 0, AVRCP_BROWSING_MAX_FOLDER_NAME_LEN); 237 root_folder.name_len = btstack_min(big_endian_read_16(packet, pos), AVRCP_BROWSING_MAX_FOLDER_NAME_LEN - 1); 238 memcpy(root_folder.name, packet+pos, root_folder.name_len); 239 printf("Found root folder: name %s, depth %d \n", (char *)root_folder.name, root_folder.depth); 240 break; 241 } 242 case AVRCP_BROWSING_MEDIA_PLAYER_ITEM:{ 243 printf("Received media player: "); 244 uint16_t player_id = big_endian_read_16(packet, pos); 245 pos += 2; 246 avrcp_browsing_media_player_major_type_t major_type = packet[pos++]; 247 avrcp_browsing_media_player_subtype_t subtype = big_endian_read_32(packet, pos); 248 pos += 4; 249 uint8_t status = packet[pos++]; 250 uint8_t feature_bitmask[16]; 251 memcpy(feature_bitmask, packet, 16); 252 pos += 16; 253 printf("player ID 0x%04x, major_type %d, subtype %d, status %d\n", player_id, major_type, subtype, status); 254 players[next_player_index()] = player_id; 255 break; 256 } 257 case AVRCP_BROWSING_FOLDER_ITEM:{ 258 int index = next_folder_index(); 259 // printf("Found folder [%d]: ", index); 260 memcpy(folders[index].uid, packet+pos, 8); 261 uint32_t folder_uid_high = big_endian_read_32(packet, pos); 262 pos += 4; 263 uint32_t folder_uid_low = big_endian_read_32(packet, pos); 264 pos += 4; 265 avrcp_browsing_folder_type_t folder_type = packet[pos++]; 266 uint8_t is_playable = packet[pos++]; 267 uint16_t charset = big_endian_read_16(packet, pos); 268 pos += 2; 269 uint16_t displayable_name_length = big_endian_read_16(packet, pos); 270 pos += 2; 271 272 char value[AVRCP_BROWSING_MAX_FOLDER_NAME_LEN]; 273 274 memset(value, 0, AVRCP_BROWSING_MAX_FOLDER_NAME_LEN); 275 uint16_t value_len = btstack_min(displayable_name_length, AVRCP_BROWSING_MAX_FOLDER_NAME_LEN - 1); 276 memcpy(value, packet+pos, value_len); 277 278 printf("UID 0x%08" PRIx32 "%08" PRIx32 ", type 0x%02x, is_playable %d, charset 0x%02x, name %s\n", 279 folder_uid_high, folder_uid_low, folder_type, is_playable, charset, value); 280 memcpy(folders[index].name, value, value_len); 281 folders[index].name_len = value_len; 282 break; 283 } 284 case AVRCP_BROWSING_MEDIA_ELEMENT_ITEM:{ 285 printf("Found media: "); 286 287 uint32_t media_uid_high = big_endian_read_32(packet, pos); 288 pos += 4; 289 uint32_t media_uid_low = big_endian_read_32(packet, pos+4); 290 pos += 4; 291 avrcp_browsing_media_type_t media_type = packet[pos++]; 292 uint16_t charset = big_endian_read_16(packet, pos); 293 pos += 2; 294 uint16_t displayable_name_length = big_endian_read_16(packet, pos); 295 pos += 2; 296 pos += displayable_name_length; 297 printf("Media UID: 0x%08" PRIx32 "%08" PRIx32 ", media_type 0x%02x, charset 0x%02x, displayable_name_length %d\n", media_uid_high, media_uid_low, media_type, charset, displayable_name_length); 298 299 uint8_t num_attributes = packet[pos++]; 300 printf("Num media attributes %d\n", num_attributes); 301 302 for (avrcp_media_item_iterator_init(&media_item_context, size-pos, packet+pos); avrcp_media_item_iterator_has_more(&media_item_context); avrcp_media_item_iterator_next(&media_item_context)){ 303 uint32_t attr_id = avrcp_media_item_iterator_get_attr_id(&media_item_context); 304 uint16_t attr_charset = avrcp_media_item_iterator_get_attr_charset(&media_item_context); 305 uint16_t attr_value_length = avrcp_media_item_iterator_get_attr_value_len(&media_item_context); 306 const uint8_t * attr_value = avrcp_media_item_iterator_get_attr_value(&media_item_context); 307 308 printf("Attr ID 0x%08" PRIx32 ", charset %d, attr_value_length %d, value %s", attr_id, attr_charset, attr_value_length, attr_value); 309 } 310 break; 311 } 312 313 default: 314 log_error("AVRCP browsing: unknown browsable item type 0%02x", data_type); 315 break; 316 } 317 break; 318 case HCI_EVENT_PACKET: 319 if (hci_event_packet_get_type(packet) != HCI_EVENT_AVRCP_META) return; 320 uint16_t local_cid; 321 uint8_t status = 0xFF; 322 bd_addr_t address; 323 324 switch (packet[2]){ 325 case AVRCP_SUBEVENT_CONNECTION_ESTABLISHED: { 326 local_cid = avrcp_subevent_connection_established_get_avrcp_cid(packet); 327 if (browsing_cid != 0 && browsing_cid != local_cid) { 328 printf("AVRCP Controller connection failed, expected 0x%02X l2cap cid, received 0x%02X\n", browsing_cid, local_cid); 329 return; 330 } 331 332 status = avrcp_subevent_connection_established_get_status(packet); 333 if (status != ERROR_CODE_SUCCESS){ 334 printf("AVRCP Controller connection failed: status 0x%02x\n", status); 335 browsing_cid = 0; 336 return; 337 } 338 339 avrcp_cid = local_cid; 340 avrcp_connected = 1; 341 avrcp_subevent_connection_established_get_bd_addr(packet, address); 342 printf("AVRCP Controller connected.\n"); 343 return; 344 } 345 case AVRCP_SUBEVENT_CONNECTION_RELEASED: 346 printf("AVRCP Browsing Client released.\n"); 347 browsing_cid = 0; 348 avrcp_browsing_connected = 0; 349 folder_index = 0; 350 memset(folders, 0, sizeof(folders)); 351 return; 352 case AVRCP_SUBEVENT_BROWSING_CONNECTION_ESTABLISHED: { 353 local_cid = avrcp_subevent_browsing_connection_established_get_browsing_cid(packet); 354 if (browsing_cid != 0 && browsing_cid != local_cid) { 355 printf("AVRCP Browsing Client connection failed, expected 0x%02X l2cap cid, received 0x%02X\n", browsing_cid, local_cid); 356 return; 357 } 358 359 status = avrcp_subevent_browsing_connection_established_get_status(packet); 360 if (status != ERROR_CODE_SUCCESS){ 361 printf("AVRCP Browsing Client connection failed: status 0x%02x\n", status); 362 browsing_cid = 0; 363 return; 364 } 365 366 browsing_cid = local_cid; 367 avrcp_browsing_connected = 1; 368 avrcp_subevent_browsing_connection_established_get_bd_addr(packet, address); 369 printf("AVRCP Browsing Client connected\n"); 370 return; 371 } 372 case AVRCP_SUBEVENT_BROWSING_CONNECTION_RELEASED: 373 printf("AVRCP Browsing Client released\n"); 374 browsing_cid = 0; 375 avrcp_browsing_connected = 0; 376 return; 377 case AVRCP_SUBEVENT_BROWSING_MEDIA_ITEM_DONE: 378 browsing_query_active = 0; 379 if (avrcp_subevent_browsing_media_item_done_get_browsing_status(packet) != AVRCP_BROWSING_ERROR_CODE_SUCCESS){ 380 printf("AVRCP Browsing query done with browsing status 0x%02x, bluetooth status 0x%02x.\n", 381 avrcp_subevent_browsing_media_item_done_get_browsing_status(packet), 382 avrcp_subevent_browsing_media_item_done_get_bluetooth_status(packet)); 383 break; 384 } 385 printf("AVRCP Browsing cmd: DONE.\n"); 386 break; 387 default: 388 printf("AVRCP Browsing Client: event is not parsed\n"); 389 break; 390 } 391 break; 392 393 default: 394 break; 395 } 396 397 } 398 399 #ifdef HAVE_BTSTACK_STDIN 400 static void show_usage(void){ 401 bd_addr_t iut_address; 402 gap_local_bd_addr(iut_address); 403 printf("\n--- Bluetooth AVRCP Controller Connection Test Console %s ---\n", bd_addr_to_str(iut_address)); 404 printf("c - AVRCP Controller create connection to addr %s\n", bd_addr_to_str(device_addr)); 405 printf("e - AVRCP Browsing Controller create connection to addr %s\n", bd_addr_to_str(device_addr)); 406 printf("E - AVRCP Browsing Controller disconnect\n"); 407 printf("C - AVRCP Controller disconnect\n"); 408 409 printf("I - Set first found player as addressed player\n"); 410 printf("O - Set first found player as browsed player\n"); 411 412 printf("p - Get media players\n"); 413 printf("Q - Browse folders\n"); 414 printf("P - Go up one level\n"); 415 printf("W - Go down one level\n"); 416 printf("T - Browse media items\n"); 417 printf("---\n"); 418 } 419 #endif 420 421 422 #ifdef HAVE_BTSTACK_STDIN 423 static void stdin_process(char cmd){ 424 uint8_t status = ERROR_CODE_SUCCESS; 425 426 if (cmd != 'a' && cmd != 'A' && cmd != 'c' && cmd != 'C'){ 427 if (browsing_query_active){ 428 printf("Query active, try later!\n"); 429 return; 430 } 431 } 432 433 switch (cmd){ 434 case 'c': 435 printf(" - Create AVRCP connection for control to addr %s.\n", bd_addr_to_str(device_addr)); 436 status = avrcp_controller_connect(device_addr, &avrcp_cid); 437 break; 438 case 'C': 439 if (avrcp_connected){ 440 printf(" - AVRCP Controller disconnect from addr %s.\n", bd_addr_to_str(device_addr)); 441 status = avrcp_controller_disconnect(avrcp_cid); 442 break; 443 } 444 printf("AVRCP Controller already disconnected\n"); 445 break; 446 447 case 'e': 448 if (!avrcp_connected) { 449 printf(" You must first create AVRCP connection for control to addr %s.\n", bd_addr_to_str(device_addr)); 450 break; 451 } 452 printf(" - Create AVRCP connection for browsing to addr %s.\n", bd_addr_to_str(device_addr)); 453 status = avrcp_browsing_controller_connect(device_addr, ertm_buffer, sizeof(ertm_buffer), &ertm_config, &browsing_cid); 454 break; 455 case 'E': 456 if (avrcp_browsing_connected){ 457 printf(" - AVRCP Browsing Controller disconnect from addr %s.\n", bd_addr_to_str(device_addr)); 458 status = avrcp_browsing_controller_disconnect(browsing_cid); 459 break; 460 } 461 printf("AVRCP Browsing Controller already disconnected\n"); 462 break; 463 case '\n': 464 case '\r': 465 break; 466 467 default: 468 if (!avrcp_browsing_connected){ 469 show_usage(); 470 printf("Please connect the AVRCP Browsing client\n"); 471 break; 472 } 473 474 switch (cmd) { 475 case 'I': 476 if (player_index < 0) { 477 printf("Get media players first\n"); 478 break; 479 } 480 printf("Set addressed player\n"); 481 status = avrcp_browsing_controller_set_addressed_player(browsing_cid, players[0]); 482 break; 483 case 'O': 484 if (player_index < 0) { 485 printf("Get media players first\n"); 486 break; 487 } 488 printf("Set browsed player\n"); 489 status = avrcp_browsing_controller_set_browsed_player(browsing_cid, players[0]); 490 break; 491 case 'p': 492 printf("AVRCP Browsing: get media players\n"); 493 player_index = -1; 494 status = avrcp_browsing_controller_get_media_players(browsing_cid, 0, 0xFFFFFFFF, AVRCP_MEDIA_ATTR_ALL); 495 break; 496 case 'Q': 497 printf("AVRCP Browsing: browse folders\n"); 498 folder_index = -1; 499 status = avrcp_browsing_controller_browse_file_system(browsing_cid, 0, 0xFFFFFFFF, AVRCP_MEDIA_ATTR_ALL); 500 break; 501 case 'P': 502 printf("AVRCP Browsing: browse media items\n"); 503 avrcp_browsing_controller_browse_media(browsing_cid, 0, 0xFFFFFFFF, AVRCP_MEDIA_ATTR_ALL); 504 break; 505 case 'W': 506 printf("AVRCP Browsing: go up one level\n"); 507 status = avrcp_browsing_controller_go_up_one_level(browsing_cid); 508 folder_index = -1; 509 break; 510 case 'T': 511 if (folder_index < 0 && !parent_folder_set){ 512 printf("AVRCP Browsing: no folders available\n"); 513 break; 514 } 515 if (!parent_folder_set){ 516 parent_folder_set = 1; 517 memcpy(parent_folder_name, folders[0].name, folders[0].name_len); 518 memcpy(parent_folder_uid, folders[0].uid, 8); 519 } 520 printf("AVRCP Browsing: go down one level of %s\n", (char *)parent_folder_name); 521 status = avrcp_browsing_controller_go_down_one_level(browsing_cid, parent_folder_uid); 522 folder_index = -1; 523 break; 524 default: 525 show_usage(); 526 break; 527 } 528 break; 529 } 530 531 if (status != ERROR_CODE_SUCCESS){ 532 printf("Could not perform command, status 0x%2x\n", status); 533 } 534 } 535 #endif 536 /* EXAMPLE_END */ 537