1 /* 2 * Copyright (C) 2017 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 AAUDIO_SERVICE_ENDPOINT_H 18 #define AAUDIO_SERVICE_ENDPOINT_H 19 20 #include <atomic> 21 #include <functional> 22 #include <mutex> 23 #include <vector> 24 25 #include "client/AudioStreamInternal.h" 26 #include "client/AudioStreamInternalPlay.h" 27 #include "core/AAudioStreamParameters.h" 28 #include "binding/AAudioServiceMessage.h" 29 #include "binding/AAudioStreamConfiguration.h" 30 31 #include "AAudioServiceStreamBase.h" 32 33 namespace aaudio { 34 35 /** 36 * AAudioServiceEndpoint is used by a subclass of AAudioServiceStreamBase 37 * to communicate with the underlying audio device or port. 38 */ 39 class AAudioServiceEndpoint 40 : public virtual android::RefBase 41 , public AAudioStreamParameters { 42 public: 43 44 virtual ~AAudioServiceEndpoint() = default; 45 46 virtual std::string dump() const; 47 48 virtual aaudio_result_t open(const aaudio::AAudioStreamRequest &request) = 0; 49 50 /* 51 * Perform any cleanup necessary before deleting the stream. 52 * This might include releasing and closing internal streams. 53 */ 54 virtual void close() = 0; 55 56 aaudio_result_t registerStream(android::sp<AAudioServiceStreamBase> stream); 57 58 aaudio_result_t unregisterStream(android::sp<AAudioServiceStreamBase> stream); 59 60 virtual aaudio_result_t startStream(android::sp<AAudioServiceStreamBase> stream, 61 audio_port_handle_t *clientHandle) = 0; 62 63 virtual aaudio_result_t stopStream(android::sp<AAudioServiceStreamBase> stream, 64 audio_port_handle_t clientHandle) = 0; 65 startClient(const android::AudioClient & client,const audio_attributes_t * attr,audio_port_handle_t * clientHandle)66 virtual aaudio_result_t startClient(const android::AudioClient& client, 67 const audio_attributes_t *attr, 68 audio_port_handle_t *clientHandle) { 69 ALOGD("AAudioServiceEndpoint::startClient(...) AAUDIO_ERROR_UNAVAILABLE"); 70 return AAUDIO_ERROR_UNAVAILABLE; 71 } 72 stopClient(audio_port_handle_t clientHandle)73 virtual aaudio_result_t stopClient(audio_port_handle_t clientHandle) { 74 ALOGD("AAudioServiceEndpoint::stopClient(...) AAUDIO_ERROR_UNAVAILABLE"); 75 return AAUDIO_ERROR_UNAVAILABLE; 76 } 77 78 /** 79 * @param positionFrames 80 * @param timeNanos 81 * @return AAUDIO_OK or AAUDIO_ERROR_UNAVAILABLE or other negative error 82 */ 83 virtual aaudio_result_t getFreeRunningPosition(int64_t *positionFrames, int64_t *timeNanos) = 0; 84 85 /** 86 * Set time that the associated frame was presented to the hardware. 87 * 88 * @param positionFrames receive position, input value is ignored 89 * @param timeNanos receive time, input value is ignored 90 * @return AAUDIO_OK or AAUDIO_ERROR_UNAVAILABLE or other negative error 91 */ 92 virtual aaudio_result_t getTimestamp(int64_t *positionFrames, int64_t *timeNanos) = 0; 93 getFramesPerBurst()94 int32_t getFramesPerBurst() const { 95 return mFramesPerBurst; 96 } 97 getRequestedDeviceId()98 int32_t getRequestedDeviceId() const { return mRequestedDeviceId; } 99 100 bool matches(const AAudioStreamConfiguration& configuration); 101 102 // This should only be called from the AAudioEndpointManager under a mutex. getOpenCount()103 int32_t getOpenCount() const { 104 return mOpenCount; 105 } 106 107 // This should only be called from the AAudioEndpointManager under a mutex. setOpenCount(int32_t count)108 void setOpenCount(int32_t count) { 109 mOpenCount = count; 110 } 111 isConnected()112 bool isConnected() const { 113 return mConnected; 114 } 115 116 static audio_attributes_t getAudioAttributesFrom(const AAudioStreamParameters *params); 117 118 // Stop, disconnect and release any streams registered on this endpoint. 119 void releaseRegisteredStreams(); 120 isForSharing()121 bool isForSharing() const { 122 return mForSharing; 123 } 124 125 /** 126 * 127 * @param flag true if this endpoint is to be shared between multiple streams 128 */ setForSharing(bool flag)129 void setForSharing(bool flag) { 130 mForSharing = flag; 131 } 132 133 protected: 134 135 /** 136 * @param portHandle 137 * @return return true if a stream with the given portHandle is registered 138 */ 139 bool isStreamRegistered(audio_port_handle_t portHandle); 140 141 std::vector<android::sp<AAudioServiceStreamBase>> disconnectRegisteredStreams(); 142 143 mutable std::mutex mLockStreams; 144 std::vector<android::sp<AAudioServiceStreamBase>> mRegisteredStreams; 145 146 SimpleDoubleBuffer<Timestamp> mAtomicEndpointTimestamp; 147 148 android::AudioClient mMmapClient; // set in open, used in open and startStream 149 150 int32_t mFramesPerBurst = 0; 151 int32_t mOpenCount = 0; 152 int32_t mRequestedDeviceId = 0; 153 154 // True if this will be shared by one or more other streams. 155 bool mForSharing = false; 156 157 std::atomic<bool> mConnected{true}; 158 159 }; 160 161 } /* namespace aaudio */ 162 163 164 #endif //AAUDIO_SERVICE_ENDPOINT_H 165