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