media/libaudiohal/StreamHalHidl.h - platform/frameworks/av - Git at Google

 /*
  * Copyright (C) 2016 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 #ifndef ANDROID_HARDWARE_STREAM_HAL_HIDL_H
 #define ANDROID_HARDWARE_STREAM_HAL_HIDL_H

 #include <atomic>

 #include <android/hardware/audio/2.0/IStream.h>
 #include <android/hardware/audio/2.0/IStreamIn.h>
 #include <android/hardware/audio/2.0/IStreamOut.h>
 #include <fmq/EventFlag.h>
 #include <fmq/MessageQueue.h>
 #include <media/audiohal/StreamHalInterface.h>

 #include "ConversionHelperHidl.h"

 using ::android::hardware::audio::V2_0::IStream;
 using ::android::hardware::audio::V2_0::IStreamIn;
 using ::android::hardware::audio::V2_0::IStreamOut;
 using ::android::hardware::EventFlag;
 using ::android::hardware::MessageQueue;
 using ::android::hardware::Return;
 using ReadParameters = ::android::hardware::audio::V2_0::IStreamIn::ReadParameters;
 using ReadStatus = ::android::hardware::audio::V2_0::IStreamIn::ReadStatus;
 using WriteCommand = ::android::hardware::audio::V2_0::IStreamOut::WriteCommand;
 using WriteStatus = ::android::hardware::audio::V2_0::IStreamOut::WriteStatus;

 namespace android {

 class DeviceHalHidl;

 class StreamHalHidl : public virtual StreamHalInterface, public ConversionHelperHidl
 {
   public:
     // Return the sampling rate in Hz - eg. 44100.
     virtual status_t getSampleRate(uint32_t *rate);

     // Return size of input/output buffer in bytes for this stream - eg. 4800.
     virtual status_t getBufferSize(size_t *size);

     // Return the channel mask.
     virtual status_t getChannelMask(audio_channel_mask_t *mask);

     // Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT.
     virtual status_t getFormat(audio_format_t *format);

     // Convenience method.
     virtual status_t getAudioProperties(
             uint32_t *sampleRate, audio_channel_mask_t *mask, audio_format_t *format);

     // Set audio stream parameters.
     virtual status_t setParameters(const String8& kvPairs);

     // Get audio stream parameters.
     virtual status_t getParameters(const String8& keys, String8 *values);

     // Add or remove the effect on the stream.
     virtual status_t addEffect(sp<EffectHalInterface> effect);
     virtual status_t removeEffect(sp<EffectHalInterface> effect);

     // Put the audio hardware input/output into standby mode.
     virtual status_t standby();

     virtual status_t dump(int fd);

     // Start a stream operating in mmap mode.
     virtual status_t start();

     // Stop a stream operating in mmap mode.
     virtual status_t stop();

     // Retrieve information on the data buffer in mmap mode.
     virtual status_t createMmapBuffer(int32_t minSizeFrames,
                                       struct audio_mmap_buffer_info *info);

     // Get current read/write position in the mmap buffer
     virtual status_t getMmapPosition(struct audio_mmap_position *position);

     // Set the priority of the thread that interacts with the HAL
     // (must match the priority of the audioflinger's thread that calls 'read' / 'write')
     virtual status_t setHalThreadPriority(int priority);

   protected:
     // Subclasses can not be constructed directly by clients.
     explicit StreamHalHidl(IStream *stream);

     // The destructor automatically closes the stream.
     virtual ~StreamHalHidl();

     bool requestHalThreadPriority(pid_t threadPid, pid_t threadId);

   private:
     const int HAL_THREAD_PRIORITY_DEFAULT = -1;
     IStream *mStream;
     int mHalThreadPriority;
 };

 class StreamOutHalHidl : public StreamOutHalInterface, public StreamHalHidl {
   public:
     // Return the frame size (number of bytes per sample) of a stream.
     virtual status_t getFrameSize(size_t *size);

     // Return the audio hardware driver estimated latency in milliseconds.
     virtual status_t getLatency(uint32_t *latency);

     // Use this method in situations where audio mixing is done in the hardware.
     virtual status_t setVolume(float left, float right);

     // Write audio buffer to driver.
     virtual status_t write(const void *buffer, size_t bytes, size_t *written);

     // Return the number of audio frames written by the audio dsp to DAC since
     // the output has exited standby.
     virtual status_t getRenderPosition(uint32_t *dspFrames);

     // Get the local time at which the next write to the audio driver will be presented.
     virtual status_t getNextWriteTimestamp(int64_t *timestamp);

     // Set the callback for notifying completion of non-blocking write and drain.
     virtual status_t setCallback(wp<StreamOutHalInterfaceCallback> callback);

     // Returns whether pause and resume operations are supported.
     virtual status_t supportsPauseAndResume(bool *supportsPause, bool *supportsResume);

     // Notifies to the audio driver to resume playback following a pause.
     virtual status_t pause();

     // Notifies to the audio driver to resume playback following a pause.
     virtual status_t resume();

     // Returns whether drain operation is supported.
     virtual status_t supportsDrain(bool *supportsDrain);

     // Requests notification when data buffered by the driver/hardware has been played.
     virtual status_t drain(bool earlyNotify);

     // Notifies to the audio driver to flush the queued data.
     virtual status_t flush();

     // Return a recent count of the number of audio frames presented to an external observer.
     virtual status_t getPresentationPosition(uint64_t *frames, struct timespec *timestamp);

     // Methods used by StreamOutCallback (HIDL).
     void onWriteReady();
     void onDrainReady();
     void onError();

   private:
     friend class DeviceHalHidl;
     typedef MessageQueue<WriteCommand, hardware::kSynchronizedReadWrite> CommandMQ;
     typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
     typedef MessageQueue<WriteStatus, hardware::kSynchronizedReadWrite> StatusMQ;

     wp<StreamOutHalInterfaceCallback> mCallback;
     sp<IStreamOut> mStream;
     std::unique_ptr<CommandMQ> mCommandMQ;
     std::unique_ptr<DataMQ> mDataMQ;
     std::unique_ptr<StatusMQ> mStatusMQ;
     std::atomic<pid_t> mWriterClient;
     EventFlag* mEfGroup;

     // Can not be constructed directly by clients.
     StreamOutHalHidl(const sp<IStreamOut>& stream);

     virtual ~StreamOutHalHidl();

     using WriterCallback = std::function<void(const WriteStatus& writeStatus)>;
     status_t callWriterThread(
             WriteCommand cmd, const char* cmdName,
             const uint8_t* data, size_t dataSize, WriterCallback callback);
     status_t prepareForWriting(size_t bufferSize);
 };

 class StreamInHalHidl : public StreamInHalInterface, public StreamHalHidl {
   public:
     // Return the frame size (number of bytes per sample) of a stream.
     virtual status_t getFrameSize(size_t *size);

     // Set the input gain for the audio driver.
     virtual status_t setGain(float gain);

     // Read audio buffer in from driver.
     virtual status_t read(void *buffer, size_t bytes, size_t *read);

     // Return the amount of input frames lost in the audio driver.
     virtual status_t getInputFramesLost(uint32_t *framesLost);

     // Return a recent count of the number of audio frames received and
     // the clock time associated with that frame count.
     virtual status_t getCapturePosition(int64_t *frames, int64_t *time);

   private:
     friend class DeviceHalHidl;
     typedef MessageQueue<ReadParameters, hardware::kSynchronizedReadWrite> CommandMQ;
     typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
     typedef MessageQueue<ReadStatus, hardware::kSynchronizedReadWrite> StatusMQ;

     sp<IStreamIn> mStream;
     std::unique_ptr<CommandMQ> mCommandMQ;
     std::unique_ptr<DataMQ> mDataMQ;
     std::unique_ptr<StatusMQ> mStatusMQ;
     std::atomic<pid_t> mReaderClient;
     EventFlag* mEfGroup;

     // Can not be constructed directly by clients.
     StreamInHalHidl(const sp<IStreamIn>& stream);

     virtual ~StreamInHalHidl();

     using ReaderCallback = std::function<void(const ReadStatus& readStatus)>;
     status_t callReaderThread(
             const ReadParameters& params, const char* cmdName, ReaderCallback callback);
     status_t prepareForReading(size_t bufferSize);
 };

 } // namespace android

 #endif // ANDROID_HARDWARE_STREAM_HAL_HIDL_H
	/*
	* Copyright (C) 2016 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	#ifndef ANDROID_HARDWARE_STREAM_HAL_HIDL_H
	#define ANDROID_HARDWARE_STREAM_HAL_HIDL_H

	#include <atomic>

	#include <android/hardware/audio/2.0/IStream.h>
	#include <android/hardware/audio/2.0/IStreamIn.h>
	#include <android/hardware/audio/2.0/IStreamOut.h>
	#include <fmq/EventFlag.h>
	#include <fmq/MessageQueue.h>
	#include <media/audiohal/StreamHalInterface.h>

	#include "ConversionHelperHidl.h"

	using ::android::hardware::audio::V2_0::IStream;
	using ::android::hardware::audio::V2_0::IStreamIn;
	using ::android::hardware::audio::V2_0::IStreamOut;
	using ::android::hardware::EventFlag;
	using ::android::hardware::MessageQueue;
	using ::android::hardware::Return;
	using ReadParameters = ::android::hardware::audio::V2_0::IStreamIn::ReadParameters;
	using ReadStatus = ::android::hardware::audio::V2_0::IStreamIn::ReadStatus;
	using WriteCommand = ::android::hardware::audio::V2_0::IStreamOut::WriteCommand;
	using WriteStatus = ::android::hardware::audio::V2_0::IStreamOut::WriteStatus;

	namespace android {

	class DeviceHalHidl;

	class StreamHalHidl : public virtual StreamHalInterface, public ConversionHelperHidl
	{
	public:
	// Return the sampling rate in Hz - eg. 44100.
	virtual status_t getSampleRate(uint32_t *rate);

	// Return size of input/output buffer in bytes for this stream - eg. 4800.
	virtual status_t getBufferSize(size_t *size);

	// Return the channel mask.
	virtual status_t getChannelMask(audio_channel_mask_t *mask);

	// Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT.
	virtual status_t getFormat(audio_format_t *format);

	// Convenience method.
	virtual status_t getAudioProperties(
	uint32_t sampleRate, audio_channel_mask_t mask, audio_format_t *format);

	// Set audio stream parameters.
	virtual status_t setParameters(const String8& kvPairs);

	// Get audio stream parameters.
	virtual status_t getParameters(const String8& keys, String8 *values);

	// Add or remove the effect on the stream.
	virtual status_t addEffect(sp<EffectHalInterface> effect);
	virtual status_t removeEffect(sp<EffectHalInterface> effect);

	// Put the audio hardware input/output into standby mode.
	virtual status_t standby();

	virtual status_t dump(int fd);

	// Start a stream operating in mmap mode.
	virtual status_t start();

	// Stop a stream operating in mmap mode.
	virtual status_t stop();

	// Retrieve information on the data buffer in mmap mode.
	virtual status_t createMmapBuffer(int32_t minSizeFrames,
	struct audio_mmap_buffer_info *info);

	// Get current read/write position in the mmap buffer
	virtual status_t getMmapPosition(struct audio_mmap_position *position);

	// Set the priority of the thread that interacts with the HAL
	// (must match the priority of the audioflinger's thread that calls 'read' / 'write')
	virtual status_t setHalThreadPriority(int priority);

	protected:
	// Subclasses can not be constructed directly by clients.
	explicit StreamHalHidl(IStream *stream);

	// The destructor automatically closes the stream.
	virtual ~StreamHalHidl();

	bool requestHalThreadPriority(pid_t threadPid, pid_t threadId);

	private:
	const int HAL_THREAD_PRIORITY_DEFAULT = -1;
	IStream *mStream;
	int mHalThreadPriority;
	};

	class StreamOutHalHidl : public StreamOutHalInterface, public StreamHalHidl {
	public:
	// Return the frame size (number of bytes per sample) of a stream.
	virtual status_t getFrameSize(size_t *size);

	// Return the audio hardware driver estimated latency in milliseconds.
	virtual status_t getLatency(uint32_t *latency);

	// Use this method in situations where audio mixing is done in the hardware.
	virtual status_t setVolume(float left, float right);

	// Write audio buffer to driver.
	virtual status_t write(const void buffer, size_t bytes, size_t written);

	// Return the number of audio frames written by the audio dsp to DAC since
	// the output has exited standby.
	virtual status_t getRenderPosition(uint32_t *dspFrames);

	// Get the local time at which the next write to the audio driver will be presented.
	virtual status_t getNextWriteTimestamp(int64_t *timestamp);

	// Set the callback for notifying completion of non-blocking write and drain.
	virtual status_t setCallback(wp<StreamOutHalInterfaceCallback> callback);

	// Returns whether pause and resume operations are supported.
	virtual status_t supportsPauseAndResume(bool supportsPause, bool supportsResume);

	// Notifies to the audio driver to resume playback following a pause.
	virtual status_t pause();

	// Notifies to the audio driver to resume playback following a pause.
	virtual status_t resume();

	// Returns whether drain operation is supported.
	virtual status_t supportsDrain(bool *supportsDrain);

	// Requests notification when data buffered by the driver/hardware has been played.
	virtual status_t drain(bool earlyNotify);

	// Notifies to the audio driver to flush the queued data.
	virtual status_t flush();

	// Return a recent count of the number of audio frames presented to an external observer.
	virtual status_t getPresentationPosition(uint64_t frames, struct timespec timestamp);

	// Methods used by StreamOutCallback (HIDL).
	void onWriteReady();
	void onDrainReady();
	void onError();

	private:
	friend class DeviceHalHidl;
	typedef MessageQueue<WriteCommand, hardware::kSynchronizedReadWrite> CommandMQ;
	typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
	typedef MessageQueue<WriteStatus, hardware::kSynchronizedReadWrite> StatusMQ;

	wp<StreamOutHalInterfaceCallback> mCallback;
	sp<IStreamOut> mStream;
	std::unique_ptr<CommandMQ> mCommandMQ;
	std::unique_ptr<DataMQ> mDataMQ;
	std::unique_ptr<StatusMQ> mStatusMQ;
	std::atomic<pid_t> mWriterClient;
	EventFlag* mEfGroup;

	// Can not be constructed directly by clients.
	StreamOutHalHidl(const sp<IStreamOut>& stream);

	virtual ~StreamOutHalHidl();

	using WriterCallback = std::function<void(const WriteStatus& writeStatus)>;
	status_t callWriterThread(
	WriteCommand cmd, const char* cmdName,
	const uint8_t* data, size_t dataSize, WriterCallback callback);
	status_t prepareForWriting(size_t bufferSize);
	};

	class StreamInHalHidl : public StreamInHalInterface, public StreamHalHidl {
	public:
	// Return the frame size (number of bytes per sample) of a stream.
	virtual status_t getFrameSize(size_t *size);

	// Set the input gain for the audio driver.
	virtual status_t setGain(float gain);

	// Read audio buffer in from driver.
	virtual status_t read(void buffer, size_t bytes, size_t read);

	// Return the amount of input frames lost in the audio driver.
	virtual status_t getInputFramesLost(uint32_t *framesLost);

	// Return a recent count of the number of audio frames received and
	// the clock time associated with that frame count.
	virtual status_t getCapturePosition(int64_t frames, int64_t time);

	private:
	friend class DeviceHalHidl;
	typedef MessageQueue<ReadParameters, hardware::kSynchronizedReadWrite> CommandMQ;
	typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
	typedef MessageQueue<ReadStatus, hardware::kSynchronizedReadWrite> StatusMQ;

	sp<IStreamIn> mStream;
	std::unique_ptr<CommandMQ> mCommandMQ;
	std::unique_ptr<DataMQ> mDataMQ;
	std::unique_ptr<StatusMQ> mStatusMQ;
	std::atomic<pid_t> mReaderClient;
	EventFlag* mEfGroup;

	// Can not be constructed directly by clients.
	StreamInHalHidl(const sp<IStreamIn>& stream);

	virtual ~StreamInHalHidl();

	using ReaderCallback = std::function<void(const ReadStatus& readStatus)>;
	status_t callReaderThread(
	const ReadParameters& params, const char* cmdName, ReaderCallback callback);
	status_t prepareForReading(size_t bufferSize);
	};

	} // namespace android

	#endif // ANDROID_HARDWARE_STREAM_HAL_HIDL_H