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 20a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard#include <vector> 21a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard 22a0c91339814f37ea78365afb436c9f3d1f0a0090Mikhail Naganov#include <media/audiohal/EffectHalInterface.h> 239ff780e58ff96ff98acaae4166bb218880bf9e73jiabin#include <media/MicrophoneInfo.h> 24cbc8f617c1aebef5d041fa40dcd38a5466690b99Mikhail Naganov#include <system/audio.h> 251dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/Errors.h> 261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/RefBase.h> 271dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#include <utils/String8.h> 281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovnamespace android { 301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamHalInterface : public virtual RefBase 321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov{ 331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the sampling rate in Hz - eg. 44100. 351dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getSampleRate(uint32_t *rate) = 0; 361dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 371dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return size of input/output buffer in bytes for this stream - eg. 4800. 381dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getBufferSize(size_t *size) = 0; 391dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 401dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the channel mask. 411dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getChannelMask(audio_channel_mask_t *mask) = 0; 421dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 431dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT. 441dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFormat(audio_format_t *format) = 0; 451dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 461dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Convenience method. 471dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getAudioProperties( 481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov uint32_t *sampleRate, audio_channel_mask_t *mask, audio_format_t *format) = 0; 491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set audio stream parameters. 511dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setParameters(const String8& kvPairs) = 0; 521dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 531dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get audio stream parameters. 541dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getParameters(const String8& keys, String8 *values) = 0; 551dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 561dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the frame size (number of bytes per sample) of a stream. 571dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFrameSize(size_t *size) = 0; 581dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 591dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Add or remove the effect on the stream. 601dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t addEffect(sp<EffectHalInterface> effect) = 0; 611dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t removeEffect(sp<EffectHalInterface> effect) = 0; 621dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 631dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Put the audio hardware input/output into standby mode. 641dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t standby() = 0; 651dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 661dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t dump(int fd) = 0; 671dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 68af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Start a stream operating in mmap mode. 69af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t start() = 0; 70af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 71af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Stop a stream operating in mmap mode. 72af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t stop() = 0; 73af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 74af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Retrieve information on the data buffer in mmap mode. 75af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t createMmapBuffer(int32_t minSizeFrames, 76af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent struct audio_mmap_buffer_info *info) = 0; 77af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 78af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Get current read/write position in the mmap buffer 79af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t getMmapPosition(struct audio_mmap_position *position) = 0; 80af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 81e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov // Set the priority of the thread that interacts with the HAL 82e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov // (must match the priority of the audioflinger's thread that calls 'read' / 'write') 83e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov virtual status_t setHalThreadPriority(int priority) = 0; 84e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov 851dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 861dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Subclasses can not be constructed directly by clients. 871dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamHalInterface() {} 881dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 891dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The destructor automatically closes the stream. 901dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamHalInterface() {} 911dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 921dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 931dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamOutHalInterfaceCallback : public virtual RefBase { 941dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 951dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onWriteReady() {} 961dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onDrainReady() {} 971dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual void onError() {} 981dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 991dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 1001dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamOutHalInterfaceCallback() {} 1011dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamOutHalInterfaceCallback() {} 1021dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1031dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1041dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamOutHalInterface : public virtual StreamHalInterface { 1051dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 1061dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio hardware driver estimated latency in milliseconds. 1071dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getLatency(uint32_t *latency) = 0; 1081dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1091dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Use this method in situations where audio mixing is done in the hardware. 1101dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setVolume(float left, float right) = 0; 1111dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1121dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Write audio buffer to driver. 1131dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t write(const void *buffer, size_t bytes, size_t *written) = 0; 1141dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1151dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the number of audio frames written by the audio dsp to DAC since 1161dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the output has exited standby. 1171dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getRenderPosition(uint32_t *dspFrames) = 0; 1181dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1191dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get the local time at which the next write to the audio driver will be presented. 1201dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getNextWriteTimestamp(int64_t *timestamp) = 0; 1211dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1221dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the callback for notifying completion of non-blocking write and drain. 1231dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The callback must be owned by someone else. The output stream does not own it 1241dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // to avoid strong pointer loops. 12515897e459c5086058e73b3e91690320a7bb46d4aMikhail Naganov virtual status_t setCallback(wp<StreamOutHalInterfaceCallback> callback) = 0; 1261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1271dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether pause and resume operations are supported. 1281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsPauseAndResume(bool *supportsPause, bool *supportsResume) = 0; 1291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t pause() = 0; 1321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t resume() = 0; 1351dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1361dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether drain operation is supported. 1371dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsDrain(bool *supportsDrain) = 0; 1381dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1391dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Requests notification when data buffered by the driver/hardware has been played. 140cbc8f617c1aebef5d041fa40dcd38a5466690b99Mikhail Naganov virtual status_t drain(bool earlyNotify) = 0; 1411dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1421dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to flush the queued data. 1431dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t flush() = 0; 1441dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1451dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames presented to an external observer. 1461dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getPresentationPosition(uint64_t *frames, struct timespec *timestamp) = 0; 1471dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 148a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard struct SourceMetadata { 149a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard std::vector<playback_track_metadata_t> tracks; 150a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard }; 151a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard /** 152a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard * Called when the metadata of the stream's source has been changed. 153a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard * @param sourceMetadata Description of the audio that is played by the clients. 154a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard */ 155a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard virtual status_t updateSourceMetadata(const SourceMetadata& sourceMetadata) = 0; 156a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard 1571dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 1581dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamOutHalInterface() {} 1591dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1601dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1611dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamInHalInterface : public virtual StreamHalInterface { 1621dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 1631dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the input gain for the audio driver. 1641dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setGain(float gain) = 0; 1651dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1661dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Read audio buffer in from driver. 1671dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t read(void *buffer, size_t bytes, size_t *read) = 0; 1681dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1691dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the amount of input frames lost in the audio driver. 1701dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getInputFramesLost(uint32_t *framesLost) = 0; 1711dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1721dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames received and 1731dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the clock time associated with that frame count. 1741dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getCapturePosition(int64_t *frames, int64_t *time) = 0; 1751dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1769ff780e58ff96ff98acaae4166bb218880bf9e73jiabin // Get active microphones 1779ff780e58ff96ff98acaae4166bb218880bf9e73jiabin virtual status_t getActiveMicrophones(std::vector<media::MicrophoneInfo> *microphones) = 0; 1789ff780e58ff96ff98acaae4166bb218880bf9e73jiabin 179a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard struct SinkMetadata { 180a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard std::vector<record_track_metadata_t> tracks; 181a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard }; 182a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard /** 183a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard * Called when the metadata of the stream's sink has been changed. 184a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard * @param sinkMetadata Description of the audio that is suggested by the clients. 185a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard */ 186a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard virtual status_t updateSinkMetadata(const SinkMetadata& sinkMetadata) = 0; 187a8975a7e857fd745fc88d226d86b53ae088eafb9Kevin Rocard 1881dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 1891dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamInHalInterface() {} 1901dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1911dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1921dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov} // namespace android 1931dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1941dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#endif // ANDROID_HARDWARE_STREAM_HAL_INTERFACE_H 195