xref: /btstack/src/classic/avrcp.h (revision be65baf476b63f90eedfe80667720885958ce4bb)
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
60*be65baf4SMilanka 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,
113be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_TOTAL_TRACKS,
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*be65baf4SMilanka Ringwald     AVRCP_PDU_ID_PLAY_ITEM = 0x74,
134c045af99SMilanka Ringwald     AVRCP_PDU_ID_UNDEFINED = 0xFF
135be32e7f1SMilanka Ringwald } avrcp_pdu_id_t;
136be32e7f1SMilanka Ringwald 
137be32e7f1SMilanka Ringwald typedef enum {
138be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_STATUS_CHANGED = 0x01,            // Change in playback status of the current track.
139be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_CHANGED = 0x02,                      // Change of current track
140be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_END = 0x03,                  // Reached end of a track
141be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_START = 0x04,                // Reached start of a track
142be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_POS_CHANGED = 0x05,               // Change in playback position. Returned after the specified playback notification change notification interval
143be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_BATT_STATUS_CHANGED = 0x06,                // Change in battery status
144be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_SYSTEM_STATUS_CHANGED = 0x07,              // Change in system status
145be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYER_APPLICATION_SETTING_CHANGED = 0x08, // Change in player application setting
146be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_NOW_PLAYING_CONTENT_CHANGED = 0x09,        // The content of the Now Playing list has changed, see 6.9.5.
147be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_AVAILABLE_PLAYERS_CHANGED = 0x0a,          // The available players have changed, see 6.9.4.
148be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_ADDRESSED_PLAYER_CHANGED = 0x0b,           // The Addressed Player has been changed, see 6.9.2.
149be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_UIDS_CHANGED = 0x0c,                       // The UIDs have changed, see 6.10.3.3.
150be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_VOLUME_CHANGED = 0x0d                      // The volume has been changed locally on the TG, see 6.13.3.
151be32e7f1SMilanka Ringwald } avrcp_notification_event_id_t;
152be32e7f1SMilanka Ringwald 
153d1207cd8SMilanka Ringwald // control command response: accepted, rejected, interim
154d1207cd8SMilanka Ringwald // status  command response: not implemented, rejected, in transition, stable
155d1207cd8SMilanka Ringwald // notify  command response: not implemented, rejected, changed
156d1207cd8SMilanka Ringwald 
157be32e7f1SMilanka Ringwald typedef enum {
158be32e7f1SMilanka Ringwald     AVRCP_CTYPE_CONTROL = 0,
159be32e7f1SMilanka Ringwald     AVRCP_CTYPE_STATUS,
160be32e7f1SMilanka Ringwald     AVRCP_CTYPE_SPECIFIC_INQUIRY,
161be32e7f1SMilanka Ringwald     AVRCP_CTYPE_NOTIFY,
162be32e7f1SMilanka Ringwald     AVRCP_CTYPE_GENERAL_INQUIRY,
163be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED5,
164be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED6,
165be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED7,
166be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_NOT_IMPLEMENTED = 8,
167be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_ACCEPTED,
168be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_REJECTED,
169be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IN_TRANSITION, // target state is in transition. A subsequent STATUS command, may result in the return of a STABLE status
170be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IMPLEMENTED_STABLE,
171be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_CHANGED_STABLE,
172be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_RESERVED,
173be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_INTERIM            // target is unable to respond with either ACCEPTED or REJECTED within 100 millisecond
174be32e7f1SMilanka Ringwald } avrcp_command_type_t;
175be32e7f1SMilanka Ringwald 
176be32e7f1SMilanka Ringwald typedef enum {
177be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_MONITOR = 0,
178be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_AUDIO = 1,
179be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PRINTER,
180be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_DISC,
181be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TAPE_RECORDER_PLAYER,
182be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TUNER,
183be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CA,
184be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA,
185be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED,
186be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PANEL = 9,
187be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_BULLETIN_BOARD,
188be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA_STORAGE,
189be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_VENDOR_UNIQUE = 0x1C,
190be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED_FOR_ALL_SUBUNIT_TYPES,
191be32e7f1SMilanka 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].
192be32e7f1SMilanka Ringwald                                               // Further extension is possible when the value of extended_unit_type is FF16, in which case another byte will be added.
193be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_UNIT = 0x1F
194be32e7f1SMilanka Ringwald } avrcp_subunit_type_t;
195be32e7f1SMilanka Ringwald 
196be32e7f1SMilanka Ringwald typedef enum {
197be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID = 0,
198be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID_IGNORE = 7
199be32e7f1SMilanka Ringwald } avrcp_subunit_id_t;
200be32e7f1SMilanka Ringwald 
201be32e7f1SMilanka Ringwald typedef enum {
202be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_VENDOR_DEPENDENT = 0x00,
2039cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_RESERVE = 0x01,
204be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_UNIT_INFO = 0x30,
2054b338011SMilanka Ringwald     AVRCP_CMD_OPCODE_SUBUNIT_INFO = 0x31,
206be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_PASS_THROUGH = 0x7C,
2079cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_VERSION = 0xB0,
2089cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_POWER = 0xB2,
2099cc1f3ceSMilanka Ringwald     AVRCP_CMD_OPCODE_UNDEFINED = 0xFF
210be32e7f1SMilanka Ringwald } avrcp_command_opcode_t;
211be32e7f1SMilanka Ringwald 
212be32e7f1SMilanka Ringwald typedef enum {
213be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_SKIP = 0x3C,
214be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_UP = 0x41,
215be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_DOWN = 0x42,
216be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_MUTE = 0x43,
217be32e7f1SMilanka Ringwald 
218be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PLAY = 0x44,
219be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_STOP = 0x45,
220be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PAUSE = 0x46,
221be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_REWIND = 0x48,
222be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FAST_FORWARD = 0x49,
223be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FORWARD = 0x4B,
2249cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_BACKWARD = 0x4C,
2259cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_UNDEFINED = 0xFF
226be32e7f1SMilanka Ringwald } avrcp_operation_id_t;
227be32e7f1SMilanka Ringwald 
228be32e7f1SMilanka Ringwald typedef enum{
229d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_STOPPED = 0x00,
230d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PLAYING,
231d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PAUSED,
232d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_FWD_SEEK,
233d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_REV_SEEK,
234d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_ERROR = 0xFF
235d1207cd8SMilanka Ringwald } avrcp_playback_status_t;
236d1207cd8SMilanka Ringwald 
237d1207cd8SMilanka Ringwald typedef enum{
238d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_NORMAL = 0x00, // Battery operation is in normal state
239d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_WARNING,       // unable to operate soon. Is provided when the battery level is going down.
240d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_CRITICAL,      // can not operate any more. Is provided when the battery level is going down.
241d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_EXTERNAL,      // Plugged to external power supply
242d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_FULL_CHARGE    // when the device is completely charged from the external power supply
243d1207cd8SMilanka Ringwald } avrcp_battery_status_t;
244d1207cd8SMilanka Ringwald 
245c045af99SMilanka Ringwald 
246c045af99SMilanka Ringwald typedef enum {
247be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_IDLE,
248f12a3722SMilanka Ringwald     AVCTP_CONNECTION_W4_SDP_QUERY_COMPLETE,
249c0a054f6SMilanka Ringwald     AVCTP_CONNECTION_W4_ERTM_CONFIGURATION,
250be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_W4_L2CAP_CONNECTED,
251be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_OPENED,
252be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_PRESS_COMMAND,
253be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_RELEASE_COMMAND,
254be32e7f1SMilanka Ringwald     AVCTP_W4_STOP,
255be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_COMMAND,
2564b338011SMilanka Ringwald     AVCTP_W2_SEND_RESPONSE,
257be32e7f1SMilanka Ringwald     AVCTP_W2_RECEIVE_PRESS_RESPONSE,
258294335f1SMilanka Ringwald     AVCTP_W2_RECEIVE_RESPONSE
259be32e7f1SMilanka Ringwald } avctp_connection_state_t;
260be32e7f1SMilanka Ringwald 
261*be65baf4SMilanka Ringwald typedef enum {
262*be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_LIST = 0x00,
263*be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_VIRTUAL_FILESYSTEM,
264*be65baf4SMilanka Ringwald     AVRCP_BROWSING_SEARCH,
265*be65baf4SMilanka Ringwald     AVRCP_BROWSING_NOW_PLAYING
266*be65baf4SMilanka Ringwald } avrcp_browsing_scope_t;
267*be65baf4SMilanka Ringwald 
268be32e7f1SMilanka Ringwald typedef struct {
269fe8b7800SMilanka Ringwald     uint16_t len;
270fe8b7800SMilanka Ringwald     uint8_t  * value;
271fe8b7800SMilanka Ringwald } avrcp_now_playing_info_item_t;
272fe8b7800SMilanka Ringwald 
273fe8b7800SMilanka Ringwald typedef struct {
274d1207cd8SMilanka Ringwald     uint8_t track_id[8];
275d1207cd8SMilanka Ringwald     uint16_t track_nr;
276d1207cd8SMilanka Ringwald     char * title;
277d1207cd8SMilanka Ringwald     char * artist;
278d1207cd8SMilanka Ringwald     char * album;
279d1207cd8SMilanka Ringwald     char * genre;
280d1207cd8SMilanka Ringwald     uint32_t song_length_ms;
281d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
282d1207cd8SMilanka Ringwald } avrcp_track_t;
283d1207cd8SMilanka Ringwald 
2841bf7a74fSMilanka Ringwald typedef enum {
2851bf7a74fSMilanka Ringwald     AVRCP_PARSER_IDLE = 0,
2861bf7a74fSMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_HEADER,       // 8 bytes
2871bf7a74fSMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_VALUE,
2881bf7a74fSMilanka Ringwald     AVRCP_PARSER_IGNORE_ATTRIBUTE_VALUE
2891bf7a74fSMilanka Ringwald } avrcp_parser_state_t;
2901bf7a74fSMilanka Ringwald 
291247956eaSMilanka Ringwald // BROWSING
292247956eaSMilanka Ringwald typedef struct {
293ed0df7b2SMilanka Ringwald     uint16_t l2cap_browsing_cid;
294ed0df7b2SMilanka Ringwald 
295247956eaSMilanka Ringwald     avctp_connection_state_t state;
296247956eaSMilanka Ringwald     uint8_t  wait_to_send;
297247956eaSMilanka Ringwald     uint8_t  transaction_label;
298ad75da14SMilanka Ringwald     // used for AVCTP fragmentation
299ad75da14SMilanka Ringwald     uint8_t  num_packets;
300ad75da14SMilanka Ringwald     uint16_t bytes_to_send;
301247956eaSMilanka Ringwald 
302247956eaSMilanka Ringwald     uint8_t *ertm_buffer;
303247956eaSMilanka Ringwald     uint32_t ertm_buffer_size;
304247956eaSMilanka Ringwald     l2cap_ertm_config_t ertm_config;
305ed0df7b2SMilanka Ringwald 
306db79553aSMilanka Ringwald     // players
307db79553aSMilanka Ringwald     uint8_t  set_addressed_player_id;
308db79553aSMilanka Ringwald     uint8_t  set_browsed_player_id;
309db79553aSMilanka Ringwald 
310db79553aSMilanka Ringwald     uint16_t addressed_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;
316*be65baf4SMilanka 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];
326*be65baf4SMilanka Ringwald 
327*be65baf4SMilanka Ringwald     // fragmentation
328*be65baf4SMilanka Ringwald     uint8_t fragmented;
329*be65baf4SMilanka Ringwald     avrcp_pdu_id_t fragmented_pdu_id;
330*be65baf4SMilanka Ringwald     uint8_t fragmented_browsing_status;
331*be65baf4SMilanka Ringwald     uint16_t fragmented_uid_counter;
332*be65baf4SMilanka Ringwald     uint16_t num_items;
333*be65baf4SMilanka Ringwald     uint8_t item_type;
334*be65baf4SMilanka Ringwald     uint16_t item_length;
335*be65baf4SMilanka Ringwald     uint16_t fragment_size;
336*be65baf4SMilanka Ringwald     uint8_t  fragment[100];
337247956eaSMilanka Ringwald } avrcp_browsing_connection_t;
338247956eaSMilanka Ringwald // BROWSING END
339247956eaSMilanka Ringwald 
340d1207cd8SMilanka Ringwald typedef struct {
341be32e7f1SMilanka Ringwald     btstack_linked_item_t    item;
342be32e7f1SMilanka Ringwald     bd_addr_t remote_addr;
343be32e7f1SMilanka Ringwald     uint16_t l2cap_signaling_cid;
3446086246cSMilanka Ringwald     uint16_t avrcp_cid;
345be32e7f1SMilanka Ringwald 
346247956eaSMilanka Ringwald     uint16_t avrcp_browsing_cid;
347247956eaSMilanka Ringwald     uint16_t browsing_l2cap_psm;
348247956eaSMilanka Ringwald     uint16_t browsing_version;
349247956eaSMilanka Ringwald 
350247956eaSMilanka Ringwald     avrcp_browsing_connection_t * browsing_connection;
351247956eaSMilanka Ringwald 
352be32e7f1SMilanka Ringwald     avctp_connection_state_t state;
353be32e7f1SMilanka Ringwald     uint8_t wait_to_send;
354be32e7f1SMilanka Ringwald 
355be32e7f1SMilanka Ringwald     // command
356be32e7f1SMilanka Ringwald     uint8_t transaction_label;
3579cc1f3ceSMilanka Ringwald     avrcp_command_opcode_t command_opcode;
358be32e7f1SMilanka Ringwald     avrcp_command_type_t command_type;
359be32e7f1SMilanka Ringwald     avrcp_subunit_type_t subunit_type;
360be32e7f1SMilanka Ringwald     avrcp_subunit_id_t   subunit_id;
361d1207cd8SMilanka Ringwald     avrcp_packet_type_t  packet_type;
362d1207cd8SMilanka Ringwald 
363be32e7f1SMilanka Ringwald     uint8_t cmd_operands[20];
364adcdded9SMilanka Ringwald     uint8_t cmd_operands_length;
365be32e7f1SMilanka Ringwald     btstack_timer_source_t press_and_hold_cmd_timer;
366d1845da3SMilanka Ringwald     uint8_t  continuous_fast_forward_cmd;
367be32e7f1SMilanka Ringwald     uint16_t notifications_enabled;
368be32e7f1SMilanka Ringwald     uint16_t notifications_to_register;
369be32e7f1SMilanka Ringwald     uint16_t notifications_to_deregister;
370fe8b7800SMilanka Ringwald 
371d1207cd8SMilanka Ringwald     avrcp_subunit_type_t unit_type;
372d1207cd8SMilanka Ringwald     uint32_t company_id;
373d1207cd8SMilanka Ringwald     avrcp_subunit_type_t subunit_info_type;
374d1207cd8SMilanka Ringwald     const uint8_t * subunit_info_data;
375d1207cd8SMilanka Ringwald     uint16_t subunit_info_data_size;
376d1207cd8SMilanka Ringwald 
377fe8b7800SMilanka Ringwald     avrcp_now_playing_info_item_t now_playing_info[AVRCP_MEDIA_ATTR_COUNT];
378d1207cd8SMilanka Ringwald     uint8_t  track_id[8];
379fe8b7800SMilanka Ringwald     uint32_t song_length_ms;
380d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
381fe8b7800SMilanka Ringwald     int total_tracks;
382fe8b7800SMilanka Ringwald     int track_nr;
383d1207cd8SMilanka Ringwald     uint8_t track_selected;
384d1207cd8SMilanka Ringwald     uint8_t track_changed;
385d1207cd8SMilanka Ringwald 
386d1207cd8SMilanka Ringwald     avrcp_playback_status_t playback_status;
387d1207cd8SMilanka Ringwald     uint8_t playback_status_changed;
388d1207cd8SMilanka Ringwald 
389d1207cd8SMilanka Ringwald     uint8_t playing_content_changed;
390d1207cd8SMilanka Ringwald 
391d1207cd8SMilanka Ringwald     avrcp_battery_status_t battery_status;
392d1207cd8SMilanka Ringwald     uint8_t battery_status_changed;
393d1207cd8SMilanka Ringwald     uint8_t volume_percentage;
394d1207cd8SMilanka Ringwald     uint8_t volume_percentage_changed;
395fe8b7800SMilanka Ringwald     uint8_t now_playing_info_response;
396d1207cd8SMilanka Ringwald     uint8_t now_playing_info_attr_bitmap;
3971bf7a74fSMilanka Ringwald     uint8_t abort_continue_response;
398d1207cd8SMilanka Ringwald 
399d1207cd8SMilanka Ringwald     // used for fragmentation
400d1207cd8SMilanka Ringwald     avrcp_media_attribute_id_t next_attr_id;
4011bf7a74fSMilanka Ringwald 
4021bf7a74fSMilanka Ringwald     avrcp_parser_state_t parser_state;
4031bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header[AVRCP_ATTRIBUTE_HEADER_LEN];
4041bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header_pos;
4051bf7a74fSMilanka Ringwald 
4061bf7a74fSMilanka Ringwald     uint16_t list_size;
4071bf7a74fSMilanka Ringwald     uint16_t list_offset;
4081bf7a74fSMilanka Ringwald     uint8_t  attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE];
4091bf7a74fSMilanka Ringwald     uint16_t attribute_value_len;
4101bf7a74fSMilanka Ringwald     uint16_t attribute_value_offset;
4111bf7a74fSMilanka Ringwald 
4121bf7a74fSMilanka Ringwald     uint32_t attribute_id;
4131bf7a74fSMilanka Ringwald 
4141bf7a74fSMilanka Ringwald     uint8_t  num_attributes;
4151bf7a74fSMilanka Ringwald     uint8_t  num_parsed_attributes;
416be32e7f1SMilanka Ringwald } avrcp_connection_t;
417be32e7f1SMilanka Ringwald 
418be32e7f1SMilanka Ringwald typedef enum {
419d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_INVALID,
420d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_OFF,
421be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_ALL_TRACKS,
422be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_GROUP
423be32e7f1SMilanka Ringwald } avrcp_shuffle_mode_t;
424be32e7f1SMilanka Ringwald 
425be32e7f1SMilanka Ringwald typedef enum {
426d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_INVALID,
427d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_OFF,
428be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_SINGLE_TRACK,
429be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_ALL_TRACKS,
430be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_GROUP
431be32e7f1SMilanka Ringwald } avrcp_repeat_mode_t;
432be32e7f1SMilanka Ringwald 
4336086246cSMilanka Ringwald typedef enum{
4346086246cSMilanka Ringwald     AVRCP_CONTROLLER = 0,
4356086246cSMilanka Ringwald     AVRCP_TARGET
4366086246cSMilanka Ringwald } avrcp_role_t;
4376086246cSMilanka Ringwald 
438fe8b7800SMilanka Ringwald typedef enum {
43960c31612SMilanka Ringwald     RFC2978_CHARSET_MIB_UTF8 = 106
440fe8b7800SMilanka Ringwald } rfc2978_charset_mib_enumid_t;
441fe8b7800SMilanka Ringwald 
4426086246cSMilanka Ringwald typedef struct {
4436086246cSMilanka Ringwald     avrcp_role_t role;
4446086246cSMilanka Ringwald     btstack_linked_list_t connections;
4456086246cSMilanka Ringwald     btstack_packet_handler_t avrcp_callback;
4466086246cSMilanka Ringwald     btstack_packet_handler_t packet_handler;
4476086246cSMilanka Ringwald 
448c0a054f6SMilanka Ringwald     btstack_packet_handler_t browsing_avrcp_callback;
449247956eaSMilanka Ringwald     btstack_packet_handler_t browsing_packet_handler;
450247956eaSMilanka Ringwald 
4516983e65eSMilanka Ringwald     // SDP query
452f12a3722SMilanka Ringwald     uint8_t parse_sdp_record;
453f12a3722SMilanka Ringwald     uint32_t record_id;
4546983e65eSMilanka Ringwald     uint16_t avrcp_cid;
455df642728SMilanka Ringwald     uint16_t avrcp_l2cap_psm;
456df642728SMilanka Ringwald     uint16_t avrcp_version;
4576983e65eSMilanka Ringwald } avrcp_context_t;
458be32e7f1SMilanka Ringwald 
459f12a3722SMilanka Ringwald 
460be32e7f1SMilanka Ringwald const char * avrcp_subunit2str(uint16_t index);
461be32e7f1SMilanka Ringwald const char * avrcp_event2str(uint16_t index);
462be32e7f1SMilanka Ringwald const char * avrcp_operation2str(uint8_t index);
463be32e7f1SMilanka Ringwald const char * avrcp_attribute2str(uint8_t index);
464be32e7f1SMilanka Ringwald const char * avrcp_play_status2str(uint8_t index);
465be32e7f1SMilanka Ringwald const char * avrcp_ctype2str(uint8_t index);
466be32e7f1SMilanka Ringwald const char * avrcp_repeat2str(uint8_t index);
467be32e7f1SMilanka Ringwald const char * avrcp_shuffle2str(uint8_t index);
468be32e7f1SMilanka Ringwald 
4696983e65eSMilanka Ringwald void avrcp_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, avrcp_context_t * context);
4706983e65eSMilanka Ringwald 
4716983e65eSMilanka 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);
4726983e65eSMilanka Ringwald uint8_t avrcp_connect(bd_addr_t bd_addr, avrcp_context_t * context, uint16_t * avrcp_cid);
4736983e65eSMilanka Ringwald void avrcp_emit_connection_established(btstack_packet_handler_t callback, uint16_t avrcp_cid, bd_addr_t addr, uint8_t status);
4746983e65eSMilanka Ringwald void avrcp_emit_connection_closed(btstack_packet_handler_t callback, uint16_t avrcp_cid);
4756983e65eSMilanka Ringwald 
4764b338011SMilanka Ringwald uint8_t avrcp_cmd_opcode(uint8_t *packet, uint16_t size);
4776983e65eSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_l2cap_signaling_cid(uint16_t l2cap_cid, avrcp_context_t * context);
47801dc6e35SMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_avrcp_cid(uint16_t avrcp_cid, avrcp_context_t * context);
479247956eaSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_bd_addr(bd_addr_t addr, avrcp_context_t * context);
4806983e65eSMilanka Ringwald void avrcp_request_can_send_now(avrcp_connection_t * connection, uint16_t l2cap_cid);
481247956eaSMilanka Ringwald uint16_t avrcp_get_next_cid(void);
482247956eaSMilanka Ringwald 
483247956eaSMilanka Ringwald // SDP query
484247956eaSMilanka Ringwald void avrcp_handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
4856983e65eSMilanka Ringwald 
486be32e7f1SMilanka Ringwald #if defined __cplusplus
487be32e7f1SMilanka Ringwald }
488be32e7f1SMilanka Ringwald #endif
489be32e7f1SMilanka Ringwald 
490be32e7f1SMilanka Ringwald #endif // __AVRCP_H