IAudioFlinger.h revision d457c970c8d08519cd77280a90b61ae1e342cfe3 
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    };
54    typedef uint32_t track_flags_t;
55
56    // invariant on exit for all APIs that return an sp<>:
57    //   (return value != 0) == (*status == NO_ERROR)
58
59    /* create an audio track and registers it with AudioFlinger.
60     * return null if the track cannot be created.
61     */
62    virtual sp<IAudioTrack> createTrack(
63                                audio_stream_type_t streamType,
64                                uint32_t sampleRate,
65                                audio_format_t format,
66                                audio_channel_mask_t channelMask,
67                                size_t *pFrameCount,
68                                track_flags_t *flags,
69                                const sp<IMemory>& sharedBuffer,
70                                // On successful return, AudioFlinger takes over the handle
71                                // reference and will release it when the track is destroyed.
72                                // However on failure, the client is responsible for release.
73                                audio_io_handle_t output,
74                                pid_t tid,  // -1 means unused, otherwise must be valid non-0
75                                int *sessionId,
76                                // input: ignored
77                                // output: server's description of IAudioTrack for display in logs.
78                                // Don't attempt to parse, as the format could change.
79                                String8& name,
80                                int clientUid,
81                                status_t *status) = 0;
82
83    virtual sp<IAudioRecord> openRecord(
84                                // On successful return, AudioFlinger takes over the handle
85                                // reference and will release it when the track is destroyed.
86                                // However on failure, the client is responsible for release.
87                                audio_io_handle_t input,
88                                uint32_t sampleRate,
89                                audio_format_t format,
90                                audio_channel_mask_t channelMask,
91                                size_t *pFrameCount,
92                                track_flags_t *flags,
93                                pid_t tid,  // -1 means unused, otherwise must be valid non-0
94                                int *sessionId,
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#if 0
102    virtual     int         channelCount(audio_io_handle_t output) const = 0;
103#endif
104    virtual     audio_format_t format(audio_io_handle_t output) const = 0;
105    virtual     size_t      frameCount(audio_io_handle_t output) const = 0;
106
107    // return estimated latency in milliseconds
108    virtual     uint32_t    latency(audio_io_handle_t output) const = 0;
109
110    /* set/get the audio hardware state. This will probably be used by
111     * the preference panel, mostly.
112     */
113    virtual     status_t    setMasterVolume(float value) = 0;
114    virtual     status_t    setMasterMute(bool muted) = 0;
115
116    virtual     float       masterVolume() const = 0;
117    virtual     bool        masterMute() const = 0;
118
119    /* set/get stream type state. This will probably be used by
120     * the preference panel, mostly.
121     */
122    virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value,
123                                    audio_io_handle_t output) = 0;
124    virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted) = 0;
125
126    virtual     float       streamVolume(audio_stream_type_t stream,
127                                    audio_io_handle_t output) const = 0;
128    virtual     bool        streamMute(audio_stream_type_t stream) const = 0;
129
130    // set audio mode
131    virtual     status_t    setMode(audio_mode_t mode) = 0;
132
133    // mic mute/state
134    virtual     status_t    setMicMute(bool state) = 0;
135    virtual     bool        getMicMute() const = 0;
136
137    virtual     status_t    setParameters(audio_io_handle_t ioHandle,
138                                    const String8& keyValuePairs) = 0;
139    virtual     String8     getParameters(audio_io_handle_t ioHandle, const String8& keys)
140                                    const = 0;
141
142    // Register an object to receive audio input/output change and track notifications.
143    // For a given calling pid, AudioFlinger disregards any registrations after the first.
144    // Thus the IAudioFlingerClient must be a singleton per process.
145    virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0;
146
147    // retrieve the audio recording buffer size
148    virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format,
149            audio_channel_mask_t channelMask) const = 0;
150
151    virtual audio_io_handle_t openOutput(audio_module_handle_t module,
152                                         audio_devices_t *pDevices,
153                                         uint32_t *pSamplingRate,
154                                         audio_format_t *pFormat,
155                                         audio_channel_mask_t *pChannelMask,
156                                         uint32_t *pLatencyMs,
157                                         audio_output_flags_t flags,
158                                         const audio_offload_info_t *offloadInfo = NULL) = 0;
159    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
160                                    audio_io_handle_t output2) = 0;
161    virtual status_t closeOutput(audio_io_handle_t output) = 0;
162    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
163    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
164
165    virtual audio_io_handle_t openInput(audio_module_handle_t module,
166                                        audio_devices_t *pDevices,
167                                        uint32_t *pSamplingRate,
168                                        audio_format_t *pFormat,
169                                        audio_channel_mask_t *pChannelMask) = 0;
170    virtual status_t closeInput(audio_io_handle_t input) = 0;
171
172    virtual status_t setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output) = 0;
173
174    virtual status_t setVoiceVolume(float volume) = 0;
175
176    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames,
177                                    audio_io_handle_t output) const = 0;
178
179    virtual uint32_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0;
180
181    virtual int newAudioSessionId() = 0;
182
183    virtual void acquireAudioSessionId(int audioSession, pid_t pid) = 0;
184    virtual void releaseAudioSessionId(int audioSession, pid_t pid) = 0;
185
186    virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0;
187
188    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0;
189
190    virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID,
191                                        effect_descriptor_t *pDescriptor) const = 0;
192
193    virtual sp<IEffect> createEffect(
194                                    effect_descriptor_t *pDesc,
195                                    const sp<IEffectClient>& client,
196                                    int32_t priority,
197                                    // AudioFlinger doesn't take over handle reference from client
198                                    audio_io_handle_t output,
199                                    int sessionId,
200                                    status_t *status,
201                                    int *id,
202                                    int *enabled) = 0;
203
204    virtual status_t moveEffects(int 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
221
222// ----------------------------------------------------------------------------
223
224class BnAudioFlinger : public BnInterface<IAudioFlinger>
225{
226public:
227    virtual status_t    onTransact( uint32_t code,
228                                    const Parcel& data,
229                                    Parcel* reply,
230                                    uint32_t flags = 0);
231};
232
233// ----------------------------------------------------------------------------
234
235}; // namespace android
236
237#endif // ANDROID_IAUDIOFLINGER_H
238