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 38 namespace android { 39 40 // ---------------------------------------------------------------------------- 41 42 class IAudioFlinger : public IInterface 43 { 44 public: 45 DECLARE_META_INTERFACE(AudioFlinger); 46 47 48 // invariant on exit for all APIs that return an sp<>: 49 // (return value != 0) == (*status == NO_ERROR) 50 51 /* create an audio track and registers it with AudioFlinger. 52 * return null if the track cannot be created. 53 */ 54 virtual sp<IAudioTrack> createTrack( 55 audio_stream_type_t streamType, 56 uint32_t sampleRate, 57 audio_format_t format, 58 audio_channel_mask_t channelMask, 59 size_t *pFrameCount, 60 audio_output_flags_t *flags, 61 const sp<IMemory>& sharedBuffer, 62 // On successful return, AudioFlinger takes over the handle 63 // reference and will release it when the track is destroyed. 64 // However on failure, the client is responsible for release. 65 audio_io_handle_t output, 66 pid_t pid, 67 pid_t tid, // -1 means unused, otherwise must be valid non-0 68 audio_session_t *sessionId, 69 int clientUid, 70 status_t *status) = 0; 71 72 virtual sp<IAudioRecord> openRecord( 73 // On successful return, AudioFlinger takes over the handle 74 // reference and will release it when the track is destroyed. 75 // However on failure, the client is responsible for release. 76 audio_io_handle_t input, 77 uint32_t sampleRate, 78 audio_format_t format, 79 audio_channel_mask_t channelMask, 80 const String16& callingPackage, 81 size_t *pFrameCount, 82 audio_input_flags_t *flags, 83 pid_t pid, 84 pid_t tid, // -1 means unused, otherwise must be valid non-0 85 int clientUid, 86 audio_session_t *sessionId, 87 size_t *notificationFrames, 88 sp<IMemory>& cblk, 89 sp<IMemory>& buffers, // return value 0 means it follows cblk 90 status_t *status) = 0; 91 92 // FIXME Surprisingly, format/latency don't work for input handles 93 94 /* query the audio hardware state. This state never changes, 95 * and therefore can be cached. 96 */ 97 virtual uint32_t sampleRate(audio_io_handle_t ioHandle) const = 0; 98 99 // reserved; formerly channelCount() 100 101 virtual audio_format_t format(audio_io_handle_t output) const = 0; 102 virtual size_t frameCount(audio_io_handle_t ioHandle) 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 // FIXME This API assumes a route, and so should be deprecated. 146 virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, 147 audio_channel_mask_t channelMask) const = 0; 148 149 virtual status_t openOutput(audio_module_handle_t module, 150 audio_io_handle_t *output, 151 audio_config_t *config, 152 audio_devices_t *devices, 153 const String8& address, 154 uint32_t *latencyMs, 155 audio_output_flags_t flags) = 0; 156 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, 157 audio_io_handle_t output2) = 0; 158 virtual status_t closeOutput(audio_io_handle_t output) = 0; 159 virtual status_t suspendOutput(audio_io_handle_t output) = 0; 160 virtual status_t restoreOutput(audio_io_handle_t output) = 0; 161 162 virtual status_t openInput(audio_module_handle_t module, 163 audio_io_handle_t *input, 164 audio_config_t *config, 165 audio_devices_t *device, 166 const String8& address, 167 audio_source_t source, 168 audio_input_flags_t flags) = 0; 169 virtual status_t closeInput(audio_io_handle_t input) = 0; 170 171 virtual status_t invalidateStream(audio_stream_type_t stream) = 0; 172 173 virtual status_t setVoiceVolume(float volume) = 0; 174 175 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, 176 audio_io_handle_t output) const = 0; 177 178 virtual uint32_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0; 179 180 virtual audio_unique_id_t newAudioUniqueId(audio_unique_id_use_t use) = 0; 181 182 virtual void acquireAudioSessionId(audio_session_t audioSession, pid_t pid) = 0; 183 virtual void releaseAudioSessionId(audio_session_t audioSession, pid_t pid) = 0; 184 185 virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0; 186 187 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0; 188 189 virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID, 190 effect_descriptor_t *pDescriptor) const = 0; 191 192 virtual sp<IEffect> createEffect( 193 effect_descriptor_t *pDesc, 194 const sp<IEffectClient>& client, 195 int32_t priority, 196 // AudioFlinger doesn't take over handle reference from client 197 audio_io_handle_t output, 198 audio_session_t sessionId, 199 const String16& callingPackage, 200 status_t *status, 201 int *id, 202 int *enabled) = 0; 203 204 virtual status_t moveEffects(audio_session_t session, audio_io_handle_t srcOutput, 205 audio_io_handle_t dstOutput) = 0; 206 207 virtual audio_module_handle_t loadHwModule(const char *name) = 0; 208 209 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 210 // FIXME move these APIs to AudioPolicy to permit a more accurate implementation 211 // that looks on primary device for a stream with fast flag, primary flag, or first one. 212 virtual uint32_t getPrimaryOutputSamplingRate() = 0; 213 virtual size_t getPrimaryOutputFrameCount() = 0; 214 215 // Intended for AudioService to inform AudioFlinger of device's low RAM attribute, 216 // and should be called at most once. For a definition of what "low RAM" means, see 217 // android.app.ActivityManager.isLowRamDevice(). 218 virtual status_t setLowRamDevice(bool isLowRamDevice) = 0; 219 220 /* List available audio ports and their attributes */ 221 virtual status_t listAudioPorts(unsigned int *num_ports, 222 struct audio_port *ports) = 0; 223 224 /* Get attributes for a given audio port */ 225 virtual status_t getAudioPort(struct audio_port *port) = 0; 226 227 /* Create an audio patch between several source and sink ports */ 228 virtual status_t createAudioPatch(const struct audio_patch *patch, 229 audio_patch_handle_t *handle) = 0; 230 231 /* Release an audio patch */ 232 virtual status_t releaseAudioPatch(audio_patch_handle_t handle) = 0; 233 234 /* List existing audio patches */ 235 virtual status_t listAudioPatches(unsigned int *num_patches, 236 struct audio_patch *patches) = 0; 237 /* Set audio port configuration */ 238 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0; 239 240 /* Get the HW synchronization source used for an audio session */ 241 virtual audio_hw_sync_t getAudioHwSyncForSession(audio_session_t sessionId) = 0; 242 243 /* Indicate JAVA services are ready (scheduling, power management ...) */ 244 virtual status_t systemReady() = 0; 245 246 // Returns the number of frames per audio HAL buffer. 247 virtual size_t frameCountHAL(audio_io_handle_t ioHandle) const = 0; 248 }; 249 250 251 // ---------------------------------------------------------------------------- 252 253 class BnAudioFlinger : public BnInterface<IAudioFlinger> 254 { 255 public: 256 virtual status_t onTransact( uint32_t code, 257 const Parcel& data, 258 Parcel* reply, 259 uint32_t flags = 0); 260 }; 261 262 // ---------------------------------------------------------------------------- 263 264 }; // namespace android 265 266 #endif // ANDROID_IAUDIOFLINGER_H 267
