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