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    // where to allocate the data buffer
43    enum alloc_type {
44        ALLOC_CBLK,     // allocate immediately after control block
45        ALLOC_READONLY, // allocate from a separate read-only heap per thread
46        ALLOC_PIPE,     // do not allocate; use the pipe buffer
47        ALLOC_LOCAL,    // allocate a local buffer
48        ALLOC_NONE,     // do not allocate:use the buffer passed to TrackBase constructor
49    };
50
51    enum track_type {
52        TYPE_DEFAULT,
53        TYPE_OUTPUT,
54        TYPE_PATCH,
55    };
56
57                        TrackBase(ThreadBase *thread,
58                                const sp<Client>& client,
59                                uint32_t sampleRate,
60                                audio_format_t format,
61                                audio_channel_mask_t channelMask,
62                                size_t frameCount,
63                                void *buffer,
64                                audio_session_t sessionId,
65                                int uid,
66                                IAudioFlinger::track_flags_t flags,
67                                bool isOut,
68                                alloc_type alloc = ALLOC_CBLK,
69                                track_type type = TYPE_DEFAULT);
70    virtual             ~TrackBase();
71    virtual status_t    initCheck() const;
72
73    virtual status_t    start(AudioSystem::sync_event_t event,
74                             audio_session_t triggerSession) = 0;
75    virtual void        stop() = 0;
76            sp<IMemory> getCblk() const { return mCblkMemory; }
77            audio_track_cblk_t* cblk() const { return mCblk; }
78            audio_session_t sessionId() const { return mSessionId; }
79            int         uid() const { return mUid; }
80    virtual status_t    setSyncEvent(const sp<SyncEvent>& event);
81
82            sp<IMemory> getBuffers() const { return mBufferMemory; }
83            void*       buffer() const { return mBuffer; }
84            bool        isFastTrack() const { return (mFlags & IAudioFlinger::TRACK_FAST) != 0; }
85            bool        isOutputTrack() const { return (mType == TYPE_OUTPUT); }
86            bool        isPatchTrack() const { return (mType == TYPE_PATCH); }
87            bool        isExternalTrack() const { return !isOutputTrack() && !isPatchTrack(); }
88
89protected:
90                        TrackBase(const TrackBase&);
91                        TrackBase& operator = (const TrackBase&);
92
93    // AudioBufferProvider interface
94    virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0;
95    virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
96
97    // ExtendedAudioBufferProvider interface is only needed for Track,
98    // but putting it in TrackBase avoids the complexity of virtual inheritance
99    virtual size_t  framesReady() const { return SIZE_MAX; }
100
101    audio_format_t format() const { return mFormat; }
102
103    uint32_t channelCount() const { return mChannelCount; }
104
105    audio_channel_mask_t channelMask() const { return mChannelMask; }
106
107    virtual uint32_t sampleRate() const { return mSampleRate; }
108
109    bool isStopped() const {
110        return (mState == STOPPED || mState == FLUSHED);
111    }
112
113    // for fast tracks and offloaded tracks only
114    bool isStopping() const {
115        return mState == STOPPING_1 || mState == STOPPING_2;
116    }
117    bool isStopping_1() const {
118        return mState == STOPPING_1;
119    }
120    bool isStopping_2() const {
121        return mState == STOPPING_2;
122    }
123
124    bool isTerminated() const {
125        return mTerminated;
126    }
127
128    void terminate() {
129        mTerminated = true;
130    }
131
132    bool isOut() const { return mIsOut; }
133                                    // true for Track, false for RecordTrack,
134                                    // this could be a track type if needed later
135
136    const wp<ThreadBase> mThread;
137    /*const*/ sp<Client> mClient;   // see explanation at ~TrackBase() why not const
138    sp<IMemory>         mCblkMemory;
139    audio_track_cblk_t* mCblk;
140    sp<IMemory>         mBufferMemory;  // currently non-0 for fast RecordTrack only
141    void*               mBuffer;    // start of track buffer, typically in shared memory
142                                    // except for OutputTrack when it is in local memory
143    // we don't really need a lock for these
144    track_state         mState;
145    const uint32_t      mSampleRate;    // initial sample rate only; for tracks which
146                        // support dynamic rates, the current value is in control block
147    const audio_format_t mFormat;
148    const audio_channel_mask_t mChannelMask;
149    const uint32_t      mChannelCount;
150    const size_t        mFrameSize; // AudioFlinger's view of frame size in shared memory,
151                                    // where for AudioTrack (but not AudioRecord),
152                                    // 8-bit PCM samples are stored as 16-bit
153    const size_t        mFrameCount;// size of track buffer given at createTrack() or
154                                    // openRecord(), and then adjusted as needed
155
156    const audio_session_t mSessionId;
157    int                 mUid;
158    Vector < sp<SyncEvent> >mSyncEvents;
159    const IAudioFlinger::track_flags_t mFlags;
160    const bool          mIsOut;
161    ServerProxy*        mServerProxy;
162    const int           mId;
163    sp<NBAIO_Sink>      mTeeSink;
164    sp<NBAIO_Source>    mTeeSource;
165    bool                mTerminated;
166    track_type          mType;      // must be one of TYPE_DEFAULT, TYPE_OUTPUT, TYPE_PATCH ...
167    audio_io_handle_t   mThreadIoHandle; // I/O handle of the thread the track is attached to
168};
169
170// PatchProxyBufferProvider interface is implemented by PatchTrack and PatchRecord.
171// it provides buffer access methods that map those of a ClientProxy (see AudioTrackShared.h)
172class PatchProxyBufferProvider
173{
174public:
175
176    virtual ~PatchProxyBufferProvider() {}
177
178    virtual status_t    obtainBuffer(Proxy::Buffer* buffer,
179                                     const struct timespec *requested = NULL) = 0;
180    virtual void        releaseBuffer(Proxy::Buffer* buffer) = 0;
181};
182