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