• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #define ERROR_LOG_ENTRIES 16
55 
56 typedef enum card_status_t {
57     CARD_STATUS_OFFLINE,
58     CARD_STATUS_ONLINE
59 } card_status_t;
60 
61 /* These are the supported use cases by the hardware.
62  * Each usecase is mapped to a specific PCM device.
63  * Refer to pcm_device_table[].
64  */
65 enum {
66     USECASE_INVALID = -1,
67     /* Playback usecases */
68     USECASE_AUDIO_PLAYBACK_DEEP_BUFFER = 0,
69     USECASE_AUDIO_PLAYBACK_LOW_LATENCY,
70     USECASE_AUDIO_PLAYBACK_MULTI_CH,
71     USECASE_AUDIO_PLAYBACK_OFFLOAD,
72     USECASE_AUDIO_PLAYBACK_TTS,
73     USECASE_AUDIO_PLAYBACK_ULL,
74 
75     /* HFP Use case*/
76     USECASE_AUDIO_HFP_SCO,
77     USECASE_AUDIO_HFP_SCO_WB,
78 
79     /* Capture usecases */
80     USECASE_AUDIO_RECORD,
81     USECASE_AUDIO_RECORD_LOW_LATENCY,
82 
83     /* Voice extension usecases
84      *
85      * Following usecase are specific to voice session names created by
86      * MODEM and APPS on 8992/8994/8084/8974 platforms.
87      */
88     USECASE_VOICE_CALL,  /* Usecase setup for voice session on first subscription for DSDS/DSDA */
89     USECASE_VOICE2_CALL, /* Usecase setup for voice session on second subscription for DSDS/DSDA */
90     USECASE_VOLTE_CALL,  /* Usecase setup for VoLTE session on first subscription */
91     USECASE_QCHAT_CALL,  /* Usecase setup for QCHAT session */
92     USECASE_VOWLAN_CALL, /* Usecase setup for VoWLAN session */
93 
94     /*
95      * Following usecase are specific to voice session names created by
96      * MODEM and APPS on 8996 platforms.
97      */
98 
99     USECASE_VOICEMMODE1_CALL, /* Usecase setup for Voice/VoLTE/VoWLAN sessions on first
100                                * subscription for DSDS/DSDA
101                                */
102     USECASE_VOICEMMODE2_CALL, /* Usecase setup for voice/VoLTE/VoWLAN sessions on second
103                                * subscription for DSDS/DSDA
104                                */
105 
106     USECASE_INCALL_REC_UPLINK,
107     USECASE_INCALL_REC_DOWNLINK,
108     USECASE_INCALL_REC_UPLINK_AND_DOWNLINK,
109 
110     USECASE_AUDIO_SPKR_CALIB_RX,
111     USECASE_AUDIO_SPKR_CALIB_TX,
112 
113     USECASE_AUDIO_PLAYBACK_AFE_PROXY,
114     USECASE_AUDIO_RECORD_AFE_PROXY,
115     USECASE_AUDIO_DSM_FEEDBACK,
116 
117     AUDIO_USECASE_MAX
118 };
119 
120 const char * const use_case_table[AUDIO_USECASE_MAX];
121 
122 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
123 
124 /*
125  * tinyAlsa library interprets period size as number of frames
126  * one frame = channel_count * sizeof (pcm sample)
127  * so if format = 16-bit PCM and channels = Stereo, frame size = 2 ch * 2 = 4 bytes
128  * DEEP_BUFFER_OUTPUT_PERIOD_SIZE = 1024 means 1024 * 4 = 4096 bytes
129  * We should take care of returning proper size when AudioFlinger queries for
130  * the buffer size of an input/output stream
131  */
132 
133 enum {
134     OFFLOAD_CMD_EXIT,               /* exit compress offload thread loop*/
135     OFFLOAD_CMD_DRAIN,              /* send a full drain request to DSP */
136     OFFLOAD_CMD_PARTIAL_DRAIN,      /* send a partial drain request to DSP */
137     OFFLOAD_CMD_WAIT_FOR_BUFFER,    /* wait for buffer released by DSP */
138     OFFLOAD_CMD_ERROR,              /* offload playback hit some error */
139 };
140 
141 enum {
142     OFFLOAD_STATE_IDLE,
143     OFFLOAD_STATE_PLAYING,
144     OFFLOAD_STATE_PAUSED,
145 };
146 
147 struct offload_cmd {
148     struct listnode node;
149     int cmd;
150     int data[];
151 };
152 
153 enum {
154     ERROR_CODE_STANDBY,
155     ERROR_CODE_WRITE,
156 };
157 
158 struct error_log_entry {
159     int32_t code;
160     int32_t count;
161     int64_t first_time;
162     int64_t last_time;
163 };
164 
165 struct error_log {
166     uint32_t errors;
167     uint32_t idx;
168     struct error_log_entry entries[ERROR_LOG_ENTRIES];
169 };
170 
171 struct stream_out {
172     struct audio_stream_out stream;
173     pthread_mutex_t lock; /* see note below on mutex acquisition order */
174     pthread_mutex_t pre_lock; /* acquire before lock to avoid DOS by playback thread */
175     pthread_cond_t  cond;
176     struct pcm_config config;
177     struct compr_config compr_config;
178     struct pcm *pcm;
179     struct compress *compr;
180     int standby;
181     int pcm_device_id;
182     unsigned int sample_rate;
183     audio_channel_mask_t channel_mask;
184     audio_format_t format;
185     audio_devices_t devices;
186     audio_output_flags_t flags;
187     audio_usecase_t usecase;
188     /* Array of supported channel mask configurations. +1 so that the last entry is always 0 */
189     audio_channel_mask_t supported_channel_masks[MAX_SUPPORTED_CHANNEL_MASKS + 1];
190     bool muted;
191     uint64_t written; /* total frames written, not cleared when entering standby */
192     audio_io_handle_t handle;
193 
194     int non_blocking;
195     int playback_started;
196     int offload_state;
197     pthread_cond_t offload_cond;
198     pthread_t offload_thread;
199     struct listnode offload_cmd_list;
200     bool offload_thread_blocked;
201 
202     stream_callback_t offload_callback;
203     void *offload_cookie;
204     struct compr_gapless_mdata gapless_mdata;
205     int send_new_metadata;
206     bool realtime;
207     int af_period_multiplier;
208     bool routing_change;
209     struct audio_device *dev;
210     card_status_t card_status;
211 
212     struct error_log error_log;
213 
214     int64_t last_write_time_us;
215 };
216 
217 struct stream_in {
218     struct audio_stream_in stream;
219     pthread_mutex_t lock; /* see note below on mutex acquisition order */
220     pthread_mutex_t pre_lock; /* acquire before lock to avoid DOS by capture thread */
221     struct pcm_config config;
222     struct pcm *pcm;
223     int standby;
224     int source;
225     int pcm_device_id;
226     audio_devices_t device;
227     audio_channel_mask_t channel_mask;
228     audio_usecase_t usecase;
229     bool enable_aec;
230     bool enable_ns;
231     int64_t frames_read; /* total frames read, not cleared when entering standby */
232 
233     audio_io_handle_t capture_handle;
234     audio_input_flags_t flags;
235     bool is_st_session;
236     bool is_st_session_active;
237     bool realtime;
238     int af_period_multiplier;
239     bool routing_change;
240     struct audio_device *dev;
241     audio_format_t format;
242     card_status_t card_status;
243 };
244 
245 typedef enum usecase_type_t {
246     PCM_PLAYBACK,
247     PCM_CAPTURE,
248     VOICE_CALL,
249     PCM_HFP_CALL
250 } usecase_type_t;
251 
252 union stream_ptr {
253     struct stream_in *in;
254     struct stream_out *out;
255 };
256 
257 struct audio_usecase {
258     struct listnode list;
259     audio_usecase_t id;
260     usecase_type_t  type;
261     audio_devices_t devices;
262     snd_device_t out_snd_device;
263     snd_device_t in_snd_device;
264     union stream_ptr stream;
265 };
266 
267 typedef void* (*adm_init_t)();
268 typedef void (*adm_deinit_t)(void *);
269 typedef void (*adm_register_output_stream_t)(void *, audio_io_handle_t, audio_output_flags_t);
270 typedef void (*adm_register_input_stream_t)(void *, audio_io_handle_t, audio_input_flags_t);
271 typedef void (*adm_deregister_stream_t)(void *, audio_io_handle_t);
272 typedef void (*adm_request_focus_t)(void *, audio_io_handle_t);
273 typedef void (*adm_abandon_focus_t)(void *, audio_io_handle_t);
274 typedef void (*adm_set_config_t)(void *, audio_io_handle_t,
275                                          struct pcm *,
276                                          struct pcm_config *);
277 typedef void (*adm_request_focus_v2_t)(void *, audio_io_handle_t, long);
278 typedef bool (*adm_is_noirq_avail_t)(void *, int, int, int);
279 typedef void (*adm_on_routing_change_t)(void *, audio_io_handle_t);
280 
281 struct audio_device {
282     struct audio_hw_device device;
283     pthread_mutex_t lock; /* see note below on mutex acquisition order */
284     struct mixer *mixer;
285     audio_mode_t mode;
286     struct stream_in *active_input;
287     struct stream_out *primary_output;
288     struct stream_out *voice_tx_output;
289     struct stream_out *current_call_output;
290     bool bluetooth_nrec;
291     bool screen_off;
292     int *snd_dev_ref_cnt;
293     struct listnode usecase_list;
294     struct audio_route *audio_route;
295     int acdb_settings;
296     struct voice voice;
297     unsigned int cur_hdmi_channels;
298     bool bt_wb_speech_enabled;
299     bool mic_muted;
300     bool enable_voicerx;
301     bool enable_hfp;
302 
303     int snd_card;
304     void *platform;
305     void *extspk;
306 
307     card_status_t card_status;
308 
309     void *visualizer_lib;
310     int (*visualizer_start_output)(audio_io_handle_t, int);
311     int (*visualizer_stop_output)(audio_io_handle_t, int);
312 
313     /* The pcm_params use_case_table is loaded by adev_verify_devices() upon
314      * calling adev_open().
315      *
316      * If an entry is not NULL, it can be used to determine if extended precision
317      * or other capabilities are present for the device corresponding to that usecase.
318      */
319     struct pcm_params *use_case_table[AUDIO_USECASE_MAX];
320     void *offload_effects_lib;
321     int (*offload_effects_start_output)(audio_io_handle_t, int);
322     int (*offload_effects_stop_output)(audio_io_handle_t, int);
323 
324     void *adm_data;
325     void *adm_lib;
326     adm_init_t adm_init;
327     adm_deinit_t adm_deinit;
328     adm_register_input_stream_t adm_register_input_stream;
329     adm_register_output_stream_t adm_register_output_stream;
330     adm_deregister_stream_t adm_deregister_stream;
331     adm_request_focus_t adm_request_focus;
332     adm_abandon_focus_t adm_abandon_focus;
333     adm_set_config_t adm_set_config;
334     adm_request_focus_v2_t adm_request_focus_v2;
335     adm_is_noirq_avail_t adm_is_noirq_avail;
336     adm_on_routing_change_t adm_on_routing_change;
337 
338     /* logging */
339     snd_device_t last_logged_snd_device[AUDIO_USECASE_MAX][2]; /* [out, in] */
340 };
341 
342 int select_devices(struct audio_device *adev,
343                    audio_usecase_t uc_id);
344 
345 int disable_audio_route(struct audio_device *adev,
346                         struct audio_usecase *usecase);
347 
348 int disable_snd_device(struct audio_device *adev,
349                        snd_device_t snd_device);
350 
351 int enable_snd_device(struct audio_device *adev,
352                       snd_device_t snd_device);
353 
354 int enable_audio_route(struct audio_device *adev,
355                        struct audio_usecase *usecase);
356 
357 struct audio_usecase *get_usecase_from_list(struct audio_device *adev,
358                                             audio_usecase_t uc_id);
359 
360 #define LITERAL_TO_STRING(x) #x
361 #define CHECK(condition) LOG_ALWAYS_FATAL_IF(!(condition), "%s",\
362             __FILE__ ":" LITERAL_TO_STRING(__LINE__)\
363             " ASSERT_FATAL(" #condition ") failed.")
364 
365 /*
366  * NOTE: when multiple mutexes have to be acquired, always take the
367  * stream_in or stream_out mutex first, followed by the audio_device mutex.
368  */
369 
370 #endif // QCOM_AUDIO_HW_H
371