xref: /btstack/src/classic/avrcp.h (revision 864d08b05a7d11fcb7b1b1bcd2b404914cdab7ee)
1be32e7f1SMilanka Ringwald /*
2be32e7f1SMilanka Ringwald  * Copyright (C) 2016 BlueKitchen GmbH
3be32e7f1SMilanka Ringwald  *
4be32e7f1SMilanka Ringwald  * Redistribution and use in source and binary forms, with or without
5be32e7f1SMilanka Ringwald  * modification, are permitted provided that the following conditions
6be32e7f1SMilanka Ringwald  * are met:
7be32e7f1SMilanka Ringwald  *
8be32e7f1SMilanka Ringwald  * 1. Redistributions of source code must retain the above copyright
9be32e7f1SMilanka Ringwald  *    notice, this list of conditions and the following disclaimer.
10be32e7f1SMilanka Ringwald  * 2. Redistributions in binary form must reproduce the above copyright
11be32e7f1SMilanka Ringwald  *    notice, this list of conditions and the following disclaimer in the
12be32e7f1SMilanka Ringwald  *    documentation and/or other materials provided with the distribution.
13be32e7f1SMilanka Ringwald  * 3. Neither the name of the copyright holders nor the names of
14be32e7f1SMilanka Ringwald  *    contributors may be used to endorse or promote products derived
15be32e7f1SMilanka Ringwald  *    from this software without specific prior written permission.
16be32e7f1SMilanka Ringwald  * 4. Any redistribution, use, or modification is done solely for
17be32e7f1SMilanka Ringwald  *    personal benefit and not for any commercial purpose or for
18be32e7f1SMilanka Ringwald  *    monetary gain.
19be32e7f1SMilanka Ringwald  *
20be32e7f1SMilanka Ringwald  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21be32e7f1SMilanka Ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22be32e7f1SMilanka Ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23be32e7f1SMilanka Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24be32e7f1SMilanka Ringwald  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25be32e7f1SMilanka Ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26be32e7f1SMilanka Ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27be32e7f1SMilanka Ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28be32e7f1SMilanka Ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29be32e7f1SMilanka Ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30be32e7f1SMilanka Ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31be32e7f1SMilanka Ringwald  * SUCH DAMAGE.
32be32e7f1SMilanka Ringwald  *
33be32e7f1SMilanka Ringwald  * Please inquire about commercial licensing options at
34be32e7f1SMilanka Ringwald  * [email protected]
35be32e7f1SMilanka Ringwald  *
36be32e7f1SMilanka Ringwald  */
37be32e7f1SMilanka Ringwald 
38be32e7f1SMilanka Ringwald /*
39be32e7f1SMilanka Ringwald  * avrcp.h
40be32e7f1SMilanka Ringwald  *
41be32e7f1SMilanka Ringwald  * Audio/Video Remote Control Profile
42be32e7f1SMilanka Ringwald  *
43be32e7f1SMilanka Ringwald  */
44be32e7f1SMilanka Ringwald 
45be32e7f1SMilanka Ringwald #ifndef __AVRCP_H
46be32e7f1SMilanka Ringwald #define __AVRCP_H
47be32e7f1SMilanka Ringwald 
48be32e7f1SMilanka Ringwald #include <stdint.h>
4931a5a745SMatthias Ringwald #include "btstack_run_loop.h"
5031a5a745SMatthias Ringwald #include "btstack_linked_list.h"
51be32e7f1SMilanka Ringwald 
52be32e7f1SMilanka Ringwald #if defined __cplusplus
53be32e7f1SMilanka Ringwald extern "C" {
54be32e7f1SMilanka Ringwald #endif
55be32e7f1SMilanka Ringwald 
56be32e7f1SMilanka Ringwald #define BT_SIG_COMPANY_ID 0x001958
57fe8b7800SMilanka Ringwald #define AVRCP_MEDIA_ATTR_COUNT 7
581bf7a74fSMilanka Ringwald #define AVRCP_MAX_ATTRIBUTTE_SIZE 100
591bf7a74fSMilanka Ringwald #define AVRCP_ATTRIBUTE_HEADER_LEN  8
60be65baf4SMilanka Ringwald #define AVRCP_MAX_FOLDER_NAME_SIZE      20
616983e65eSMilanka Ringwald 
626983e65eSMilanka Ringwald typedef enum {
63e0bbf3edSMilanka Ringwald     AVRCP_STATUS_INVALID_COMMAND = 0,           // sent if TG received a PDU that it did not understand.
64e0bbf3edSMilanka Ringwald     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.
65e0bbf3edSMilanka Ringwald     AVRCP_STATUS_SPECIFIED_PARAMETER_NOT_FOUND, // sent if the parameter ID is understood, but content is wrong or corrupted.
66e0bbf3edSMilanka Ringwald     AVRCP_STATUS_INTERNAL_ERROR,                // sent if there are error conditions not covered by a more specific error code.
67e0bbf3edSMilanka Ringwald     AVRCP_STATUS_SUCCESS,                       // sent if the operation was successful.
68e0bbf3edSMilanka Ringwald     AVRCP_STATUS_UID_CHANGED,                   // sent if the UIDs on the device have changed.
69e0bbf3edSMilanka Ringwald     AVRCP_STATUS_RESERVED_6,
70e0bbf3edSMilanka Ringwald     AVRCP_STATUS_INVALID_DIRECTION,             // The Direction parameter is invalid. Valid for command: Change Path
71e0bbf3edSMilanka Ringwald     AVRCP_STATUS_NOT_A_DIRECTORY,               // The UID provided does not refer to a folder item. Valid for command: Change Path
72e0bbf3edSMilanka Ringwald     AVRCP_STATUS_DOES_NOT_EXIST,                // The UID provided does not refer to any currently valid. Valid for command: Change Path, PlayItem, AddToNowPlaying, GetItemAttributes
73e0bbf3edSMilanka Ringwald     AVRCP_STATUS_INVALID_SCOPE,                 // The scope parameter is invalid. Valid for command: GetFolderItems, PlayItem, AddToNowPlayer, GetItemAttributes,
74e0bbf3edSMilanka Ringwald     AVRCP_STATUS_RANGE_OUT_OF_BOUNDS,           // The start of range provided is not valid. Valid for command: GetFolderItems
75e0bbf3edSMilanka Ringwald     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
76e0bbf3edSMilanka Ringwald     AVRCP_STATUS_MEDIA_IN_USE,                  // The media is not able to be used for this operation at this time. Valid for command: PlayItem, AddToNowPlaying
77e0bbf3edSMilanka Ringwald     AVRCP_STATUS_NOW_PLAYING_LIST_FULL,         // No more items can be added to the Now Playing List. Valid for command: AddToNowPlaying
78e0bbf3edSMilanka Ringwald     AVRCP_STATUS_SEARCH_NOT_SUPPORTED,          // The Browsed Media Player does not support search. Valid for command: Search
79e0bbf3edSMilanka Ringwald     AVRCP_STATUS_SEARCH_IN_PROGRESS,            // A search operation is already in progress. Valid for command: Search
80e0bbf3edSMilanka Ringwald     AVRCP_STATUS_INVALID_PLAYER_ID,             // The specified Player Id does not refer to a valid player. Valid for command: SetAddressedPlayer, SetBrowsedPlayer
81e0bbf3edSMilanka Ringwald     AVRCP_STATUS_PLAYER_NOT_BROWSABLE,          // The Player Id supplied refers to a Media Player which does not support browsing. Valid for command: SetBrowsedPlayer
82e0bbf3edSMilanka Ringwald     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
83e0bbf3edSMilanka Ringwald     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
84e0bbf3edSMilanka Ringwald     AVRCP_STATUS_NO_AVAILABLE_PLAYERS,
85e0bbf3edSMilanka Ringwald     AVRCP_STATUS_ADDRESSED_PLAYER_CHANGED,       // Valid for command: Register Notification
86e0bbf3edSMilanka Ringwald     AVRCP_STATUS_RESERVED                       // 0x17 - 0xFF
87e0bbf3edSMilanka Ringwald } avrcp_status_code_t;
88e0bbf3edSMilanka Ringwald 
89e0bbf3edSMilanka Ringwald typedef enum {
906983e65eSMilanka Ringwald     AVRCP_SINGLE_PACKET= 0,
916983e65eSMilanka Ringwald     AVRCP_START_PACKET    ,
926983e65eSMilanka Ringwald     AVRCP_CONTINUE_PACKET ,
936983e65eSMilanka Ringwald     AVRCP_END_PACKET
946983e65eSMilanka Ringwald } avrcp_packet_type_t;
956983e65eSMilanka Ringwald 
966983e65eSMilanka Ringwald typedef enum {
976983e65eSMilanka Ringwald     AVRCP_COMMAND_FRAME = 0,
986983e65eSMilanka Ringwald     AVRCP_RESPONSE_FRAME
996983e65eSMilanka Ringwald } avrcp_frame_type_t;
1006983e65eSMilanka Ringwald 
101be32e7f1SMilanka Ringwald 
102be32e7f1SMilanka Ringwald typedef enum {
103be32e7f1SMilanka Ringwald     AVRCP_CAPABILITY_ID_COMPANY = 0x02,
104be32e7f1SMilanka Ringwald     AVRCP_CAPABILITY_ID_EVENT = 0x03
105be32e7f1SMilanka Ringwald } avrcp_capability_id_t;
106be32e7f1SMilanka Ringwald 
107be32e7f1SMilanka Ringwald typedef enum {
1082f511ffbSMilanka Ringwald     AVRCP_MEDIA_ATTR_ALL = 0,
109d1207cd8SMilanka Ringwald     AVRCP_MEDIA_ATTR_TITLE,
110be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_ARTIST,
111be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_ALBUM,
112be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_TRACK,
113*864d08b0SMilanka Ringwald     AVRCP_MEDIA_ATTR_TOTAL_NUM_ITEMS,
114be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_GENRE,
1152f511ffbSMilanka Ringwald     AVRCP_MEDIA_ATTR_SONG_LENGTH_MS,
1162f511ffbSMilanka Ringwald     AVRCP_MEDIA_ATTR_NONE = 0xFFFFFFFF
117be32e7f1SMilanka Ringwald } avrcp_media_attribute_id_t;
118be32e7f1SMilanka Ringwald 
119be32e7f1SMilanka Ringwald typedef enum {
120be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_CAPABILITIES = 0x10,
121be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GetCurrentPlayerApplicationSettingValue = 0x13,
122be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_SetPlayerApplicationSettingValue = 0x14,
123be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_ELEMENT_ATTRIBUTES = 0x20,
124be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_PLAY_STATUS = 0x30,
125be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_REGISTER_NOTIFICATION = 0x31,
126d1207cd8SMilanka Ringwald     AVRCP_PDU_ID_REQUEST_CONTINUING_RESPONSE = 0x40,
1271bf7a74fSMilanka Ringwald     AVRCP_PDU_ID_REQUEST_ABORT_CONTINUING_RESPONSE = 0x41,
128c045af99SMilanka Ringwald     AVRCP_PDU_ID_SET_ABSOLUTE_VOLUME = 0x50,
129db79553aSMilanka Ringwald     AVRCP_PDU_ID_SET_ADDRESSED_PLAYER = 0x60,
130db79553aSMilanka Ringwald     AVRCP_PDU_ID_SET_BROWSED_PLAYER = 0x70,
131ed0df7b2SMilanka Ringwald     AVRCP_PDU_ID_GET_FOLDER_ITEMS = 0x71,
13260c31612SMilanka Ringwald     AVRCP_PDU_ID_CHANGE_PATH = 0x72,
133*864d08b0SMilanka Ringwald     AVRCP_PDU_ID_GET_ITEM_ATTRIBUTES = 0x73,
134be65baf4SMilanka Ringwald     AVRCP_PDU_ID_PLAY_ITEM = 0x74,
135*864d08b0SMilanka Ringwald     AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS = 0x75,
13673fba538SMilanka Ringwald     AVRCP_PDU_ID_SEARCH = 0x80,
137c045af99SMilanka Ringwald     AVRCP_PDU_ID_UNDEFINED = 0xFF
138be32e7f1SMilanka Ringwald } avrcp_pdu_id_t;
139be32e7f1SMilanka Ringwald 
140be32e7f1SMilanka Ringwald typedef enum {
141be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_STATUS_CHANGED = 0x01,            // Change in playback status of the current track.
142be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_CHANGED = 0x02,                      // Change of current track
143be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_END = 0x03,                  // Reached end of a track
144be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_START = 0x04,                // Reached start of a track
145be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_POS_CHANGED = 0x05,               // Change in playback position. Returned after the specified playback notification change notification interval
146be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_BATT_STATUS_CHANGED = 0x06,                // Change in battery status
147be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_SYSTEM_STATUS_CHANGED = 0x07,              // Change in system status
148be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYER_APPLICATION_SETTING_CHANGED = 0x08, // Change in player application setting
149be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_NOW_PLAYING_CONTENT_CHANGED = 0x09,        // The content of the Now Playing list has changed, see 6.9.5.
150be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_AVAILABLE_PLAYERS_CHANGED = 0x0a,          // The available players have changed, see 6.9.4.
151be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_ADDRESSED_PLAYER_CHANGED = 0x0b,           // The Addressed Player has been changed, see 6.9.2.
152be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_UIDS_CHANGED = 0x0c,                       // The UIDs have changed, see 6.10.3.3.
153be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_VOLUME_CHANGED = 0x0d                      // The volume has been changed locally on the TG, see 6.13.3.
154be32e7f1SMilanka Ringwald } avrcp_notification_event_id_t;
155be32e7f1SMilanka Ringwald 
156d1207cd8SMilanka Ringwald // control command response: accepted, rejected, interim
157d1207cd8SMilanka Ringwald // status  command response: not implemented, rejected, in transition, stable
158d1207cd8SMilanka Ringwald // notify  command response: not implemented, rejected, changed
159d1207cd8SMilanka Ringwald 
160be32e7f1SMilanka Ringwald typedef enum {
161be32e7f1SMilanka Ringwald     AVRCP_CTYPE_CONTROL = 0,
162be32e7f1SMilanka Ringwald     AVRCP_CTYPE_STATUS,
163be32e7f1SMilanka Ringwald     AVRCP_CTYPE_SPECIFIC_INQUIRY,
164be32e7f1SMilanka Ringwald     AVRCP_CTYPE_NOTIFY,
165be32e7f1SMilanka Ringwald     AVRCP_CTYPE_GENERAL_INQUIRY,
166be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED5,
167be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED6,
168be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED7,
169be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_NOT_IMPLEMENTED = 8,
170be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_ACCEPTED,
171be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_REJECTED,
172be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IN_TRANSITION, // target state is in transition. A subsequent STATUS command, may result in the return of a STABLE status
173be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IMPLEMENTED_STABLE,
174be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_CHANGED_STABLE,
175be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_RESERVED,
176be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_INTERIM            // target is unable to respond with either ACCEPTED or REJECTED within 100 millisecond
177be32e7f1SMilanka Ringwald } avrcp_command_type_t;
178be32e7f1SMilanka Ringwald 
179be32e7f1SMilanka Ringwald typedef enum {
180be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_MONITOR = 0,
181be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_AUDIO = 1,
182be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PRINTER,
183be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_DISC,
184be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TAPE_RECORDER_PLAYER,
185be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TUNER,
186be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CA,
187be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA,
188be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED,
189be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PANEL = 9,
190be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_BULLETIN_BOARD,
191be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA_STORAGE,
192be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_VENDOR_UNIQUE = 0x1C,
193be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED_FOR_ALL_SUBUNIT_TYPES,
194be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_EXTENDED_TO_NEXT_BYTE, // The unit_type field may take value 1E16, which means that the field is extended to the following byte. In that case, an additional byte for extended_unit_type will be added immediately following operand[1].
195be32e7f1SMilanka Ringwald                                               // Further extension is possible when the value of extended_unit_type is FF16, in which case another byte will be added.
196be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_UNIT = 0x1F
197be32e7f1SMilanka Ringwald } avrcp_subunit_type_t;
198be32e7f1SMilanka Ringwald 
199be32e7f1SMilanka Ringwald typedef enum {
200be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID = 0,
201be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID_IGNORE = 7
202be32e7f1SMilanka Ringwald } avrcp_subunit_id_t;
203be32e7f1SMilanka Ringwald 
204be32e7f1SMilanka Ringwald typedef enum {
205be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_VENDOR_DEPENDENT = 0x00,
2069cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_RESERVE = 0x01,
207be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_UNIT_INFO = 0x30,
2084b338011SMilanka Ringwald     AVRCP_CMD_OPCODE_SUBUNIT_INFO = 0x31,
209be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_PASS_THROUGH = 0x7C,
2109cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_VERSION = 0xB0,
2119cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_POWER = 0xB2,
2129cc1f3ceSMilanka Ringwald     AVRCP_CMD_OPCODE_UNDEFINED = 0xFF
213be32e7f1SMilanka Ringwald } avrcp_command_opcode_t;
214be32e7f1SMilanka Ringwald 
215be32e7f1SMilanka Ringwald typedef enum {
216be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_SKIP = 0x3C,
217be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_UP = 0x41,
218be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_DOWN = 0x42,
219be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_MUTE = 0x43,
220be32e7f1SMilanka Ringwald 
221be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PLAY = 0x44,
222be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_STOP = 0x45,
223be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PAUSE = 0x46,
224be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_REWIND = 0x48,
225be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FAST_FORWARD = 0x49,
226be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FORWARD = 0x4B,
2279cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_BACKWARD = 0x4C,
2289cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_UNDEFINED = 0xFF
229be32e7f1SMilanka Ringwald } avrcp_operation_id_t;
230be32e7f1SMilanka Ringwald 
231be32e7f1SMilanka Ringwald typedef enum{
232d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_STOPPED = 0x00,
233d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PLAYING,
234d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PAUSED,
235d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_FWD_SEEK,
236d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_REV_SEEK,
237d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_ERROR = 0xFF
238d1207cd8SMilanka Ringwald } avrcp_playback_status_t;
239d1207cd8SMilanka Ringwald 
240d1207cd8SMilanka Ringwald typedef enum{
241d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_NORMAL = 0x00, // Battery operation is in normal state
242d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_WARNING,       // unable to operate soon. Is provided when the battery level is going down.
243d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_CRITICAL,      // can not operate any more. Is provided when the battery level is going down.
244d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_EXTERNAL,      // Plugged to external power supply
245d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_FULL_CHARGE    // when the device is completely charged from the external power supply
246d1207cd8SMilanka Ringwald } avrcp_battery_status_t;
247d1207cd8SMilanka Ringwald 
248c045af99SMilanka Ringwald 
249c045af99SMilanka Ringwald typedef enum {
250be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_IDLE,
251f12a3722SMilanka Ringwald     AVCTP_CONNECTION_W4_SDP_QUERY_COMPLETE,
252c0a054f6SMilanka Ringwald     AVCTP_CONNECTION_W4_ERTM_CONFIGURATION,
253be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_W4_L2CAP_CONNECTED,
254be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_OPENED,
255be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_PRESS_COMMAND,
256be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_RELEASE_COMMAND,
257be32e7f1SMilanka Ringwald     AVCTP_W4_STOP,
258be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_COMMAND,
2594b338011SMilanka Ringwald     AVCTP_W2_SEND_RESPONSE,
260be32e7f1SMilanka Ringwald     AVCTP_W2_RECEIVE_PRESS_RESPONSE,
261294335f1SMilanka Ringwald     AVCTP_W2_RECEIVE_RESPONSE
262be32e7f1SMilanka Ringwald } avctp_connection_state_t;
263be32e7f1SMilanka Ringwald 
264be65baf4SMilanka Ringwald typedef enum {
265be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_LIST = 0x00,
266be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_VIRTUAL_FILESYSTEM,
267be65baf4SMilanka Ringwald     AVRCP_BROWSING_SEARCH,
268be65baf4SMilanka Ringwald     AVRCP_BROWSING_NOW_PLAYING
269be65baf4SMilanka Ringwald } avrcp_browsing_scope_t;
270be65baf4SMilanka Ringwald 
271be32e7f1SMilanka Ringwald typedef struct {
272fe8b7800SMilanka Ringwald     uint16_t len;
273fe8b7800SMilanka Ringwald     uint8_t  * value;
274fe8b7800SMilanka Ringwald } avrcp_now_playing_info_item_t;
275fe8b7800SMilanka Ringwald 
276fe8b7800SMilanka Ringwald typedef struct {
277d1207cd8SMilanka Ringwald     uint8_t track_id[8];
278d1207cd8SMilanka Ringwald     uint16_t track_nr;
279d1207cd8SMilanka Ringwald     char * title;
280d1207cd8SMilanka Ringwald     char * artist;
281d1207cd8SMilanka Ringwald     char * album;
282d1207cd8SMilanka Ringwald     char * genre;
283d1207cd8SMilanka Ringwald     uint32_t song_length_ms;
284d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
285d1207cd8SMilanka Ringwald } avrcp_track_t;
286d1207cd8SMilanka Ringwald 
2871bf7a74fSMilanka Ringwald typedef enum {
2881bf7a74fSMilanka Ringwald     AVRCP_PARSER_IDLE = 0,
2891bf7a74fSMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_HEADER,       // 8 bytes
2901bf7a74fSMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_VALUE,
2911bf7a74fSMilanka Ringwald     AVRCP_PARSER_IGNORE_ATTRIBUTE_VALUE
2921bf7a74fSMilanka Ringwald } avrcp_parser_state_t;
2931bf7a74fSMilanka Ringwald 
294247956eaSMilanka Ringwald // BROWSING
295247956eaSMilanka Ringwald typedef struct {
296ed0df7b2SMilanka Ringwald     uint16_t l2cap_browsing_cid;
297ed0df7b2SMilanka Ringwald 
298247956eaSMilanka Ringwald     avctp_connection_state_t state;
299247956eaSMilanka Ringwald     uint8_t  wait_to_send;
300247956eaSMilanka Ringwald     uint8_t  transaction_label;
301ad75da14SMilanka Ringwald     // used for AVCTP fragmentation
302ad75da14SMilanka Ringwald     uint8_t  num_packets;
303ad75da14SMilanka Ringwald     uint16_t bytes_to_send;
304247956eaSMilanka Ringwald 
305247956eaSMilanka Ringwald     uint8_t *ertm_buffer;
306247956eaSMilanka Ringwald     uint32_t ertm_buffer_size;
307247956eaSMilanka Ringwald     l2cap_ertm_config_t ertm_config;
308ed0df7b2SMilanka Ringwald 
309db79553aSMilanka Ringwald     // players
310db79553aSMilanka Ringwald     uint8_t  set_browsed_player_id;
311db79553aSMilanka Ringwald     uint16_t browsed_player_id;
312db79553aSMilanka Ringwald     uint16_t browsed_player_uid_counter;
313db79553aSMilanka Ringwald 
314ed0df7b2SMilanka Ringwald     // get folder item
315ed0df7b2SMilanka Ringwald     uint8_t  get_folder_item;
316be65baf4SMilanka Ringwald     avrcp_browsing_scope_t  scope;
317ed0df7b2SMilanka Ringwald     uint32_t start_item;
318ed0df7b2SMilanka Ringwald     uint32_t end_item;
3192f511ffbSMilanka Ringwald     uint32_t attr_bitmap;
320ed0df7b2SMilanka Ringwald 
32160c31612SMilanka Ringwald     // change_path
32260c31612SMilanka Ringwald     uint8_t  change_path;
32360c31612SMilanka Ringwald     uint8_t  direction;
32460c31612SMilanka Ringwald     uint16_t uid_counter;
32560c31612SMilanka Ringwald     uint8_t  folder_uid[8];
326be65baf4SMilanka Ringwald 
32773fba538SMilanka Ringwald     // search str
32873fba538SMilanka Ringwald     uint16_t search_str_len;
32973fba538SMilanka Ringwald     uint8_t  search_str[20];
33073fba538SMilanka Ringwald     uint8_t  search;
33173fba538SMilanka Ringwald 
332*864d08b0SMilanka Ringwald     // get_item_attributes
333*864d08b0SMilanka Ringwald     uint8_t  get_total_nr_items;
334*864d08b0SMilanka Ringwald     avrcp_browsing_scope_t get_total_nr_items_scope;
335*864d08b0SMilanka Ringwald 
336be65baf4SMilanka Ringwald     // fragmentation
337be65baf4SMilanka Ringwald     uint8_t fragmented;
338be65baf4SMilanka Ringwald     avrcp_pdu_id_t fragmented_pdu_id;
339be65baf4SMilanka Ringwald     uint8_t fragmented_browsing_status;
340be65baf4SMilanka Ringwald     uint16_t fragmented_uid_counter;
341be65baf4SMilanka Ringwald     uint16_t num_items;
342be65baf4SMilanka Ringwald     uint8_t item_type;
343be65baf4SMilanka Ringwald     uint16_t item_length;
344be65baf4SMilanka Ringwald     uint16_t fragment_size;
345be65baf4SMilanka Ringwald     uint8_t  fragment[100];
346247956eaSMilanka Ringwald } avrcp_browsing_connection_t;
347247956eaSMilanka Ringwald // BROWSING END
348247956eaSMilanka Ringwald 
349d1207cd8SMilanka Ringwald typedef struct {
350be32e7f1SMilanka Ringwald     btstack_linked_item_t    item;
351be32e7f1SMilanka Ringwald     bd_addr_t remote_addr;
352be32e7f1SMilanka Ringwald     uint16_t l2cap_signaling_cid;
3536086246cSMilanka Ringwald     uint16_t avrcp_cid;
354be32e7f1SMilanka Ringwald 
355247956eaSMilanka Ringwald     uint16_t avrcp_browsing_cid;
356247956eaSMilanka Ringwald     uint16_t browsing_l2cap_psm;
357247956eaSMilanka Ringwald     uint16_t browsing_version;
358247956eaSMilanka Ringwald 
359247956eaSMilanka Ringwald     avrcp_browsing_connection_t * browsing_connection;
360247956eaSMilanka Ringwald 
361be32e7f1SMilanka Ringwald     avctp_connection_state_t state;
362be32e7f1SMilanka Ringwald     uint8_t wait_to_send;
363be32e7f1SMilanka Ringwald 
364be32e7f1SMilanka Ringwald     // command
365be32e7f1SMilanka Ringwald     uint8_t transaction_label;
3669cc1f3ceSMilanka Ringwald     avrcp_command_opcode_t command_opcode;
367be32e7f1SMilanka Ringwald     avrcp_command_type_t command_type;
368be32e7f1SMilanka Ringwald     avrcp_subunit_type_t subunit_type;
369be32e7f1SMilanka Ringwald     avrcp_subunit_id_t   subunit_id;
370d1207cd8SMilanka Ringwald     avrcp_packet_type_t  packet_type;
371d1207cd8SMilanka Ringwald 
372be32e7f1SMilanka Ringwald     uint8_t cmd_operands[20];
373adcdded9SMilanka Ringwald     uint8_t cmd_operands_length;
374be32e7f1SMilanka Ringwald     btstack_timer_source_t press_and_hold_cmd_timer;
375d1845da3SMilanka Ringwald     uint8_t  continuous_fast_forward_cmd;
376be32e7f1SMilanka Ringwald     uint16_t notifications_enabled;
377be32e7f1SMilanka Ringwald     uint16_t notifications_to_register;
378be32e7f1SMilanka Ringwald     uint16_t notifications_to_deregister;
379fe8b7800SMilanka Ringwald 
380d1207cd8SMilanka Ringwald     avrcp_subunit_type_t unit_type;
381d1207cd8SMilanka Ringwald     uint32_t company_id;
382d1207cd8SMilanka Ringwald     avrcp_subunit_type_t subunit_info_type;
383d1207cd8SMilanka Ringwald     const uint8_t * subunit_info_data;
384d1207cd8SMilanka Ringwald     uint16_t subunit_info_data_size;
385d1207cd8SMilanka Ringwald 
386fe8b7800SMilanka Ringwald     avrcp_now_playing_info_item_t now_playing_info[AVRCP_MEDIA_ATTR_COUNT];
387d1207cd8SMilanka Ringwald     uint8_t  track_id[8];
388fe8b7800SMilanka Ringwald     uint32_t song_length_ms;
389d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
390fe8b7800SMilanka Ringwald     int total_tracks;
391fe8b7800SMilanka Ringwald     int track_nr;
392d1207cd8SMilanka Ringwald     uint8_t track_selected;
393d1207cd8SMilanka Ringwald     uint8_t track_changed;
394d1207cd8SMilanka Ringwald 
395d1207cd8SMilanka Ringwald     avrcp_playback_status_t playback_status;
396d1207cd8SMilanka Ringwald     uint8_t playback_status_changed;
397d1207cd8SMilanka Ringwald 
398d1207cd8SMilanka Ringwald     uint8_t playing_content_changed;
399d1207cd8SMilanka Ringwald 
400d1207cd8SMilanka Ringwald     avrcp_battery_status_t battery_status;
401d1207cd8SMilanka Ringwald     uint8_t battery_status_changed;
402d1207cd8SMilanka Ringwald     uint8_t volume_percentage;
403d1207cd8SMilanka Ringwald     uint8_t volume_percentage_changed;
404fe8b7800SMilanka Ringwald     uint8_t now_playing_info_response;
405d1207cd8SMilanka Ringwald     uint8_t now_playing_info_attr_bitmap;
4061bf7a74fSMilanka Ringwald     uint8_t abort_continue_response;
407d1207cd8SMilanka Ringwald 
408d1207cd8SMilanka Ringwald     // used for fragmentation
409d1207cd8SMilanka Ringwald     avrcp_media_attribute_id_t next_attr_id;
4101bf7a74fSMilanka Ringwald 
4111bf7a74fSMilanka Ringwald     avrcp_parser_state_t parser_state;
4121bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header[AVRCP_ATTRIBUTE_HEADER_LEN];
4131bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header_pos;
4141bf7a74fSMilanka Ringwald 
4151bf7a74fSMilanka Ringwald     uint16_t list_size;
4161bf7a74fSMilanka Ringwald     uint16_t list_offset;
4171bf7a74fSMilanka Ringwald     uint8_t  attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE];
4181bf7a74fSMilanka Ringwald     uint16_t attribute_value_len;
4191bf7a74fSMilanka Ringwald     uint16_t attribute_value_offset;
4201bf7a74fSMilanka Ringwald 
4211bf7a74fSMilanka Ringwald     uint32_t attribute_id;
4221bf7a74fSMilanka Ringwald 
4231bf7a74fSMilanka Ringwald     uint8_t  num_attributes;
4241bf7a74fSMilanka Ringwald     uint8_t  num_parsed_attributes;
425be32e7f1SMilanka Ringwald } avrcp_connection_t;
426be32e7f1SMilanka Ringwald 
427be32e7f1SMilanka Ringwald typedef enum {
428d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_INVALID,
429d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_OFF,
430be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_ALL_TRACKS,
431be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_GROUP
432be32e7f1SMilanka Ringwald } avrcp_shuffle_mode_t;
433be32e7f1SMilanka Ringwald 
434be32e7f1SMilanka Ringwald typedef enum {
435d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_INVALID,
436d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_OFF,
437be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_SINGLE_TRACK,
438be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_ALL_TRACKS,
439be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_GROUP
440be32e7f1SMilanka Ringwald } avrcp_repeat_mode_t;
441be32e7f1SMilanka Ringwald 
4426086246cSMilanka Ringwald typedef enum{
4436086246cSMilanka Ringwald     AVRCP_CONTROLLER = 0,
4446086246cSMilanka Ringwald     AVRCP_TARGET
4456086246cSMilanka Ringwald } avrcp_role_t;
4466086246cSMilanka Ringwald 
447fe8b7800SMilanka Ringwald typedef enum {
44860c31612SMilanka Ringwald     RFC2978_CHARSET_MIB_UTF8 = 106
449fe8b7800SMilanka Ringwald } rfc2978_charset_mib_enumid_t;
450fe8b7800SMilanka Ringwald 
4516086246cSMilanka Ringwald typedef struct {
4526086246cSMilanka Ringwald     avrcp_role_t role;
4536086246cSMilanka Ringwald     btstack_linked_list_t connections;
4546086246cSMilanka Ringwald     btstack_packet_handler_t avrcp_callback;
4556086246cSMilanka Ringwald     btstack_packet_handler_t packet_handler;
4566086246cSMilanka Ringwald 
457c0a054f6SMilanka Ringwald     btstack_packet_handler_t browsing_avrcp_callback;
458247956eaSMilanka Ringwald     btstack_packet_handler_t browsing_packet_handler;
459247956eaSMilanka Ringwald 
4606983e65eSMilanka Ringwald     // SDP query
461f12a3722SMilanka Ringwald     uint8_t parse_sdp_record;
462f12a3722SMilanka Ringwald     uint32_t record_id;
4636983e65eSMilanka Ringwald     uint16_t avrcp_cid;
464df642728SMilanka Ringwald     uint16_t avrcp_l2cap_psm;
465df642728SMilanka Ringwald     uint16_t avrcp_version;
4666983e65eSMilanka Ringwald } avrcp_context_t;
467be32e7f1SMilanka Ringwald 
468f12a3722SMilanka Ringwald 
469be32e7f1SMilanka Ringwald const char * avrcp_subunit2str(uint16_t index);
470be32e7f1SMilanka Ringwald const char * avrcp_event2str(uint16_t index);
471be32e7f1SMilanka Ringwald const char * avrcp_operation2str(uint8_t index);
472be32e7f1SMilanka Ringwald const char * avrcp_attribute2str(uint8_t index);
473be32e7f1SMilanka Ringwald const char * avrcp_play_status2str(uint8_t index);
474be32e7f1SMilanka Ringwald const char * avrcp_ctype2str(uint8_t index);
475be32e7f1SMilanka Ringwald const char * avrcp_repeat2str(uint8_t index);
476be32e7f1SMilanka Ringwald const char * avrcp_shuffle2str(uint8_t index);
477be32e7f1SMilanka Ringwald 
4786983e65eSMilanka Ringwald void avrcp_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, avrcp_context_t * context);
4796983e65eSMilanka Ringwald 
4806983e65eSMilanka Ringwald 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);
4816983e65eSMilanka Ringwald uint8_t avrcp_connect(bd_addr_t bd_addr, avrcp_context_t * context, uint16_t * avrcp_cid);
4826983e65eSMilanka Ringwald void avrcp_emit_connection_established(btstack_packet_handler_t callback, uint16_t avrcp_cid, bd_addr_t addr, uint8_t status);
4836983e65eSMilanka Ringwald void avrcp_emit_connection_closed(btstack_packet_handler_t callback, uint16_t avrcp_cid);
4846983e65eSMilanka Ringwald 
4854b338011SMilanka Ringwald uint8_t avrcp_cmd_opcode(uint8_t *packet, uint16_t size);
4866983e65eSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_l2cap_signaling_cid(uint16_t l2cap_cid, avrcp_context_t * context);
48701dc6e35SMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_avrcp_cid(uint16_t avrcp_cid, avrcp_context_t * context);
488247956eaSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_bd_addr(bd_addr_t addr, avrcp_context_t * context);
4896983e65eSMilanka Ringwald void avrcp_request_can_send_now(avrcp_connection_t * connection, uint16_t l2cap_cid);
490247956eaSMilanka Ringwald uint16_t avrcp_get_next_cid(void);
491247956eaSMilanka Ringwald 
492247956eaSMilanka Ringwald // SDP query
493247956eaSMilanka Ringwald void avrcp_handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
4946983e65eSMilanka Ringwald 
495be32e7f1SMilanka Ringwald #if defined __cplusplus
496be32e7f1SMilanka Ringwald }
497be32e7f1SMilanka Ringwald #endif
498be32e7f1SMilanka Ringwald 
499be32e7f1SMilanka Ringwald #endif // __AVRCP_H