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