1 /* 2 * Copyright 2014 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #ifndef ANDROID_GUI_BUFFERQUEUECONSUMER_H 18 #define ANDROID_GUI_BUFFERQUEUECONSUMER_H 19 20 #include <EGL/egl.h> 21 #include <EGL/eglext.h> 22 23 #include <gui/BufferQueueDefs.h> 24 #include <gui/IGraphicBufferConsumer.h> 25 26 namespace android { 27 28 class BufferQueueCore; 29 30 class BufferQueueConsumer : public BnGraphicBufferConsumer { 31 32 public: 33 BufferQueueConsumer(const sp<BufferQueueCore>& core); 34 virtual ~BufferQueueConsumer(); 35 36 // acquireBuffer attempts to acquire ownership of the next pending buffer in 37 // the BufferQueue. If no buffer is pending then it returns 38 // NO_BUFFER_AVAILABLE. If a buffer is successfully acquired, the 39 // information about the buffer is returned in BufferItem. If the buffer 40 // returned had previously been acquired then the BufferItem::mGraphicBuffer 41 // field of buffer is set to NULL and it is assumed that the consumer still 42 // holds a reference to the buffer. 43 // 44 // If expectedPresent is nonzero, it indicates the time when the buffer 45 // will be displayed on screen. If the buffer's timestamp is farther in the 46 // future, the buffer won't be acquired, and PRESENT_LATER will be 47 // returned. The presentation time is in nanoseconds, and the time base 48 // is CLOCK_MONOTONIC. 49 virtual status_t acquireBuffer(BufferItem* outBuffer, 50 nsecs_t expectedPresent, uint64_t maxFrameNumber = 0) override; 51 52 // See IGraphicBufferConsumer::detachBuffer 53 virtual status_t detachBuffer(int slot); 54 55 // See IGraphicBufferConsumer::attachBuffer 56 virtual status_t attachBuffer(int* slot, const sp<GraphicBuffer>& buffer); 57 58 // releaseBuffer releases a buffer slot from the consumer back to the 59 // BufferQueue. This may be done while the buffer's contents are still 60 // being accessed. The fence will signal when the buffer is no longer 61 // in use. frameNumber is used to indentify the exact buffer returned. 62 // 63 // If releaseBuffer returns STALE_BUFFER_SLOT, then the consumer must free 64 // any references to the just-released buffer that it might have, as if it 65 // had received a onBuffersReleased() call with a mask set for the released 66 // buffer. 67 // 68 // Note that the dependencies on EGL will be removed once we switch to using 69 // the Android HW Sync HAL. 70 virtual status_t releaseBuffer(int slot, uint64_t frameNumber, 71 const sp<Fence>& releaseFence, EGLDisplay display, 72 EGLSyncKHR fence); 73 74 // connect connects a consumer to the BufferQueue. Only one 75 // consumer may be connected, and when that consumer disconnects the 76 // BufferQueue is placed into the "abandoned" state, causing most 77 // interactions with the BufferQueue by the producer to fail. 78 // controlledByApp indicates whether the consumer is controlled by 79 // the application. 80 // 81 // consumerListener may not be NULL. 82 virtual status_t connect(const sp<IConsumerListener>& consumerListener, 83 bool controlledByApp); 84 85 // disconnect disconnects a consumer from the BufferQueue. All 86 // buffers will be freed and the BufferQueue is placed in the "abandoned" 87 // state, causing most interactions with the BufferQueue by the producer to 88 // fail. 89 virtual status_t disconnect(); 90 91 // getReleasedBuffers sets the value pointed to by outSlotMask to a bit mask 92 // indicating which buffer slots have been released by the BufferQueue 93 // but have not yet been released by the consumer. 94 // 95 // This should be called from the onBuffersReleased() callback. 96 virtual status_t getReleasedBuffers(uint64_t* outSlotMask); 97 98 // setDefaultBufferSize is used to set the size of buffers returned by 99 // dequeueBuffer when a width and height of zero is requested. Default 100 // is 1x1. 101 virtual status_t setDefaultBufferSize(uint32_t width, uint32_t height); 102 103 // see IGraphicBufferConsumer::setMaxBufferCount 104 virtual status_t setMaxBufferCount(int bufferCount); 105 106 // setMaxAcquiredBufferCount sets the maximum number of buffers that can 107 // be acquired by the consumer at one time (default 1). This call will 108 // fail if a producer is connected to the BufferQueue. 109 virtual status_t setMaxAcquiredBufferCount(int maxAcquiredBuffers); 110 111 // setConsumerName sets the name used in logging 112 virtual void setConsumerName(const String8& name); 113 114 // setDefaultBufferFormat allows the BufferQueue to create 115 // GraphicBuffers of a defaultFormat if no format is specified 116 // in dequeueBuffer. The initial default is HAL_PIXEL_FORMAT_RGBA_8888. 117 virtual status_t setDefaultBufferFormat(PixelFormat defaultFormat); 118 119 // setDefaultBufferDataSpace allows the BufferQueue to create 120 // GraphicBuffers of a defaultDataSpace if no data space is specified 121 // in queueBuffer. 122 // The initial default is HAL_DATASPACE_UNKNOWN 123 virtual status_t setDefaultBufferDataSpace( 124 android_dataspace defaultDataSpace); 125 126 // setConsumerUsageBits will turn on additional usage bits for dequeueBuffer. 127 // These are merged with the bits passed to dequeueBuffer. The values are 128 // enumerated in gralloc.h, e.g. GRALLOC_USAGE_HW_RENDER; the default is 0. 129 virtual status_t setConsumerUsageBits(uint32_t usage); 130 131 // setTransformHint bakes in rotation to buffers so overlays can be used. 132 // The values are enumerated in window.h, e.g. 133 // NATIVE_WINDOW_TRANSFORM_ROT_90. The default is 0 (no transform). 134 virtual status_t setTransformHint(uint32_t hint); 135 136 // Retrieve the sideband buffer stream, if any. 137 virtual sp<NativeHandle> getSidebandStream() const; 138 139 // See IGraphicBufferConsumer::getOccupancyHistory 140 virtual status_t getOccupancyHistory(bool forceFlush, 141 std::vector<OccupancyTracker::Segment>* outHistory) override; 142 143 // See IGraphicBufferConsumer::discardFreeBuffers 144 virtual status_t discardFreeBuffers() override; 145 146 // dump our state in a String 147 virtual void dump(String8& result, const char* prefix) const; 148 149 // Functions required for backwards compatibility. 150 // These will be modified/renamed in IGraphicBufferConsumer and will be 151 // removed from this class at that time. See b/13306289. 152 releaseBuffer(int buf,uint64_t frameNumber,EGLDisplay display,EGLSyncKHR fence,const sp<Fence> & releaseFence)153 virtual status_t releaseBuffer(int buf, uint64_t frameNumber, 154 EGLDisplay display, EGLSyncKHR fence, 155 const sp<Fence>& releaseFence) { 156 return releaseBuffer(buf, frameNumber, releaseFence, display, fence); 157 } 158 consumerConnect(const sp<IConsumerListener> & consumer,bool controlledByApp)159 virtual status_t consumerConnect(const sp<IConsumerListener>& consumer, 160 bool controlledByApp) { 161 return connect(consumer, controlledByApp); 162 } 163 consumerDisconnect()164 virtual status_t consumerDisconnect() { return disconnect(); } 165 166 // End functions required for backwards compatibility 167 168 private: 169 sp<BufferQueueCore> mCore; 170 171 // This references mCore->mSlots. Lock mCore->mMutex while accessing. 172 BufferQueueDefs::SlotsType& mSlots; 173 174 // This is a cached copy of the name stored in the BufferQueueCore. 175 // It's updated during setConsumerName. 176 String8 mConsumerName; 177 178 }; // class BufferQueueConsumer 179 180 } // namespace android 181 182 #endif 183