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_AUDIO_HARDWARE_INTERFACE_H
18#define ANDROID_AUDIO_HARDWARE_INTERFACE_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <utils/Errors.h>
24#include <utils/Vector.h>
25#include <utils/String16.h>
26#include <utils/String8.h>
27
28#include <media/IAudioFlinger.h>
29#include <hardware_legacy/AudioSystemLegacy.h>
30
31#include <system/audio.h>
32#include <hardware/audio.h>
33
34#include <cutils/bitops.h>
35
36namespace android_audio_legacy {
37    using android::Vector;
38    using android::String16;
39    using android::String8;
40
41// ----------------------------------------------------------------------------
42
43/**
44 * AudioStreamOut is the abstraction interface for the audio output hardware.
45 *
46 * It provides information about various properties of the audio output hardware driver.
47 */
48class AudioStreamOut {
49public:
50    virtual             ~AudioStreamOut() = 0;
51
52    /** return audio sampling rate in hz - eg. 44100 */
53    virtual uint32_t    sampleRate() const = 0;
54
55    /** returns size of output buffer - eg. 4800 */
56    virtual size_t      bufferSize() const = 0;
57
58    /**
59     * returns the output channel mask
60     */
61    virtual uint32_t    channels() const = 0;
62
63    /**
64     * return audio format in 8bit or 16bit PCM format -
65     * eg. AudioSystem:PCM_16_BIT
66     */
67    virtual int         format() const = 0;
68
69    /**
70     * return the frame size (number of bytes per sample).
71     */
72    uint32_t    frameSize() const { return popcount(channels())*((format()==AUDIO_FORMAT_PCM_16_BIT)?sizeof(int16_t):sizeof(int8_t)); }
73
74    /**
75     * return the audio hardware driver latency in milli seconds.
76     */
77    virtual uint32_t    latency() const = 0;
78
79    /**
80     * Use this method in situations where audio mixing is done in the
81     * hardware. This method serves as a direct interface with hardware,
82     * allowing you to directly set the volume as apposed to via the framework.
83     * This method might produce multiple PCM outputs or hardware accelerated
84     * codecs, such as MP3 or AAC.
85     */
86    virtual status_t    setVolume(float left, float right) = 0;
87
88    /** write audio buffer to driver. Returns number of bytes written */
89    virtual ssize_t     write(const void* buffer, size_t bytes) = 0;
90
91    /**
92     * Put the audio hardware output into standby mode. Returns
93     * status based on include/utils/Errors.h
94     */
95    virtual status_t    standby() = 0;
96
97    /** dump the state of the audio output device */
98    virtual status_t dump(int fd, const Vector<String16>& args) = 0;
99
100    // set/get audio output parameters. The function accepts a list of parameters
101    // key value pairs in the form: key1=value1;key2=value2;...
102    // Some keys are reserved for standard parameters (See AudioParameter class).
103    // If the implementation does not accept a parameter change while the output is
104    // active but the parameter is acceptable otherwise, it must return INVALID_OPERATION.
105    // The audio flinger will put the output in standby and then change the parameter value.
106    virtual status_t    setParameters(const String8& keyValuePairs) = 0;
107    virtual String8     getParameters(const String8& keys) = 0;
108
109    // return the number of audio frames written by the audio dsp to DAC since
110    // the output has exited standby
111    virtual status_t    getRenderPosition(uint32_t *dspFrames) = 0;
112
113    /**
114     * get the local time at which the next write to the audio driver will be
115     * presented
116     */
117    virtual status_t    getNextWriteTimestamp(int64_t *timestamp);
118
119};
120
121/**
122 * AudioStreamIn is the abstraction interface for the audio input hardware.
123 *
124 * It defines the various properties of the audio hardware input driver.
125 */
126class AudioStreamIn {
127public:
128    virtual             ~AudioStreamIn() = 0;
129
130    /** return audio sampling rate in hz - eg. 44100 */
131    virtual uint32_t    sampleRate() const = 0;
132
133    /** return the input buffer size allowed by audio driver */
134    virtual size_t      bufferSize() const = 0;
135
136    /** return input channel mask */
137    virtual uint32_t    channels() const = 0;
138
139    /**
140     * return audio format in 8bit or 16bit PCM format -
141     * eg. AudioSystem:PCM_16_BIT
142     */
143    virtual int         format() const = 0;
144
145    /**
146     * return the frame size (number of bytes per sample).
147     */
148    uint32_t    frameSize() const { return AudioSystem::popCount(channels())*((format()==AudioSystem::PCM_16_BIT)?sizeof(int16_t):sizeof(int8_t)); }
149
150    /** set the input gain for the audio driver. This method is for
151     *  for future use */
152    virtual status_t    setGain(float gain) = 0;
153
154    /** read audio buffer in from audio driver */
155    virtual ssize_t     read(void* buffer, ssize_t bytes) = 0;
156
157    /** dump the state of the audio input device */
158    virtual status_t dump(int fd, const Vector<String16>& args) = 0;
159
160    /**
161     * Put the audio hardware input into standby mode. Returns
162     * status based on include/utils/Errors.h
163     */
164    virtual status_t    standby() = 0;
165
166    // set/get audio input parameters. The function accepts a list of parameters
167    // key value pairs in the form: key1=value1;key2=value2;...
168    // Some keys are reserved for standard parameters (See AudioParameter class).
169    // If the implementation does not accept a parameter change while the output is
170    // active but the parameter is acceptable otherwise, it must return INVALID_OPERATION.
171    // The audio flinger will put the input in standby and then change the parameter value.
172    virtual status_t    setParameters(const String8& keyValuePairs) = 0;
173    virtual String8     getParameters(const String8& keys) = 0;
174
175
176    // Return the number of input frames lost in the audio driver since the last call of this function.
177    // Audio driver is expected to reset the value to 0 and restart counting upon returning the current value by this function call.
178    // Such loss typically occurs when the user space process is blocked longer than the capacity of audio driver buffers.
179    // Unit: the number of input audio frames
180    virtual unsigned int  getInputFramesLost() const = 0;
181
182    virtual status_t addAudioEffect(effect_handle_t effect) = 0;
183    virtual status_t removeAudioEffect(effect_handle_t effect) = 0;
184};
185
186/**
187 * AudioHardwareInterface.h defines the interface to the audio hardware abstraction layer.
188 *
189 * The interface supports setting and getting parameters, selecting audio routing
190 * paths, and defining input and output streams.
191 *
192 * AudioFlinger initializes the audio hardware and immediately opens an output stream.
193 * You can set Audio routing to output to handset, speaker, Bluetooth, or a headset.
194 *
195 * The audio input stream is initialized when AudioFlinger is called to carry out
196 * a record operation.
197 */
198class AudioHardwareInterface
199{
200public:
201    virtual ~AudioHardwareInterface() {}
202
203    /**
204     * check to see if the audio hardware interface has been initialized.
205     * return status based on values defined in include/utils/Errors.h
206     */
207    virtual status_t    initCheck() = 0;
208
209    /** set the audio volume of a voice call. Range is between 0.0 and 1.0 */
210    virtual status_t    setVoiceVolume(float volume) = 0;
211
212    /**
213     * set the audio volume for all audio activities other than voice call.
214     * Range between 0.0 and 1.0. If any value other than NO_ERROR is returned,
215     * the software mixer will emulate this capability.
216     */
217    virtual status_t    setMasterVolume(float volume) = 0;
218
219    /**
220     * Get the current master volume value for the HAL, if the HAL supports
221     * master volume control.  AudioFlinger will query this value from the
222     * primary audio HAL when the service starts and use the value for setting
223     * the initial master volume across all HALs.
224     */
225    virtual status_t    getMasterVolume(float *volume) = 0;
226
227    /**
228     * setMode is called when the audio mode changes. NORMAL mode is for
229     * standard audio playback, RINGTONE when a ringtone is playing, and IN_CALL
230     * when a call is in progress.
231     */
232    virtual status_t    setMode(int mode) = 0;
233
234    // mic mute
235    virtual status_t    setMicMute(bool state) = 0;
236    virtual status_t    getMicMute(bool* state) = 0;
237
238    // set/get global audio parameters
239    virtual status_t    setParameters(const String8& keyValuePairs) = 0;
240    virtual String8     getParameters(const String8& keys) = 0;
241
242    // Returns audio input buffer size according to parameters passed or 0 if one of the
243    // parameters is not supported
244    virtual size_t    getInputBufferSize(uint32_t sampleRate, int format, int channelCount) = 0;
245
246    /** This method creates and opens the audio hardware output stream */
247    virtual AudioStreamOut* openOutputStream(
248                                uint32_t devices,
249                                int *format=0,
250                                uint32_t *channels=0,
251                                uint32_t *sampleRate=0,
252                                status_t *status=0) = 0;
253    virtual    void        closeOutputStream(AudioStreamOut* out) = 0;
254
255    /** This method creates and opens the audio hardware input stream */
256    virtual AudioStreamIn* openInputStream(
257                                uint32_t devices,
258                                int *format,
259                                uint32_t *channels,
260                                uint32_t *sampleRate,
261                                status_t *status,
262                                AudioSystem::audio_in_acoustics acoustics) = 0;
263    virtual    void        closeInputStream(AudioStreamIn* in) = 0;
264
265    /**This method dumps the state of the audio hardware */
266    virtual status_t dumpState(int fd, const Vector<String16>& args) = 0;
267
268    static AudioHardwareInterface* create();
269
270protected:
271
272    virtual status_t dump(int fd, const Vector<String16>& args) = 0;
273};
274
275// ----------------------------------------------------------------------------
276
277extern "C" AudioHardwareInterface* createAudioHardware(void);
278
279}; // namespace android
280
281#endif // ANDROID_AUDIO_HARDWARE_INTERFACE_H
282