2 * Copyright (C) 2007 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
20 #include <sys/types.h>
22 #include <utils/Errors.h>
23 #include <utils/Log.h>
24 #include <utils/StopWatch.h>
26 #include <ui/GraphicBuffer.h>
27 #include <ui/PixelFormat.h>
28 #include <ui/FramebufferNativeWindow.h>
30 #include <ui/Region.h>
32 #include <hardware/copybit.h>
34 #include "LayerBuffer.h"
35 #include "SurfaceFlinger.h"
36 #include "DisplayHardware/DisplayHardware.h"
40 // ---------------------------------------------------------------------------
42 gralloc_module_t const* LayerBuffer::sGrallocModule = 0;
44 // ---------------------------------------------------------------------------
46 LayerBuffer::LayerBuffer(SurfaceFlinger* flinger, DisplayID display,
47 const sp<Client>& client)
48 : LayerBaseClient(flinger, display, client),
49 mNeedsBlending(false), mBlitEngine(0)
53 LayerBuffer::~LayerBuffer()
56 copybit_close(mBlitEngine);
60 void LayerBuffer::onFirstRef()
62 LayerBaseClient::onFirstRef();
63 mSurface = new SurfaceLayerBuffer(mFlinger, this);
65 hw_module_t const* module = (hw_module_t const*)sGrallocModule;
67 // NOTE: technically there is a race here, but it shouldn't
68 // cause any problem since hw_get_module() always returns
70 if (hw_get_module(GRALLOC_HARDWARE_MODULE_ID, &module) == 0) {
71 sGrallocModule = (gralloc_module_t const *)module;
75 if (hw_get_module(COPYBIT_HARDWARE_MODULE_ID, &module) == 0) {
76 copybit_open(module, &mBlitEngine);
80 sp<LayerBaseClient::Surface> LayerBuffer::createSurface() const
85 status_t LayerBuffer::ditch()
91 bool LayerBuffer::needsBlending() const {
92 return mNeedsBlending;
95 void LayerBuffer::setNeedsBlending(bool blending) {
96 mNeedsBlending = blending;
99 void LayerBuffer::postBuffer(ssize_t offset)
101 sp<Source> source(getSource());
103 source->postBuffer(offset);
106 void LayerBuffer::unregisterBuffers()
108 sp<Source> source(clearSource());
110 source->unregisterBuffers();
113 uint32_t LayerBuffer::doTransaction(uint32_t flags)
115 sp<Source> source(getSource());
117 source->onTransaction(flags);
118 uint32_t res = LayerBase::doTransaction(flags);
119 // we always want filtering for these surfaces
120 mNeedsFiltering = !(mFlags & DisplayHardware::SLOW_CONFIG);
124 void LayerBuffer::unlockPageFlip(const Transform& planeTransform,
125 Region& outDirtyRegion)
127 // this code-path must be as tight as possible, it's called each time
128 // the screen is composited.
129 sp<Source> source(getSource());
131 source->onVisibilityResolved(planeTransform);
132 LayerBase::unlockPageFlip(planeTransform, outDirtyRegion);
135 void LayerBuffer::validateVisibility(const Transform& globalTransform)
137 sp<Source> source(getSource());
139 source->onvalidateVisibility(globalTransform);
140 LayerBase::validateVisibility(globalTransform);
143 void LayerBuffer::drawForSreenShot() const
145 const DisplayHardware& hw(graphicPlane(0).displayHardware());
146 clearWithOpenGL( Region(hw.bounds()) );
149 void LayerBuffer::onDraw(const Region& clip) const
151 sp<Source> source(getSource());
152 if (LIKELY(source != 0)) {
153 source->onDraw(clip);
155 clearWithOpenGL(clip);
159 void LayerBuffer::serverDestroy()
161 sp<Source> source(clearSource());
168 * This creates a "buffer" source for this surface
170 status_t LayerBuffer::registerBuffers(const ISurface::BufferHeap& buffers)
172 Mutex::Autolock _l(mLock);
174 return INVALID_OPERATION;
176 sp<BufferSource> source = new BufferSource(*this, buffers);
178 status_t result = source->getStatus();
179 if (result == NO_ERROR) {
186 * This creates an "overlay" source for this surface
188 sp<OverlayRef> LayerBuffer::createOverlay(uint32_t w, uint32_t h, int32_t f,
191 sp<OverlayRef> result;
192 Mutex::Autolock _l(mLock);
196 sp<OverlaySource> source = new OverlaySource(*this, &result, w, h, f, orientation);
203 sp<LayerBuffer::Source> LayerBuffer::getSource() const {
204 Mutex::Autolock _l(mLock);
208 sp<LayerBuffer::Source> LayerBuffer::clearSource() {
210 Mutex::Autolock _l(mLock);
216 // ============================================================================
217 // LayerBuffer::SurfaceLayerBuffer
218 // ============================================================================
220 LayerBuffer::SurfaceLayerBuffer::SurfaceLayerBuffer(
221 const sp<SurfaceFlinger>& flinger, const sp<LayerBuffer>& owner)
222 : LayerBaseClient::Surface(flinger, owner->getIdentity(), owner)
226 LayerBuffer::SurfaceLayerBuffer::~SurfaceLayerBuffer()
231 status_t LayerBuffer::SurfaceLayerBuffer::registerBuffers(
232 const ISurface::BufferHeap& buffers)
234 sp<LayerBuffer> owner(getOwner());
236 return owner->registerBuffers(buffers);
240 void LayerBuffer::SurfaceLayerBuffer::postBuffer(ssize_t offset)
242 sp<LayerBuffer> owner(getOwner());
244 owner->postBuffer(offset);
247 void LayerBuffer::SurfaceLayerBuffer::unregisterBuffers()
249 sp<LayerBuffer> owner(getOwner());
251 owner->unregisterBuffers();
254 sp<OverlayRef> LayerBuffer::SurfaceLayerBuffer::createOverlay(
255 uint32_t w, uint32_t h, int32_t format, int32_t orientation) {
256 sp<OverlayRef> result;
257 sp<LayerBuffer> owner(getOwner());
259 result = owner->createOverlay(w, h, format, orientation);
263 // ============================================================================
264 // LayerBuffer::Buffer
265 // ============================================================================
267 LayerBuffer::Buffer::Buffer(const ISurface::BufferHeap& buffers,
268 ssize_t offset, size_t bufferSize)
269 : mBufferHeap(buffers), mSupportsCopybit(false)
271 NativeBuffer& src(mNativeBuffer);
274 src.crop.r = buffers.w;
275 src.crop.b = buffers.h;
277 src.img.w = buffers.hor_stride ?: buffers.w;
278 src.img.h = buffers.ver_stride ?: buffers.h;
279 src.img.format = buffers.format;
280 src.img.base = (void*)(intptr_t(buffers.heap->base()) + offset);
283 gralloc_module_t const * module = LayerBuffer::getGrallocModule();
284 if (module && module->perform) {
285 int err = module->perform(module,
286 GRALLOC_MODULE_PERFORM_CREATE_HANDLE_FROM_BUFFER,
287 buffers.heap->heapID(), bufferSize,
288 offset, buffers.heap->base(),
291 // we can fail here is the passed buffer is purely software
292 mSupportsCopybit = (err == NO_ERROR);
296 LayerBuffer::Buffer::~Buffer()
298 NativeBuffer& src(mNativeBuffer);
299 if (src.img.handle) {
300 native_handle_delete(src.img.handle);
304 // ============================================================================
305 // LayerBuffer::Source
306 // LayerBuffer::BufferSource
307 // LayerBuffer::OverlaySource
308 // ============================================================================
310 LayerBuffer::Source::Source(LayerBuffer& layer)
314 LayerBuffer::Source::~Source() {
316 void LayerBuffer::Source::onDraw(const Region& clip) const {
318 void LayerBuffer::Source::onTransaction(uint32_t flags) {
320 void LayerBuffer::Source::onVisibilityResolved(
321 const Transform& planeTransform) {
323 void LayerBuffer::Source::postBuffer(ssize_t offset) {
325 void LayerBuffer::Source::unregisterBuffers() {
328 // ---------------------------------------------------------------------------
330 LayerBuffer::BufferSource::BufferSource(LayerBuffer& layer,
331 const ISurface::BufferHeap& buffers)
332 : Source(layer), mStatus(NO_ERROR), mBufferSize(0)
334 if (buffers.heap == NULL) {
335 // this is allowed, but in this case, it is illegal to receive
336 // postBuffer(). The surface just erases the framebuffer with
337 // fully transparent pixels.
338 mBufferHeap = buffers;
339 mLayer.setNeedsBlending(false);
343 status_t err = (buffers.heap->heapID() >= 0) ? NO_ERROR : NO_INIT;
344 if (err != NO_ERROR) {
345 LOGE("LayerBuffer::BufferSource: invalid heap (%s)", strerror(err));
350 PixelFormatInfo info;
351 err = getPixelFormatInfo(buffers.format, &info);
352 if (err != NO_ERROR) {
353 LOGE("LayerBuffer::BufferSource: invalid format %d (%s)",
354 buffers.format, strerror(err));
359 if (buffers.hor_stride<0 || buffers.ver_stride<0) {
360 LOGE("LayerBuffer::BufferSource: invalid parameters "
361 "(w=%d, h=%d, xs=%d, ys=%d)",
362 buffers.w, buffers.h, buffers.hor_stride, buffers.ver_stride);
367 mBufferHeap = buffers;
368 mLayer.setNeedsBlending((info.h_alpha - info.l_alpha) > 0);
369 mBufferSize = info.getScanlineSize(buffers.hor_stride)*buffers.ver_stride;
370 mLayer.forceVisibilityTransaction();
373 LayerBuffer::BufferSource::~BufferSource()
375 class MessageDestroyTexture : public MessageBase {
376 SurfaceFlinger* flinger;
379 MessageDestroyTexture(
380 SurfaceFlinger* flinger, GLuint name)
381 : flinger(flinger), name(name) { }
382 virtual bool handler() {
383 glDeleteTextures(1, &name);
388 if (mTexture.name != -1U) {
389 // GL textures can only be destroyed from the GL thread
390 getFlinger()->mEventQueue.postMessage(
391 new MessageDestroyTexture(getFlinger(), mTexture.name) );
393 if (mTexture.image != EGL_NO_IMAGE_KHR) {
394 EGLDisplay dpy(getFlinger()->graphicPlane(0).getEGLDisplay());
395 eglDestroyImageKHR(dpy, mTexture.image);
399 void LayerBuffer::BufferSource::postBuffer(ssize_t offset)
401 ISurface::BufferHeap buffers;
402 { // scope for the lock
403 Mutex::Autolock _l(mBufferSourceLock);
404 buffers = mBufferHeap;
405 if (buffers.heap != 0) {
406 const size_t memorySize = buffers.heap->getSize();
407 if ((size_t(offset) + mBufferSize) > memorySize) {
408 LOGE("LayerBuffer::BufferSource::postBuffer() "
409 "invalid buffer (offset=%d, size=%d, heap-size=%d",
410 int(offset), int(mBufferSize), int(memorySize));
417 if (buffers.heap != 0) {
418 buffer = new LayerBuffer::Buffer(buffers, offset, mBufferSize);
419 if (buffer->getStatus() != NO_ERROR)
426 void LayerBuffer::BufferSource::unregisterBuffers()
428 Mutex::Autolock _l(mBufferSourceLock);
429 mBufferHeap.heap.clear();
434 sp<LayerBuffer::Buffer> LayerBuffer::BufferSource::getBuffer() const
436 Mutex::Autolock _l(mBufferSourceLock);
440 void LayerBuffer::BufferSource::setBuffer(const sp<LayerBuffer::Buffer>& buffer)
442 Mutex::Autolock _l(mBufferSourceLock);
446 void LayerBuffer::BufferSource::onDraw(const Region& clip) const
448 sp<Buffer> ourBuffer(getBuffer());
449 if (UNLIKELY(ourBuffer == 0)) {
450 // nothing to do, we don't have a buffer
451 mLayer.clearWithOpenGL(clip);
455 status_t err = NO_ERROR;
456 NativeBuffer src(ourBuffer->getBuffer());
457 const Rect transformedBounds(mLayer.getTransformedBounds());
459 #if defined(EGL_ANDROID_image_native_buffer)
460 if (GLExtensions::getInstance().haveDirectTexture()) {
461 err = INVALID_OPERATION;
462 if (ourBuffer->supportsCopybit()) {
463 copybit_device_t* copybit = mLayer.mBlitEngine;
464 if (copybit && err != NO_ERROR) {
465 // create our EGLImageKHR the first time
466 err = initTempBuffer();
467 if (err == NO_ERROR) {
468 // NOTE: Assume the buffer is allocated with the proper USAGE flags
469 const NativeBuffer& dst(mTempBuffer);
470 region_iterator clip(Region(Rect(dst.crop.r, dst.crop.b)));
471 copybit->set_parameter(copybit, COPYBIT_TRANSFORM, 0);
472 copybit->set_parameter(copybit, COPYBIT_PLANE_ALPHA, 0xFF);
473 copybit->set_parameter(copybit, COPYBIT_DITHER, COPYBIT_ENABLE);
474 err = copybit->stretch(copybit, &dst.img, &src.img,
475 &dst.crop, &src.crop, &clip);
476 if (err != NO_ERROR) {
477 clearTempBufferImage();
485 err = INVALID_OPERATION;
488 if (err != NO_ERROR) {
491 t.version = sizeof(GGLSurface);
492 t.width = src.crop.r;
493 t.height = src.crop.b;
494 t.stride = src.img.w;
495 t.vstride= src.img.h;
496 t.format = src.img.format;
497 t.data = (GGLubyte*)src.img.base;
498 const Region dirty(Rect(t.width, t.height));
499 mTextureManager.loadTexture(&mTexture, dirty, t);
502 mLayer.setBufferTransform(mBufferHeap.transform);
503 mLayer.drawWithOpenGL(clip, mTexture);
506 status_t LayerBuffer::BufferSource::initTempBuffer() const
508 // figure out the size we need now
509 const ISurface::BufferHeap& buffers(mBufferHeap);
510 uint32_t w = mLayer.mTransformedBounds.width();
511 uint32_t h = mLayer.mTransformedBounds.height();
512 if (buffers.w * h != buffers.h * w) {
513 int t = w; w = h; h = t;
516 // we're in the copybit case, so make sure we can handle this blit
517 // we don't have to keep the aspect ratio here
518 copybit_device_t* copybit = mLayer.mBlitEngine;
519 const int down = copybit->get(copybit, COPYBIT_MINIFICATION_LIMIT);
520 const int up = copybit->get(copybit, COPYBIT_MAGNIFICATION_LIMIT);
521 if (buffers.w > w*down) w = buffers.w / down;
522 else if (w > buffers.w*up) w = buffers.w*up;
523 if (buffers.h > h*down) h = buffers.h / down;
524 else if (h > buffers.h*up) h = buffers.h*up;
526 if (mTexture.image != EGL_NO_IMAGE_KHR) {
527 // we have an EGLImage, make sure the needed size didn't change
528 if (w!=mTexture.width || h!= mTexture.height) {
529 // delete the EGLImage and texture
530 clearTempBufferImage();
532 // we're good, we have an EGLImageKHR and it's (still) the
538 // figure out if we need linear filtering
539 if (buffers.w * h == buffers.h * w) {
540 // same pixel area, don't use filtering
541 mLayer.mNeedsFiltering = false;
544 // Allocate a temporary buffer and create the corresponding EGLImageKHR
545 // once the EGLImage has been created we don't need the
546 // graphic buffer reference anymore.
547 sp<GraphicBuffer> buffer = new GraphicBuffer(
548 w, h, HAL_PIXEL_FORMAT_RGB_565,
549 GraphicBuffer::USAGE_HW_TEXTURE |
550 GraphicBuffer::USAGE_HW_2D);
552 status_t err = buffer->initCheck();
553 if (err == NO_ERROR) {
554 NativeBuffer& dst(mTempBuffer);
555 dst.img.w = buffer->getStride();
557 dst.img.format = buffer->getPixelFormat();
558 dst.img.handle = (native_handle_t *)buffer->handle;
565 EGLDisplay dpy(getFlinger()->graphicPlane(0).getEGLDisplay());
566 err = mTextureManager.initEglImage(&mTexture, dpy, buffer);
572 void LayerBuffer::BufferSource::clearTempBufferImage() const
575 EGLDisplay dpy(getFlinger()->graphicPlane(0).getEGLDisplay());
576 eglDestroyImageKHR(dpy, mTexture.image);
578 // and the associated texture (recreate a name)
579 glDeleteTextures(1, &mTexture.name);
580 Texture defaultTexture;
581 mTexture = defaultTexture;
584 // ---------------------------------------------------------------------------
586 LayerBuffer::OverlaySource::OverlaySource(LayerBuffer& layer,
587 sp<OverlayRef>* overlayRef,
588 uint32_t w, uint32_t h, int32_t format, int32_t orientation)
589 : Source(layer), mVisibilityChanged(false),
590 mOverlay(0), mOverlayHandle(0), mOverlayDevice(0), mOrientation(orientation)
592 overlay_control_device_t* overlay_dev = getFlinger()->getOverlayEngine();
593 if (overlay_dev == NULL) {
594 // overlays not supported
598 mOverlayDevice = overlay_dev;
599 overlay_t* overlay = overlay_dev->createOverlay(overlay_dev, w, h, format);
600 if (overlay == NULL) {
601 // couldn't create the overlay (no memory? no more overlays?)
605 // enable dithering...
606 overlay_dev->setParameter(overlay_dev, overlay,
607 OVERLAY_DITHER, OVERLAY_ENABLE);
611 mHeight = overlay->h;
612 mFormat = overlay->format;
613 mWidthStride = overlay->w_stride;
614 mHeightStride = overlay->h_stride;
615 mInitialized = false;
617 mOverlayHandle = overlay->getHandleRef(overlay);
619 sp<OverlayChannel> channel = new OverlayChannel( &layer );
621 *overlayRef = new OverlayRef(mOverlayHandle, channel,
622 mWidth, mHeight, mFormat, mWidthStride, mHeightStride);
623 getFlinger()->signalEvent();
626 LayerBuffer::OverlaySource::~OverlaySource()
628 if (mOverlay && mOverlayDevice) {
629 overlay_control_device_t* overlay_dev = mOverlayDevice;
630 overlay_dev->destroyOverlay(overlay_dev, mOverlay);
634 void LayerBuffer::OverlaySource::onDraw(const Region& clip) const
636 // this would be where the color-key would be set, should we need it.
640 mLayer.clearWithOpenGL(clip, red, green, blue, 0);
643 void LayerBuffer::OverlaySource::onTransaction(uint32_t flags)
645 const Layer::State& front(mLayer.drawingState());
646 const Layer::State& temp(mLayer.currentState());
647 if (temp.sequence != front.sequence) {
648 mVisibilityChanged = true;
652 void LayerBuffer::OverlaySource::onvalidateVisibility(const Transform&)
654 mVisibilityChanged = true;
657 void LayerBuffer::OverlaySource::onVisibilityResolved(
658 const Transform& planeTransform)
660 // this code-path must be as tight as possible, it's called each time
661 // the screen is composited.
662 if (UNLIKELY(mOverlay != 0)) {
663 if (mVisibilityChanged || !mInitialized) {
664 mVisibilityChanged = false;
666 const Rect bounds(mLayer.getTransformedBounds());
669 int w = bounds.width();
670 int h = bounds.height();
672 // we need a lock here to protect "destroy"
673 Mutex::Autolock _l(mOverlaySourceLock);
675 overlay_control_device_t* overlay_dev = mOverlayDevice;
676 overlay_dev->setPosition(overlay_dev, mOverlay, x,y,w,h);
677 // we need to combine the layer orientation and the
678 // user-requested orientation.
679 Transform finalTransform(Transform(mLayer.getOrientation()) *
680 Transform(mOrientation));
681 overlay_dev->setParameter(overlay_dev, mOverlay,
682 OVERLAY_TRANSFORM, finalTransform.getOrientation());
683 overlay_dev->commit(overlay_dev, mOverlay);
689 void LayerBuffer::OverlaySource::destroy()
691 // we need a lock here to protect "onVisibilityResolved"
692 Mutex::Autolock _l(mOverlaySourceLock);
693 if (mOverlay && mOverlayDevice) {
694 overlay_control_device_t* overlay_dev = mOverlayDevice;
695 overlay_dev->destroyOverlay(overlay_dev, mOverlay);
700 // ---------------------------------------------------------------------------
701 }; // namespace android