IAudioFlinger.h revision 18868c5db2f90309c6d11e5837822135e4a0c0fa 
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    virtual     uint32_t    latency(audio_io_handle_t output) const = 0;
82
83    /* set/get the audio hardware state. This will probably be used by
84     * the preference panel, mostly.
85     */
86    virtual     status_t    setMasterVolume(float value) = 0;
87    virtual     status_t    setMasterMute(bool muted) = 0;
88
89    virtual     float       masterVolume() const = 0;
90    virtual     bool        masterMute() const = 0;
91
92    /* set/get stream type state. This will probably be used by
93     * the preference panel, mostly.
94     */
95    virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value,
96                                    audio_io_handle_t output) = 0;
97    virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted) = 0;
98
99    virtual     float       streamVolume(audio_stream_type_t stream,
100                                    audio_io_handle_t output) const = 0;
101    virtual     bool        streamMute(audio_stream_type_t stream) const = 0;
102
103    // set audio mode
104    virtual     status_t    setMode(audio_mode_t mode) = 0;
105
106    // mic mute/state
107    virtual     status_t    setMicMute(bool state) = 0;
108    virtual     bool        getMicMute() const = 0;
109
110    virtual     status_t    setParameters(audio_io_handle_t ioHandle,
111                                    const String8& keyValuePairs) = 0;
112    virtual     String8     getParameters(audio_io_handle_t ioHandle, const String8& keys) const = 0;
113
114    // register a current process for audio output change notifications
115    virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0;
116
117    // retrieve the audio recording buffer size
118    virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format, int channelCount) const = 0;
119
120    virtual audio_io_handle_t openOutput(uint32_t *pDevices,
121                                    uint32_t *pSamplingRate,
122                                    audio_format_t *pFormat,
123                                    uint32_t *pChannels,
124                                    uint32_t *pLatencyMs,
125                                    audio_policy_output_flags_t flags) = 0;
126    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
127                                    audio_io_handle_t output2) = 0;
128    virtual status_t closeOutput(audio_io_handle_t output) = 0;
129    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
130    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
131
132    virtual audio_io_handle_t openInput(uint32_t *pDevices,
133                                    uint32_t *pSamplingRate,
134                                    audio_format_t *pFormat,
135                                    uint32_t *pChannels,
136                                    audio_in_acoustics_t acoustics) = 0;
137    virtual status_t closeInput(audio_io_handle_t input) = 0;
138
139    virtual status_t setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output) = 0;
140
141    virtual status_t setVoiceVolume(float volume) = 0;
142
143    virtual status_t getRenderPosition(uint32_t *halFrames, uint32_t *dspFrames,
144                                    audio_io_handle_t output) const = 0;
145
146    virtual unsigned int getInputFramesLost(audio_io_handle_t ioHandle) const = 0;
147
148    virtual int newAudioSessionId() = 0;
149
150    virtual void acquireAudioSessionId(int audioSession) = 0;
151    virtual void releaseAudioSessionId(int audioSession) = 0;
152
153    virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0;
154
155    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0;
156
157    virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID,
158                                        effect_descriptor_t *pDescriptor) const = 0;
159
160    virtual sp<IEffect> createEffect(pid_t pid,
161                                    effect_descriptor_t *pDesc,
162                                    const sp<IEffectClient>& client,
163                                    int32_t priority,
164                                    audio_io_handle_t output,
165                                    int sessionId,
166                                    status_t *status,
167                                    int *id,
168                                    int *enabled) = 0;
169
170    virtual status_t moveEffects(int session, audio_io_handle_t srcOutput,
171                                    audio_io_handle_t dstOutput) = 0;
172};
173
174
175// ----------------------------------------------------------------------------
176
177class BnAudioFlinger : public BnInterface<IAudioFlinger>
178{
179public:
180    virtual status_t    onTransact( uint32_t code,
181                                    const Parcel& data,
182                                    Parcel* reply,
183                                    uint32_t flags = 0);
184};
185
186// ----------------------------------------------------------------------------
187
188}; // namespace android
189
190#endif // ANDROID_IAUDIOFLINGER_H
191