Merge "AudioBufferProvider comments and cleanup"

gkasten · Android (Google) Code Review · commit 2b119a633606 · 2012-02-28T07:17:47.000-08:00
diff --git a/services/audioflinger/Android.mk b/services/audioflinger/Android.mk
@@ -7,7 +7,6 @@ LOCAL_SRC_FILES:=               \
     AudioMixer.cpp.arm          \
     AudioResampler.cpp.arm      \
     AudioPolicyService.cpp      \
-    AudioBufferProvider.cpp     \
     ServiceUtilities.cpp
 #   AudioResamplerSinc.cpp.arm
 #   AudioResamplerCubic.cpp.arm
diff --git a/services/audioflinger/AudioBufferProvider.cpp b/services/audioflinger/AudioBufferProvider.cpp
diff --git a/services/audioflinger/AudioBufferProvider.h b/services/audioflinger/AudioBufferProvider.h
@@ -17,8 +17,6 @@
 #ifndef ANDROID_AUDIO_BUFFER_PROVIDER_H
 #define ANDROID_AUDIO_BUFFER_PROVIDER_H
 
-#include <stdint.h>
-#include <sys/types.h>
 #include <utils/Errors.h>
 
 namespace android {
@@ -29,6 +27,7 @@ class AudioBufferProvider
 public:
 
     struct Buffer {
+        Buffer() : raw(NULL), frameCount(0) { }
         union {
             void*       raw;
             short*      i16;
@@ -40,12 +39,12 @@ class AudioBufferProvider
     virtual ~AudioBufferProvider() {}
 
     // value representing an invalid presentation timestamp
-    static const int64_t kInvalidPTS;
+    static const int64_t kInvalidPTS = 0x7FFFFFFFFFFFFFFFLL;    // <stdint.h> is too painful
 
     // pts is the local time when the next sample yielded by getNextBuffer
     // will be rendered.
     // Pass kInvalidPTS if the PTS is unknown or not applicable.
-    virtual status_t getNextBuffer(Buffer* buffer, int64_t pts) = 0;
+    virtual status_t getNextBuffer(Buffer* buffer, int64_t pts = kInvalidPTS) = 0;
 
     virtual void releaseBuffer(Buffer* buffer) = 0;
 };
diff --git a/services/audioflinger/AudioFlinger.cpp b/services/audioflinger/AudioFlinger.cpp
@@ -2909,8 +2909,7 @@ bool AudioFlinger::DirectOutputThread::threadLoop()
             // output audio to hardware
             while (frameCount) {
                 buffer.frameCount = frameCount;
-                activeTrack->getNextBuffer(&buffer,
-                                           AudioBufferProvider::kInvalidPTS);
+                activeTrack->getNextBuffer(&buffer);
                 if (CC_UNLIKELY(buffer.raw == NULL)) {
                     memset(curBuf, 0, frameCount * mFrameSize);
                     break;
@@ -3408,11 +3407,14 @@ AudioFlinger::ThreadBase::TrackBase::~TrackBase()
     }
 }
 
+// AudioBufferProvider interface
+// getNextBuffer() = 0;
+// This implementation of releaseBuffer() is used by Track and RecordTrack, but not TimedTrack
 void AudioFlinger::ThreadBase::TrackBase::releaseBuffer(AudioBufferProvider::Buffer* buffer)
 {
     buffer->raw = NULL;
     mFrameCount = buffer->frameCount;
-    step();
+    (void) step();      // ignore return value of step()
     buffer->frameCount = 0;
 }
 
@@ -3558,6 +3560,7 @@ void AudioFlinger::PlaybackThread::Track::dump(char* buffer, size_t size)
             (int)mAuxBuffer);
 }
 
+// AudioBufferProvider interface
 status_t AudioFlinger::PlaybackThread::Track::getNextBuffer(
     AudioBufferProvider::Buffer* buffer, int64_t pts)
 {
@@ -4106,6 +4109,7 @@ void AudioFlinger::PlaybackThread::TimedTrack::timedYieldSilence(
     mTimedAudioOutputOnTime = false;
 }
 
+// AudioBufferProvider interface
 void AudioFlinger::PlaybackThread::TimedTrack::releaseBuffer(
     AudioBufferProvider::Buffer* buffer) {
 
@@ -4190,6 +4194,7 @@ AudioFlinger::RecordThread::RecordTrack::~RecordTrack()
     }
 }
 
+// AudioBufferProvider interface
 status_t AudioFlinger::RecordThread::RecordTrack::getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts)
 {
     audio_track_cblk_t* cblk = this->cblk();
@@ -4877,8 +4882,7 @@ bool AudioFlinger::RecordThread::threadLoop()
             }
 
             buffer.frameCount = mFrameCount;
