IAudioFlinger.h revision 688aac7675f18bdd7bff13334759e20bc4e6c390 
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 <hardware/audio_effect.h>
32#include <media/IEffect.h>
33#include <media/IEffectClient.h>
34#include <utils/String8.h>
35
36namespace android {
37
38// ----------------------------------------------------------------------------
39
40class IAudioFlinger : public IInterface
41{
42public:
43    DECLARE_META_INTERFACE(AudioFlinger);
44
45    /* create an audio track and registers it with AudioFlinger.
46     * return null if the track cannot be created.
47     */
48    virtual sp<IAudioTrack> createTrack(
49                                pid_t pid,
50                                audio_stream_type_t streamType,
51                                uint32_t sampleRate,
52                                audio_format_t format,
53                                uint32_t channelMask,
54                                int frameCount,
55                                uint32_t flags,
56                                const sp<IMemory>& sharedBuffer,
57                                audio_io_handle_t output,
58                                bool isTimed,
59                                int *sessionId,
60                                status_t *status) = 0;
61
62    virtual sp<IAudioRecord> openRecord(
63                                pid_t pid,
64                                audio_io_handle_t input,
65                                uint32_t sampleRate,
66                                audio_format_t format,
67                                uint32_t channelMask,
68                                int frameCount,
69                                uint32_t flags,
70                                int *sessionId,
71                                status_t *status) = 0;
72
73    /* query the audio hardware state. This state never changes,
74     * and therefore can be cached.
75     */
76    virtual     uint32_t    sampleRate(audio_io_handle_t output) const = 0;
77    virtual     int         channelCount(audio_io_handle_t output) const = 0;
78    virtual     audio_format_t format(audio_io_handle_t output) const = 0;
79    virtual     size_t      frameCount(audio_io_handle_t output) const = 0;
80
81    // return estimated latency in milliseconds
82    virtual     uint32_t    latency(audio_io_handle_t output) const = 0;
83
84    /* set/get the audio hardware state. This will probably be used by
85     * the preference panel, mostly.
86     */
87    virtual     status_t    setMasterVolume(float value) = 0;
88    virtual     status_t    setMasterMute(bool muted) = 0;
89
90    virtual     float       masterVolume() const = 0;
91    virtual     bool        masterMute() const = 0;
92
93    /* set/get stream type state. This will probably be used by
94     * the preference panel, mostly.
95     */
96    virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value,
97                                    audio_io_handle_t output) = 0;
98    virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted) = 0;
99
100    virtual     float       streamVolume(audio_stream_type_t stream,
101                                    audio_io_handle_t output) const = 0;
102    virtual     bool        streamMute(audio_stream_type_t stream) const = 0;
103
104    // set audio mode
105    virtual     status_t    setMode(audio_mode_t mode) = 0;
106
107    // mic mute/state
108    virtual     status_t    setMicMute(bool state) = 0;
109    virtual     bool        getMicMute() const = 0;
110
111    virtual     status_t    setParameters(audio_io_handle_t ioHandle,
112                                    const String8& keyValuePairs) = 0;
113    virtual     String8     getParameters(audio_io_handle_t ioHandle, const String8& keys) const = 0;
114
115    // register a current process for audio output change notifications
116    virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0;
117
118    // retrieve the audio recording buffer size
119    virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount) const = 0;
120
121    virtual audio_io_handle_t openOutput(uint32_t *pDevices,
122                                    uint32_t *pSamplingRate,
123                                    audio_format_t *pFormat,
124                                    uint32_t *pChannels,
125                                    uint32_t *pLatencyMs,
126                                    uint32_t flags) = 0;
127    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
128                                    audio_io_handle_t output2) = 0;
129    virtual status_t closeOutput(audio_io_handle_t output) = 0;
130    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
131    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
132
133    virtual audio_io_handle_t openInput(uint32_t *pDevices,
134                                    uint32_t *pSamplingRate,
135                                    audio_format_t *pFormat,
136                                    uint32_t *pChannels,
137                                    audio_in_acoustics_t acoustics) = 0;
138    virtual status_t closeInput(audio_io_handle_t input) = 0;
139
140    virtual status_t setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output) = 0;
141
142    virtual status_t setVoiceVolume(float volume) = 0;
143
144    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames,
145                                    audio_io_handle_t output) const = 0;
146
147    virtual unsigned int getInputFramesLost(audio_io_handle_t ioHandle) const = 0;
148
149    virtual int newAudioSessionId() = 0;
150
151    virtual void acquireAudioSessionId(int audioSession) = 0;
152    virtual void releaseAudioSessionId(int audioSession) = 0;
153
154    virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0;
155
156    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0;
157
158    virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID,
159                                        effect_descriptor_t *pDescriptor) const = 0;
160
161    virtual sp<IEffect> createEffect(pid_t pid,
162                                    effect_descriptor_t *pDesc,
163                                    const sp<IEffectClient>& client,
164                                    int32_t priority,
165                                    audio_io_handle_t output,
166                                    int sessionId,
167                                    status_t *status,
168                                    int *id,
169                                    int *enabled) = 0;
170
171    virtual status_t moveEffects(int session, audio_io_handle_t srcOutput,
172                                    audio_io_handle_t dstOutput) = 0;
173};
174
175
176// ----------------------------------------------------------------------------
177
178class BnAudioFlinger : public BnInterface<IAudioFlinger>
179{
180public:
181    virtual status_t    onTransact( uint32_t code,
182                                    const Parcel& data,
183                                    Parcel* reply,
184                                    uint32_t flags = 0);
185};
186
187// ----------------------------------------------------------------------------
188
189}; // namespace android
190
191#endif // ANDROID_IAUDIOFLINGER_H
192