audio_hw.h revision 3ad4e1b9949d04ad90d053458b10fa4dfbfa088e
1/*
2 * Copyright (C) 2013-2014 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#define VISUALIZER_LIBRARY_PATH "/system/lib/soundfx/libqcomvisualizer.so"
31#define OFFLOAD_EFFECTS_BUNDLE_LIBRARY_PATH "/system/lib/soundfx/libqcompostprocbundle.so"
32
33/* Flags used to initialize acdb_settings variable that goes to ACDB library */
34#define DMIC_FLAG       0x00000002
35#define TTY_MODE_OFF    0x00000010
36#define TTY_MODE_FULL   0x00000020
37#define TTY_MODE_VCO    0x00000040
38#define TTY_MODE_HCO    0x00000080
39#define TTY_MODE_CLEAR  0xFFFFFF0F
40
41#define ACDB_DEV_TYPE_OUT 1
42#define ACDB_DEV_TYPE_IN 2
43
44#define MAX_SUPPORTED_CHANNEL_MASKS 2
45#define DEFAULT_HDMI_OUT_CHANNELS   2
46
47typedef int snd_device_t;
48
49/* These are the supported use cases by the hardware.
50 * Each usecase is mapped to a specific PCM device.
51 * Refer to pcm_device_table[].
52 */
53enum {
54    USECASE_INVALID = -1,
55    /* Playback usecases */
56    USECASE_AUDIO_PLAYBACK_DEEP_BUFFER = 0,
57    USECASE_AUDIO_PLAYBACK_LOW_LATENCY,
58    USECASE_AUDIO_PLAYBACK_MULTI_CH,
59    USECASE_AUDIO_PLAYBACK_OFFLOAD,
60
61    /* HFP Use case*/
62    USECASE_AUDIO_HFP_SCO,
63    USECASE_AUDIO_HFP_SCO_WB,
64
65    /* Capture usecases */
66    USECASE_AUDIO_RECORD,
67    USECASE_AUDIO_RECORD_LOW_LATENCY,
68
69    USECASE_VOICE_CALL,
70
71    /* Voice extension usecases */
72    USECASE_VOICE2_CALL,
73    USECASE_VOLTE_CALL,
74    USECASE_QCHAT_CALL,
75    USECASE_VOWLAN_CALL,
76    USECASE_INCALL_REC_UPLINK,
77    USECASE_INCALL_REC_DOWNLINK,
78    USECASE_INCALL_REC_UPLINK_AND_DOWNLINK,
79    AUDIO_USECASE_MAX
80};
81
82const char * const use_case_table[AUDIO_USECASE_MAX];
83
84#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
85
86/*
87 * tinyAlsa library interprets period size as number of frames
88 * one frame = channel_count * sizeof (pcm sample)
89 * so if format = 16-bit PCM and channels = Stereo, frame size = 2 ch * 2 = 4 bytes
90 * DEEP_BUFFER_OUTPUT_PERIOD_SIZE = 1024 means 1024 * 4 = 4096 bytes
91 * We should take care of returning proper size when AudioFlinger queries for
92 * the buffer size of an input/output stream
93 */
94
95enum {
96    OFFLOAD_CMD_EXIT,               /* exit compress offload thread loop*/
97    OFFLOAD_CMD_DRAIN,              /* send a full drain request to DSP */
98    OFFLOAD_CMD_PARTIAL_DRAIN,      /* send a partial drain request to DSP */
99    OFFLOAD_CMD_WAIT_FOR_BUFFER,    /* wait for buffer released by DSP */
100};
101
102enum {
103    OFFLOAD_STATE_IDLE,
104    OFFLOAD_STATE_PLAYING,
105    OFFLOAD_STATE_PAUSED,
106};
107
108struct offload_cmd {
109    struct listnode node;
110    int cmd;
111    int data[];
112};
113
114struct stream_out {
115    struct audio_stream_out stream;
116    pthread_mutex_t lock; /* see note below on mutex acquisition order */
117    pthread_cond_t  cond;
118    struct pcm_config config;
119    struct compr_config compr_config;
120    struct pcm *pcm;
121    struct compress *compr;
122    int standby;
123    int pcm_device_id;
124    unsigned int sample_rate;
125    audio_channel_mask_t channel_mask;
126    audio_format_t format;
127    audio_devices_t devices;
128    audio_output_flags_t flags;
129    audio_usecase_t usecase;
130    /* Array of supported channel mask configurations. +1 so that the last entry is always 0 */
131    audio_channel_mask_t supported_channel_masks[MAX_SUPPORTED_CHANNEL_MASKS + 1];
132    bool muted;
133    uint64_t written; /* total frames written, not cleared when entering standby */
134    audio_io_handle_t handle;
135
136    int non_blocking;
137    int playback_started;
138    int offload_state;
139    pthread_cond_t offload_cond;
140    pthread_t offload_thread;
141    struct listnode offload_cmd_list;
142    bool offload_thread_blocked;
143
144    stream_callback_t offload_callback;
145    void *offload_cookie;
146    struct compr_gapless_mdata gapless_mdata;
147    int send_new_metadata;
148
149    struct audio_device *dev;
150};
151
152struct stream_in {
153    struct audio_stream_in stream;
154    pthread_mutex_t lock; /* see note below on mutex acquisition order */
155    struct pcm_config config;
156    struct pcm *pcm;
157    int standby;
158    int source;
159    int pcm_device_id;
160    int device;
161    audio_channel_mask_t channel_mask;
162    audio_usecase_t usecase;
163    bool enable_aec;
164    bool enable_ns;
165
166    struct audio_device *dev;
167};
168
169typedef enum {
170    PCM_PLAYBACK,
171    PCM_CAPTURE,
172    VOICE_CALL,
173    PCM_HFP_CALL
174} usecase_type_t;
175
176union stream_ptr {
177    struct stream_in *in;
178    struct stream_out *out;
179};
180
181struct audio_usecase {
182    struct listnode list;
183    audio_usecase_t id;
184    usecase_type_t  type;
185    audio_devices_t devices;
186    snd_device_t out_snd_device;
187    snd_device_t in_snd_device;
188    union stream_ptr stream;
189};
190
191struct audio_device {
192    struct audio_hw_device device;
193    pthread_mutex_t lock; /* see note below on mutex acquisition order */
194    struct mixer *mixer;
195    audio_mode_t mode;
196    struct stream_in *active_input;
197    struct stream_out *primary_output;
198    bool bluetooth_nrec;
199    bool screen_off;
200    int *snd_dev_ref_cnt;
201    struct listnode usecase_list;
202    struct audio_route *audio_route;
203    int acdb_settings;
204    bool speaker_lr_swap;
205    struct voice voice;
206    unsigned int cur_hdmi_channels;
207    bool bt_wb_speech_enabled;
208
209    int snd_card;
210    void *platform;
211
212    void *visualizer_lib;
213    int (*visualizer_start_output)(audio_io_handle_t, int);
214    int (*visualizer_stop_output)(audio_io_handle_t, int);
215
216    /* The pcm_params use_case_table is loaded by adev_verify_devices() upon
217     * calling adev_open().
218     *
219     * If an entry is not NULL, it can be used to determine if extended precision
220     * or other capabilities are present for the device corresponding to that usecase.
221     */
222    struct pcm_params *use_case_table[AUDIO_USECASE_MAX];
223    void *offload_effects_lib;
224    int (*offload_effects_start_output)(audio_io_handle_t, int);
225    int (*offload_effects_stop_output)(audio_io_handle_t, int);
226};
227
228int pcm_ioctl(void *pcm, int request, ...);
229
230int select_devices(struct audio_device *adev,
231                   audio_usecase_t uc_id);
232
233int disable_audio_route(struct audio_device *adev,
234                        struct audio_usecase *usecase);
235
236int disable_snd_device(struct audio_device *adev,
237                       snd_device_t snd_device);
238
239int enable_snd_device(struct audio_device *adev,
240                      snd_device_t snd_device);
241
242int enable_audio_route(struct audio_device *adev,
243                       struct audio_usecase *usecase);
244
245struct audio_usecase *get_usecase_from_list(struct audio_device *adev,
246                                            audio_usecase_t uc_id);
247
248#define LITERAL_TO_STRING(x) #x
249#define CHECK(condition) LOG_ALWAYS_FATAL_IF(!(condition), "%s",\
250            __FILE__ ":" LITERAL_TO_STRING(__LINE__)\
251            " ASSERT_FATAL(" #condition ") failed.")
252
253/*
254 * NOTE: when multiple mutexes have to be acquired, always take the
255 * stream_in or stream_out mutex first, followed by the audio_device mutex.
256 */
257
258#endif // QCOM_AUDIO_HW_H
259