1 /*
2  * Copyright (C) 2013-2016 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef QCOM_AUDIO_HW_H
18 #define QCOM_AUDIO_HW_H
19 
20 #include <cutils/str_parms.h>
21 #include <cutils/list.h>
22 #include <hardware/audio.h>
23 
24 #include <tinyalsa/asoundlib.h>
25 #include <tinycompress/tinycompress.h>
26 
27 #include <audio_route/audio_route.h>
28 #include "voice.h"
29 
30 // dlopen() does not go through default library path search if there is a "/" in the library name.
31 #ifdef __LP64__
32 #define VISUALIZER_LIBRARY_PATH "/system/lib64/soundfx/libqcomvisualizer.so"
33 #define OFFLOAD_EFFECTS_BUNDLE_LIBRARY_PATH "/system/lib64/soundfx/libqcompostprocbundle.so"
34 #else
35 #define VISUALIZER_LIBRARY_PATH "/system/lib/soundfx/libqcomvisualizer.so"
36 #define OFFLOAD_EFFECTS_BUNDLE_LIBRARY_PATH "/system/lib/soundfx/libqcompostprocbundle.so"
37 #endif
38 #define ADM_LIBRARY_PATH "libadm.so"
39 
40 /* Flags used to initialize acdb_settings variable that goes to ACDB library */
41 #define DMIC_FLAG       0x00000002
42 #define TTY_MODE_OFF    0x00000010
43 #define TTY_MODE_FULL   0x00000020
44 #define TTY_MODE_VCO    0x00000040
45 #define TTY_MODE_HCO    0x00000080
46 #define TTY_MODE_CLEAR  0xFFFFFF0F
47 
48 #define ACDB_DEV_TYPE_OUT 1
49 #define ACDB_DEV_TYPE_IN 2
50 
51 #define MAX_SUPPORTED_CHANNEL_MASKS 2
52 #define DEFAULT_HDMI_OUT_CHANNELS   2
53 
54 /* These are the supported use cases by the hardware.
55  * Each usecase is mapped to a specific PCM device.
56  * Refer to pcm_device_table[].
57  */
58 enum {
59     USECASE_INVALID = -1,
60     /* Playback usecases */
61     USECASE_AUDIO_PLAYBACK_DEEP_BUFFER = 0,
62     USECASE_AUDIO_PLAYBACK_LOW_LATENCY,
63     USECASE_AUDIO_PLAYBACK_MULTI_CH,
64     USECASE_AUDIO_PLAYBACK_OFFLOAD,
65     USECASE_AUDIO_PLAYBACK_TTS,
66     USECASE_AUDIO_PLAYBACK_ULL,
67 
68     /* HFP Use case*/
69     USECASE_AUDIO_HFP_SCO,
70     USECASE_AUDIO_HFP_SCO_WB,
71 
72     /* Capture usecases */
73     USECASE_AUDIO_RECORD,
74     USECASE_AUDIO_RECORD_LOW_LATENCY,
75 
76     /* Voice extension usecases
77      *
78      * Following usecase are specific to voice session names created by
79      * MODEM and APPS on 8992/8994/8084/8974 platforms.
80      */
81     USECASE_VOICE_CALL,  /* Usecase setup for voice session on first subscription for DSDS/DSDA */
82     USECASE_VOICE2_CALL, /* Usecase setup for voice session on second subscription for DSDS/DSDA */
83     USECASE_VOLTE_CALL,  /* Usecase setup for VoLTE session on first subscription */
84     USECASE_QCHAT_CALL,  /* Usecase setup for QCHAT session */
85     USECASE_VOWLAN_CALL, /* Usecase setup for VoWLAN session */
86 
87     /*
88      * Following usecase are specific to voice session names created by
89      * MODEM and APPS on 8996 platforms.
90      */
91 
92     USECASE_VOICEMMODE1_CALL, /* Usecase setup for Voice/VoLTE/VoWLAN sessions on first
93                                * subscription for DSDS/DSDA
94                                */
95     USECASE_VOICEMMODE2_CALL, /* Usecase setup for voice/VoLTE/VoWLAN sessions on second
96                                * subscription for DSDS/DSDA
97                                */
98 
99     USECASE_INCALL_REC_UPLINK,
100     USECASE_INCALL_REC_DOWNLINK,
101     USECASE_INCALL_REC_UPLINK_AND_DOWNLINK,
102 
103     USECASE_AUDIO_SPKR_CALIB_RX,
104     USECASE_AUDIO_SPKR_CALIB_TX,
105 
106     USECASE_AUDIO_PLAYBACK_AFE_PROXY,
107     USECASE_AUDIO_RECORD_AFE_PROXY,
108     USECASE_AUDIO_DSM_FEEDBACK,
109 
110     AUDIO_USECASE_MAX
111 };
112 
113 const char * const use_case_table[AUDIO_USECASE_MAX];
114 
115 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
116 
117 /*
118  * tinyAlsa library interprets period size as number of frames
119  * one frame = channel_count * sizeof (pcm sample)
120  * so if format = 16-bit PCM and channels = Stereo, frame size = 2 ch * 2 = 4 bytes
121  * DEEP_BUFFER_OUTPUT_PERIOD_SIZE = 1024 means 1024 * 4 = 4096 bytes
122  * We should take care of returning proper size when AudioFlinger queries for
123  * the buffer size of an input/output stream
124  */
125 
126 enum {
127     OFFLOAD_CMD_EXIT,               /* exit compress offload thread loop*/
128     OFFLOAD_CMD_DRAIN,              /* send a full drain request to DSP */
129     OFFLOAD_CMD_PARTIAL_DRAIN,      /* send a partial drain request to DSP */
130     OFFLOAD_CMD_WAIT_FOR_BUFFER,    /* wait for buffer released by DSP */
131 };
132 
133 enum {
134     OFFLOAD_STATE_IDLE,
135     OFFLOAD_STATE_PLAYING,
136     OFFLOAD_STATE_PAUSED,
137 };
138 
139 struct offload_cmd {
140     struct listnode node;
141     int cmd;
142     int data[];
143 };
144 
145 struct stream_out {
146     struct audio_stream_out stream;
147     pthread_mutex_t lock; /* see note below on mutex acquisition order */
148     pthread_mutex_t pre_lock; /* acquire before lock to avoid DOS by playback thread */
149     pthread_cond_t  cond;
150     struct pcm_config config;
151     struct compr_config compr_config;
152     struct pcm *pcm;
153     struct compress *compr;
154     int standby;
155     int pcm_device_id;
156     unsigned int sample_rate;
157     audio_channel_mask_t channel_mask;
158     audio_format_t format;
159     audio_devices_t devices;
160     audio_output_flags_t flags;
161     audio_usecase_t usecase;
162     /* Array of supported channel mask configurations. +1 so that the last entry is always 0 */
163     audio_channel_mask_t supported_channel_masks[MAX_SUPPORTED_CHANNEL_MASKS + 1];
164     bool muted;
165     uint64_t written; /* total frames written, not cleared when entering standby */
166     audio_io_handle_t handle;
167 
168     int non_blocking;
169     int playback_started;
170     int offload_state;
171     pthread_cond_t offload_cond;
172     pthread_t offload_thread;
173     struct listnode offload_cmd_list;
174     bool offload_thread_blocked;
175 
176     stream_callback_t offload_callback;
177     void *offload_cookie;
178     struct compr_gapless_mdata gapless_mdata;
179     int send_new_metadata;
180 
181     struct audio_device *dev;
182 };
183 
184 struct stream_in {
185     struct audio_stream_in stream;
186     pthread_mutex_t lock; /* see note below on mutex acquisition order */
187     pthread_mutex_t pre_lock; /* acquire before lock to avoid DOS by capture thread */
188     struct pcm_config config;
189     struct pcm *pcm;
190     int standby;
191     int source;
192     int pcm_device_id;
193     audio_devices_t device;
194     audio_channel_mask_t channel_mask;
195     audio_usecase_t usecase;
196     bool enable_aec;
197     bool enable_ns;
198     int64_t frames_read; /* total frames read, not cleared when entering standby */
199 
200     audio_io_handle_t capture_handle;
201     audio_input_flags_t flags;
202     bool is_st_session;
203     bool is_st_session_active;
204 
205     struct audio_device *dev;
206     audio_format_t format;
207 };
208 
209 typedef enum {
210     PCM_PLAYBACK,
211     PCM_CAPTURE,
212     VOICE_CALL,
213     PCM_HFP_CALL
214 } usecase_type_t;
215 
216 union stream_ptr {
217     struct stream_in *in;
218     struct stream_out *out;
219 };
220 
221 struct audio_usecase {
222     struct listnode list;
223     audio_usecase_t id;
224     usecase_type_t  type;
225     audio_devices_t devices;
226     snd_device_t out_snd_device;
227     snd_device_t in_snd_device;
228     union stream_ptr stream;
229 };
230 
231 typedef void* (*adm_init_t)();
232 typedef void (*adm_deinit_t)(void *);
233 typedef void (*adm_register_output_stream_t)(void *, audio_io_handle_t, audio_output_flags_t);
234 typedef void (*adm_register_input_stream_t)(void *, audio_io_handle_t, audio_input_flags_t);
235 typedef void (*adm_deregister_stream_t)(void *, audio_io_handle_t);
236 typedef void (*adm_request_focus_t)(void *, audio_io_handle_t);
237 typedef void (*adm_abandon_focus_t)(void *, audio_io_handle_t);
238 
239 struct audio_device {
240     struct audio_hw_device device;
241     pthread_mutex_t lock; /* see note below on mutex acquisition order */
242     struct mixer *mixer;
243     audio_mode_t mode;
244     struct stream_in *active_input;
245     struct stream_out *primary_output;
246     struct stream_out *voice_tx_output;
247     struct stream_out *current_call_output;
248     bool bluetooth_nrec;
249     bool screen_off;
250     int *snd_dev_ref_cnt;
251     struct listnode usecase_list;
252     struct audio_route *audio_route;
253     int acdb_settings;
254     struct voice voice;
255     unsigned int cur_hdmi_channels;
256     bool bt_wb_speech_enabled;
257     bool mic_muted;
258     bool enable_voicerx;
259     bool enable_hfp;
260 
261     int snd_card;
262     void *platform;
263     void *extspk;
264 
265     void *visualizer_lib;
266     int (*visualizer_start_output)(audio_io_handle_t, int);
267     int (*visualizer_stop_output)(audio_io_handle_t, int);
268 
269     /* The pcm_params use_case_table is loaded by adev_verify_devices() upon
270      * calling adev_open().
271      *
272      * If an entry is not NULL, it can be used to determine if extended precision
273      * or other capabilities are present for the device corresponding to that usecase.
274      */
275     struct pcm_params *use_case_table[AUDIO_USECASE_MAX];
276     void *offload_effects_lib;
277     int (*offload_effects_start_output)(audio_io_handle_t, int);
278     int (*offload_effects_stop_output)(audio_io_handle_t, int);
279 
280     void *adm_data;
281     void *adm_lib;
282     adm_init_t adm_init;
283     adm_deinit_t adm_deinit;
284     adm_register_input_stream_t adm_register_input_stream;
285     adm_register_output_stream_t adm_register_output_stream;
286     adm_deregister_stream_t adm_deregister_stream;
287     adm_request_focus_t adm_request_focus;
288     adm_abandon_focus_t adm_abandon_focus;
289 
290     /* logging */
291     snd_device_t last_logged_snd_device[AUDIO_USECASE_MAX][2]; /* [out, in] */
292 
293 };
294 
295 int select_devices(struct audio_device *adev,
296                    audio_usecase_t uc_id);
297 
298 int disable_audio_route(struct audio_device *adev,
299                         struct audio_usecase *usecase);
300 
301 int disable_snd_device(struct audio_device *adev,
302                        snd_device_t snd_device);
303 
304 int enable_snd_device(struct audio_device *adev,
305                       snd_device_t snd_device);
306 
307 int enable_audio_route(struct audio_device *adev,
308                        struct audio_usecase *usecase);
309 
310 struct audio_usecase *get_usecase_from_list(struct audio_device *adev,
311                                             audio_usecase_t uc_id);
312 
313 #define LITERAL_TO_STRING(x) #x
314 #define CHECK(condition) LOG_ALWAYS_FATAL_IF(!(condition), "%s",\
315             __FILE__ ":" LITERAL_TO_STRING(__LINE__)\
316             " ASSERT_FATAL(" #condition ") failed.")
317 
318 /*
319  * NOTE: when multiple mutexes have to be acquired, always take the
320  * stream_in or stream_out mutex first, followed by the audio_device mutex.
321  */
322 
323 #endif // QCOM_AUDIO_HW_H
324