IAudioFlinger.h revision fb1fdc9d6603aa228362e7349451f6455c9849c2 
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_policy.h>
33#include <hardware/audio_effect.h>
34#include <media/IEffect.h>
35#include <media/IEffectClient.h>
36#include <utils/String8.h>
37
38namespace android {
39
40// ----------------------------------------------------------------------------
41
42class IAudioFlinger : public IInterface
43{
44public:
45    DECLARE_META_INTERFACE(AudioFlinger);
46
47    // or-able bits shared by createTrack and openRecord, but not all combinations make sense
48    enum {
49        TRACK_DEFAULT = 0,  // client requests a default AudioTrack
50        TRACK_TIMED   = 1,  // client requests a TimedAudioTrack
51        TRACK_FAST    = 2,  // client requests a fast AudioTrack or AudioRecord
52        TRACK_OFFLOAD = 4,  // client requests offload to hw codec
53    };
54    typedef uint32_t track_flags_t;
55
56    /* create an audio track and registers it with AudioFlinger.
57     * return null if the track cannot be created.
58     */
59    virtual sp<IAudioTrack> createTrack(
60                                audio_stream_type_t streamType,
61                                uint32_t sampleRate,
62                                audio_format_t format,
63                                audio_channel_mask_t channelMask,
64                                size_t frameCount,
65                                track_flags_t *flags,
66                                const sp<IMemory>& sharedBuffer,
67                                audio_io_handle_t output,
68                                pid_t tid,  // -1 means unused, otherwise must be valid non-0
69                                int *sessionId,
70                                status_t *status) = 0;
71
72    virtual sp<IAudioRecord> openRecord(
73                                audio_io_handle_t input,
74                                uint32_t sampleRate,
75                                audio_format_t format,
76                                audio_channel_mask_t channelMask,
77                                size_t frameCount,
78                                track_flags_t flags,
79                                pid_t tid,  // -1 means unused, otherwise must be valid non-0
80                                int *sessionId,
81                                status_t *status) = 0;
82
83    /* query the audio hardware state. This state never changes,
84     * and therefore can be cached.
85     */
86    virtual     uint32_t    sampleRate(audio_io_handle_t output) const = 0;
87#if 0
88    virtual     int         channelCount(audio_io_handle_t output) const = 0;
89#endif
90    virtual     audio_format_t format(audio_io_handle_t output) const = 0;
91    virtual     size_t      frameCount(audio_io_handle_t output) const = 0;
92
93    // return estimated latency in milliseconds
94    virtual     uint32_t    latency(audio_io_handle_t output) const = 0;
95
96    /* set/get the audio hardware state. This will probably be used by
97     * the preference panel, mostly.
98     */
99    virtual     status_t    setMasterVolume(float value) = 0;
100    virtual     status_t    setMasterMute(bool muted) = 0;
101
102    virtual     float       masterVolume() const = 0;
103    virtual     bool        masterMute() const = 0;
104
105    /* set/get stream type state. This will probably be used by
106     * the preference panel, mostly.
107     */
108    virtual     status_t    setStreamVolume(audio_stream_type_t stream, float value,
109                                    audio_io_handle_t output) = 0;
110    virtual     status_t    setStreamMute(audio_stream_type_t stream, bool muted) = 0;
111
112    virtual     float       streamVolume(audio_stream_type_t stream,
113                                    audio_io_handle_t output) const = 0;
114    virtual     bool        streamMute(audio_stream_type_t stream) const = 0;
115
116    // set audio mode
117    virtual     status_t    setMode(audio_mode_t mode) = 0;
118
119    // mic mute/state
120    virtual     status_t    setMicMute(bool state) = 0;
121    virtual     bool        getMicMute() const = 0;
122
123    virtual     status_t    setParameters(audio_io_handle_t ioHandle,
124                                    const String8& keyValuePairs) = 0;
125    virtual     String8     getParameters(audio_io_handle_t ioHandle, const String8& keys)
126                                    const = 0;
127
128    // Register an object to receive audio input/output change and track notifications.
129    // For a given calling pid, AudioFlinger disregards any registrations after the first.
130    // Thus the IAudioFlingerClient must be a singleton per process.
131    virtual void registerClient(const sp<IAudioFlingerClient>& client) = 0;
132
133    // retrieve the audio recording buffer size
134    virtual size_t getInputBufferSize(uint32_t sampleRate, audio_format_t format,
135            audio_channel_mask_t channelMask) const = 0;
136
137    virtual audio_io_handle_t openOutput(audio_module_handle_t module,
138                                         audio_devices_t *pDevices,
139                                         uint32_t *pSamplingRate,
140                                         audio_format_t *pFormat,
141                                         audio_channel_mask_t *pChannelMask,
142                                         uint32_t *pLatencyMs,
143                                         audio_output_flags_t flags,
144                                         const audio_offload_info_t *offloadInfo = NULL) = 0;
145    virtual audio_io_handle_t openDuplicateOutput(audio_io_handle_t output1,
146                                    audio_io_handle_t output2) = 0;
147    virtual status_t closeOutput(audio_io_handle_t output) = 0;
148    virtual status_t suspendOutput(audio_io_handle_t output) = 0;
149    virtual status_t restoreOutput(audio_io_handle_t output) = 0;
150
151    virtual audio_io_handle_t openInput(audio_module_handle_t module,
152                                        audio_devices_t *pDevices,
153                                        uint32_t *pSamplingRate,
154                                        audio_format_t *pFormat,
155                                        audio_channel_mask_t *pChannelMask) = 0;
156    virtual status_t closeInput(audio_io_handle_t input) = 0;
157
158    virtual status_t setStreamOutput(audio_stream_type_t stream, audio_io_handle_t output) = 0;
159
160    virtual status_t setVoiceVolume(float volume) = 0;
161
162    virtual status_t getRenderPosition(size_t *halFrames, size_t *dspFrames,
163                                    audio_io_handle_t output) const = 0;
164
165    virtual size_t getInputFramesLost(audio_io_handle_t ioHandle) const = 0;
166
167    virtual int newAudioSessionId() = 0;
168
169    virtual void acquireAudioSessionId(int audioSession) = 0;
170    virtual void releaseAudioSessionId(int audioSession) = 0;
171
172    virtual status_t queryNumberEffects(uint32_t *numEffects) const = 0;
173
174    virtual status_t queryEffect(uint32_t index, effect_descriptor_t *pDescriptor) const = 0;
175
176    virtual status_t getEffectDescriptor(const effect_uuid_t *pEffectUUID,
177                                        effect_descriptor_t *pDescriptor) const = 0;
178
179    virtual sp<IEffect> createEffect(
180                                    effect_descriptor_t *pDesc,
181                                    const sp<IEffectClient>& client,
182                                    int32_t priority,
183                                    audio_io_handle_t output,
184                                    int sessionId,
185                                    status_t *status,
186                                    int *id,
187                                    int *enabled) = 0;
188
189    virtual status_t moveEffects(int session, audio_io_handle_t srcOutput,
190                                    audio_io_handle_t dstOutput) = 0;
191
192    virtual audio_module_handle_t loadHwModule(const char *name) = 0;
193
194    // helpers for android.media.AudioManager.getProperty(), see description there for meaning
195    // FIXME move these APIs to AudioPolicy to permit a more accurate implementation
196    // that looks on primary device for a stream with fast flag, primary flag, or first one.
197    virtual uint32_t getPrimaryOutputSamplingRate() = 0;
198    virtual size_t getPrimaryOutputFrameCount() = 0;
199
200};
201
202
203// ----------------------------------------------------------------------------
204
205class BnAudioFlinger : public BnInterface<IAudioFlinger>
206{
207public:
208    virtual status_t    onTransact( uint32_t code,
209                                    const Parcel& data,
210                                    Parcel* reply,
211                                    uint32_t flags = 0);
212};
213
214// ----------------------------------------------------------------------------
215
216}; // namespace android
217
218#endif // ANDROID_IAUDIOFLINGER_H
219