audio.h revision ed9928c76d107d02452a25a0d62803197c47f673
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 44f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/**************************************/ 45f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 46ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent/* BT SCO Noise Reduction + Echo Cancellation parameters */ 47ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_KEY_BT_NREC "bt_headset_nrec" 48ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_VALUE_ON "on" 49ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent#define AUDIO_PARAMETER_VALUE_OFF "off" 50ed9928c76d107d02452a25a0d62803197c47f673Eric Laurent 5157dde28fb80e1a166db283296812f5fb078ca24aDima Zavin/* standard audio parameters that the HAL may need to handle */ 5257dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_ROUTING "routing" 5357dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_FORMAT "format" 5457dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_CHANNELS "channels" 5557dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_FRAME_COUNT "frame_count" 5657dde28fb80e1a166db283296812f5fb078ca24aDima Zavin#define AUDIO_PARAMETER_STREAM_INPUT_SOURCE "input_source" 5757dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 58f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* common audio stream parameters and operations */ 59f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream { 60f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 61f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 62f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * sampling rate is in Hz - eg. 44100 63f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 64f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_sample_rate)(const struct audio_stream *stream); 6557dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 6657dde28fb80e1a166db283296812f5fb078ca24aDima Zavin /* currently unused - use set_parameters with key 6757dde28fb80e1a166db283296812f5fb078ca24aDima Zavin * AUDIO_PARAMETER_STREAM_SAMPLING_RATE 6857dde28fb80e1a166db283296812f5fb078ca24aDima Zavin */ 69f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_sample_rate)(struct audio_stream *stream, uint32_t rate); 70f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 71f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 72f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * size of output buffer in bytes - eg. 4800 73f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 74f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t (*get_buffer_size)(const struct audio_stream *stream); 75f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 76f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 77f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the channel mask - 78f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * e.g. AUDIO_CHANNEL_OUT_STEREO or AUDIO_CHANNEL_IN_STEREO 79f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 80f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_channels)(const struct audio_stream *stream); 81f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 82f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 83f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio format - eg. AUDIO_FORMAT_PCM_16_BIT 84f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 85f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_format)(const struct audio_stream *stream); 8657dde28fb80e1a166db283296812f5fb078ca24aDima Zavin 8757dde28fb80e1a166db283296812f5fb078ca24aDima Zavin /* currently unused - use set_parameters with key 8857dde28fb80e1a166db283296812f5fb078ca24aDima Zavin * AUDIO_PARAMETER_STREAM_FORMAT 8957dde28fb80e1a166db283296812f5fb078ca24aDima Zavin */ 90f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_format)(struct audio_stream *stream, int format); 91f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 92f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 93f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Put the audio hardware input/output into standby mode. 94f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns 0 on success and <0 on failure. 95f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 96f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*standby)(struct audio_stream *stream); 97f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 98f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** dump the state of the audio input/output device */ 99f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*dump)(const struct audio_stream *stream, int fd); 100f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 101f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_devices_t (*get_device)(const struct audio_stream *stream); 102f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_device)(struct audio_stream *stream, audio_devices_t device); 103f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 104f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 105f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * set/get audio stream parameters. The function accepts a list of 106f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * parameter key value pairs in the form: key1=value1;key2=value2;... 107f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 108f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Some keys are reserved for standard parameters (See AudioParameter class) 109f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 110f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * If the implementation does not accept a parameter change while 111f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the output is active but the parameter is acceptable otherwise, it must 112f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return -ENOSYS. 113f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 114f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The audio flinger will put the stream in standby and then change the 115f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * parameter value. 116f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 117f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_parameters)(struct audio_stream *stream, const char *kv_pairs); 118f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 119f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 120f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns a pointer to a heap allocated string. The caller is responsible 121f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for freeing the memory for it. 122f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 123f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin char * (*get_parameters)(const struct audio_stream *stream, 124f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *keys); 125f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent int (*add_audio_effect)(const struct audio_stream *stream, 126f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent effect_handle_t effect); 127f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent int (*remove_audio_effect)(const struct audio_stream *stream, 128f3008aa707c1c302e8c8f9c8b759f170d972ddceEric Laurent effect_handle_t effect); 129f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 130f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream audio_stream_t; 131f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 132f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 133f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio_stream_out is the abstraction interface for the audio output hardware. 134f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 135f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * It provides information about various properties of the audio output 136f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * hardware driver. 137f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 138f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 139f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream_out { 140f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream common; 141f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 142f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 143f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return the audio hardware driver latency in milli seconds. 144f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 145f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_latency)(const struct audio_stream_out *stream); 146f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 147f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 148f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Use this method in situations where audio mixing is done in the 149f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * hardware. This method serves as a direct interface with hardware, 150f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * allowing you to directly set the volume as apposed to via the framework. 151f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * This method might produce multiple PCM outputs or hardware accelerated 152f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * codecs, such as MP3 or AAC. 153f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 154f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_volume)(struct audio_stream_out *stream, float left, float right); 155f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 156f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 157f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * write audio buffer to driver. Returns number of bytes written 158f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 159f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin ssize_t (*write)(struct audio_stream_out *stream, const void* buffer, 160f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t bytes); 161f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 162f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* return the number of audio frames written by the audio dsp to DAC since 163f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the output has exited standby 164f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 165f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_render_position)(const struct audio_stream_out *stream, 166f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *dsp_frames); 167f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 168f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream_out audio_stream_out_t; 169f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 170f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_stream_in { 171f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream common; 172f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 173f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** set the input gain for the audio driver. This method is for 174f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for future use */ 175f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_gain)(struct audio_stream_in *stream, float gain); 176f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 177f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** read audio buffer in from audio driver */ 178f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin ssize_t (*read)(struct audio_stream_in *stream, void* buffer, 179f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t bytes); 180f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 181f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 182f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Return the amount of input frames lost in the audio driver since the 183f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * last call of this function. 184f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Audio driver is expected to reset the value to 0 and restart counting 185f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * upon returning the current value by this function call. 186f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Such loss typically occurs when the user space process is blocked 187f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * longer than the capacity of audio driver buffers. 188f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 189f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Unit: the number of input audio frames 190f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 191f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_input_frames_lost)(struct audio_stream_in *stream); 192f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 193f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_stream_in audio_stream_in_t; 194f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 195f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 196f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * return the frame size (number of bytes per sample). 197f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 198f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline uint32_t audio_stream_frame_size(struct audio_stream *s) 199f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 200f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int chan_samp_sz; 201f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 202f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin switch (s->get_format(s)) { 203f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin case AUDIO_FORMAT_PCM_16_BIT: 204f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin chan_samp_sz = sizeof(int16_t); 205f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin break; 206f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin case AUDIO_FORMAT_PCM_8_BIT: 207f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin default: 208f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin chan_samp_sz = sizeof(int8_t); 209f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin break; 210f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin } 211f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 212f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return popcount(s->get_channels(s)) * chan_samp_sz; 213f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 214f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 215f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 216f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/**********************************************************************/ 217f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 218f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 219f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 220f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * and the fields of this data structure must begin with hw_module_t 221f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * followed by module specific information. 222f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 223f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_module { 224f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_module_t common; 225f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 226f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 227f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_hw_device { 228f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_device_t common; 229f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 230f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 231f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * used by audio flinger to enumerate what devices are supported by 232f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * each audio_hw_device implementation. 233f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 234f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Return value is a bitmask of 1 or more values of audio_devices_t 235f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 236f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_supported_devices)(const struct audio_hw_device *dev); 237f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 238f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 239f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * check to see if the audio hardware interface has been initialized. 240f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * returns 0 on success, -ENODEV on failure. 241f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 242f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*init_check)(const struct audio_hw_device *dev); 243f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 244f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */ 245f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_voice_volume)(struct audio_hw_device *dev, float volume); 246f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 247f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 248f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * set the audio volume for all audio activities other than voice call. 249f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Range between 0.0 and 1.0. If any value other than 0 is returned, 250f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the software mixer will emulate this capability. 251f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 252f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_master_volume)(struct audio_hw_device *dev, float volume); 253f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 254f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** 255f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * setMode is called when the audio mode changes. AUDIO_MODE_NORMAL mode 256f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * is for standard audio playback, AUDIO_MODE_RINGTONE when a ringtone is 257f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * playing, and AUDIO_MODE_IN_CALL when a call is in progress. 258f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 259f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_mode)(struct audio_hw_device *dev, int mode); 260f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 261f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* mic mute */ 262f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_mic_mute)(struct audio_hw_device *dev, bool state); 263f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_mic_mute)(const struct audio_hw_device *dev, bool *state); 264f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 265f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* set/get global audio parameters */ 266f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_parameters)(struct audio_hw_device *dev, const char *kv_pairs); 267f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 268f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 269f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns a pointer to a heap allocated string. The caller is responsible 270f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for freeing the memory for it. 271f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 272f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin char * (*get_parameters)(const struct audio_hw_device *dev, 273f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *keys); 274f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 275f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* Returns audio input buffer size according to parameters passed or 276f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 0 if one of the parameters is not supported 277f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 278f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin size_t (*get_input_buffer_size)(const struct audio_hw_device *dev, 279f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t sample_rate, int format, 280f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int channel_count); 281f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 282f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method creates and opens the audio hardware output stream */ 283f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*open_output_stream)(struct audio_hw_device *dev, uint32_t devices, 284f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int *format, uint32_t *channels, 285f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *sample_rate, 286f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_out **out); 287f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 288f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*close_output_stream)(struct audio_hw_device *dev, 289f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_out* out); 290f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 291f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method creates and opens the audio hardware input stream */ 292f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*open_input_stream)(struct audio_hw_device *dev, uint32_t devices, 293f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int *format, uint32_t *channels, 294f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *sample_rate, 295f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_in_acoustics_t acoustics, 296f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_in **stream_in); 297f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 298f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*close_input_stream)(struct audio_hw_device *dev, 299f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_stream_in *in); 300f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 301f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /** This method dumps the state of the audio hardware */ 302f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*dump)(const struct audio_hw_device *dev, int fd); 303f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 304f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_hw_device audio_hw_device_t; 305f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 306f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** convenience API for opening and closing a supported device */ 307f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 308f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_hw_device_open(const struct hw_module_t* module, 309f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_hw_device** device) 310f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 311f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return module->methods->open(module, AUDIO_HARDWARE_INTERFACE, 312f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin (struct hw_device_t**)device); 313f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 314f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 315f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_hw_device_close(struct audio_hw_device* device) 316f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 317f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return device->common.close(&device->common); 318f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 319f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 320f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 321f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin__END_DECLS 322f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 323f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#endif // ANDROID_AUDIO_INTERFACE_H 324