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