audio_hw.h revision 55a1293b422d181281cf0f7d37c6c15c5d921ef3
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 */
53typedef enum {
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} audio_usecase_t;
81
82#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
83
84/*
85 * tinyAlsa library interprets period size as number of frames
86 * one frame = channel_count * sizeof (pcm sample)
87 * so if format = 16-bit PCM and channels = Stereo, frame size = 2 ch * 2 = 4 bytes
88 * DEEP_BUFFER_OUTPUT_PERIOD_SIZE = 1024 means 1024 * 4 = 4096 bytes
89 * We should take care of returning proper size when AudioFlinger queries for
90 * the buffer size of an input/output stream
91 */
92
93enum {
94    OFFLOAD_CMD_EXIT,               /* exit compress offload thread loop*/
95    OFFLOAD_CMD_DRAIN,              /* send a full drain request to DSP */
96    OFFLOAD_CMD_PARTIAL_DRAIN,      /* send a partial drain request to DSP */
97    OFFLOAD_CMD_WAIT_FOR_BUFFER,    /* wait for buffer released by DSP */
98};
99
100enum {
101    OFFLOAD_STATE_IDLE,
102    OFFLOAD_STATE_PLAYING,
103    OFFLOAD_STATE_PAUSED,
104};
105
106struct offload_cmd {
107    struct listnode node;
108    int cmd;
109    int data[];
110};
111
112struct stream_out {
113    struct audio_stream_out stream;
114    pthread_mutex_t lock; /* see note below on mutex acquisition order */
115    pthread_cond_t  cond;
116    struct pcm_config config;
117    struct compr_config compr_config;
118    struct pcm *pcm;
119    struct compress *compr;
120    int standby;
121    int pcm_device_id;
122    unsigned int sample_rate;
123    audio_channel_mask_t channel_mask;
124    audio_format_t format;
125    audio_devices_t devices;
126    audio_output_flags_t flags;
127    audio_usecase_t usecase;
128    /* Array of supported channel mask configurations. +1 so that the last entry is always 0 */
129    audio_channel_mask_t supported_channel_masks[MAX_SUPPORTED_CHANNEL_MASKS + 1];
130    bool muted;
131    uint64_t written; /* total frames written, not cleared when entering standby */
132    audio_io_handle_t handle;
133
134    int non_blocking;
135    int playback_started;
136    int offload_state;
137    pthread_cond_t offload_cond;
138    pthread_t offload_thread;
139    struct listnode offload_cmd_list;
140    bool offload_thread_blocked;
141
142    stream_callback_t offload_callback;
143    void *offload_cookie;
144    struct compr_gapless_mdata gapless_mdata;
145    int send_new_metadata;
146
147    struct audio_device *dev;
148};
149
150struct stream_in {
151    struct audio_stream_in stream;
152    pthread_mutex_t lock; /* see note below on mutex acquisition order */
153    struct pcm_config config;
154    struct pcm *pcm;
155    int standby;
156    int source;
157    int pcm_device_id;
158    int device;
159    audio_channel_mask_t channel_mask;
160    audio_usecase_t usecase;
161    bool enable_aec;
162
163    struct audio_device *dev;
164};
165
166typedef enum {
167    PCM_PLAYBACK,
168    PCM_CAPTURE,
169    VOICE_CALL,
170    PCM_HFP_CALL
171} usecase_type_t;
172
173union stream_ptr {
174    struct stream_in *in;
175    struct stream_out *out;
176};
177
178struct audio_usecase {
179    struct listnode list;
180    audio_usecase_t id;
181    usecase_type_t  type;
182    audio_devices_t devices;
183    snd_device_t out_snd_device;
184    snd_device_t in_snd_device;
185    union stream_ptr stream;
186};
187
188struct audio_device {
189    struct audio_hw_device device;
190    pthread_mutex_t lock; /* see note below on mutex acquisition order */
191    struct mixer *mixer;
192    audio_mode_t mode;
193    struct stream_in *active_input;
194    struct stream_out *primary_output;
195    bool bluetooth_nrec;
196    bool screen_off;
197    int *snd_dev_ref_cnt;
198    struct listnode usecase_list;
199    struct audio_route *audio_route;
200    int acdb_settings;
201    bool speaker_lr_swap;
202    struct voice voice;
203    unsigned int cur_hdmi_channels;
204    bool bt_wb_speech_enabled;
205
206    int snd_card;
207    void *platform;
208
209    void *visualizer_lib;
210    int (*visualizer_start_output)(audio_io_handle_t, int);
211    int (*visualizer_stop_output)(audio_io_handle_t, int);
212
213    /* The pcm_params use_case_table is loaded by adev_verify_devices() upon
214     * calling adev_open().
215     *
216     * If an entry is not NULL, it can be used to determine if extended precision
217     * or other capabilities are present for the device corresponding to that usecase.
218     */
219    struct pcm_params *use_case_table[AUDIO_USECASE_MAX];
220    void *offload_effects_lib;
221    int (*offload_effects_start_output)(audio_io_handle_t, int);
222    int (*offload_effects_stop_output)(audio_io_handle_t, int);
223};
224
225int pcm_ioctl(void *pcm, int request, ...);
226
227int select_devices(struct audio_device *adev,
228                   audio_usecase_t uc_id);
229
230int disable_audio_route(struct audio_device *adev,
231                        struct audio_usecase *usecase);
232
233int disable_snd_device(struct audio_device *adev,
234                       snd_device_t snd_device);
235
236int enable_snd_device(struct audio_device *adev,
237                      snd_device_t snd_device);
238
239int enable_audio_route(struct audio_device *adev,
240                       struct audio_usecase *usecase);
241
242struct audio_usecase *get_usecase_from_list(struct audio_device *adev,
243                                            audio_usecase_t uc_id);
244
245#define LITERAL_TO_STRING(x) #x
246#define CHECK(condition) LOG_ALWAYS_FATAL_IF(!(condition), "%s",\
247            __FILE__ ":" LITERAL_TO_STRING(__LINE__)\
248            " ASSERT_FATAL(" #condition ") failed.")
249
250/*
251 * NOTE: when multiple mutexes have to be acquired, always take the
252 * stream_in or stream_out mutex first, followed by the audio_device mutex.
253 */
254
255#endif // QCOM_AUDIO_HW_H
256