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;
86 mConnectedToCpu = false;
89 void SurfaceTextureClient::setISurfaceTexture(
90 const sp<ISurfaceTexture>& surfaceTexture)
92 mSurfaceTexture = surfaceTexture;
95 sp<ISurfaceTexture> SurfaceTextureClient::getISurfaceTexture() const {
96 return mSurfaceTexture;
99 int SurfaceTextureClient::hook_setSwapInterval(ANativeWindow* window, int interval) {
100 SurfaceTextureClient* c = getSelf(window);
101 return c->setSwapInterval(interval);
104 int SurfaceTextureClient::hook_dequeueBuffer(ANativeWindow* window,
105 ANativeWindowBuffer** buffer) {
106 SurfaceTextureClient* c = getSelf(window);
107 return c->dequeueBuffer(buffer);
110 int SurfaceTextureClient::hook_cancelBuffer(ANativeWindow* window,
111 ANativeWindowBuffer* buffer) {
112 SurfaceTextureClient* c = getSelf(window);
113 return c->cancelBuffer(buffer);
116 int SurfaceTextureClient::hook_lockBuffer(ANativeWindow* window,
117 ANativeWindowBuffer* buffer) {
118 SurfaceTextureClient* c = getSelf(window);
119 return c->lockBuffer(buffer);
122 int SurfaceTextureClient::hook_queueBuffer(ANativeWindow* window,
123 ANativeWindowBuffer* buffer) {
124 SurfaceTextureClient* c = getSelf(window);
125 return c->queueBuffer(buffer);
128 int SurfaceTextureClient::hook_query(const ANativeWindow* window,
129 int what, int* value) {
130 const SurfaceTextureClient* c = getSelf(window);
131 return c->query(what, value);
134 int SurfaceTextureClient::hook_perform(ANativeWindow* window, int operation, ...) {
136 va_start(args, operation);
137 SurfaceTextureClient* c = getSelf(window);
138 return c->perform(operation, args);
141 int SurfaceTextureClient::setSwapInterval(int interval) {
143 // EGL specification states:
144 // interval is silently clamped to minimum and maximum implementation
145 // dependent values before being stored.
146 // Although we don't have to, we apply the same logic here.
148 if (interval < minSwapInterval)
149 interval = minSwapInterval;
151 if (interval > maxSwapInterval)
152 interval = maxSwapInterval;
154 status_t res = mSurfaceTexture->setSynchronousMode(interval ? true : false);
159 int SurfaceTextureClient::dequeueBuffer(android_native_buffer_t** buffer) {
161 ALOGV("SurfaceTextureClient::dequeueBuffer");
162 Mutex::Autolock lock(mMutex);
164 int reqW = mReqWidth ? mReqWidth : mUserWidth;
165 int reqH = mReqHeight ? mReqHeight : mUserHeight;
166 status_t result = mSurfaceTexture->dequeueBuffer(&buf, reqW, reqH,
167 mReqFormat, mReqUsage);
169 ALOGV("dequeueBuffer: ISurfaceTexture::dequeueBuffer(%d, %d, %d, %d)"
170 "failed: %d", mReqWidth, mReqHeight, mReqFormat, mReqUsage,
174 sp<GraphicBuffer>& gbuf(mSlots[buf]);
175 if (result & ISurfaceTexture::RELEASE_ALL_BUFFERS) {
179 if ((result & ISurfaceTexture::BUFFER_NEEDS_REALLOCATION) || gbuf == 0) {
180 result = mSurfaceTexture->requestBuffer(buf, &gbuf);
181 if (result != NO_ERROR) {
182 ALOGE("dequeueBuffer: ISurfaceTexture::requestBuffer failed: %d",
187 *buffer = gbuf.get();
191 int SurfaceTextureClient::cancelBuffer(android_native_buffer_t* buffer) {
193 ALOGV("SurfaceTextureClient::cancelBuffer");
194 Mutex::Autolock lock(mMutex);
195 int i = getSlotFromBufferLocked(buffer);
199 mSurfaceTexture->cancelBuffer(i);
203 int SurfaceTextureClient::getSlotFromBufferLocked(
204 android_native_buffer_t* buffer) const {
205 bool dumpedState = false;
206 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
207 if (mSlots[i] != NULL && mSlots[i]->handle == buffer->handle) {
211 ALOGE("getSlotFromBufferLocked: unknown buffer: %p", buffer->handle);
215 int SurfaceTextureClient::lockBuffer(android_native_buffer_t* buffer) {
216 ALOGV("SurfaceTextureClient::lockBuffer");
217 Mutex::Autolock lock(mMutex);
221 int SurfaceTextureClient::queueBuffer(android_native_buffer_t* buffer) {
223 ALOGV("SurfaceTextureClient::queueBuffer");
224 Mutex::Autolock lock(mMutex);
226 if (mTimestamp == NATIVE_WINDOW_TIMESTAMP_AUTO) {
227 timestamp = systemTime(SYSTEM_TIME_MONOTONIC);
228 ALOGV("SurfaceTextureClient::queueBuffer making up timestamp: %.2f ms",
229 timestamp / 1000000.f);
231 timestamp = mTimestamp;
233 int i = getSlotFromBufferLocked(buffer);
238 ISurfaceTexture::QueueBufferOutput output;
239 ISurfaceTexture::QueueBufferInput input(timestamp,
240 mCrop, mScalingMode, mTransform);
241 status_t err = mSurfaceTexture->queueBuffer(i, input, &output);
243 ALOGE("queueBuffer: error queuing buffer to SurfaceTexture, %d", err);
245 output.deflate(&mDefaultWidth, &mDefaultHeight, &mTransformHint);
249 int SurfaceTextureClient::query(int what, int* value) const {
251 ALOGV("SurfaceTextureClient::query");
252 { // scope for the lock
253 Mutex::Autolock lock(mMutex);
255 case NATIVE_WINDOW_FORMAT:
261 case NATIVE_WINDOW_QUEUES_TO_WINDOW_COMPOSER:
263 sp<ISurfaceComposer> composer(
264 ComposerService::getComposerService());
265 if (composer->authenticateSurfaceTexture(mSurfaceTexture)) {
272 case NATIVE_WINDOW_CONCRETE_TYPE:
273 *value = NATIVE_WINDOW_SURFACE_TEXTURE_CLIENT;
275 case NATIVE_WINDOW_DEFAULT_WIDTH:
276 *value = mUserWidth ? mUserWidth : mDefaultWidth;
278 case NATIVE_WINDOW_DEFAULT_HEIGHT:
279 *value = mUserHeight ? mUserHeight : mDefaultHeight;
281 case NATIVE_WINDOW_TRANSFORM_HINT:
282 *value = mTransformHint;
286 return mSurfaceTexture->query(what, value);
289 int SurfaceTextureClient::perform(int operation, va_list args)
293 case NATIVE_WINDOW_CONNECT:
294 // deprecated. must return NO_ERROR.
296 case NATIVE_WINDOW_DISCONNECT:
297 // deprecated. must return NO_ERROR.
299 case NATIVE_WINDOW_SET_USAGE:
300 res = dispatchSetUsage(args);
302 case NATIVE_WINDOW_SET_CROP:
303 res = dispatchSetCrop(args);
305 case NATIVE_WINDOW_SET_BUFFER_COUNT:
306 res = dispatchSetBufferCount(args);
308 case NATIVE_WINDOW_SET_BUFFERS_GEOMETRY:
309 res = dispatchSetBuffersGeometry(args);
311 case NATIVE_WINDOW_SET_BUFFERS_TRANSFORM:
312 res = dispatchSetBuffersTransform(args);
314 case NATIVE_WINDOW_SET_BUFFERS_TIMESTAMP:
315 res = dispatchSetBuffersTimestamp(args);
317 case NATIVE_WINDOW_SET_BUFFERS_DIMENSIONS:
318 res = dispatchSetBuffersDimensions(args);
320 case NATIVE_WINDOW_SET_BUFFERS_USER_DIMENSIONS:
321 res = dispatchSetBuffersUserDimensions(args);
323 case NATIVE_WINDOW_SET_BUFFERS_FORMAT:
324 res = dispatchSetBuffersFormat(args);
326 case NATIVE_WINDOW_LOCK:
327 res = dispatchLock(args);
329 case NATIVE_WINDOW_UNLOCK_AND_POST:
330 res = dispatchUnlockAndPost(args);
332 case NATIVE_WINDOW_SET_SCALING_MODE:
333 res = dispatchSetScalingMode(args);
335 case NATIVE_WINDOW_API_CONNECT:
336 res = dispatchConnect(args);
338 case NATIVE_WINDOW_API_DISCONNECT:
339 res = dispatchDisconnect(args);
342 res = NAME_NOT_FOUND;
348 int SurfaceTextureClient::dispatchConnect(va_list args) {
349 int api = va_arg(args, int);
353 int SurfaceTextureClient::dispatchDisconnect(va_list args) {
354 int api = va_arg(args, int);
355 return disconnect(api);
358 int SurfaceTextureClient::dispatchSetUsage(va_list args) {
359 int usage = va_arg(args, int);
360 return setUsage(usage);
363 int SurfaceTextureClient::dispatchSetCrop(va_list args) {
364 android_native_rect_t const* rect = va_arg(args, android_native_rect_t*);
365 return setCrop(reinterpret_cast<Rect const*>(rect));
368 int SurfaceTextureClient::dispatchSetBufferCount(va_list args) {
369 size_t bufferCount = va_arg(args, size_t);
370 return setBufferCount(bufferCount);
373 int SurfaceTextureClient::dispatchSetBuffersGeometry(va_list args) {
374 int w = va_arg(args, int);
375 int h = va_arg(args, int);
376 int f = va_arg(args, int);
377 int err = setBuffersDimensions(w, h);
381 return setBuffersFormat(f);
384 int SurfaceTextureClient::dispatchSetBuffersDimensions(va_list args) {
385 int w = va_arg(args, int);
386 int h = va_arg(args, int);
387 return setBuffersDimensions(w, h);
390 int SurfaceTextureClient::dispatchSetBuffersUserDimensions(va_list args) {
391 int w = va_arg(args, int);
392 int h = va_arg(args, int);
393 return setBuffersUserDimensions(w, h);
396 int SurfaceTextureClient::dispatchSetBuffersFormat(va_list args) {
397 int f = va_arg(args, int);
398 return setBuffersFormat(f);
401 int SurfaceTextureClient::dispatchSetScalingMode(va_list args) {
402 int m = va_arg(args, int);
403 return setScalingMode(m);
406 int SurfaceTextureClient::dispatchSetBuffersTransform(va_list args) {
407 int transform = va_arg(args, int);
408 return setBuffersTransform(transform);
411 int SurfaceTextureClient::dispatchSetBuffersTimestamp(va_list args) {
412 int64_t timestamp = va_arg(args, int64_t);
413 return setBuffersTimestamp(timestamp);
416 int SurfaceTextureClient::dispatchLock(va_list args) {
417 ANativeWindow_Buffer* outBuffer = va_arg(args, ANativeWindow_Buffer*);
418 ARect* inOutDirtyBounds = va_arg(args, ARect*);
419 return lock(outBuffer, inOutDirtyBounds);
422 int SurfaceTextureClient::dispatchUnlockAndPost(va_list args) {
423 return unlockAndPost();
427 int SurfaceTextureClient::connect(int api) {
429 ALOGV("SurfaceTextureClient::connect");
430 Mutex::Autolock lock(mMutex);
431 int err = mSurfaceTexture->connect(api,
432 &mDefaultWidth, &mDefaultHeight, &mTransformHint);
433 if (!err && api == NATIVE_WINDOW_API_CPU) {
434 mConnectedToCpu = true;
439 int SurfaceTextureClient::disconnect(int api) {
441 ALOGV("SurfaceTextureClient::disconnect");
442 Mutex::Autolock lock(mMutex);
444 int err = mSurfaceTexture->disconnect(api);
451 mScalingMode = NATIVE_WINDOW_SCALING_MODE_FREEZE;
453 if (api == NATIVE_WINDOW_API_CPU) {
454 mConnectedToCpu = false;
460 int SurfaceTextureClient::setUsage(uint32_t reqUsage)
462 ALOGV("SurfaceTextureClient::setUsage");
463 Mutex::Autolock lock(mMutex);
464 mReqUsage = reqUsage;
468 int SurfaceTextureClient::setCrop(Rect const* rect)
471 ALOGV("SurfaceTextureClient::setCrop");
474 if (rect == NULL || rect->isEmpty()) {
480 Mutex::Autolock lock(mMutex);
485 int SurfaceTextureClient::setBufferCount(int bufferCount)
488 ALOGV("SurfaceTextureClient::setBufferCount");
489 Mutex::Autolock lock(mMutex);
491 status_t err = mSurfaceTexture->setBufferCount(bufferCount);
492 ALOGE_IF(err, "ISurfaceTexture::setBufferCount(%d) returned %s",
493 bufferCount, strerror(-err));
495 if (err == NO_ERROR) {
502 int SurfaceTextureClient::setBuffersDimensions(int w, int h)
505 ALOGV("SurfaceTextureClient::setBuffersDimensions");
510 if ((w && !h) || (!w && h))
513 Mutex::Autolock lock(mMutex);
520 int SurfaceTextureClient::setBuffersUserDimensions(int w, int h)
523 ALOGV("SurfaceTextureClient::setBuffersUserDimensions");
528 if ((w && !h) || (!w && h))
531 Mutex::Autolock lock(mMutex);
538 int SurfaceTextureClient::setBuffersFormat(int format)
540 ALOGV("SurfaceTextureClient::setBuffersFormat");
545 Mutex::Autolock lock(mMutex);
550 int SurfaceTextureClient::setScalingMode(int mode)
553 ALOGV("SurfaceTextureClient::setScalingMode(%d)", mode);
556 case NATIVE_WINDOW_SCALING_MODE_FREEZE:
557 case NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW:
558 case NATIVE_WINDOW_SCALING_MODE_SCALE_CROP:
561 ALOGE("unknown scaling mode: %d", mode);
565 Mutex::Autolock lock(mMutex);
570 int SurfaceTextureClient::setBuffersTransform(int transform)
573 ALOGV("SurfaceTextureClient::setBuffersTransform");
574 Mutex::Autolock lock(mMutex);
575 mTransform = transform;
579 int SurfaceTextureClient::setBuffersTimestamp(int64_t timestamp)
581 ALOGV("SurfaceTextureClient::setBuffersTimestamp");
582 Mutex::Autolock lock(mMutex);
583 mTimestamp = timestamp;
587 void SurfaceTextureClient::freeAllBuffers() {
588 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) {
593 // ----------------------------------------------------------------------
594 // the lock/unlock APIs must be used from the same thread
596 static status_t copyBlt(
597 const sp<GraphicBuffer>& dst,
598 const sp<GraphicBuffer>& src,
601 // src and dst with, height and format must be identical. no verification
604 uint8_t const * src_bits = NULL;
605 err = src->lock(GRALLOC_USAGE_SW_READ_OFTEN, reg.bounds(), (void**)&src_bits);
606 ALOGE_IF(err, "error locking src buffer %s", strerror(-err));
608 uint8_t* dst_bits = NULL;
609 err = dst->lock(GRALLOC_USAGE_SW_WRITE_OFTEN, reg.bounds(), (void**)&dst_bits);
610 ALOGE_IF(err, "error locking dst buffer %s", strerror(-err));
612 Region::const_iterator head(reg.begin());
613 Region::const_iterator tail(reg.end());
614 if (head != tail && src_bits && dst_bits) {
615 const size_t bpp = bytesPerPixel(src->format);
616 const size_t dbpr = dst->stride * bpp;
617 const size_t sbpr = src->stride * bpp;
619 while (head != tail) {
620 const Rect& r(*head++);
621 ssize_t h = r.height();
622 if (h <= 0) continue;
623 size_t size = r.width() * bpp;
624 uint8_t const * s = src_bits + (r.left + src->stride * r.top) * bpp;
625 uint8_t * d = dst_bits + (r.left + dst->stride * r.top) * bpp;
626 if (dbpr==sbpr && size==sbpr) {
647 // ----------------------------------------------------------------------------
649 status_t SurfaceTextureClient::lock(
650 ANativeWindow_Buffer* outBuffer, ARect* inOutDirtyBounds)
652 if (mLockedBuffer != 0) {
653 ALOGE("Surface::lock failed, already locked");
654 return INVALID_OPERATION;
657 if (!mConnectedToCpu) {
658 int err = SurfaceTextureClient::connect(NATIVE_WINDOW_API_CPU);
662 // we're intending to do software rendering from this point
663 setUsage(GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN);
666 ANativeWindowBuffer* out;
667 status_t err = dequeueBuffer(&out);
668 ALOGE_IF(err, "dequeueBuffer failed (%s)", strerror(-err));
669 if (err == NO_ERROR) {
670 sp<GraphicBuffer> backBuffer(GraphicBuffer::getSelf(out));
671 err = lockBuffer(backBuffer.get());
672 ALOGE_IF(err, "lockBuffer (handle=%p) failed (%s)",
673 backBuffer->handle, strerror(-err));
674 if (err == NO_ERROR) {
675 const Rect bounds(backBuffer->width, backBuffer->height);
677 Region newDirtyRegion;
678 if (inOutDirtyBounds) {
679 newDirtyRegion.set(static_cast<Rect const&>(*inOutDirtyBounds));
680 newDirtyRegion.andSelf(bounds);
682 newDirtyRegion.set(bounds);
685 // figure out if we can copy the frontbuffer back
686 const sp<GraphicBuffer>& frontBuffer(mPostedBuffer);
687 const bool canCopyBack = (frontBuffer != 0 &&
688 backBuffer->width == frontBuffer->width &&
689 backBuffer->height == frontBuffer->height &&
690 backBuffer->format == frontBuffer->format);
693 // copy the area that is invalid and not repainted this round
694 const Region copyback(mOldDirtyRegion.subtract(newDirtyRegion));
695 if (!copyback.isEmpty())
696 copyBlt(backBuffer, frontBuffer, copyback);
698 // if we can't copy-back anything, modify the user's dirty
699 // region to make sure they redraw the whole buffer
700 newDirtyRegion.set(bounds);
703 // keep track of the are of the buffer that is "clean"
704 // (ie: that will be redrawn)
705 mOldDirtyRegion = newDirtyRegion;
707 if (inOutDirtyBounds) {
708 *inOutDirtyBounds = newDirtyRegion.getBounds();
712 status_t res = backBuffer->lock(
713 GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN,
714 newDirtyRegion.bounds(), &vaddr);
716 ALOGW_IF(res, "failed locking buffer (handle = %p)",
719 mLockedBuffer = backBuffer;
720 outBuffer->width = backBuffer->width;
721 outBuffer->height = backBuffer->height;
722 outBuffer->stride = backBuffer->stride;
723 outBuffer->format = backBuffer->format;
724 outBuffer->bits = vaddr;
730 status_t SurfaceTextureClient::unlockAndPost()
732 if (mLockedBuffer == 0) {
733 ALOGE("Surface::unlockAndPost failed, no locked buffer");
734 return INVALID_OPERATION;
737 status_t err = mLockedBuffer->unlock();
738 ALOGE_IF(err, "failed unlocking buffer (%p)", mLockedBuffer->handle);
740 err = queueBuffer(mLockedBuffer.get());
741 ALOGE_IF(err, "queueBuffer (handle=%p) failed (%s)",
742 mLockedBuffer->handle, strerror(-err));
744 mPostedBuffer = mLockedBuffer;
749 }; // namespace android