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