audio.h revision 431fc78c112646f43d6d6f51b06d45d248d2f317
1f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* 2f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Copyright (C) 2011 The Android Open Source Project 3f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 4f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Licensed under the Apache License, Version 2.0 (the "License"); 5f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * you may not use this file except in compliance with the License. 6f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * You may obtain a copy of the License at 7f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 8f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * http://www.apache.org/licenses/LICENSE-2.0 9f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 10f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Unless required by applicable law or agreed to in writing, software 11f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * distributed under the License is distributed on an "AS IS" BASIS, 12f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * See the License for the specific language governing permissions and 14f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * limitations under the License. 15f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 16f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 17f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 18f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#ifndef ANDROID_AUDIO_HAL_INTERFACE_H 19f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define ANDROID_AUDIO_HAL_INTERFACE_H 20f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 21f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <stdint.h> 22f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <strings.h> 23f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <sys/cdefs.h> 24f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <sys/types.h> 25f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 26f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <cutils/bitops.h> 27f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 28f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <hardware/hardware.h> 29aa21172bcd4c332eec78d34ffdafd8cc0178ea95Dima Zavin#include <system/audio.h> 30f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent#include <hardware/audio_effect.h> 31f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 32f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin__BEGIN_DECLS 33f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 34f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 35f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The id of this module 36f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 37f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define AUDIO_HARDWARE_MODULE_ID "audio" 38f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 39f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 40f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Name of the audio devices to open 41f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 42f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define AUDIO_HARDWARE_INTERFACE "audio_hw_if" 43f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 44431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent/** 45431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent * List of known audio HAL modules. This is the base name of the audio HAL 46431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent * library composed of the "audio." prefix, one of the base names below and 47431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent * a suffix specific to the device. 48431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent * e.g: audio.primary.goldfish.so or audio.a2dp.default.so 49431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent */ 50431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent 51431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent#define AUDIO_HARDWARE_MODULE_ID_PRIMARY "primary" 52431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent#define AUDIO_HARDWARE_MODULE_ID_A2DP "a2dp" 53431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent#define AUDIO_HARDWARE_MODULE_ID_USB "usb" 54431fc78c112646f43d6d6f51b06d45d248d2f317Eric Laurent 55f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/**************************************/ 56f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 5770e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent/** 5870e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent * standard audio parameters that the HAL may need to handle 5970e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent */ 6070e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent 6170e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent/** 6270e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent * audio device parameters 6370e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent */ 6470e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent 65ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent/* BT SCO Noise Reduction + Echo Cancellation parameters */ 66ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_KEY_BT_NREC "bt_headset_nrec" 67ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_VALUE_ON "on" 68ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_VALUE_OFF "off" 69ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent 7070e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent/* TTY mode selection */ 7170e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent#define AUDIO_PARAMETER_KEY_TTY_MODE "tty_mode" 7270e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent#define AUDIO_PARAMETER_VALUE_TTY_OFF "tty_off" 7370e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent#define AUDIO_PARAMETER_VALUE_TTY_VCO "tty_vco" 7470e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent#define AUDIO_PARAMETER_VALUE_TTY_HCO "tty_hco" 7570e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent#define AUDIO_PARAMETER_VALUE_TTY_FULL "tty_full" 7670e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent 77a70c5d0cafe1ef9e4531627d3d009e80b9a8eec4Eric Laurent/* A2DP sink address set by framework */ 78a70c5d0cafe1ef9e4531627d3d009e80b9a8eec4Eric Laurent#define AUDIO_PARAMETER_A2DP_SINK_ADDRESS "a2dp_sink_address" 79a70c5d0cafe1ef9e4531627d3d009e80b9a8eec4Eric Laurent 8070e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent/** 8170e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent * audio stream parameters 8270e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent */ 8370e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent 8457dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_ROUTING "routing" 8557dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_FORMAT "format" 8657dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_CHANNELS "channels" 8757dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_FRAME_COUNT "frame_count" 8857dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_INPUT_SOURCE "input_source" 8957dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 9070e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent/**************************************/ 9170e8110fcf2c35d1ac67f0eb4a2702014a16719bEric Laurent 92f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* common audio stream parameters and operations */ 93f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream { 94f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 95f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 96f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * sampling rate is in Hz - eg. 44100 97f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 98f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_sample_rate)(const struct audio_stream *stream); 9957dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 10057dde28fb80e1a166db283296812f5fb078ca24aDima Zavin /* currently unused - use set_parameters with key 10157dde28fb80e1a166db283296812f5fb078ca24aDima Zavin * AUDIO_PARAMETER_STREAM_SAMPLING_RATE 10257dde28fb80e1a166db283296812f5fb078ca24aDima Zavin */ 103f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_sample_rate)(struct audio_stream *stream, uint32_t rate); 104f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 105f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 106f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * size of output buffer in bytes - eg. 4800 107f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 108f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t (*get_buffer_size)(const struct audio_stream *stream); 109f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 110f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 111f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the channel mask - 112f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * e.g. AUDIO_CHANNEL_OUT_STEREO or AUDIO_CHANNEL_IN_STEREO 113f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 114f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_channels)(const struct audio_stream *stream); 115f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 116f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 117f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio format - eg. AUDIO_FORMAT_PCM_16_BIT 118f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 119fe79eb3f06967f863a637e546eb4421d0da2283bGlenn Kasten audio_format_t (*get_format)(const struct audio_stream *stream); 12057dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 12157dde28fb80e1a166db283296812f5fb078ca24aDima Zavin /* currently unused - use set_parameters with key 12257dde28fb80e1a166db283296812f5fb078ca24aDima Zavin * AUDIO_PARAMETER_STREAM_FORMAT 12357dde28fb80e1a166db283296812f5fb078ca24aDima Zavin */ 124fe79eb3f06967f863a637e546eb4421d0da2283bGlenn Kasten int (*set_format)(struct audio_stream *stream, audio_format_t format); 125f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 126f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 127f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Put the audio hardware input/output into standby mode. 128f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns 0 on success and <0 on failure. 129f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 130f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*standby)(struct audio_stream *stream); 131f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 132f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** dump the state of the audio input/output device */ 133f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*dump)(const struct audio_stream *stream, int fd); 134f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 135f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_devices_t (*get_device)(const struct audio_stream *stream); 136f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_device)(struct audio_stream *stream, audio_devices_t device); 137f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 138f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 139f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * set/get audio stream parameters. The function accepts a list of 140f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * parameter key value pairs in the form: key1=value1;key2=value2;... 141f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 142f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Some keys are reserved for standard parameters (See AudioParameter class) 143f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 144f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * If the implementation does not accept a parameter change while 145f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the output is active but the parameter is acceptable otherwise, it must 146f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return -ENOSYS. 147f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 148f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The audio flinger will put the stream in standby and then change the 149f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * parameter value. 150f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 151f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_parameters)(struct audio_stream *stream, const char *kv_pairs); 152f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 153f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 154f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns a pointer to a heap allocated string. The caller is responsible 155f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for freeing the memory for it. 156f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 157f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin char * (*get_parameters)(const struct audio_stream *stream, 158f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *keys); 159f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent int (*add_audio_effect)(const struct audio_stream *stream, 160f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent effect_handle_t effect); 161f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent int (*remove_audio_effect)(const struct audio_stream *stream, 162f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent effect_handle_t effect); 163f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 164f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream audio_stream_t; 165f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 166f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 167f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio_stream_out is the abstraction interface for the audio output hardware. 168f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 169f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * It provides information about various properties of the audio output 170f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * hardware driver. 171f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 172f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 173f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream_out { 174f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream common; 175f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 176f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 177f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return the audio hardware driver latency in milli seconds. 178f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 179f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_latency)(const struct audio_stream_out *stream); 180f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 181f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 182f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Use this method in situations where audio mixing is done in the 183f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * hardware. This method serves as a direct interface with hardware, 184f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * allowing you to directly set the volume as apposed to via the framework. 185f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * This method might produce multiple PCM outputs or hardware accelerated 186f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * codecs, such as MP3 or AAC. 187f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 188f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_volume)(struct audio_stream_out *stream, float left, float right); 189f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 190f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 191f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * write audio buffer to driver. Returns number of bytes written 192f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 193f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin ssize_t (*write)(struct audio_stream_out *stream, const void* buffer, 194f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t bytes); 195f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 196f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* return the number of audio frames written by the audio dsp to DAC since 197f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the output has exited standby 198f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 199f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_render_position)(const struct audio_stream_out *stream, 200f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *dsp_frames); 2015ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen 2025ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen /** 2035ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * get the local time at which the next write to the audio driver will be 2045ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * presented 2055ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen */ 2065ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen int (*get_next_write_timestamp)(const struct audio_stream_out *stream, 2075ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen int64_t *timestamp); 2085ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen 209f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 210f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream_out audio_stream_out_t; 211f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 212f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream_in { 213f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream common; 214f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 215f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** set the input gain for the audio driver. This method is for 216f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for future use */ 217f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_gain)(struct audio_stream_in *stream, float gain); 218f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 219f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** read audio buffer in from audio driver */ 220f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin ssize_t (*read)(struct audio_stream_in *stream, void* buffer, 221f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t bytes); 222f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 223f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 224f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Return the amount of input frames lost in the audio driver since the 225f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * last call of this function. 226f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Audio driver is expected to reset the value to 0 and restart counting 227f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * upon returning the current value by this function call. 228f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Such loss typically occurs when the user space process is blocked 229f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * longer than the capacity of audio driver buffers. 230f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 231f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Unit: the number of input audio frames 232f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 233f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_input_frames_lost)(struct audio_stream_in *stream); 234f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 235f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream_in audio_stream_in_t; 236f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 237f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 238f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return the frame size (number of bytes per sample). 239f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 240a26cbac8a0f71ba59a89e250caaa1155f0179751Glenn Kastenstatic inline size_t audio_stream_frame_size(struct audio_stream *s) 241f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 242a26cbac8a0f71ba59a89e250caaa1155f0179751Glenn Kasten size_t chan_samp_sz; 243f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 244f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin switch (s->get_format(s)) { 245f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin case AUDIO_FORMAT_PCM_16_BIT: 246f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin chan_samp_sz = sizeof(int16_t); 247f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin break; 248f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin case AUDIO_FORMAT_PCM_8_BIT: 249f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin default: 250f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin chan_samp_sz = sizeof(int8_t); 251f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin break; 252f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin } 253f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 254f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return popcount(s->get_channels(s)) * chan_samp_sz; 255f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 256f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 257f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 258f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/**********************************************************************/ 259f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 260f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 261f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 262f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * and the fields of this data structure must begin with hw_module_t 263f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * followed by module specific information. 264f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 265f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_module { 266f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_module_t common; 267f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 268f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 269f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_hw_device { 270f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_device_t common; 271f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 272f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 273f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * used by audio flinger to enumerate what devices are supported by 274f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * each audio_hw_device implementation. 275f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 276f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Return value is a bitmask of 1 or more values of audio_devices_t 277f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 278f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_supported_devices)(const struct audio_hw_device *dev); 279f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 280f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 281f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * check to see if the audio hardware interface has been initialized. 282f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * returns 0 on success, -ENODEV on failure. 283f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 284f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*init_check)(const struct audio_hw_device *dev); 285f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 286f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */ 287f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_voice_volume)(struct audio_hw_device *dev, float volume); 288f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 289f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 290f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * set the audio volume for all audio activities other than voice call. 291f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Range between 0.0 and 1.0. If any value other than 0 is returned, 292f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the software mixer will emulate this capability. 293f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 294f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_master_volume)(struct audio_hw_device *dev, float volume); 295f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 296f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 2975ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * Get the current master volume value for the HAL, if the HAL supports 2985ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * master volume control. AudioFlinger will query this value from the 2995ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * primary audio HAL when the service starts and use the value for setting 3005ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * the initial master volume across all HALs. HALs which do not support 3015ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen * this method should may leave it set to NULL. 3025ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen */ 3035ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen int (*get_master_volume)(struct audio_hw_device *dev, float *volume); 3045ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen 3055ad38a901dcca2961f3ed35ae0b206c13bc515cdMike J. Chen /** 3066df641e269639dbb81bb1c19f47d3b9e5e3ff7d7Glenn Kasten * set_mode is called when the audio mode changes. AUDIO_MODE_NORMAL mode 307f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * is for standard audio playback, AUDIO_MODE_RINGTONE when a ringtone is 308f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * playing, and AUDIO_MODE_IN_CALL when a call is in progress. 309f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 3106df641e269639dbb81bb1c19f47d3b9e5e3ff7d7Glenn Kasten int (*set_mode)(struct audio_hw_device *dev, audio_mode_t mode); 311f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 312f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* mic mute */ 313f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_mic_mute)(struct audio_hw_device *dev, bool state); 314f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_mic_mute)(const struct audio_hw_device *dev, bool *state); 315f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 316f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* set/get global audio parameters */ 317f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_parameters)(struct audio_hw_device *dev, const char *kv_pairs); 318f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 319f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 320f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns a pointer to a heap allocated string. The caller is responsible 321f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for freeing the memory for it. 322f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 323f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin char * (*get_parameters)(const struct audio_hw_device *dev, 324f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *keys); 325f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 326f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* Returns audio input buffer size according to parameters passed or 327f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 0 if one of the parameters is not supported 328f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 329f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t (*get_input_buffer_size)(const struct audio_hw_device *dev, 330fe79eb3f06967f863a637e546eb4421d0da2283bGlenn Kasten uint32_t sample_rate, audio_format_t format, 331f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int channel_count); 332f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 333f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method creates and opens the audio hardware output stream */ 334f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*open_output_stream)(struct audio_hw_device *dev, uint32_t devices, 335fe79eb3f06967f863a637e546eb4421d0da2283bGlenn Kasten audio_format_t *format, uint32_t *channels, 336f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *sample_rate, 337f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_out **out); 338f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 339f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*close_output_stream)(struct audio_hw_device *dev, 340f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_out* out); 341f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 342f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method creates and opens the audio hardware input stream */ 343f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*open_input_stream)(struct audio_hw_device *dev, uint32_t devices, 344fe79eb3f06967f863a637e546eb4421d0da2283bGlenn Kasten audio_format_t *format, uint32_t *channels, 345f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *sample_rate, 346f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_in_acoustics_t acoustics, 347f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_in **stream_in); 348f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 349f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*close_input_stream)(struct audio_hw_device *dev, 350f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_in *in); 351f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 352f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method dumps the state of the audio hardware */ 353f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*dump)(const struct audio_hw_device *dev, int fd); 354f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 355f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_hw_device audio_hw_device_t; 356f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 357f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** convenience API for opening and closing a supported device */ 358f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 359f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_hw_device_open(const struct hw_module_t* module, 360f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_hw_device** device) 361f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 362f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return module->methods->open(module, AUDIO_HARDWARE_INTERFACE, 363f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin (struct hw_device_t**)device); 364f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 365f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 366f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_hw_device_close(struct audio_hw_device* device) 367f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 368f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return device->common.close(&device->common); 369f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 370f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 371f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 372f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin__END_DECLS 373f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 374f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#endif // ANDROID_AUDIO_INTERFACE_H 375