1 /* 2 * Copyright (C) 2012 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_INCLUDE_BT_RC_H 18 #define ANDROID_INCLUDE_BT_RC_H 19 20 #include "types/raw_address.h" 21 __BEGIN_DECLS 22 23 /* Change this macro to use multiple RC */ 24 #define BT_RC_NUM_APP 6 25 26 /* Macros */ 27 #define BTRC_MAX_ATTR_STR_LEN (1 << 16) 28 #define BTRC_UID_SIZE 8 29 #define BTRC_MAX_APP_SETTINGS 8 30 #define BTRC_MAX_FOLDER_DEPTH 4 31 #define BTRC_MAX_APP_ATTR_SIZE 16 32 #define BTRC_MAX_ELEM_ATTR_SIZE 8 33 #define BTRC_FEATURE_BIT_MASK_SIZE 16 34 35 /* Macros for valid scopes in get_folder_items */ 36 #define BTRC_SCOPE_PLAYER_LIST 0x00 /* Media Player List */ 37 #define BTRC_SCOPE_FILE_SYSTEM 0x01 /* Virtual File System */ 38 #define BTRC_SCOPE_SEARCH 0x02 /* Search */ 39 #define BTRC_SCOPE_NOW_PLAYING 0x03 /* Now Playing */ 40 41 /* Macros for supported character encoding */ 42 #define BTRC_CHARSET_ID_UTF8 0x006A 43 44 /* Macros for item types */ 45 #define BTRC_ITEM_PLAYER 0x01 /* Media Player */ 46 #define BTRC_ITEM_FOLDER 0x02 /* Folder */ 47 #define BTRC_ITEM_MEDIA 0x03 /* Media File */ 48 49 /* Macros for media attribute IDs */ 50 #define BTRC_MEDIA_ATTR_ID_INVALID -1 51 #define BTRC_MEDIA_ATTR_ID_TITLE 0x00000001 52 #define BTRC_MEDIA_ATTR_ID_ARTIST 0x00000002 53 #define BTRC_MEDIA_ATTR_ID_ALBUM 0x00000003 54 #define BTRC_MEDIA_ATTR_ID_TRACK_NUM 0x00000004 55 #define BTRC_MEDIA_ATTR_ID_NUM_TRACKS 0x00000005 56 #define BTRC_MEDIA_ATTR_ID_GENRE 0x00000006 57 #define BTRC_MEDIA_ATTR_ID_PLAYING_TIME 0x00000007 /* in miliseconds */ 58 #define BTRC_MEDIA_ATTR_ID_COVER_ARTWORK_HANDLE 0x00000008 59 60 /* Macros for folder types */ 61 #define BTRC_FOLDER_TYPE_MIXED 0x00 62 #define BTRC_FOLDER_TYPE_TITLES 0x01 63 #define BTRC_FOLDER_TYPE_ALBUMS 0x02 64 #define BTRC_FOLDER_TYPE_ARTISTS 0x03 65 #define BTRC_FOLDER_TYPE_GENRES 0x04 66 #define BTRC_FOLDER_TYPE_PLAYLISTS 0x05 67 #define BTRC_FOLDER_TYPE_YEARS 0x06 68 69 /* Macros for media types */ 70 #define BTRC_MEDIA_TYPE_AUDIO 0x00 /* audio */ 71 #define BTRC_MEDIA_TYPE_VIDEO 0x01 /* video */ 72 73 /* Macros for num attributes */ 74 #define BTRC_NUM_ATTR_NONE 0xFF /* No attributes required */ 75 #define BTRC_NUM_ATTR_ALL 0X00 /* All attributes required */ 76 77 #define BTRC_HANDLE_NONE 0xFF 78 79 typedef uint8_t btrc_uid_t[BTRC_UID_SIZE]; 80 81 typedef enum { 82 BTRC_CONNECTION_STATE_DISCONNECTED = 0, 83 BTRC_CONNECTION_STATE_CONNECTED 84 } btrc_connection_state_t; 85 86 typedef enum { 87 BTRC_FEAT_NONE = 0x00, /* AVRCP 1.0 */ 88 BTRC_FEAT_METADATA = 0x01, /* AVRCP 1.3 */ 89 BTRC_FEAT_ABSOLUTE_VOLUME = 0x02, /* Supports TG role and volume sync */ 90 BTRC_FEAT_BROWSE = 0x04, /* AVRCP 1.4 and up, with Browsing support */ 91 BTRC_FEAT_COVER_ARTWORK = 0x8, /* AVRCP 1.6 and up, Cover Art */ 92 } btrc_remote_features_t; 93 94 typedef enum { 95 BTRC_PLAYSTATE_STOPPED = 0x00, /* Stopped */ 96 BTRC_PLAYSTATE_PLAYING = 0x01, /* Playing */ 97 BTRC_PLAYSTATE_PAUSED = 0x02, /* Paused */ 98 BTRC_PLAYSTATE_FWD_SEEK = 0x03, /* Fwd Seek*/ 99 BTRC_PLAYSTATE_REV_SEEK = 0x04, /* Rev Seek*/ 100 BTRC_PLAYSTATE_ERROR = 0xFF, /* Error */ 101 } btrc_play_status_t; 102 103 typedef enum { 104 BTRC_EVT_PLAY_STATUS_CHANGED = 0x01, 105 BTRC_EVT_TRACK_CHANGE = 0x02, 106 BTRC_EVT_TRACK_REACHED_END = 0x03, 107 BTRC_EVT_TRACK_REACHED_START = 0x04, 108 BTRC_EVT_PLAY_POS_CHANGED = 0x05, 109 BTRC_EVT_APP_SETTINGS_CHANGED = 0x08, 110 BTRC_EVT_NOW_PLAYING_CONTENT_CHANGED = 0x09, 111 BTRC_EVT_AVAL_PLAYER_CHANGE = 0x0a, 112 BTRC_EVT_ADDR_PLAYER_CHANGE = 0x0b, 113 BTRC_EVT_UIDS_CHANGED = 0x0c, 114 BTRC_EVT_VOL_CHANGED = 0x0d, 115 } btrc_event_id_t; 116 117 typedef enum { 118 BTRC_NOTIFICATION_TYPE_INTERIM = 0, 119 BTRC_NOTIFICATION_TYPE_CHANGED = 1, 120 } btrc_notification_type_t; 121 122 typedef enum { 123 BTRC_PLAYER_ATTR_EQUALIZER = 0x01, 124 BTRC_PLAYER_ATTR_REPEAT = 0x02, 125 BTRC_PLAYER_ATTR_SHUFFLE = 0x03, 126 BTRC_PLAYER_ATTR_SCAN = 0x04, 127 } btrc_player_attr_t; 128 129 typedef enum { 130 BTRC_MEDIA_ATTR_TITLE = 0x01, 131 BTRC_MEDIA_ATTR_ARTIST = 0x02, 132 BTRC_MEDIA_ATTR_ALBUM = 0x03, 133 BTRC_MEDIA_ATTR_TRACK_NUM = 0x04, 134 BTRC_MEDIA_ATTR_NUM_TRACKS = 0x05, 135 BTRC_MEDIA_ATTR_GENRE = 0x06, 136 BTRC_MEDIA_ATTR_PLAYING_TIME = 0x07, 137 } btrc_media_attr_t; 138 139 typedef enum { 140 BTRC_PLAYER_VAL_OFF_REPEAT = 0x01, 141 BTRC_PLAYER_VAL_SINGLE_REPEAT = 0x02, 142 BTRC_PLAYER_VAL_ALL_REPEAT = 0x03, 143 BTRC_PLAYER_VAL_GROUP_REPEAT = 0x04 144 } btrc_player_repeat_val_t; 145 146 typedef enum { 147 BTRC_PLAYER_VAL_OFF_SHUFFLE = 0x01, 148 BTRC_PLAYER_VAL_ALL_SHUFFLE = 0x02, 149 BTRC_PLAYER_VAL_GROUP_SHUFFLE = 0x03 150 } btrc_player_shuffle_val_t; 151 152 typedef enum { 153 BTRC_STS_BAD_CMD = 0x00, /* Invalid command */ 154 BTRC_STS_BAD_PARAM = 0x01, /* Invalid parameter */ 155 BTRC_STS_NOT_FOUND = 0x02, /* Specified parameter is wrong or not found */ 156 BTRC_STS_INTERNAL_ERR = 0x03, /* Internal Error */ 157 BTRC_STS_NO_ERROR = 0x04, /* Operation Success */ 158 BTRC_STS_UID_CHANGED = 0x05, /* UIDs changed */ 159 BTRC_STS_RESERVED = 0x06, /* Reserved */ 160 BTRC_STS_INV_DIRN = 0x07, /* Invalid direction */ 161 BTRC_STS_INV_DIRECTORY = 0x08, /* Invalid directory */ 162 BTRC_STS_INV_ITEM = 0x09, /* Invalid Item */ 163 BTRC_STS_INV_SCOPE = 0x0a, /* Invalid scope */ 164 BTRC_STS_INV_RANGE = 0x0b, /* Invalid range */ 165 BTRC_STS_DIRECTORY = 0x0c, /* UID is a directory */ 166 BTRC_STS_MEDIA_IN_USE = 0x0d, /* Media in use */ 167 BTRC_STS_PLAY_LIST_FULL = 0x0e, /* Playing list full */ 168 BTRC_STS_SRCH_NOT_SPRTD = 0x0f, /* Search not supported */ 169 BTRC_STS_SRCH_IN_PROG = 0x10, /* Search in progress */ 170 BTRC_STS_INV_PLAYER = 0x11, /* Invalid player */ 171 BTRC_STS_PLAY_NOT_BROW = 0x12, /* Player not browsable */ 172 BTRC_STS_PLAY_NOT_ADDR = 0x13, /* Player not addressed */ 173 BTRC_STS_INV_RESULTS = 0x14, /* Invalid results */ 174 BTRC_STS_NO_AVBL_PLAY = 0x15, /* No available players */ 175 BTRC_STS_ADDR_PLAY_CHGD = 0x16, /* Addressed player changed */ 176 } btrc_status_t; 177 178 typedef struct { 179 uint16_t player_id; 180 uint16_t uid_counter; 181 } btrc_addr_player_changed_t; 182 183 typedef struct { 184 uint8_t num_attr; 185 uint8_t attr_ids[BTRC_MAX_APP_SETTINGS]; 186 uint8_t attr_values[BTRC_MAX_APP_SETTINGS]; 187 } btrc_player_settings_t; 188 189 typedef struct { 190 uint8_t val; 191 uint16_t charset_id; 192 uint16_t str_len; 193 uint8_t* p_str; 194 } btrc_player_app_ext_attr_val_t; 195 196 typedef struct { 197 uint8_t attr_id; 198 uint16_t charset_id; 199 uint16_t str_len; 200 uint8_t* p_str; 201 uint8_t num_val; 202 btrc_player_app_ext_attr_val_t ext_attr_val[BTRC_MAX_APP_ATTR_SIZE]; 203 } btrc_player_app_ext_attr_t; 204 205 typedef struct { 206 uint8_t attr_id; 207 uint8_t num_val; 208 uint8_t attr_val[BTRC_MAX_APP_ATTR_SIZE]; 209 } btrc_player_app_attr_t; 210 211 typedef struct { 212 uint32_t start_item; 213 uint32_t end_item; 214 uint32_t size; 215 uint32_t attrs[BTRC_MAX_ELEM_ATTR_SIZE]; 216 uint8_t attr_count; 217 } btrc_getfolderitem_t; 218 219 typedef struct { 220 uint16_t type; 221 uint16_t uid_counter; 222 } btrc_uids_changed_t; 223 224 typedef struct { 225 uint16_t type; 226 } btrc_now_playing_changed_t; 227 228 typedef union { 229 btrc_play_status_t play_status; 230 btrc_uid_t track; /* queue position in NowPlaying */ 231 uint32_t song_pos; 232 uint16_t uid_counter; 233 btrc_player_settings_t player_setting; 234 btrc_addr_player_changed_t addr_player_changed; 235 btrc_uids_changed_t uids_changed; 236 btrc_now_playing_changed_t now_playing_changed; 237 } btrc_register_notification_t; 238 239 typedef struct { 240 uint8_t id; /* can be attr_id or value_id */ 241 uint8_t text[BTRC_MAX_ATTR_STR_LEN]; 242 } btrc_player_setting_text_t; 243 244 typedef struct { 245 uint32_t attr_id; 246 uint8_t text[BTRC_MAX_ATTR_STR_LEN]; 247 } btrc_element_attr_val_t; 248 249 typedef struct { 250 uint16_t player_id; 251 uint8_t major_type; 252 uint32_t sub_type; 253 uint8_t play_status; 254 uint8_t features[BTRC_FEATURE_BIT_MASK_SIZE]; 255 uint16_t charset_id; 256 uint8_t name[BTRC_MAX_ATTR_STR_LEN]; 257 } btrc_item_player_t; 258 259 typedef struct { 260 uint8_t uid[BTRC_UID_SIZE]; 261 uint8_t type; 262 uint8_t playable; 263 uint16_t charset_id; 264 uint8_t name[BTRC_MAX_ATTR_STR_LEN]; 265 } btrc_item_folder_t; 266 267 typedef struct { 268 uint8_t uid[BTRC_UID_SIZE]; 269 uint8_t type; 270 uint16_t charset_id; 271 uint8_t name[BTRC_MAX_ATTR_STR_LEN]; 272 int num_attrs; 273 btrc_element_attr_val_t* p_attrs; 274 } btrc_item_media_t; 275 276 typedef struct { 277 uint8_t item_type; 278 union { 279 btrc_item_player_t player; 280 btrc_item_folder_t folder; 281 btrc_item_media_t media; 282 }; 283 } btrc_folder_items_t; 284 285 typedef struct { 286 uint16_t str_len; 287 uint8_t p_str[BTRC_MAX_ATTR_STR_LEN]; 288 } btrc_br_folder_name_t; 289 290 /** Callback for the controller's supported feautres */ 291 typedef void (*btrc_remote_features_callback)(const RawAddress& bd_addr, 292 btrc_remote_features_t features); 293 294 /** Callback for play status request */ 295 typedef void (*btrc_get_play_status_callback)(const RawAddress& bd_addr); 296 297 /** Callback for list player application attributes (Shuffle, Repeat,...) */ 298 typedef void (*btrc_list_player_app_attr_callback)(const RawAddress& bd_addr); 299 300 /** Callback for list player application attributes (Shuffle, Repeat,...) */ 301 typedef void (*btrc_list_player_app_values_callback)(btrc_player_attr_t attr_id, 302 const RawAddress& bd_addr); 303 304 /** Callback for getting the current player application settings value 305 ** num_attr: specifies the number of attribute ids contained in p_attrs 306 */ 307 typedef void (*btrc_get_player_app_value_callback)(uint8_t num_attr, btrc_player_attr_t* p_attrs, 308 const RawAddress& bd_addr); 309 310 /** Callback for getting the player application settings attributes' text 311 ** num_attr: specifies the number of attribute ids contained in p_attrs 312 */ 313 typedef void (*btrc_get_player_app_attrs_text_callback)(uint8_t num_attr, 314 btrc_player_attr_t* p_attrs, 315 const RawAddress& bd_addr); 316 317 /** Callback for getting the player application settings values' text 318 ** num_attr: specifies the number of value ids contained in p_vals 319 */ 320 typedef void (*btrc_get_player_app_values_text_callback)(uint8_t attr_id, uint8_t num_val, 321 uint8_t* p_vals, 322 const RawAddress& bd_addr); 323 324 /** Callback for setting the player application settings values */ 325 typedef void (*btrc_set_player_app_value_callback)(btrc_player_settings_t* p_vals, 326 const RawAddress& bd_addr); 327 328 /** Callback to fetch the get element attributes of the current song 329 ** num_attr: specifies the number of attributes requested in p_attrs 330 */ 331 typedef void (*btrc_get_element_attr_callback)(uint8_t num_attr, btrc_media_attr_t* p_attrs, 332 const RawAddress& bd_addr); 333 334 /** Callback for register notification (Play state change/track change/...) 335 ** param: Is only valid if event_id is BTRC_EVT_PLAY_POS_CHANGED 336 */ 337 typedef void (*btrc_register_notification_callback)(btrc_event_id_t event_id, uint32_t param, 338 const RawAddress& bd_addr); 339 340 /* AVRCP 1.4 Enhancements */ 341 /** Callback for volume change on CT 342 ** volume: Current volume setting on the CT (0-127) 343 */ 344 typedef void (*btrc_volume_change_callback)(uint8_t volume, uint8_t ctype, 345 const RawAddress& bd_addr); 346 347 /** Callback for passthrough commands */ 348 typedef void (*btrc_passthrough_cmd_callback)(int id, int key_state, const RawAddress& bd_addr); 349 350 /** Callback for set addressed player response on TG **/ 351 typedef void (*btrc_set_addressed_player_callback)(uint16_t player_id, const RawAddress& bd_addr); 352 353 /** Callback for set browsed player response on TG **/ 354 typedef void (*btrc_set_browsed_player_callback)(uint16_t player_id, const RawAddress& bd_addr); 355 356 /** Callback for get folder items on TG 357 ** num_attr: specifies the number of attributes requested in p_attr_ids 358 */ 359 typedef void (*btrc_get_folder_items_callback)(uint8_t scope, uint32_t start_item, 360 uint32_t end_item, uint8_t num_attr, 361 uint32_t* p_attr_ids, const RawAddress& bd_addr); 362 363 /** Callback for changing browsed path on TG **/ 364 typedef void (*btrc_change_path_callback)(uint8_t direction, uint8_t* folder_uid, 365 const RawAddress& bd_addr); 366 367 /** Callback to fetch the get item attributes of the media item 368 ** num_attr: specifies the number of attributes requested in p_attrs 369 */ 370 typedef void (*btrc_get_item_attr_callback)(uint8_t scope, uint8_t* uid, uint16_t uid_counter, 371 uint8_t num_attr, btrc_media_attr_t* p_attrs, 372 const RawAddress& bd_addr); 373 374 /** Callback for play request for the media item indicated by an identifier */ 375 typedef void (*btrc_play_item_callback)(uint8_t scope, uint16_t uid_counter, uint8_t* uid, 376 const RawAddress& bd_addr); 377 378 /** Callback to fetch total number of items from a folder **/ 379 typedef void (*btrc_get_total_num_of_items_callback)(uint8_t scope, const RawAddress& bd_addr); 380 381 /** Callback for conducting recursive search on a current browsed path for a 382 * specified string */ 383 typedef void (*btrc_search_callback)(uint16_t charset_id, uint16_t str_len, uint8_t* p_str, 384 const RawAddress& bd_addr); 385 386 /** Callback to add a specified media item indicated by an identifier to now 387 * playing queue. */ 388 typedef void (*btrc_add_to_now_playing_callback)(uint8_t scope, uint8_t* uid, uint16_t uid_counter, 389 const RawAddress& bd_addr); 390 391 /** BT-RC Target callback structure. */ 392 typedef struct { 393 /** set to sizeof(BtRcCallbacks) */ 394 size_t size; 395 btrc_remote_features_callback remote_features_cb; 396 btrc_get_play_status_callback get_play_status_cb; 397 btrc_list_player_app_attr_callback list_player_app_attr_cb; 398 btrc_list_player_app_values_callback list_player_app_values_cb; 399 btrc_get_player_app_value_callback get_player_app_value_cb; 400 btrc_get_player_app_attrs_text_callback get_player_app_attrs_text_cb; 401 btrc_get_player_app_values_text_callback get_player_app_values_text_cb; 402 btrc_set_player_app_value_callback set_player_app_value_cb; 403 btrc_get_element_attr_callback get_element_attr_cb; 404 btrc_register_notification_callback register_notification_cb; 405 btrc_volume_change_callback volume_change_cb; 406 btrc_passthrough_cmd_callback passthrough_cmd_cb; 407 btrc_set_addressed_player_callback set_addressed_player_cb; 408 btrc_set_browsed_player_callback set_browsed_player_cb; 409 btrc_get_folder_items_callback get_folder_items_cb; 410 btrc_change_path_callback change_path_cb; 411 btrc_get_item_attr_callback get_item_attr_cb; 412 btrc_play_item_callback play_item_cb; 413 btrc_get_total_num_of_items_callback get_total_num_of_items_cb; 414 btrc_search_callback search_cb; 415 btrc_add_to_now_playing_callback add_to_now_playing_cb; 416 } btrc_callbacks_t; 417 418 /** Represents the standard BT-RC AVRCP Target interface. */ 419 typedef struct { 420 /** set to sizeof(BtRcInterface) */ 421 size_t size; 422 /** 423 * Register the BtRc callbacks 424 */ 425 bt_status_t (*init)(btrc_callbacks_t* callbacks); 426 427 /** Respose to GetPlayStatus request. Contains the current 428 ** 1. Play status 429 ** 2. Song duration/length 430 ** 3. Song position 431 */ 432 bt_status_t (*get_play_status_rsp)(const RawAddress& bd_addr, btrc_play_status_t play_status, 433 uint32_t song_len, uint32_t song_pos); 434 435 /** Lists the support player application attributes (Shuffle/Repeat/...) 436 ** num_attr: Specifies the number of attributes contained in the pointer 437 *p_attrs 438 */ 439 bt_status_t (*list_player_app_attr_rsp)(const RawAddress& bd_addr, int num_attr, 440 btrc_player_attr_t* p_attrs); 441 442 /** Lists the support player application attributes (Shuffle Off/On/Group) 443 ** num_val: Specifies the number of values contained in the pointer p_vals 444 */ 445 bt_status_t (*list_player_app_value_rsp)(const RawAddress& bd_addr, int num_val, uint8_t* p_vals); 446 447 /** Returns the current application attribute values for each of the specified 448 * attr_id */ 449 bt_status_t (*get_player_app_value_rsp)(const RawAddress& bd_addr, 450 btrc_player_settings_t* p_vals); 451 452 /** Returns the application attributes text ("Shuffle"/"Repeat"/...) 453 ** num_attr: Specifies the number of attributes' text contained in the 454 *pointer p_attrs 455 */ 456 bt_status_t (*get_player_app_attr_text_rsp)(const RawAddress& bd_addr, int num_attr, 457 btrc_player_setting_text_t* p_attrs); 458 459 /** Returns the application attributes text ("Shuffle"/"Repeat"/...) 460 ** num_attr: Specifies the number of attribute values' text contained in the 461 *pointer p_vals 462 */ 463 bt_status_t (*get_player_app_value_text_rsp)(const RawAddress& bd_addr, int num_val, 464 btrc_player_setting_text_t* p_vals); 465 466 /** Returns the current songs' element attributes text 467 *("Title"/"Album"/"Artist") 468 ** num_attr: Specifies the number of attributes' text contained in the 469 *pointer p_attrs 470 */ 471 bt_status_t (*get_element_attr_rsp)(const RawAddress& bd_addr, uint8_t num_attr, 472 btrc_element_attr_val_t* p_attrs); 473 474 /** Response to set player attribute request ("Shuffle"/"Repeat") 475 ** rsp_status: Status of setting the player attributes for the current media 476 *player 477 */ 478 bt_status_t (*set_player_app_value_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status); 479 480 /* Response to the register notification request (Play state change/track 481 *change/...). 482 ** event_id: Refers to the event_id this notification change corresponds too 483 ** type: Response type - interim/changed 484 ** p_params: Based on the event_id, this parameter should be populated 485 */ 486 bt_status_t (*register_notification_rsp)(btrc_event_id_t event_id, btrc_notification_type_t type, 487 btrc_register_notification_t* p_param); 488 489 /* AVRCP 1.4 enhancements */ 490 491 /**Send current volume setting to remote side. Support limited to 492 *SetAbsoluteVolume 493 ** This can be enhanced to support Relative Volume (AVRCP 1.0). 494 ** With RelateVolume, we will send VOLUME_UP/VOLUME_DOWN opposed to absolute 495 *volume level 496 ** volume: Should be in the range 0-127. bit7 is reserved and cannot be set 497 */ 498 bt_status_t (*set_volume)(uint8_t volume); 499 500 /* Set addressed player response from TG to CT */ 501 bt_status_t (*set_addressed_player_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status); 502 503 /* Set browsed player response from TG to CT */ 504 bt_status_t (*set_browsed_player_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 505 uint32_t num_items, uint16_t charset_id, 506 uint8_t folder_depth, btrc_br_folder_name_t* p_folders); 507 508 /* Get folder item list response from TG to CT */ 509 bt_status_t (*get_folder_items_list_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 510 uint16_t uid_counter, uint8_t num_items, 511 btrc_folder_items_t* p_items); 512 513 /* Change path response from TG to CT */ 514 bt_status_t (*change_path_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 515 uint32_t num_items); 516 517 /** Returns the element's attributes num_attr: Specifies the number of 518 * attributes' text contained in the pointer p_attrs 519 */ 520 bt_status_t (*get_item_attr_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 521 uint8_t num_attr, btrc_element_attr_val_t* p_attrs); 522 523 /* play media item response from TG to CT */ 524 bt_status_t (*play_item_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status); 525 526 /* get total number of items response from TG to CT*/ 527 bt_status_t (*get_total_num_of_items_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 528 uint32_t uid_counter, uint32_t num_items); 529 530 /* Search VFS response from TG to CT */ 531 bt_status_t (*search_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status, 532 uint32_t uid_counter, uint32_t num_items); 533 534 /* add_to_now playing list response from TG to CT */ 535 bt_status_t (*add_to_now_playing_rsp)(const RawAddress& bd_addr, btrc_status_t rsp_status); 536 537 /** Closes the interface. */ 538 void (*cleanup)(void); 539 } btrc_interface_t; 540 541 typedef void (*btrc_passthrough_rsp_callback)(const RawAddress& bd_addr, int id, int key_state); 542 543 typedef void (*btrc_groupnavigation_rsp_callback)(int id, int key_state); 544 545 typedef void (*btrc_connection_state_callback)(bool rc_connect, bool bt_connect, 546 const RawAddress& bd_addr); 547 548 typedef void (*btrc_ctrl_getrcfeatures_callback)(const RawAddress& bd_addr, int features); 549 550 typedef void (*btrc_ctrl_setabsvol_cmd_callback)(const RawAddress& bd_addr, uint8_t abs_vol, 551 uint8_t label); 552 553 typedef void (*btrc_ctrl_registernotification_abs_vol_callback)(const RawAddress& bd_addr, 554 uint8_t label); 555 556 typedef void (*btrc_ctrl_setplayerapplicationsetting_rsp_callback)(const RawAddress& bd_addr, 557 uint8_t accepted); 558 559 typedef void (*btrc_ctrl_playerapplicationsetting_callback)(const RawAddress& bd_addr, 560 uint8_t num_attr, 561 btrc_player_app_attr_t* app_attrs, 562 uint8_t num_ext_attr, 563 btrc_player_app_ext_attr_t* ext_attrs); 564 565 typedef void (*btrc_ctrl_playerapplicationsetting_changed_callback)( 566 const RawAddress& bd_addr, const btrc_player_settings_t& vals); 567 568 typedef void (*btrc_ctrl_track_changed_callback)(const RawAddress& bd_addr, uint8_t num_attr, 569 btrc_element_attr_val_t* p_attrs); 570 571 typedef void (*btrc_ctrl_play_position_changed_callback)(const RawAddress& bd_addr, 572 uint32_t song_len, uint32_t song_pos); 573 574 typedef void (*btrc_ctrl_play_status_changed_callback)(const RawAddress& bd_addr, 575 btrc_play_status_t play_status); 576 577 typedef void (*btrc_ctrl_get_folder_items_callback)(const RawAddress& bd_addr, btrc_status_t status, 578 const btrc_folder_items_t* folder_items, 579 uint8_t count); 580 581 typedef void (*btrc_ctrl_change_path_callback)(const RawAddress& bd_addr, uint32_t count); 582 583 typedef void (*btrc_ctrl_set_browsed_player_callback)(const RawAddress& bd_addr, uint8_t num_items, 584 uint8_t depth); 585 typedef void (*btrc_ctrl_set_addressed_player_callback)(const RawAddress& bd_addr, uint8_t status); 586 typedef void (*btrc_ctrl_addressed_player_changed_callback)(const RawAddress& bd_addr, uint16_t id); 587 typedef void (*btrc_ctrl_now_playing_contents_changed_callback)(const RawAddress& bd_addr); 588 typedef void (*btrc_ctrl_available_player_changed_callback)(const RawAddress& bd_addr); 589 590 typedef void (*btrc_ctrl_get_cover_art_psm_callback)(const RawAddress& bd_addr, const uint16_t psm); 591 592 /** BT-RC Controller callback structure. */ 593 typedef struct { 594 /** set to sizeof(BtRcCallbacks) */ 595 size_t size; 596 btrc_passthrough_rsp_callback passthrough_rsp_cb; 597 btrc_groupnavigation_rsp_callback groupnavigation_rsp_cb; 598 btrc_connection_state_callback connection_state_cb; 599 btrc_ctrl_getrcfeatures_callback getrcfeatures_cb; 600 btrc_ctrl_setplayerapplicationsetting_rsp_callback setplayerappsetting_rsp_cb; 601 btrc_ctrl_playerapplicationsetting_callback playerapplicationsetting_cb; 602 btrc_ctrl_playerapplicationsetting_changed_callback playerapplicationsetting_changed_cb; 603 btrc_ctrl_setabsvol_cmd_callback setabsvol_cmd_cb; 604 btrc_ctrl_registernotification_abs_vol_callback registernotification_absvol_cb; 605 btrc_ctrl_track_changed_callback track_changed_cb; 606 btrc_ctrl_play_position_changed_callback play_position_changed_cb; 607 btrc_ctrl_play_status_changed_callback play_status_changed_cb; 608 btrc_ctrl_get_folder_items_callback get_folder_items_cb; 609 btrc_ctrl_change_path_callback change_folder_path_cb; 610 btrc_ctrl_set_browsed_player_callback set_browsed_player_cb; 611 btrc_ctrl_set_addressed_player_callback set_addressed_player_cb; 612 btrc_ctrl_addressed_player_changed_callback addressed_player_changed_cb; 613 btrc_ctrl_now_playing_contents_changed_callback now_playing_contents_changed_cb; 614 btrc_ctrl_available_player_changed_callback available_player_changed_cb; 615 btrc_ctrl_get_cover_art_psm_callback get_cover_art_psm_cb; 616 } btrc_ctrl_callbacks_t; 617 618 /** Represents the standard BT-RC AVRCP Controller interface. */ 619 typedef struct { 620 /** set to sizeof(BtRcInterface) */ 621 size_t size; 622 /** 623 * Register the BtRc callbacks 624 */ 625 bt_status_t (*init)(btrc_ctrl_callbacks_t* callbacks); 626 627 /** send pass through command to target */ 628 bt_status_t (*send_pass_through_cmd)(const RawAddress& bd_addr, uint8_t key_code, 629 uint8_t key_state); 630 631 /** send group navigation command to target */ 632 bt_status_t (*send_group_navigation_cmd)(const RawAddress& bd_addr, uint8_t key_code, 633 uint8_t key_state); 634 635 /** send command to set player application setting attributes to target */ 636 bt_status_t (*set_player_app_setting_cmd)(const RawAddress& bd_addr, uint8_t num_attrib, 637 uint8_t* attrib_ids, uint8_t* attrib_vals); 638 639 /** send command to play a particular item */ 640 bt_status_t (*play_item_cmd)(const RawAddress& bd_addr, uint8_t scope, uint8_t* uid, 641 uint16_t uid_counter); 642 643 /** get the current track's media metadata */ 644 bt_status_t (*get_current_metadata_cmd)(const RawAddress& bd_addr); 645 646 /** get the playback state */ 647 bt_status_t (*get_playback_state_cmd)(const RawAddress& bd_addr); 648 649 /** get the now playing list */ 650 bt_status_t (*get_now_playing_list_cmd)(const RawAddress& bd_addr, uint32_t start, uint32_t end); 651 652 /** get the folder list */ 653 bt_status_t (*get_folder_list_cmd)(const RawAddress& bd_addr, uint32_t start, uint32_t end); 654 655 /** get the player list */ 656 bt_status_t (*get_player_list_cmd)(const RawAddress& bd_addr, uint32_t start, uint32_t end); 657 658 /** change the folder path */ 659 bt_status_t (*change_folder_path_cmd)(const RawAddress& bd_addr, uint8_t direction, uint8_t* uid); 660 661 /** set browsed player */ 662 bt_status_t (*set_browsed_player_cmd)(const RawAddress& bd_addr, uint16_t player_id); 663 664 /** set addressed player */ 665 bt_status_t (*set_addressed_player_cmd)(const RawAddress& bd_addr, uint16_t player_id); 666 667 /** send rsp to set_abs_vol received from target */ 668 bt_status_t (*set_volume_rsp)(const RawAddress& bd_addr, uint8_t abs_vol, uint8_t label); 669 670 /** send notificaiton rsp for abs vol to target */ 671 bt_status_t (*register_abs_vol_rsp)(const RawAddress& bd_addr, btrc_notification_type_t rsp_type, 672 uint8_t abs_vol, uint8_t label); 673 674 /** Closes the interface. */ 675 void (*cleanup)(void); 676 } btrc_ctrl_interface_t; 677 678 __END_DECLS 679 680 #if __has_include(<bluetooth/log.h>) 681 #include <bluetooth/log.h> 682 683 namespace std { 684 template <> 685 struct formatter<btrc_status_t> : enum_formatter<btrc_status_t> {}; 686 template <> 687 struct formatter<btrc_event_id_t> : enum_formatter<btrc_event_id_t> {}; 688 template <> 689 struct formatter<btrc_remote_features_t> : enum_formatter<btrc_remote_features_t> {}; 690 template <> 691 struct formatter<btrc_notification_type_t> : enum_formatter<btrc_notification_type_t> {}; 692 } // namespace std 693 694 #endif // __has_include(<bluetooth/log.h>) 695 696 #endif /* ANDROID_INCLUDE_BT_RC_H */ 697