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 LOG_NDEBUG 0
20 #include <gui/SurfaceTextureClient.h>
21 #include <surfaceflinger/ISurfaceComposer.h>
22 #include <surfaceflinger/SurfaceComposerClient.h>
24 #include <utils/Log.h>
28 SurfaceTextureClient::SurfaceTextureClient(
29 const sp<ISurfaceTexture>& surfaceTexture)
31 SurfaceTextureClient::init();
32 SurfaceTextureClient::setISurfaceTexture(surfaceTexture);
35 SurfaceTextureClient::SurfaceTextureClient() {
36 SurfaceTextureClient::init();
39 SurfaceTextureClient::~SurfaceTextureClient() {
40 if (mConnectedToCpu) {
41 SurfaceTextureClient::disconnect(NATIVE_WINDOW_API_CPU);
45 void SurfaceTextureClient::init() {
46 // Initialize the ANativeWindow function pointers.
47 ANativeWindow::setSwapInterval = hook_setSwapInterval;
48 ANativeWindow::dequeueBuffer = hook_dequeueBuffer;
49 ANativeWindow::cancelBuffer = hook_cancelBuffer;
50 ANativeWindow::lockBuffer = hook_lockBuffer;
51 ANativeWindow::queueBuffer = hook_queueBuffer;
52 ANativeWindow::query = hook_query;
53 ANativeWindow::perform = hook_perform;
55 const_cast<int&>(ANativeWindow::minSwapInterval) = 0;
56 const_cast<int&>(ANativeWindow::maxSwapInterval) = 1;
62 mTimestamp = NATIVE_WINDOW_TIMESTAMP_AUTO;
66 mConnectedToCpu = false;
69 void SurfaceTextureClient::setISurfaceTexture(
70 const sp<ISurfaceTexture>& surfaceTexture)
72 mSurfaceTexture = surfaceTexture;
75 sp<ISurfaceTexture> SurfaceTextureClient::getISurfaceTexture() const {
76 return mSurfaceTexture;
79 int SurfaceTextureClient::hook_setSwapInterval(ANativeWindow* window, int interval) {
80 SurfaceTextureClient* c = getSelf(window);
81 return c->setSwapInterval(interval);
84 int SurfaceTextureClient::hook_dequeueBuffer(ANativeWindow* window,
85 ANativeWindowBuffer** buffer) {
86 SurfaceTextureClient* c = getSelf(window);
87 return c->dequeueBuffer(buffer);
90 int SurfaceTextureClient::hook_cancelBuffer(ANativeWindow* window,
91 ANativeWindowBuffer* buffer) {
92 SurfaceTextureClient* c = getSelf(window);
93 return c->cancelBuffer(buffer);
96 int SurfaceTextureClient::hook_lockBuffer(ANativeWindow* window,
97 ANativeWindowBuffer* buffer) {
98 SurfaceTextureClient* c = getSelf(window);
99 return c->lockBuffer(buffer);
102 int SurfaceTextureClient::hook_queueBuffer(ANativeWindow* window,
103 ANativeWindowBuffer* buffer) {
104 SurfaceTextureClient* c = getSelf(window);
105 return c->queueBuffer(buffer);
108 int SurfaceTextureClient::hook_query(const ANativeWindow* window,
109 int what, int* value) {
110 const SurfaceTextureClient* c = getSelf(window);
111 return c->query(what, value);
114 int SurfaceTextureClient::hook_perform(ANativeWindow* window, int operation, ...) {
116 va_start(args, operation);
117 SurfaceTextureClient* c = getSelf(window);
118 return c->perform(operation, args);
121 int SurfaceTextureClient::setSwapInterval(int interval) {
122 // EGL specification states:
123 // interval is silently clamped to minimum and maximum implementation
124 // dependent values before being stored.
125 // Although we don't have to, we apply the same logic here.
127 if (interval < minSwapInterval)
128 interval = minSwapInterval;
130 if (interval > maxSwapInterval)
131 interval = maxSwapInterval;
133 status_t res = mSurfaceTexture->setSynchronousMode(interval ? true : false);
138 int SurfaceTextureClient::dequeueBuffer(android_native_buffer_t** buffer) {
139 ALOGV("SurfaceTextureClient::dequeueBuffer");
140 Mutex::Autolock lock(mMutex);
142 status_t result = mSurfaceTexture->dequeueBuffer(&buf, mReqWidth, mReqHeight,
143 mReqFormat, mReqUsage);
145 ALOGV("dequeueBuffer: ISurfaceTexture::dequeueBuffer(%d, %d, %d, %d)"
146 "failed: %d", mReqWidth, mReqHeight, mReqFormat, mReqUsage,
150 sp<GraphicBuffer>& gbuf(mSlots[buf]);
151 if (result & ISurfaceTexture::RELEASE_ALL_BUFFERS) {
155 if ((result & ISurfaceTexture::BUFFER_NEEDS_REALLOCATION) || gbuf == 0) {
156 result = mSurfaceTexture->requestBuffer(buf, &gbuf);
157 if (result != NO_ERROR) {
158 ALOGE("dequeueBuffer: ISurfaceTexture::requestBuffer failed: %d",
163 *buffer = gbuf.get();
167 int SurfaceTextureClient::cancelBuffer(android_native_buffer_t* buffer) {
168 ALOGV("SurfaceTextureClient::cancelBuffer");
169 Mutex::Autolock lock(mMutex);
170 int i = getSlotFromBufferLocked(buffer);
174 mSurfaceTexture->cancelBuffer(i);
178 int SurfaceTextureClient::getSlotFromBufferLocked(
179 android_native_buffer_t* buffer) const {
180 bool dumpedState = false;
181 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
182 // XXX: Dump the slots whenever we hit a NULL entry while searching for
184 if (mSlots[i] == NULL) {
186 ALOGD("getSlotFromBufferLocked: encountered NULL buffer in slot %d "
187 "looking for buffer %p", i, buffer->handle);
188 for (int j = 0; j < NUM_BUFFER_SLOTS; j++) {
189 if (mSlots[j] == NULL) {
190 ALOGD("getSlotFromBufferLocked: %02d: NULL", j);
192 ALOGD("getSlotFromBufferLocked: %02d: %p", j, mSlots[j]->handle);
199 if (mSlots[i] != NULL && mSlots[i]->handle == buffer->handle) {
203 ALOGE("getSlotFromBufferLocked: unknown buffer: %p", buffer->handle);
207 int SurfaceTextureClient::lockBuffer(android_native_buffer_t* buffer) {
208 ALOGV("SurfaceTextureClient::lockBuffer");
209 Mutex::Autolock lock(mMutex);
213 int SurfaceTextureClient::queueBuffer(android_native_buffer_t* buffer) {
214 ALOGV("SurfaceTextureClient::queueBuffer");
215 Mutex::Autolock lock(mMutex);
217 if (mTimestamp == NATIVE_WINDOW_TIMESTAMP_AUTO) {
218 timestamp = systemTime(SYSTEM_TIME_MONOTONIC);
219 ALOGV("SurfaceTextureClient::queueBuffer making up timestamp: %.2f ms",
220 timestamp / 1000000.f);
222 timestamp = mTimestamp;
224 int i = getSlotFromBufferLocked(buffer);
228 status_t err = mSurfaceTexture->queueBuffer(i, timestamp,
229 &mDefaultWidth, &mDefaultHeight, &mTransformHint);
231 ALOGE("queueBuffer: error queuing buffer to SurfaceTexture, %d", err);
236 int SurfaceTextureClient::query(int what, int* value) const {
237 ALOGV("SurfaceTextureClient::query");
238 { // scope for the lock
239 Mutex::Autolock lock(mMutex);
241 case NATIVE_WINDOW_FORMAT:
247 case NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER:
249 sp<ISurfaceComposer> composer(
250 ComposerService::getComposerService());
251 if (composer->authenticateSurfaceTexture(mSurfaceTexture)) {
258 case NATIVE_WINDOW_CONCRETE_TYPE:
259 *value = NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT;
261 case NATIVE_WINDOW_DEFAULT_WIDTH:
262 *value = mDefaultWidth;
264 case NATIVE_WINDOW_DEFAULT_HEIGHT:
265 *value = mDefaultHeight;
267 case NATIVE_WINDOW_TRANSFORM_HINT:
268 *value = mTransformHint;
272 return mSurfaceTexture->query(what, value);
275 int SurfaceTextureClient::perform(int operation, va_list args)
279 case NATIVE_WINDOW_CONNECT:
280 // deprecated. must return NO_ERROR.
282 case NATIVE_WINDOW_DISCONNECT:
283 // deprecated. must return NO_ERROR.
285 case NATIVE_WINDOW_SET_USAGE:
286 res = dispatchSetUsage(args);
288 case NATIVE_WINDOW_SET_CROP:
289 res = dispatchSetCrop(args);
291 case NATIVE_WINDOW_SET_BUFFER_COUNT:
292 res = dispatchSetBufferCount(args);
294 case NATIVE_WINDOW_SET_BUFFERS_GEOMETRY:
295 res = dispatchSetBuffersGeometry(args);
297 case NATIVE_WINDOW_SET_BUFFERS_TRANSFORM:
298 res = dispatchSetBuffersTransform(args);
300 case NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP:
301 res = dispatchSetBuffersTimestamp(args);
303 case NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS:
304 res = dispatchSetBuffersDimensions(args);
306 case NATIVE_WINDOW_SET_BUFFERS_FORMAT:
307 res = dispatchSetBuffersFormat(args);
309 case NATIVE_WINDOW_LOCK:
310 res = dispatchLock(args);
312 case NATIVE_WINDOW_UNLOCK_AND_POST:
313 res = dispatchUnlockAndPost(args);
315 case NATIVE_WINDOW_SET_SCALING_MODE:
316 res = dispatchSetScalingMode(args);
318 case NATIVE_WINDOW_API_CONNECT:
319 res = dispatchConnect(args);
321 case NATIVE_WINDOW_API_DISCONNECT:
322 res = dispatchDisconnect(args);
325 res = NAME_NOT_FOUND;
331 int SurfaceTextureClient::dispatchConnect(va_list args) {
332 int api = va_arg(args, int);
336 int SurfaceTextureClient::dispatchDisconnect(va_list args) {
337 int api = va_arg(args, int);
338 return disconnect(api);
341 int SurfaceTextureClient::dispatchSetUsage(va_list args) {
342 int usage = va_arg(args, int);
343 return setUsage(usage);
346 int SurfaceTextureClient::dispatchSetCrop(va_list args) {
347 android_native_rect_t const* rect = va_arg(args, android_native_rect_t*);
348 return setCrop(reinterpret_cast<Rect const*>(rect));
351 int SurfaceTextureClient::dispatchSetBufferCount(va_list args) {
352 size_t bufferCount = va_arg(args, size_t);
353 return setBufferCount(bufferCount);
356 int SurfaceTextureClient::dispatchSetBuffersGeometry(va_list args) {
357 int w = va_arg(args, int);
358 int h = va_arg(args, int);
359 int f = va_arg(args, int);
360 int err = setBuffersDimensions(w, h);
364 return setBuffersFormat(f);
367 int SurfaceTextureClient::dispatchSetBuffersDimensions(va_list args) {
368 int w = va_arg(args, int);
369 int h = va_arg(args, int);
370 return setBuffersDimensions(w, h);
373 int SurfaceTextureClient::dispatchSetBuffersFormat(va_list args) {
374 int f = va_arg(args, int);
375 return setBuffersFormat(f);
378 int SurfaceTextureClient::dispatchSetScalingMode(va_list args) {
379 int m = va_arg(args, int);
380 return setScalingMode(m);
383 int SurfaceTextureClient::dispatchSetBuffersTransform(va_list args) {
384 int transform = va_arg(args, int);
385 return setBuffersTransform(transform);
388 int SurfaceTextureClient::dispatchSetBuffersTimestamp(va_list args) {
389 int64_t timestamp = va_arg(args, int64_t);
390 return setBuffersTimestamp(timestamp);
393 int SurfaceTextureClient::dispatchLock(va_list args) {
394 ANativeWindow_Buffer* outBuffer = va_arg(args, ANativeWindow_Buffer*);
395 ARect* inOutDirtyBounds = va_arg(args, ARect*);
396 return lock(outBuffer, inOutDirtyBounds);
399 int SurfaceTextureClient::dispatchUnlockAndPost(va_list args) {
400 return unlockAndPost();
404 int SurfaceTextureClient::connect(int api) {
405 ALOGV("SurfaceTextureClient::connect");
406 Mutex::Autolock lock(mMutex);
407 int err = mSurfaceTexture->connect(api,
408 &mDefaultWidth, &mDefaultHeight, &mTransformHint);
409 if (!err && api == NATIVE_WINDOW_API_CPU) {
410 mConnectedToCpu = true;
415 int SurfaceTextureClient::disconnect(int api) {
416 ALOGV("SurfaceTextureClient::disconnect");
417 Mutex::Autolock lock(mMutex);
419 int err = mSurfaceTexture->disconnect(api);
425 if (api == NATIVE_WINDOW_API_CPU) {
426 mConnectedToCpu = false;
432 int SurfaceTextureClient::setUsage(uint32_t reqUsage)
434 ALOGV("SurfaceTextureClient::setUsage");
435 Mutex::Autolock lock(mMutex);
436 mReqUsage = reqUsage;
440 int SurfaceTextureClient::setCrop(Rect const* rect)
442 ALOGV("SurfaceTextureClient::setCrop");
443 Mutex::Autolock lock(mMutex);
446 if (rect == NULL || rect->isEmpty()) {
447 realRect = Rect(0, 0);
452 status_t err = mSurfaceTexture->setCrop(*rect);
453 ALOGE_IF(err, "ISurfaceTexture::setCrop(...) returned %s", strerror(-err));
458 int SurfaceTextureClient::setBufferCount(int bufferCount)
460 ALOGV("SurfaceTextureClient::setBufferCount");
461 Mutex::Autolock lock(mMutex);
463 status_t err = mSurfaceTexture->setBufferCount(bufferCount);
464 ALOGE_IF(err, "ISurfaceTexture::setBufferCount(%d) returned %s",
465 bufferCount, strerror(-err));
467 if (err == NO_ERROR) {
474 int SurfaceTextureClient::setBuffersDimensions(int w, int h)
476 ALOGV("SurfaceTextureClient::setBuffersDimensions");
477 Mutex::Autolock lock(mMutex);
482 if ((w && !h) || (!w && h))
488 status_t err = mSurfaceTexture->setCrop(Rect(0, 0));
489 ALOGE_IF(err, "ISurfaceTexture::setCrop(...) returned %s", strerror(-err));
494 int SurfaceTextureClient::setBuffersFormat(int format)
496 ALOGV("SurfaceTextureClient::setBuffersFormat");
497 Mutex::Autolock lock(mMutex);
507 int SurfaceTextureClient::setScalingMode(int mode)
509 ALOGV("SurfaceTextureClient::setScalingMode(%d)", mode);
510 Mutex::Autolock lock(mMutex);
511 // mode is validated on the server
512 status_t err = mSurfaceTexture->setScalingMode(mode);
513 ALOGE_IF(err, "ISurfaceTexture::setScalingMode(%d) returned %s",
514 mode, strerror(-err));
519 int SurfaceTextureClient::setBuffersTransform(int transform)
521 ALOGV("SurfaceTextureClient::setBuffersTransform");
522 Mutex::Autolock lock(mMutex);
523 status_t err = mSurfaceTexture->setTransform(transform);
527 int SurfaceTextureClient::setBuffersTimestamp(int64_t timestamp)
529 ALOGV("SurfaceTextureClient::setBuffersTimestamp");
530 Mutex::Autolock lock(mMutex);
531 mTimestamp = timestamp;
535 void SurfaceTextureClient::freeAllBuffers() {
536 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
541 // ----------------------------------------------------------------------
542 // the lock/unlock APIs must be used from the same thread
544 static status_t copyBlt(
545 const sp<GraphicBuffer>& dst,
546 const sp<GraphicBuffer>& src,
549 // src and dst with, height and format must be identical. no verification
552 uint8_t const * src_bits = NULL;
553 err = src->lock(GRALLOC_USAGE_SW_READ_OFTEN, reg.bounds(), (void**)&src_bits);
554 ALOGE_IF(err, "error locking src buffer %s", strerror(-err));
556 uint8_t* dst_bits = NULL;
557 err = dst->lock(GRALLOC_USAGE_SW_WRITE_OFTEN, reg.bounds(), (void**)&dst_bits);
558 ALOGE_IF(err, "error locking dst buffer %s", strerror(-err));
560 Region::const_iterator head(reg.begin());
561 Region::const_iterator tail(reg.end());
562 if (head != tail && src_bits && dst_bits) {
563 const size_t bpp = bytesPerPixel(src->format);
564 const size_t dbpr = dst->stride * bpp;
565 const size_t sbpr = src->stride * bpp;
567 while (head != tail) {
568 const Rect& r(*head++);
569 ssize_t h = r.height();
570 if (h <= 0) continue;
571 size_t size = r.width() * bpp;
572 uint8_t const * s = src_bits + (r.left + src->stride * r.top) * bpp;
573 uint8_t * d = dst_bits + (r.left + dst->stride * r.top) * bpp;
574 if (dbpr==sbpr && size==sbpr) {
595 // ----------------------------------------------------------------------------
597 status_t SurfaceTextureClient::lock(
598 ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds)
600 if (mLockedBuffer != 0) {
601 ALOGE("Surface::lock failed, already locked");
602 return INVALID_OPERATION;
605 if (!mConnectedToCpu) {
606 int err = SurfaceTextureClient::connect(NATIVE_WINDOW_API_CPU);
610 // we're intending to do software rendering from this point
611 setUsage(GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN);
614 ANativeWindowBuffer* out;
615 status_t err = dequeueBuffer(&out);
616 ALOGE_IF(err, "dequeueBuffer failed (%s)", strerror(-err));
617 if (err == NO_ERROR) {
618 sp<GraphicBuffer> backBuffer(GraphicBuffer::getSelf(out));
619 err = lockBuffer(backBuffer.get());
620 ALOGE_IF(err, "lockBuffer (handle=%p) failed (%s)",
621 backBuffer->handle, strerror(-err));
622 if (err == NO_ERROR) {
623 const Rect bounds(backBuffer->width, backBuffer->height);
625 Region newDirtyRegion;
626 if (inOutDirtyBounds) {
627 newDirtyRegion.set(static_cast<Rect const&>(*inOutDirtyBounds));
628 newDirtyRegion.andSelf(bounds);
630 newDirtyRegion.set(bounds);
633 // figure out if we can copy the frontbuffer back
634 const sp<GraphicBuffer>& frontBuffer(mPostedBuffer);
635 const bool canCopyBack = (frontBuffer != 0 &&
636 backBuffer->width == frontBuffer->width &&
637 backBuffer->height == frontBuffer->height &&
638 backBuffer->format == frontBuffer->format);
641 // copy the area that is invalid and not repainted this round
642 const Region copyback(mOldDirtyRegion.subtract(newDirtyRegion));
643 if (!copyback.isEmpty())
644 copyBlt(backBuffer, frontBuffer, copyback);
646 // if we can't copy-back anything, modify the user's dirty
647 // region to make sure they redraw the whole buffer
648 newDirtyRegion.set(bounds);
651 // keep track of the are of the buffer that is "clean"
652 // (ie: that will be redrawn)
653 mOldDirtyRegion = newDirtyRegion;
655 if (inOutDirtyBounds) {
656 *inOutDirtyBounds = newDirtyRegion.getBounds();
660 status_t res = backBuffer->lock(
661 GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN,
662 newDirtyRegion.bounds(), &vaddr);
664 ALOGW_IF(res, "failed locking buffer (handle = %p)",
667 mLockedBuffer = backBuffer;
668 outBuffer->width = backBuffer->width;
669 outBuffer->height = backBuffer->height;
670 outBuffer->stride = backBuffer->stride;
671 outBuffer->format = backBuffer->format;
672 outBuffer->bits = vaddr;
678 status_t SurfaceTextureClient::unlockAndPost()
680 if (mLockedBuffer == 0) {
681 ALOGE("Surface::unlockAndPost failed, no locked buffer");
682 return INVALID_OPERATION;
685 status_t err = mLockedBuffer->unlock();
686 ALOGE_IF(err, "failed unlocking buffer (%p)", mLockedBuffer->handle);
688 err = queueBuffer(mLockedBuffer.get());
689 ALOGE_IF(err, "queueBuffer (handle=%p) failed (%s)",
690 mLockedBuffer->handle, strerror(-err));
692 mPostedBuffer = mLockedBuffer;
697 }; // namespace android