Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8cd5ba4b authored by Jamie Gennis's avatar Jamie Gennis
Browse files

SurfaceTexture: clean up some comments, tests, etc. 

This change fixes up some stale comments, member variable names, log
messages and disables a failing test.

Change-Id: Ic1d3344b18066cf710e4a42838b2417c6b1f2f6c
parent d9584858

include/gui/SurfaceTexture.h

+45 −20
Original line number Diff line number Diff line
@@ -197,8 +197,9 @@ private: 
              mEglDisplay(EGL_NO_DISPLAY),

              mBufferState(BufferSlot::FREE),

              mRequestBufferCalled(false),

              mLastQueuedTransform(0),

              mLastQueuedTimestamp(0) {

              mTransform(0),

              mTimestamp(0) {

            mCrop.makeInvalid();

        }



        // mGraphicBuffer points to the buffer allocated for this slot or is NULL
@@ -211,32 +212,56 @@ private: 
        // mEglDisplay is the EGLDisplay used to create mEglImage.

        EGLDisplay mEglDisplay;



        // mBufferState indicates whether the slot is currently accessible to a

        // client and should not be used by the SurfaceTexture object. It gets

        // set to true when dequeueBuffer returns the slot and is reset to false

        // when the client calls either queueBuffer or cancelBuffer on the slot.

        enum { DEQUEUED=-2, FREE=-1, QUEUED=0 };

        int8_t mBufferState;

        // BufferState represents the different states in which a buffer slot

        // can be.

        enum BufferState {

            // FREE indicates that the buffer is not currently being used and

            // will not be used in the future until it gets dequeued and

            // subseqently queued by the client.

            FREE = 0,



            // DEQUEUED indicates that the buffer has been dequeued by the

            // client, but has not yet been queued or canceled. The buffer is

            // considered 'owned' by the client, and the server should not use

            // it for anything.

            //

            // Note that when in synchronous-mode (mSynchronousMode == true),

            // the buffer that's currently attached to the texture may be

            // dequeued by the client.  That means that the current buffer can

            // be in either the DEQUEUED or QUEUED state.  In asynchronous mode,

            // however, the current buffer is always in the QUEUED state.

            DEQUEUED = 1,



            // QUEUED indicates that the buffer has been queued by the client,

            // and has not since been made available for the client to dequeue.

            // Attaching the buffer to the texture does NOT transition the

            // buffer away from the QUEUED state. However, in Synchronous mode

            // the current buffer may be dequeued by the client under some

            // circumstances. See the note about the current buffer in the

            // documentation for DEQUEUED.

            QUEUED = 2,

        };



        // mBufferState is the current state of this buffer slot.

        BufferState mBufferState;



        // mRequestBufferCalled is used for validating that the client did

        // call requestBuffer() when told to do so. Technically this is not

        // needed but useful for debugging and catching client bugs.

        bool mRequestBufferCalled;



        // mLastQueuedCrop is the crop rectangle for the buffer that was most

        // recently queued. This gets set to mNextCrop each time queueBuffer gets

        // called.

        Rect mLastQueuedCrop;

        // mCrop is the current crop rectangle for this buffer slot. This gets

        // set to mNextCrop each time queueBuffer gets called for this buffer.

        Rect mCrop;



        // mLastQueuedTransform is the transform identifier for the buffer that was

        // most recently queued. This gets set to mNextTransform each time

        // queueBuffer gets called.

        uint32_t mLastQueuedTransform;

        // mTransform is the current transform flags for this buffer slot. This

        // gets set to mNextTransform each time queueBuffer gets called for this

        // slot.

        uint32_t mTransform;



        // mLastQueuedTimestamp is the timestamp for the buffer that was most

        // recently queued. This gets set by queueBuffer.

        int64_t mLastQueuedTimestamp;

        // mTimestamp is the current timestamp for this buffer slot. This gets

        // to set by queueBuffer each time this slot is queued.

        int64_t mTimestamp;

    };



    // mSlots is the array of buffer slots that must be mirrored on the client

libs/gui/SurfaceTexture.cpp

