1 /* 2 ** 3 ** Copyright 2012, The Android Open Source Project 4 ** 5 ** Licensed under the Apache License, Version 2.0 (the "License"); 6 ** you may not use this file except in compliance with the License. 7 ** You may obtain a copy of the License at 8 ** 9 ** http://www.apache.org/licenses/LICENSE-2.0 10 ** 11 ** Unless required by applicable law or agreed to in writing, software 12 ** distributed under the License is distributed on an "AS IS" BASIS, 13 ** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 ** See the License for the specific language governing permissions and 15 ** limitations under the License. 16 */ 17 18 #ifndef INCLUDING_FROM_AUDIOFLINGER_H 19 #error This header file should only be included from AudioFlinger.h 20 #endif 21 22 // base for record and playback 23 class TrackBase : public ExtendedAudioBufferProvider, public RefBase { 24 25 public: 26 enum track_state { 27 IDLE, 28 FLUSHED, // for PlaybackTracks only 29 STOPPED, 30 // next 2 states are currently used for fast tracks 31 // and offloaded tracks only 32 STOPPING_1, // waiting for first underrun 33 STOPPING_2, // waiting for presentation complete 34 RESUMING, // for PlaybackTracks only 35 ACTIVE, 36 PAUSING, 37 PAUSED, 38 STARTING_1, // for RecordTrack only 39 STARTING_2, // for RecordTrack only 40 }; 41 42 // where to allocate the data buffer 43 enum alloc_type { 44 ALLOC_CBLK, // allocate immediately after control block 45 ALLOC_READONLY, // allocate from a separate read-only heap per thread 46 ALLOC_PIPE, // do not allocate; use the pipe buffer 47 ALLOC_LOCAL, // allocate a local buffer 48 ALLOC_NONE, // do not allocate:use the buffer passed to TrackBase constructor 49 }; 50 51 enum track_type { 52 TYPE_DEFAULT, 53 TYPE_OUTPUT, 54 TYPE_PATCH, 55 }; 56 57 TrackBase(ThreadBase *thread, 58 const sp<Client>& client, 59 const audio_attributes_t& mAttr, 60 uint32_t sampleRate, 61 audio_format_t format, 62 audio_channel_mask_t channelMask, 63 size_t frameCount, 64 void *buffer, 65 size_t bufferSize, 66 audio_session_t sessionId, 67 pid_t creatorPid, 68 uid_t uid, 69 bool isOut, 70 alloc_type alloc = ALLOC_CBLK, 71 track_type type = TYPE_DEFAULT, 72 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE, 73 std::string metricsId = {}); 74 virtual ~TrackBase(); 75 virtual status_t initCheck() const; 76 77 virtual status_t start(AudioSystem::sync_event_t event, 78 audio_session_t triggerSession) = 0; 79 virtual void stop() = 0; getCblk()80 sp<IMemory> getCblk() const { return mCblkMemory; } cblk()81 audio_track_cblk_t* cblk() const { return mCblk; } sessionId()82 audio_session_t sessionId() const { return mSessionId; } uid()83 uid_t uid() const { return mUid; } creatorPid()84 pid_t creatorPid() const { return mCreatorPid; } 85 portId()86 audio_port_handle_t portId() const { return mPortId; } 87 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 88 getBuffers()89 sp<IMemory> getBuffers() const { return mBufferMemory; } buffer()90 void* buffer() const { return mBuffer; } bufferSize()91 size_t bufferSize() const { return mBufferSize; } 92 virtual bool isFastTrack() const = 0; 93 virtual bool isDirect() const = 0; isOutputTrack()94 bool isOutputTrack() const { return (mType == TYPE_OUTPUT); } isPatchTrack()95 bool isPatchTrack() const { return (mType == TYPE_PATCH); } isExternalTrack()96 bool isExternalTrack() const { return !isOutputTrack() && !isPatchTrack(); } 97 invalidate()98 virtual void invalidate() { 99 if (mIsInvalid) return; 100 mTrackMetrics.logInvalidate(); 101 mIsInvalid = true; 102 } isInvalid()103 bool isInvalid() const { return mIsInvalid; } 104 terminate()105 void terminate() { mTerminated = true; } isTerminated()106 bool isTerminated() const { return mTerminated; } 107 attributes()108 audio_attributes_t attributes() const { return mAttr; } 109 110 #ifdef TEE_SINK dumpTee(int fd,const std::string & reason)111 void dumpTee(int fd, const std::string &reason) const { 112 mTee.dump(fd, reason); 113 } 114 #endif 115 116 /** returns the buffer contents size converted to time in milliseconds 117 * for PCM Playback or Record streaming tracks. The return value is zero for 118 * PCM static tracks and not defined for non-PCM tracks. 119 * 120 * This may be called without the thread lock. 121 */ bufferLatencyMs()122 virtual double bufferLatencyMs() const { 123 return mServerProxy->framesReadySafe() * 1000 / sampleRate(); 124 } 125 126 /** returns whether the track supports server latency computation. 127 * This is set in the constructor and constant throughout the track lifetime. 128 */ 129 isServerLatencySupported()130 bool isServerLatencySupported() const { return mServerLatencySupported; } 131 132 /** computes the server latency for PCM Playback or Record track 133 * to the device sink/source. This is the time for the next frame in the track buffer 134 * written or read from the server thread to the device source or sink. 135 * 136 * This may be called without the thread lock, but latencyMs and fromTrack 137 * may be not be synchronized. For example PatchPanel may not obtain the 138 * thread lock before calling. 139 * 140 * \param latencyMs on success is set to the latency in milliseconds of the 141 * next frame written/read by the server thread to/from the track buffer 142 * from the device source/sink. 143 * \param fromTrack on success is set to true if latency was computed directly 144 * from the track timestamp; otherwise set to false if latency was 145 * estimated from the server timestamp. 146 * fromTrack may be nullptr or omitted if not required. 147 * 148 * \returns OK or INVALID_OPERATION on failure. 149 */ 150 status_t getServerLatencyMs(double *latencyMs, bool *fromTrack = nullptr) const { 151 if (!isServerLatencySupported()) { 152 return INVALID_OPERATION; 153 } 154 155 // if no thread lock is acquired, these atomics are not 156 // synchronized with each other, considered a benign race. 157 158 const double serverLatencyMs = mServerLatencyMs.load(); 159 if (serverLatencyMs == 0.) { 160 return INVALID_OPERATION; 161 } 162 if (fromTrack != nullptr) { 163 *fromTrack = mServerLatencyFromTrack.load(); 164 } 165 *latencyMs = serverLatencyMs; 166 return OK; 167 } 168 169 /** computes the total client latency for PCM Playback or Record tracks 170 * for the next client app access to the device sink/source; i.e. the 171 * server latency plus the buffer latency. 172 * 173 * This may be called without the thread lock, but latencyMs and fromTrack 174 * may be not be synchronized. For example PatchPanel may not obtain the 175 * thread lock before calling. 176 * 177 * \param latencyMs on success is set to the latency in milliseconds of the 178 * next frame written/read by the client app to/from the track buffer 179 * from the device sink/source. 180 * \param fromTrack on success is set to true if latency was computed directly 181 * from the track timestamp; otherwise set to false if latency was 182 * estimated from the server timestamp. 183 * fromTrack may be nullptr or omitted if not required. 184 * 185 * \returns OK or INVALID_OPERATION on failure. 186 */ 187 status_t getTrackLatencyMs(double *latencyMs, bool *fromTrack = nullptr) const { 188 double serverLatencyMs; 189 status_t status = getServerLatencyMs(&serverLatencyMs, fromTrack); 190 if (status == OK) { 191 *latencyMs = serverLatencyMs + bufferLatencyMs(); 192 } 193 return status; 194 } 195 196 // TODO: Consider making this external. 197 struct FrameTime { 198 int64_t frames; 199 int64_t timeNs; 200 }; 201 202 // KernelFrameTime is updated per "mix" period even for non-pcm tracks. getKernelFrameTime(FrameTime * ft)203 void getKernelFrameTime(FrameTime *ft) const { 204 *ft = mKernelFrameTime.load(); 205 } 206 format()207 audio_format_t format() const { return mFormat; } id()208 int id() const { return mId; } 209 getTrackStateAsString()210 const char *getTrackStateAsString() const { 211 if (isTerminated()) { 212 return "TERMINATED"; 213 } 214 switch (mState) { 215 case IDLE: 216 return "IDLE"; 217 case STOPPING_1: // for Fast and Offload 218 return "STOPPING_1"; 219 case STOPPING_2: // for Fast and Offload 220 return "STOPPING_2"; 221 case STOPPED: 222 return "STOPPED"; 223 case RESUMING: 224 return "RESUMING"; 225 case ACTIVE: 226 return "ACTIVE"; 227 case PAUSING: 228 return "PAUSING"; 229 case PAUSED: 230 return "PAUSED"; 231 case FLUSHED: 232 return "FLUSHED"; 233 case STARTING_1: // for RecordTrack 234 return "STARTING_1"; 235 case STARTING_2: // for RecordTrack 236 return "STARTING_2"; 237 default: 238 return "UNKNOWN"; 239 } 240 } 241 242 // Called by the PlaybackThread to indicate that the track is becoming active 243 // and a new interval should start with a given device list. logBeginInterval(const std::string & devices)244 void logBeginInterval(const std::string& devices) { 245 mTrackMetrics.logBeginInterval(devices); 246 } 247 248 // Called by the PlaybackThread to indicate the track is no longer active. logEndInterval()249 void logEndInterval() { 250 mTrackMetrics.logEndInterval(); 251 } 252 253 // Called to tally underrun frames in playback. tallyUnderrunFrames(size_t)254 virtual void tallyUnderrunFrames(size_t /* frames */) {} 255 channelMask()256 audio_channel_mask_t channelMask() const { return mChannelMask; } 257 258 /** @return true if the track has changed (metadata or volume) since 259 * the last time this function was called, 260 * true if this function was never called since the track creation, 261 * false otherwise. 262 * Thread safe. 263 */ readAndClearHasChanged()264 bool readAndClearHasChanged() { return !mChangeNotified.test_and_set(); } 265 266 /** Set that a metadata has changed and needs to be notified to backend. Thread safe. */ setMetadataHasChanged()267 void setMetadataHasChanged() { mChangeNotified.clear(); } 268 269 protected: 270 DISALLOW_COPY_AND_ASSIGN(TrackBase); 271 releaseCblk()272 void releaseCblk() { 273 if (mCblk != nullptr) { 274 mCblk->~audio_track_cblk_t(); // destroy our shared-structure. 275 if (mClient == 0) { 276 free(mCblk); 277 } 278 mCblk = nullptr; 279 } 280 } 281 282 // AudioBufferProvider interface 283 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0; 284 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 285 286 // ExtendedAudioBufferProvider interface is only needed for Track, 287 // but putting it in TrackBase avoids the complexity of virtual inheritance framesReady()288 virtual size_t framesReady() const { return SIZE_MAX; } 289 channelCount()290 uint32_t channelCount() const { return mChannelCount; } 291 frameSize()292 size_t frameSize() const { return mFrameSize; } 293 sampleRate()294 virtual uint32_t sampleRate() const { return mSampleRate; } 295 isStopped()296 bool isStopped() const { 297 return (mState == STOPPED || mState == FLUSHED); 298 } 299 300 // for fast tracks and offloaded tracks only isStopping()301 bool isStopping() const { 302 return mState == STOPPING_1 || mState == STOPPING_2; 303 } isStopping_1()304 bool isStopping_1() const { 305 return mState == STOPPING_1; 306 } isStopping_2()307 bool isStopping_2() const { 308 return mState == STOPPING_2; 309 } 310 311 // Upper case characters are final states. 312 // Lower case characters are transitory. getTrackStateAsCodedString()313 const char *getTrackStateAsCodedString() const { 314 if (isTerminated()) { 315 return "T "; 316 } 317 switch (mState) { 318 case IDLE: 319 return "I "; 320 case STOPPING_1: // for Fast and Offload 321 return "s1"; 322 case STOPPING_2: // for Fast and Offload 323 return "s2"; 324 case STOPPED: 325 return "S "; 326 case RESUMING: 327 return "r "; 328 case ACTIVE: 329 return "A "; 330 case PAUSING: 331 return "p "; 332 case PAUSED: 333 return "P "; 334 case FLUSHED: 335 return "F "; 336 case STARTING_1: // for RecordTrack 337 return "r1"; 338 case STARTING_2: // for RecordTrack 339 return "r2"; 340 default: 341 return "? "; 342 } 343 } 344 isOut()345 bool isOut() const { return mIsOut; } 346 // true for Track, false for RecordTrack, 347 // this could be a track type if needed later 348 349 const wp<ThreadBase> mThread; 350 /*const*/ sp<Client> mClient; // see explanation at ~TrackBase() why not const 351 sp<IMemory> mCblkMemory; 352 audio_track_cblk_t* mCblk; 353 sp<IMemory> mBufferMemory; // currently non-0 for fast RecordTrack only 354 void* mBuffer; // start of track buffer, typically in shared memory 355 // except for OutputTrack when it is in local memory 356 size_t mBufferSize; // size of mBuffer in bytes 357 // we don't really need a lock for these 358 track_state mState; 359 const audio_attributes_t mAttr; 360 const uint32_t mSampleRate; // initial sample rate only; for tracks which 361 // support dynamic rates, the current value is in control block 362 const audio_format_t mFormat; 363 const audio_channel_mask_t mChannelMask; 364 const uint32_t mChannelCount; 365 const size_t mFrameSize; // AudioFlinger's view of frame size in shared memory, 366 // where for AudioTrack (but not AudioRecord), 367 // 8-bit PCM samples are stored as 16-bit 368 const size_t mFrameCount;// size of track buffer given at createTrack() or 369 // createRecord(), and then adjusted as needed 370 371 const audio_session_t mSessionId; 372 uid_t mUid; 373 Vector < sp<SyncEvent> >mSyncEvents; 374 const bool mIsOut; 375 sp<ServerProxy> mServerProxy; 376 const int mId; 377 #ifdef TEE_SINK 378 NBAIO_Tee mTee; 379 #endif 380 bool mTerminated; 381 track_type mType; // must be one of TYPE_DEFAULT, TYPE_OUTPUT, TYPE_PATCH ... 382 audio_io_handle_t mThreadIoHandle; // I/O handle of the thread the track is attached to 383 audio_port_handle_t mPortId; // unique ID for this track used by audio policy 384 bool mIsInvalid; // non-resettable latch, set by invalidate() 385 386 // It typically takes 5 threadloop mix iterations for latency to stabilize. 387 // However, this can be 12+ iterations for BT. 388 // To be sure, we wait for latency to dip (it usually increases at the start) 389 // to assess stability and then log to MediaMetrics. 390 // Rapid start / pause calls may cause inaccurate numbers. 391 static inline constexpr int32_t LOG_START_COUNTDOWN = 12; 392 int32_t mLogStartCountdown = 0; // Mixer period countdown 393 int64_t mLogStartTimeNs = 0; // Monotonic time at start() 394 int64_t mLogStartFrames = 0; // Timestamp frames at start() 395 double mLogLatencyMs = 0.; // Track the last log latency 396 397 TrackMetrics mTrackMetrics; 398 399 bool mServerLatencySupported = false; 400 std::atomic<bool> mServerLatencyFromTrack{}; // latency from track or server timestamp. 401 std::atomic<double> mServerLatencyMs{}; // last latency pushed from server thread. 402 std::atomic<FrameTime> mKernelFrameTime{}; // last frame time on kernel side. 403 const pid_t mCreatorPid; // can be different from mclient->pid() for instance 404 // when created by NuPlayer on behalf of a client 405 406 // If the last track change was notified to the client with readAndClearHasChanged 407 std::atomic_flag mChangeNotified = ATOMIC_FLAG_INIT; 408 }; 409 410 // PatchProxyBufferProvider interface is implemented by PatchTrack and PatchRecord. 411 // it provides buffer access methods that map those of a ClientProxy (see AudioTrackShared.h) 412 class PatchProxyBufferProvider 413 { 414 public: 415 ~PatchProxyBufferProvider()416 virtual ~PatchProxyBufferProvider() {} 417 418 virtual bool producesBufferOnDemand() const = 0; 419 virtual status_t obtainBuffer(Proxy::Buffer* buffer, 420 const struct timespec *requested = NULL) = 0; 421 virtual void releaseBuffer(Proxy::Buffer* buffer) = 0; 422 }; 423 424 class PatchTrackBase : public PatchProxyBufferProvider 425 { 426 public: 427 using Timeout = std::optional<std::chrono::nanoseconds>; 428 PatchTrackBase(sp<ClientProxy> proxy, const ThreadBase& thread, 429 const Timeout& timeout); 430 void setPeerTimeout(std::chrono::nanoseconds timeout); 431 template <typename T> setPeerProxy(const sp<T> & proxy,bool holdReference)432 void setPeerProxy(const sp<T> &proxy, bool holdReference) { 433 mPeerReferenceHold = holdReference ? proxy : nullptr; 434 mPeerProxy = proxy.get(); 435 } clearPeerProxy()436 void clearPeerProxy() { 437 mPeerReferenceHold.clear(); 438 mPeerProxy = nullptr; 439 } 440 producesBufferOnDemand()441 bool producesBufferOnDemand() const override { return false; } 442 443 protected: 444 const sp<ClientProxy> mProxy; 445 sp<RefBase> mPeerReferenceHold; // keeps mPeerProxy alive during access. 446 PatchProxyBufferProvider* mPeerProxy = nullptr; 447 struct timespec mPeerTimeout{}; 448 449 }; 450