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