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#include <gui/BufferItem.h>
22#include <gui/IProducerListener.h>
23
24// ---------------------------------------------------------------------------
25namespace android {
26// ---------------------------------------------------------------------------
27
28#if defined(FORCE_HWC_COPY_FOR_VIRTUAL_DISPLAYS)
29static const bool sForceHwcCopy = true;
30#else
31static const bool sForceHwcCopy = false;
32#endif
33
34#define VDS_LOGE(msg, ...) ALOGE("[%s] " msg, \
35        mDisplayName.string(), ##__VA_ARGS__)
36#define VDS_LOGW_IF(cond, msg, ...) ALOGW_IF(cond, "[%s] " msg, \
37        mDisplayName.string(), ##__VA_ARGS__)
38#define VDS_LOGV(msg, ...) ALOGV("[%s] " msg, \
39        mDisplayName.string(), ##__VA_ARGS__)
40
41static const char* dbgCompositionTypeStr(DisplaySurface::CompositionType type) {
42    switch (type) {
43        case DisplaySurface::COMPOSITION_UNKNOWN: return "UNKNOWN";
44        case DisplaySurface::COMPOSITION_GLES:    return "GLES";
45        case DisplaySurface::COMPOSITION_HWC:     return "HWC";
46        case DisplaySurface::COMPOSITION_MIXED:   return "MIXED";
47        default:                                  return "<INVALID>";
48    }
49}
50
51VirtualDisplaySurface::VirtualDisplaySurface(HWComposer& hwc, int32_t dispId,
52        const sp<IGraphicBufferProducer>& sink,
53        const sp<IGraphicBufferProducer>& bqProducer,
54        const sp<IGraphicBufferConsumer>& bqConsumer,
55        const String8& name)
56:   ConsumerBase(bqConsumer),
57    mHwc(hwc),
58    mDisplayId(dispId),
59    mDisplayName(name),
60    mSource{},
61    mDefaultOutputFormat(HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED),
62    mOutputFormat(HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED),
63    mOutputUsage(GRALLOC_USAGE_HW_COMPOSER),
64    mProducerSlotSource(0),
65    mProducerBuffers(),
66    mQueueBufferOutput(),
67    mSinkBufferWidth(0),
68    mSinkBufferHeight(0),
69    mCompositionType(COMPOSITION_UNKNOWN),
70    mFbFence(Fence::NO_FENCE),
71    mOutputFence(Fence::NO_FENCE),
72    mFbProducerSlot(BufferQueue::INVALID_BUFFER_SLOT),
73    mOutputProducerSlot(BufferQueue::INVALID_BUFFER_SLOT),
74    mDbgState(DBG_STATE_IDLE),
75    mDbgLastCompositionType(COMPOSITION_UNKNOWN),
76    mMustRecompose(false)
77{
78    mSource[SOURCE_SINK] = sink;
79    mSource[SOURCE_SCRATCH] = bqProducer;
80
81    resetPerFrameState();
82
83    int sinkWidth, sinkHeight;
84    sink->query(NATIVE_WINDOW_WIDTH, &sinkWidth);
85    sink->query(NATIVE_WINDOW_HEIGHT, &sinkHeight);
86    mSinkBufferWidth = sinkWidth;
87    mSinkBufferHeight = sinkHeight;
88
89    // Pick the buffer format to request from the sink when not rendering to it
90    // with GLES. If the consumer needs CPU access, use the default format
91    // set by the consumer. Otherwise allow gralloc to decide the format based
92    // on usage bits.
93    int sinkUsage;
94    sink->query(NATIVE_WINDOW_CONSUMER_USAGE_BITS, &sinkUsage);
95    if (sinkUsage & (GRALLOC_USAGE_SW_READ_MASK | GRALLOC_USAGE_SW_WRITE_MASK)) {
96        int sinkFormat;
97        sink->query(NATIVE_WINDOW_FORMAT, &sinkFormat);
98        mDefaultOutputFormat = sinkFormat;
99    } else {
100        mDefaultOutputFormat = HAL_PIXEL_FORMAT_IMPLEMENTATION_DEFINED;
101    }
102    mOutputFormat = mDefaultOutputFormat;
103
104    ConsumerBase::mName = String8::format("VDS: %s", mDisplayName.string());
105    mConsumer->setConsumerName(ConsumerBase::mName);
106    mConsumer->setConsumerUsageBits(GRALLOC_USAGE_HW_COMPOSER);
107    mConsumer->setDefaultBufferSize(sinkWidth, sinkHeight);
108    sink->setAsyncMode(true);
109    IGraphicBufferProducer::QueueBufferOutput output;
110    mSource[SOURCE_SCRATCH]->connect(NULL, NATIVE_WINDOW_API_EGL, false, &output);
111}
112
113VirtualDisplaySurface::~VirtualDisplaySurface() {
114    mSource[SOURCE_SCRATCH]->disconnect(NATIVE_WINDOW_API_EGL);
115}
116
117status_t VirtualDisplaySurface::beginFrame(bool mustRecompose) {
118    if (mDisplayId < 0)
119        return NO_ERROR;
120
121    mMustRecompose = mustRecompose;
122
123    VDS_LOGW_IF(mDbgState != DBG_STATE_IDLE,
124            "Unexpected beginFrame() in %s state", dbgStateStr());
125    mDbgState = DBG_STATE_BEGUN;
126
127    return refreshOutputBuffer();
128}
129
130status_t VirtualDisplaySurface::prepareFrame(CompositionType compositionType) {
131    if (mDisplayId < 0)
132        return NO_ERROR;
133
134    VDS_LOGW_IF(mDbgState != DBG_STATE_BEGUN,
135            "Unexpected prepareFrame() in %s state", dbgStateStr());
136    mDbgState = DBG_STATE_PREPARED;
137
138    mCompositionType = compositionType;
139    if (sForceHwcCopy && mCompositionType == COMPOSITION_GLES) {
140        // Some hardware can do RGB->YUV conversion more efficiently in hardware
141        // controlled by HWC than in hardware controlled by the video encoder.
142        // Forcing GLES-composed frames to go through an extra copy by the HWC
143        // allows the format conversion to happen there, rather than passing RGB
144        // directly to the consumer.
145        //
146        // On the other hand, when the consumer prefers RGB or can consume RGB
147        // inexpensively, this forces an unnecessary copy.
148        mCompositionType = COMPOSITION_MIXED;
149    }
150
151    if (mCompositionType != mDbgLastCompositionType) {
152        VDS_LOGV("prepareFrame: composition type changed to %s",
153                dbgCompositionTypeStr(mCompositionType));
154        mDbgLastCompositionType = mCompositionType;
155    }
156
157    if (mCompositionType != COMPOSITION_GLES &&
158            (mOutputFormat != mDefaultOutputFormat ||
159             mOutputUsage != GRALLOC_USAGE_HW_COMPOSER)) {
160        // We must have just switched from GLES-only to MIXED or HWC
161        // composition. Stop using the format and usage requested by the GLES
162        // driver; they may be suboptimal when HWC is writing to the output
163        // buffer. For example, if the output is going to a video encoder, and
164        // HWC can write directly to YUV, some hardware can skip a
165        // memory-to-memory RGB-to-YUV conversion step.
166        //
167        // If we just switched *to* GLES-only mode, we'll change the
168        // format/usage and get a new buffer when the GLES driver calls
169        // dequeueBuffer().
170        mOutputFormat = mDefaultOutputFormat;
171        mOutputUsage = GRALLOC_USAGE_HW_COMPOSER;
172        refreshOutputBuffer();
173    }
174
175    return NO_ERROR;
176}
177
178#ifndef USE_HWC2
179status_t VirtualDisplaySurface::compositionComplete() {
180    return NO_ERROR;
181}
182#endif
183
184status_t VirtualDisplaySurface::advanceFrame() {
185    if (mDisplayId < 0)
186        return NO_ERROR;
187
188    if (mCompositionType == COMPOSITION_HWC) {
189        VDS_LOGW_IF(mDbgState != DBG_STATE_PREPARED,
190                "Unexpected advanceFrame() in %s state on HWC frame",
191                dbgStateStr());
192    } else {
193        VDS_LOGW_IF(mDbgState != DBG_STATE_GLES_DONE,
194                "Unexpected advanceFrame() in %s state on GLES/MIXED frame",
195                dbgStateStr());
196    }
197    mDbgState = DBG_STATE_HWC;
198
199    if (mOutputProducerSlot < 0 ||
200            (mCompositionType != COMPOSITION_HWC && mFbProducerSlot < 0)) {
201        // Last chance bailout if something bad happened earlier. For example,
202        // in a GLES configuration, if the sink disappears then dequeueBuffer
203        // will fail, the GLES driver won't queue a buffer, but SurfaceFlinger
204        // will soldier on. So we end up here without a buffer. There should
205        // be lots of scary messages in the log just before this.
206        VDS_LOGE("advanceFrame: no buffer, bailing out");
207        return NO_MEMORY;
208    }
209
210    sp<GraphicBuffer> fbBuffer = mFbProducerSlot >= 0 ?
211            mProducerBuffers[mFbProducerSlot] : sp<GraphicBuffer>(NULL);
212    sp<GraphicBuffer> outBuffer = mProducerBuffers[mOutputProducerSlot];
213    VDS_LOGV("advanceFrame: fb=%d(%p) out=%d(%p)",
214            mFbProducerSlot, fbBuffer.get(),
215            mOutputProducerSlot, outBuffer.get());
216
217    // At this point we know the output buffer acquire fence,
218    // so update HWC state with it.
219    mHwc.setOutputBuffer(mDisplayId, mOutputFence, outBuffer);
220
221    status_t result = NO_ERROR;
222    if (fbBuffer != NULL) {
223#ifdef USE_HWC2
224        // TODO: Correctly propagate the dataspace from GL composition
225        result = mHwc.setClientTarget(mDisplayId, mFbFence, fbBuffer,
226                HAL_DATASPACE_UNKNOWN);
227#else
228        result = mHwc.fbPost(mDisplayId, mFbFence, fbBuffer);
229#endif
230    }
231
232    return result;
233}
234
235void VirtualDisplaySurface::onFrameCommitted() {
236    if (mDisplayId < 0)
237        return;
238
239    VDS_LOGW_IF(mDbgState != DBG_STATE_HWC,
240            "Unexpected onFrameCommitted() in %s state", dbgStateStr());
241    mDbgState = DBG_STATE_IDLE;
242
243#ifdef USE_HWC2
244    sp<Fence> retireFence = mHwc.getRetireFence(mDisplayId);
245#else
246    sp<Fence> fbFence = mHwc.getAndResetReleaseFence(mDisplayId);
247#endif
248    if (mCompositionType == COMPOSITION_MIXED && mFbProducerSlot >= 0) {
249        // release the scratch buffer back to the pool
250        Mutex::Autolock lock(mMutex);
251        int sslot = mapProducer2SourceSlot(SOURCE_SCRATCH, mFbProducerSlot);
252        VDS_LOGV("onFrameCommitted: release scratch sslot=%d", sslot);
253#ifdef USE_HWC2
254        addReleaseFenceLocked(sslot, mProducerBuffers[mFbProducerSlot],
255                retireFence);
256#else
257        addReleaseFenceLocked(sslot, mProducerBuffers[mFbProducerSlot], fbFence);
258#endif
259        releaseBufferLocked(sslot, mProducerBuffers[mFbProducerSlot],
260                EGL_NO_DISPLAY, EGL_NO_SYNC_KHR);
261    }
262
263    if (mOutputProducerSlot >= 0) {
264        int sslot = mapProducer2SourceSlot(SOURCE_SINK, mOutputProducerSlot);
265        QueueBufferOutput qbo;
266#ifndef USE_HWC2
267        sp<Fence> outFence = mHwc.getLastRetireFence(mDisplayId);
268#endif
269        VDS_LOGV("onFrameCommitted: queue sink sslot=%d", sslot);
270        if (mMustRecompose) {
271            status_t result = mSource[SOURCE_SINK]->queueBuffer(sslot,
272                    QueueBufferInput(
273                        systemTime(), false /* isAutoTimestamp */,
274                        HAL_DATASPACE_UNKNOWN,
275                        Rect(mSinkBufferWidth, mSinkBufferHeight),
276                        NATIVE_WINDOW_SCALING_MODE_FREEZE, 0 /* transform */,
277#ifdef USE_HWC2
278                        retireFence),
279#else
280                        outFence),
281#endif
282                    &qbo);
283            if (result == NO_ERROR) {
284                updateQueueBufferOutput(qbo);
285            }
286        } else {
287            // If the surface hadn't actually been updated, then we only went
288            // through the motions of updating the display to keep our state
289            // machine happy. We cancel the buffer to avoid triggering another
290            // re-composition and causing an infinite loop.
291#ifdef USE_HWC2
292            mSource[SOURCE_SINK]->cancelBuffer(sslot, retireFence);
293#else
294            mSource[SOURCE_SINK]->cancelBuffer(sslot, outFence);
295#endif
296        }
297    }
298
299    resetPerFrameState();
300}
301
302void VirtualDisplaySurface::dumpAsString(String8& /* result */) const {
303}
304
305void VirtualDisplaySurface::resizeBuffers(const uint32_t w, const uint32_t h) {
306    uint32_t tmpW, tmpH, transformHint, numPendingBuffers;
307    mQueueBufferOutput.deflate(&tmpW, &tmpH, &transformHint, &numPendingBuffers);
308    mQueueBufferOutput.inflate(w, h, transformHint, numPendingBuffers);
309
310    mSinkBufferWidth = w;
311    mSinkBufferHeight = h;
312}
313
314const sp<Fence>& VirtualDisplaySurface::getClientTargetAcquireFence() const {
315    return mFbFence;
316}
317
318status_t VirtualDisplaySurface::requestBuffer(int pslot,
319        sp<GraphicBuffer>* outBuf) {
320    if (mDisplayId < 0)
321        return mSource[SOURCE_SINK]->requestBuffer(pslot, outBuf);
322
323    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
324            "Unexpected requestBuffer pslot=%d in %s state",
325            pslot, dbgStateStr());
326
327    *outBuf = mProducerBuffers[pslot];
328    return NO_ERROR;
329}
330
331status_t VirtualDisplaySurface::setMaxDequeuedBufferCount(
332        int maxDequeuedBuffers) {
333    return mSource[SOURCE_SINK]->setMaxDequeuedBufferCount(maxDequeuedBuffers);
334}
335
336status_t VirtualDisplaySurface::setAsyncMode(bool async) {
337    return mSource[SOURCE_SINK]->setAsyncMode(async);
338}
339
340status_t VirtualDisplaySurface::dequeueBuffer(Source source,
341        PixelFormat format, uint32_t usage, int* sslot, sp<Fence>* fence) {
342    LOG_FATAL_IF(mDisplayId < 0, "mDisplayId=%d but should not be < 0.", mDisplayId);
343
344    status_t result = mSource[source]->dequeueBuffer(sslot, fence,
345            mSinkBufferWidth, mSinkBufferHeight, format, usage);
346    if (result < 0)
347        return result;
348    int pslot = mapSource2ProducerSlot(source, *sslot);
349    VDS_LOGV("dequeueBuffer(%s): sslot=%d pslot=%d result=%d",
350            dbgSourceStr(source), *sslot, pslot, result);
351    uint64_t sourceBit = static_cast<uint64_t>(source) << pslot;
352
353    if ((mProducerSlotSource & (1ULL << pslot)) != sourceBit) {
354        // This slot was previously dequeued from the other source; must
355        // re-request the buffer.
356        result |= BUFFER_NEEDS_REALLOCATION;
357        mProducerSlotSource &= ~(1ULL << pslot);
358        mProducerSlotSource |= sourceBit;
359    }
360
361    if (result & RELEASE_ALL_BUFFERS) {
362        for (uint32_t i = 0; i < BufferQueue::NUM_BUFFER_SLOTS; i++) {
363            if ((mProducerSlotSource & (1ULL << i)) == sourceBit)
364                mProducerBuffers[i].clear();
365        }
366    }
367    if (result & BUFFER_NEEDS_REALLOCATION) {
368        result = mSource[source]->requestBuffer(*sslot, &mProducerBuffers[pslot]);
369        if (result < 0) {
370            mProducerBuffers[pslot].clear();
371            mSource[source]->cancelBuffer(*sslot, *fence);
372            return result;
373        }
374        VDS_LOGV("dequeueBuffer(%s): buffers[%d]=%p fmt=%d usage=%#x",
375                dbgSourceStr(source), pslot, mProducerBuffers[pslot].get(),
376                mProducerBuffers[pslot]->getPixelFormat(),
377                mProducerBuffers[pslot]->getUsage());
378    }
379
380    return result;
381}
382
383status_t VirtualDisplaySurface::dequeueBuffer(int* pslot, sp<Fence>* fence,
384        uint32_t w, uint32_t h, PixelFormat format, uint32_t usage) {
385    if (mDisplayId < 0)
386        return mSource[SOURCE_SINK]->dequeueBuffer(pslot, fence, w, h, format, usage);
387
388    VDS_LOGW_IF(mDbgState != DBG_STATE_PREPARED,
389            "Unexpected dequeueBuffer() in %s state", dbgStateStr());
390    mDbgState = DBG_STATE_GLES;
391
392    VDS_LOGV("dequeueBuffer %dx%d fmt=%d usage=%#x", w, h, format, usage);
393
394    status_t result = NO_ERROR;
395    Source source = fbSourceForCompositionType(mCompositionType);
396
397    if (source == SOURCE_SINK) {
398
399        if (mOutputProducerSlot < 0) {
400            // Last chance bailout if something bad happened earlier. For example,
401            // in a GLES configuration, if the sink disappears then dequeueBuffer
402            // will fail, the GLES driver won't queue a buffer, but SurfaceFlinger
403            // will soldier on. So we end up here without a buffer. There should
404            // be lots of scary messages in the log just before this.
405            VDS_LOGE("dequeueBuffer: no buffer, bailing out");
406            return NO_MEMORY;
407        }
408
409        // We already dequeued the output buffer. If the GLES driver wants
410        // something incompatible, we have to cancel and get a new one. This
411        // will mean that HWC will see a different output buffer between
412        // prepare and set, but since we're in GLES-only mode already it
413        // shouldn't matter.
414
415        usage |= GRALLOC_USAGE_HW_COMPOSER;
416        const sp<GraphicBuffer>& buf = mProducerBuffers[mOutputProducerSlot];
417        if ((usage & ~buf->getUsage()) != 0 ||
418                (format != 0 && format != buf->getPixelFormat()) ||
419                (w != 0 && w != mSinkBufferWidth) ||
420                (h != 0 && h != mSinkBufferHeight)) {
421            VDS_LOGV("dequeueBuffer: dequeueing new output buffer: "
422                    "want %dx%d fmt=%d use=%#x, "
423                    "have %dx%d fmt=%d use=%#x",
424                    w, h, format, usage,
425                    mSinkBufferWidth, mSinkBufferHeight,
426                    buf->getPixelFormat(), buf->getUsage());
427            mOutputFormat = format;
428            mOutputUsage = usage;
429            result = refreshOutputBuffer();
430            if (result < 0)
431                return result;
432        }
433    }
434
435    if (source == SOURCE_SINK) {
436        *pslot = mOutputProducerSlot;
437        *fence = mOutputFence;
438    } else {
439        int sslot;
440        result = dequeueBuffer(source, format, usage, &sslot, fence);
441        if (result >= 0) {
442            *pslot = mapSource2ProducerSlot(source, sslot);
443        }
444    }
445    return result;
446}
447
448status_t VirtualDisplaySurface::detachBuffer(int /* slot */) {
449    VDS_LOGE("detachBuffer is not available for VirtualDisplaySurface");
450    return INVALID_OPERATION;
451}
452
453status_t VirtualDisplaySurface::detachNextBuffer(
454        sp<GraphicBuffer>* /* outBuffer */, sp<Fence>* /* outFence */) {
455    VDS_LOGE("detachNextBuffer is not available for VirtualDisplaySurface");
456    return INVALID_OPERATION;
457}
458
459status_t VirtualDisplaySurface::attachBuffer(int* /* outSlot */,
460        const sp<GraphicBuffer>& /* buffer */) {
461    VDS_LOGE("attachBuffer is not available for VirtualDisplaySurface");
462    return INVALID_OPERATION;
463}
464
465status_t VirtualDisplaySurface::queueBuffer(int pslot,
466        const QueueBufferInput& input, QueueBufferOutput* output) {
467    if (mDisplayId < 0)
468        return mSource[SOURCE_SINK]->queueBuffer(pslot, input, output);
469
470    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
471            "Unexpected queueBuffer(pslot=%d) in %s state", pslot,
472            dbgStateStr());
473    mDbgState = DBG_STATE_GLES_DONE;
474
475    VDS_LOGV("queueBuffer pslot=%d", pslot);
476
477    status_t result;
478    if (mCompositionType == COMPOSITION_MIXED) {
479        // Queue the buffer back into the scratch pool
480        QueueBufferOutput scratchQBO;
481        int sslot = mapProducer2SourceSlot(SOURCE_SCRATCH, pslot);
482        result = mSource[SOURCE_SCRATCH]->queueBuffer(sslot, input, &scratchQBO);
483        if (result != NO_ERROR)
484            return result;
485
486        // Now acquire the buffer from the scratch pool -- should be the same
487        // slot and fence as we just queued.
488        Mutex::Autolock lock(mMutex);
489        BufferItem item;
490        result = acquireBufferLocked(&item, 0);
491        if (result != NO_ERROR)
492            return result;
493        VDS_LOGW_IF(item.mSlot != sslot,
494                "queueBuffer: acquired sslot %d from SCRATCH after queueing sslot %d",
495                item.mSlot, sslot);
496        mFbProducerSlot = mapSource2ProducerSlot(SOURCE_SCRATCH, item.mSlot);
497        mFbFence = mSlots[item.mSlot].mFence;
498
499    } else {
500        LOG_FATAL_IF(mCompositionType != COMPOSITION_GLES,
501                "Unexpected queueBuffer in state %s for compositionType %s",
502                dbgStateStr(), dbgCompositionTypeStr(mCompositionType));
503
504        // Extract the GLES release fence for HWC to acquire
505        int64_t timestamp;
506        bool isAutoTimestamp;
507        android_dataspace dataSpace;
508        Rect crop;
509        int scalingMode;
510        uint32_t transform;
511        input.deflate(&timestamp, &isAutoTimestamp, &dataSpace, &crop,
512                &scalingMode, &transform, &mFbFence);
513
514        mFbProducerSlot = pslot;
515        mOutputFence = mFbFence;
516    }
517
518    *output = mQueueBufferOutput;
519    return NO_ERROR;
520}
521
522status_t VirtualDisplaySurface::cancelBuffer(int pslot,
523        const sp<Fence>& fence) {
524    if (mDisplayId < 0)
525        return mSource[SOURCE_SINK]->cancelBuffer(mapProducer2SourceSlot(SOURCE_SINK, pslot), fence);
526
527    VDS_LOGW_IF(mDbgState != DBG_STATE_GLES,
528            "Unexpected cancelBuffer(pslot=%d) in %s state", pslot,
529            dbgStateStr());
530    VDS_LOGV("cancelBuffer pslot=%d", pslot);
531    Source source = fbSourceForCompositionType(mCompositionType);
532    return mSource[source]->cancelBuffer(
533            mapProducer2SourceSlot(source, pslot), fence);
534}
535
536int VirtualDisplaySurface::query(int what, int* value) {
537    switch (what) {
538        case NATIVE_WINDOW_WIDTH:
539            *value = mSinkBufferWidth;
540            break;
541        case NATIVE_WINDOW_HEIGHT:
542            *value = mSinkBufferHeight;
543            break;
544        default:
545            return mSource[SOURCE_SINK]->query(what, value);
546    }
547    return NO_ERROR;
548}
549
550status_t VirtualDisplaySurface::connect(const sp<IProducerListener>& listener,
551        int api, bool producerControlledByApp,
552        QueueBufferOutput* output) {
553    QueueBufferOutput qbo;
554    status_t result = mSource[SOURCE_SINK]->connect(listener, api,
555            producerControlledByApp, &qbo);
556    if (result == NO_ERROR) {
557        updateQueueBufferOutput(qbo);
558        *output = mQueueBufferOutput;
559    }
560    return result;
561}
562
563status_t VirtualDisplaySurface::disconnect(int api) {
564    return mSource[SOURCE_SINK]->disconnect(api);
565}
566
567status_t VirtualDisplaySurface::setSidebandStream(const sp<NativeHandle>& /*stream*/) {
568    return INVALID_OPERATION;
569}
570
571void VirtualDisplaySurface::allocateBuffers(uint32_t /* width */,
572        uint32_t /* height */, PixelFormat /* format */, uint32_t /* usage */) {
573    // TODO: Should we actually allocate buffers for a virtual display?
574}
575
576status_t VirtualDisplaySurface::allowAllocation(bool /* allow */) {
577    return INVALID_OPERATION;
578}
579
580status_t VirtualDisplaySurface::setGenerationNumber(uint32_t /* generation */) {
581    ALOGE("setGenerationNumber not supported on VirtualDisplaySurface");
582    return INVALID_OPERATION;
583}
584
585String8 VirtualDisplaySurface::getConsumerName() const {
586    return String8("VirtualDisplaySurface");
587}
588
589uint64_t VirtualDisplaySurface::getNextFrameNumber() const {
590    return 0;
591}
592
593status_t VirtualDisplaySurface::setSharedBufferMode(bool /*sharedBufferMode*/) {
594    ALOGE("setSharedBufferMode not supported on VirtualDisplaySurface");
595    return INVALID_OPERATION;
596}
597
598status_t VirtualDisplaySurface::setAutoRefresh(bool /*autoRefresh*/) {
599    ALOGE("setAutoRefresh not supported on VirtualDisplaySurface");
600    return INVALID_OPERATION;
601}
602
603status_t VirtualDisplaySurface::setDequeueTimeout(nsecs_t /* timeout */) {
604    ALOGE("setDequeueTimeout not supported on VirtualDisplaySurface");
605    return INVALID_OPERATION;
606}
607
608status_t VirtualDisplaySurface::getLastQueuedBuffer(
609        sp<GraphicBuffer>* /*outBuffer*/, sp<Fence>* /*outFence*/,
610        float[16] /* outTransformMatrix*/) {
611    ALOGE("getLastQueuedBuffer not supported on VirtualDisplaySurface");
612    return INVALID_OPERATION;
613}
614
615status_t VirtualDisplaySurface::getUniqueId(uint64_t* /*outId*/) const {
616    ALOGE("getUniqueId not supported on VirtualDisplaySurface");
617    return INVALID_OPERATION;
618}
619
620void VirtualDisplaySurface::updateQueueBufferOutput(
621        const QueueBufferOutput& qbo) {
622    uint32_t w, h, transformHint, numPendingBuffers;
623    qbo.deflate(&w, &h, &transformHint, &numPendingBuffers);
624    mQueueBufferOutput.inflate(w, h, 0, numPendingBuffers);
625}
626
627void VirtualDisplaySurface::resetPerFrameState() {
628    mCompositionType = COMPOSITION_UNKNOWN;
629    mFbFence = Fence::NO_FENCE;
630    mOutputFence = Fence::NO_FENCE;
631    mOutputProducerSlot = -1;
632    mFbProducerSlot = -1;
633}
634
635status_t VirtualDisplaySurface::refreshOutputBuffer() {
636    if (mOutputProducerSlot >= 0) {
637        mSource[SOURCE_SINK]->cancelBuffer(
638                mapProducer2SourceSlot(SOURCE_SINK, mOutputProducerSlot),
639                mOutputFence);
640    }
641
642    int sslot;
643    status_t result = dequeueBuffer(SOURCE_SINK, mOutputFormat, mOutputUsage,
644            &sslot, &mOutputFence);
645    if (result < 0)
646        return result;
647    mOutputProducerSlot = mapSource2ProducerSlot(SOURCE_SINK, sslot);
648
649    // On GLES-only frames, we don't have the right output buffer acquire fence
650    // until after GLES calls queueBuffer(). So here we just set the buffer
651    // (for use in HWC prepare) but not the fence; we'll call this again with
652    // the proper fence once we have it.
653    result = mHwc.setOutputBuffer(mDisplayId, Fence::NO_FENCE,
654            mProducerBuffers[mOutputProducerSlot]);
655
656    return result;
657}
658
659// This slot mapping function is its own inverse, so two copies are unnecessary.
660// Both are kept to make the intent clear where the function is called, and for
661// the (unlikely) chance that we switch to a different mapping function.
662int VirtualDisplaySurface::mapSource2ProducerSlot(Source source, int sslot) {
663    if (source == SOURCE_SCRATCH) {
664        return BufferQueue::NUM_BUFFER_SLOTS - sslot - 1;
665    } else {
666        return sslot;
667    }
668}
669int VirtualDisplaySurface::mapProducer2SourceSlot(Source source, int pslot) {
670    return mapSource2ProducerSlot(source, pslot);
671}
672
673VirtualDisplaySurface::Source
674VirtualDisplaySurface::fbSourceForCompositionType(CompositionType type) {
675    return type == COMPOSITION_MIXED ? SOURCE_SCRATCH : SOURCE_SINK;
676}
677
678const char* VirtualDisplaySurface::dbgStateStr() const {
679    switch (mDbgState) {
680        case DBG_STATE_IDLE:      return "IDLE";
681        case DBG_STATE_PREPARED:  return "PREPARED";
682        case DBG_STATE_GLES:      return "GLES";
683        case DBG_STATE_GLES_DONE: return "GLES_DONE";
684        case DBG_STATE_HWC:       return "HWC";
685        default:                  return "INVALID";
686    }
687}
688
689const char* VirtualDisplaySurface::dbgSourceStr(Source s) {
690    switch (s) {
691        case SOURCE_SINK:    return "SINK";
692        case SOURCE_SCRATCH: return "SCRATCH";
693        default:             return "INVALID";
694    }
695}
696
697// ---------------------------------------------------------------------------
698} // namespace android
699// ---------------------------------------------------------------------------
700