ConsumerBase.cpp revision a4e19521ac4563f2ff6517bcfd63d9b8d33a6d0b 
1/*
2 * Copyright (C) 2010 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#define LOG_TAG "ConsumerBase"
18#define ATRACE_TAG ATRACE_TAG_GRAPHICS
19//#define LOG_NDEBUG 0
20
21#define EGL_EGLEXT_PROTOTYPES
22
23#include <EGL/egl.h>
24#include <EGL/eglext.h>
25
26#include <hardware/hardware.h>
27
28#include <gui/IGraphicBufferAlloc.h>
29#include <gui/ISurfaceComposer.h>
30#include <gui/SurfaceComposerClient.h>
31#include <gui/ConsumerBase.h>
32
33#include <private/gui/ComposerService.h>
34
35#include <utils/Log.h>
36#include <utils/String8.h>
37#include <utils/Trace.h>
38
39// Macros for including the ConsumerBase name in log messages
40#define CB_LOGV(x, ...) ALOGV("[%s] "x, mName.string(), ##__VA_ARGS__)
41#define CB_LOGD(x, ...) ALOGD("[%s] "x, mName.string(), ##__VA_ARGS__)
42#define CB_LOGI(x, ...) ALOGI("[%s] "x, mName.string(), ##__VA_ARGS__)
43#define CB_LOGW(x, ...) ALOGW("[%s] "x, mName.string(), ##__VA_ARGS__)
44#define CB_LOGE(x, ...) ALOGE("[%s] "x, mName.string(), ##__VA_ARGS__)
45
46namespace android {
47
48// Get an ID that's unique within this process.
49static int32_t createProcessUniqueId() {
50    static volatile int32_t globalCounter = 0;
51    return android_atomic_inc(&globalCounter);
52}
53
54ConsumerBase::ConsumerBase(const sp<BufferQueue>& bufferQueue, bool controlledByApp) :
55        mAbandoned(false),
56        mBufferQueue(bufferQueue) {
57    // Choose a name using the PID and a process-unique ID.
58    mName = String8::format("unnamed-%d-%d", getpid(), createProcessUniqueId());
59
60    // Note that we can't create an sp<...>(this) in a ctor that will not keep a
61    // reference once the ctor ends, as that would cause the refcount of 'this'
62    // dropping to 0 at the end of the ctor.  Since all we need is a wp<...>
63    // that's what we create.
64    wp<ConsumerListener> listener = static_cast<ConsumerListener*>(this);
65    sp<IConsumerListener> proxy = new BufferQueue::ProxyConsumerListener(listener);
66
67    status_t err = mBufferQueue->consumerConnect(proxy, controlledByApp);
68    if (err != NO_ERROR) {
69        CB_LOGE("ConsumerBase: error connecting to BufferQueue: %s (%d)",
70                strerror(-err), err);
71    } else {
72        mBufferQueue->setConsumerName(mName);
73    }
74}
75
76ConsumerBase::~ConsumerBase() {
77    CB_LOGV("~ConsumerBase");
78    Mutex::Autolock lock(mMutex);
79
80    // Verify that abandon() has been called before we get here.  This should
81    // be done by ConsumerBase::onLastStrongRef(), but it's possible for a
82    // derived class to override that method and not call
83    // ConsumerBase::onLastStrongRef().
84    LOG_ALWAYS_FATAL_IF(!mAbandoned, "[%s] ~ConsumerBase was called, but the "
85        "consumer is not abandoned!", mName.string());
86}
87
88void ConsumerBase::onLastStrongRef(const void* id) {
89    abandon();
90}
91
92void ConsumerBase::freeBufferLocked(int slotIndex) {
93    CB_LOGV("freeBufferLocked: slotIndex=%d", slotIndex);
94    mSlots[slotIndex].mGraphicBuffer = 0;
95    mSlots[slotIndex].mFence = Fence::NO_FENCE;
96    mSlots[slotIndex].mFrameNumber = 0;
97}
98
99// Used for refactoring, should not be in final interface
100sp<BufferQueue> ConsumerBase::getBufferQueue() const {
101    Mutex::Autolock lock(mMutex);
102    return mBufferQueue;
103}
104
105void ConsumerBase::onFrameAvailable() {
106    CB_LOGV("onFrameAvailable");
107
108    sp<FrameAvailableListener> listener;
109    { // scope for the lock
110        Mutex::Autolock lock(mMutex);
111        listener = mFrameAvailableListener.promote();
112    }
113
114    if (listener != NULL) {
115        CB_LOGV("actually calling onFrameAvailable");
116        listener->onFrameAvailable();
117    }
118}
119
120void ConsumerBase::onBuffersReleased() {
121    Mutex::Autolock lock(mMutex);
122
123    CB_LOGV("onBuffersReleased");
124
125    if (mAbandoned) {
126        // Nothing to do if we're already abandoned.
127        return;
128    }
129
130    uint32_t mask = 0;
131    mBufferQueue->getReleasedBuffers(&mask);
132    for (int i = 0; i < BufferQueue::NUM_BUFFER_SLOTS; i++) {
133        if (mask & (1 << i)) {
134            freeBufferLocked(i);
135        }
136    }
137}
138
139void ConsumerBase::abandon() {
140    CB_LOGV("abandon");
141    Mutex::Autolock lock(mMutex);
142
143    if (!mAbandoned) {
144        abandonLocked();
145        mAbandoned = true;
146    }
147}
148
149void ConsumerBase::abandonLocked() {
150	CB_LOGV("abandonLocked");
151    for (int i =0; i < BufferQueue::NUM_BUFFER_SLOTS; i++) {
152        freeBufferLocked(i);
153    }
154    // disconnect from the BufferQueue
155    mBufferQueue->consumerDisconnect();
156    mBufferQueue.clear();
157}
158
159void ConsumerBase::setFrameAvailableListener(
160        const wp<FrameAvailableListener>& listener) {
161    CB_LOGV("setFrameAvailableListener");
162    Mutex::Autolock lock(mMutex);
163    mFrameAvailableListener = listener;
164}
165
166void ConsumerBase::dump(String8& result) const {
167    dump(result, "");
168}
169
170void ConsumerBase::dump(String8& result, const char* prefix) const {
171    Mutex::Autolock _l(mMutex);
172    dumpLocked(result, prefix);
173}
174
175void ConsumerBase::dumpLocked(String8& result, const char* prefix) const {
176    result.appendFormat("%smAbandoned=%d\n", prefix, int(mAbandoned));
177
178    if (!mAbandoned) {
179        mBufferQueue->dump(result, prefix);
180    }
181}
182
183status_t ConsumerBase::acquireBufferLocked(BufferQueue::BufferItem *item,
184        nsecs_t presentWhen) {
185    status_t err = mBufferQueue->acquireBuffer(item, presentWhen);
186    if (err != NO_ERROR) {
187        return err;
188    }
189
190    if (item->mGraphicBuffer != NULL) {
191        mSlots[item->mBuf].mGraphicBuffer = item->mGraphicBuffer;
192    }
193
194    mSlots[item->mBuf].mFrameNumber = item->mFrameNumber;
195    mSlots[item->mBuf].mFence = item->mFence;
196
197    CB_LOGV("acquireBufferLocked: -> slot=%d/%llu",
198            item->mBuf, item->mFrameNumber);
199
200    return OK;
201}
202
203status_t ConsumerBase::addReleaseFence(int slot,
204        const sp<GraphicBuffer> graphicBuffer, const sp<Fence>& fence) {
205    Mutex::Autolock lock(mMutex);
206    return addReleaseFenceLocked(slot, graphicBuffer, fence);
207}
208
209status_t ConsumerBase::addReleaseFenceLocked(int slot,
210        const sp<GraphicBuffer> graphicBuffer, const sp<Fence>& fence) {
211    CB_LOGV("addReleaseFenceLocked: slot=%d", slot);
212
213    // If consumer no longer tracks this graphicBuffer, we can safely
214    // drop this fence, as it will never be received by the producer.
215    if (!stillTracking(slot, graphicBuffer)) {
216        return OK;
217    }
218
219    if (!mSlots[slot].mFence.get()) {
220        mSlots[slot].mFence = fence;
221    } else {
222        sp<Fence> mergedFence = Fence::merge(
223                String8::format("%.28s:%d", mName.string(), slot),
224                mSlots[slot].mFence, fence);
225        if (!mergedFence.get()) {
226            CB_LOGE("failed to merge release fences");
227            // synchronization is broken, the best we can do is hope fences
228            // signal in order so the new fence will act like a union
229            mSlots[slot].mFence = fence;
230            return BAD_VALUE;
231        }
232        mSlots[slot].mFence = mergedFence;
233    }
234
235    return OK;
236}
237
238status_t ConsumerBase::releaseBufferLocked(
239        int slot, const sp<GraphicBuffer> graphicBuffer,
240        EGLDisplay display, EGLSyncKHR eglFence) {
241    // If consumer no longer tracks this graphicBuffer (we received a new
242    // buffer on the same slot), the buffer producer is definitely no longer
243    // tracking it.
244    if (!stillTracking(slot, graphicBuffer)) {
245        return OK;
246    }
247
248    CB_LOGV("releaseBufferLocked: slot=%d/%llu",
249            slot, mSlots[slot].mFrameNumber);
250    status_t err = mBufferQueue->releaseBuffer(slot, mSlots[slot].mFrameNumber,
251            display, eglFence, mSlots[slot].mFence);
252    if (err == BufferQueue::STALE_BUFFER_SLOT) {
253        freeBufferLocked(slot);
254    }
255
256    mSlots[slot].mFence = Fence::NO_FENCE;
257
258    return err;
259}
260
261bool ConsumerBase::stillTracking(int slot,
262        const sp<GraphicBuffer> graphicBuffer) {
263    if (slot < 0 || slot >= BufferQueue::NUM_BUFFER_SLOTS) {
264        return false;
265    }
266    return (mSlots[slot].mGraphicBuffer != NULL &&
267            mSlots[slot].mGraphicBuffer->handle == graphicBuffer->handle);
268}
269
270} // namespace android
271