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#include <common/all-versions/IncludeGuard.h>
18
19#include <atomic>
20#include <memory>
21
22#include <fmq/EventFlag.h>
23#include <fmq/MessageQueue.h>
24#include <hidl/MQDescriptor.h>
25#include <hidl/Status.h>
26#include <utils/Thread.h>
27
28namespace android {
29namespace hardware {
30namespace audio {
31namespace AUDIO_HAL_VERSION {
32namespace implementation {
33
34using ::android::hardware::audio::common::AUDIO_HAL_VERSION::AudioChannelMask;
35using ::android::hardware::audio::common::AUDIO_HAL_VERSION::AudioDevice;
36using ::android::hardware::audio::common::AUDIO_HAL_VERSION::AudioFormat;
37using ::android::hardware::audio::AUDIO_HAL_VERSION::AudioDrain;
38using ::android::hardware::audio::AUDIO_HAL_VERSION::DeviceAddress;
39using ::android::hardware::audio::AUDIO_HAL_VERSION::IStream;
40using ::android::hardware::audio::AUDIO_HAL_VERSION::IStreamOut;
41using ::android::hardware::audio::AUDIO_HAL_VERSION::IStreamOutCallback;
42using ::android::hardware::audio::AUDIO_HAL_VERSION::ParameterValue;
43using ::android::hardware::audio::AUDIO_HAL_VERSION::Result;
44using ::android::hardware::audio::AUDIO_HAL_VERSION::TimeSpec;
45using ::android::hardware::Return;
46using ::android::hardware::Void;
47using ::android::hardware::hidl_vec;
48using ::android::hardware::hidl_string;
49using ::android::sp;
50
51struct StreamOut : public IStreamOut {
52    typedef MessageQueue<WriteCommand, kSynchronizedReadWrite> CommandMQ;
53    typedef MessageQueue<uint8_t, kSynchronizedReadWrite> DataMQ;
54    typedef MessageQueue<WriteStatus, kSynchronizedReadWrite> StatusMQ;
55
56    StreamOut(const sp<Device>& device, audio_stream_out_t* stream);
57
58    // Methods from ::android::hardware::audio::AUDIO_HAL_VERSION::IStream follow.
59    Return<uint64_t> getFrameSize() override;
60    Return<uint64_t> getFrameCount() override;
61    Return<uint64_t> getBufferSize() override;
62    Return<uint32_t> getSampleRate() override;
63#ifdef AUDIO_HAL_VERSION_2_0
64    Return<void> getSupportedSampleRates(getSupportedSampleRates_cb _hidl_cb) override;
65    Return<void> getSupportedChannelMasks(getSupportedChannelMasks_cb _hidl_cb) override;
66#endif
67    Return<void> getSupportedSampleRates(AudioFormat format, getSupportedSampleRates_cb _hidl_cb);
68    Return<void> getSupportedChannelMasks(AudioFormat format, getSupportedChannelMasks_cb _hidl_cb);
69    Return<Result> setSampleRate(uint32_t sampleRateHz) override;
70    Return<AudioChannelBitfield> getChannelMask() override;
71    Return<Result> setChannelMask(AudioChannelBitfield mask) override;
72    Return<AudioFormat> getFormat() override;
73    Return<void> getSupportedFormats(getSupportedFormats_cb _hidl_cb) override;
74    Return<Result> setFormat(AudioFormat format) override;
75    Return<void> getAudioProperties(getAudioProperties_cb _hidl_cb) override;
76    Return<Result> addEffect(uint64_t effectId) override;
77    Return<Result> removeEffect(uint64_t effectId) override;
78    Return<Result> standby() override;
79#ifdef AUDIO_HAL_VERSION_2_0
80    Return<AudioDevice> getDevice() override;
81    Return<Result> setDevice(const DeviceAddress& address) override;
82    Return<void> getParameters(const hidl_vec<hidl_string>& keys,
83                               getParameters_cb _hidl_cb) override;
84    Return<Result> setParameters(const hidl_vec<ParameterValue>& parameters) override;
85    Return<Result> setConnectedState(const DeviceAddress& address, bool connected) override;
86#elif defined(AUDIO_HAL_VERSION_4_0)
87    Return<void> getDevices(getDevices_cb _hidl_cb) override;
88    Return<Result> setDevices(const hidl_vec<DeviceAddress>& devices) override;
89    Return<void> getParameters(const hidl_vec<ParameterValue>& context,
90                               const hidl_vec<hidl_string>& keys,
91                               getParameters_cb _hidl_cb) override;
92    Return<Result> setParameters(const hidl_vec<ParameterValue>& context,
93                                 const hidl_vec<ParameterValue>& parameters) override;
94#endif
95    Return<Result> setHwAvSync(uint32_t hwAvSync) override;
96    Return<Result> close() override;
97
98    Return<void> debug(const hidl_handle& fd, const hidl_vec<hidl_string>& options) override;
99#ifdef AUDIO_HAL_VERSION_2_0
100    Return<void> debugDump(const hidl_handle& fd) override;
101#endif
102
103    // Methods from ::android::hardware::audio::AUDIO_HAL_VERSION::IStreamOut follow.
104    Return<uint32_t> getLatency() override;
105    Return<Result> setVolume(float left, float right) override;
106    Return<void> prepareForWriting(uint32_t frameSize, uint32_t framesCount,
107                                   prepareForWriting_cb _hidl_cb) override;
108    Return<void> getRenderPosition(getRenderPosition_cb _hidl_cb) override;
109    Return<void> getNextWriteTimestamp(getNextWriteTimestamp_cb _hidl_cb) override;
110    Return<Result> setCallback(const sp<IStreamOutCallback>& callback) override;
111    Return<Result> clearCallback() override;
112    Return<void> supportsPauseAndResume(supportsPauseAndResume_cb _hidl_cb) override;
113    Return<Result> pause() override;
114    Return<Result> resume() override;
115    Return<bool> supportsDrain() override;
116    Return<Result> drain(AudioDrain type) override;
117    Return<Result> flush() override;
118    Return<void> getPresentationPosition(getPresentationPosition_cb _hidl_cb) override;
119    Return<Result> start() override;
120    Return<Result> stop() override;
121    Return<void> createMmapBuffer(int32_t minSizeFrames, createMmapBuffer_cb _hidl_cb) override;
122    Return<void> getMmapPosition(getMmapPosition_cb _hidl_cb) override;
123#ifdef AUDIO_HAL_VERSION_4_0
124    Return<void> updateSourceMetadata(const SourceMetadata& sourceMetadata) override;
125    Return<Result> selectPresentation(int32_t presentationId, int32_t programId) override;
126#endif
127
128    static Result getPresentationPositionImpl(audio_stream_out_t* stream, uint64_t* frames,
129                                              TimeSpec* timeStamp);
130
131   private:
132    bool mIsClosed;
133    const sp<Device> mDevice;
134    audio_stream_out_t* mStream;
135    const sp<Stream> mStreamCommon;
136    const sp<StreamMmap<audio_stream_out_t>> mStreamMmap;
137    sp<IStreamOutCallback> mCallback;
138    std::unique_ptr<CommandMQ> mCommandMQ;
139    std::unique_ptr<DataMQ> mDataMQ;
140    std::unique_ptr<StatusMQ> mStatusMQ;
141    EventFlag* mEfGroup;
142    std::atomic<bool> mStopWriteThread;
143    sp<Thread> mWriteThread;
144
145    virtual ~StreamOut();
146
147    static int asyncCallback(stream_callback_event_t event, void* param, void* cookie);
148};
149
150}  // namespace implementation
151}  // namespace AUDIO_HAL_VERSION
152}  // namespace audio
153}  // namespace hardware
154}  // namespace android
155