IAudioFlinger.h revision c5a17425986b4ce3384e6956762c86018b49c4a0 
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                                int clientUid,
77                                status_t *status) = 0;
78
79    virtual sp<IAudioRecord> openRecord(
80                                // On successful return, AudioFlinger takes over the handle
81                                // reference and will release it when the track is destroyed.
82                                // However on failure, the client is responsible for release.
83                                audio_io_handle_t input,
84                                uint32_t sampleRate,
85                                audio_format_t format,
86                                audio_channel_mask_t channelMask,
87                                size_t *pFrameCount,
88                                track_flags_t *flags,
89                                pid_t tid,  // -1 means unused, otherwise must be valid non-0
90                                int *sessionId,
91                                status_t *status) = 0;
92
93    /* query the audio hardware state. This state never changes,
94     * and therefore can be cached.
95     */
96    virtual     uint32_t    sampleRate(audio_io_handle_t output) const = 0;
97#if 0
98    virtual     int         channelCount(audio_io_handle_t output) const = 0;
99#endif
100    virtual     audio_format_t format(audio_io_handle_t output) const = 0;
101    virtual     size_t      frameCount(audio_io_handle_t output) const = 0;
102
103    // return estimated latency in milliseconds
104    virtual     uint32_t    latency(audio_io_handle_t output) const = 0;
105
106    /* set/get the audio hardware state. This will probably be used by
107     * the preference panel, mostly.
108     */
109    virtual     status_t    setMasterVolume(float value) = 0;
110    virtual     status_t    setMasterMute(bool muted) = 0;
111
112    virtual     float       masterVolume() const = 0;
113    virtual     bool        masterMute() const = 0;
114
115    /* set/get stream type state. This will probably be used by
116     * the preference panel, mostly.
117     */
118    virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value,
119                                    audio_io_handle_t output) = 0;
120    virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted) = 0;
121
122    virtual     float       streamVolume(audio_stream_type_t stream,
123                                    audio_io_handle_t output) const = 0;
124    virtual     bool        streamMute(audio_stream_type_t stream) const = 0;
125
126    // set audio mode
127    virtual     status_t    setMode(audio_mode_t mode) = 0;
128
129    // mic mute/state
130    virtual     status_t    setMicMute(bool state) = 0;
131    virtual     bool        getMicMute() const = 0;
132
133    virtual     status_t    setParameters(audio_io_handle_t ioHandle,
134                                    const String8& keyValuePairs) = 0;
135    virtual     String8     getParameters(audio_io_handle_t ioHandle, const String8& keys)
136                                    const = 0;
137
138    // Register an object to receive audio input/output change and track notifications.
139    // For a given calling pid, AudioFlinger disregards any registrations after the first.
140    // Thus the IAudioFlingerClient must be a singleton per process.
141    virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0;
142
143    // retrieve the audio recording buffer size
144    virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format,
145            audio_channel_mask_t channelMask) const = 0;
146
147    virtual audio_io_handle_t openOutput(audio_module_handle_t module,
148                                         audio_devices_t *pDevices,
149                                         uint32_t *pSamplingRate,
150                                         audio_format_t *pFormat,
151                                         audio_channel_mask_t *pChannelMask,
152                                         uint32_t *pLatencyMs,
153                                         audio_output_flags_t flags,
154                                         const audio_offload_info_t *offloadInfo = NULL) = 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 audio_io_handle_t openInput(audio_module_handle_t module,
162                                        audio_devices_t *pDevices,
163                                        uint32_t *pSamplingRate,
164                                        audio_format_t *pFormat,
165                                        audio_channel_mask_t *pChannelMask) = 0;
166    virtual status_t closeInput(audio_io_handle_t input) = 0;
167
168    virtual status_t invalidateStream(audio_stream_type_t stream) = 0;
169
170    virtual status_t setVoiceVolume(float volume) = 0;
171
172    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames,
173                                    audio_io_handle_t output) const = 0;
174
175    virtual uint32_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0;
176
177    virtual int newAudioSessionId() = 0;
178
179    virtual void acquireAudioSessionId(int audioSession, pid_t pid) = 0;
180    virtual void releaseAudioSessionId(int audioSession, pid_t pid) = 0;
181
182    virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0;
183
184    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0;
185
186    virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID,
187                                        effect_descriptor_t *pDescriptor) const = 0;
188
189    virtual sp<IEffect> createEffect(
190                                    effect_descriptor_t *pDesc,
191                                    const sp<IEffectClient>& client,
192                                    int32_t priority,
193                                    // AudioFlinger doesn't take over handle reference from client
194                                    audio_io_handle_t output,
195                                    int sessionId,
196                                    status_t *status,
197                                    int *id,
198                                    int *enabled) = 0;
199
200    virtual status_t moveEffects(int session, audio_io_handle_t srcOutput,
201                                    audio_io_handle_t dstOutput) = 0;
202
203    virtual audio_module_handle_t loadHwModule(const char *name) = 0;
204
205    // helpers for android.media.AudioManager.getProperty(), see description there for meaning
206    // FIXME move these APIs to AudioPolicy to permit a more accurate implementation
207    // that looks on primary device for a stream with fast flag, primary flag, or first one.
208    virtual uint32_t getPrimaryOutputSamplingRate() = 0;
209    virtual size_t getPrimaryOutputFrameCount() = 0;
210
211    // Intended for AudioService to inform AudioFlinger of device's low RAM attribute,
212    // and should be called at most once.  For a definition of what "low RAM" means, see
213    // android.app.ActivityManager.isLowRamDevice().
214    virtual status_t setLowRamDevice(bool isLowRamDevice) = 0;
215};
216
217
218// ----------------------------------------------------------------------------
219
220class BnAudioFlinger : public BnInterface<IAudioFlinger>
221{
222public:
223    virtual status_t    onTransact( uint32_t code,
224                                    const Parcel& data,
225                                    Parcel* reply,
226                                    uint32_t flags = 0);
227};
228
229// ----------------------------------------------------------------------------
230
231}; // namespace android
232
233#endif // ANDROID_IAUDIOFLINGER_H
234