IAudioFlinger.h revision cf2c0210c8afbe7d0661ccbbae3835b5ce73c0bf
1/* 2 * Copyright (C) 2007 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#ifndef ANDROID_IAUDIOFLINGER_H 18#define ANDROID_IAUDIOFLINGER_H 19 20#include <stdint.h> 21#include <sys/types.h> 22#include <unistd.h> 23 24#include <utils/RefBase.h> 25#include <utils/Errors.h> 26#include <binder/IInterface.h> 27#include <media/IAudioTrack.h> 28#include <media/IAudioRecord.h> 29#include <media/IAudioFlingerClient.h> 30#include <system/audio.h> 31#include <system/audio_policy.h> 32#include <hardware/audio_policy.h> 33#include <hardware/audio_effect.h> 34#include <media/IEffect.h> 35#include <media/IEffectClient.h> 36#include <utils/String8.h> 37 38namespace android { 39 40// ---------------------------------------------------------------------------- 41 42class IAudioFlinger : public IInterface 43{ 44public: 45 DECLARE_META_INTERFACE(AudioFlinger); 46 47 // or-able bits shared by createTrack and openRecord, but not all combinations make sense 48 enum { 49 TRACK_DEFAULT = 0, // client requests a default AudioTrack 50 TRACK_TIMED = 1, // client requests a TimedAudioTrack 51 TRACK_FAST = 2, // client requests a fast AudioTrack or AudioRecord 52 TRACK_OFFLOAD = 4, // client requests offload to hw codec 53 TRACK_DIRECT = 8, // client requests a direct output 54 }; 55 typedef uint32_t track_flags_t; 56 57 // invariant on exit for all APIs that return an sp<>: 58 // (return value != 0) == (*status == NO_ERROR) 59 60 /* create an audio track and registers it with AudioFlinger. 61 * return null if the track cannot be created. 62 */ 63 virtual sp<IAudioTrack> createTrack( 64 audio_stream_type_t streamType, 65 uint32_t sampleRate, 66 audio_format_t format, 67 audio_channel_mask_t channelMask, 68 size_t *pFrameCount, 69 track_flags_t *flags, 70 const sp<IMemory>& sharedBuffer, 71 // On successful return, AudioFlinger takes over the handle 72 // reference and will release it when the track is destroyed. 73 // However on failure, the client is responsible for release. 74 audio_io_handle_t output, 75 pid_t tid, // -1 means unused, otherwise must be valid non-0 76 int *sessionId, 77 int clientUid, 78 status_t *status) = 0; 79 80 virtual sp<IAudioRecord> openRecord( 81 // On successful return, AudioFlinger takes over the handle 82 // reference and will release it when the track is destroyed. 83 // However on failure, the client is responsible for release. 84 audio_io_handle_t input, 85 uint32_t sampleRate, 86 audio_format_t format, 87 audio_channel_mask_t channelMask, 88 size_t *pFrameCount, 89 track_flags_t *flags, 90 pid_t tid, // -1 means unused, otherwise must be valid non-0 91 int *sessionId, 92 size_t *notificationFrames, 93 sp<IMemory>& cblk, 94 sp<IMemory>& buffers, // return value 0 means it follows cblk 95 status_t *status) = 0; 96 97 /* query the audio hardware state. This state never changes, 98 * and therefore can be cached. 99 */ 100 virtual uint32_t sampleRate(audio_io_handle_t output) const = 0; 101 virtual audio_format_t format(audio_io_handle_t output) const = 0; 102 virtual size_t frameCount(audio_io_handle_t output) const = 0; 103 104 // return estimated latency in milliseconds 105 virtual uint32_t latency(audio_io_handle_t output) const = 0; 106 107 /* set/get the audio hardware state. This will probably be used by 108 * the preference panel, mostly. 109 */ 110 virtual status_t setMasterVolume(float value) = 0; 111 virtual status_t setMasterMute(bool muted) = 0; 112 113 virtual float masterVolume() const = 0; 114 virtual bool masterMute() const = 0; 115 116 /* set/get stream type state. This will probably be used by 117 * the preference panel, mostly. 118 */ 119 virtual status_t setStreamVolume(audio_stream_type_t stream, float value, 120 audio_io_handle_t output) = 0; 121 virtual status_t setStreamMute(audio_stream_type_t stream, bool muted) = 0; 122 123 virtual float streamVolume(audio_stream_type_t stream, 124 audio_io_handle_t output) const = 0; 125 virtual bool streamMute(audio_stream_type_t stream) const = 0; 126 127 // set audio mode 128 virtual status_t setMode(audio_mode_t mode) = 0; 129 130 // mic mute/state 131 virtual status_t setMicMute(bool state) = 0; 132 virtual bool getMicMute() const = 0; 133 134 virtual status_t setParameters(audio_io_handle_t ioHandle, 135 const String8& keyValuePairs) = 0; 136 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) 137 const = 0; 138 139 // Register an object to receive audio input/output change and track notifications. 140 // For a given calling pid, AudioFlinger disregards any registrations after the first. 141 // Thus the IAudioFlingerClient must be a singleton per process. 142 virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0; 143 144 // retrieve the audio recording buffer size 145 virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, 146 audio_channel_mask_t channelMask) const = 0; 147 148 virtual status_t openOutput(audio_module_handle_t module, 149 audio_io_handle_t *output, 150 audio_config_t *config, 151 audio_devices_t *devices, 152 const String8& address, 153 uint32_t *latencyMs, 154 audio_output_flags_t flags) = 0; 155 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, 156 audio_io_handle_t output2) = 0; 157 virtual status_t closeOutput(audio_io_handle_t output) = 0; 158 virtual status_t suspendOutput(audio_io_handle_t output) = 0; 159 virtual status_t restoreOutput(audio_io_handle_t output) = 0; 160 161 virtual status_t openInput(audio_module_handle_t module, 162 audio_io_handle_t *input, 163 audio_config_t *config, 164 audio_devices_t *device, 165 const String8& address, 166 audio_source_t source, 167 audio_input_flags_t flags) = 0; 168 virtual status_t closeInput(audio_io_handle_t input) = 0; 169 170 virtual status_t invalidateStream(audio_stream_type_t stream) = 0; 171 172 virtual status_t setVoiceVolume(float volume) = 0; 173 174 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, 175 audio_io_handle_t output) const = 0; 176 177 virtual uint32_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0; 178 179 virtual int newAudioSessionId() = 0; 180 181 virtual void acquireAudioSessionId(int audioSession, pid_t pid) = 0; 182 virtual void releaseAudioSessionId(int audioSession, pid_t pid) = 0; 183 184 virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0; 185 186 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0; 187 188 virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID, 189 effect_descriptor_t *pDescriptor) const = 0; 190 191 virtual sp<IEffect> createEffect( 192 effect_descriptor_t *pDesc, 193 const sp<IEffectClient>& client, 194 int32_t priority, 195 // AudioFlinger doesn't take over handle reference from client 196 audio_io_handle_t output, 197 int sessionId, 198 status_t *status, 199 int *id, 200 int *enabled) = 0; 201 202 virtual status_t moveEffects(int session, audio_io_handle_t srcOutput, 203 audio_io_handle_t dstOutput) = 0; 204 205 virtual audio_module_handle_t loadHwModule(const char *name) = 0; 206 207 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 208 // FIXME move these APIs to AudioPolicy to permit a more accurate implementation 209 // that looks on primary device for a stream with fast flag, primary flag, or first one. 210 virtual uint32_t getPrimaryOutputSamplingRate() = 0; 211 virtual size_t getPrimaryOutputFrameCount() = 0; 212 213 // Intended for AudioService to inform AudioFlinger of device's low RAM attribute, 214 // and should be called at most once. For a definition of what "low RAM" means, see 215 // android.app.ActivityManager.isLowRamDevice(). 216 virtual status_t setLowRamDevice(bool isLowRamDevice) = 0; 217 218 /* List available audio ports and their attributes */ 219 virtual status_t listAudioPorts(unsigned int *num_ports, 220 struct audio_port *ports) = 0; 221 222 /* Get attributes for a given audio port */ 223 virtual status_t getAudioPort(struct audio_port *port) = 0; 224 225 /* Create an audio patch between several source and sink ports */ 226 virtual status_t createAudioPatch(const struct audio_patch *patch, 227 audio_patch_handle_t *handle) = 0; 228 229 /* Release an audio patch */ 230 virtual status_t releaseAudioPatch(audio_patch_handle_t handle) = 0; 231 232 /* List existing audio patches */ 233 virtual status_t listAudioPatches(unsigned int *num_patches, 234 struct audio_patch *patches) = 0; 235 /* Set audio port configuration */ 236 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0; 237 238}; 239 240 241// ---------------------------------------------------------------------------- 242 243class BnAudioFlinger : public BnInterface<IAudioFlinger> 244{ 245public: 246 virtual status_t onTransact( uint32_t code, 247 const Parcel& data, 248 Parcel* reply, 249 uint32_t flags = 0); 250}; 251 252// ---------------------------------------------------------------------------- 253 254}; // namespace android 255 256#endif // ANDROID_IAUDIOFLINGER_H 257