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 // 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 const String16& callingPackage, 89 size_t *pFrameCount, 90 track_flags_t *flags, 91 pid_t tid, // -1 means unused, otherwise must be valid non-0 92 int clientUid, 93 int *sessionId, 94 size_t *notificationFrames, 95 sp<IMemory>& cblk, 96 sp<IMemory>& buffers, // return value 0 means it follows cblk 97 status_t *status) = 0; 98 99 // FIXME Surprisingly, sampleRate/format/frameCount/latency don't work for input handles 100 101 /* query the audio hardware state. This state never changes, 102 * and therefore can be cached. 103 */ 104 virtual uint32_t sampleRate(audio_io_handle_t output) const = 0; 105 virtual audio_format_t format(audio_io_handle_t output) const = 0; 106 virtual size_t frameCount(audio_io_handle_t output) const = 0; 107 108 // return estimated latency in milliseconds 109 virtual uint32_t latency(audio_io_handle_t output) const = 0; 110 111 /* set/get the audio hardware state. This will probably be used by 112 * the preference panel, mostly. 113 */ 114 virtual status_t setMasterVolume(float value) = 0; 115 virtual status_t setMasterMute(bool muted) = 0; 116 117 virtual float masterVolume() const = 0; 118 virtual bool masterMute() const = 0; 119 120 /* set/get stream type state. This will probably be used by 121 * the preference panel, mostly. 122 */ 123 virtual status_t setStreamVolume(audio_stream_type_t stream, float value, 124 audio_io_handle_t output) = 0; 125 virtual status_t setStreamMute(audio_stream_type_t stream, bool muted) = 0; 126 127 virtual float streamVolume(audio_stream_type_t stream, 128 audio_io_handle_t output) const = 0; 129 virtual bool streamMute(audio_stream_type_t stream) const = 0; 130 131 // set audio mode 132 virtual status_t setMode(audio_mode_t mode) = 0; 133 134 // mic mute/state 135 virtual status_t setMicMute(bool state) = 0; 136 virtual bool getMicMute() const = 0; 137 138 virtual status_t setParameters(audio_io_handle_t ioHandle, 139 const String8& keyValuePairs) = 0; 140 virtual String8 getParameters(audio_io_handle_t ioHandle, const String8& keys) 141 const = 0; 142 143 // Register an object to receive audio input/output change and track notifications. 144 // For a given calling pid, AudioFlinger disregards any registrations after the first. 145 // Thus the IAudioFlingerClient must be a singleton per process. 146 virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0; 147 148 // retrieve the audio recording buffer size 149 // FIXME This API assumes a route, and so should be deprecated. 150 virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, 151 audio_channel_mask_t channelMask) const = 0; 152 153 virtual status_t openOutput(audio_module_handle_t module, 154 audio_io_handle_t *output, 155 audio_config_t *config, 156 audio_devices_t *devices, 157 const String8& address, 158 uint32_t *latencyMs, 159 audio_output_flags_t flags) = 0; 160 virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1, 161 audio_io_handle_t output2) = 0; 162 virtual status_t closeOutput(audio_io_handle_t output) = 0; 163 virtual status_t suspendOutput(audio_io_handle_t output) = 0; 164 virtual status_t restoreOutput(audio_io_handle_t output) = 0; 165 166 virtual status_t openInput(audio_module_handle_t module, 167 audio_io_handle_t *input, 168 audio_config_t *config, 169 audio_devices_t *device, 170 const String8& address, 171 audio_source_t source, 172 audio_input_flags_t flags) = 0; 173 virtual status_t closeInput(audio_io_handle_t input) = 0; 174 175 virtual status_t invalidateStream(audio_stream_type_t stream) = 0; 176 177 virtual status_t setVoiceVolume(float volume) = 0; 178 179 virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames, 180 audio_io_handle_t output) const = 0; 181 182 virtual uint32_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0; 183 184 virtual audio_unique_id_t newAudioUniqueId() = 0; 185 186 virtual void acquireAudioSessionId(int audioSession, pid_t pid) = 0; 187 virtual void releaseAudioSessionId(int audioSession, pid_t pid) = 0; 188 189 virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0; 190 191 virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0; 192 193 virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID, 194 effect_descriptor_t *pDescriptor) const = 0; 195 196 virtual sp<IEffect> createEffect( 197 effect_descriptor_t *pDesc, 198 const sp<IEffectClient>& client, 199 int32_t priority, 200 // AudioFlinger doesn't take over handle reference from client 201 audio_io_handle_t output, 202 int sessionId, 203 const String16& callingPackage, 204 status_t *status, 205 int *id, 206 int *enabled) = 0; 207 208 virtual status_t moveEffects(int session, audio_io_handle_t srcOutput, 209 audio_io_handle_t dstOutput) = 0; 210 211 virtual audio_module_handle_t loadHwModule(const char *name) = 0; 212 213 // helpers for android.media.AudioManager.getProperty(), see description there for meaning 214 // FIXME move these APIs to AudioPolicy to permit a more accurate implementation 215 // that looks on primary device for a stream with fast flag, primary flag, or first one. 216 virtual uint32_t getPrimaryOutputSamplingRate() = 0; 217 virtual size_t getPrimaryOutputFrameCount() = 0; 218 219 // Intended for AudioService to inform AudioFlinger of device's low RAM attribute, 220 // and should be called at most once. For a definition of what "low RAM" means, see 221 // android.app.ActivityManager.isLowRamDevice(). 222 virtual status_t setLowRamDevice(bool isLowRamDevice) = 0; 223 224 /* List available audio ports and their attributes */ 225 virtual status_t listAudioPorts(unsigned int *num_ports, 226 struct audio_port *ports) = 0; 227 228 /* Get attributes for a given audio port */ 229 virtual status_t getAudioPort(struct audio_port *port) = 0; 230 231 /* Create an audio patch between several source and sink ports */ 232 virtual status_t createAudioPatch(const struct audio_patch *patch, 233 audio_patch_handle_t *handle) = 0; 234 235 /* Release an audio patch */ 236 virtual status_t releaseAudioPatch(audio_patch_handle_t handle) = 0; 237 238 /* List existing audio patches */ 239 virtual status_t listAudioPatches(unsigned int *num_patches, 240 struct audio_patch *patches) = 0; 241 /* Set audio port configuration */ 242 virtual status_t setAudioPortConfig(const struct audio_port_config *config) = 0; 243 244 /* Get the HW synchronization source used for an audio session */ 245 virtual audio_hw_sync_t getAudioHwSyncForSession(audio_session_t sessionId) = 0; 246 247 /* Indicate JAVA services are ready (scheduling, power management ...) */ 248 virtual status_t systemReady() = 0; 249 }; 250 251 252 // ---------------------------------------------------------------------------- 253 254 class BnAudioFlinger : public BnInterface<IAudioFlinger> 255 { 256 public: 257 virtual status_t onTransact( uint32_t code, 258 const Parcel& data, 259 Parcel* reply, 260 uint32_t flags = 0); 261 }; 262 263 // ---------------------------------------------------------------------------- 264 265 }; // namespace android 266 267 #endif // ANDROID_IAUDIOFLINGER_H 268