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_LOCAL_H 181dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#define ANDROID_HARDWARE_STREAM_HAL_LOCAL_H 191dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 20a0c91339814f37ea78365afb436c9f3d1f0a0090Mikhail Naganov#include <media/audiohal/StreamHalInterface.h> 211dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 221dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovnamespace android { 231dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 241dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass DeviceHalLocal; 251dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamHalLocal : public virtual StreamHalInterface 271dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov{ 281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the sampling rate in Hz - eg. 44100. 301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getSampleRate(uint32_t *rate); 311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return size of input/output buffer in bytes for this stream - eg. 4800. 331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getBufferSize(size_t *size); 341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 351dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the channel mask. 361dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getChannelMask(audio_channel_mask_t *mask); 371dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 381dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT. 391dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFormat(audio_format_t *format); 401dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 411dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Convenience method. 421dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getAudioProperties( 431dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov uint32_t *sampleRate, audio_channel_mask_t *mask, audio_format_t *format); 441dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 451dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set audio stream parameters. 461dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setParameters(const String8& kvPairs); 471dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get audio stream parameters. 491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getParameters(const String8& keys, String8 *values); 501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 511dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Add or remove the effect on the stream. 521dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t addEffect(sp<EffectHalInterface> effect); 531dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t removeEffect(sp<EffectHalInterface> effect); 541dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 551dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Put the audio hardware input/output into standby mode. 561dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t standby(); 571dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 581dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t dump(int fd); 591dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 60af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Start a stream operating in mmap mode. 61af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t start() = 0; 62af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 63af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Stop a stream operating in mmap mode. 64af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t stop() = 0; 65af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 66af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Retrieve information on the data buffer in mmap mode. 67af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t createMmapBuffer(int32_t minSizeFrames, 68af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent struct audio_mmap_buffer_info *info) = 0; 69af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 70af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Get current read/write position in the mmap buffer 71af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t getMmapPosition(struct audio_mmap_position *position) = 0; 72af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 73e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov // Set the priority of the thread that interacts with the HAL 74e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov // (must match the priority of the audioflinger's thread that calls 'read' / 'write') 75e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov virtual status_t setHalThreadPriority(int priority); 76e1c4b5d7a94c21b8ce0c5707b4af84de596fbb79Mikhail Naganov 771dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov protected: 781dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Subclasses can not be constructed directly by clients. 791dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamHalLocal(audio_stream_t *stream, sp<DeviceHalLocal> device); 801dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 811dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // The destructor automatically closes the stream. 821dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamHalLocal(); 831dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 841dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov sp<DeviceHalLocal> mDevice; 851dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 861dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov private: 871dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov audio_stream_t *mStream; 881dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 891dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 901dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamOutHalLocal : public StreamOutHalInterface, public StreamHalLocal { 911dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 921dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the frame size (number of bytes per sample) of a stream. 931dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFrameSize(size_t *size); 941dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 951dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the audio hardware driver estimated latency in milliseconds. 961dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getLatency(uint32_t *latency); 971dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 981dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Use this method in situations where audio mixing is done in the hardware. 991dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setVolume(float left, float right); 1001dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1011dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Write audio buffer to driver. 1021dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t write(const void *buffer, size_t bytes, size_t *written); 1031dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1041dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the number of audio frames written by the audio dsp to DAC since 1051dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the output has exited standby. 1061dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getRenderPosition(uint32_t *dspFrames); 1071dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1081dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Get the local time at which the next write to the audio driver will be presented. 1091dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getNextWriteTimestamp(int64_t *timestamp); 1101dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1111dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the callback for notifying completion of non-blocking write and drain. 11215897e459c5086058e73b3e91690320a7bb46d4aMikhail Naganov virtual status_t setCallback(wp<StreamOutHalInterfaceCallback> callback); 1131dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1141dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether pause and resume operations are supported. 1151dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsPauseAndResume(bool *supportsPause, bool *supportsResume); 1161dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1171dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1181dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t pause(); 1191dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1201dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to resume playback following a pause. 1211dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t resume(); 1221dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1231dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Returns whether drain operation is supported. 1241dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t supportsDrain(bool *supportsDrain); 1251dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1261dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Requests notification when data buffered by the driver/hardware has been played. 127cbc8f617c1aebef5d041fa40dcd38a5466690b99Mikhail Naganov virtual status_t drain(bool earlyNotify); 1281dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1291dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Notifies to the audio driver to flush the queued data. 1301dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t flush(); 1311dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1321dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames presented to an external observer. 1331dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getPresentationPosition(uint64_t *frames, struct timespec *timestamp); 1341dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 135af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Start a stream operating in mmap mode. 136af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t start(); 137af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 138af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Stop a stream operating in mmap mode. 139af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t stop(); 140af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 141af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Retrieve information on the data buffer in mmap mode. 142af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t createMmapBuffer(int32_t minSizeFrames, 143af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent struct audio_mmap_buffer_info *info); 144af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 145af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Get current read/write position in the mmap buffer 146af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t getMmapPosition(struct audio_mmap_position *position); 147af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 1481dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov private: 1491dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov audio_stream_out_t *mStream; 1501dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov wp<StreamOutHalInterfaceCallback> mCallback; 1511dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1521dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov friend class DeviceHalLocal; 1531dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1541dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Can not be constructed directly by clients. 1551dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamOutHalLocal(audio_stream_out_t *stream, sp<DeviceHalLocal> device); 1561dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1571dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamOutHalLocal(); 1581dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1591dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov static int asyncCallback(stream_callback_event_t event, void *param, void *cookie); 1601dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 1611dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1621dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganovclass StreamInHalLocal : public StreamInHalInterface, public StreamHalLocal { 1631dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov public: 1641dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the frame size (number of bytes per sample) of a stream. 1651dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getFrameSize(size_t *size); 1661dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1671dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Set the input gain for the audio driver. 1681dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t setGain(float gain); 1691dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1701dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Read audio buffer in from driver. 1711dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t read(void *buffer, size_t bytes, size_t *read); 1721dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1731dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return the amount of input frames lost in the audio driver. 1741dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getInputFramesLost(uint32_t *framesLost); 1751dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1761dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Return a recent count of the number of audio frames received and 1771dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // the clock time associated with that frame count. 1781dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual status_t getCapturePosition(int64_t *frames, int64_t *time); 1791dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 180af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Start a stream operating in mmap mode. 181af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t start(); 182af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 183af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Stop a stream operating in mmap mode. 184af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t stop(); 185af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 186af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Retrieve information on the data buffer in mmap mode. 187af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t createMmapBuffer(int32_t minSizeFrames, 188af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent struct audio_mmap_buffer_info *info); 189af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 190af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent // Get current read/write position in the mmap buffer 191af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent virtual status_t getMmapPosition(struct audio_mmap_position *position); 192af35aadb7ab558035b6cf45bd3930ecaa3a3b330Eric Laurent 1931dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov private: 1941dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov audio_stream_in_t *mStream; 1951dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1961dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov friend class DeviceHalLocal; 1971dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 1981dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov // Can not be constructed directly by clients. 1991dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov StreamInHalLocal(audio_stream_in_t *stream, sp<DeviceHalLocal> device); 2001dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 2011dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov virtual ~StreamInHalLocal(); 2021dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov}; 2031dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 2041dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov} // namespace android 2051dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov 2061dc98674f701dada94143b4d31b7221c58346c6cMikhail Naganov#endif // ANDROID_HARDWARE_STREAM_HAL_LOCAL_H 207