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