VirtualDisplaySurface.cpp revision b716e57048e945d5bceda33c2434c65d06464dba 
1/*
2 * Copyright 2013 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_NDEBUG 0
18#include "VirtualDisplaySurface.h"
19#include "HWComposer.h"
20
21// ---------------------------------------------------------------------------
22namespace android {
23// ---------------------------------------------------------------------------
24
25#define VDS_LOGE(msg, ...) ALOGE("[%s] "msg, \
26        mDisplayName.string(), ##__VA_ARGS__)
27#define VDS_LOGW_IF(cond, msg, ...) ALOGW_IF(cond, "[%s] "msg, \
28        mDisplayName.string(), ##__VA_ARGS__)
29#define VDS_LOGV(msg, ...) ALOGV("[%s] "msg, \
30        mDisplayName.string(), ##__VA_ARGS__)
31
32static const char* dbgCompositionTypeStr(DisplaySurface::CompositionType type) {
33    switch (type) {
34        case DisplaySurface::COMPOSITION_UNKNOWN: return "UNKNOWN";
35        case DisplaySurface::COMPOSITION_GLES:    return "GLES";
36        case DisplaySurface::COMPOSITION_HWC:     return "HWC";
37        case DisplaySurface::COMPOSITION_MIXED:   return "MIXED";
38        default:                                  return "<INVALID>";
39    }
40}
41
42VirtualDisplaySurface::VirtualDisplaySurface(HWComposer& hwc, int32_t dispId,
43        const sp<IGraphicBufferProducer>& sink,
44        const sp<BufferQueue>& bq,
45        const String8& name)
46:   ConsumerBase(bq),
47    mHwc(hwc),
48    mDisplayId(dispId),
49    mDisplayName(name),
50    mProducerUsage(GRALLOC_USAGE_HW_COMPOSER),
51    mProducerSlotSource(0),
52    mDbgState(DBG_STATE_IDLE),
53    mDbgLastCompositionType(COMPOSITION_UNKNOWN)
54{
55    mSource[SOURCE_SINK] = sink;
56    mSource[SOURCE_SCRATCH] = bq;
57
58    resetPerFrameState();
59
60    int sinkWidth, sinkHeight;
61    mSource[SOURCE_SINK]->query(NATIVE_WINDOW_WIDTH, &sinkWidth);
62    mSource[SOURCE_SINK]->query(NATIVE_WINDOW_HEIGHT, &sinkHeight);
63
64    ConsumerBase::mName = String8::format("VDS: %s", mDisplayName.string());
65    mConsumer->setConsumerName(ConsumerBase::mName);
66    mConsumer->setConsumerUsageBits(GRALLOC_USAGE_HW_COMPOSER);
67    mConsumer->setDefaultBufferSize(sinkWidth, sinkHeight);
68    mConsumer->setDefaultMaxBufferCount(2);
69}
70
71VirtualDisplaySurface::~VirtualDisplaySurface() {
72}
73
74status_t VirtualDisplaySurface::beginFrame() {
75    if (mDisplayId < 0)
76        return NO_ERROR;
77
78    VDS_LOGW_IF(mDbgState != DBG_STATE_IDLE,
79            "Unexpected beginFrame() in %s state", dbgStateStr());
80    mDbgState = DBG_STATE_BEGUN;
81
82    uint32_t transformHint, numPendingBuffers;
83    mQueueBufferOutput.deflate(&mSinkBufferWidth, &mSinkBufferHeight,
84            &transformHint, &numPendingBuffers);
85
86    return refreshOutputBuffer();
87}
88
89status_t VirtualDisplaySurface::prepareFrame(CompositionType compositionType) {
90    if (mDisplayId < 0)
91        return NO_ERROR;
92
93    VDS_LOGW_IF(mDbgState != DBG_STATE_BEGUN,
94            "Unexpected prepareFrame() in %s state", dbgStateStr());
95    mDbgState = DBG_STATE_PREPARED;
96
97    mCompositionType = compositionType;
98
99    if (mCompositionType != mDbgLastCompositionType) {
100        VDS_LOGV("prepareFrame: composition type changed to %s",
101                dbgCompositionTypeStr(mCompositionType));
102        mDbgLastCompositionType = mCompositionType;
103    }
104
105    return NO_ERROR;
106}
107
108status_t VirtualDisplaySurface::compositionComplete() {
109    return NO_ERROR;
110}
111
112status_t VirtualDisplaySurface::advanceFrame() {
113    if (mDisplayId < 0)
114        return NO_ERROR;
115
116    if (mCompositionType == COMPOSITION_HWC) {
117        VDS_LOGW_IF(mDbgState != DBG_STATE_PREPARED,
118                "Unexpected advanceFrame() in %s state on HWC frame",
119                dbgStateStr());
120    } else {
121        VDS_LOGW_IF(mDbgState != DBG_STATE_GLES_DONE,
122                "Unexpected advanceFrame() in %s state on GLES/MIXED frame",
123                dbgStateStr());
124    }
125    mDbgState = DBG_STATE_HWC;
126
127    if (mCompositionType == COMPOSITION_HWC) {
128        // Use the output buffer for the FB as well, though conceptually the
129        // FB is unused on this frame.
130        mFbProducerSlot = mOutputProducerSlot;
131        mFbFence = mOutputFence;
132    }
133
134    if (mFbProducerSlot < 0 || mOutputProducerSlot < 0) {
135        // Last chance bailout if something bad happened earlier. For example,
136        // in a GLES configuration, if the sink disappears then dequeueBuffer
137        // will fail, the GLES driver won't queue a buffer, but SurfaceFlinger
138        // will soldier on. So we end up here without a buffer. There should
139        // be lots of scary messages in the log just before this.
140        VDS_LOGE("advanceFrame: no buffer, bailing out");
141        return NO_MEMORY;
142    }
143
144    sp<GraphicBuffer> fbBuffer = mProducerBuffers[mFbProducerSlot];
145    sp<GraphicBuffer> outBuffer = mProducerBuffers[mOutputProducerSlot];
146    VDS_LOGV("advanceFrame: fb=%d(%p) out=%d(%p)",
147            mFbProducerSlot, fbBuffer.get(),
148            mOutputProducerSlot, outBuffer.get());
149
150    // At this point we know the output buffer acquire fence,
151    // so update HWC state with it.
152    mHwc.setOutputBuffer(mDisplayId, mOutputFence, outBuffer);
153
154    return mHwc.fbPost(mDisplayId, mFbFence, fbBuffer);
155}
156
157void VirtualDisplaySurface::onFrameCommitted() {
158    if (mDisplayId < 0)
159        return;
160
161    VDS_LOGW_IF(mDbgState != DBG_STATE_HWC,
162            "Unexpected onFrameCommitted() in %s state", dbgStateStr());
163    mDbgState = DBG_STATE_IDLE;
164
165    sp<Fence> fbFence = mHwc.getAndResetReleaseFence(mDisplayId);
166    if (mCompositionType == COMPOSITION_MIXED && mFbProducerSlot >= 0) {
167        // release the scratch buffer back to the pool
168        Mutex::Autolock lock(mMutex);
169        int sslot = mapProducer2SourceSlot(SOURCE_SCRATCH, mFbProducerSlot);
170        VDS_LOGV("onFrameCommitted: release scratch sslot=%d", sslot);
171        addReleaseFenceLocked(sslot, mProducerBuffers[mFbProducerSlot], fbFence);
172        releaseBufferLocked(sslot, mProducerBuffers[mFbProducerSlot],
173                EGL_NO_DISPLAY, EGL_NO_SYNC_KHR);
174    }
175
176    if (mOutputProducerSlot >= 0) {
177        int sslot = mapProducer2SourceSlot(SOURCE_SINK, mOutputProducerSlot);
178        QueueBufferOutput qbo;
179        sp<Fence> outFence = mHwc.getLastRetireFence(mDisplayId);
180        VDS_LOGV("onFrameCommitted: queue sink sslot=%d", sslot);
181        status_t result = mSource[SOURCE_SINK]->queueBuffer(sslot,
182                QueueBufferInput(
183                    systemTime(), false /* isAutoTimestamp */,
184                    Rect(mSinkBufferWidth, mSinkBufferHeight),
185                    NATIVE_WINDOW_SCALING_MODE_FREEZE, 0 /* transform */,
186                    true /* async*/,
187                    outFence),
188                &qbo);
189        if (result == NO_ERROR) {
190            updateQueueBufferOutput(qbo);
191        }
192    }
193
194    resetPerFrameState();
195}
196
197void VirtualDisplaySurface::dump(String8& result) const {
198}
199
200status_t VirtualDisplaySurface::requestBuffer(int pslot,
201        sp<GraphicBuffer>* outBuf) {
202    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
203            "Unexpected requestBuffer pslot=%d in %s state",
204            pslot, dbgStateStr());
205
206    *outBuf = mProducerBuffers[pslot];
207    return NO_ERROR;
208}
209
210status_t VirtualDisplaySurface::setBufferCount(int bufferCount) {
211    return mSource[SOURCE_SINK]->setBufferCount(bufferCount);
212}
213
214status_t VirtualDisplaySurface::dequeueBuffer(Source source,
215        uint32_t format, int* sslot, sp<Fence>* fence) {
216    // Don't let a slow consumer block us
217    bool async = (source == SOURCE_SINK);
218
219    status_t result = mSource[source]->dequeueBuffer(sslot, fence, async,
220            mSinkBufferWidth, mSinkBufferHeight, format, mProducerUsage);
221    if (result < 0)
222        return result;
223    int pslot = mapSource2ProducerSlot(source, *sslot);
224    VDS_LOGV("dequeueBuffer(%s): sslot=%d pslot=%d result=%d",
225            dbgSourceStr(source), *sslot, pslot, result);
226    uint32_t sourceBit = static_cast<uint32_t>(source) << pslot;
227
228    if ((mProducerSlotSource & (1u << pslot)) != sourceBit) {
229        // This slot was previously dequeued from the other source; must
230        // re-request the buffer.
231        result |= BUFFER_NEEDS_REALLOCATION;
232        mProducerSlotSource &= ~(1u << pslot);
233        mProducerSlotSource |= sourceBit;
234    }
235
236    if (result & RELEASE_ALL_BUFFERS) {
237        for (uint32_t i = 0; i < BufferQueue::NUM_BUFFER_SLOTS; i++) {
238            if ((mProducerSlotSource & (1u << i)) == sourceBit)
239                mProducerBuffers[i].clear();
240        }
241    }
242    if (result & BUFFER_NEEDS_REALLOCATION) {
243        mSource[source]->requestBuffer(*sslot, &mProducerBuffers[pslot]);
244        VDS_LOGV("dequeueBuffer(%s): buffers[%d]=%p",
245                dbgSourceStr(source), pslot, mProducerBuffers[pslot].get());
246    }
247
248    return result;
249}
250
251status_t VirtualDisplaySurface::dequeueBuffer(int* pslot, sp<Fence>* fence, bool async,
252        uint32_t w, uint32_t h, uint32_t format, uint32_t usage) {
253    VDS_LOGW_IF(mDbgState != DBG_STATE_PREPARED,
254            "Unexpected dequeueBuffer() in %s state", dbgStateStr());
255    mDbgState = DBG_STATE_GLES;
256
257    VDS_LOGW_IF(!async, "EGL called dequeueBuffer with !async despite eglSwapInterval(0)");
258    VDS_LOGV("dequeueBuffer %dx%d fmt=%d usage=%#x", w, h, format, usage);
259
260    status_t result = NO_ERROR;
261    mProducerUsage = usage | GRALLOC_USAGE_HW_COMPOSER;
262    Source source = fbSourceForCompositionType(mCompositionType);
263
264    if (source == SOURCE_SINK) {
265
266        if (mOutputProducerSlot < 0) {
267            // Last chance bailout if something bad happened earlier. For example,
268            // in a GLES configuration, if the sink disappears then dequeueBuffer
269            // will fail, the GLES driver won't queue a buffer, but SurfaceFlinger
270            // will soldier on. So we end up here without a buffer. There should
271            // be lots of scary messages in the log just before this.
272            VDS_LOGE("dequeueBuffer: no buffer, bailing out");
273            return NO_MEMORY;
274        }
275
276        // We already dequeued the output buffer. If the GLES driver wants
277        // something incompatible, we have to cancel and get a new one. This
278        // will mean that HWC will see a different output buffer between
279        // prepare and set, but since we're in GLES-only mode already it
280        // shouldn't matter.
281
282        const sp<GraphicBuffer>& buf = mProducerBuffers[mOutputProducerSlot];
283        if ((mProducerUsage & ~buf->getUsage()) != 0 ||
284                (format != 0 && format != (uint32_t)buf->getPixelFormat()) ||
285                (w != 0 && w != mSinkBufferWidth) ||
286                (h != 0 && h != mSinkBufferHeight)) {
287            VDS_LOGV("dequeueBuffer: output buffer doesn't satisfy GLES "
288                    "request, getting a new buffer");
289            result = refreshOutputBuffer();
290            if (result < 0)
291                return result;
292        }
293    }
294
295    if (source == SOURCE_SINK) {
296        *pslot = mOutputProducerSlot;
297        *fence = mOutputFence;
298    } else {
299        int sslot;
300        result = dequeueBuffer(source, format, &sslot, fence);
301        if (result >= 0) {
302            *pslot = mapSource2ProducerSlot(source, sslot);
303        }
304    }
305    return result;
306}
307
308status_t VirtualDisplaySurface::queueBuffer(int pslot,
309        const QueueBufferInput& input, QueueBufferOutput* output) {
310    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
311            "Unexpected queueBuffer(pslot=%d) in %s state", pslot,
312            dbgStateStr());
313    mDbgState = DBG_STATE_GLES_DONE;
314
315    VDS_LOGV("queueBuffer pslot=%d", pslot);
316
317    status_t result;
318    if (mCompositionType == COMPOSITION_MIXED) {
319        // Queue the buffer back into the scratch pool
320        QueueBufferOutput scratchQBO;
321        int sslot = mapProducer2SourceSlot(SOURCE_SCRATCH, pslot);
322        result = mSource[SOURCE_SCRATCH]->queueBuffer(sslot, input, &scratchQBO);
323        if (result != NO_ERROR)
324            return result;
325
326        // Now acquire the buffer from the scratch pool -- should be the same
327        // slot and fence as we just queued.
328        Mutex::Autolock lock(mMutex);
329        BufferQueue::BufferItem item;
330        result = acquireBufferLocked(&item, 0);
331        if (result != NO_ERROR)
332            return result;
333        VDS_LOGW_IF(item.mBuf != sslot,
334                "queueBuffer: acquired sslot %d from SCRATCH after queueing sslot %d",
335                item.mBuf, sslot);
336        mFbProducerSlot = mapSource2ProducerSlot(SOURCE_SCRATCH, item.mBuf);
337        mFbFence = mSlots[item.mBuf].mFence;
338
339    } else {
340        LOG_FATAL_IF(mCompositionType != COMPOSITION_GLES,
341                "Unexpected queueBuffer in state %s for compositionType %s",
342                dbgStateStr(), dbgCompositionTypeStr(mCompositionType));
343
344        // Extract the GLES release fence for HWC to acquire
345        int64_t timestamp;
346        bool isAutoTimestamp;
347        Rect crop;
348        int scalingMode;
349        uint32_t transform;
350        bool async;
351        input.deflate(&timestamp, &isAutoTimestamp, &crop, &scalingMode,
352                &transform, &async, &mFbFence);
353
354        mFbProducerSlot = pslot;
355        mOutputFence = mFbFence;
356    }
357
358    *output = mQueueBufferOutput;
359    return NO_ERROR;
360}
361
362void VirtualDisplaySurface::cancelBuffer(int pslot, const sp<Fence>& fence) {
363    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
364            "Unexpected cancelBuffer(pslot=%d) in %s state", pslot,
365            dbgStateStr());
366    VDS_LOGV("cancelBuffer pslot=%d", pslot);
367    Source source = fbSourceForCompositionType(mCompositionType);
368    return mSource[source]->cancelBuffer(
369            mapProducer2SourceSlot(source, pslot), fence);
370}
371
372int VirtualDisplaySurface::query(int what, int* value) {
373    return mSource[SOURCE_SINK]->query(what, value);
374}
375
376status_t VirtualDisplaySurface::connect(const sp<IBinder>& token,
377        int api, bool producerControlledByApp,
378        QueueBufferOutput* output) {
379    QueueBufferOutput qbo;
380    status_t result = mSource[SOURCE_SINK]->connect(token, api, producerControlledByApp, &qbo);
381    if (result == NO_ERROR) {
382        updateQueueBufferOutput(qbo);
383        *output = mQueueBufferOutput;
384    }
385    return result;
386}
387
388status_t VirtualDisplaySurface::disconnect(int api) {
389    return mSource[SOURCE_SINK]->disconnect(api);
390}
391
392void VirtualDisplaySurface::updateQueueBufferOutput(
393        const QueueBufferOutput& qbo) {
394    uint32_t w, h, transformHint, numPendingBuffers;
395    qbo.deflate(&w, &h, &transformHint, &numPendingBuffers);
396    mQueueBufferOutput.inflate(w, h, 0, numPendingBuffers);
397}
398
399void VirtualDisplaySurface::resetPerFrameState() {
400    mCompositionType = COMPOSITION_UNKNOWN;
401    mSinkBufferWidth = 0;
402    mSinkBufferHeight = 0;
403    mFbFence = Fence::NO_FENCE;
404    mOutputFence = Fence::NO_FENCE;
405    mFbProducerSlot = -1;
406    mOutputProducerSlot = -1;
407}
408
409status_t VirtualDisplaySurface::refreshOutputBuffer() {
410    if (mOutputProducerSlot >= 0) {
411        mSource[SOURCE_SINK]->cancelBuffer(
412                mapProducer2SourceSlot(SOURCE_SINK, mOutputProducerSlot),
413                mOutputFence);
414    }
415
416    int sslot;
417    status_t result = dequeueBuffer(SOURCE_SINK, 0, &sslot, &mOutputFence);
418    if (result < 0)
419        return result;
420    mOutputProducerSlot = mapSource2ProducerSlot(SOURCE_SINK, sslot);
421
422    // On GLES-only frames, we don't have the right output buffer acquire fence
423    // until after GLES calls queueBuffer(). So here we just set the buffer
424    // (for use in HWC prepare) but not the fence; we'll call this again with
425    // the proper fence once we have it.
426    result = mHwc.setOutputBuffer(mDisplayId, Fence::NO_FENCE,
427            mProducerBuffers[mOutputProducerSlot]);
428
429    return result;
430}
431
432// This slot mapping function is its own inverse, so two copies are unnecessary.
433// Both are kept to make the intent clear where the function is called, and for
434// the (unlikely) chance that we switch to a different mapping function.
435int VirtualDisplaySurface::mapSource2ProducerSlot(Source source, int sslot) {
436    if (source == SOURCE_SCRATCH) {
437        return BufferQueue::NUM_BUFFER_SLOTS - sslot - 1;
438    } else {
439        return sslot;
440    }
441}
442int VirtualDisplaySurface::mapProducer2SourceSlot(Source source, int pslot) {
443    return mapSource2ProducerSlot(source, pslot);
444}
445
446VirtualDisplaySurface::Source
447VirtualDisplaySurface::fbSourceForCompositionType(CompositionType type) {
448    return type == COMPOSITION_MIXED ? SOURCE_SCRATCH : SOURCE_SINK;
449}
450
451const char* VirtualDisplaySurface::dbgStateStr() const {
452    switch (mDbgState) {
453        case DBG_STATE_IDLE:      return "IDLE";
454        case DBG_STATE_PREPARED:  return "PREPARED";
455        case DBG_STATE_GLES:      return "GLES";
456        case DBG_STATE_GLES_DONE: return "GLES_DONE";
457        case DBG_STATE_HWC:       return "HWC";
458        default:                  return "INVALID";
459    }
460}
461
462const char* VirtualDisplaySurface::dbgSourceStr(Source s) {
463    switch (s) {
464        case SOURCE_SINK:    return "SINK";
465        case SOURCE_SCRATCH: return "SCRATCH";
466        default:             return "INVALID";
467    }
468}
469
470// ---------------------------------------------------------------------------
471} // namespace android
472// ---------------------------------------------------------------------------
473