blob: fa6ab57caa5c6e0af9ac57055d964ef61dc8aab0 [file] [log] [blame]
Dima Zavinf1504db2011-03-11 11:20:49 -08001/*
2 * Copyright (C) 2011 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
18#ifndef ANDROID_AUDIO_HAL_INTERFACE_H
19#define ANDROID_AUDIO_HAL_INTERFACE_H
20
21#include <stdint.h>
22#include <strings.h>
23#include <sys/cdefs.h>
24#include <sys/types.h>
25
26#include <cutils/bitops.h>
27
28#include <hardware/hardware.h>
Dima Zavinaa211722011-05-11 14:15:53 -070029#include <system/audio.h>
Eric Laurentf3008aa2011-06-17 16:53:12 -070030#include <hardware/audio_effect.h>
Dima Zavinf1504db2011-03-11 11:20:49 -080031
32__BEGIN_DECLS
33
34/**
35 * The id of this module
36 */
37#define AUDIO_HARDWARE_MODULE_ID "audio"
38
39/**
40 * Name of the audio devices to open
41 */
42#define AUDIO_HARDWARE_INTERFACE "audio_hw_if"
43
Eric Laurent55786bc2012-04-10 16:56:32 -070044
45/* Use version 0.1 to be compatible with first generation of audio hw module with version_major
46 * hardcoded to 1. No audio module API change.
47 */
48#define AUDIO_MODULE_API_VERSION_0_1 HARDWARE_MODULE_API_VERSION(0, 1)
49#define AUDIO_MODULE_API_VERSION_CURRENT AUDIO_MODULE_API_VERSION_0_1
50
51/* First generation of audio devices had version hardcoded to 0. all devices with versions < 1.0
52 * will be considered of first generation API.
53 */
54#define AUDIO_DEVICE_API_VERSION_0_0 HARDWARE_DEVICE_API_VERSION(0, 0)
55#define AUDIO_DEVICE_API_VERSION_1_0 HARDWARE_DEVICE_API_VERSION(1, 0)
Eric Laurent85e08e22012-08-28 14:30:35 -070056#define AUDIO_DEVICE_API_VERSION_2_0 HARDWARE_DEVICE_API_VERSION(2, 0)
Eric Laurent73b8a742014-05-22 14:02:38 -070057#define AUDIO_DEVICE_API_VERSION_3_0 HARDWARE_DEVICE_API_VERSION(3, 0)
58#define AUDIO_DEVICE_API_VERSION_CURRENT AUDIO_DEVICE_API_VERSION_3_0
Eric Laurent447cae72014-05-22 13:45:55 -070059/* Minimal audio HAL version supported by the audio framework */
60#define AUDIO_DEVICE_API_VERSION_MIN AUDIO_DEVICE_API_VERSION_2_0
Eric Laurent55786bc2012-04-10 16:56:32 -070061
Eric Laurent431fc782012-04-03 12:07:02 -070062/**
63 * List of known audio HAL modules. This is the base name of the audio HAL
64 * library composed of the "audio." prefix, one of the base names below and
65 * a suffix specific to the device.
66 * e.g: audio.primary.goldfish.so or audio.a2dp.default.so
67 */
68
69#define AUDIO_HARDWARE_MODULE_ID_PRIMARY "primary"
70#define AUDIO_HARDWARE_MODULE_ID_A2DP "a2dp"
71#define AUDIO_HARDWARE_MODULE_ID_USB "usb"
Jean-Michel Trivi88b79cb2012-08-16 13:56:03 -070072#define AUDIO_HARDWARE_MODULE_ID_REMOTE_SUBMIX "r_submix"
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +000073#define AUDIO_HARDWARE_MODULE_ID_CODEC_OFFLOAD "codec_offload"
Eric Laurent431fc782012-04-03 12:07:02 -070074
Dima Zavinf1504db2011-03-11 11:20:49 -080075/**************************************/
76
Eric Laurent70e81102011-08-07 10:05:40 -070077/**
78 * standard audio parameters that the HAL may need to handle
79 */
80
81/**
82 * audio device parameters
83 */
84
Eric Laurented9928c2011-08-02 17:12:00 -070085/* BT SCO Noise Reduction + Echo Cancellation parameters */
86#define AUDIO_PARAMETER_KEY_BT_NREC "bt_headset_nrec"
87#define AUDIO_PARAMETER_VALUE_ON "on"
88#define AUDIO_PARAMETER_VALUE_OFF "off"
89
Eric Laurent70e81102011-08-07 10:05:40 -070090/* TTY mode selection */
91#define AUDIO_PARAMETER_KEY_TTY_MODE "tty_mode"
92#define AUDIO_PARAMETER_VALUE_TTY_OFF "tty_off"
93#define AUDIO_PARAMETER_VALUE_TTY_VCO "tty_vco"
94#define AUDIO_PARAMETER_VALUE_TTY_HCO "tty_hco"
95#define AUDIO_PARAMETER_VALUE_TTY_FULL "tty_full"
96
Eric Laurentd1a1b1c2014-07-25 12:10:11 -050097/* Hearing Aid Compatibility - Telecoil (HAC-T) mode on/off
98 Strings must be in sync with CallFeaturesSetting.java */
99#define AUDIO_PARAMETER_KEY_HAC "HACSetting"
100#define AUDIO_PARAMETER_VALUE_HAC_ON "ON"
101#define AUDIO_PARAMETER_VALUE_HAC_OFF "OFF"
102
Eric Laurenta70c5d02012-03-07 18:59:47 -0800103/* A2DP sink address set by framework */
104#define AUDIO_PARAMETER_A2DP_SINK_ADDRESS "a2dp_sink_address"
105
Mike Lockwood2d4d9652014-05-28 11:09:54 -0700106/* A2DP source address set by framework */
107#define AUDIO_PARAMETER_A2DP_SOURCE_ADDRESS "a2dp_source_address"
108
Glenn Kasten34afb682012-06-08 10:49:34 -0700109/* Screen state */
110#define AUDIO_PARAMETER_KEY_SCREEN_STATE "screen_state"
111
Glenn Kastend930d922014-04-29 13:35:57 -0700112/* Bluetooth SCO wideband */
113#define AUDIO_PARAMETER_KEY_BT_SCO_WB "bt_wbs"
114
Eric Laurent70e81102011-08-07 10:05:40 -0700115/**
116 * audio stream parameters
117 */
118
Eric Laurentf5e24692014-07-27 16:14:57 -0700119#define AUDIO_PARAMETER_STREAM_ROUTING "routing" /* audio_devices_t */
120#define AUDIO_PARAMETER_STREAM_FORMAT "format" /* audio_format_t */
121#define AUDIO_PARAMETER_STREAM_CHANNELS "channels" /* audio_channel_mask_t */
122#define AUDIO_PARAMETER_STREAM_FRAME_COUNT "frame_count" /* size_t */
123#define AUDIO_PARAMETER_STREAM_INPUT_SOURCE "input_source" /* audio_source_t */
124#define AUDIO_PARAMETER_STREAM_SAMPLING_RATE "sampling_rate" /* uint32_t */
Dima Zavin57dde282011-06-06 19:31:18 -0700125
Eric Laurent41eeb4f2012-05-17 18:54:49 -0700126/* Query supported formats. The response is a '|' separated list of strings from
127 * audio_format_t enum e.g: "sup_formats=AUDIO_FORMAT_PCM_16_BIT" */
128#define AUDIO_PARAMETER_STREAM_SUP_FORMATS "sup_formats"
129/* Query supported channel masks. The response is a '|' separated list of strings from
130 * audio_channel_mask_t enum e.g: "sup_channels=AUDIO_CHANNEL_OUT_STEREO|AUDIO_CHANNEL_OUT_MONO" */
131#define AUDIO_PARAMETER_STREAM_SUP_CHANNELS "sup_channels"
132/* Query supported sampling rates. The response is a '|' separated list of integer values e.g:
133 * "sup_sampling_rates=44100|48000" */
134#define AUDIO_PARAMETER_STREAM_SUP_SAMPLING_RATES "sup_sampling_rates"
135
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000136/**
137 * audio codec parameters
138 */
139
140#define AUDIO_OFFLOAD_CODEC_PARAMS "music_offload_codec_param"
141#define AUDIO_OFFLOAD_CODEC_BIT_PER_SAMPLE "music_offload_bit_per_sample"
142#define AUDIO_OFFLOAD_CODEC_BIT_RATE "music_offload_bit_rate"
143#define AUDIO_OFFLOAD_CODEC_AVG_BIT_RATE "music_offload_avg_bit_rate"
144#define AUDIO_OFFLOAD_CODEC_ID "music_offload_codec_id"
145#define AUDIO_OFFLOAD_CODEC_BLOCK_ALIGN "music_offload_block_align"
146#define AUDIO_OFFLOAD_CODEC_SAMPLE_RATE "music_offload_sample_rate"
147#define AUDIO_OFFLOAD_CODEC_ENCODE_OPTION "music_offload_encode_option"
148#define AUDIO_OFFLOAD_CODEC_NUM_CHANNEL "music_offload_num_channels"
149#define AUDIO_OFFLOAD_CODEC_DOWN_SAMPLING "music_offload_down_sampling"
150#define AUDIO_OFFLOAD_CODEC_DELAY_SAMPLES "delay_samples"
151#define AUDIO_OFFLOAD_CODEC_PADDING_SAMPLES "padding_samples"
Eric Laurent55786bc2012-04-10 16:56:32 -0700152
Eric Laurent70e81102011-08-07 10:05:40 -0700153/**************************************/
154
Dima Zavinf1504db2011-03-11 11:20:49 -0800155/* common audio stream parameters and operations */
156struct audio_stream {
157
158 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800159 * Return the sampling rate in Hz - eg. 44100.
Dima Zavinf1504db2011-03-11 11:20:49 -0800160 */
161 uint32_t (*get_sample_rate)(const struct audio_stream *stream);
Dima Zavin57dde282011-06-06 19:31:18 -0700162
163 /* currently unused - use set_parameters with key
164 * AUDIO_PARAMETER_STREAM_SAMPLING_RATE
165 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800166 int (*set_sample_rate)(struct audio_stream *stream, uint32_t rate);
167
168 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800169 * Return size of input/output buffer in bytes for this stream - eg. 4800.
170 * It should be a multiple of the frame size. See also get_input_buffer_size.
Dima Zavinf1504db2011-03-11 11:20:49 -0800171 */
172 size_t (*get_buffer_size)(const struct audio_stream *stream);
173
174 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800175 * Return the channel mask -
Dima Zavinf1504db2011-03-11 11:20:49 -0800176 * e.g. AUDIO_CHANNEL_OUT_STEREO or AUDIO_CHANNEL_IN_STEREO
177 */
Eric Laurent55786bc2012-04-10 16:56:32 -0700178 audio_channel_mask_t (*get_channels)(const struct audio_stream *stream);
Dima Zavinf1504db2011-03-11 11:20:49 -0800179
180 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800181 * Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT
Dima Zavinf1504db2011-03-11 11:20:49 -0800182 */
Glenn Kastenfe79eb32012-01-12 14:55:57 -0800183 audio_format_t (*get_format)(const struct audio_stream *stream);
Dima Zavin57dde282011-06-06 19:31:18 -0700184
185 /* currently unused - use set_parameters with key
186 * AUDIO_PARAMETER_STREAM_FORMAT
187 */
Glenn Kastenfe79eb32012-01-12 14:55:57 -0800188 int (*set_format)(struct audio_stream *stream, audio_format_t format);
Dima Zavinf1504db2011-03-11 11:20:49 -0800189
190 /**
191 * Put the audio hardware input/output into standby mode.
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800192 * Driver should exit from standby mode at the next I/O operation.
Dima Zavinf1504db2011-03-11 11:20:49 -0800193 * Returns 0 on success and <0 on failure.
194 */
195 int (*standby)(struct audio_stream *stream);
196
197 /** dump the state of the audio input/output device */
198 int (*dump)(const struct audio_stream *stream, int fd);
199
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800200 /** Return the set of device(s) which this stream is connected to */
Dima Zavinf1504db2011-03-11 11:20:49 -0800201 audio_devices_t (*get_device)(const struct audio_stream *stream);
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800202
203 /**
204 * Currently unused - set_device() corresponds to set_parameters() with key
205 * AUDIO_PARAMETER_STREAM_ROUTING for both input and output.
206 * AUDIO_PARAMETER_STREAM_INPUT_SOURCE is an additional information used by
207 * input streams only.
208 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800209 int (*set_device)(struct audio_stream *stream, audio_devices_t device);
210
211 /**
212 * set/get audio stream parameters. The function accepts a list of
213 * parameter key value pairs in the form: key1=value1;key2=value2;...
214 *
215 * Some keys are reserved for standard parameters (See AudioParameter class)
216 *
217 * If the implementation does not accept a parameter change while
218 * the output is active but the parameter is acceptable otherwise, it must
219 * return -ENOSYS.
220 *
221 * The audio flinger will put the stream in standby and then change the
222 * parameter value.
223 */
224 int (*set_parameters)(struct audio_stream *stream, const char *kv_pairs);
225
226 /*
227 * Returns a pointer to a heap allocated string. The caller is responsible
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800228 * for freeing the memory for it using free().
Dima Zavinf1504db2011-03-11 11:20:49 -0800229 */
230 char * (*get_parameters)(const struct audio_stream *stream,
231 const char *keys);
Eric Laurentf3008aa2011-06-17 16:53:12 -0700232 int (*add_audio_effect)(const struct audio_stream *stream,
233 effect_handle_t effect);
234 int (*remove_audio_effect)(const struct audio_stream *stream,
235 effect_handle_t effect);
Dima Zavinf1504db2011-03-11 11:20:49 -0800236};
237typedef struct audio_stream audio_stream_t;
238
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000239/* type of asynchronous write callback events. Mutually exclusive */
240typedef enum {
241 STREAM_CBK_EVENT_WRITE_READY, /* non blocking write completed */
242 STREAM_CBK_EVENT_DRAIN_READY /* drain completed */
243} stream_callback_event_t;
244
245typedef int (*stream_callback_t)(stream_callback_event_t event, void *param, void *cookie);
246
247/* type of drain requested to audio_stream_out->drain(). Mutually exclusive */
248typedef enum {
249 AUDIO_DRAIN_ALL, /* drain() returns when all data has been played */
250 AUDIO_DRAIN_EARLY_NOTIFY /* drain() returns a short time before all data
251 from the current track has been played to
252 give time for gapless track switch */
253} audio_drain_type_t;
254
Dima Zavinf1504db2011-03-11 11:20:49 -0800255/**
256 * audio_stream_out is the abstraction interface for the audio output hardware.
257 *
258 * It provides information about various properties of the audio output
259 * hardware driver.
260 */
261
262struct audio_stream_out {
Stewart Miles84d35492014-05-01 09:03:27 -0700263 /**
264 * Common methods of the audio stream out. This *must* be the first member of audio_stream_out
265 * as users of this structure will cast a audio_stream to audio_stream_out pointer in contexts
266 * where it's known the audio_stream references an audio_stream_out.
267 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800268 struct audio_stream common;
269
270 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800271 * Return the audio hardware driver estimated latency in milliseconds.
Dima Zavinf1504db2011-03-11 11:20:49 -0800272 */
273 uint32_t (*get_latency)(const struct audio_stream_out *stream);
274
275 /**
276 * Use this method in situations where audio mixing is done in the
277 * hardware. This method serves as a direct interface with hardware,
278 * allowing you to directly set the volume as apposed to via the framework.
279 * This method might produce multiple PCM outputs or hardware accelerated
280 * codecs, such as MP3 or AAC.
281 */
282 int (*set_volume)(struct audio_stream_out *stream, float left, float right);
283
284 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800285 * Write audio buffer to driver. Returns number of bytes written, or a
286 * negative status_t. If at least one frame was written successfully prior to the error,
287 * it is suggested that the driver return that successful (short) byte count
288 * and then return an error in the subsequent call.
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000289 *
290 * If set_callback() has previously been called to enable non-blocking mode
291 * the write() is not allowed to block. It must write only the number of
292 * bytes that currently fit in the driver/hardware buffer and then return
293 * this byte count. If this is less than the requested write size the
294 * callback function must be called when more space is available in the
295 * driver/hardware buffer.
Dima Zavinf1504db2011-03-11 11:20:49 -0800296 */
297 ssize_t (*write)(struct audio_stream_out *stream, const void* buffer,
298 size_t bytes);
299
300 /* return the number of audio frames written by the audio dsp to DAC since
301 * the output has exited standby
302 */
303 int (*get_render_position)(const struct audio_stream_out *stream,
304 uint32_t *dsp_frames);
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700305
306 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800307 * get the local time at which the next write to the audio driver will be presented.
308 * The units are microseconds, where the epoch is decided by the local audio HAL.
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700309 */
310 int (*get_next_write_timestamp)(const struct audio_stream_out *stream,
311 int64_t *timestamp);
312
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000313 /**
314 * set the callback function for notifying completion of non-blocking
315 * write and drain.
316 * Calling this function implies that all future write() and drain()
317 * must be non-blocking and use the callback to signal completion.
318 */
319 int (*set_callback)(struct audio_stream_out *stream,
320 stream_callback_t callback, void *cookie);
321
322 /**
323 * Notifies to the audio driver to stop playback however the queued buffers are
324 * retained by the hardware. Useful for implementing pause/resume. Empty implementation
325 * if not supported however should be implemented for hardware with non-trivial
326 * latency. In the pause state audio hardware could still be using power. User may
327 * consider calling suspend after a timeout.
328 *
329 * Implementation of this function is mandatory for offloaded playback.
330 */
331 int (*pause)(struct audio_stream_out* stream);
332
333 /**
334 * Notifies to the audio driver to resume playback following a pause.
335 * Returns error if called without matching pause.
336 *
337 * Implementation of this function is mandatory for offloaded playback.
338 */
339 int (*resume)(struct audio_stream_out* stream);
340
341 /**
342 * Requests notification when data buffered by the driver/hardware has
343 * been played. If set_callback() has previously been called to enable
344 * non-blocking mode, the drain() must not block, instead it should return
345 * quickly and completion of the drain is notified through the callback.
346 * If set_callback() has not been called, the drain() must block until
347 * completion.
348 * If type==AUDIO_DRAIN_ALL, the drain completes when all previously written
349 * data has been played.
350 * If type==AUDIO_DRAIN_EARLY_NOTIFY, the drain completes shortly before all
351 * data for the current track has played to allow time for the framework
352 * to perform a gapless track switch.
353 *
354 * Drain must return immediately on stop() and flush() call
355 *
356 * Implementation of this function is mandatory for offloaded playback.
357 */
358 int (*drain)(struct audio_stream_out* stream, audio_drain_type_t type );
359
360 /**
361 * Notifies to the audio driver to flush the queued data. Stream must already
362 * be paused before calling flush().
363 *
364 * Implementation of this function is mandatory for offloaded playback.
365 */
366 int (*flush)(struct audio_stream_out* stream);
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700367
368 /**
Glenn Kasten22a06b72013-09-10 09:23:07 -0700369 * Return a recent count of the number of audio frames presented to an external observer.
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700370 * This excludes frames which have been written but are still in the pipeline.
371 * The count is not reset to zero when output enters standby.
372 * Also returns the value of CLOCK_MONOTONIC as of this presentation count.
Glenn Kasten22a06b72013-09-10 09:23:07 -0700373 * The returned count is expected to be 'recent',
374 * but does not need to be the most recent possible value.
375 * However, the associated time should correspond to whatever count is returned.
376 * Example: assume that N+M frames have been presented, where M is a 'small' number.
377 * Then it is permissible to return N instead of N+M,
378 * and the timestamp should correspond to N rather than N+M.
379 * The terms 'recent' and 'small' are not defined.
380 * They reflect the quality of the implementation.
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700381 *
382 * 3.0 and higher only.
383 */
384 int (*get_presentation_position)(const struct audio_stream_out *stream,
385 uint64_t *frames, struct timespec *timestamp);
386
Dima Zavinf1504db2011-03-11 11:20:49 -0800387};
388typedef struct audio_stream_out audio_stream_out_t;
389
390struct audio_stream_in {
Stewart Miles84d35492014-05-01 09:03:27 -0700391 /**
392 * Common methods of the audio stream in. This *must* be the first member of audio_stream_in
393 * as users of this structure will cast a audio_stream to audio_stream_in pointer in contexts
394 * where it's known the audio_stream references an audio_stream_in.
395 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800396 struct audio_stream common;
397
398 /** set the input gain for the audio driver. This method is for
399 * for future use */
400 int (*set_gain)(struct audio_stream_in *stream, float gain);
401
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800402 /** Read audio buffer in from audio driver. Returns number of bytes read, or a
403 * negative status_t. If at least one frame was read prior to the error,
404 * read should return that byte count and then return an error in the subsequent call.
405 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800406 ssize_t (*read)(struct audio_stream_in *stream, void* buffer,
407 size_t bytes);
408
409 /**
410 * Return the amount of input frames lost in the audio driver since the
411 * last call of this function.
412 * Audio driver is expected to reset the value to 0 and restart counting
413 * upon returning the current value by this function call.
414 * Such loss typically occurs when the user space process is blocked
415 * longer than the capacity of audio driver buffers.
416 *
417 * Unit: the number of input audio frames
418 */
419 uint32_t (*get_input_frames_lost)(struct audio_stream_in *stream);
420};
421typedef struct audio_stream_in audio_stream_in_t;
422
423/**
424 * return the frame size (number of bytes per sample).
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700425 *
426 * Deprecated: use audio_stream_out_frame_size() or audio_stream_in_frame_size() instead.
Dima Zavinf1504db2011-03-11 11:20:49 -0800427 */
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700428__attribute__((__deprecated__))
Glenn Kasten48915ac2012-02-20 12:08:57 -0800429static inline size_t audio_stream_frame_size(const struct audio_stream *s)
Dima Zavinf1504db2011-03-11 11:20:49 -0800430{
Glenn Kastena26cbac2012-01-13 14:53:35 -0800431 size_t chan_samp_sz;
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000432 audio_format_t format = s->get_format(s);
Dima Zavinf1504db2011-03-11 11:20:49 -0800433
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000434 if (audio_is_linear_pcm(format)) {
435 chan_samp_sz = audio_bytes_per_sample(format);
436 return popcount(s->get_channels(s)) * chan_samp_sz;
Dima Zavinf1504db2011-03-11 11:20:49 -0800437 }
438
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000439 return sizeof(int8_t);
Dima Zavinf1504db2011-03-11 11:20:49 -0800440}
441
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700442/**
443 * return the frame size (number of bytes per sample) of an output stream.
444 */
445static inline size_t audio_stream_out_frame_size(const struct audio_stream_out *s)
446{
447 size_t chan_samp_sz;
448 audio_format_t format = s->common.get_format(&s->common);
449
450 if (audio_is_linear_pcm(format)) {
451 chan_samp_sz = audio_bytes_per_sample(format);
452 return audio_channel_count_from_out_mask(s->common.get_channels(&s->common)) * chan_samp_sz;
453 }
454
455 return sizeof(int8_t);
456}
457
458/**
459 * return the frame size (number of bytes per sample) of an input stream.
460 */
461static inline size_t audio_stream_in_frame_size(const struct audio_stream_in *s)
462{
463 size_t chan_samp_sz;
464 audio_format_t format = s->common.get_format(&s->common);
465
466 if (audio_is_linear_pcm(format)) {
467 chan_samp_sz = audio_bytes_per_sample(format);
468 return audio_channel_count_from_in_mask(s->common.get_channels(&s->common)) * chan_samp_sz;
469 }
470
471 return sizeof(int8_t);
472}
Dima Zavinf1504db2011-03-11 11:20:49 -0800473
474/**********************************************************************/
475
476/**
477 * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM
478 * and the fields of this data structure must begin with hw_module_t
479 * followed by module specific information.
480 */
481struct audio_module {
482 struct hw_module_t common;
483};
484
485struct audio_hw_device {
Stewart Miles84d35492014-05-01 09:03:27 -0700486 /**
487 * Common methods of the audio device. This *must* be the first member of audio_hw_device
488 * as users of this structure will cast a hw_device_t to audio_hw_device pointer in contexts
489 * where it's known the hw_device_t references an audio_hw_device.
490 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800491 struct hw_device_t common;
492
493 /**
494 * used by audio flinger to enumerate what devices are supported by
495 * each audio_hw_device implementation.
496 *
497 * Return value is a bitmask of 1 or more values of audio_devices_t
Eric Laurent85e08e22012-08-28 14:30:35 -0700498 *
499 * NOTE: audio HAL implementations starting with
500 * AUDIO_DEVICE_API_VERSION_2_0 do not implement this function.
501 * All supported devices should be listed in audio_policy.conf
502 * file and the audio policy manager must choose the appropriate
503 * audio module based on information in this file.
Dima Zavinf1504db2011-03-11 11:20:49 -0800504 */
505 uint32_t (*get_supported_devices)(const struct audio_hw_device *dev);
506
507 /**
508 * check to see if the audio hardware interface has been initialized.
509 * returns 0 on success, -ENODEV on failure.
510 */
511 int (*init_check)(const struct audio_hw_device *dev);
512
513 /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */
514 int (*set_voice_volume)(struct audio_hw_device *dev, float volume);
515
516 /**
517 * set the audio volume for all audio activities other than voice call.
518 * Range between 0.0 and 1.0. If any value other than 0 is returned,
519 * the software mixer will emulate this capability.
520 */
521 int (*set_master_volume)(struct audio_hw_device *dev, float volume);
522
523 /**
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700524 * Get the current master volume value for the HAL, if the HAL supports
525 * master volume control. AudioFlinger will query this value from the
526 * primary audio HAL when the service starts and use the value for setting
527 * the initial master volume across all HALs. HALs which do not support
John Grossman47bf3d72012-07-17 11:54:04 -0700528 * this method may leave it set to NULL.
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700529 */
530 int (*get_master_volume)(struct audio_hw_device *dev, float *volume);
531
532 /**
Glenn Kasten6df641e2012-01-09 10:41:30 -0800533 * set_mode is called when the audio mode changes. AUDIO_MODE_NORMAL mode
Dima Zavinf1504db2011-03-11 11:20:49 -0800534 * is for standard audio playback, AUDIO_MODE_RINGTONE when a ringtone is
535 * playing, and AUDIO_MODE_IN_CALL when a call is in progress.
Dima Zavinf1504db2011-03-11 11:20:49 -0800536 */
Glenn Kasten6df641e2012-01-09 10:41:30 -0800537 int (*set_mode)(struct audio_hw_device *dev, audio_mode_t mode);
Dima Zavinf1504db2011-03-11 11:20:49 -0800538
539 /* mic mute */
540 int (*set_mic_mute)(struct audio_hw_device *dev, bool state);
541 int (*get_mic_mute)(const struct audio_hw_device *dev, bool *state);
542
543 /* set/get global audio parameters */
544 int (*set_parameters)(struct audio_hw_device *dev, const char *kv_pairs);
545
546 /*
547 * Returns a pointer to a heap allocated string. The caller is responsible
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800548 * for freeing the memory for it using free().
Dima Zavinf1504db2011-03-11 11:20:49 -0800549 */
550 char * (*get_parameters)(const struct audio_hw_device *dev,
551 const char *keys);
552
553 /* Returns audio input buffer size according to parameters passed or
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800554 * 0 if one of the parameters is not supported.
555 * See also get_buffer_size which is for a particular stream.
Dima Zavinf1504db2011-03-11 11:20:49 -0800556 */
557 size_t (*get_input_buffer_size)(const struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700558 const struct audio_config *config);
Dima Zavinf1504db2011-03-11 11:20:49 -0800559
Eric Laurentf5e24692014-07-27 16:14:57 -0700560 /** This method creates and opens the audio hardware output stream.
561 * The "address" parameter qualifies the "devices" audio device type if needed.
562 * The format format depends on the device type:
563 * - Bluetooth devices use the MAC address of the device in the form "00:11:22:AA:BB:CC"
564 * - USB devices use the ALSA card and device numbers in the form "card=X;device=Y"
565 * - Other devices may use a number or any other string.
566 */
567
Eric Laurent55786bc2012-04-10 16:56:32 -0700568 int (*open_output_stream)(struct audio_hw_device *dev,
569 audio_io_handle_t handle,
570 audio_devices_t devices,
571 audio_output_flags_t flags,
572 struct audio_config *config,
Eric Laurentf5e24692014-07-27 16:14:57 -0700573 struct audio_stream_out **stream_out,
574 const char *address);
Dima Zavinf1504db2011-03-11 11:20:49 -0800575
576 void (*close_output_stream)(struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700577 struct audio_stream_out* stream_out);
Dima Zavinf1504db2011-03-11 11:20:49 -0800578
579 /** This method creates and opens the audio hardware input stream */
Eric Laurent55786bc2012-04-10 16:56:32 -0700580 int (*open_input_stream)(struct audio_hw_device *dev,
581 audio_io_handle_t handle,
582 audio_devices_t devices,
583 struct audio_config *config,
Glenn Kasten7d973ad2014-07-15 11:10:38 -0700584 struct audio_stream_in **stream_in,
Eric Laurentf5e24692014-07-27 16:14:57 -0700585 audio_input_flags_t flags,
586 const char *address,
587 audio_source_t source);
Dima Zavinf1504db2011-03-11 11:20:49 -0800588
589 void (*close_input_stream)(struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700590 struct audio_stream_in *stream_in);
Dima Zavinf1504db2011-03-11 11:20:49 -0800591
592 /** This method dumps the state of the audio hardware */
593 int (*dump)(const struct audio_hw_device *dev, int fd);
John Grossman47bf3d72012-07-17 11:54:04 -0700594
595 /**
596 * set the audio mute status for all audio activities. If any value other
597 * than 0 is returned, the software mixer will emulate this capability.
598 */
599 int (*set_master_mute)(struct audio_hw_device *dev, bool mute);
600
601 /**
602 * Get the current master mute status for the HAL, if the HAL supports
603 * master mute control. AudioFlinger will query this value from the primary
604 * audio HAL when the service starts and use the value for setting the
605 * initial master mute across all HALs. HALs which do not support this
606 * method may leave it set to NULL.
607 */
608 int (*get_master_mute)(struct audio_hw_device *dev, bool *mute);
Eric Laurent73b8a742014-05-22 14:02:38 -0700609
610 /**
611 * Routing control
612 */
613
614 /* Creates an audio patch between several source and sink ports.
615 * The handle is allocated by the HAL and should be unique for this
616 * audio HAL module. */
617 int (*create_audio_patch)(struct audio_hw_device *dev,
618 unsigned int num_sources,
619 const struct audio_port_config *sources,
620 unsigned int num_sinks,
621 const struct audio_port_config *sinks,
622 audio_patch_handle_t *handle);
623
624 /* Release an audio patch */
625 int (*release_audio_patch)(struct audio_hw_device *dev,
626 audio_patch_handle_t handle);
627
628 /* Fills the list of supported attributes for a given audio port.
629 * As input, "port" contains the information (type, role, address etc...)
630 * needed by the HAL to identify the port.
631 * As output, "port" contains possible attributes (sampling rates, formats,
632 * channel masks, gain controllers...) for this port.
633 */
634 int (*get_audio_port)(struct audio_hw_device *dev,
635 struct audio_port *port);
636
637 /* Set audio port configuration */
638 int (*set_audio_port_config)(struct audio_hw_device *dev,
639 const struct audio_port_config *config);
640
Dima Zavinf1504db2011-03-11 11:20:49 -0800641};
642typedef struct audio_hw_device audio_hw_device_t;
643
644/** convenience API for opening and closing a supported device */
645
646static inline int audio_hw_device_open(const struct hw_module_t* module,
647 struct audio_hw_device** device)
648{
649 return module->methods->open(module, AUDIO_HARDWARE_INTERFACE,
650 (struct hw_device_t**)device);
651}
652
653static inline int audio_hw_device_close(struct audio_hw_device* device)
654{
655 return device->common.close(&device->common);
656}
657
658
659__END_DECLS
660
661#endif // ANDROID_AUDIO_INTERFACE_H