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