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