The Tor Browser: widget/gonk/nativewindow/GonkNativeWindowClientKK.h@b8a032363ba2 (annotated)

widget/gonk/nativewindow/GonkNativeWindowClientKK.h@b8a032363ba2 (annotated)

widget/gonk/nativewindow/GonkNativeWindowClientKK.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /*
  * Copyright (C) 2010 The Android Open Source Project
  * Copyright (C) 2013 Mozilla Foundation
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 #ifndef NATIVEWINDOW_GONKNATIVEWINDOWCLIENT_KK_H
 #define NATIVEWINDOW_GONKNATIVEWINDOWCLIENT_KK_H
 #include <gui/IGraphicBufferProducer.h>
 #include <ui/ANativeObjectBase.h>
 #include <ui/Region.h>
 #include <utils/RefBase.h>
 #include <utils/threads.h>
 #include <utils/KeyedVector.h>
 #include "GonkBufferQueue.h"
 struct ANativeWindow_Buffer;
 namespace android {
 /*
  * An implementation of ANativeWindow that feeds graphics buffers into a
  * BufferQueue.
  *
  * 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
  * GonkNativeWindowClient.  GonkNativeWindowClient then forwards the buffers through Binder IPC
  * to the BufferQueue's producer interface, providing the new frame to a
  * consumer such as GLConsumer.
  */
 class GonkNativeWindowClient
     : public ANativeObjectBase<ANativeWindow, GonkNativeWindowClient, RefBase>
 {
 public:
     /*
      * creates a GonkNativeWindowClient from the given IGraphicBufferProducer (which concrete
      * implementation is a BufferQueue).
      *
      * GonkNativeWindowClient is mainly state-less while it's disconnected, it can be
      * viewed as a glorified IGraphicBufferProducer holder. It's therefore
      * safe to create other GonkNativeWindowClients from the same IGraphicBufferProducer.
      *
      * However, once a GonkNativeWindowClient is connected, it'll prevent other GonkNativeWindowClients
      * referring to the same IGraphicBufferProducer to become connected and
      * therefore prevent them to be used as actual producers of buffers.
      *
      * the controlledByApp flag indicates that this Surface (producer) is
      * controlled by the application. This flag is used at connect time.
      */
     GonkNativeWindowClient(const sp<IGraphicBufferProducer>& bufferProducer, bool controlledByApp = false);
     /* getIGraphicBufferProducer() returns the IGraphicBufferProducer this
      * GonkNativeWindowClient was created with. Usually it's an error to use the
      * IGraphicBufferProducer while the GonkNativeWindowClient is connected.
      */
     sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
     /* convenience function to check that the given surface is non NULL as
      * well as its IGraphicBufferProducer */
     static bool isValid(const sp<GonkNativeWindowClient>& surface) {
         return surface != NULL && surface->getIGraphicBufferProducer() != NULL;
     }
 protected:
     virtual ~GonkNativeWindowClient();
 private:
     // can't be copied
     GonkNativeWindowClient& operator = (const GonkNativeWindowClient& rhs);
     GonkNativeWindowClient(const GonkNativeWindowClient& rhs);
     // 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);
 public:
     virtual int lock(ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds);
     virtual int unlockAndPost();
 protected:
     enum { NUM_BUFFER_SLOTS = GonkBufferQueue::NUM_BUFFER_SLOTS };
     enum { DEFAULT_FORMAT = PIXEL_FORMAT_RGBA_8888 };
 private:
     void freeAllBuffers();
     int getSlotFromBufferLocked(android_native_buffer_t* buffer) const;
     struct BufferSlot {
         sp<GraphicBuffer> buffer;
         Region dirtyRegion;
     };
     // 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;
     // mProducerControlledByApp whether this buffer producer is controlled
     // by the application
     bool mProducerControlledByApp;
     // mSwapIntervalZero set if we should drop buffers at queue() time to
     // achieve an asynchronous swap interval
     bool mSwapIntervalZero;
     // 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 GonkNativeWindowClient 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
 #endif  // NATIVEWINDOW_GONKNATIVEWINDOWCLIENT_JB_H

The Tor Browser / annotate

widget/gonk/nativewindow/GonkNativeWindowClientKK.h@b8a032363ba2 (annotated)

widget/gonk/nativewindow/GonkNativeWindowClientKK.h