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