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