-            if (CC_LIKELY(mActiveTrack->getNextBuffer(
-                    &buffer, AudioBufferProvider::kInvalidPTS) == NO_ERROR)) {
+            if (CC_LIKELY(mActiveTrack->getNextBuffer(&buffer) == NO_ERROR)) {
                 size_t framesOut = buffer.frameCount;
                 if (mResampler == NULL) {
                     // no resampling
@@ -5155,6 +5159,7 @@ status_t AudioFlinger::RecordThread::dump(int fd, const Vector<String16>& args)
     return NO_ERROR;
 }
 
+// AudioBufferProvider interface
 status_t AudioFlinger::RecordThread::getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts)
 {
     size_t framesReq = buffer->frameCount;
@@ -5193,6 +5198,7 @@ status_t AudioFlinger::RecordThread::getNextBuffer(AudioBufferProvider::Buffer*
     return NO_ERROR;
 }
 
+// AudioBufferProvider interface
 void AudioFlinger::RecordThread::releaseBuffer(AudioBufferProvider::Buffer* buffer)
 {
     mRsmpInIndex += buffer->frameCount;
diff --git a/services/audioflinger/AudioFlinger.h b/services/audioflinger/AudioFlinger.h
@@ -339,9 +339,8 @@ class AudioFlinger :
                                 TrackBase(const TrackBase&);
                                 TrackBase& operator = (const TrackBase&);
 
-            virtual status_t getNextBuffer(
-                AudioBufferProvider::Buffer* buffer,
-                int64_t pts) = 0;
+            // AudioBufferProvider interface
+            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts) = 0;
             virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
 
             audio_format_t format() const {
@@ -627,9 +626,10 @@ class AudioFlinger :
                                 Track(const Track&);
                                 Track& operator = (const Track&);
 
-            virtual status_t getNextBuffer(
-                AudioBufferProvider::Buffer* buffer,
-                int64_t pts);
+            // AudioBufferProvider interface
+            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts = kInvalidPTS);
+            // releaseBuffer() not overridden
+
             virtual uint32_t framesReady() const;
 
             bool isMuted() const { return mMute; }
@@ -696,9 +696,10 @@ class AudioFlinger :
 
             virtual uint32_t framesReady() const;
 
-            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer,
-                                           int64_t pts);
+            // AudioBufferProvider interface
+            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts);
             virtual void releaseBuffer(AudioBufferProvider::Buffer* buffer);
+
             void timedYieldSamples(AudioBufferProvider::Buffer* buffer);
             void timedYieldSilence(uint32_t numFrames,
                                    AudioBufferProvider::Buffer* buffer);
@@ -1062,9 +1063,9 @@ class AudioFlinger :
                                 RecordTrack(const RecordTrack&);
                                 RecordTrack& operator = (const RecordTrack&);
 
-            virtual status_t getNextBuffer(
-                AudioBufferProvider::Buffer* buffer,
-                int64_t pts);
+            // AudioBufferProvider interface
+            virtual status_t getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts = kInvalidPTS);
+            // releaseBuffer() not overridden
 
             bool                mOverflow;
         };
@@ -1100,9 +1101,10 @@ class AudioFlinger :
                 AudioStreamIn* clearInput();
                 virtual audio_stream_t* stream();
 
-        virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer,
-                                          int64_t pts);
+        // AudioBufferProvider interface
+        virtual status_t    getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts);
         virtual void        releaseBuffer(AudioBufferProvider::Buffer* buffer);
+
         virtual bool        checkForNewParameters_l();
         virtual String8     getParameters(const String8& keys);
         virtual void        audioConfigChanged_l(int event, int param = 0);
diff --git a/services/audioflinger/AudioMixer.cpp b/services/audioflinger/AudioMixer.cpp
@@ -332,11 +332,11 @@ size_t AudioMixer::getUnreleasedFrames(int name) const
     return 0;
 }
 
