1 /*
2  * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 
8 /*****************************************************************************
9  **
10  **  Name:           btc_av_api.h
11  **
12  **  Description:    This is the public interface file for the advanced
13  **                  audio/video streaming (AV) subsystem of BTC.
14  **
15  *****************************************************************************/
16 
17 #ifndef __BTC_AV_API_H__
18 #define __BTC_AV_API_H__
19 
20 #include "common/bt_target.h"
21 #include "bta/bta_av_api.h"
22 #include "stack/a2d_api.h"
23 #include "stack/a2d_sbc.h"
24 
25 #if (BTC_AV_INCLUDED == TRUE)
26 /*****************************************************************************
27  **  Constants and data types
28  *****************************************************************************/
29 
30 /* Codec type */
31 #define BTC_AV_CODEC_NONE       0xFF
32 #define BTC_AV_CODEC_SBC        A2D_MEDIA_CT_SBC        /* SBC media codec type */
33 
34 #define BTC_AV_CODEC_PCM        0x5                     /* Raw PCM */
35 
36 typedef UINT8 tBTC_AV_CODEC_ID;
37 
38 /* AV features masks */
39 #define BTC_AV_FEAT_RCTG        BTA_AV_FEAT_RCTG      /* remote control target */
40 #define BTC_AV_FEAT_RCCT        BTA_AV_FEAT_RCCT      /* remote control controller */
41 #define BTC_AV_FEAT_METADATA    BTA_AV_FEAT_METADATA  /* remote control Metadata Transfer command/response */
42 
43 typedef UINT16 tBTC_AV_FEAT;
44 
45 /* AV channel values */
46 #define BTC_AV_CHNL_MSK         BTA_AV_CHNL_MSK
47 #define BTC_AV_CHNL_AUDIO       BTA_AV_CHNL_AUDIO       /* audio channel */
48 #define BTC_AV_CHNL_VIDEO       BTA_AV_CHNL_VIDEO       /* video channel */
49 typedef UINT8 tBTC_AV_CHNL;
50 
51 typedef UINT8 tBTC_AV_HNDL;
52 
53 /* Operation id list for BTC_AvRemoteCmd */
54 #define BTC_AV_ID_SELECT      0x00    /* select */
55 #define BTC_AV_ID_UP          0x01    /* up */
56 #define BTC_AV_ID_DOWN        0x02    /* down */
57 #define BTC_AV_ID_LEFT        0x03    /* left */
58 #define BTC_AV_ID_RIGHT       0x04    /* right */
59 #define BTC_AV_ID_RIGHT_UP    0x05    /* right-up */
60 #define BTC_AV_ID_RIGHT_DOWN  0x06    /* right-down */
61 #define BTC_AV_ID_LEFT_UP     0x07    /* left-up */
62 #define BTC_AV_ID_LEFT_DOWN   0x08    /* left-down */
63 #define BTC_AV_ID_ROOT_MENU   0x09    /* root menu */
64 #define BTC_AV_ID_SETUP_MENU  0x0A    /* setup menu */
65 #define BTC_AV_ID_CONT_MENU   0x0B    /* contents menu */
66 #define BTC_AV_ID_FAV_MENU    0x0C    /* favorite menu */
67 #define BTC_AV_ID_EXIT        0x0D    /* exit */
68 #define BTC_AV_ID_0           0x20    /* 0 */
69 #define BTC_AV_ID_1           0x21    /* 1 */
70 #define BTC_AV_ID_2           0x22    /* 2 */
71 #define BTC_AV_ID_3           0x23    /* 3 */
72 #define BTC_AV_ID_4           0x24    /* 4 */
73 #define BTC_AV_ID_5           0x25    /* 5 */
74 #define BTC_AV_ID_6           0x26    /* 6 */
75 #define BTC_AV_ID_7           0x27    /* 7 */
76 #define BTC_AV_ID_8           0x28    /* 8 */
77 #define BTC_AV_ID_9           0x29    /* 9 */
78 #define BTC_AV_ID_DOT         0x2A    /* dot */
79 #define BTC_AV_ID_ENTER       0x2B    /* enter */
80 #define BTC_AV_ID_CLEAR       0x2C    /* clear */
81 #define BTC_AV_ID_CHAN_UP     0x30    /* channel up */
82 #define BTC_AV_ID_CHAN_DOWN   0x31    /* channel down */
83 #define BTC_AV_ID_PREV_CHAN   0x32    /* previous channel */
84 #define BTC_AV_ID_SOUND_SEL   0x33    /* sound select */
85 #define BTC_AV_ID_INPUT_SEL   0x34    /* input select */
86 #define BTC_AV_ID_DISP_INFO   0x35    /* display information */
87 #define BTC_AV_ID_HELP        0x36    /* help */
88 #define BTC_AV_ID_PAGE_UP     0x37    /* page up */
89 #define BTC_AV_ID_PAGE_DOWN   0x38    /* page down */
90 #define BTC_AV_ID_POWER       0x40    /* power */
91 #define BTC_AV_ID_VOL_UP      0x41    /* volume up */
92 #define BTC_AV_ID_VOL_DOWN    0x42    /* volume down */
93 #define BTC_AV_ID_MUTE        0x43    /* mute */
94 #define BTC_AV_ID_PLAY        0x44    /* play */
95 #define BTC_AV_ID_STOP        0x45    /* stop */
96 #define BTC_AV_ID_PAUSE       0x46    /* pause */
97 #define BTC_AV_ID_RECORD      0x47    /* record */
98 #define BTC_AV_ID_REWIND      0x48    /* rewind */
99 #define BTC_AV_ID_FAST_FOR    0x49    /* fast forward */
100 #define BTC_AV_ID_EJECT       0x4A    /* eject */
101 #define BTC_AV_ID_FORWARD     0x4B    /* forward */
102 #define BTC_AV_ID_BACKWARD    0x4C    /* backward */
103 #define BTC_AV_ID_ANGLE       0x50    /* angle */
104 #define BTC_AV_ID_SUBPICT     0x51    /* subpicture */
105 #define BTC_AV_ID_F1          0x71    /* F1 */
106 #define BTC_AV_ID_F2          0x72    /* F2 */
107 #define BTC_AV_ID_F3          0x73    /* F3 */
108 #define BTC_AV_ID_F4          0x74    /* F4 */
109 #define BTC_AV_ID_F5          0x75    /* F5 */
110 #define BTC_AV_ID_VENDOR      0x7E    /* vendor unique */
111 #define BTC_AV_KEYPRESSED_RELEASE 0x80
112 
113 typedef UINT8 tBTC_AV_RC;
114 
115 /* State flag for pass through command */
116 #define BTC_AV_STATE_PRESS      0    /* key pressed */
117 #define BTC_AV_STATE_RELEASE    1  /* key released */
118 
119 typedef UINT8 tBTC_AV_STATE;
120 
121 typedef UINT8 tBTC_AV_RC_HNDL;
122 
123 /* Command codes for BTC_AvVendorCmd */
124 #define BTC_AV_CMD_CTRL         0
125 #define BTC_AV_CMD_STATUS       1
126 #define BTC_AV_CMD_SPEC_INQ     2
127 #define BTC_AV_CMD_NOTIF        3
128 #define BTC_AV_CMD_GEN_INQ      4
129 
130 typedef UINT8 tBTC_AV_CMD;
131 
132 /* AV callback events */
133 #define BTC_AV_OPEN_EVT         0       /* connection opened */
134 #define BTC_AV_CLOSE_EVT        1       /* connection closed */
135 #define BTC_AV_START_EVT        2       /* stream data transfer started */
136 #define BTC_AV_STOP_EVT         3       /* stream data transfer stopped */
137 #define BTC_AV_RC_OPEN_EVT      4       /* remote control channel open */
138 #define BTC_AV_RC_CLOSE_EVT     5       /* remote control channel closed */
139 #define BTC_AV_REMOTE_CMD_EVT   6      /* remote control command */
140 #define BTC_AV_REMOTE_RSP_EVT   7      /* remote control response */
141 #define BTC_AV_META_MSG_EVT     8      /* metadata messages */
142 
143 typedef UINT8 tBTC_AV_EVT;
144 
145 #define BTC_AV_FEEDING_ASYNCHRONOUS 0   /* asynchronous feeding, use tx av timer */
146 #define BTC_AV_FEEDING_SYNCHRONOUS  1   /* synchronous feeding, no av tx timer */
147 
148 #define BTC_AV_MAX_SYNCHRONOUS_LATENCY 80 /* max latency in ms for BTC_AV_FEEDING_SYNCHRONOUS */
149 #define BTC_AV_MIN_SYNCHRONOUS_LATENCY 4 /* min latency in ms for BTC_AV_FEEDING_SYNCHRONOUS */
150 
151 typedef UINT8 tBTC_AV_FEEDING_MODE;
152 
153 #define BTC_AV_CHANNEL_MODE_MONO    A2D_SBC_IE_CH_MD_MONO
154 #define BTC_AV_CHANNEL_MODE_STEREO  A2D_SBC_IE_CH_MD_STEREO
155 #define BTC_AV_CHANNEL_MODE_JOINT   A2D_SBC_IE_CH_MD_JOINT
156 #define BTC_AV_CHANNEL_MODE_DUAL    A2D_SBC_IE_CH_MD_DUAL
157 
158 typedef UINT8 tBTC_AV_CHANNEL_MODE;
159 
160 /**
161  * Structure used to configure the AV codec capabilities/config
162  */
163 typedef struct {
164     tBTC_AV_CODEC_ID id;             /* Codec ID (in terms of BTC) */
165     UINT8 info[AVDT_CODEC_SIZE];     /* Codec info (can be config or capabilities) */
166 } tBTC_AV_CODEC_INFO;
167 
168 /**
169  * Structure used to configure the AV media feeding
170  */
171 typedef struct {
172     UINT16 sampling_freq;   /* 44100, 48000 etc */
173     UINT16 num_channel;     /* 1 for mono or 2 stereo */
174     UINT8  bit_per_sample;  /* Number of bits per sample (8, 16) */
175 } tBTC_AV_MEDIA_FEED_CFG_PCM;
176 
177 typedef union {
178     tBTC_AV_MEDIA_FEED_CFG_PCM pcm;     /* Raw PCM feeding format */
179 } tBTC_AV_MEDIA_FEED_CFG;
180 
181 typedef struct {
182     tBTC_AV_CODEC_ID format;        /* Media codec identifier */
183     tBTC_AV_MEDIA_FEED_CFG cfg;     /* Media codec configuration */
184 } tBTC_AV_MEDIA_FEEDINGS;
185 
186 
187 #ifdef __cplusplus
188 }
189 #endif
190 
191 #endif  ///BTC_AV_INCLUDED == TRUE
192 
193 #endif /* __BTC_AV_API_H__ */
194