Layer.cpp revision 47d0812977b7acc4fed6a823203770a57f7a6b78 
13742d9db8b6edb10627b0f89336cca5249f1d15aManuel Roman/*
23742d9db8b6edb10627b0f89336cca5249f1d15aManuel Roman * Copyright (C) 2007 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 <stdlib.h>
18#include <stdint.h>
19#include <sys/types.h>
20
21#include <cutils/compiler.h>
22#include <cutils/native_handle.h>
23#include <cutils/properties.h>
24
25#include <utils/Errors.h>
26#include <utils/Log.h>
27#include <utils/StopWatch.h>
28
29#include <ui/GraphicBuffer.h>
30#include <ui/PixelFormat.h>
31
32#include <surfaceflinger/Surface.h>
33
34#include "clz.h"
35#include "DisplayHardware/DisplayHardware.h"
36#include "DisplayHardware/HWComposer.h"
37#include "GLExtensions.h"
38#include "Layer.h"
39#include "SurfaceFlinger.h"
40#include "SurfaceTextureLayer.h"
41
42#define DEBUG_RESIZE    0
43
44
45namespace android {
46
47// ---------------------------------------------------------------------------
48
49Layer::Layer(SurfaceFlinger* flinger,
50        DisplayID display, const sp<Client>& client)
51    :   LayerBaseClient(flinger, display, client),
52        mTextureName(-1U),
53        mQueuedFrames(0),
54        mCurrentTransform(0),
55        mCurrentScalingMode(NATIVE_WINDOW_SCALING_MODE_FREEZE),
56        mCurrentOpacity(true),
57        mFormat(PIXEL_FORMAT_NONE),
58        mGLExtensions(GLExtensions::getInstance()),
59        mOpaqueLayer(true),
60        mNeedsDithering(false),
61        mSecure(false),
62        mProtectedByApp(false)
63{
64    mCurrentCrop.makeInvalid();
65    glGenTextures(1, &mTextureName);
66}
67
68void Layer::onFirstRef()
69{
70    LayerBaseClient::onFirstRef();
71
72    struct FrameQueuedListener : public SurfaceTexture::FrameAvailableListener {
73        FrameQueuedListener(Layer* layer) : mLayer(layer) { }
74    private:
75        wp<Layer> mLayer;
76        virtual void onFrameAvailable() {
77            sp<Layer> that(mLayer.promote());
78            if (that != 0) {
79                that->onFrameQueued();
80            }
81        }
82    };
83    mSurfaceTexture = new SurfaceTextureLayer(mTextureName, this);
84    mSurfaceTexture->setFrameAvailableListener(new FrameQueuedListener(this));
85    mSurfaceTexture->setSynchronousMode(true);
86    mSurfaceTexture->setBufferCountServer(2);
87}
88
89Layer::~Layer()
90{
91    class MessageDestroyGLState : public MessageBase {
92        GLuint texture;
93    public:
94        MessageDestroyGLState(GLuint texture) : texture(texture) { }
95        virtual bool handler() {
96            glDeleteTextures(1, &texture);
97            return true;
98        }
99    };
100    mFlinger->postMessageAsync( new MessageDestroyGLState(mTextureName) );
101}
102
103void Layer::onFrameQueued() {
104    android_atomic_inc(&mQueuedFrames);
105    mFlinger->signalEvent();
106}
107
108// called with SurfaceFlinger::mStateLock as soon as the layer is entered
109// in the purgatory list
110void Layer::onRemoved()
111{
112    mSurfaceTexture->abandon();
113}
114
115sp<ISurface> Layer::createSurface()
116{
117    class BSurface : public BnSurface, public LayerCleaner {
118        wp<const Layer> mOwner;
119        virtual sp<ISurfaceTexture> getSurfaceTexture() const {
120            sp<ISurfaceTexture> res;
121            sp<const Layer> that( mOwner.promote() );
122            if (that != NULL) {
123                res = that->mSurfaceTexture;
124            }
125            return res;
126        }
127    public:
128        BSurface(const sp<SurfaceFlinger>& flinger,
129                const sp<Layer>& layer)
130            : LayerCleaner(flinger, layer), mOwner(layer) { }
131    };
132    sp<ISurface> sur(new BSurface(mFlinger, this));
133    return sur;
134}
135
136status_t Layer::setBuffers( uint32_t w, uint32_t h,
137                            PixelFormat format, uint32_t flags)
138{
139    // this surfaces pixel format
140    PixelFormatInfo info;
141    status_t err = getPixelFormatInfo(format, &info);
142    if (err) return err;
143
144    // the display's pixel format
145    const DisplayHardware& hw(graphicPlane(0).displayHardware());
146    uint32_t const maxSurfaceDims = min(
147            hw.getMaxTextureSize(), hw.getMaxViewportDims());
148
149    // never allow a surface larger than what our underlying GL implementation
150    // can handle.
151    if ((uint32_t(w)>maxSurfaceDims) || (uint32_t(h)>maxSurfaceDims)) {
152        return BAD_VALUE;
153    }
154
155    PixelFormatInfo displayInfo;
156    getPixelFormatInfo(hw.getFormat(), &displayInfo);
157    const uint32_t hwFlags = hw.getFlags();
158
159    mFormat = format;
160
161    mSecure = (flags & ISurfaceComposer::eSecure) ? true : false;
162    mProtectedByApp = (flags & ISurfaceComposer::eProtectedByApp) ? true : false;
163    mOpaqueLayer = (flags & ISurfaceComposer::eOpaque);
164    mCurrentOpacity = getOpacityForFormat(format);
165
166    mSurfaceTexture->setDefaultBufferSize(w, h);
167    mSurfaceTexture->setDefaultBufferFormat(format);
168
169    // we use the red index
170    int displayRedSize = displayInfo.getSize(PixelFormatInfo::INDEX_RED);
171    int layerRedsize = info.getSize(PixelFormatInfo::INDEX_RED);
172    mNeedsDithering = layerRedsize > displayRedSize;
173
174    return NO_ERROR;
175}
176
177void Layer::setGeometry(hwc_layer_t* hwcl)
178{
179    LayerBaseClient::setGeometry(hwcl);
180
181    hwcl->flags &= ~HWC_SKIP_LAYER;
182
183    // we can't do alpha-fade with the hwc HAL
184    const State& s(drawingState());
185    if (s.alpha < 0xFF) {
186        hwcl->flags = HWC_SKIP_LAYER;
187    }
188
189    /*
190     * Transformations are applied in this order:
191     * 1) buffer orientation/flip/mirror
192     * 2) state transformation (window manager)
193     * 3) layer orientation (screen orientation)
194     * (NOTE: the matrices are multiplied in reverse order)
195     */
196
197    const Transform bufferOrientation(mCurrentTransform);
198    const Transform& stateTransform(s.transform);
199    const Transform layerOrientation(mOrientation);
200
201    const Transform tr(layerOrientation * stateTransform * bufferOrientation);
202
203    // this gives us only the "orientation" component of the transform
204    const uint32_t finalTransform = tr.getOrientation();
205
206    // we can only handle simple transformation
207    if (finalTransform & Transform::ROT_INVALID) {
208        hwcl->flags = HWC_SKIP_LAYER;
209    } else {
210        hwcl->transform = finalTransform;
211    }
212}
213
214void Layer::setPerFrameData(hwc_layer_t* hwcl) {
215    const sp<GraphicBuffer>& buffer(mActiveBuffer);
216    if (buffer == NULL) {
217        // this can happen if the client never drew into this layer yet,
218        // or if we ran out of memory. In that case, don't let
219        // HWC handle it.
220        hwcl->flags |= HWC_SKIP_LAYER;
221        hwcl->handle = NULL;
222    } else {
223        hwcl->handle = buffer->handle;
224    }
225
226    if (isCropped()) {
227        hwcl->sourceCrop.left   = mCurrentCrop.left;
228        hwcl->sourceCrop.top    = mCurrentCrop.top;
229        hwcl->sourceCrop.right  = mCurrentCrop.right;
230        hwcl->sourceCrop.bottom = mCurrentCrop.bottom;
231    } else {
232        hwcl->sourceCrop.left   = 0;
233        hwcl->sourceCrop.top    = 0;
234        if (buffer != NULL) {
235            hwcl->sourceCrop.right  = buffer->width;
236            hwcl->sourceCrop.bottom = buffer->height;
237        } else {
238            hwcl->sourceCrop.right  = mTransformedBounds.width();
239            hwcl->sourceCrop.bottom = mTransformedBounds.height();
240        }
241    }
242}
243
244static inline uint16_t pack565(int r, int g, int b) {
245    return (r<<11)|(g<<5)|b;
246}
247void Layer::onDraw(const Region& clip) const
248{
249    if (CC_UNLIKELY(mActiveBuffer == 0)) {
250        // the texture has not been created yet, this Layer has
251        // in fact never been drawn into. This happens frequently with
252        // SurfaceView because the WindowManager can't know when the client
253        // has drawn the first time.
254
255        // If there is nothing under us, we paint the screen in black, otherwise
256        // we just skip this update.
257
258        // figure out if there is something below us
259        Region under;
260        const SurfaceFlinger::LayerVector& drawingLayers(mFlinger->mDrawingState.layersSortedByZ);
261        const size_t count = drawingLayers.size();
262        for (size_t i=0 ; i<count ; ++i) {
263            const sp<LayerBase>& layer(drawingLayers[i]);
264            if (layer.get() == static_cast<LayerBase const*>(this))
265                break;
266            under.orSelf(layer->visibleRegionScreen);
267        }
268        // if not everything below us is covered, we plug the holes!
269        Region holes(clip.subtract(under));
270        if (!holes.isEmpty()) {
271            clearWithOpenGL(holes, 0, 0, 0, 1);
272        }
273        return;
274    }
275
276    GLenum target = mSurfaceTexture->getCurrentTextureTarget();
277    glBindTexture(target, mTextureName);
278    if (getFiltering() || needsFiltering() || isFixedSize() || isCropped()) {
279        // TODO: we could be more subtle with isFixedSize()
280        glTexParameterx(target, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
281        glTexParameterx(target, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
282    } else {
283        glTexParameterx(target, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
284        glTexParameterx(target, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
285    }
286    glEnable(target);
287    glMatrixMode(GL_TEXTURE);
288    glLoadMatrixf(mTextureMatrix);
289    glMatrixMode(GL_MODELVIEW);
290
291    drawWithOpenGL(clip);
292
293    glDisable(target);
294}
295
296// As documented in libhardware header, formats in the range
297// 0x100 - 0x1FF are specific to the HAL implementation, and
298// are known to have no alpha channel
299// TODO: move definition for device-specific range into
300// hardware.h, instead of using hard-coded values here.
301#define HARDWARE_IS_DEVICE_FORMAT(f) ((f) >= 0x100 && (f) <= 0x1FF)
302
303bool Layer::getOpacityForFormat(uint32_t format)
304{
305    if (HARDWARE_IS_DEVICE_FORMAT(format)) {
306        return true;
307    }
308    PixelFormatInfo info;
309    status_t err = getPixelFormatInfo(PixelFormat(format), &info);
310    // in case of error (unknown format), we assume no blending
311    return (err || info.h_alpha <= info.l_alpha);
312}
313
314
315bool Layer::isOpaque() const
316{
317    // if we don't have a buffer yet, we're translucent regardless of the
318    // layer's opaque flag.
319    if (mActiveBuffer == 0) {
320        return false;
321    }
322
323    // if the layer has the opaque flag, then we're always opaque,
324    // otherwise we use the current buffer's format.
325    return mOpaqueLayer || mCurrentOpacity;
326}
327
328bool Layer::isProtected() const
329{
330    const sp<GraphicBuffer>& activeBuffer(mActiveBuffer);
331    return (activeBuffer != 0) &&
332            (activeBuffer->getUsage() & GRALLOC_USAGE_PROTECTED);
333}
334
335uint32_t Layer::doTransaction(uint32_t flags)
336{
337    const Layer::State& front(drawingState());
338    const Layer::State& temp(currentState());
339
340    const bool sizeChanged = (front.requested_w != temp.requested_w) ||
341            (front.requested_h != temp.requested_h);
342
343    if (sizeChanged) {
344        // the size changed, we need to ask our client to request a new buffer
345        LOGD_IF(DEBUG_RESIZE,
346                "doTransaction: "
347                "resize (layer=%p), requested (%dx%d), drawing (%d,%d), "
348                "scalingMode=%d",
349                this,
350                int(temp.requested_w), int(temp.requested_h),
351                int(front.requested_w), int(front.requested_h),
352                mCurrentScalingMode);
353
354        if (!isFixedSize()) {
355            // we're being resized and there is a freeze display request,
356            // acquire a freeze lock, so that the screen stays put
357            // until we've redrawn at the new size; this is to avoid
358            // glitches upon orientation changes.
359            if (mFlinger->hasFreezeRequest()) {
360                // if the surface is hidden, don't try to acquire the
361                // freeze lock, since hidden surfaces may never redraw
362                if (!(front.flags & ISurfaceComposer::eLayerHidden)) {
363                    mFreezeLock = mFlinger->getFreezeLock();
364                }
365            }
366
367            // this will make sure LayerBase::doTransaction doesn't update
368            // the drawing state's size
369            Layer::State& editDraw(mDrawingState);
370            editDraw.requested_w = temp.requested_w;
371            editDraw.requested_h = temp.requested_h;
372
373            // record the new size, form this point on, when the client request
374            // a buffer, it'll get the new size.
375            mSurfaceTexture->setDefaultBufferSize(temp.requested_w, temp.requested_h);
376        }
377    }
378
379    if (temp.sequence != front.sequence) {
380        if (temp.flags & ISurfaceComposer::eLayerHidden || temp.alpha == 0) {
381            // this surface is now hidden, so it shouldn't hold a freeze lock
382            // (it may never redraw, which is fine if it is hidden)
383            mFreezeLock.clear();
384        }
385    }
386
387    return LayerBase::doTransaction(flags);
388}
389
390bool Layer::isFixedSize() const {
391    return mCurrentScalingMode != NATIVE_WINDOW_SCALING_MODE_FREEZE;
392}
393
394bool Layer::isCropped() const {
395    return !mCurrentCrop.isEmpty();
396}
397
398// ----------------------------------------------------------------------------
399// pageflip handling...
400// ----------------------------------------------------------------------------
401
402void Layer::lockPageFlip(bool& recomputeVisibleRegions)
403{
404    if (mQueuedFrames > 0) {
405        const bool oldOpacity = isOpaque();
406
407        // signal another event if we have more frames pending
408        if (android_atomic_dec(&mQueuedFrames) > 1) {
409            mFlinger->signalEvent();
410        }
411
412        if (mSurfaceTexture->updateTexImage() < NO_ERROR) {
413            // something happened!
414            recomputeVisibleRegions = true;
415            return;
416        }
417
418        mActiveBuffer = mSurfaceTexture->getCurrentBuffer();
419        mSurfaceTexture->getTransformMatrix(mTextureMatrix);
420
421        const Rect crop(mSurfaceTexture->getCurrentCrop());
422        const uint32_t transform(mSurfaceTexture->getCurrentTransform());
423        const uint32_t scalingMode(mSurfaceTexture->getCurrentScalingMode());
424        if ((crop != mCurrentCrop) ||
425            (transform != mCurrentTransform) ||
426            (scalingMode != mCurrentScalingMode))
427        {
428            mCurrentCrop = crop;
429            mCurrentTransform = transform;
430            mCurrentScalingMode = scalingMode;
431            mFlinger->invalidateHwcGeometry();
432        }
433
434        mCurrentOpacity = getOpacityForFormat(mActiveBuffer->format);
435        if (oldOpacity != isOpaque()) {
436            recomputeVisibleRegions = true;
437        }
438
439        const GLenum target(mSurfaceTexture->getCurrentTextureTarget());
440        glTexParameterx(target, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
441        glTexParameterx(target, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
442
443        // update the layer size and release freeze-lock
444        const Layer::State& front(drawingState());
445
446        // FIXME: mPostedDirtyRegion = dirty & bounds
447        mPostedDirtyRegion.set(front.w, front.h);
448
449
450        if ((front.w != front.requested_w) ||
451            (front.h != front.requested_h))
452        {
453            // check that we received a buffer of the right size
454            // (Take the buffer's orientation into account)
455            sp<GraphicBuffer> newFrontBuffer(mActiveBuffer);
456            uint32_t bufWidth  = newFrontBuffer->getWidth();
457            uint32_t bufHeight = newFrontBuffer->getHeight();
458            if (mCurrentTransform & Transform::ROT_90) {
459                swap(bufWidth, bufHeight);
460            }
461
462            if (isFixedSize() ||
463                    (bufWidth == front.requested_w &&
464                    bufHeight == front.requested_h))
465            {
466                // Here we pretend the transaction happened by updating the
467                // current and drawing states. Drawing state is only accessed
468                // in this thread, no need to have it locked
469                Layer::State& editDraw(mDrawingState);
470                editDraw.w = editDraw.requested_w;
471                editDraw.h = editDraw.requested_h;
472
473                // We also need to update the current state so that we don't
474                // end-up doing too much work during the next transaction.
475                // NOTE: We actually don't need hold the transaction lock here
476                // because State::w and State::h are only accessed from
477                // this thread
478                Layer::State& editTemp(currentState());
479                editTemp.w = editDraw.w;
480                editTemp.h = editDraw.h;
481
482                // recompute visible region
483                recomputeVisibleRegions = true;
484
485                // we now have the correct size, unfreeze the screen
486                mFreezeLock.clear();
487            }
488
489            LOGD_IF(DEBUG_RESIZE,
490                    "lockPageFlip : "
491                    "       (layer=%p), buffer (%ux%u, tr=%02x), "
492                    "requested (%dx%d)",
493                    this,
494                    bufWidth, bufHeight, mCurrentTransform,
495                    front.requested_w, front.requested_h);
496        }
497    }
498}
499
500void Layer::unlockPageFlip(
501        const Transform& planeTransform, Region& outDirtyRegion)
502{
503    Region dirtyRegion(mPostedDirtyRegion);
504    if (!dirtyRegion.isEmpty()) {
505        mPostedDirtyRegion.clear();
506        // The dirty region is given in the layer's coordinate space
507        // transform the dirty region by the surface's transformation
508        // and the global transformation.
509        const Layer::State& s(drawingState());
510        const Transform tr(planeTransform * s.transform);
511        dirtyRegion = tr.transform(dirtyRegion);
512
513        // At this point, the dirty region is in screen space.
514        // Make sure it's constrained by the visible region (which
515        // is in screen space as well).
516        dirtyRegion.andSelf(visibleRegionScreen);
517        outDirtyRegion.orSelf(dirtyRegion);
518    }
519    if (visibleRegionScreen.isEmpty()) {
520        // an invisible layer should not hold a freeze-lock
521        // (because it may never be updated and therefore never release it)
522        mFreezeLock.clear();
523    }
524}
525
526void Layer::dump(String8& result, char* buffer, size_t SIZE) const
527{
528    LayerBaseClient::dump(result, buffer, SIZE);
529
530    sp<const GraphicBuffer> buf0(mActiveBuffer);
531    uint32_t w0=0, h0=0, s0=0, f0=0;
532    if (buf0 != 0) {
533        w0 = buf0->getWidth();
534        h0 = buf0->getHeight();
535        s0 = buf0->getStride();
536        f0 = buf0->format;
537    }
538    snprintf(buffer, SIZE,
539            "      "
540            "format=%2d, activeBuffer=[%4ux%4u:%4u,%3X],"
541            " freezeLock=%p, queued-frames=%d\n",
542            mFormat, w0, h0, s0,f0,
543            getFreezeLock().get(), mQueuedFrames);
544
545    result.append(buffer);
546
547    if (mSurfaceTexture != 0) {
548        mSurfaceTexture->dump(result, "            ", buffer, SIZE);
549    }
550}
551
552uint32_t Layer::getEffectiveUsage(uint32_t usage) const
553{
554    // TODO: should we do something special if mSecure is set?
555    if (mProtectedByApp) {
556        // need a hardware-protected path to external video sink
557        usage |= GraphicBuffer::USAGE_PROTECTED;
558    }
559    return usage;
560}
561
562// ---------------------------------------------------------------------------
563
564
565}; // namespace android
566