StreamHalInterface.h revision 1dc98674f701dada94143b4d31b7221c58346c6c
11dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov/* 21dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * Copyright (C) 2016 The Android Open Source Project 31dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * 41dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * Licensed under the Apache License, Version 2.0 (the "License"); 51dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * you may not use this file except in compliance with the License. 61dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * You may obtain a copy of the License at 71dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * 81dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * http://www.apache.org/licenses/LICENSE-2.0 91dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * 101dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * Unless required by applicable law or agreed to in writing, software 111dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * distributed under the License is distributed on an "AS IS" BASIS, 121dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * See the License for the specific language governing permissions and 141dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov * limitations under the License. 151dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov */ 161dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 171dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#ifndef ANDROID_HARDWARE_STREAM_HAL_INTERFACE_H 181dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#define ANDROID_HARDWARE_STREAM_HAL_INTERFACE_H 191dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 201dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <hardware/audio_effect.h> 211dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/Errors.h> 221dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/RefBase.h> 231dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/String8.h> 241dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 251dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include "EffectHalInterface.h" 261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 271dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovnamespace android { 281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamHalInterface : public virtual RefBase 301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov{ 311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the sampling rate in Hz - eg. 44100. 331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getSampleRate(uint32_t *rate) = 0; 341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 351dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return size of input/output buffer in bytes for this stream - eg. 4800. 361dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getBufferSize(size_t *size) = 0; 371dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 381dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the channel mask. 391dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getChannelMask(audio_channel_mask_t *mask) = 0; 401dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 411dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT. 421dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFormat(audio_format_t *format) = 0; 431dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 441dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Convenience method. 451dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getAudioProperties( 461dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov uint32_t *sampleRate, audio_channel_mask_t *mask, audio_format_t *format) = 0; 471dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set audio stream parameters. 491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setParameters(const String8& kvPairs) = 0; 501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 511dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get audio stream parameters. 521dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getParameters(const String8& keys, String8 *values) = 0; 531dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 541dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the frame size (number of bytes per sample) of a stream. 551dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFrameSize(size_t *size) = 0; 561dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 571dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Add or remove the effect on the stream. 581dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t addEffect(sp<EffectHalInterface> effect) = 0; 591dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t removeEffect(sp<EffectHalInterface> effect) = 0; 601dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 611dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Put the audio hardware input/output into standby mode. 621dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t standby() = 0; 631dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 641dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t dump(int fd) = 0; 651dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 661dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 671dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Subclasses can not be constructed directly by clients. 681dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamHalInterface() {} 691dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 701dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The destructor automatically closes the stream. 711dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamHalInterface() {} 721dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 731dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 741dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamOutHalInterfaceCallback : public virtual RefBase { 751dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 761dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onWriteReady() {} 771dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onDrainReady() {} 781dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onError() {} 791dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 801dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 811dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamOutHalInterfaceCallback() {} 821dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamOutHalInterfaceCallback() {} 831dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 841dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 851dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamOutHalInterface : public virtual StreamHalInterface { 861dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 871dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio hardware driver estimated latency in milliseconds. 881dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getLatency(uint32_t *latency) = 0; 891dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 901dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Use this method in situations where audio mixing is done in the hardware. 911dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setVolume(float left, float right) = 0; 921dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 931dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Write audio buffer to driver. 941dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t write(const void *buffer, size_t bytes, size_t *written) = 0; 951dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 961dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the number of audio frames written by the audio dsp to DAC since 971dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the output has exited standby. 981dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getRenderPosition(uint32_t *dspFrames) = 0; 991dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1001dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get the local time at which the next write to the audio driver will be presented. 1011dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getNextWriteTimestamp(int64_t *timestamp) = 0; 1021dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1031dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the callback for notifying completion of non-blocking write and drain. 1041dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The callback must be owned by someone else. The output stream does not own it 1051dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // to avoid strong pointer loops. 1061dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setCallback(sp<StreamOutHalInterfaceCallback> callback) = 0; 1071dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1081dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether pause and resume operations are supported. 1091dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsPauseAndResume(bool *supportsPause, bool *supportsResume) = 0; 1101dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1111dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1121dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t pause() = 0; 1131dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1141dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1151dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t resume() = 0; 1161dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1171dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether drain operation is supported. 1181dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsDrain(bool *supportsDrain) = 0; 1191dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1201dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Requests notification when data buffered by the driver/hardware has been played. 1211dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t drain(audio_drain_type_t type) = 0; 1221dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1231dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to flush the queued data. 1241dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t flush() = 0; 1251dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames presented to an external observer. 1271dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getPresentationPosition(uint64_t *frames, struct timespec *timestamp) = 0; 1281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 1301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamOutHalInterface() {} 1311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamInHalInterface : public virtual StreamHalInterface { 1341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 1351dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the input gain for the audio driver. 1361dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setGain(float gain) = 0; 1371dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1381dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Read audio buffer in from driver. 1391dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t read(void *buffer, size_t bytes, size_t *read) = 0; 1401dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1411dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the amount of input frames lost in the audio driver. 1421dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getInputFramesLost(uint32_t *framesLost) = 0; 1431dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1441dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames received and 1451dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the clock time associated with that frame count. 1461dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getCapturePosition(int64_t *frames, int64_t *time) = 0; 1471dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 1491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamInHalInterface() {} 1501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1511dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1521dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov} // namespace android 1531dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1541dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#endif // ANDROID_HARDWARE_STREAM_HAL_INTERFACE_H 155