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