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