1 /*
2  * Copyright (C) 2016 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_HARDWARE_STREAM_HAL_HIDL_H
18 #define ANDROID_HARDWARE_STREAM_HAL_HIDL_H
19 
20 #include <atomic>
21 
22 #include PATH(android/hardware/audio/FILE_VERSION/IStream.h)
23 #include PATH(android/hardware/audio/FILE_VERSION/IStreamIn.h)
24 #include PATH(android/hardware/audio/FILE_VERSION/IStreamOut.h)
25 #include <fmq/EventFlag.h>
26 #include <fmq/MessageQueue.h>
27 #include <media/audiohal/StreamHalInterface.h>
28 
29 #include "ConversionHelperHidl.h"
30 #include "StreamPowerLog.h"
31 
32 using ::android::hardware::audio::CPP_VERSION::IStream;
33 using ::android::hardware::audio::CPP_VERSION::IStreamIn;
34 using ::android::hardware::audio::CPP_VERSION::IStreamOut;
35 using ::android::hardware::EventFlag;
36 using ::android::hardware::MessageQueue;
37 using ::android::hardware::Return;
38 using ReadParameters = ::android::hardware::audio::CPP_VERSION::IStreamIn::ReadParameters;
39 using ReadStatus = ::android::hardware::audio::CPP_VERSION::IStreamIn::ReadStatus;
40 using WriteCommand = ::android::hardware::audio::CPP_VERSION::IStreamOut::WriteCommand;
41 using WriteStatus = ::android::hardware::audio::CPP_VERSION::IStreamOut::WriteStatus;
42 
43 namespace android {
44 namespace CPP_VERSION {
45 
46 class DeviceHalHidl;
47 
48 class StreamHalHidl : public virtual StreamHalInterface, public ConversionHelperHidl
49 {
50   public:
51     // Return the sampling rate in Hz - eg. 44100.
52     virtual status_t getSampleRate(uint32_t *rate);
53 
54     // Return size of input/output buffer in bytes for this stream - eg. 4800.
55     virtual status_t getBufferSize(size_t *size);
56 
57     // Return the channel mask.
58     virtual status_t getChannelMask(audio_channel_mask_t *mask);
59 
60     // Return the audio format - e.g. AUDIO_FORMAT_PCM_16_BIT.
61     virtual status_t getFormat(audio_format_t *format);
62 
63     // Convenience method.
64     virtual status_t getAudioProperties(
65             uint32_t *sampleRate, audio_channel_mask_t *mask, audio_format_t *format);
66 
67     // Set audio stream parameters.
68     virtual status_t setParameters(const String8& kvPairs);
69 
70     // Get audio stream parameters.
71     virtual status_t getParameters(const String8& keys, String8 *values);
72 
73     // Add or remove the effect on the stream.
74     virtual status_t addEffect(sp<EffectHalInterface> effect);
75     virtual status_t removeEffect(sp<EffectHalInterface> effect);
76 
77     // Put the audio hardware input/output into standby mode.
78     virtual status_t standby();
79 
80     virtual status_t dump(int fd);
81 
82     // Start a stream operating in mmap mode.
83     virtual status_t start();
84 
85     // Stop a stream operating in mmap mode.
86     virtual status_t stop();
87 
88     // Retrieve information on the data buffer in mmap mode.
89     virtual status_t createMmapBuffer(int32_t minSizeFrames,
90                                       struct audio_mmap_buffer_info *info);
91 
92     // Get current read/write position in the mmap buffer
93     virtual status_t getMmapPosition(struct audio_mmap_position *position);
94 
95     // Set the priority of the thread that interacts with the HAL
96     // (must match the priority of the audioflinger's thread that calls 'read' / 'write')
97     virtual status_t setHalThreadPriority(int priority);
98 
99   protected:
100     // Subclasses can not be constructed directly by clients.
101     explicit StreamHalHidl(IStream *stream);
102 
103     // The destructor automatically closes the stream.
104     virtual ~StreamHalHidl();
105 
106     status_t getCachedBufferSize(size_t *size);
107 
108     bool requestHalThreadPriority(pid_t threadPid, pid_t threadId);
109 
110     // mStreamPowerLog is used for audio signal power logging.
111     StreamPowerLog mStreamPowerLog;
112 
113   private:
114     const int HAL_THREAD_PRIORITY_DEFAULT = -1;
115     IStream *mStream;
116     int mHalThreadPriority;
117     size_t mCachedBufferSize;
118 };
119 
120 class StreamOutHalHidl : public StreamOutHalInterface, public StreamHalHidl {
121   public:
122     // Return the frame size (number of bytes per sample) of a stream.
123     virtual status_t getFrameSize(size_t *size);
124 
125     // Return the audio hardware driver estimated latency in milliseconds.
126     virtual status_t getLatency(uint32_t *latency);
127 
128     // Use this method in situations where audio mixing is done in the hardware.
129     virtual status_t setVolume(float left, float right);
130 
131     // Selects the audio presentation (if available).
132     virtual status_t selectPresentation(int presentationId, int programId);
133 
134     // Write audio buffer to driver.
135     virtual status_t write(const void *buffer, size_t bytes, size_t *written);
136 
137     // Return the number of audio frames written by the audio dsp to DAC since
138     // the output has exited standby.
139     virtual status_t getRenderPosition(uint32_t *dspFrames);
140 
141     // Get the local time at which the next write to the audio driver will be presented.
142     virtual status_t getNextWriteTimestamp(int64_t *timestamp);
143 
144     // Set the callback for notifying completion of non-blocking write and drain.
145     virtual status_t setCallback(wp<StreamOutHalInterfaceCallback> callback);
146 
147     // Returns whether pause and resume operations are supported.
148     virtual status_t supportsPauseAndResume(bool *supportsPause, bool *supportsResume);
149 
150     // Notifies to the audio driver to resume playback following a pause.
151     virtual status_t pause();
152 
153     // Notifies to the audio driver to resume playback following a pause.
154     virtual status_t resume();
155 
156     // Returns whether drain operation is supported.
157     virtual status_t supportsDrain(bool *supportsDrain);
158 
159     // Requests notification when data buffered by the driver/hardware has been played.
160     virtual status_t drain(bool earlyNotify);
161 
162     // Notifies to the audio driver to flush the queued data.
163     virtual status_t flush();
164 
165     // Return a recent count of the number of audio frames presented to an external observer.
166     virtual status_t getPresentationPosition(uint64_t *frames, struct timespec *timestamp);
167 
168     // Called when the metadata of the stream's source has been changed.
169     status_t updateSourceMetadata(const SourceMetadata& sourceMetadata) override;
170 
171     // Methods used by StreamOutCallback (HIDL).
172     void onWriteReady();
173     void onDrainReady();
174     void onError();
175 
176     status_t setEventCallback(const sp<StreamOutHalInterfaceEventCallback>& callback) override;
177 
178     // Methods used by StreamCodecFormatCallback (HIDL).
179     void onCodecFormatChanged(const std::basic_string<uint8_t>& metadataBs);
180 
181   private:
182     friend class DeviceHalHidl;
183     typedef MessageQueue<WriteCommand, hardware::kSynchronizedReadWrite> CommandMQ;
184     typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
185     typedef MessageQueue<WriteStatus, hardware::kSynchronizedReadWrite> StatusMQ;
186 
187     wp<StreamOutHalInterfaceCallback> mCallback;
188     wp<StreamOutHalInterfaceEventCallback> mEventCallback;
189     sp<IStreamOut> mStream;
190     std::unique_ptr<CommandMQ> mCommandMQ;
191     std::unique_ptr<DataMQ> mDataMQ;
192     std::unique_ptr<StatusMQ> mStatusMQ;
193     std::atomic<pid_t> mWriterClient;
194     EventFlag* mEfGroup;
195 
196     // Can not be constructed directly by clients.
197     StreamOutHalHidl(const sp<IStreamOut>& stream);
198 
199     virtual ~StreamOutHalHidl();
200 
201     using WriterCallback = std::function<void(const WriteStatus& writeStatus)>;
202     status_t callWriterThread(
203             WriteCommand cmd, const char* cmdName,
204             const uint8_t* data, size_t dataSize, WriterCallback callback);
205     status_t prepareForWriting(size_t bufferSize);
206 };
207 
208 class StreamInHalHidl : public StreamInHalInterface, public StreamHalHidl {
209   public:
210     // Return the frame size (number of bytes per sample) of a stream.
211     virtual status_t getFrameSize(size_t *size);
212 
213     // Set the input gain for the audio driver.
214     virtual status_t setGain(float gain);
215 
216     // Read audio buffer in from driver.
217     virtual status_t read(void *buffer, size_t bytes, size_t *read);
218 
219     // Return the amount of input frames lost in the audio driver.
220     virtual status_t getInputFramesLost(uint32_t *framesLost);
221 
222     // Return a recent count of the number of audio frames received and
223     // the clock time associated with that frame count.
224     virtual status_t getCapturePosition(int64_t *frames, int64_t *time);
225 
226     // Get active microphones
227     virtual status_t getActiveMicrophones(std::vector<media::MicrophoneInfo> *microphones);
228 
229     // Set microphone direction (for processing)
230     virtual status_t setPreferredMicrophoneDirection(
231                             audio_microphone_direction_t direction) override;
232 
233     // Set microphone zoom (for processing)
234     virtual status_t setPreferredMicrophoneFieldDimension(float zoom) override;
235 
236     // Called when the metadata of the stream's sink has been changed.
237     status_t updateSinkMetadata(const SinkMetadata& sinkMetadata) override;
238 
239   private:
240     friend class DeviceHalHidl;
241     typedef MessageQueue<ReadParameters, hardware::kSynchronizedReadWrite> CommandMQ;
242     typedef MessageQueue<uint8_t, hardware::kSynchronizedReadWrite> DataMQ;
243     typedef MessageQueue<ReadStatus, hardware::kSynchronizedReadWrite> StatusMQ;
244 
245     sp<IStreamIn> mStream;
246     std::unique_ptr<CommandMQ> mCommandMQ;
247     std::unique_ptr<DataMQ> mDataMQ;
248     std::unique_ptr<StatusMQ> mStatusMQ;
249     std::atomic<pid_t> mReaderClient;
250     EventFlag* mEfGroup;
251 
252     // Can not be constructed directly by clients.
253     StreamInHalHidl(const sp<IStreamIn>& stream);
254 
255     virtual ~StreamInHalHidl();
256 
257     using ReaderCallback = std::function<void(const ReadStatus& readStatus)>;
258     status_t callReaderThread(
259             const ReadParameters& params, const char* cmdName, ReaderCallback callback);
260     status_t prepareForReading(size_t bufferSize);
261 };
262 
263 } // namespace CPP_VERSION
264 } // namespace android
265 
266 #endif // ANDROID_HARDWARE_STREAM_HAL_HIDL_H
267