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 /* 39 * avrcp.h 40 * 41 * Audio/Video Remote Control Profile 42 * 43 */ 44 45 #ifndef AVRCP_H 46 #define AVRCP_H 47 48 #include <stdint.h> 49 50 #include "btstack_run_loop.h" 51 #include "btstack_linked_list.h" 52 #include "l2cap.h" 53 54 #if defined __cplusplus 55 extern "C" { 56 #endif 57 58 #define PSM_AVCTP_BROWSING 0x001b 59 60 #define AVRCP_BROWSING_ITEM_HEADER_LEN 3 61 #define AVRCP_BROWSING_MAX_NUM_ATTR_IDS 8 62 63 #define BT_SIG_COMPANY_ID 0x001958 64 #define AVRCP_MEDIA_ATTR_COUNT 7 65 #define AVRCP_MAX_ATTRIBUTTE_SIZE 100 66 #define AVRCP_ATTRIBUTE_HEADER_LEN 8 67 #define AVRCP_MAX_FOLDER_NAME_SIZE 20 68 69 #define AVRCP_NO_TRACK_SELECTED_PLAYBACK_POSITION_CHANGED 0xFFFFFFFF 70 71 #define AVRCP_FEATURE_MASK_CATEGORY_PLAYER_OR_RECORDER 0x0001u 72 #define AVRCP_FEATURE_MASK_CATEGORY_MONITOR_OR_AMPLIFIER 0x0002u 73 #define AVRCP_FEATURE_MASK_CATEGORY_TUNER 0x0004u 74 #define AVRCP_FEATURE_MASK_CATEGORY_MENU 0x0008u 75 #define AVRCP_FEATURE_MASK_PLAYER_APPLICATION_SETTINGS 0x0010u // AVRCP_FEATURE_MASK_CATEGORY_PLAYER_OR_RECORDER must be 1 for this feature to be set 76 #define AVRCP_FEATURE_MASK_GROUP_NAVIGATION 0x0020u // AVRCP_FEATURE_MASK_CATEGORY_PLAYER_OR_RECORDER must be 1 for this feature to be set 77 #define AVRCP_FEATURE_MASK_BROWSING 0x0040u 78 #define AVRCP_FEATURE_MASK_MULTIPLE_MEDIA_PLAYE_APPLICATIONS 0x0080u 79 80 typedef enum { 81 AVRCP_STATUS_INVALID_COMMAND = 0, // sent if TG received a PDU that it did not understand. 82 AVRCP_STATUS_INVALID_PARAMETER, // Sent if the TG received a PDU with a parameter ID that it did not understand, or, if there is only one parameter ID in the PDU. 83 AVRCP_STATUS_SPECIFIED_PARAMETER_NOT_FOUND, // sent if the parameter ID is understood, but content is wrong or corrupted. 84 AVRCP_STATUS_INTERNAL_ERROR, // sent if there are error conditions not covered by a more specific error code. 85 AVRCP_STATUS_SUCCESS, // sent if the operation was successful. 86 AVRCP_STATUS_UID_CHANGED, // sent if the UIDs on the device have changed. 87 AVRCP_STATUS_RESERVED_6, 88 AVRCP_STATUS_INVALID_DIRECTION, // The Direction parameter is invalid. Valid for command: Change Path 89 AVRCP_STATUS_NOT_A_DIRECTORY, // The UID provided does not refer to a folder item. Valid for command: Change Path 90 AVRCP_STATUS_DOES_NOT_EXIST, // The UID provided does not refer to any currently valid. Valid for command: Change Path, PlayItem, AddToNowPlaying, GetItemAttributes 91 AVRCP_STATUS_INVALID_SCOPE, // The scope parameter is invalid. Valid for command: GetFolderItems, PlayItem, AddToNowPlayer, GetItemAttributes, 92 AVRCP_STATUS_RANGE_OUT_OF_BOUNDS, // The start of range provided is not valid. Valid for command: GetFolderItems 93 AVRCP_STATUS_UID_IS_A_DIRECTORY, // The UID provided refers to a directory, which cannot be handled by this media player. Valid for command: PlayItem, AddToNowPlaying 94 AVRCP_STATUS_MEDIA_IN_USE, // The media is not able to be used for this operation at this time. Valid for command: PlayItem, AddToNowPlaying 95 AVRCP_STATUS_NOW_PLAYING_LIST_FULL, // No more items can be added to the Now Playing List. Valid for command: AddToNowPlaying 96 AVRCP_STATUS_SEARCH_NOT_SUPPORTED, // The Browsed Media Player does not support search. Valid for command: Search 97 AVRCP_STATUS_SEARCH_IN_PROGRESS, // A search operation is already in progress. Valid for command: Search 98 AVRCP_STATUS_INVALID_PLAYER_ID, // The specified Player Id does not refer to a valid player. Valid for command: SetAddressedPlayer, SetBrowsedPlayer 99 AVRCP_STATUS_PLAYER_NOT_BROWSABLE, // The Player Id supplied refers to a Media Player which does not support browsing. Valid for command: SetBrowsedPlayer 100 AVRCP_STATUS_PLAYER_NOT_ADDRESSED, // The Player Id supplied refers to a player which is not currently addressed, and the command is not able to be performed if the player is not set as addressed. Valid for command: Search SetBrowsedPlayer 101 AVRCP_STATUS_NO_VALID_SEARCH_RESULTS, // The Search result list does not contain valid entries, e.g. after being invalidated due to change of browsed player. Valid for command: GetFolderItems 102 AVRCP_STATUS_NO_AVAILABLE_PLAYERS, 103 AVRCP_STATUS_ADDRESSED_PLAYER_CHANGED, // Valid for command: Register Notification 104 AVRCP_STATUS_RESERVED // 0x17 - 0xFF 105 } avrcp_status_code_t; 106 107 typedef enum { 108 AVRCP_SINGLE_PACKET= 0, 109 AVRCP_START_PACKET , 110 AVRCP_CONTINUE_PACKET , 111 AVRCP_END_PACKET 112 } avrcp_packet_type_t; 113 114 typedef enum { 115 AVRCP_COMMAND_FRAME = 0, 116 AVRCP_RESPONSE_FRAME 117 } avrcp_frame_type_t; 118 119 120 typedef enum { 121 AVRCP_CAPABILITY_ID_COMPANY = 0x02, 122 AVRCP_CAPABILITY_ID_EVENT = 0x03 123 } avrcp_capability_id_t; 124 125 typedef enum { 126 AVRCP_MEDIA_ATTR_ALL = 0x0000, 127 AVRCP_MEDIA_ATTR_TITLE, 128 AVRCP_MEDIA_ATTR_ARTIST, 129 AVRCP_MEDIA_ATTR_ALBUM, 130 AVRCP_MEDIA_ATTR_TRACK, 131 AVRCP_MEDIA_ATTR_TOTAL_NUM_ITEMS, 132 AVRCP_MEDIA_ATTR_GENRE, 133 AVRCP_MEDIA_ATTR_SONG_LENGTH_MS, 134 AVRCP_MEDIA_ATTR_DEFAULT_COVER_ART, 135 AVRCP_MEDIA_ATTR_NONE = 0x7FFF 136 } avrcp_media_attribute_id_t; 137 138 typedef enum { 139 AVRCP_PDU_ID_GET_CAPABILITIES = 0x10, 140 AVRCP_PDU_ID_GET_CURRENT_PLAYER_APPLICATION_SETTING_VALUE = 0x13, 141 AVRCP_PDU_ID_SET_PLAYER_APPLICATION_SETTING_VALUE = 0x14, 142 AVRCP_PDU_ID_GET_ELEMENT_ATTRIBUTES = 0x20, 143 AVRCP_PDU_ID_GET_PLAY_STATUS = 0x30, 144 AVRCP_PDU_ID_REGISTER_NOTIFICATION = 0x31, 145 AVRCP_PDU_ID_REQUEST_CONTINUING_RESPONSE = 0x40, 146 AVRCP_PDU_ID_REQUEST_ABORT_CONTINUING_RESPONSE = 0x41, 147 AVRCP_PDU_ID_SET_ABSOLUTE_VOLUME = 0x50, 148 AVRCP_PDU_ID_SET_ADDRESSED_PLAYER = 0x60, 149 AVRCP_PDU_ID_SET_BROWSED_PLAYER = 0x70, 150 AVRCP_PDU_ID_GET_FOLDER_ITEMS = 0x71, 151 AVRCP_PDU_ID_CHANGE_PATH = 0x72, 152 AVRCP_PDU_ID_GET_ITEM_ATTRIBUTES = 0x73, 153 AVRCP_PDU_ID_PLAY_ITEM = 0x74, 154 AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS = 0x75, 155 AVRCP_PDU_ID_SEARCH = 0x80, 156 AVRCP_PDU_ID_ADD_TO_NOW_PLAYING = 0x90, 157 AVRCP_PDU_ID_GENERAL_REJECT = 0xA0, 158 159 AVRCP_PDU_ID_UNDEFINED = 0xFF 160 } avrcp_pdu_id_t; 161 162 typedef enum { 163 AVRCP_NOTIFICATION_EVENT_PLAYBACK_STATUS_CHANGED = 0x01, // Change in playback status of the current track. 164 AVRCP_NOTIFICATION_EVENT_TRACK_CHANGED = 0x02, // Change of current track 165 AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_END = 0x03, // Reached end of a track 166 AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_START = 0x04, // Reached start of a track 167 AVRCP_NOTIFICATION_EVENT_PLAYBACK_POS_CHANGED = 0x05, // Change in playback position. Returned after the specified playback notification change notification interval 168 AVRCP_NOTIFICATION_EVENT_BATT_STATUS_CHANGED = 0x06, // Change in battery status 169 AVRCP_NOTIFICATION_EVENT_SYSTEM_STATUS_CHANGED = 0x07, // Change in system status 170 AVRCP_NOTIFICATION_EVENT_PLAYER_APPLICATION_SETTING_CHANGED = 0x08, // Change in player application setting 171 AVRCP_NOTIFICATION_EVENT_NOW_PLAYING_CONTENT_CHANGED = 0x09, // The content of the Now Playing list has changed, see 6.9.5. 172 AVRCP_NOTIFICATION_EVENT_AVAILABLE_PLAYERS_CHANGED = 0x0a, // The available players have changed, see 6.9.4. 173 AVRCP_NOTIFICATION_EVENT_ADDRESSED_PLAYER_CHANGED = 0x0b, // The Addressed Player has been changed, see 6.9.2. 174 AVRCP_NOTIFICATION_EVENT_UIDS_CHANGED = 0x0c, // The UIDs have changed, see 6.10.3.3. 175 AVRCP_NOTIFICATION_EVENT_VOLUME_CHANGED = 0x0d, // The volume has been changed locally on the TG, see 6.13.3. 176 AVRCP_NOTIFICATION_EVENT_MAX_VALUE = 0x0e 177 } avrcp_notification_event_id_t; 178 179 180 // control command response: accepted, rejected, interim 181 // status command response: not implemented, rejected, in transition, stable 182 // notify command response: not implemented, rejected, changed 183 184 typedef enum { 185 AVRCP_CTYPE_CONTROL = 0, 186 AVRCP_CTYPE_STATUS, 187 AVRCP_CTYPE_SPECIFIC_INQUIRY, 188 AVRCP_CTYPE_NOTIFY, 189 AVRCP_CTYPE_GENERAL_INQUIRY, 190 AVRCP_CTYPE_RESERVED5, 191 AVRCP_CTYPE_RESERVED6, 192 AVRCP_CTYPE_RESERVED7, 193 AVRCP_CTYPE_RESPONSE_NOT_IMPLEMENTED = 8, 194 AVRCP_CTYPE_RESPONSE_ACCEPTED, 195 AVRCP_CTYPE_RESPONSE_REJECTED, 196 AVRCP_CTYPE_RESPONSE_IN_TRANSITION, // target state is in transition. A subsequent STATUS command, may result in the return of a STABLE status 197 AVRCP_CTYPE_RESPONSE_IMPLEMENTED_STABLE, 198 AVRCP_CTYPE_RESPONSE_CHANGED_STABLE, 199 AVRCP_CTYPE_RESPONSE_RESERVED, 200 AVRCP_CTYPE_RESPONSE_INTERIM // target is unable to respond with either ACCEPTED or REJECTED within 100 millisecond 201 } avrcp_command_type_t; 202 203 typedef enum { 204 AVRCP_SUBUNIT_TYPE_MONITOR = 0, 205 AVRCP_SUBUNIT_TYPE_AUDIO = 1, 206 AVRCP_SUBUNIT_TYPE_PRINTER, 207 AVRCP_SUBUNIT_TYPE_DISC, 208 AVRCP_SUBUNIT_TYPE_TAPE_RECORDER_PLAYER, 209 AVRCP_SUBUNIT_TYPE_TUNER, 210 AVRCP_SUBUNIT_TYPE_CA, 211 AVRCP_SUBUNIT_TYPE_CAMERA, 212 AVRCP_SUBUNIT_TYPE_RESERVED, 213 AVRCP_SUBUNIT_TYPE_PANEL = 9, 214 AVRCP_SUBUNIT_TYPE_BULLETIN_BOARD, 215 AVRCP_SUBUNIT_TYPE_CAMERA_STORAGE, 216 AVRCP_SUBUNIT_TYPE_VENDOR_UNIQUE = 0x1C, 217 AVRCP_SUBUNIT_TYPE_RESERVED_FOR_ALL_SUBUNIT_TYPES, 218 AVRCP_SUBUNIT_TYPE_EXTENDED_TO_NEXT_BYTE, // The unit_type field may take value 1E16, which means that the field is extended to the following byte. In that case, an additional byte for extended_unit_type will be added immediately following operand[1]. 219 // Further extension is possible when the value of extended_unit_type is FF16, in which case another byte will be added. 220 AVRCP_SUBUNIT_TYPE_UNIT = 0x1F 221 } avrcp_subunit_type_t; 222 223 typedef enum { 224 AVRCP_SUBUNIT_ID = 0, 225 AVRCP_SUBUNIT_ID_IGNORE = 7 226 } avrcp_subunit_id_t; 227 228 typedef enum { 229 AVRCP_CMD_OPCODE_VENDOR_DEPENDENT = 0x00, 230 // AVRCP_CMD_OPCODE_RESERVE = 0x01, 231 AVRCP_CMD_OPCODE_UNIT_INFO = 0x30, 232 AVRCP_CMD_OPCODE_SUBUNIT_INFO = 0x31, 233 AVRCP_CMD_OPCODE_PASS_THROUGH = 0x7C, 234 // AVRCP_CMD_OPCODE_VERSION = 0xB0, 235 // AVRCP_CMD_OPCODE_POWER = 0xB2, 236 AVRCP_CMD_OPCODE_UNDEFINED = 0xFF 237 } avrcp_command_opcode_t; 238 239 typedef enum { 240 AVRCP_OPERATION_ID_CHANNEL_UP = 0x30, 241 AVRCP_OPERATION_ID_CHANNEL_DOWN = 0x31, 242 AVRCP_OPERATION_ID_SELECT = 0x00, 243 AVRCP_OPERATION_ID_UP = 0x01, 244 AVRCP_OPERATION_ID_DOWN = 0x02, 245 AVRCP_OPERATION_ID_LEFT = 0x03, 246 AVRCP_OPERATION_ID_RIGHT = 0x04, 247 AVRCP_OPERATION_ID_ROOT_MENU = 0x09, 248 249 AVRCP_OPERATION_ID_SKIP = 0x3C, 250 AVRCP_OPERATION_ID_VOLUME_UP = 0x41, 251 AVRCP_OPERATION_ID_VOLUME_DOWN = 0x42, 252 AVRCP_OPERATION_ID_MUTE = 0x43, 253 254 AVRCP_OPERATION_ID_PLAY = 0x44, 255 AVRCP_OPERATION_ID_STOP = 0x45, 256 AVRCP_OPERATION_ID_PAUSE = 0x46, 257 AVRCP_OPERATION_ID_REWIND = 0x48, 258 AVRCP_OPERATION_ID_FAST_FORWARD = 0x49, 259 AVRCP_OPERATION_ID_FORWARD = 0x4B, 260 AVRCP_OPERATION_ID_BACKWARD = 0x4C, 261 AVRCP_OPERATION_ID_UNDEFINED = 0xFF 262 } avrcp_operation_id_t; 263 264 typedef enum{ 265 AVRCP_PLAYBACK_STATUS_STOPPED = 0x00, 266 AVRCP_PLAYBACK_STATUS_PLAYING, 267 AVRCP_PLAYBACK_STATUS_PAUSED, 268 AVRCP_PLAYBACK_STATUS_FWD_SEEK, 269 AVRCP_PLAYBACK_STATUS_REV_SEEK, 270 AVRCP_PLAYBACK_STATUS_ERROR = 0xFF 271 } avrcp_playback_status_t; 272 273 typedef enum { 274 AVRCP_BATTERY_STATUS_NORMAL = 0x00, // Battery operation is in normal state 275 AVRCP_BATTERY_STATUS_WARNING, // unable to operate soon. Is provided when the battery level is going down. 276 AVRCP_BATTERY_STATUS_CRITICAL, // can not operate any more. Is provided when the battery level is going down. 277 AVRCP_BATTERY_STATUS_EXTERNAL, // Plugged to external power supply 278 AVRCP_BATTERY_STATUS_FULL_CHARGE // when the device is completely charged from the external power supply 279 } avrcp_battery_status_t; 280 281 typedef enum { 282 AVRCP_SYSTEM_STATUS_POWER_ON = 0x00, 283 AVRCP_SYSTEM_STATUS_POWER_OFF, 284 AVRCP_SYSTEM_STATUS_UNPLUGGED 285 } avrcp_system_status_t; 286 287 typedef enum { 288 AVRCP_PLAYER_APPLICATION_SETTING_ATTRIBUTE_ID_ILLEGAL = 0x00, // ValueIDs with descriptions: 289 AVRCP_PLAYER_APPLICATION_SETTING_ATTRIBUTE_ID_EQUALIZER_STATUS, // 1 - off, 2 - on 290 AVRCP_PLAYER_APPLICATION_SETTING_ATTRIBUTE_ID_REPEAT_MODE_STATUS, // 1 - off, 2 - single track repeat, 3 - all tracks repeat, 4 - group repeat 291 AVRCP_PLAYER_APPLICATION_SETTING_ATTRIBUTE_ID_SHUFFLE_STATUS, // 1 - off, 2 - all tracks shuffle , 3 - group shuffle 292 AVRCP_PLAYER_APPLICATION_SETTING_ATTRIBUTE_ID_SCAN_STATUS // 1 - off, 2 - all tracks scan , 3 - group scan 293 } avrcp_player_application_setting_attribute_id_t; 294 295 typedef enum { 296 AVCTP_CONNECTION_IDLE, 297 AVCTP_CONNECTION_W2_SEND_SDP_QUERY, 298 AVCTP_CONNECTION_W4_SDP_QUERY_COMPLETE, 299 AVCTP_CONNECTION_W4_ERTM_CONFIGURATION, 300 AVCTP_CONNECTION_W4_L2CAP_CONNECTED, 301 AVCTP_CONNECTION_W2_L2CAP_RETRY, 302 AVCTP_CONNECTION_OPENED, 303 AVCTP_W2_SEND_PRESS_COMMAND, 304 AVCTP_W2_SEND_RELEASE_COMMAND, 305 AVCTP_W4_STOP, 306 AVCTP_W2_SEND_COMMAND, 307 AVCTP_W2_SEND_RESPONSE, 308 AVCTP_W2_RECEIVE_PRESS_RESPONSE, 309 AVCTP_W2_RECEIVE_RESPONSE, 310 AVCTP_W2_SEND_FRAGMENTED_COMMAND, 311 } avctp_connection_state_t; 312 313 typedef struct { 314 uint16_t len; 315 uint8_t * value; 316 } avrcp_now_playing_info_item_t; 317 318 typedef struct { 319 uint8_t track_id[8]; 320 uint16_t track_nr; 321 char * title; 322 char * artist; 323 char * album; 324 char * genre; 325 uint32_t song_length_ms; 326 uint32_t song_position_ms; 327 } avrcp_track_t; 328 329 typedef enum { 330 AVRCP_PARSER_GET_ATTRIBUTE_HEADER = 0, // 8 bytes 331 AVRCP_PARSER_GET_ATTRIBUTE_VALUE, 332 AVRCP_PARSER_IGNORE_REST_OF_ATTRIBUTE_VALUE 333 } avrcp_parser_state_t; 334 335 336 typedef enum{ 337 AVRCP_CONTROLLER = 0, 338 AVRCP_TARGET 339 } avrcp_role_t; 340 341 typedef enum { 342 AVRCP_SHUFFLE_MODE_INVALID, 343 AVRCP_SHUFFLE_MODE_OFF, 344 AVRCP_SHUFFLE_MODE_ALL_TRACKS, 345 AVRCP_SHUFFLE_MODE_GROUP 346 } avrcp_shuffle_mode_t; 347 348 typedef enum { 349 AVRCP_REPEAT_MODE_INVALID, 350 AVRCP_REPEAT_MODE_OFF, 351 AVRCP_REPEAT_MODE_SINGLE_TRACK, 352 AVRCP_REPEAT_MODE_ALL_TRACKS, 353 AVRCP_REPEAT_MODE_GROUP 354 } avrcp_repeat_mode_t; 355 356 typedef enum { 357 RFC2978_CHARSET_MIB_UTF8 = 106 358 } rfc2978_charset_mib_enumid_t; 359 360 typedef enum { 361 AVRCP_BROWSING_MEDIA_PLAYER_LIST = 0x00, 362 AVRCP_BROWSING_MEDIA_PLAYER_VIRTUAL_FILESYSTEM, 363 AVRCP_BROWSING_SEARCH, 364 AVRCP_BROWSING_NOW_PLAYING 365 } avrcp_browsing_scope_t; 366 367 368 369 370 // BROWSING 371 typedef struct { 372 uint16_t l2cap_browsing_cid; 373 374 avctp_connection_state_t state; 375 bool wait_to_send; 376 uint8_t transaction_label; 377 // used for AVCTP fragmentation 378 uint8_t num_packets; 379 uint16_t bytes_to_send; 380 381 uint8_t *ertm_buffer; 382 uint32_t ertm_buffer_size; 383 l2cap_ertm_config_t ertm_config; 384 385 // players 386 uint8_t set_browsed_player_id; 387 uint16_t browsed_player_id; 388 389 avrcp_browsing_scope_t scope; 390 uint8_t folder_uid[8]; // or media element 391 uint16_t uid_counter; 392 393 // get folder item 394 uint8_t get_folder_items; 395 uint32_t start_item; 396 uint32_t end_item; 397 uint32_t attr_bitmap; 398 399 // item attrs 400 uint8_t get_item_attributes; 401 402 // change_path 403 uint8_t change_path; 404 uint8_t direction; 405 406 // search str 407 uint16_t search_str_len; 408 uint8_t search_str[20]; 409 uint8_t search; 410 411 // get_item_attributes 412 uint8_t get_total_nr_items; 413 avrcp_browsing_scope_t get_total_nr_items_scope; 414 415 avrcp_pdu_id_t pdu_id; 416 uint8_t browsing_status; 417 uint16_t num_items; 418 419 avrcp_parser_state_t parser_state; 420 uint8_t parser_attribute_header[AVRCP_BROWSING_ITEM_HEADER_LEN]; 421 uint8_t parser_attribute_header_pos; 422 uint8_t parsed_attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE]; 423 uint16_t parsed_attribute_value_len; 424 uint16_t parsed_attribute_value_offset; 425 uint8_t parsed_num_attributes; 426 427 // get folder items data 428 uint8_t * attr_list; 429 uint16_t attr_list_size; 430 // command 431 // uint8_t transaction_label; 432 avrcp_command_opcode_t command_opcode; 433 avrcp_command_type_t command_type; 434 avrcp_subunit_type_t subunit_type; 435 avrcp_subunit_id_t subunit_id; 436 avrcp_packet_type_t packet_type; 437 uint8_t cmd_operands[200]; 438 uint8_t cmd_operands_length; 439 440 bool incoming_declined; 441 } avrcp_browsing_connection_t; 442 443 typedef struct { 444 btstack_linked_item_t item; 445 446 avrcp_role_t role; 447 bd_addr_t remote_addr; 448 uint16_t avrcp_l2cap_psm; 449 uint16_t l2cap_signaling_cid; 450 uint16_t l2cap_mtu; 451 uint16_t avrcp_cid; 452 bool incoming_declined; 453 454 uint16_t avrcp_browsing_cid; 455 uint16_t browsing_l2cap_psm; 456 uint16_t browsing_version; 457 458 avrcp_browsing_connection_t * browsing_connection; 459 460 avctp_connection_state_t state; 461 bool wait_to_send; 462 463 // PID check 464 uint8_t reject_transport_header; 465 uint8_t transport_header; 466 uint16_t invalid_pid; 467 468 // command 469 uint8_t transaction_label; 470 avrcp_command_opcode_t command_opcode; 471 avrcp_command_type_t command_type; 472 avrcp_subunit_type_t subunit_type; 473 avrcp_subunit_id_t subunit_id; 474 avrcp_packet_type_t packet_type; 475 476 // regular commands 477 uint8_t cmd_operands[20]; 478 uint8_t cmd_operands_length; 479 480 // long/fragmented commands 481 const uint8_t * cmd_operands_fragmented_buffer; 482 uint16_t cmd_operands_fragmented_pos; 483 uint16_t cmd_operands_fragmented_len; 484 485 btstack_timer_source_t retry_timer; 486 btstack_timer_source_t press_and_hold_cmd_timer; 487 uint8_t continuous_fast_forward_cmd; 488 uint16_t notifications_enabled; 489 uint16_t notifications_to_register; 490 uint16_t notifications_to_deregister; 491 uint8_t notifications_transaction_label[AVRCP_NOTIFICATION_EVENT_MAX_VALUE+1]; 492 493 avrcp_subunit_type_t unit_type; 494 uint32_t company_id; 495 avrcp_subunit_type_t subunit_info_type; 496 const uint8_t * subunit_info_data; 497 uint16_t subunit_info_data_size; 498 499 avrcp_now_playing_info_item_t now_playing_info[AVRCP_MEDIA_ATTR_COUNT]; 500 uint8_t track_id[8]; 501 uint32_t song_length_ms; 502 uint32_t song_position_ms; 503 int total_tracks; 504 int track_nr; 505 uint8_t track_selected; 506 uint8_t track_changed; 507 508 avrcp_playback_status_t playback_status; 509 uint8_t playback_status_changed; 510 511 uint8_t playing_content_changed; 512 513 avrcp_battery_status_t battery_status; 514 uint8_t battery_status_changed; 515 uint8_t volume_percentage; 516 uint8_t notify_volume_percentage_changed; 517 518 uint8_t now_playing_info_response; 519 uint8_t now_playing_info_attr_bitmap; 520 uint8_t abort_continue_response; 521 522 // used for fragmentation 523 avrcp_media_attribute_id_t next_attr_id; 524 525 avrcp_parser_state_t parser_state; 526 uint8_t parser_attribute_header[AVRCP_ATTRIBUTE_HEADER_LEN]; 527 uint8_t parser_attribute_header_pos; 528 529 uint16_t list_size; 530 uint16_t list_offset; 531 uint8_t attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE]; 532 uint16_t attribute_value_len; 533 uint16_t attribute_value_offset; 534 535 uint32_t attribute_id; 536 537 uint8_t num_attributes; 538 uint8_t num_parsed_attributes; 539 540 uint8_t addressed_player_changed; 541 uint16_t addressed_player_id; 542 uint16_t uid_counter; 543 // PTS requires definition of max num fragments 544 uint8_t max_num_fragments; 545 uint8_t num_received_fragments; 546 547 uint8_t accept_response; 548 } avrcp_connection_t; 549 550 typedef struct { 551 avrcp_role_t role; 552 btstack_packet_handler_t avrcp_callback; 553 btstack_packet_handler_t packet_handler; 554 555 bool (*set_addressed_player_callback)(uint16_t player_id); 556 557 btstack_packet_handler_t browsing_avrcp_callback; 558 btstack_packet_handler_t browsing_packet_handler; 559 } avrcp_context_t; 560 561 562 const char * avrcp_subunit2str(uint16_t index); 563 const char * avrcp_event2str(uint16_t index); 564 const char * avrcp_operation2str(uint8_t index); 565 const char * avrcp_attribute2str(uint8_t index); 566 const char * avrcp_play_status2str(uint8_t index); 567 const char * avrcp_ctype2str(uint8_t index); 568 const char * avrcp_repeat2str(uint8_t index); 569 const char * avrcp_shuffle2str(uint8_t index); 570 571 572 void avrcp_register_controller_packet_handler(btstack_packet_handler_t avrcp_controller_packet_handler); 573 void avrcp_register_target_packet_handler(btstack_packet_handler_t avrcp_target_packet_handler); 574 575 uint8_t avrcp_cmd_opcode(uint8_t *packet, uint16_t size); 576 577 avrcp_connection_t * avrcp_get_connection_for_l2cap_signaling_cid_for_role(avrcp_role_t role, uint16_t l2cap_cid); 578 avrcp_connection_t * avrcp_get_connection_for_avrcp_cid_for_role(avrcp_role_t role, uint16_t avrcp_cid); 579 avrcp_connection_t * avrcp_get_connection_for_bd_addr_for_role(avrcp_role_t role, bd_addr_t addr); 580 581 avrcp_connection_t * avrcp_get_connection_for_browsing_cid_for_role(avrcp_role_t role, uint16_t browsing_cid); 582 avrcp_connection_t * avrcp_get_connection_for_browsing_l2cap_cid_for_role(avrcp_role_t role, uint16_t browsing_l2cap_cid); 583 avrcp_browsing_connection_t * avrcp_get_browsing_connection_for_l2cap_cid_for_role(avrcp_role_t role, uint16_t l2cap_cid); 584 585 void avrcp_request_can_send_now(avrcp_connection_t * connection, uint16_t l2cap_cid); 586 uint16_t avrcp_get_next_cid(avrcp_role_t role); 587 btstack_linked_list_t avrcp_get_connections(void); 588 589 uint16_t avrcp_sdp_sdp_query_browsing_l2cap_psm(void); 590 void avrcp_handle_sdp_client_query_attribute_value(uint8_t *packet); 591 avrcp_connection_t * get_avrcp_connection_for_browsing_cid_for_role(avrcp_role_t role, uint16_t browsing_cid); 592 avrcp_connection_t * get_avrcp_connection_for_browsing_l2cap_cid_for_role(avrcp_role_t role, uint16_t browsing_l2cap_cid); 593 avrcp_browsing_connection_t * get_avrcp_browsing_connection_for_l2cap_cid_for_role(avrcp_role_t role, uint16_t l2cap_cid); 594 // SDP query 595 void avrcp_create_sdp_record(uint8_t controller, uint8_t * service, uint32_t service_record_handle, uint8_t browsing, uint16_t supported_features, const char * service_name, const char * service_provider_name); 596 597 598 /* API_START */ 599 600 /** 601 * @brief Set up AVRCP service 602 */ 603 void avrcp_init(void); 604 605 /** 606 * @brief Register callback for the AVRCP Controller client. 607 * @param callback 608 */ 609 void avrcp_register_packet_handler(btstack_packet_handler_t callback); 610 611 /** 612 * @brief Connect to AVRCP service on a remote device, emits AVRCP_SUBEVENT_CONNECTION_ESTABLISHED with status 613 * @param remote_addr 614 * @param avrcp_cid outgoing parameter, valid if status == ERROR_CODE_SUCCESS 615 * @returns status 616 */ 617 uint8_t avrcp_connect(bd_addr_t remote_addr, uint16_t * avrcp_cid); 618 619 /** 620 * @brief Disconnect from AVRCP service 621 * @param avrcp_cid 622 * @returns status 623 */ 624 uint8_t avrcp_disconnect(uint16_t avrcp_cid); 625 626 /** 627 * @brief Set up AVRCP Browsing service 628 */ 629 void avrcp_browsing_init(void); 630 631 /** 632 * @brief Register callback for the AVRCP Browsing Controller client. 633 * @param callback 634 */ 635 void avrcp_browsing_register_packet_handler(btstack_packet_handler_t callback); 636 637 /** 638 * @brief Connect to AVRCP Browsing service on a remote device, emits AVRCP_SUBEVENT_BROWSING_CONNECTION_ESTABLISHED with status 639 * @param remote_addr 640 * @param ertm_buffer 641 * @param ertm_buffer_size 642 * @param ertm_config 643 * @param avrcp_browsing_cid outgoing parameter, valid if status == ERROR_CODE_SUCCESS 644 * @returns status 645 */ 646 uint8_t avrcp_browsing_connect(bd_addr_t remote_addr, uint8_t * ertm_buffer, uint32_t ertm_buffer_size, l2cap_ertm_config_t * ertm_config, uint16_t * avrcp_browsing_cid); 647 648 /** 649 * @brief Configure incoming connection for Browsing Service. 650 * @param avrcp_browsing_cid 651 * @param ertm_buffer 652 * @param ertm_buffer_size 653 * @param ertm_config 654 * @returns status 655 */ 656 uint8_t avrcp_browsing_configure_incoming_connection(uint16_t avrcp_browsing_cid, uint8_t * ertm_buffer, uint32_t ertm_buffer_size, l2cap_ertm_config_t * ertm_config); 657 658 /** 659 * @brief Decline incoming connection Browsing Service. 660 * @param avrcp_browsing_cid 661 * @returns status 662 */ 663 uint8_t avrcp_browsing_decline_incoming_connection(uint16_t avrcp_browsing_cid); 664 665 /** 666 * @brief Disconnect from AVRCP Browsing service 667 * @param avrcp_browsing_cid 668 * @returns status 669 */ 670 uint8_t avrcp_browsing_disconnect(uint16_t avrcp_browsing_cid); 671 672 /* API_END */ 673 674 void avrcp_browsing_register_controller_packet_handler(btstack_packet_handler_t callback); 675 void avrcp_browsing_register_target_packet_handler(btstack_packet_handler_t callback); 676 void avrcp_browsing_request_can_send_now(avrcp_browsing_connection_t * connection, uint16_t l2cap_cid); 677 678 #ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION 679 void avrcp_init_fuzz(void); 680 void avrcp_packet_handler_fuzz(uint8_t *packet, uint16_t size); 681 #endif 682 683 684 #if defined __cplusplus 685 } 686 #endif 687 688 #endif // AVRCP_H 689