Refactoring: Rename SurfaceTextureClient to Surface

    glc->setDefaultMaxBufferCount(3);

    glc->setConsumerUsageBits(GRALLOC_USAGE_HW_COMPOSER);

    sp<ANativeWindow> anw = new SurfaceTextureClient(bq);

    sp<ANativeWindow> anw = new Surface(bq);

    EGLSurface s = eglCreateWindowSurface(mDisplay, mConfig, anw.get(), NULL);

    if (s == EGL_NO_SURFACE) {

        fprintf(stderr, "eglCreateWindowSurface error: %#x\n", eglGetError());

#include <gui/GraphicBufferAlloc.h>

#include <gui/GLConsumer.h>

#include <gui/SurfaceTextureClient.h>

#include <gui/Surface.h>

#include <EGL/egl.h>

#include <GLES2/gl2.h>

#include <gui/GraphicBufferAlloc.h>

#include <gui/Surface.h>

#include <gui/GLConsumer.h>

#include <gui/SurfaceTextureClient.h>

#include <gui/Surface.h>

#include <ui/Fence.h>

#include <utils/Trace.h>

namespace android {

// ----------------------------------------------------------------------------

class SurfaceTextureClient;

class Surface;

/*

 * This class defines the Binder IPC interface for the producer side of

 * a queue of graphics buffers.  It's used to send graphics data from one

 * component to another.  For example, a class that decodes video for

 * playback might use this to provide frames.  This is typically done

 * indirectly, through SurfaceTextureClient.

 * indirectly, through Surface.

 *

 * The underlying mechanism is a BufferQueue, which implements

 * BnGraphicBufferProducer.  In normal operation, the producer calls

/*

 * Copyright (C) 2007 The Android Open Source Project

 * Copyright (C) 2010 The Android Open Source Project

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

#ifndef ANDROID_GUI_SURFACE_H

#define ANDROID_GUI_SURFACE_H

#include <stdint.h>

#include <sys/types.h>

#include <gui/IGraphicBufferProducer.h>

#include <gui/GLConsumer.h>

#include <gui/BufferQueue.h>

#include <ui/ANativeObjectBase.h>

#include <ui/Region.h>

#include <utils/KeyedVector.h>

#include <utils/RefBase.h>

#include <utils/threads.h>

#include <utils/KeyedVector.h>

#include <ui/PixelFormat.h>

#include <ui/Region.h>

#include <gui/SurfaceTextureClient.h>

#include <gui/ISurface.h>

#include <gui/ISurfaceComposerClient.h>

struct ANativeWindow_Buffer;

namespace android {

// ---------------------------------------------------------------------------

class IGraphicBufferProducer;

class Surface;

class SurfaceComposerClient;

// ---------------------------------------------------------------------------

class SurfaceControl : public RefBase

{

public:

    static bool isValid(const sp<SurfaceControl>& surface) {

        return (surface != 0) && surface->isValid();

    }

    bool isValid() {

        return mSurface!=0 && mClient!=0;

    }

    static bool isSameSurface(

            const sp<SurfaceControl>& lhs, const sp<SurfaceControl>& rhs);

    // release surface data from java

    void        clear();

    status_t    setLayerStack(int32_t layerStack);

    status_t    setLayer(int32_t layer);

    status_t    setPosition(int32_t x, int32_t y);

    status_t    setSize(uint32_t w, uint32_t h);

    status_t    hide();

    status_t    show();

    status_t    setFlags(uint32_t flags, uint32_t mask);

    status_t    setTransparentRegionHint(const Region& transparent);

    status_t    setAlpha(float alpha=1.0f);

    status_t    setMatrix(float dsdx, float dtdx, float dsdy, float dtdy);

    status_t    setCrop(const Rect& crop);

    static status_t writeSurfaceToParcel(

            const sp<SurfaceControl>& control, Parcel* parcel);

    sp<Surface> getSurface() const;

private:

    // can't be copied

    SurfaceControl& operator = (SurfaceControl& rhs);

    SurfaceControl(const SurfaceControl& rhs);

    friend class SurfaceComposerClient;

    friend class Surface;

    SurfaceControl(

            const sp<SurfaceComposerClient>& client,

            const sp<ISurface>& surface);

    ~SurfaceControl();

    status_t validate() const;

    void destroy();

    sp<SurfaceComposerClient>   mClient;

    sp<IBinder>                 mSurface;

    mutable Mutex               mLock;

    mutable sp<Surface>         mSurfaceData;

};

// ---------------------------------------------------------------------------

/*

 * This is a small wrapper around SurfaceTextureClient.

 * An implementation of ANativeWindow that feeds graphics buffers into a

 * BufferQueue.

 *

 * TODO: rename and/or merge with STC.

 * This is typically used by programs that want to render frames through

 * some means (maybe OpenGL, a software renderer, or a hardware decoder)

 * and have the frames they create forwarded to SurfaceFlinger for

 * compositing.  For example, a video decoder could render a frame and call

 * eglSwapBuffers(), which invokes ANativeWindow callbacks defined by

 * Surface.  Surface then forwards the buffers through Binder IPC

 * to the BufferQueue's producer interface, providing the new frame to a

 * consumer such as GLConsumer.

 */

class Surface : public SurfaceTextureClient

class Surface

    : public ANativeObjectBase<ANativeWindow, Surface, RefBase>

{

public:

    struct SurfaceInfo {

        uint32_t    w;

        uint32_t    h;

        uint32_t    s;

        uint32_t    usage;

        PixelFormat format;

        void*       bits;

        uint32_t    reserved[2];

    };

    explicit Surface(const sp<IGraphicBufferProducer>& bp);

    Surface(const sp<IGraphicBufferProducer>& bufferProducer);

    static status_t writeToParcel(const sp<Surface>& control, Parcel* parcel);

    sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;

    static status_t writeToParcel(const sp<Surface>& surface, Parcel* parcel);

    static sp<Surface> readFromParcel(const Parcel& data);

    static bool isValid(const sp<Surface>& surface) {

        return (surface != 0) && surface->isValid();

    }

    bool        isValid();

    uint32_t    getIdentity() const { return mIdentity; }

    sp<IGraphicBufferProducer> getSurfaceTexture();     // TODO: rename this

    // the lock/unlock APIs must be used from the same thread

    status_t    lock(SurfaceInfo* info, Region* dirty = NULL);

    status_t    unlockAndPost();

    // FIXME: temporary for source compatibility...

    sp<IGraphicBufferProducer> getISurfaceTexture() const {

        return getIGraphicBufferProducer();

    }

    sp<IBinder> asBinder() const;

protected:

    Surface();

    virtual ~Surface();

    void setIGraphicBufferProducer(const sp<IGraphicBufferProducer>& bufferProducer);

private:

    // this is just to be able to write some unit tests

    friend class Test;

    friend class SurfaceControl;

    // can't be copied

    Surface& operator = (Surface& rhs);

    Surface& operator = (const Surface& rhs);

    Surface(const Surface& rhs);

    void init();

    // ANativeWindow hooks

    static int hook_cancelBuffer(ANativeWindow* window,

            ANativeWindowBuffer* buffer, int fenceFd);

    static int hook_dequeueBuffer(ANativeWindow* window,

            ANativeWindowBuffer** buffer, int* fenceFd);

    static int hook_perform(ANativeWindow* window, int operation, ...);

    static int hook_query(const ANativeWindow* window, int what, int* value);

    static int hook_queueBuffer(ANativeWindow* window,

            ANativeWindowBuffer* buffer, int fenceFd);

    static int hook_setSwapInterval(ANativeWindow* window, int interval);

    static int hook_cancelBuffer_DEPRECATED(ANativeWindow* window,

            ANativeWindowBuffer* buffer);

    static int hook_dequeueBuffer_DEPRECATED(ANativeWindow* window,

            ANativeWindowBuffer** buffer);

    static int hook_lockBuffer_DEPRECATED(ANativeWindow* window,

            ANativeWindowBuffer* buffer);

    static int hook_queueBuffer_DEPRECATED(ANativeWindow* window,

            ANativeWindowBuffer* buffer);

    int dispatchConnect(va_list args);

    int dispatchDisconnect(va_list args);

    int dispatchSetBufferCount(va_list args);

    int dispatchSetBuffersGeometry(va_list args);

    int dispatchSetBuffersDimensions(va_list args);

    int dispatchSetBuffersUserDimensions(va_list args);

    int dispatchSetBuffersFormat(va_list args);

    int dispatchSetScalingMode(va_list args);

    int dispatchSetBuffersTransform(va_list args);

    int dispatchSetBuffersTimestamp(va_list args);

    int dispatchSetCrop(va_list args);

    int dispatchSetPostTransformCrop(va_list args);

    int dispatchSetUsage(va_list args);

    int dispatchLock(va_list args);

    int dispatchUnlockAndPost(va_list args);

protected:

    virtual int dequeueBuffer(ANativeWindowBuffer** buffer, int* fenceFd);

    virtual int cancelBuffer(ANativeWindowBuffer* buffer, int fenceFd);

    virtual int queueBuffer(ANativeWindowBuffer* buffer, int fenceFd);

    virtual int perform(int operation, va_list args);

    virtual int query(int what, int* value) const;

    virtual int setSwapInterval(int interval);

    virtual int lockBuffer_DEPRECATED(ANativeWindowBuffer* buffer);

    virtual int connect(int api);

    virtual int disconnect(int api);

    virtual int setBufferCount(int bufferCount);

    virtual int setBuffersDimensions(int w, int h);

    virtual int setBuffersUserDimensions(int w, int h);

    virtual int setBuffersFormat(int format);

    virtual int setScalingMode(int mode);

    virtual int setBuffersTransform(int transform);

    virtual int setBuffersTimestamp(int64_t timestamp);

    virtual int setCrop(Rect const* rect);

    virtual int setUsage(uint32_t reqUsage);

    explicit Surface(const sp<SurfaceControl>& control);

    Surface(const Parcel& data, const sp<IBinder>& ref);

    ~Surface();

    /*

     *  private stuff...

     */

    void init(const sp<IGraphicBufferProducer>& bufferProducer);

public:

    virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);

    virtual int unlockAndPost();

    static void cleanCachedSurfacesLocked();

protected:

    enum { NUM_BUFFER_SLOTS = BufferQueue::NUM_BUFFER_SLOTS };

    enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };

    virtual int query(int what, int* value) const;

private:

    void freeAllBuffers();

    int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;

    // constants

    sp<ISurface>                mSurface;

    uint32_t                    mIdentity;

    struct BufferSlot {

        sp<GraphicBuffer> buffer;

        Region dirtyRegion;

    };

    // A cache of Surface objects that have been deserialized into this process.

    static Mutex sCachedSurfacesLock;

    static DefaultKeyedVector<wp<IBinder>, wp<Surface> > sCachedSurfaces;

    // mSurfaceTexture is the interface to the surface texture server. All

    // operations on the surface texture client ultimately translate into

    // interactions with the server using this interface.

    // TODO: rename to mBufferProducer

    sp<IGraphicBufferProducer> mGraphicBufferProducer;

    // mSlots stores the buffers that have been allocated for each buffer slot.

    // It is initialized to null pointers, and gets filled in with the result of

    // IGraphicBufferProducer::requestBuffer when the client dequeues a buffer from a

    // slot that has not yet been used. The buffer allocated to a slot will also

    // be replaced if the requested buffer usage or geometry differs from that

    // of the buffer allocated to a slot.

    BufferSlot mSlots[NUM_BUFFER_SLOTS];

    // mReqWidth is the buffer width that will be requested at the next dequeue

    // operation. It is initialized to 1.

    uint32_t mReqWidth;

    // mReqHeight is the buffer height that will be requested at the next

    // dequeue operation. It is initialized to 1.

    uint32_t mReqHeight;

    // mReqFormat is the buffer pixel format that will be requested at the next

    // deuque operation. It is initialized to PIXEL_FORMAT_RGBA_8888.

    uint32_t mReqFormat;

    // mReqUsage is the set of buffer usage flags that will be requested

    // at the next deuque operation. It is initialized to 0.

    uint32_t mReqUsage;

    // mTimestamp is the timestamp that will be used for the next buffer queue

    // operation. It defaults to NATIVE_WINDOW_TIMESTAMP_AUTO, which means that

    // a timestamp is auto-generated when queueBuffer is called.

    int64_t mTimestamp;

    // mCrop is the crop rectangle that will be used for the next buffer

    // that gets queued. It is set by calling setCrop.

    Rect mCrop;

    // mScalingMode is the scaling mode that will be used for the next

    // buffers that get queued. It is set by calling setScalingMode.

    int mScalingMode;

    // mTransform is the transform identifier that will be used for the next

    // buffer that gets queued. It is set by calling setTransform.

    uint32_t mTransform;

     // mDefaultWidth is default width of the buffers, regardless of the

     // native_window_set_buffers_dimensions call.

     uint32_t mDefaultWidth;

     // mDefaultHeight is default height of the buffers, regardless of the

     // native_window_set_buffers_dimensions call.

     uint32_t mDefaultHeight;

     // mUserWidth, if non-zero, is an application-specified override

     // of mDefaultWidth.  This is lower priority than the width set by

     // native_window_set_buffers_dimensions.

     uint32_t mUserWidth;

     // mUserHeight, if non-zero, is an application-specified override

     // of mDefaultHeight.  This is lower priority than the height set

     // by native_window_set_buffers_dimensions.

     uint32_t mUserHeight;

    // mTransformHint is the transform probably applied to buffers of this

    // window. this is only a hint, actual transform may differ.

    uint32_t mTransformHint;

    // mConsumerRunningBehind whether the consumer is running more than

    // one buffer behind the producer.

    mutable bool mConsumerRunningBehind;

    // mMutex is the mutex used to prevent concurrent access to the member

    // variables of Surface objects. It must be locked whenever the

    // member variables are accessed.

    mutable Mutex mMutex;

    // must be used from the lock/unlock thread

    sp<GraphicBuffer>           mLockedBuffer;

    sp<GraphicBuffer>           mPostedBuffer;

    bool                        mConnectedToCpu;

    // must be accessed from lock/unlock thread only

    Region mDirtyRegion;

};

}; // namespace android