blob: 95111dd1b1c7588b57b4123d0fe8fca0730d9bdd [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 Laurenta70c5d02012-03-07 18:59:47 -080097/* A2DP sink address set by framework */
98#define AUDIO_PARAMETER_A2DP_SINK_ADDRESS "a2dp_sink_address"
99
Mike Lockwood2d4d9652014-05-28 11:09:54 -0700100/* A2DP source address set by framework */
101#define AUDIO_PARAMETER_A2DP_SOURCE_ADDRESS "a2dp_source_address"
102
Glenn Kasten34afb682012-06-08 10:49:34 -0700103/* Screen state */
104#define AUDIO_PARAMETER_KEY_SCREEN_STATE "screen_state"
105
Glenn Kastend930d922014-04-29 13:35:57 -0700106/* Bluetooth SCO wideband */
107#define AUDIO_PARAMETER_KEY_BT_SCO_WB "bt_wbs"
108
Eric Laurent70e81102011-08-07 10:05:40 -0700109/**
110 * audio stream parameters
111 */
112
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800113#define AUDIO_PARAMETER_STREAM_ROUTING "routing" // audio_devices_t
114#define AUDIO_PARAMETER_STREAM_FORMAT "format" // audio_format_t
115#define AUDIO_PARAMETER_STREAM_CHANNELS "channels" // audio_channel_mask_t
116#define AUDIO_PARAMETER_STREAM_FRAME_COUNT "frame_count" // size_t
117#define AUDIO_PARAMETER_STREAM_INPUT_SOURCE "input_source" // audio_source_t
118#define AUDIO_PARAMETER_STREAM_SAMPLING_RATE "sampling_rate" // uint32_t
Dima Zavin57dde282011-06-06 19:31:18 -0700119
Eric Laurent41eeb4f2012-05-17 18:54:49 -0700120/* Query supported formats. The response is a '|' separated list of strings from
121 * audio_format_t enum e.g: "sup_formats=AUDIO_FORMAT_PCM_16_BIT" */
122#define AUDIO_PARAMETER_STREAM_SUP_FORMATS "sup_formats"
123/* Query supported channel masks. The response is a '|' separated list of strings from
124 * audio_channel_mask_t enum e.g: "sup_channels=AUDIO_CHANNEL_OUT_STEREO|AUDIO_CHANNEL_OUT_MONO" */
125#define AUDIO_PARAMETER_STREAM_SUP_CHANNELS "sup_channels"
126/* Query supported sampling rates. The response is a '|' separated list of integer values e.g:
127 * "sup_sampling_rates=44100|48000" */
128#define AUDIO_PARAMETER_STREAM_SUP_SAMPLING_RATES "sup_sampling_rates"
129
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000130/**
131 * audio codec parameters
132 */
133
134#define AUDIO_OFFLOAD_CODEC_PARAMS "music_offload_codec_param"
135#define AUDIO_OFFLOAD_CODEC_BIT_PER_SAMPLE "music_offload_bit_per_sample"
136#define AUDIO_OFFLOAD_CODEC_BIT_RATE "music_offload_bit_rate"
137#define AUDIO_OFFLOAD_CODEC_AVG_BIT_RATE "music_offload_avg_bit_rate"
138#define AUDIO_OFFLOAD_CODEC_ID "music_offload_codec_id"
139#define AUDIO_OFFLOAD_CODEC_BLOCK_ALIGN "music_offload_block_align"
140#define AUDIO_OFFLOAD_CODEC_SAMPLE_RATE "music_offload_sample_rate"
141#define AUDIO_OFFLOAD_CODEC_ENCODE_OPTION "music_offload_encode_option"
142#define AUDIO_OFFLOAD_CODEC_NUM_CHANNEL "music_offload_num_channels"
143#define AUDIO_OFFLOAD_CODEC_DOWN_SAMPLING "music_offload_down_sampling"
144#define AUDIO_OFFLOAD_CODEC_DELAY_SAMPLES "delay_samples"
145#define AUDIO_OFFLOAD_CODEC_PADDING_SAMPLES "padding_samples"
Eric Laurent55786bc2012-04-10 16:56:32 -0700146
Eric Laurent70e81102011-08-07 10:05:40 -0700147/**************************************/
148
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000149/* common audio stream configuration parameters
150 * You should memset() the entire structure to zero before use to
151 * ensure forward compatibility
152 */
Eric Laurent55786bc2012-04-10 16:56:32 -0700153struct audio_config {
154 uint32_t sample_rate;
155 audio_channel_mask_t channel_mask;
156 audio_format_t format;
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000157 audio_offload_info_t offload_info;
Eric Laurent55786bc2012-04-10 16:56:32 -0700158};
Eric Laurent55786bc2012-04-10 16:56:32 -0700159typedef struct audio_config audio_config_t;
160
Dima Zavinf1504db2011-03-11 11:20:49 -0800161/* common audio stream parameters and operations */
162struct audio_stream {
163
164 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800165 * Return the sampling rate in Hz - eg. 44100.
Dima Zavinf1504db2011-03-11 11:20:49 -0800166 */
167 uint32_t (*get_sample_rate)(const struct audio_stream *stream);
Dima Zavin57dde282011-06-06 19:31:18 -0700168
169 /* currently unused - use set_parameters with key
170 * AUDIO_PARAMETER_STREAM_SAMPLING_RATE
171 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800172 int (*set_sample_rate)(struct audio_stream *stream, uint32_t rate);
173
174 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800175 * Return size of input/output buffer in bytes for this stream - eg. 4800.
176 * It should be a multiple of the frame size. See also get_input_buffer_size.
Dima Zavinf1504db2011-03-11 11:20:49 -0800177 */
178 size_t (*get_buffer_size)(const struct audio_stream *stream);
179
180 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800181 * Return the channel mask -
Dima Zavinf1504db2011-03-11 11:20:49 -0800182 * e.g. AUDIO_CHANNEL_OUT_STEREO or AUDIO_CHANNEL_IN_STEREO
183 */
Eric Laurent55786bc2012-04-10 16:56:32 -0700184 audio_channel_mask_t (*get_channels)(const struct audio_stream *stream);
Dima Zavinf1504db2011-03-11 11:20:49 -0800185
186 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800187 * Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT
Dima Zavinf1504db2011-03-11 11:20:49 -0800188 */
Glenn Kastenfe79eb32012-01-12 14:55:57 -0800189 audio_format_t (*get_format)(const struct audio_stream *stream);
Dima Zavin57dde282011-06-06 19:31:18 -0700190
191 /* currently unused - use set_parameters with key
192 * AUDIO_PARAMETER_STREAM_FORMAT
193 */
Glenn Kastenfe79eb32012-01-12 14:55:57 -0800194 int (*set_format)(struct audio_stream *stream, audio_format_t format);
Dima Zavinf1504db2011-03-11 11:20:49 -0800195
196 /**
197 * Put the audio hardware input/output into standby mode.
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800198 * Driver should exit from standby mode at the next I/O operation.
Dima Zavinf1504db2011-03-11 11:20:49 -0800199 * Returns 0 on success and <0 on failure.
200 */
201 int (*standby)(struct audio_stream *stream);
202
203 /** dump the state of the audio input/output device */
204 int (*dump)(const struct audio_stream *stream, int fd);
205
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800206 /** Return the set of device(s) which this stream is connected to */
Dima Zavinf1504db2011-03-11 11:20:49 -0800207 audio_devices_t (*get_device)(const struct audio_stream *stream);
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800208
209 /**
210 * Currently unused - set_device() corresponds to set_parameters() with key
211 * AUDIO_PARAMETER_STREAM_ROUTING for both input and output.
212 * AUDIO_PARAMETER_STREAM_INPUT_SOURCE is an additional information used by
213 * input streams only.
214 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800215 int (*set_device)(struct audio_stream *stream, audio_devices_t device);
216
217 /**
218 * set/get audio stream parameters. The function accepts a list of
219 * parameter key value pairs in the form: key1=value1;key2=value2;...
220 *
221 * Some keys are reserved for standard parameters (See AudioParameter class)
222 *
223 * If the implementation does not accept a parameter change while
224 * the output is active but the parameter is acceptable otherwise, it must
225 * return -ENOSYS.
226 *
227 * The audio flinger will put the stream in standby and then change the
228 * parameter value.
229 */
230 int (*set_parameters)(struct audio_stream *stream, const char *kv_pairs);
231
232 /*
233 * Returns a pointer to a heap allocated string. The caller is responsible
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800234 * for freeing the memory for it using free().
Dima Zavinf1504db2011-03-11 11:20:49 -0800235 */
236 char * (*get_parameters)(const struct audio_stream *stream,
237 const char *keys);
Eric Laurentf3008aa2011-06-17 16:53:12 -0700238 int (*add_audio_effect)(const struct audio_stream *stream,
239 effect_handle_t effect);
240 int (*remove_audio_effect)(const struct audio_stream *stream,
241 effect_handle_t effect);
Dima Zavinf1504db2011-03-11 11:20:49 -0800242};
243typedef struct audio_stream audio_stream_t;
244
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000245/* type of asynchronous write callback events. Mutually exclusive */
246typedef enum {
247 STREAM_CBK_EVENT_WRITE_READY, /* non blocking write completed */
248 STREAM_CBK_EVENT_DRAIN_READY /* drain completed */
249} stream_callback_event_t;
250
251typedef int (*stream_callback_t)(stream_callback_event_t event, void *param, void *cookie);
252
253/* type of drain requested to audio_stream_out->drain(). Mutually exclusive */
254typedef enum {
255 AUDIO_DRAIN_ALL, /* drain() returns when all data has been played */
256 AUDIO_DRAIN_EARLY_NOTIFY /* drain() returns a short time before all data
257 from the current track has been played to
258 give time for gapless track switch */
259} audio_drain_type_t;
260
Dima Zavinf1504db2011-03-11 11:20:49 -0800261/**
262 * audio_stream_out is the abstraction interface for the audio output hardware.
263 *
264 * It provides information about various properties of the audio output
265 * hardware driver.
266 */
267
268struct audio_stream_out {
Stewart Miles84d35492014-05-01 09:03:27 -0700269 /**
270 * Common methods of the audio stream out. This *must* be the first member of audio_stream_out
271 * as users of this structure will cast a audio_stream to audio_stream_out pointer in contexts
272 * where it's known the audio_stream references an audio_stream_out.
273 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800274 struct audio_stream common;
275
276 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800277 * Return the audio hardware driver estimated latency in milliseconds.
Dima Zavinf1504db2011-03-11 11:20:49 -0800278 */
279 uint32_t (*get_latency)(const struct audio_stream_out *stream);
280
281 /**
282 * Use this method in situations where audio mixing is done in the
283 * hardware. This method serves as a direct interface with hardware,
284 * allowing you to directly set the volume as apposed to via the framework.
285 * This method might produce multiple PCM outputs or hardware accelerated
286 * codecs, such as MP3 or AAC.
287 */
288 int (*set_volume)(struct audio_stream_out *stream, float left, float right);
289
290 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800291 * Write audio buffer to driver. Returns number of bytes written, or a
292 * negative status_t. If at least one frame was written successfully prior to the error,
293 * it is suggested that the driver return that successful (short) byte count
294 * and then return an error in the subsequent call.
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000295 *
296 * If set_callback() has previously been called to enable non-blocking mode
297 * the write() is not allowed to block. It must write only the number of
298 * bytes that currently fit in the driver/hardware buffer and then return
299 * this byte count. If this is less than the requested write size the
300 * callback function must be called when more space is available in the
301 * driver/hardware buffer.
Dima Zavinf1504db2011-03-11 11:20:49 -0800302 */
303 ssize_t (*write)(struct audio_stream_out *stream, const void* buffer,
304 size_t bytes);
305
306 /* return the number of audio frames written by the audio dsp to DAC since
307 * the output has exited standby
308 */
309 int (*get_render_position)(const struct audio_stream_out *stream,
310 uint32_t *dsp_frames);
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700311
312 /**
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800313 * get the local time at which the next write to the audio driver will be presented.
314 * The units are microseconds, where the epoch is decided by the local audio HAL.
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700315 */
316 int (*get_next_write_timestamp)(const struct audio_stream_out *stream,
317 int64_t *timestamp);
318
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000319 /**
320 * set the callback function for notifying completion of non-blocking
321 * write and drain.
322 * Calling this function implies that all future write() and drain()
323 * must be non-blocking and use the callback to signal completion.
324 */
325 int (*set_callback)(struct audio_stream_out *stream,
326 stream_callback_t callback, void *cookie);
327
328 /**
329 * Notifies to the audio driver to stop playback however the queued buffers are
330 * retained by the hardware. Useful for implementing pause/resume. Empty implementation
331 * if not supported however should be implemented for hardware with non-trivial
332 * latency. In the pause state audio hardware could still be using power. User may
333 * consider calling suspend after a timeout.
334 *
335 * Implementation of this function is mandatory for offloaded playback.
336 */
337 int (*pause)(struct audio_stream_out* stream);
338
339 /**
340 * Notifies to the audio driver to resume playback following a pause.
341 * Returns error if called without matching pause.
342 *
343 * Implementation of this function is mandatory for offloaded playback.
344 */
345 int (*resume)(struct audio_stream_out* stream);
346
347 /**
348 * Requests notification when data buffered by the driver/hardware has
349 * been played. If set_callback() has previously been called to enable
350 * non-blocking mode, the drain() must not block, instead it should return
351 * quickly and completion of the drain is notified through the callback.
352 * If set_callback() has not been called, the drain() must block until
353 * completion.
354 * If type==AUDIO_DRAIN_ALL, the drain completes when all previously written
355 * data has been played.
356 * If type==AUDIO_DRAIN_EARLY_NOTIFY, the drain completes shortly before all
357 * data for the current track has played to allow time for the framework
358 * to perform a gapless track switch.
359 *
360 * Drain must return immediately on stop() and flush() call
361 *
362 * Implementation of this function is mandatory for offloaded playback.
363 */
364 int (*drain)(struct audio_stream_out* stream, audio_drain_type_t type );
365
366 /**
367 * Notifies to the audio driver to flush the queued data. Stream must already
368 * be paused before calling flush().
369 *
370 * Implementation of this function is mandatory for offloaded playback.
371 */
372 int (*flush)(struct audio_stream_out* stream);
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700373
374 /**
Glenn Kasten22a06b72013-09-10 09:23:07 -0700375 * Return a recent count of the number of audio frames presented to an external observer.
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700376 * This excludes frames which have been written but are still in the pipeline.
377 * The count is not reset to zero when output enters standby.
378 * Also returns the value of CLOCK_MONOTONIC as of this presentation count.
Glenn Kasten22a06b72013-09-10 09:23:07 -0700379 * The returned count is expected to be 'recent',
380 * but does not need to be the most recent possible value.
381 * However, the associated time should correspond to whatever count is returned.
382 * Example: assume that N+M frames have been presented, where M is a 'small' number.
383 * Then it is permissible to return N instead of N+M,
384 * and the timestamp should correspond to N rather than N+M.
385 * The terms 'recent' and 'small' are not defined.
386 * They reflect the quality of the implementation.
Glenn Kastene25f9ed2013-08-22 16:27:22 -0700387 *
388 * 3.0 and higher only.
389 */
390 int (*get_presentation_position)(const struct audio_stream_out *stream,
391 uint64_t *frames, struct timespec *timestamp);
392
Dima Zavinf1504db2011-03-11 11:20:49 -0800393};
394typedef struct audio_stream_out audio_stream_out_t;
395
396struct audio_stream_in {
Stewart Miles84d35492014-05-01 09:03:27 -0700397 /**
398 * Common methods of the audio stream in. This *must* be the first member of audio_stream_in
399 * as users of this structure will cast a audio_stream to audio_stream_in pointer in contexts
400 * where it's known the audio_stream references an audio_stream_in.
401 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800402 struct audio_stream common;
403
404 /** set the input gain for the audio driver. This method is for
405 * for future use */
406 int (*set_gain)(struct audio_stream_in *stream, float gain);
407
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800408 /** Read audio buffer in from audio driver. Returns number of bytes read, or a
409 * negative status_t. If at least one frame was read prior to the error,
410 * read should return that byte count and then return an error in the subsequent call.
411 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800412 ssize_t (*read)(struct audio_stream_in *stream, void* buffer,
413 size_t bytes);
414
415 /**
416 * Return the amount of input frames lost in the audio driver since the
417 * last call of this function.
418 * Audio driver is expected to reset the value to 0 and restart counting
419 * upon returning the current value by this function call.
420 * Such loss typically occurs when the user space process is blocked
421 * longer than the capacity of audio driver buffers.
422 *
423 * Unit: the number of input audio frames
424 */
425 uint32_t (*get_input_frames_lost)(struct audio_stream_in *stream);
426};
427typedef struct audio_stream_in audio_stream_in_t;
428
429/**
430 * return the frame size (number of bytes per sample).
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700431 *
432 * Deprecated: use audio_stream_out_frame_size() or audio_stream_in_frame_size() instead.
Dima Zavinf1504db2011-03-11 11:20:49 -0800433 */
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700434__attribute__((__deprecated__))
Glenn Kasten48915ac2012-02-20 12:08:57 -0800435static inline size_t audio_stream_frame_size(const struct audio_stream *s)
Dima Zavinf1504db2011-03-11 11:20:49 -0800436{
Glenn Kastena26cbac2012-01-13 14:53:35 -0800437 size_t chan_samp_sz;
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000438 audio_format_t format = s->get_format(s);
Dima Zavinf1504db2011-03-11 11:20:49 -0800439
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000440 if (audio_is_linear_pcm(format)) {
441 chan_samp_sz = audio_bytes_per_sample(format);
442 return popcount(s->get_channels(s)) * chan_samp_sz;
Dima Zavinf1504db2011-03-11 11:20:49 -0800443 }
444
Richard Fitzgeraldf37f1872013-03-25 16:11:44 +0000445 return sizeof(int8_t);
Dima Zavinf1504db2011-03-11 11:20:49 -0800446}
447
Eric Laurentc5ae6a02014-07-02 13:45:32 -0700448/**
449 * return the frame size (number of bytes per sample) of an output stream.
450 */
451static inline size_t audio_stream_out_frame_size(const struct audio_stream_out *s)
452{
453 size_t chan_samp_sz;
454 audio_format_t format = s->common.get_format(&s->common);
455
456 if (audio_is_linear_pcm(format)) {
457 chan_samp_sz = audio_bytes_per_sample(format);
458 return audio_channel_count_from_out_mask(s->common.get_channels(&s->common)) * chan_samp_sz;
459 }
460
461 return sizeof(int8_t);
462}
463
464/**
465 * return the frame size (number of bytes per sample) of an input stream.
466 */
467static inline size_t audio_stream_in_frame_size(const struct audio_stream_in *s)
468{
469 size_t chan_samp_sz;
470 audio_format_t format = s->common.get_format(&s->common);
471
472 if (audio_is_linear_pcm(format)) {
473 chan_samp_sz = audio_bytes_per_sample(format);
474 return audio_channel_count_from_in_mask(s->common.get_channels(&s->common)) * chan_samp_sz;
475 }
476
477 return sizeof(int8_t);
478}
Dima Zavinf1504db2011-03-11 11:20:49 -0800479
480/**********************************************************************/
481
482/**
483 * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM
484 * and the fields of this data structure must begin with hw_module_t
485 * followed by module specific information.
486 */
487struct audio_module {
488 struct hw_module_t common;
489};
490
491struct audio_hw_device {
Stewart Miles84d35492014-05-01 09:03:27 -0700492 /**
493 * Common methods of the audio device. This *must* be the first member of audio_hw_device
494 * as users of this structure will cast a hw_device_t to audio_hw_device pointer in contexts
495 * where it's known the hw_device_t references an audio_hw_device.
496 */
Dima Zavinf1504db2011-03-11 11:20:49 -0800497 struct hw_device_t common;
498
499 /**
500 * used by audio flinger to enumerate what devices are supported by
501 * each audio_hw_device implementation.
502 *
503 * Return value is a bitmask of 1 or more values of audio_devices_t
Eric Laurent85e08e22012-08-28 14:30:35 -0700504 *
505 * NOTE: audio HAL implementations starting with
506 * AUDIO_DEVICE_API_VERSION_2_0 do not implement this function.
507 * All supported devices should be listed in audio_policy.conf
508 * file and the audio policy manager must choose the appropriate
509 * audio module based on information in this file.
Dima Zavinf1504db2011-03-11 11:20:49 -0800510 */
511 uint32_t (*get_supported_devices)(const struct audio_hw_device *dev);
512
513 /**
514 * check to see if the audio hardware interface has been initialized.
515 * returns 0 on success, -ENODEV on failure.
516 */
517 int (*init_check)(const struct audio_hw_device *dev);
518
519 /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */
520 int (*set_voice_volume)(struct audio_hw_device *dev, float volume);
521
522 /**
523 * set the audio volume for all audio activities other than voice call.
524 * Range between 0.0 and 1.0. If any value other than 0 is returned,
525 * the software mixer will emulate this capability.
526 */
527 int (*set_master_volume)(struct audio_hw_device *dev, float volume);
528
529 /**
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700530 * Get the current master volume value for the HAL, if the HAL supports
531 * master volume control. AudioFlinger will query this value from the
532 * primary audio HAL when the service starts and use the value for setting
533 * the initial master volume across all HALs. HALs which do not support
John Grossman47bf3d72012-07-17 11:54:04 -0700534 * this method may leave it set to NULL.
Mike J. Chen5ad38a92011-08-15 12:05:00 -0700535 */
536 int (*get_master_volume)(struct audio_hw_device *dev, float *volume);
537
538 /**
Glenn Kasten6df641e2012-01-09 10:41:30 -0800539 * set_mode is called when the audio mode changes. AUDIO_MODE_NORMAL mode
Dima Zavinf1504db2011-03-11 11:20:49 -0800540 * is for standard audio playback, AUDIO_MODE_RINGTONE when a ringtone is
541 * playing, and AUDIO_MODE_IN_CALL when a call is in progress.
Dima Zavinf1504db2011-03-11 11:20:49 -0800542 */
Glenn Kasten6df641e2012-01-09 10:41:30 -0800543 int (*set_mode)(struct audio_hw_device *dev, audio_mode_t mode);
Dima Zavinf1504db2011-03-11 11:20:49 -0800544
545 /* mic mute */
546 int (*set_mic_mute)(struct audio_hw_device *dev, bool state);
547 int (*get_mic_mute)(const struct audio_hw_device *dev, bool *state);
548
549 /* set/get global audio parameters */
550 int (*set_parameters)(struct audio_hw_device *dev, const char *kv_pairs);
551
552 /*
553 * Returns a pointer to a heap allocated string. The caller is responsible
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800554 * for freeing the memory for it using free().
Dima Zavinf1504db2011-03-11 11:20:49 -0800555 */
556 char * (*get_parameters)(const struct audio_hw_device *dev,
557 const char *keys);
558
559 /* Returns audio input buffer size according to parameters passed or
Glenn Kasten0cacd8d2012-02-10 13:42:44 -0800560 * 0 if one of the parameters is not supported.
561 * See also get_buffer_size which is for a particular stream.
Dima Zavinf1504db2011-03-11 11:20:49 -0800562 */
563 size_t (*get_input_buffer_size)(const struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700564 const struct audio_config *config);
Dima Zavinf1504db2011-03-11 11:20:49 -0800565
566 /** This method creates and opens the audio hardware output stream */
Eric Laurent55786bc2012-04-10 16:56:32 -0700567 int (*open_output_stream)(struct audio_hw_device *dev,
568 audio_io_handle_t handle,
569 audio_devices_t devices,
570 audio_output_flags_t flags,
571 struct audio_config *config,
572 struct audio_stream_out **stream_out);
Dima Zavinf1504db2011-03-11 11:20:49 -0800573
574 void (*close_output_stream)(struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700575 struct audio_stream_out* stream_out);
Dima Zavinf1504db2011-03-11 11:20:49 -0800576
577 /** This method creates and opens the audio hardware input stream */
Eric Laurent55786bc2012-04-10 16:56:32 -0700578 int (*open_input_stream)(struct audio_hw_device *dev,
579 audio_io_handle_t handle,
580 audio_devices_t devices,
581 struct audio_config *config,
Glenn Kasten7d973ad2014-07-15 11:10:38 -0700582 struct audio_stream_in **stream_in,
583 audio_input_flags_t flags);
Dima Zavinf1504db2011-03-11 11:20:49 -0800584
585 void (*close_input_stream)(struct audio_hw_device *dev,
Eric Laurent55786bc2012-04-10 16:56:32 -0700586 struct audio_stream_in *stream_in);
Dima Zavinf1504db2011-03-11 11:20:49 -0800587
588 /** This method dumps the state of the audio hardware */
589 int (*dump)(const struct audio_hw_device *dev, int fd);
John Grossman47bf3d72012-07-17 11:54:04 -0700590
591 /**
592 * set the audio mute status for all audio activities. If any value other
593 * than 0 is returned, the software mixer will emulate this capability.
594 */
595 int (*set_master_mute)(struct audio_hw_device *dev, bool mute);
596
597 /**
598 * Get the current master mute status for the HAL, if the HAL supports
599 * master mute control. AudioFlinger will query this value from the primary
600 * audio HAL when the service starts and use the value for setting the
601 * initial master mute across all HALs. HALs which do not support this
602 * method may leave it set to NULL.
603 */
604 int (*get_master_mute)(struct audio_hw_device *dev, bool *mute);
Eric Laurent73b8a742014-05-22 14:02:38 -0700605
606 /**
607 * Routing control
608 */
609
610 /* Creates an audio patch between several source and sink ports.
611 * The handle is allocated by the HAL and should be unique for this
612 * audio HAL module. */
613 int (*create_audio_patch)(struct audio_hw_device *dev,
614 unsigned int num_sources,
615 const struct audio_port_config *sources,
616 unsigned int num_sinks,
617 const struct audio_port_config *sinks,
618 audio_patch_handle_t *handle);
619
620 /* Release an audio patch */
621 int (*release_audio_patch)(struct audio_hw_device *dev,
622 audio_patch_handle_t handle);
623
624 /* Fills the list of supported attributes for a given audio port.
625 * As input, "port" contains the information (type, role, address etc...)
626 * needed by the HAL to identify the port.
627 * As output, "port" contains possible attributes (sampling rates, formats,
628 * channel masks, gain controllers...) for this port.
629 */
630 int (*get_audio_port)(struct audio_hw_device *dev,
631 struct audio_port *port);
632
633 /* Set audio port configuration */
634 int (*set_audio_port_config)(struct audio_hw_device *dev,
635 const struct audio_port_config *config);
636
Dima Zavinf1504db2011-03-11 11:20:49 -0800637};
638typedef struct audio_hw_device audio_hw_device_t;
639
640/** convenience API for opening and closing a supported device */
641
642static inline int audio_hw_device_open(const struct hw_module_t* module,
643 struct audio_hw_device** device)
644{
645 return module->methods->open(module, AUDIO_HARDWARE_INTERFACE,
646 (struct hw_device_t**)device);
647}
648
649static inline int audio_hw_device_close(struct audio_hw_device* device)
650{
651 return device->common.close(&device->common);
652}
653
654
655__END_DECLS
656
657#endif // ANDROID_AUDIO_INTERFACE_H