+43 −45
Original line number Diff line number Diff line
@@ -403,8 +403,8 @@ status_t SurfaceTexture::queueBuffer(int buf, int64_t timestamp) { 
            LOGE("queueBuffer: slot %d is current!", buf);

            return -EINVAL;

        } else if (!mSlots[buf].mRequestBufferCalled) {

        LOGE("queueBuffer: slot %d was enqueued without requesting a buffer",

                buf);

            LOGE("queueBuffer: slot %d was enqueued without requesting a "

                    "buffer", buf);

            return -EINVAL;

        }
@@ -429,9 +429,9 @@ status_t SurfaceTexture::queueBuffer(int buf, int64_t timestamp) { 
        }



        mSlots[buf].mBufferState = BufferSlot::QUEUED;

    mSlots[buf].mLastQueuedCrop = mNextCrop;

    mSlots[buf].mLastQueuedTransform = mNextTransform;

    mSlots[buf].mLastQueuedTimestamp = timestamp;

        mSlots[buf].mCrop = mNextCrop;

        mSlots[buf].mTransform = mNextTransform;

        mSlots[buf].mTimestamp = timestamp;

        mDequeueCondition.signal();

    } // scope for the lock
@@ -540,9 +540,9 @@ status_t SurfaceTexture::updateTexImage() { 
        mCurrentTexture = buf;

        mCurrentTextureTarget = target;

        mCurrentTextureBuf = mSlots[buf].mGraphicBuffer;

        mCurrentCrop = mSlots[buf].mLastQueuedCrop;

        mCurrentTransform = mSlots[buf].mLastQueuedTransform;

        mCurrentTimestamp = mSlots[buf].mLastQueuedTimestamp;

        mCurrentCrop = mSlots[buf].mCrop;

        mCurrentTransform = mSlots[buf].mTransform;

        mCurrentTimestamp = mSlots[buf].mTimestamp;

        mDequeueCondition.signal();

    } else {

        // We always bind the texture even if we don't update its contents.
@@ -826,12 +826,10 @@ void SurfaceTexture::dump(String8& result, const char* prefix, 
        const BufferSlot& slot(mSlots[i]);

        snprintf(buffer, SIZE,

                "%s%s[%02d] state=%-8s, crop=[%d,%d,%d,%d], transform=0x%02x, "

                "timestamp=%lld\n"

                ,

                "timestamp=%lld\n",

                prefix, (i==mCurrentTexture)?">":" ", i, stateName(slot.mBufferState),

                slot.mLastQueuedCrop.left, slot.mLastQueuedCrop.top,

                slot.mLastQueuedCrop.right, slot.mLastQueuedCrop.bottom,

                slot.mLastQueuedTransform, slot.mLastQueuedTimestamp

                slot.mCrop.left, slot.mCrop.top, slot.mCrop.right, slot.mCrop.bottom,

                slot.mTransform, slot.mTimestamp

        );

        result.append(buffer);

    }

libs/gui/SurfaceTextureClient.cpp

+2 −1
Original line number Diff line number Diff line
@@ -117,7 +117,8 @@ int SurfaceTextureClient::dequeueBuffer(android_native_buffer_t** buffer) { 
            mReqFormat, mReqUsage);

    if (result < 0) {

        LOGV("dequeueBuffer: ISurfaceTexture::dequeueBuffer(%d, %d, %d, %d)"

             "failed: %d", result, mReqWidth, mReqHeight, mReqFormat, mReqUsage);

             "failed: %d", mReqWidth, mReqHeight, mReqFormat, mReqUsage,

             result);

        return result;

    }

    sp<GraphicBuffer>& gbuf(mSlots[buf]);

libs/gui/tests/SurfaceTextureClient_test.cpp

+3 −1
Original line number Diff line number Diff line
@@ -400,7 +400,9 @@ TEST_F(SurfaceTextureClientTest, SurfaceTextureSyncModeDQQR) { 
    EXPECT_EQ(st->getCurrentBuffer().get(), buf[2]);

}



TEST_F(SurfaceTextureClientTest, SurfaceTextureSyncModeDequeueCurrent) {

// XXX: We currently have no hardware that properly handles dequeuing the

// buffer that is currently bound to the texture.

TEST_F(SurfaceTextureClientTest, DISABLED_SurfaceTextureSyncModeDequeueCurrent) {

    sp<ANativeWindow> anw(mSTC);

    sp<SurfaceTexture> st(mST);

    android_native_buffer_t* buf[3];