xref: /btstack/src/classic/avrcp.h (revision 12b7c8ec5c3729fa7a7046391fe2e35c562eb400)
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
5814e95846SMilanka 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 
1075d6a28a5SMilanka Ringwald #define AVRCP_BROWSING_MAX_NUM_ATTR_IDS 8
108be32e7f1SMilanka Ringwald typedef enum {
1094614c049SMilanka Ringwald     AVRCP_MEDIA_ATTR_ALL = 0x00000000,
110d1207cd8SMilanka Ringwald     AVRCP_MEDIA_ATTR_TITLE,
111be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_ARTIST,
112be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_ALBUM,
113be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_TRACK,
114864d08b0SMilanka Ringwald     AVRCP_MEDIA_ATTR_TOTAL_NUM_ITEMS,
115be32e7f1SMilanka Ringwald     AVRCP_MEDIA_ATTR_GENRE,
1162f511ffbSMilanka Ringwald     AVRCP_MEDIA_ATTR_SONG_LENGTH_MS,
1175d6a28a5SMilanka Ringwald     AVRCP_MEDIA_ATTR_DEFAULT_COVER_ART,
1182f511ffbSMilanka Ringwald     AVRCP_MEDIA_ATTR_NONE = 0xFFFFFFFF
119be32e7f1SMilanka Ringwald } avrcp_media_attribute_id_t;
120be32e7f1SMilanka Ringwald 
121be32e7f1SMilanka Ringwald typedef enum {
122be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_CAPABILITIES = 0x10,
123be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GetCurrentPlayerApplicationSettingValue = 0x13,
124be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_SetPlayerApplicationSettingValue = 0x14,
125be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_ELEMENT_ATTRIBUTES = 0x20,
126be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_GET_PLAY_STATUS = 0x30,
127be32e7f1SMilanka Ringwald     AVRCP_PDU_ID_REGISTER_NOTIFICATION = 0x31,
128d1207cd8SMilanka Ringwald     AVRCP_PDU_ID_REQUEST_CONTINUING_RESPONSE = 0x40,
1291bf7a74fSMilanka Ringwald     AVRCP_PDU_ID_REQUEST_ABORT_CONTINUING_RESPONSE = 0x41,
130c045af99SMilanka Ringwald     AVRCP_PDU_ID_SET_ABSOLUTE_VOLUME = 0x50,
131db79553aSMilanka Ringwald     AVRCP_PDU_ID_SET_ADDRESSED_PLAYER = 0x60,
132db79553aSMilanka Ringwald     AVRCP_PDU_ID_SET_BROWSED_PLAYER = 0x70,
133ed0df7b2SMilanka Ringwald     AVRCP_PDU_ID_GET_FOLDER_ITEMS = 0x71,
13460c31612SMilanka Ringwald     AVRCP_PDU_ID_CHANGE_PATH = 0x72,
135864d08b0SMilanka Ringwald     AVRCP_PDU_ID_GET_ITEM_ATTRIBUTES = 0x73,
136be65baf4SMilanka Ringwald     AVRCP_PDU_ID_PLAY_ITEM = 0x74,
137864d08b0SMilanka Ringwald     AVRCP_PDU_ID_GET_TOTAL_NUMBER_OF_ITEMS = 0x75,
13873fba538SMilanka Ringwald     AVRCP_PDU_ID_SEARCH = 0x80,
1394931e24aSMilanka Ringwald     AVRCP_PDU_ADD_TO_NOW_PLAYING = 0x90,
140c045af99SMilanka Ringwald     AVRCP_PDU_ID_UNDEFINED = 0xFF
141be32e7f1SMilanka Ringwald } avrcp_pdu_id_t;
142be32e7f1SMilanka Ringwald 
143be32e7f1SMilanka Ringwald typedef enum {
144be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_STATUS_CHANGED = 0x01,            // Change in playback status of the current track.
145be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_CHANGED = 0x02,                      // Change of current track
146be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_END = 0x03,                  // Reached end of a track
147be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_TRACK_REACHED_START = 0x04,                // Reached start of a track
148be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYBACK_POS_CHANGED = 0x05,               // Change in playback position. Returned after the specified playback notification change notification interval
149be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_BATT_STATUS_CHANGED = 0x06,                // Change in battery status
150be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_SYSTEM_STATUS_CHANGED = 0x07,              // Change in system status
151be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_PLAYER_APPLICATION_SETTING_CHANGED = 0x08, // Change in player application setting
152be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_NOW_PLAYING_CONTENT_CHANGED = 0x09,        // The content of the Now Playing list has changed, see 6.9.5.
153be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_AVAILABLE_PLAYERS_CHANGED = 0x0a,          // The available players have changed, see 6.9.4.
154be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_ADDRESSED_PLAYER_CHANGED = 0x0b,           // The Addressed Player has been changed, see 6.9.2.
155be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_UIDS_CHANGED = 0x0c,                       // The UIDs have changed, see 6.10.3.3.
156be32e7f1SMilanka Ringwald     AVRCP_NOTIFICATION_EVENT_VOLUME_CHANGED = 0x0d                      // The volume has been changed locally on the TG, see 6.13.3.
157be32e7f1SMilanka Ringwald } avrcp_notification_event_id_t;
158be32e7f1SMilanka Ringwald 
159d1207cd8SMilanka Ringwald // control command response: accepted, rejected, interim
160d1207cd8SMilanka Ringwald // status  command response: not implemented, rejected, in transition, stable
161d1207cd8SMilanka Ringwald // notify  command response: not implemented, rejected, changed
162d1207cd8SMilanka Ringwald 
163be32e7f1SMilanka Ringwald typedef enum {
164be32e7f1SMilanka Ringwald     AVRCP_CTYPE_CONTROL = 0,
165be32e7f1SMilanka Ringwald     AVRCP_CTYPE_STATUS,
166be32e7f1SMilanka Ringwald     AVRCP_CTYPE_SPECIFIC_INQUIRY,
167be32e7f1SMilanka Ringwald     AVRCP_CTYPE_NOTIFY,
168be32e7f1SMilanka Ringwald     AVRCP_CTYPE_GENERAL_INQUIRY,
169be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED5,
170be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED6,
171be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESERVED7,
172be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_NOT_IMPLEMENTED = 8,
173be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_ACCEPTED,
174be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_REJECTED,
175be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IN_TRANSITION, // target state is in transition. A subsequent STATUS command, may result in the return of a STABLE status
176be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_IMPLEMENTED_STABLE,
177be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_CHANGED_STABLE,
178be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_RESERVED,
179be32e7f1SMilanka Ringwald     AVRCP_CTYPE_RESPONSE_INTERIM            // target is unable to respond with either ACCEPTED or REJECTED within 100 millisecond
180be32e7f1SMilanka Ringwald } avrcp_command_type_t;
181be32e7f1SMilanka Ringwald 
182be32e7f1SMilanka Ringwald typedef enum {
183be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_MONITOR = 0,
184be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_AUDIO = 1,
185be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PRINTER,
186be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_DISC,
187be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TAPE_RECORDER_PLAYER,
188be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_TUNER,
189be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CA,
190be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA,
191be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED,
192be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_PANEL = 9,
193be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_BULLETIN_BOARD,
194be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_CAMERA_STORAGE,
195be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_VENDOR_UNIQUE = 0x1C,
196be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_RESERVED_FOR_ALL_SUBUNIT_TYPES,
197be32e7f1SMilanka 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].
198be32e7f1SMilanka Ringwald                                               // Further extension is possible when the value of extended_unit_type is FF16, in which case another byte will be added.
199be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_TYPE_UNIT = 0x1F
200be32e7f1SMilanka Ringwald } avrcp_subunit_type_t;
201be32e7f1SMilanka Ringwald 
202be32e7f1SMilanka Ringwald typedef enum {
203be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID = 0,
204be32e7f1SMilanka Ringwald     AVRCP_SUBUNIT_ID_IGNORE = 7
205be32e7f1SMilanka Ringwald } avrcp_subunit_id_t;
206be32e7f1SMilanka Ringwald 
207be32e7f1SMilanka Ringwald typedef enum {
208be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_VENDOR_DEPENDENT = 0x00,
2099cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_RESERVE = 0x01,
210be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_UNIT_INFO = 0x30,
2114b338011SMilanka Ringwald     AVRCP_CMD_OPCODE_SUBUNIT_INFO = 0x31,
212be32e7f1SMilanka Ringwald     AVRCP_CMD_OPCODE_PASS_THROUGH = 0x7C,
2139cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_VERSION = 0xB0,
2149cc1f3ceSMilanka Ringwald     // AVRCP_CMD_OPCODE_POWER = 0xB2,
2159cc1f3ceSMilanka Ringwald     AVRCP_CMD_OPCODE_UNDEFINED = 0xFF
216be32e7f1SMilanka Ringwald } avrcp_command_opcode_t;
217be32e7f1SMilanka Ringwald 
218be32e7f1SMilanka Ringwald typedef enum {
219*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_CHANNEL_UP = 0x30,
220*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_CHANNEL_DOWN = 0x31,
221*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_SELECT = 0x00,
222*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_UP = 0x01,
223*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_DOWN = 0x02,
224*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_LEFT = 0x03,
225*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_RIGHT = 0x04,
226*12b7c8ecSMilanka Ringwald     AVRCP_OPERATION_ID_ROOT_MENU = 0x09,
227*12b7c8ecSMilanka Ringwald 
228be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_SKIP = 0x3C,
229be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_UP = 0x41,
230be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_VOLUME_DOWN = 0x42,
231be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_MUTE = 0x43,
232be32e7f1SMilanka Ringwald 
233be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PLAY = 0x44,
234be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_STOP = 0x45,
235be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_PAUSE = 0x46,
236be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_REWIND = 0x48,
237be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FAST_FORWARD = 0x49,
238be32e7f1SMilanka Ringwald     AVRCP_OPERATION_ID_FORWARD = 0x4B,
2399cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_BACKWARD = 0x4C,
2409cc1f3ceSMilanka Ringwald     AVRCP_OPERATION_ID_UNDEFINED = 0xFF
241be32e7f1SMilanka Ringwald } avrcp_operation_id_t;
242be32e7f1SMilanka Ringwald 
243be32e7f1SMilanka Ringwald typedef enum{
244d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_STOPPED = 0x00,
245d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PLAYING,
246d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_PAUSED,
247d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_FWD_SEEK,
248d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_REV_SEEK,
249d1207cd8SMilanka Ringwald     AVRCP_PLAYBACK_STATUS_ERROR = 0xFF
250d1207cd8SMilanka Ringwald } avrcp_playback_status_t;
251d1207cd8SMilanka Ringwald 
252d1207cd8SMilanka Ringwald typedef enum{
253d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_NORMAL = 0x00, // Battery operation is in normal state
254d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_WARNING,       // unable to operate soon. Is provided when the battery level is going down.
255d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_CRITICAL,      // can not operate any more. Is provided when the battery level is going down.
256d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_EXTERNAL,      // Plugged to external power supply
257d1207cd8SMilanka Ringwald     AVRCP_BATTERY_STATUS_FULL_CHARGE    // when the device is completely charged from the external power supply
258d1207cd8SMilanka Ringwald } avrcp_battery_status_t;
259d1207cd8SMilanka Ringwald 
260c045af99SMilanka Ringwald 
261c045af99SMilanka Ringwald typedef enum {
262be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_IDLE,
263f12a3722SMilanka Ringwald     AVCTP_CONNECTION_W4_SDP_QUERY_COMPLETE,
264c0a054f6SMilanka Ringwald     AVCTP_CONNECTION_W4_ERTM_CONFIGURATION,
265be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_W4_L2CAP_CONNECTED,
266be32e7f1SMilanka Ringwald     AVCTP_CONNECTION_OPENED,
267be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_PRESS_COMMAND,
268be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_RELEASE_COMMAND,
269be32e7f1SMilanka Ringwald     AVCTP_W4_STOP,
270be32e7f1SMilanka Ringwald     AVCTP_W2_SEND_COMMAND,
2714b338011SMilanka Ringwald     AVCTP_W2_SEND_RESPONSE,
272be32e7f1SMilanka Ringwald     AVCTP_W2_RECEIVE_PRESS_RESPONSE,
273294335f1SMilanka Ringwald     AVCTP_W2_RECEIVE_RESPONSE
274be32e7f1SMilanka Ringwald } avctp_connection_state_t;
275be32e7f1SMilanka Ringwald 
276be65baf4SMilanka Ringwald typedef enum {
277be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_LIST = 0x00,
278be65baf4SMilanka Ringwald     AVRCP_BROWSING_MEDIA_PLAYER_VIRTUAL_FILESYSTEM,
279be65baf4SMilanka Ringwald     AVRCP_BROWSING_SEARCH,
280be65baf4SMilanka Ringwald     AVRCP_BROWSING_NOW_PLAYING
281be65baf4SMilanka Ringwald } avrcp_browsing_scope_t;
282be65baf4SMilanka Ringwald 
283be32e7f1SMilanka Ringwald typedef struct {
284fe8b7800SMilanka Ringwald     uint16_t len;
285fe8b7800SMilanka Ringwald     uint8_t  * value;
286fe8b7800SMilanka Ringwald } avrcp_now_playing_info_item_t;
287fe8b7800SMilanka Ringwald 
288fe8b7800SMilanka Ringwald typedef struct {
289d1207cd8SMilanka Ringwald     uint8_t track_id[8];
290d1207cd8SMilanka Ringwald     uint16_t track_nr;
291d1207cd8SMilanka Ringwald     char * title;
292d1207cd8SMilanka Ringwald     char * artist;
293d1207cd8SMilanka Ringwald     char * album;
294d1207cd8SMilanka Ringwald     char * genre;
295d1207cd8SMilanka Ringwald     uint32_t song_length_ms;
296d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
297d1207cd8SMilanka Ringwald } avrcp_track_t;
298d1207cd8SMilanka Ringwald 
2991bf7a74fSMilanka Ringwald typedef enum {
3008b2b4034SMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_HEADER = 0,       // 8 bytes
3011bf7a74fSMilanka Ringwald     AVRCP_PARSER_GET_ATTRIBUTE_VALUE,
30214e95846SMilanka Ringwald     AVRCP_PARSER_IGNORE_REST_OF_ATTRIBUTE_VALUE
3031bf7a74fSMilanka Ringwald } avrcp_parser_state_t;
3041bf7a74fSMilanka Ringwald 
30514e95846SMilanka Ringwald 
30614e95846SMilanka Ringwald #define AVRCP_BROWSING_ITEM_HEADER_LEN 3
30714e95846SMilanka Ringwald 
308247956eaSMilanka Ringwald // BROWSING
309247956eaSMilanka Ringwald typedef struct {
310ed0df7b2SMilanka Ringwald     uint16_t l2cap_browsing_cid;
311ed0df7b2SMilanka Ringwald 
312247956eaSMilanka Ringwald     avctp_connection_state_t state;
313247956eaSMilanka Ringwald     uint8_t  wait_to_send;
314247956eaSMilanka Ringwald     uint8_t  transaction_label;
315ad75da14SMilanka Ringwald     // used for AVCTP fragmentation
316ad75da14SMilanka Ringwald     uint8_t  num_packets;
317ad75da14SMilanka Ringwald     uint16_t bytes_to_send;
318247956eaSMilanka Ringwald 
319247956eaSMilanka Ringwald     uint8_t *ertm_buffer;
320247956eaSMilanka Ringwald     uint32_t ertm_buffer_size;
321247956eaSMilanka Ringwald     l2cap_ertm_config_t ertm_config;
322ed0df7b2SMilanka Ringwald 
323db79553aSMilanka Ringwald     // players
324db79553aSMilanka Ringwald     uint8_t  set_browsed_player_id;
325db79553aSMilanka Ringwald     uint16_t browsed_player_id;
326db79553aSMilanka Ringwald 
327be65baf4SMilanka Ringwald     avrcp_browsing_scope_t  scope;
3285d6a28a5SMilanka Ringwald     uint8_t  folder_uid[8]; // or media element
3295d6a28a5SMilanka Ringwald     uint16_t uid_counter;
3305d6a28a5SMilanka Ringwald 
3315d6a28a5SMilanka Ringwald     // get folder item
3325d6a28a5SMilanka Ringwald     uint8_t  get_folder_items;
333ed0df7b2SMilanka Ringwald     uint32_t start_item;
334ed0df7b2SMilanka Ringwald     uint32_t end_item;
3352f511ffbSMilanka Ringwald     uint32_t attr_bitmap;
336ed0df7b2SMilanka Ringwald 
3375d6a28a5SMilanka Ringwald     // item attrs
3385d6a28a5SMilanka Ringwald     uint8_t get_item_attributes;
3395d6a28a5SMilanka Ringwald 
34060c31612SMilanka Ringwald     // change_path
34160c31612SMilanka Ringwald     uint8_t  change_path;
34260c31612SMilanka Ringwald     uint8_t  direction;
343be65baf4SMilanka Ringwald 
34473fba538SMilanka Ringwald     // search str
34573fba538SMilanka Ringwald     uint16_t search_str_len;
34673fba538SMilanka Ringwald     uint8_t  search_str[20];
34773fba538SMilanka Ringwald     uint8_t  search;
34873fba538SMilanka Ringwald 
349864d08b0SMilanka Ringwald     // get_item_attributes
350864d08b0SMilanka Ringwald     uint8_t  get_total_nr_items;
351864d08b0SMilanka Ringwald     avrcp_browsing_scope_t get_total_nr_items_scope;
352864d08b0SMilanka Ringwald 
35314e95846SMilanka Ringwald     avrcp_pdu_id_t pdu_id;
35414e95846SMilanka Ringwald     uint8_t browsing_status;
355be65baf4SMilanka Ringwald     uint16_t num_items;
35614e95846SMilanka Ringwald 
35714e95846SMilanka Ringwald     avrcp_parser_state_t parser_state;
35814e95846SMilanka Ringwald     uint8_t  parser_attribute_header[AVRCP_BROWSING_ITEM_HEADER_LEN];
35914e95846SMilanka Ringwald     uint8_t  parser_attribute_header_pos;
36014e95846SMilanka Ringwald     uint8_t  parsed_attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE];
36114e95846SMilanka Ringwald     uint16_t parsed_attribute_value_len;
36214e95846SMilanka Ringwald     uint16_t parsed_attribute_value_offset;
36314e95846SMilanka Ringwald     uint8_t  parsed_num_attributes;
364247956eaSMilanka Ringwald } avrcp_browsing_connection_t;
365247956eaSMilanka Ringwald // BROWSING END
366247956eaSMilanka Ringwald 
367d1207cd8SMilanka Ringwald typedef struct {
368be32e7f1SMilanka Ringwald     btstack_linked_item_t    item;
369be32e7f1SMilanka Ringwald     bd_addr_t remote_addr;
370be32e7f1SMilanka Ringwald     uint16_t l2cap_signaling_cid;
3716086246cSMilanka Ringwald     uint16_t avrcp_cid;
372be32e7f1SMilanka Ringwald 
373247956eaSMilanka Ringwald     uint16_t avrcp_browsing_cid;
374247956eaSMilanka Ringwald     uint16_t browsing_l2cap_psm;
375247956eaSMilanka Ringwald     uint16_t browsing_version;
376247956eaSMilanka Ringwald 
377247956eaSMilanka Ringwald     avrcp_browsing_connection_t * browsing_connection;
378247956eaSMilanka Ringwald 
379be32e7f1SMilanka Ringwald     avctp_connection_state_t state;
380be32e7f1SMilanka Ringwald     uint8_t wait_to_send;
381be32e7f1SMilanka Ringwald 
382be32e7f1SMilanka Ringwald     // command
383be32e7f1SMilanka Ringwald     uint8_t transaction_label;
3849cc1f3ceSMilanka Ringwald     avrcp_command_opcode_t command_opcode;
385be32e7f1SMilanka Ringwald     avrcp_command_type_t command_type;
386be32e7f1SMilanka Ringwald     avrcp_subunit_type_t subunit_type;
387be32e7f1SMilanka Ringwald     avrcp_subunit_id_t   subunit_id;
388d1207cd8SMilanka Ringwald     avrcp_packet_type_t  packet_type;
389d1207cd8SMilanka Ringwald 
390be32e7f1SMilanka Ringwald     uint8_t cmd_operands[20];
391adcdded9SMilanka Ringwald     uint8_t cmd_operands_length;
392be32e7f1SMilanka Ringwald     btstack_timer_source_t press_and_hold_cmd_timer;
393d1845da3SMilanka Ringwald     uint8_t  continuous_fast_forward_cmd;
394be32e7f1SMilanka Ringwald     uint16_t notifications_enabled;
395be32e7f1SMilanka Ringwald     uint16_t notifications_to_register;
396be32e7f1SMilanka Ringwald     uint16_t notifications_to_deregister;
397fe8b7800SMilanka Ringwald 
398d1207cd8SMilanka Ringwald     avrcp_subunit_type_t unit_type;
399d1207cd8SMilanka Ringwald     uint32_t company_id;
400d1207cd8SMilanka Ringwald     avrcp_subunit_type_t subunit_info_type;
401d1207cd8SMilanka Ringwald     const uint8_t * subunit_info_data;
402d1207cd8SMilanka Ringwald     uint16_t subunit_info_data_size;
403d1207cd8SMilanka Ringwald 
404fe8b7800SMilanka Ringwald     avrcp_now_playing_info_item_t now_playing_info[AVRCP_MEDIA_ATTR_COUNT];
405d1207cd8SMilanka Ringwald     uint8_t  track_id[8];
406fe8b7800SMilanka Ringwald     uint32_t song_length_ms;
407d1207cd8SMilanka Ringwald     uint32_t song_position_ms;
408fe8b7800SMilanka Ringwald     int total_tracks;
409fe8b7800SMilanka Ringwald     int track_nr;
410d1207cd8SMilanka Ringwald     uint8_t track_selected;
411d1207cd8SMilanka Ringwald     uint8_t track_changed;
412d1207cd8SMilanka Ringwald 
413d1207cd8SMilanka Ringwald     avrcp_playback_status_t playback_status;
414d1207cd8SMilanka Ringwald     uint8_t playback_status_changed;
415d1207cd8SMilanka Ringwald 
416d1207cd8SMilanka Ringwald     uint8_t playing_content_changed;
417d1207cd8SMilanka Ringwald 
418d1207cd8SMilanka Ringwald     avrcp_battery_status_t battery_status;
419d1207cd8SMilanka Ringwald     uint8_t battery_status_changed;
420d1207cd8SMilanka Ringwald     uint8_t volume_percentage;
421d1207cd8SMilanka Ringwald     uint8_t volume_percentage_changed;
422fe8b7800SMilanka Ringwald     uint8_t now_playing_info_response;
423d1207cd8SMilanka Ringwald     uint8_t now_playing_info_attr_bitmap;
4241bf7a74fSMilanka Ringwald     uint8_t abort_continue_response;
425d1207cd8SMilanka Ringwald 
426d1207cd8SMilanka Ringwald     // used for fragmentation
427d1207cd8SMilanka Ringwald     avrcp_media_attribute_id_t next_attr_id;
4281bf7a74fSMilanka Ringwald 
4291bf7a74fSMilanka Ringwald     avrcp_parser_state_t parser_state;
4301bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header[AVRCP_ATTRIBUTE_HEADER_LEN];
4311bf7a74fSMilanka Ringwald     uint8_t  parser_attribute_header_pos;
4321bf7a74fSMilanka Ringwald 
4331bf7a74fSMilanka Ringwald     uint16_t list_size;
4341bf7a74fSMilanka Ringwald     uint16_t list_offset;
4351bf7a74fSMilanka Ringwald     uint8_t  attribute_value[AVRCP_MAX_ATTRIBUTTE_SIZE];
4361bf7a74fSMilanka Ringwald     uint16_t attribute_value_len;
4371bf7a74fSMilanka Ringwald     uint16_t attribute_value_offset;
4381bf7a74fSMilanka Ringwald 
4391bf7a74fSMilanka Ringwald     uint32_t attribute_id;
4401bf7a74fSMilanka Ringwald 
4411bf7a74fSMilanka Ringwald     uint8_t  num_attributes;
4421bf7a74fSMilanka Ringwald     uint8_t  num_parsed_attributes;
4438b2b4034SMilanka Ringwald 
4448b2b4034SMilanka Ringwald     // PTS requires definition of max num fragments
4458b2b4034SMilanka Ringwald     uint8_t max_num_fragments;
4468b2b4034SMilanka Ringwald     uint8_t num_received_fragments;
447be32e7f1SMilanka Ringwald } avrcp_connection_t;
448be32e7f1SMilanka Ringwald 
449be32e7f1SMilanka Ringwald typedef enum {
450d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_INVALID,
451d5ff3b26SMatthias Ringwald     AVRCP_SHUFFLE_MODE_OFF,
452be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_ALL_TRACKS,
453be32e7f1SMilanka Ringwald     AVRCP_SHUFFLE_MODE_GROUP
454be32e7f1SMilanka Ringwald } avrcp_shuffle_mode_t;
455be32e7f1SMilanka Ringwald 
456be32e7f1SMilanka Ringwald typedef enum {
457d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_INVALID,
458d5ff3b26SMatthias Ringwald     AVRCP_REPEAT_MODE_OFF,
459be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_SINGLE_TRACK,
460be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_ALL_TRACKS,
461be32e7f1SMilanka Ringwald     AVRCP_REPEAT_MODE_GROUP
462be32e7f1SMilanka Ringwald } avrcp_repeat_mode_t;
463be32e7f1SMilanka Ringwald 
4646086246cSMilanka Ringwald typedef enum{
4656086246cSMilanka Ringwald     AVRCP_CONTROLLER = 0,
4666086246cSMilanka Ringwald     AVRCP_TARGET
4676086246cSMilanka Ringwald } avrcp_role_t;
4686086246cSMilanka Ringwald 
469fe8b7800SMilanka Ringwald typedef enum {
47060c31612SMilanka Ringwald     RFC2978_CHARSET_MIB_UTF8 = 106
471fe8b7800SMilanka Ringwald } rfc2978_charset_mib_enumid_t;
472fe8b7800SMilanka Ringwald 
4736086246cSMilanka Ringwald typedef struct {
4746086246cSMilanka Ringwald     avrcp_role_t role;
4756086246cSMilanka Ringwald     btstack_linked_list_t connections;
4766086246cSMilanka Ringwald     btstack_packet_handler_t avrcp_callback;
4776086246cSMilanka Ringwald     btstack_packet_handler_t packet_handler;
4786086246cSMilanka Ringwald 
479c0a054f6SMilanka Ringwald     btstack_packet_handler_t browsing_avrcp_callback;
480247956eaSMilanka Ringwald     btstack_packet_handler_t browsing_packet_handler;
481247956eaSMilanka Ringwald 
4826983e65eSMilanka Ringwald     // SDP query
483f12a3722SMilanka Ringwald     uint8_t parse_sdp_record;
484f12a3722SMilanka Ringwald     uint32_t record_id;
4856983e65eSMilanka Ringwald     uint16_t avrcp_cid;
486df642728SMilanka Ringwald     uint16_t avrcp_l2cap_psm;
487df642728SMilanka Ringwald     uint16_t avrcp_version;
4886983e65eSMilanka Ringwald } avrcp_context_t;
489be32e7f1SMilanka Ringwald 
490f12a3722SMilanka Ringwald 
491be32e7f1SMilanka Ringwald const char * avrcp_subunit2str(uint16_t index);
492be32e7f1SMilanka Ringwald const char * avrcp_event2str(uint16_t index);
493be32e7f1SMilanka Ringwald const char * avrcp_operation2str(uint8_t index);
494be32e7f1SMilanka Ringwald const char * avrcp_attribute2str(uint8_t index);
495be32e7f1SMilanka Ringwald const char * avrcp_play_status2str(uint8_t index);
496be32e7f1SMilanka Ringwald const char * avrcp_ctype2str(uint8_t index);
497be32e7f1SMilanka Ringwald const char * avrcp_repeat2str(uint8_t index);
498be32e7f1SMilanka Ringwald const char * avrcp_shuffle2str(uint8_t index);
499be32e7f1SMilanka Ringwald 
5006983e65eSMilanka Ringwald void avrcp_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size, avrcp_context_t * context);
5016983e65eSMilanka Ringwald 
5026983e65eSMilanka 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);
5036983e65eSMilanka Ringwald uint8_t avrcp_connect(bd_addr_t bd_addr, avrcp_context_t * context, uint16_t * avrcp_cid);
5046983e65eSMilanka Ringwald void avrcp_emit_connection_established(btstack_packet_handler_t callback, uint16_t avrcp_cid, bd_addr_t addr, uint8_t status);
5056983e65eSMilanka Ringwald void avrcp_emit_connection_closed(btstack_packet_handler_t callback, uint16_t avrcp_cid);
5066983e65eSMilanka Ringwald 
5074b338011SMilanka Ringwald uint8_t avrcp_cmd_opcode(uint8_t *packet, uint16_t size);
5086983e65eSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_l2cap_signaling_cid(uint16_t l2cap_cid, avrcp_context_t * context);
50901dc6e35SMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_avrcp_cid(uint16_t avrcp_cid, avrcp_context_t * context);
510247956eaSMilanka Ringwald avrcp_connection_t * get_avrcp_connection_for_bd_addr(bd_addr_t addr, avrcp_context_t * context);
5116983e65eSMilanka Ringwald void avrcp_request_can_send_now(avrcp_connection_t * connection, uint16_t l2cap_cid);
512247956eaSMilanka Ringwald uint16_t avrcp_get_next_cid(void);
513247956eaSMilanka Ringwald 
514247956eaSMilanka Ringwald // SDP query
515247956eaSMilanka Ringwald void avrcp_handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
5166983e65eSMilanka Ringwald 
517be32e7f1SMilanka Ringwald #if defined __cplusplus
518be32e7f1SMilanka Ringwald }
519be32e7f1SMilanka Ringwald #endif
520be32e7f1SMilanka Ringwald 
521be32e7f1SMilanka Ringwald #endif // __AVRCP_H