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 23 class TrackBase : public ExtendedAudioBufferProvider, public RefBase { 24 25 public: 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 size_t bufferSize, 65 audio_session_t sessionId, 66 uid_t uid, 67 bool isOut, 68 alloc_type alloc = ALLOC_CBLK, 69 track_type type = TYPE_DEFAULT, 70 audio_port_handle_t portId = AUDIO_PORT_HANDLE_NONE); 71 virtual ~TrackBase(); 72 virtual status_t initCheck() const; 73 74 virtual status_t start(AudioSystem::sync_event_t event, 75 audio_session_t triggerSession) = 0; 76 virtual void stop() = 0; getCblk()77 sp<IMemory> getCblk() const { return mCblkMemory; } cblk()78 audio_track_cblk_t* cblk() const { return mCblk; } sessionId()79 audio_session_t sessionId() const { return mSessionId; } uid()80 uid_t uid() const { return mUid; } portId()81 audio_port_handle_t portId() const { return mPortId; } 82 virtual status_t setSyncEvent(const sp<SyncEvent>& event); 83 getBuffers()84 sp<IMemory> getBuffers() const { return mBufferMemory; } buffer()85 void* buffer() const { return mBuffer; } bufferSize()86 size_t bufferSize() const { return mBufferSize; } 87 virtual bool isFastTrack() const = 0; isOutputTrack()88 bool isOutputTrack() const { return (mType == TYPE_OUTPUT); } isPatchTrack()89 bool isPatchTrack() const { return (mType == TYPE_PATCH); } isExternalTrack()90 bool isExternalTrack() const { return !isOutputTrack() && !isPatchTrack(); } 91 invalidate()92 virtual void invalidate() { mIsInvalid = true; } isInvalid()93 bool isInvalid() const { return mIsInvalid; } 94 95 96 protected: 97 DISALLOW_COPY_AND_ASSIGN(TrackBase); 98 99 // AudioBufferProvider interface 100 virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer) = 0; 101 virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer); 102 103 // ExtendedAudioBufferProvider interface is only needed for Track, 104 // but putting it in TrackBase avoids the complexity of virtual inheritance framesReady()105 virtual size_t framesReady() const { return SIZE_MAX; } 106 format()107 audio_format_t format() const { return mFormat; } 108 channelCount()109 uint32_t channelCount() const { return mChannelCount; } 110 channelMask()111 audio_channel_mask_t channelMask() const { return mChannelMask; } 112 sampleRate()113 virtual uint32_t sampleRate() const { return mSampleRate; } 114 isStopped()115 bool isStopped() const { 116 return (mState == STOPPED || mState == FLUSHED); 117 } 118 119 // for fast tracks and offloaded tracks only isStopping()120 bool isStopping() const { 121 return mState == STOPPING_1 || mState == STOPPING_2; 122 } isStopping_1()123 bool isStopping_1() const { 124 return mState == STOPPING_1; 125 } isStopping_2()126 bool isStopping_2() const { 127 return mState == STOPPING_2; 128 } 129 isTerminated()130 bool isTerminated() const { 131 return mTerminated; 132 } 133 terminate()134 void terminate() { 135 mTerminated = true; 136 } 137 138 // Upper case characters are final states. 139 // Lower case characters are transitory. getTrackStateString()140 const char *getTrackStateString() const { 141 if (isTerminated()) { 142 return "T "; 143 } 144 switch (mState) { 145 case IDLE: 146 return "I "; 147 case STOPPING_1: // for Fast and Offload 148 return "s1"; 149 case STOPPING_2: // for Fast and Offload 150 return "s2"; 151 case STOPPED: 152 return "S "; 153 case RESUMING: 154 return "r "; 155 case ACTIVE: 156 return "A "; 157 case PAUSING: 158 return "p "; 159 case PAUSED: 160 return "P "; 161 case FLUSHED: 162 return "F "; 163 case STARTING_1: // for RecordTrack 164 return "r1"; 165 case STARTING_2: // for RecordTrack 166 return "r2"; 167 default: 168 return "? "; 169 } 170 } 171 isOut()172 bool isOut() const { return mIsOut; } 173 // true for Track, false for RecordTrack, 174 // this could be a track type if needed later 175 176 const wp<ThreadBase> mThread; 177 /*const*/ sp<Client> mClient; // see explanation at ~TrackBase() why not const 178 sp<IMemory> mCblkMemory; 179 audio_track_cblk_t* mCblk; 180 sp<IMemory> mBufferMemory; // currently non-0 for fast RecordTrack only 181 void* mBuffer; // start of track buffer, typically in shared memory 182 // except for OutputTrack when it is in local memory 183 size_t mBufferSize; // size of mBuffer in bytes 184 // we don't really need a lock for these 185 track_state mState; 186 const uint32_t mSampleRate; // initial sample rate only; for tracks which 187 // support dynamic rates, the current value is in control block 188 const audio_format_t mFormat; 189 const audio_channel_mask_t mChannelMask; 190 const uint32_t mChannelCount; 191 const size_t mFrameSize; // AudioFlinger's view of frame size in shared memory, 192 // where for AudioTrack (but not AudioRecord), 193 // 8-bit PCM samples are stored as 16-bit 194 const size_t mFrameCount;// size of track buffer given at createTrack() or 195 // openRecord(), and then adjusted as needed 196 197 const audio_session_t mSessionId; 198 uid_t mUid; 199 Vector < sp<SyncEvent> >mSyncEvents; 200 const bool mIsOut; 201 sp<ServerProxy> mServerProxy; 202 const int mId; 203 sp<NBAIO_Sink> mTeeSink; 204 sp<NBAIO_Source> mTeeSource; 205 bool mTerminated; 206 track_type mType; // must be one of TYPE_DEFAULT, TYPE_OUTPUT, TYPE_PATCH ... 207 audio_io_handle_t mThreadIoHandle; // I/O handle of the thread the track is attached to 208 audio_port_handle_t mPortId; // unique ID for this track used by audio policy 209 bool mIsInvalid; // non-resettable latch, set by invalidate() 210 }; 211 212 // PatchProxyBufferProvider interface is implemented by PatchTrack and PatchRecord. 213 // it provides buffer access methods that map those of a ClientProxy (see AudioTrackShared.h) 214 class PatchProxyBufferProvider 215 { 216 public: 217 ~PatchProxyBufferProvider()218 virtual ~PatchProxyBufferProvider() {} 219 220 virtual status_t obtainBuffer(Proxy::Buffer* buffer, 221 const struct timespec *requested = NULL) = 0; 222 virtual void releaseBuffer(Proxy::Buffer* buffer) = 0; 223 }; 224