TrackBase.h revision 755b0a611f539dfa49e88aac592a938427c7e1b8 
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
23class TrackBase : public ExtendedAudioBufferProvider, public RefBase {
24
25public:
26    enum track_state {
27        IDLE,
28        FLUSHED,
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,
35        ACTIVE,
36        PAUSING,
37        PAUSED,
38        STARTING_1,     // for RecordTrack only
39        STARTING_2,     // for RecordTrack only
40    };
41
42                        TrackBase(ThreadBase *thread,
43                                const sp<Client>& client,
44                                uint32_t sampleRate,
45                                audio_format_t format,
46                                audio_channel_mask_t channelMask,
47                                size_t frameCount,
48                                const sp<IMemory>& sharedBuffer,
49                                int sessionId,
50                                int uid,
51                                IAudioFlinger::track_flags_t flags,
52                                bool isOut,
53                                bool useReadOnlyHeap = false);
54    virtual             ~TrackBase();
55    virtual status_t    initCheck() const { return getCblk() != 0 ? NO_ERROR : NO_MEMORY; }
56
57    virtual status_t    start(AudioSystem::sync_event_t event,
58                             int triggerSession) = 0;
59    virtual void        stop() = 0;
60            sp<IMemory> getCblk() const { return mCblkMemory; }
61            audio_track_cblk_t* cblk() const { return mCblk; }
62            int         sessionId() const { return mSessionId; }
63            int         uid() const { return mUid; }
64    virtual status_t    setSyncEvent(const sp<SyncEvent>& event);
65
66            sp<IMemory> getBuffers() const { return mBufferMemory; }
67            bool        isFastTrack() const { return (mFlags & IAudioFlinger::TRACK_FAST) != 0; }
68
69protected:
70                        TrackBase(const TrackBase&);
71                        TrackBase& operator = (const TrackBase&);
72
73    // AudioBufferProvider interface
74    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts) = 0;
75    virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
76
77    // ExtendedAudioBufferProvider interface is only needed for Track,
78    // but putting it in TrackBase avoids the complexity of virtual inheritance
79    virtual size_t  framesReady() const { return SIZE_MAX; }
80
81    audio_format_t format() const { return mFormat; }
82
83    uint32_t channelCount() const { return mChannelCount; }
84
85    audio_channel_mask_t channelMask() const { return mChannelMask; }
86
87    virtual uint32_t sampleRate() const { return mSampleRate; }
88
89    bool isStopped() const {
90        return (mState == STOPPED || mState == FLUSHED);
91    }
92
93    // for fast tracks and offloaded tracks only
94    bool isStopping() const {
95        return mState == STOPPING_1 || mState == STOPPING_2;
96    }
97    bool isStopping_1() const {
98        return mState == STOPPING_1;
99    }
100    bool isStopping_2() const {
101        return mState == STOPPING_2;
102    }
103
104    bool isTerminated() const {
105        return mTerminated;
106    }
107
108    void terminate() {
109        mTerminated = true;
110    }
111
112    bool isOut() const { return mIsOut; }
113                                    // true for Track and TimedTrack, false for RecordTrack,
114                                    // this could be a track type if needed later
115
116    const wp<ThreadBase> mThread;
117    /*const*/ sp<Client> mClient;   // see explanation at ~TrackBase() why not const
118    sp<IMemory>         mCblkMemory;
119    audio_track_cblk_t* mCblk;
120    sp<IMemory>         mBufferMemory;  // currently non-0 for fast RecordTrack only
121    void*               mBuffer;    // start of track buffer, typically in shared memory
122                                    // except for OutputTrack when it is in local memory
123    // we don't really need a lock for these
124    track_state         mState;
125    const uint32_t      mSampleRate;    // initial sample rate only; for tracks which
126                        // support dynamic rates, the current value is in control block
127    const audio_format_t mFormat;
128    const audio_channel_mask_t mChannelMask;
129    const uint32_t      mChannelCount;
130    const size_t        mFrameSize; // AudioFlinger's view of frame size in shared memory,
131                                    // where for AudioTrack (but not AudioRecord),
132                                    // 8-bit PCM samples are stored as 16-bit
133    const size_t        mFrameCount;// size of track buffer given at createTrack() or
134                                    // openRecord(), and then adjusted as needed
135
136    const int           mSessionId;
137    int                 mUid;
138    Vector < sp<SyncEvent> >mSyncEvents;
139    const IAudioFlinger::track_flags_t mFlags;
140    const bool          mIsOut;
141    ServerProxy*        mServerProxy;
142    const int           mId;
143    sp<NBAIO_Sink>      mTeeSink;
144    sp<NBAIO_Source>    mTeeSource;
145    bool                mTerminated;
146};
147