2 * Copyright (C) 2010 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.
17 #define LOG_TAG "SurfaceTextureClient"
18 #define ATRACE_TAG ATRACE_TAG_GRAPHICS
19 //#define LOG_NDEBUG 0
21 #include <android/native_window.h>
23 #include <utils/Log.h>
24 #include <utils/Trace.h>
26 #include <gui/ISurfaceComposer.h>
27 #include <gui/SurfaceComposerClient.h>
28 #include <gui/SurfaceTexture.h>
29 #include <gui/SurfaceTextureClient.h>
31 #include <private/gui/ComposerService.h>
35 SurfaceTextureClient::SurfaceTextureClient(
36 const sp<ISurfaceTexture>& surfaceTexture)
38 SurfaceTextureClient::init();
39 SurfaceTextureClient::setISurfaceTexture(surfaceTexture);
42 // see SurfaceTextureClient.h
43 SurfaceTextureClient::SurfaceTextureClient(const
44 sp<SurfaceTexture>& surfaceTexture)
46 SurfaceTextureClient::init();
47 SurfaceTextureClient::setISurfaceTexture(surfaceTexture->getBufferQueue());
50 SurfaceTextureClient::SurfaceTextureClient() {
51 SurfaceTextureClient::init();
54 SurfaceTextureClient::~SurfaceTextureClient() {
55 if (mConnectedToCpu) {
56 SurfaceTextureClient::disconnect(NATIVE_WINDOW_API_CPU);
60 void SurfaceTextureClient::init() {
61 // Initialize the ANativeWindow function pointers.
62 ANativeWindow::setSwapInterval = hook_setSwapInterval;
63 ANativeWindow::dequeueBuffer = hook_dequeueBuffer;
64 ANativeWindow::cancelBuffer = hook_cancelBuffer;
65 ANativeWindow::lockBuffer = hook_lockBuffer;
66 ANativeWindow::queueBuffer = hook_queueBuffer;
67 ANativeWindow::query = hook_query;
68 ANativeWindow::perform = hook_perform;
70 const_cast<int&>(ANativeWindow::minSwapInterval) = 0;
71 const_cast<int&>(ANativeWindow::maxSwapInterval) = 1;
77 mTimestamp = NATIVE_WINDOW_TIMESTAMP_AUTO;
79 mScalingMode = NATIVE_WINDOW_SCALING_MODE_FREEZE;
84 mConnectedToCpu = false;
87 void SurfaceTextureClient::setISurfaceTexture(
88 const sp<ISurfaceTexture>& surfaceTexture)
90 mSurfaceTexture = surfaceTexture;
93 sp<ISurfaceTexture> SurfaceTextureClient::getISurfaceTexture() const {
94 return mSurfaceTexture;
97 int SurfaceTextureClient::hook_setSwapInterval(ANativeWindow* window, int interval) {
98 SurfaceTextureClient* c = getSelf(window);
99 return c->setSwapInterval(interval);
102 int SurfaceTextureClient::hook_dequeueBuffer(ANativeWindow* window,
103 ANativeWindowBuffer** buffer) {
104 SurfaceTextureClient* c = getSelf(window);
105 return c->dequeueBuffer(buffer);
108 int SurfaceTextureClient::hook_cancelBuffer(ANativeWindow* window,
109 ANativeWindowBuffer* buffer) {
110 SurfaceTextureClient* c = getSelf(window);
111 return c->cancelBuffer(buffer);
114 int SurfaceTextureClient::hook_lockBuffer(ANativeWindow* window,
115 ANativeWindowBuffer* buffer) {
116 SurfaceTextureClient* c = getSelf(window);
117 return c->lockBuffer(buffer);
120 int SurfaceTextureClient::hook_queueBuffer(ANativeWindow* window,
121 ANativeWindowBuffer* buffer) {
122 SurfaceTextureClient* c = getSelf(window);
123 return c->queueBuffer(buffer);
126 int SurfaceTextureClient::hook_query(const ANativeWindow* window,
127 int what, int* value) {
128 const SurfaceTextureClient* c = getSelf(window);
129 return c->query(what, value);
132 int SurfaceTextureClient::hook_perform(ANativeWindow* window, int operation, ...) {
134 va_start(args, operation);
135 SurfaceTextureClient* c = getSelf(window);
136 return c->perform(operation, args);
139 int SurfaceTextureClient::setSwapInterval(int interval) {
141 // EGL specification states:
142 // interval is silently clamped to minimum and maximum implementation
143 // dependent values before being stored.
144 // Although we don't have to, we apply the same logic here.
146 if (interval < minSwapInterval)
147 interval = minSwapInterval;
149 if (interval > maxSwapInterval)
150 interval = maxSwapInterval;
152 status_t res = mSurfaceTexture->setSynchronousMode(interval ? true : false);
157 int SurfaceTextureClient::dequeueBuffer(android_native_buffer_t** buffer) {
159 ALOGV("SurfaceTextureClient::dequeueBuffer");
160 Mutex::Autolock lock(mMutex);
162 status_t result = mSurfaceTexture->dequeueBuffer(&buf, mReqWidth, mReqHeight,
163 mReqFormat, mReqUsage);
165 ALOGV("dequeueBuffer: ISurfaceTexture::dequeueBuffer(%d, %d, %d, %d)"
166 "failed: %d", mReqWidth, mReqHeight, mReqFormat, mReqUsage,
170 sp<GraphicBuffer>& gbuf(mSlots[buf]);
171 if (result & ISurfaceTexture::RELEASE_ALL_BUFFERS) {
175 if ((result & ISurfaceTexture::BUFFER_NEEDS_REALLOCATION) || gbuf == 0) {
176 result = mSurfaceTexture->requestBuffer(buf, &gbuf);
177 if (result != NO_ERROR) {
178 ALOGE("dequeueBuffer: ISurfaceTexture::requestBuffer failed: %d",
183 *buffer = gbuf.get();
187 int SurfaceTextureClient::cancelBuffer(android_native_buffer_t* buffer) {
189 ALOGV("SurfaceTextureClient::cancelBuffer");
190 Mutex::Autolock lock(mMutex);
191 int i = getSlotFromBufferLocked(buffer);
195 mSurfaceTexture->cancelBuffer(i);
199 int SurfaceTextureClient::getSlotFromBufferLocked(
200 android_native_buffer_t* buffer) const {
201 bool dumpedState = false;
202 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
203 // XXX: Dump the slots whenever we hit a NULL entry while searching for
205 if (mSlots[i] == NULL) {
207 ALOGD("getSlotFromBufferLocked: encountered NULL buffer in slot %d "
208 "looking for buffer %p", i, buffer->handle);
209 for (int j = 0; j < NUM_BUFFER_SLOTS; j++) {
210 if (mSlots[j] == NULL) {
211 ALOGD("getSlotFromBufferLocked: %02d: NULL", j);
213 ALOGD("getSlotFromBufferLocked: %02d: %p", j, mSlots[j]->handle);
220 if (mSlots[i] != NULL && mSlots[i]->handle == buffer->handle) {
224 ALOGE("getSlotFromBufferLocked: unknown buffer: %p", buffer->handle);
228 int SurfaceTextureClient::lockBuffer(android_native_buffer_t* buffer) {
229 ALOGV("SurfaceTextureClient::lockBuffer");
230 Mutex::Autolock lock(mMutex);
234 int SurfaceTextureClient::queueBuffer(android_native_buffer_t* buffer) {
236 ALOGV("SurfaceTextureClient::queueBuffer");
237 Mutex::Autolock lock(mMutex);
239 if (mTimestamp == NATIVE_WINDOW_TIMESTAMP_AUTO) {
240 timestamp = systemTime(SYSTEM_TIME_MONOTONIC);
241 ALOGV("SurfaceTextureClient::queueBuffer making up timestamp: %.2f ms",
242 timestamp / 1000000.f);
244 timestamp = mTimestamp;
246 int i = getSlotFromBufferLocked(buffer);
250 status_t err = mSurfaceTexture->queueBuffer(i, timestamp,
251 mCrop, mScalingMode, mTransform,
252 &mDefaultWidth, &mDefaultHeight, &mTransformHint);
254 ALOGE("queueBuffer: error queuing buffer to SurfaceTexture, %d", err);
259 int SurfaceTextureClient::query(int what, int* value) const {
261 ALOGV("SurfaceTextureClient::query");
262 { // scope for the lock
263 Mutex::Autolock lock(mMutex);
265 case NATIVE_WINDOW_FORMAT:
271 case NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER:
273 sp<ISurfaceComposer> composer(
274 ComposerService::getComposerService());
275 if (composer->authenticateSurfaceTexture(mSurfaceTexture)) {
282 case NATIVE_WINDOW_CONCRETE_TYPE:
283 *value = NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT;
285 case NATIVE_WINDOW_DEFAULT_WIDTH:
286 *value = mDefaultWidth;
288 case NATIVE_WINDOW_DEFAULT_HEIGHT:
289 *value = mDefaultHeight;
291 case NATIVE_WINDOW_TRANSFORM_HINT:
292 *value = mTransformHint;
296 return mSurfaceTexture->query(what, value);
299 int SurfaceTextureClient::perform(int operation, va_list args)
303 case NATIVE_WINDOW_CONNECT:
304 // deprecated. must return NO_ERROR.
306 case NATIVE_WINDOW_DISCONNECT:
307 // deprecated. must return NO_ERROR.
309 case NATIVE_WINDOW_SET_USAGE:
310 res = dispatchSetUsage(args);
312 case NATIVE_WINDOW_SET_CROP:
313 res = dispatchSetCrop(args);
315 case NATIVE_WINDOW_SET_BUFFER_COUNT:
316 res = dispatchSetBufferCount(args);
318 case NATIVE_WINDOW_SET_BUFFERS_GEOMETRY:
319 res = dispatchSetBuffersGeometry(args);
321 case NATIVE_WINDOW_SET_BUFFERS_TRANSFORM:
322 res = dispatchSetBuffersTransform(args);
324 case NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP:
325 res = dispatchSetBuffersTimestamp(args);
327 case NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS:
328 res = dispatchSetBuffersDimensions(args);
330 case NATIVE_WINDOW_SET_BUFFERS_FORMAT:
331 res = dispatchSetBuffersFormat(args);
333 case NATIVE_WINDOW_LOCK:
334 res = dispatchLock(args);
336 case NATIVE_WINDOW_UNLOCK_AND_POST:
337 res = dispatchUnlockAndPost(args);
339 case NATIVE_WINDOW_SET_SCALING_MODE:
340 res = dispatchSetScalingMode(args);
342 case NATIVE_WINDOW_API_CONNECT:
343 res = dispatchConnect(args);
345 case NATIVE_WINDOW_API_DISCONNECT:
346 res = dispatchDisconnect(args);
349 res = NAME_NOT_FOUND;
355 int SurfaceTextureClient::dispatchConnect(va_list args) {
356 int api = va_arg(args, int);
360 int SurfaceTextureClient::dispatchDisconnect(va_list args) {
361 int api = va_arg(args, int);
362 return disconnect(api);
365 int SurfaceTextureClient::dispatchSetUsage(va_list args) {
366 int usage = va_arg(args, int);
367 return setUsage(usage);
370 int SurfaceTextureClient::dispatchSetCrop(va_list args) {
371 android_native_rect_t const* rect = va_arg(args, android_native_rect_t*);
372 return setCrop(reinterpret_cast<Rect const*>(rect));
375 int SurfaceTextureClient::dispatchSetBufferCount(va_list args) {
376 size_t bufferCount = va_arg(args, size_t);
377 return setBufferCount(bufferCount);
380 int SurfaceTextureClient::dispatchSetBuffersGeometry(va_list args) {
381 int w = va_arg(args, int);
382 int h = va_arg(args, int);
383 int f = va_arg(args, int);
384 int err = setBuffersDimensions(w, h);
388 return setBuffersFormat(f);
391 int SurfaceTextureClient::dispatchSetBuffersDimensions(va_list args) {
392 int w = va_arg(args, int);
393 int h = va_arg(args, int);
394 return setBuffersDimensions(w, h);
397 int SurfaceTextureClient::dispatchSetBuffersFormat(va_list args) {
398 int f = va_arg(args, int);
399 return setBuffersFormat(f);
402 int SurfaceTextureClient::dispatchSetScalingMode(va_list args) {
403 int m = va_arg(args, int);
404 return setScalingMode(m);
407 int SurfaceTextureClient::dispatchSetBuffersTransform(va_list args) {
408 int transform = va_arg(args, int);
409 return setBuffersTransform(transform);
412 int SurfaceTextureClient::dispatchSetBuffersTimestamp(va_list args) {
413 int64_t timestamp = va_arg(args, int64_t);
414 return setBuffersTimestamp(timestamp);
417 int SurfaceTextureClient::dispatchLock(va_list args) {
418 ANativeWindow_Buffer* outBuffer = va_arg(args, ANativeWindow_Buffer*);
419 ARect* inOutDirtyBounds = va_arg(args, ARect*);
420 return lock(outBuffer, inOutDirtyBounds);
423 int SurfaceTextureClient::dispatchUnlockAndPost(va_list args) {
424 return unlockAndPost();
428 int SurfaceTextureClient::connect(int api) {
430 ALOGV("SurfaceTextureClient::connect");
431 Mutex::Autolock lock(mMutex);
432 int err = mSurfaceTexture->connect(api,
433 &mDefaultWidth, &mDefaultHeight, &mTransformHint);
434 if (!err && api == NATIVE_WINDOW_API_CPU) {
435 mConnectedToCpu = true;
440 int SurfaceTextureClient::disconnect(int api) {
442 ALOGV("SurfaceTextureClient::disconnect");
443 Mutex::Autolock lock(mMutex);
445 int err = mSurfaceTexture->disconnect(api);
452 mScalingMode = NATIVE_WINDOW_SCALING_MODE_FREEZE;
454 if (api == NATIVE_WINDOW_API_CPU) {
455 mConnectedToCpu = false;
461 int SurfaceTextureClient::setUsage(uint32_t reqUsage)
463 ALOGV("SurfaceTextureClient::setUsage");
464 Mutex::Autolock lock(mMutex);
465 mReqUsage = reqUsage;
469 int SurfaceTextureClient::setCrop(Rect const* rect)
472 ALOGV("SurfaceTextureClient::setCrop");
475 if (rect == NULL || rect->isEmpty()) {
481 Mutex::Autolock lock(mMutex);
486 int SurfaceTextureClient::setBufferCount(int bufferCount)
489 ALOGV("SurfaceTextureClient::setBufferCount");
490 Mutex::Autolock lock(mMutex);
492 status_t err = mSurfaceTexture->setBufferCount(bufferCount);
493 ALOGE_IF(err, "ISurfaceTexture::setBufferCount(%d) returned %s",
494 bufferCount, strerror(-err));
496 if (err == NO_ERROR) {
503 int SurfaceTextureClient::setBuffersDimensions(int w, int h)
506 ALOGV("SurfaceTextureClient::setBuffersDimensions");
511 if ((w && !h) || (!w && h))
514 Mutex::Autolock lock(mMutex);
521 int SurfaceTextureClient::setBuffersFormat(int format)
523 ALOGV("SurfaceTextureClient::setBuffersFormat");
528 Mutex::Autolock lock(mMutex);
533 int SurfaceTextureClient::setScalingMode(int mode)
536 ALOGV("SurfaceTextureClient::setScalingMode(%d)", mode);
539 case NATIVE_WINDOW_SCALING_MODE_FREEZE:
540 case NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW:
543 ALOGE("unknown scaling mode: %d", mode);
547 Mutex::Autolock lock(mMutex);
552 int SurfaceTextureClient::setBuffersTransform(int transform)
555 ALOGV("SurfaceTextureClient::setBuffersTransform");
556 Mutex::Autolock lock(mMutex);
557 mTransform = transform;
561 int SurfaceTextureClient::setBuffersTimestamp(int64_t timestamp)
563 ALOGV("SurfaceTextureClient::setBuffersTimestamp");
564 Mutex::Autolock lock(mMutex);
565 mTimestamp = timestamp;
569 void SurfaceTextureClient::freeAllBuffers() {
570 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
575 // ----------------------------------------------------------------------
576 // the lock/unlock APIs must be used from the same thread
578 static status_t copyBlt(
579 const sp<GraphicBuffer>& dst,
580 const sp<GraphicBuffer>& src,
583 // src and dst with, height and format must be identical. no verification
586 uint8_t const * src_bits = NULL;
587 err = src->lock(GRALLOC_USAGE_SW_READ_OFTEN, reg.bounds(), (void**)&src_bits);
588 ALOGE_IF(err, "error locking src buffer %s", strerror(-err));
590 uint8_t* dst_bits = NULL;
591 err = dst->lock(GRALLOC_USAGE_SW_WRITE_OFTEN, reg.bounds(), (void**)&dst_bits);
592 ALOGE_IF(err, "error locking dst buffer %s", strerror(-err));
594 Region::const_iterator head(reg.begin());
595 Region::const_iterator tail(reg.end());
596 if (head != tail && src_bits && dst_bits) {
597 const size_t bpp = bytesPerPixel(src->format);
598 const size_t dbpr = dst->stride * bpp;
599 const size_t sbpr = src->stride * bpp;
601 while (head != tail) {
602 const Rect& r(*head++);
603 ssize_t h = r.height();
604 if (h <= 0) continue;
605 size_t size = r.width() * bpp;
606 uint8_t const * s = src_bits + (r.left + src->stride * r.top) * bpp;
607 uint8_t * d = dst_bits + (r.left + dst->stride * r.top) * bpp;
608 if (dbpr==sbpr && size==sbpr) {
629 // ----------------------------------------------------------------------------
631 status_t SurfaceTextureClient::lock(
632 ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds)
634 if (mLockedBuffer != 0) {
635 ALOGE("Surface::lock failed, already locked");
636 return INVALID_OPERATION;
639 if (!mConnectedToCpu) {
640 int err = SurfaceTextureClient::connect(NATIVE_WINDOW_API_CPU);
644 // we're intending to do software rendering from this point
645 setUsage(GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN);
648 ANativeWindowBuffer* out;
649 status_t err = dequeueBuffer(&out);
650 ALOGE_IF(err, "dequeueBuffer failed (%s)", strerror(-err));
651 if (err == NO_ERROR) {
652 sp<GraphicBuffer> backBuffer(GraphicBuffer::getSelf(out));
653 err = lockBuffer(backBuffer.get());
654 ALOGE_IF(err, "lockBuffer (handle=%p) failed (%s)",
655 backBuffer->handle, strerror(-err));
656 if (err == NO_ERROR) {
657 const Rect bounds(backBuffer->width, backBuffer->height);
659 Region newDirtyRegion;
660 if (inOutDirtyBounds) {
661 newDirtyRegion.set(static_cast<Rect const&>(*inOutDirtyBounds));
662 newDirtyRegion.andSelf(bounds);
664 newDirtyRegion.set(bounds);
667 // figure out if we can copy the frontbuffer back
668 const sp<GraphicBuffer>& frontBuffer(mPostedBuffer);
669 const bool canCopyBack = (frontBuffer != 0 &&
670 backBuffer->width == frontBuffer->width &&
671 backBuffer->height == frontBuffer->height &&
672 backBuffer->format == frontBuffer->format);
675 // copy the area that is invalid and not repainted this round
676 const Region copyback(mOldDirtyRegion.subtract(newDirtyRegion));
677 if (!copyback.isEmpty())
678 copyBlt(backBuffer, frontBuffer, copyback);
680 // if we can't copy-back anything, modify the user's dirty
681 // region to make sure they redraw the whole buffer
682 newDirtyRegion.set(bounds);
685 // keep track of the are of the buffer that is "clean"
686 // (ie: that will be redrawn)
687 mOldDirtyRegion = newDirtyRegion;
689 if (inOutDirtyBounds) {
690 *inOutDirtyBounds = newDirtyRegion.getBounds();
694 status_t res = backBuffer->lock(
695 GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN,
696 newDirtyRegion.bounds(), &vaddr);
698 ALOGW_IF(res, "failed locking buffer (handle = %p)",
701 mLockedBuffer = backBuffer;
702 outBuffer->width = backBuffer->width;
703 outBuffer->height = backBuffer->height;
704 outBuffer->stride = backBuffer->stride;
705 outBuffer->format = backBuffer->format;
706 outBuffer->bits = vaddr;
712 status_t SurfaceTextureClient::unlockAndPost()
714 if (mLockedBuffer == 0) {
715 ALOGE("Surface::unlockAndPost failed, no locked buffer");
716 return INVALID_OPERATION;
719 status_t err = mLockedBuffer->unlock();
720 ALOGE_IF(err, "failed unlocking buffer (%p)", mLockedBuffer->handle);
722 err = queueBuffer(mLockedBuffer.get());
723 ALOGE_IF(err, "queueBuffer (handle=%p) failed (%s)",
724 mLockedBuffer->handle, strerror(-err));
726 mPostedBuffer = mLockedBuffer;
731 }; // namespace android