audio_policy.h revision 1199865d0cb68750e2b959cb3ed04e1bc0f1c9d1
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_POLICY_INTERFACE_H 19f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define ANDROID_AUDIO_POLICY_INTERFACE_H 20f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 21f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <stdint.h> 22f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <sys/cdefs.h> 23f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <sys/types.h> 24f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 25f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#include <hardware/hardware.h> 26f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 27aa21172bcd4c332eec78d34ffdafd8cc0178ea95Dima Zavin#include <system/audio.h> 281199865d0cb68750e2b959cb3ed04e1bc0f1c9d1Dima Zavin#include <system/audio_policy.h> 29f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 30f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin__BEGIN_DECLS 31f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 32f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 33f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The id of this module 34f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 35f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define AUDIO_POLICY_HARDWARE_MODULE_ID "audio_policy" 36f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 37f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 38f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Name of the audio devices to open 39f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 40f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#define AUDIO_POLICY_INTERFACE "policy" 41f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 42f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* ---------------------------------------------------------------------------- */ 43f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 44f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* 45f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The audio_policy and audio_policy_service_ops structs define the 46f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * communication interfaces between the platform specific audio policy manager 47f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * and Android generic audio policy manager. 48f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The platform specific audio policy manager must implement methods of the 49f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio_policy struct. 50f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * This implementation makes use of the audio_policy_service_ops to control 51f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * the activity and configuration of audio input and output streams. 52f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 53f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The platform specific audio policy manager is in charge of the audio 54f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * routing and volume control policies for a given platform. 55f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The main roles of this module are: 56f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * - keep track of current system state (removable device connections, phone 57f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * state, user requests...). 58f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * System state changes and user actions are notified to audio policy 59f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * manager with methods of the audio_policy. 60f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 61f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * - process get_output() queries received when AudioTrack objects are 62f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * created: Those queries return a handler on an output that has been 63f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * selected, configured and opened by the audio policy manager and that 64f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * must be used by the AudioTrack when registering to the AudioFlinger 65f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * with the createTrack() method. 66f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * When the AudioTrack object is released, a release_output() query 67f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * is received and the audio policy manager can decide to close or 68f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * reconfigure the output depending on other streams using this output and 69f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * current system state. 70f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 71f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * - similarly process get_input() and release_input() queries received from 72f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * AudioRecord objects and configure audio inputs. 73f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * - process volume control requests: the stream volume is converted from 74f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * an index value (received from UI) to a float value applicable to each 75f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * output as a function of platform specific settings and current output 76f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * route (destination device). It also make sure that streams are not 77f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * muted if not allowed (e.g. camera shutter sound in some countries). 78f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 79f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 80f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/* XXX: this should be defined OUTSIDE of frameworks/base */ 81f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct effect_descriptor_s; 82f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 83f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_policy { 84f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 85f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * configuration functions 86f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 87f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 88f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicate a change in device connection status */ 89f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_device_connection_state)(struct audio_policy *pol, 90f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_devices_t device, 91f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_dev_state_t state, 92f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *device_address); 93f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 94f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* retreive a device connection status */ 95f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_dev_state_t (*get_device_connection_state)( 96f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const struct audio_policy *pol, 97f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_devices_t device, 98f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *device_address); 99f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 100f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicate a change in phone state. Valid phones states are defined 101f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * by audio_mode_t */ 102f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*set_phone_state)(struct audio_policy *pol, int state); 103f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 104f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicate a change in ringer mode */ 105f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*set_ringer_mode)(struct audio_policy *pol, uint32_t mode, 106f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t mask); 107f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 108f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* force using a specific device category for the specified usage */ 109f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*set_force_use)(struct audio_policy *pol, 110f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_force_use_t usage, 111f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_forced_cfg_t config); 112f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 113f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* retreive current device category forced for a given usage */ 114f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_forced_cfg_t (*get_force_use)(const struct audio_policy *pol, 115f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_force_use_t usage); 116f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 117f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* if can_mute is true, then audio streams that are marked ENFORCED_AUDIBLE 118f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * can still be muted. */ 119f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*set_can_mute_enforced_audible)(struct audio_policy *pol, 120f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin bool can_mute); 121f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 122f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* check proper initialization */ 123f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*init_check)(const struct audio_policy *pol); 124f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 125f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 126f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Audio routing query functions 127f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 128f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 129f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* request an output appriate for playback of the supplied stream type and 130f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * parameters */ 131f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*get_output)(struct audio_policy *pol, 132f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 133f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t samplingRate, 134f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t format, 135f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t channels, 136f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_output_flags_t flags); 137f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 138f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicates to the audio policy manager that the output starts being used 139f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * by corresponding stream. */ 140f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*start_output)(struct audio_policy *pol, 141f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output, 142f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 143f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int session); 144f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 145f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicates to the audio policy manager that the output stops being used 146f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * by corresponding stream. */ 147f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*stop_output)(struct audio_policy *pol, 148f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output, 149f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 150f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int session); 151f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 152f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* releases the output. */ 153f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*release_output)(struct audio_policy *pol, audio_io_handle_t output); 154f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 155f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* request an input appriate for record from the supplied device with 156f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * supplied parameters. */ 157f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*get_input)(struct audio_policy *pol, int inputSource, 158f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t samplingRate, 159f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t format, 160f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t channels, 161f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_in_acoustics_t acoustics); 162f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 163f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicates to the audio policy manager that the input starts being used */ 164f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*start_input)(struct audio_policy *pol, audio_io_handle_t input); 165f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 166f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* indicates to the audio policy manager that the input stops being used. */ 167f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*stop_input)(struct audio_policy *pol, audio_io_handle_t input); 168f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 169f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* releases the input. */ 170f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*release_input)(struct audio_policy *pol, audio_io_handle_t input); 171f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 172f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 173f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * volume control functions 174f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 175f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 176f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* initialises stream volume conversion parameters by specifying volume 177f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * index range. */ 178f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*init_stream_volume)(struct audio_policy *pol, 179f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 180f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int index_min, 181f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int index_max); 182f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 183f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* sets the new stream volume at a level corresponding to the supplied 184f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * index */ 185f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_stream_volume_index)(struct audio_policy *pol, 186f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 187f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int index); 188f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 189f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* retreive current volume index for the specified stream */ 190f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*get_stream_volume_index)(const struct audio_policy *pol, 191f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 192f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int *index); 193f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 194f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* return the strategy corresponding to a given stream type */ 195f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_strategy_for_stream)(const struct audio_policy *pol, 196f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream); 197f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 198f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* return the enabled output devices for the given stream type */ 199f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t (*get_devices_for_stream)(const struct audio_policy *pol, 200f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream); 201f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 202f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* Audio effect management */ 203f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*get_output_for_effect)(struct audio_policy *pol, 204f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct effect_descriptor_s *desc); 205f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 206f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*register_effect)(struct audio_policy *pol, 207f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct effect_descriptor_s *desc, 208f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output, 209f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t strategy, 210f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int session, 211f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int id); 212f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 213f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*unregister_effect)(struct audio_policy *pol, int id); 214f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 215f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin bool (*is_stream_active)(const struct audio_policy *pol, 216f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int stream, 217f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t in_past_ms); 218f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 219f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* dump state */ 220f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*dump)(const struct audio_policy *pol, int fd); 221f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 222f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 223f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_policy_service_ops { 224f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* 225f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Audio output Control functions 226f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 227f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 228f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* Opens an audio output with the requested parameters. 229f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 230f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The parameter values can indicate to use the default values in case the 231f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio policy manager has no specific requirements for the output being 232f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * opened. 233f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 234f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * When the function returns, the parameter values reflect the actual 235f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * values used by the audio hardware output stream. 236f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 237f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * The audio policy manager can check if the proposed parameters are 238f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * suitable or not and act accordingly. 239f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 240f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*open_output)(void *service, 241f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pDevices, 242f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pSamplingRate, 243f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pFormat, 244f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pChannels, 245f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pLatencyMs, 246f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_output_flags_t flags); 247f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 248f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* creates a special output that is duplicated to the two outputs passed as 249f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * arguments. The duplication is performed by 250f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * a special mixer thread in the AudioFlinger. 251f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 252f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*open_duplicate_output)(void *service, 253f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output1, 254f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output2); 255f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 256f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* closes the output stream */ 257f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*close_output)(void *service, audio_io_handle_t output); 258f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 259f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* suspends the output. 260f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 261f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * When an output is suspended, the corresponding audio hardware output 262f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * stream is placed in standby and the AudioTracks attached to the mixer 263f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * thread are still processed but the output mix is discarded. 264f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 265f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*suspend_output)(void *service, audio_io_handle_t output); 266f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 267f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* restores a suspended output. */ 268f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*restore_output)(void *service, audio_io_handle_t output); 269f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 270f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* */ 271f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* Audio input Control functions */ 272f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* */ 273f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 274f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* opens an audio input */ 275f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t (*open_input)(void *service, 276f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pDevices, 277f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pSamplingRate, 278f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pFormat, 279f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t *pChannels, 280f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin uint32_t acoustics); 281f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 282f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* closes an audio input */ 283f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*close_input)(void *service, audio_io_handle_t input); 284f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 285f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* */ 286f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* misc control functions */ 287f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* */ 288f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 289f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* set a stream volume for a particular output. 290f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 291f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * For the same user setting, a given stream type can have different 292f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * volumes for each output (destination device) it is attached to. 293f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 294f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_stream_volume)(void *service, 295f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 296f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin float volume, 297f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output, 298f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int delay_ms); 299f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 300f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* reroute a given stream type to the specified output */ 301f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_stream_output)(void *service, 302f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream, 303f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t output); 304f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 305f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* function enabling to send proprietary informations directly from audio 306f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * policy manager to audio hardware interface. */ 307f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void (*set_parameters)(void *service, 308f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t io_handle, 309f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *kv_pairs, 310f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int delay_ms); 311f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 312f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* function enabling to receive proprietary informations directly from 313f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * audio hardware interface to audio policy manager. 314f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * 315f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Returns a pointer to a heap allocated string. The caller is responsible 316f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * for freeing the memory for it. 317f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 318f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 319f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin char * (*get_parameters)(void *service, audio_io_handle_t io_handle, 320f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin const char *keys); 321f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 322f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* request the playback of a tone on the specified stream. 323f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * used for instance to replace notification sounds when playing over a 324f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * telephony device during a phone call. 325f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 326f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*start_tone)(void *service, 327f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_policy_tone_t tone, 328f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_stream_type_t stream); 329f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 330f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*stop_tone)(void *service); 331f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 332f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* set down link audio volume. */ 333f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*set_voice_volume)(void *service, 334f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin float volume, 335f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int delay_ms); 336f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 337f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin /* move effect to the specified output */ 338f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*move_effects)(void *service, 339f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int session, 340f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t src_output, 341f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin audio_io_handle_t dst_output); 342f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 343f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 344f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/**********************************************************************/ 345f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 346f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** 347f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * Every hardware module must have a data structure named HAL_MODULE_INFO_SYM 348f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * and the fields of this data structure must begin with hw_module_t 349f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin * followed by module specific information. 350f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin */ 351f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavintypedef struct audio_policy_module { 352f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_module_t common; 353f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} audio_policy_module_t; 354f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 355f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstruct audio_policy_device { 356f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct hw_device_t common; 357f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 358f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*create_audio_policy)(const struct audio_policy_device *device, 359f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_policy_service_ops *aps_ops, 360f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin void *service, 361f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_policy **ap); 362f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 363f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin int (*destroy_audio_policy)(const struct audio_policy_device *device, 364f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_policy *ap); 365f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin}; 366f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 367f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin/** convenience API for opening and closing a supported device */ 368f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 369f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_policy_dev_open(const hw_module_t* module, 370f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin struct audio_policy_device** device) 371f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 372f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return module->methods->open(module, AUDIO_POLICY_INTERFACE, 373f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin (hw_device_t**)device); 374f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 375f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 376f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavinstatic inline int audio_policy_dev_close(struct audio_policy_device* device) 377f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin{ 378f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin return device->common.close(&device->common); 379f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin} 380f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 381f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 382f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin__END_DECLS 383f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin 384f1504dbca386fc454b8ded7669012f3d4d27eab7Dima Zavin#endif // ANDROID_AUDIO_POLICY_INTERFACE_H 385