1/*
2 * Copyright (C) 2014 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_AUDIO_FAST_MIXER_DUMP_STATE_H
18#define ANDROID_AUDIO_FAST_MIXER_DUMP_STATE_H
19
20#include <stdint.h>
21#include "Configuration.h"
22#include "FastThreadDumpState.h"
23#include "FastMixerState.h"
24
25namespace android {
26
27// Describes the underrun status for a single "pull" attempt
28enum FastTrackUnderrunStatus {
29    UNDERRUN_FULL,      // framesReady() is full frame count, no underrun
30    UNDERRUN_PARTIAL,   // framesReady() is non-zero but < full frame count, partial underrun
31    UNDERRUN_EMPTY,     // framesReady() is zero, total underrun
32};
33
34// Underrun counters are not reset to zero for new tracks or if track generation changes.
35// This packed representation is used to keep the information atomic.
36union FastTrackUnderruns {
37    FastTrackUnderruns() { mAtomic = 0;
38            static_assert(sizeof(FastTrackUnderruns) == sizeof(uint32_t), "FastTrackUnderrun"); }
39    FastTrackUnderruns(const FastTrackUnderruns& copyFrom) : mAtomic(copyFrom.mAtomic) { }
40    FastTrackUnderruns& operator=(const FastTrackUnderruns& rhs)
41            { if (this != &rhs) mAtomic = rhs.mAtomic; return *this; }
42    struct {
43#define UNDERRUN_BITS 10
44#define UNDERRUN_MASK ((1 << UNDERRUN_BITS) - 1)
45        uint32_t mFull    : UNDERRUN_BITS; // framesReady() is full frame count
46        uint32_t mPartial : UNDERRUN_BITS; // framesReady() is non-zero but < full frame count
47        uint32_t mEmpty   : UNDERRUN_BITS; // framesReady() is zero
48        FastTrackUnderrunStatus mMostRecent : 2;    // status of most recent framesReady()
49    }        mBitFields;
50private:
51    uint32_t mAtomic;
52};
53
54// Represents the dump state of a fast track
55struct FastTrackDump {
56    FastTrackDump() : mFramesReady(0) { }
57    /*virtual*/ ~FastTrackDump() { }
58    FastTrackUnderruns  mUnderruns;
59    size_t              mFramesReady;        // most recent value only; no long-term statistics kept
60    int64_t             mFramesWritten;      // last value from track
61};
62
63struct FastMixerDumpState : FastThreadDumpState {
64    FastMixerDumpState();
65    /*virtual*/ ~FastMixerDumpState();
66
67    void dump(int fd) const;    // should only be called on a stable copy, not the original
68
69    uint32_t mWriteSequence;    // incremented before and after each write()
70    uint32_t mFramesWritten;    // total number of frames written successfully
71    uint32_t mNumTracks;        // total number of active fast tracks
72    uint32_t mWriteErrors;      // total number of write() errors
73    uint32_t mSampleRate;
74    size_t   mFrameCount;
75    uint32_t mTrackMask;        // mask of active tracks
76    FastTrackDump   mTracks[FastMixerState::kMaxFastTracks];
77};
78
79}   // android
80
81#endif  // ANDROID_AUDIO_FAST_MIXER_DUMP_STATE_H
82