12234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten/* 22234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * Copyright (C) 2014 The Android Open Source Project 32234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * 42234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * Licensed under the Apache License, Version 2.0 (the "License"); 52234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * you may not use this file except in compliance with the License. 62234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * You may obtain a copy of the License at 72234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * 82234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * http://www.apache.org/licenses/LICENSE-2.0 92234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * 102234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * Unless required by applicable law or agreed to in writing, software 112234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * distributed under the License is distributed on an "AS IS" BASIS, 122234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 132234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * See the License for the specific language governing permissions and 142234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten * limitations under the License. 152234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten */ 162234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 172234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#ifndef ANDROID_AUDIO_FAST_MIXER_DUMP_STATE_H 182234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#define ANDROID_AUDIO_FAST_MIXER_DUMP_STATE_H 192234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 202234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#include "Configuration.h" 212234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 222234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastennamespace android { 232234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 242234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// Describes the underrun status for a single "pull" attempt 252234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastenenum FastTrackUnderrunStatus { 262234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten UNDERRUN_FULL, // framesReady() is full frame count, no underrun 272234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten UNDERRUN_PARTIAL, // framesReady() is non-zero but < full frame count, partial underrun 282234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten UNDERRUN_EMPTY, // framesReady() is zero, total underrun 292234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten}; 302234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 312234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// Underrun counters are not reset to zero for new tracks or if track generation changes. 322234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// This packed representation is used to keep the information atomic. 332234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastenunion FastTrackUnderruns { 342234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackUnderruns() { mAtomic = 0; 352234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten COMPILE_TIME_ASSERT_FUNCTION_SCOPE(sizeof(FastTrackUnderruns) == sizeof(uint32_t)); } 362234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackUnderruns(const FastTrackUnderruns& copyFrom) : mAtomic(copyFrom.mAtomic) { } 372234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackUnderruns& operator=(const FastTrackUnderruns& rhs) 382234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten { if (this != &rhs) mAtomic = rhs.mAtomic; return *this; } 392234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten struct { 402234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#define UNDERRUN_BITS 10 412234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#define UNDERRUN_MASK ((1 << UNDERRUN_BITS) - 1) 422234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mFull : UNDERRUN_BITS; // framesReady() is full frame count 432234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mPartial : UNDERRUN_BITS; // framesReady() is non-zero but < full frame count 442234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mEmpty : UNDERRUN_BITS; // framesReady() is zero 452234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackUnderrunStatus mMostRecent : 2; // status of most recent framesReady() 462234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten } mBitFields; 472234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastenprivate: 482234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mAtomic; 492234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten}; 502234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 512234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// Represents the dump state of a fast track 522234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastenstruct FastTrackDump { 532234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackDump() : mFramesReady(0) { } 542234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten /*virtual*/ ~FastTrackDump() { } 552234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackUnderruns mUnderruns; 562234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten size_t mFramesReady; // most recent value only; no long-term statistics kept 572234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten}; 582234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 592234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// The FastMixerDumpState keeps a cache of FastMixer statistics that can be logged by dumpsys. 602234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// Each individual native word-sized field is accessed atomically. But the 612234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// overall structure is non-atomic, that is there may be an inconsistency between fields. 622234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// No barriers or locks are used for either writing or reading. 632234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// Only POD types are permitted, and the contents shouldn't be trusted (i.e. do range checks). 642234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten// It has a different lifetime than the FastMixer, and so it can't be a member of FastMixer. 652234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kastenstruct FastMixerDumpState : FastThreadDumpState { 662234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastMixerDumpState( 672234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#ifdef FAST_MIXER_STATISTICS 682234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t samplingN = kSamplingNforLowRamDevice 692234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#endif 702234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten ); 712234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten /*virtual*/ ~FastMixerDumpState(); 722234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 732234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten void dump(int fd) const; // should only be called on a stable copy, not the original 742234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 752234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mWriteSequence; // incremented before and after each write() 762234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mFramesWritten; // total number of frames written successfully 772234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mNumTracks; // total number of active fast tracks 782234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mWriteErrors; // total number of write() errors 792234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mSampleRate; 802234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten size_t mFrameCount; 812234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten uint32_t mTrackMask; // mask of active tracks 822234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten FastTrackDump mTracks[FastMixerState::kMaxFastTracks]; 832234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 842234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#ifdef FAST_MIXER_STATISTICS 852234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten // Compile-time constant for a "low RAM device", must be a power of 2 <= kSamplingN. 862234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten // This value was chosen such that each array uses 1 small page (4 Kbytes). 872234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten static const uint32_t kSamplingNforLowRamDevice = 0x400; 882234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten // Increase sampling window after construction, must be a power of 2 <= kSamplingN 892234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten void increaseSamplingN(uint32_t samplingN); 902234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#endif 912234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten}; 922234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 932234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten} // android 942234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten 952234002b0710c8db73f82d397cb945cd541c6bbbGlenn Kasten#endif // ANDROID_AUDIO_FAST_MIXER_DUMP_STATE_H 96