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