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