-void AudioMixer::setBufferProvider(int name, AudioBufferProvider* buffer)
+void AudioMixer::setBufferProvider(int name, AudioBufferProvider* bufferProvider)
 {
     name -= TRACK0;
     assert(uint32_t(name) < MAX_NUM_TRACKS);
-    mState.tracks[name].bufferProvider = buffer;
+    mState.tracks[name].bufferProvider = bufferProvider;
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -2909,8 +2909,7 @@ bool AudioFlinger::DirectOutputThread::threadLoop()`
`2909`	`2909`	`// output audio to hardware`
`2910`	`2910`	`while (frameCount) {`
`2911`	`2911`	`buffer.frameCount = frameCount;`
`2912`		`- activeTrack->getNextBuffer(&buffer,`
`2913`		`- AudioBufferProvider::kInvalidPTS);`
	`2912`	`+ activeTrack->getNextBuffer(&buffer);`
`2914`	`2913`	`if (CC_UNLIKELY(buffer.raw == NULL)) {`
`2915`	`2914`	`memset(curBuf, 0, frameCount * mFrameSize);`
`2916`	`2915`	`break;`
`@@ -3408,11 +3407,14 @@ AudioFlinger::ThreadBase::TrackBase::~TrackBase()`
`3408`	`3407`	`}`
`3409`	`3408`	`}`
`3410`	`3409`
	`3410`	`+// AudioBufferProvider interface`
	`3411`	`+// getNextBuffer() = 0;`
	`3412`	`+// This implementation of releaseBuffer() is used by Track and RecordTrack, but not TimedTrack`
`3411`	`3413`	`void AudioFlinger::ThreadBase::TrackBase::releaseBuffer(AudioBufferProvider::Buffer* buffer)`
`3412`	`3414`	`{`
`3413`	`3415`	`buffer->raw = NULL;`
`3414`	`3416`	`mFrameCount = buffer->frameCount;`
`3415`		`- step();`
	`3417`	`+ (void) step(); // ignore return value of step()`
`3416`	`3418`	`buffer->frameCount = 0;`
`3417`	`3419`	`}`
`3418`	`3420`
`@@ -3558,6 +3560,7 @@ void AudioFlinger::PlaybackThread::Track::dump(char* buffer, size_t size)`
`3558`	`3560`	`(int)mAuxBuffer);`
`3559`	`3561`	`}`
`3560`	`3562`
	`3563`	`+// AudioBufferProvider interface`
`3561`	`3564`	`status_t AudioFlinger::PlaybackThread::Track::getNextBuffer(`
`3562`	`3565`	`AudioBufferProvider::Buffer* buffer, int64_t pts)`
`3563`	`3566`	`{`
`@@ -4106,6 +4109,7 @@ void AudioFlinger::PlaybackThread::TimedTrack::timedYieldSilence(`
`4106`	`4109`	`mTimedAudioOutputOnTime = false;`
`4107`	`4110`	`}`
`4108`	`4111`
	`4112`	`+// AudioBufferProvider interface`
`4109`	`4113`	`void AudioFlinger::PlaybackThread::TimedTrack::releaseBuffer(`
`4110`	`4114`	`AudioBufferProvider::Buffer* buffer) {`
`4111`	`4115`
`@@ -4190,6 +4194,7 @@ AudioFlinger::RecordThread::RecordTrack::~RecordTrack()`
`4190`	`4194`	`}`
`4191`	`4195`	`}`
`4192`	`4196`
	`4197`	`+// AudioBufferProvider interface`
`4193`	`4198`	`status_t AudioFlinger::RecordThread::RecordTrack::getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts)`
`4194`	`4199`	`{`
`4195`	`4200`	`audio_track_cblk_t* cblk = this->cblk();`
`@@ -4877,8 +4882,7 @@ bool AudioFlinger::RecordThread::threadLoop()`
`4877`	`4882`	`}`
`4878`	`4883`
`4879`	`4884`	`buffer.frameCount = mFrameCount;`
`4880`		`- if (CC_LIKELY(mActiveTrack->getNextBuffer(`
`4881`		`- &buffer, AudioBufferProvider::kInvalidPTS) == NO_ERROR)) {`
	`4885`	`+ if (CC_LIKELY(mActiveTrack->getNextBuffer(&buffer) == NO_ERROR)) {`
`4882`	`4886`	`size_t framesOut = buffer.frameCount;`
`4883`	`4887`	`if (mResampler == NULL) {`
`4884`	`4888`	`// no resampling`
`@@ -5155,6 +5159,7 @@ status_t AudioFlinger::RecordThread::dump(int fd, const Vector<String16>& args)`
`5155`	`5159`	`return NO_ERROR;`
`5156`	`5160`	`}`
`5157`	`5161`
	`5162`	`+// AudioBufferProvider interface`
`5158`	`5163`	`status_t AudioFlinger::RecordThread::getNextBuffer(AudioBufferProvider::Buffer* buffer, int64_t pts)`
`5159`	`5164`	`{`
`5160`	`5165`	`size_t framesReq = buffer->frameCount;`
`@@ -5193,6 +5198,7 @@ status_t AudioFlinger::RecordThread::getNextBuffer(AudioBufferProvider::Buffer*`
`5193`	`5198`	`return NO_ERROR;`
`5194`	`5199`	`}`
`5195`	`5200`
	`5201`	`+// AudioBufferProvider interface`
`5196`	`5202`	`void AudioFlinger::RecordThread::releaseBuffer(AudioBufferProvider::Buffer* buffer)`
`5197`	`5203`	`{`
`5198`	`5204`	`mRsmpInIndex += buffer->frameCount;`
Original file line number	Diff line number	Diff line change
`@@ -332,11 +332,11 @@ size_t AudioMixer::getUnreleasedFrames(int name) const`
`332`	`332`	`return 0;`
`333`	`333`	`}`
`334`	`334`
`335`		`-void AudioMixer::setBufferProvider(int name, AudioBufferProvider* buffer)`
	`335`	`+void AudioMixer::setBufferProvider(int name, AudioBufferProvider* bufferProvider)`
`336`	`336`	`{`
`337`	`337`	`name -= TRACK0;`
`338`	`338`	`assert(uint32_t(name) < MAX_NUM_TRACKS);`
`339`		`- mState.tracks[name].bufferProvider = buffer;`
	`339`	`+ mState.tracks[name].bufferProvider = bufferProvider;`
`340`	`340`	`}`
`341`	`341`
`342`	`342`