BufferQueue.cpp revision 8db92553e9e6263cd41eaf1a1ebc9e3f88f92b5f
1/* 2 * Copyright (C) 2012 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#define LOG_TAG "BufferQueue" 18#define ATRACE_TAG ATRACE_TAG_GRAPHICS 19//#define LOG_NDEBUG 0 20 21#define GL_GLEXT_PROTOTYPES 22#define EGL_EGLEXT_PROTOTYPES 23 24#include <EGL/egl.h> 25#include <EGL/eglext.h> 26 27#include <gui/BufferQueue.h> 28#include <gui/IConsumerListener.h> 29#include <gui/ISurfaceComposer.h> 30#include <private/gui/ComposerService.h> 31 32#include <utils/Log.h> 33#include <utils/Trace.h> 34#include <utils/CallStack.h> 35 36// Macros for including the BufferQueue name in log messages 37#define ST_LOGV(x, ...) ALOGV("[%s] "x, mConsumerName.string(), ##__VA_ARGS__) 38#define ST_LOGD(x, ...) ALOGD("[%s] "x, mConsumerName.string(), ##__VA_ARGS__) 39#define ST_LOGI(x, ...) ALOGI("[%s] "x, mConsumerName.string(), ##__VA_ARGS__) 40#define ST_LOGW(x, ...) ALOGW("[%s] "x, mConsumerName.string(), ##__VA_ARGS__) 41#define ST_LOGE(x, ...) ALOGE("[%s] "x, mConsumerName.string(), ##__VA_ARGS__) 42 43#define ATRACE_BUFFER_INDEX(index) \ 44 if (ATRACE_ENABLED()) { \ 45 char ___traceBuf[1024]; \ 46 snprintf(___traceBuf, 1024, "%s: %d", mConsumerName.string(), \ 47 (index)); \ 48 android::ScopedTrace ___bufTracer(ATRACE_TAG, ___traceBuf); \ 49 } 50 51namespace android { 52 53// Get an ID that's unique within this process. 54static int32_t createProcessUniqueId() { 55 static volatile int32_t globalCounter = 0; 56 return android_atomic_inc(&globalCounter); 57} 58 59static const char* scalingModeName(int scalingMode) { 60 switch (scalingMode) { 61 case NATIVE_WINDOW_SCALING_MODE_FREEZE: return "FREEZE"; 62 case NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW: return "SCALE_TO_WINDOW"; 63 case NATIVE_WINDOW_SCALING_MODE_SCALE_CROP: return "SCALE_CROP"; 64 default: return "Unknown"; 65 } 66} 67 68BufferQueue::BufferQueue(const sp<IGraphicBufferAlloc>& allocator) : 69 mDefaultWidth(1), 70 mDefaultHeight(1), 71 mMaxAcquiredBufferCount(1), 72 mDefaultMaxBufferCount(2), 73 mOverrideMaxBufferCount(0), 74 mConsumerControlledByApp(false), 75 mDequeueBufferCannotBlock(false), 76 mUseAsyncBuffer(true), 77 mConnectedApi(NO_CONNECTED_API), 78 mAbandoned(false), 79 mFrameCounter(0), 80 mBufferHasBeenQueued(false), 81 mDefaultBufferFormat(PIXEL_FORMAT_RGBA_8888), 82 mConsumerUsageBits(0), 83 mTransformHint(0) 84{ 85 // Choose a name using the PID and a process-unique ID. 86 mConsumerName = String8::format("unnamed-%d-%d", getpid(), createProcessUniqueId()); 87 88 ST_LOGV("BufferQueue"); 89 if (allocator == NULL) { 90 sp<ISurfaceComposer> composer(ComposerService::getComposerService()); 91 mGraphicBufferAlloc = composer->createGraphicBufferAlloc(); 92 if (mGraphicBufferAlloc == 0) { 93 ST_LOGE("createGraphicBufferAlloc() failed in BufferQueue()"); 94 } 95 } else { 96 mGraphicBufferAlloc = allocator; 97 } 98} 99 100BufferQueue::~BufferQueue() { 101 ST_LOGV("~BufferQueue"); 102} 103 104status_t BufferQueue::setDefaultMaxBufferCountLocked(int count) { 105 const int minBufferCount = mUseAsyncBuffer ? 2 : 1; 106 if (count < minBufferCount || count > NUM_BUFFER_SLOTS) 107 return BAD_VALUE; 108 109 mDefaultMaxBufferCount = count; 110 mDequeueCondition.broadcast(); 111 112 return NO_ERROR; 113} 114 115void BufferQueue::setConsumerName(const String8& name) { 116 Mutex::Autolock lock(mMutex); 117 mConsumerName = name; 118} 119 120status_t BufferQueue::setDefaultBufferFormat(uint32_t defaultFormat) { 121 Mutex::Autolock lock(mMutex); 122 mDefaultBufferFormat = defaultFormat; 123 return NO_ERROR; 124} 125 126status_t BufferQueue::setConsumerUsageBits(uint32_t usage) { 127 Mutex::Autolock lock(mMutex); 128 mConsumerUsageBits = usage; 129 return NO_ERROR; 130} 131 132status_t BufferQueue::setTransformHint(uint32_t hint) { 133 ST_LOGV("setTransformHint: %02x", hint); 134 Mutex::Autolock lock(mMutex); 135 mTransformHint = hint; 136 return NO_ERROR; 137} 138 139status_t BufferQueue::setBufferCount(int bufferCount) { 140 ST_LOGV("setBufferCount: count=%d", bufferCount); 141 142 sp<IConsumerListener> listener; 143 { 144 Mutex::Autolock lock(mMutex); 145 146 if (mAbandoned) { 147 ST_LOGE("setBufferCount: BufferQueue has been abandoned!"); 148 return NO_INIT; 149 } 150 if (bufferCount > NUM_BUFFER_SLOTS) { 151 ST_LOGE("setBufferCount: bufferCount too large (max %d)", 152 NUM_BUFFER_SLOTS); 153 return BAD_VALUE; 154 } 155 156 // Error out if the user has dequeued buffers 157 for (int i=0 ; i<NUM_BUFFER_SLOTS; i++) { 158 if (mSlots[i].mBufferState == BufferSlot::DEQUEUED) { 159 ST_LOGE("setBufferCount: client owns some buffers"); 160 return -EINVAL; 161 } 162 } 163 164 if (bufferCount == 0) { 165 mOverrideMaxBufferCount = 0; 166 mDequeueCondition.broadcast(); 167 return NO_ERROR; 168 } 169 170 // fine to assume async to false before we're setting the buffer count 171 const int minBufferSlots = getMinMaxBufferCountLocked(false); 172 if (bufferCount < minBufferSlots) { 173 ST_LOGE("setBufferCount: requested buffer count (%d) is less than " 174 "minimum (%d)", bufferCount, minBufferSlots); 175 return BAD_VALUE; 176 } 177 178 // here we're guaranteed that the client doesn't have dequeued buffers 179 // and will release all of its buffer references. We don't clear the 180 // queue, however, so currently queued buffers still get displayed. 181 freeAllBuffersLocked(); 182 mOverrideMaxBufferCount = bufferCount; 183 mDequeueCondition.broadcast(); 184 listener = mConsumerListener; 185 } // scope for lock 186 187 if (listener != NULL) { 188 listener->onBuffersReleased(); 189 } 190 191 return NO_ERROR; 192} 193 194int BufferQueue::query(int what, int* outValue) 195{ 196 ATRACE_CALL(); 197 Mutex::Autolock lock(mMutex); 198 199 if (mAbandoned) { 200 ST_LOGE("query: BufferQueue has been abandoned!"); 201 return NO_INIT; 202 } 203 204 int value; 205 switch (what) { 206 case NATIVE_WINDOW_WIDTH: 207 value = mDefaultWidth; 208 break; 209 case NATIVE_WINDOW_HEIGHT: 210 value = mDefaultHeight; 211 break; 212 case NATIVE_WINDOW_FORMAT: 213 value = mDefaultBufferFormat; 214 break; 215 case NATIVE_WINDOW_MIN_UNDEQUEUED_BUFFERS: 216 value = getMinUndequeuedBufferCount(false); 217 break; 218 case NATIVE_WINDOW_CONSUMER_RUNNING_BEHIND: 219 value = (mQueue.size() >= 2); 220 break; 221 case NATIVE_WINDOW_CONSUMER_USAGE_BITS: 222 value = mConsumerUsageBits; 223 break; 224 default: 225 return BAD_VALUE; 226 } 227 outValue[0] = value; 228 return NO_ERROR; 229} 230 231status_t BufferQueue::requestBuffer(int slot, sp<GraphicBuffer>* buf) { 232 ATRACE_CALL(); 233 ST_LOGV("requestBuffer: slot=%d", slot); 234 Mutex::Autolock lock(mMutex); 235 if (mAbandoned) { 236 ST_LOGE("requestBuffer: BufferQueue has been abandoned!"); 237 return NO_INIT; 238 } 239 if (slot < 0 || slot >= NUM_BUFFER_SLOTS) { 240 ST_LOGE("requestBuffer: slot index out of range [0, %d]: %d", 241 NUM_BUFFER_SLOTS, slot); 242 return BAD_VALUE; 243 } else if (mSlots[slot].mBufferState != BufferSlot::DEQUEUED) { 244 ST_LOGE("requestBuffer: slot %d is not owned by the client (state=%d)", 245 slot, mSlots[slot].mBufferState); 246 return BAD_VALUE; 247 } 248 mSlots[slot].mRequestBufferCalled = true; 249 *buf = mSlots[slot].mGraphicBuffer; 250 return NO_ERROR; 251} 252 253status_t BufferQueue::dequeueBuffer(int *outBuf, sp<Fence>* outFence, bool async, 254 uint32_t w, uint32_t h, uint32_t format, uint32_t usage) { 255 ATRACE_CALL(); 256 ST_LOGV("dequeueBuffer: w=%d h=%d fmt=%#x usage=%#x", w, h, format, usage); 257 258 if ((w && !h) || (!w && h)) { 259 ST_LOGE("dequeueBuffer: invalid size: w=%u, h=%u", w, h); 260 return BAD_VALUE; 261 } 262 263 status_t returnFlags(OK); 264 EGLDisplay dpy = EGL_NO_DISPLAY; 265 EGLSyncKHR eglFence = EGL_NO_SYNC_KHR; 266 267 { // Scope for the lock 268 Mutex::Autolock lock(mMutex); 269 270 if (format == 0) { 271 format = mDefaultBufferFormat; 272 } 273 // turn on usage bits the consumer requested 274 usage |= mConsumerUsageBits; 275 276 int found = -1; 277 bool tryAgain = true; 278 while (tryAgain) { 279 if (mAbandoned) { 280 ST_LOGE("dequeueBuffer: BufferQueue has been abandoned!"); 281 return NO_INIT; 282 } 283 284 const int maxBufferCount = getMaxBufferCountLocked(async); 285 if (async && mOverrideMaxBufferCount) { 286 // FIXME: some drivers are manually setting the buffer-count (which they 287 // shouldn't), so we do this extra test here to handle that case. 288 // This is TEMPORARY, until we get this fixed. 289 if (mOverrideMaxBufferCount < maxBufferCount) { 290 ST_LOGE("dequeueBuffer: async mode is invalid with buffercount override"); 291 return BAD_VALUE; 292 } 293 } 294 295 // Free up any buffers that are in slots beyond the max buffer 296 // count. 297 for (int i = maxBufferCount; i < NUM_BUFFER_SLOTS; i++) { 298 assert(mSlots[i].mBufferState == BufferSlot::FREE); 299 if (mSlots[i].mGraphicBuffer != NULL) { 300 freeBufferLocked(i); 301 returnFlags |= IGraphicBufferProducer::RELEASE_ALL_BUFFERS; 302 } 303 } 304 305 // look for a free buffer to give to the client 306 found = INVALID_BUFFER_SLOT; 307 int dequeuedCount = 0; 308 int acquiredCount = 0; 309 for (int i = 0; i < maxBufferCount; i++) { 310 const int state = mSlots[i].mBufferState; 311 switch (state) { 312 case BufferSlot::DEQUEUED: 313 dequeuedCount++; 314 break; 315 case BufferSlot::ACQUIRED: 316 acquiredCount++; 317 break; 318 case BufferSlot::FREE: 319 /* We return the oldest of the free buffers to avoid 320 * stalling the producer if possible. This is because 321 * the consumer may still have pending reads of the 322 * buffers in flight. 323 */ 324 if ((found < 0) || 325 mSlots[i].mFrameNumber < mSlots[found].mFrameNumber) { 326 found = i; 327 } 328 break; 329 } 330 } 331 332 // clients are not allowed to dequeue more than one buffer 333 // if they didn't set a buffer count. 334 if (!mOverrideMaxBufferCount && dequeuedCount) { 335 ST_LOGE("dequeueBuffer: can't dequeue multiple buffers without " 336 "setting the buffer count"); 337 return -EINVAL; 338 } 339 340 // See whether a buffer has been queued since the last 341 // setBufferCount so we know whether to perform the min undequeued 342 // buffers check below. 343 if (mBufferHasBeenQueued) { 344 // make sure the client is not trying to dequeue more buffers 345 // than allowed. 346 const int newUndequeuedCount = maxBufferCount - (dequeuedCount+1); 347 const int minUndequeuedCount = getMinUndequeuedBufferCount(async); 348 if (newUndequeuedCount < minUndequeuedCount) { 349 ST_LOGE("dequeueBuffer: min undequeued buffer count (%d) " 350 "exceeded (dequeued=%d undequeudCount=%d)", 351 minUndequeuedCount, dequeuedCount, 352 newUndequeuedCount); 353 return -EBUSY; 354 } 355 } 356 357 // If no buffer is found, wait for a buffer to be released or for 358 // the max buffer count to change. 359 tryAgain = found == INVALID_BUFFER_SLOT; 360 if (tryAgain) { 361 // return an error if we're in "cannot block" mode (producer and consumer 362 // are controlled by the application) -- however, the consumer is allowed 363 // to acquire briefly an extra buffer (which could cause us to have to wait here) 364 // and that's okay because we know the wait will be brief (it happens 365 // if we dequeue a buffer while the consumer has acquired one but not released 366 // the old one yet -- for e.g.: see GLConsumer::updateTexImage()). 367 if (mDequeueBufferCannotBlock && (acquiredCount <= mMaxAcquiredBufferCount)) { 368 ST_LOGE("dequeueBuffer: would block! returning an error instead."); 369 return WOULD_BLOCK; 370 } 371 mDequeueCondition.wait(mMutex); 372 } 373 } 374 375 376 if (found == INVALID_BUFFER_SLOT) { 377 // This should not happen. 378 ST_LOGE("dequeueBuffer: no available buffer slots"); 379 return -EBUSY; 380 } 381 382 const int buf = found; 383 *outBuf = found; 384 385 ATRACE_BUFFER_INDEX(buf); 386 387 const bool useDefaultSize = !w && !h; 388 if (useDefaultSize) { 389 // use the default size 390 w = mDefaultWidth; 391 h = mDefaultHeight; 392 } 393 394 mSlots[buf].mBufferState = BufferSlot::DEQUEUED; 395 396 const sp<GraphicBuffer>& buffer(mSlots[buf].mGraphicBuffer); 397 if ((buffer == NULL) || 398 (uint32_t(buffer->width) != w) || 399 (uint32_t(buffer->height) != h) || 400 (uint32_t(buffer->format) != format) || 401 ((uint32_t(buffer->usage) & usage) != usage)) 402 { 403 mSlots[buf].mAcquireCalled = false; 404 mSlots[buf].mGraphicBuffer = NULL; 405 mSlots[buf].mRequestBufferCalled = false; 406 mSlots[buf].mEglFence = EGL_NO_SYNC_KHR; 407 mSlots[buf].mFence = Fence::NO_FENCE; 408 mSlots[buf].mEglDisplay = EGL_NO_DISPLAY; 409 410 returnFlags |= IGraphicBufferProducer::BUFFER_NEEDS_REALLOCATION; 411 } 412 413 414 if (CC_UNLIKELY(mSlots[buf].mFence == NULL)) { 415 ST_LOGE("dequeueBuffer: about to return a NULL fence from mSlot. " 416 "buf=%d, w=%d, h=%d, format=%d", 417 buf, buffer->width, buffer->height, buffer->format); 418 } 419 420 dpy = mSlots[buf].mEglDisplay; 421 eglFence = mSlots[buf].mEglFence; 422 *outFence = mSlots[buf].mFence; 423 mSlots[buf].mEglFence = EGL_NO_SYNC_KHR; 424 mSlots[buf].mFence = Fence::NO_FENCE; 425 } // end lock scope 426 427 if (returnFlags & IGraphicBufferProducer::BUFFER_NEEDS_REALLOCATION) { 428 status_t error; 429 sp<GraphicBuffer> graphicBuffer( 430 mGraphicBufferAlloc->createGraphicBuffer(w, h, format, usage, &error)); 431 if (graphicBuffer == 0) { 432 ST_LOGE("dequeueBuffer: SurfaceComposer::createGraphicBuffer failed"); 433 return error; 434 } 435 436 { // Scope for the lock 437 Mutex::Autolock lock(mMutex); 438 439 if (mAbandoned) { 440 ST_LOGE("dequeueBuffer: BufferQueue has been abandoned!"); 441 return NO_INIT; 442 } 443 444 mSlots[*outBuf].mFrameNumber = ~0; 445 mSlots[*outBuf].mGraphicBuffer = graphicBuffer; 446 } 447 } 448 449 if (eglFence != EGL_NO_SYNC_KHR) { 450 EGLint result = eglClientWaitSyncKHR(dpy, eglFence, 0, 1000000000); 451 // If something goes wrong, log the error, but return the buffer without 452 // synchronizing access to it. It's too late at this point to abort the 453 // dequeue operation. 454 if (result == EGL_FALSE) { 455 ST_LOGE("dequeueBuffer: error waiting for fence: %#x", eglGetError()); 456 } else if (result == EGL_TIMEOUT_EXPIRED_KHR) { 457 ST_LOGE("dequeueBuffer: timeout waiting for fence"); 458 } 459 eglDestroySyncKHR(dpy, eglFence); 460 } 461 462 ST_LOGV("dequeueBuffer: returning slot=%d/%llu buf=%p flags=%#x", *outBuf, 463 mSlots[*outBuf].mFrameNumber, 464 mSlots[*outBuf].mGraphicBuffer->handle, returnFlags); 465 466 return returnFlags; 467} 468 469status_t BufferQueue::queueBuffer(int buf, 470 const QueueBufferInput& input, QueueBufferOutput* output) { 471 ATRACE_CALL(); 472 ATRACE_BUFFER_INDEX(buf); 473 474 Rect crop; 475 uint32_t transform; 476 int scalingMode; 477 int64_t timestamp; 478 bool isAutoTimestamp; 479 bool async; 480 sp<Fence> fence; 481 482 input.deflate(×tamp, &isAutoTimestamp, &crop, &scalingMode, &transform, 483 &async, &fence); 484 485 if (fence == NULL) { 486 ST_LOGE("queueBuffer: fence is NULL"); 487 return BAD_VALUE; 488 } 489 490 switch (scalingMode) { 491 case NATIVE_WINDOW_SCALING_MODE_FREEZE: 492 case NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW: 493 case NATIVE_WINDOW_SCALING_MODE_SCALE_CROP: 494 case NATIVE_WINDOW_SCALING_MODE_NO_SCALE_CROP: 495 break; 496 default: 497 ST_LOGE("unknown scaling mode: %d", scalingMode); 498 return -EINVAL; 499 } 500 501 sp<IConsumerListener> listener; 502 503 { // scope for the lock 504 Mutex::Autolock lock(mMutex); 505 506 if (mAbandoned) { 507 ST_LOGE("queueBuffer: BufferQueue has been abandoned!"); 508 return NO_INIT; 509 } 510 511 const int maxBufferCount = getMaxBufferCountLocked(async); 512 if (async && mOverrideMaxBufferCount) { 513 // FIXME: some drivers are manually setting the buffer-count (which they 514 // shouldn't), so we do this extra test here to handle that case. 515 // This is TEMPORARY, until we get this fixed. 516 if (mOverrideMaxBufferCount < maxBufferCount) { 517 ST_LOGE("queueBuffer: async mode is invalid with buffercount override"); 518 return BAD_VALUE; 519 } 520 } 521 if (buf < 0 || buf >= maxBufferCount) { 522 ST_LOGE("queueBuffer: slot index out of range [0, %d]: %d", 523 maxBufferCount, buf); 524 return -EINVAL; 525 } else if (mSlots[buf].mBufferState != BufferSlot::DEQUEUED) { 526 ST_LOGE("queueBuffer: slot %d is not owned by the client " 527 "(state=%d)", buf, mSlots[buf].mBufferState); 528 return -EINVAL; 529 } else if (!mSlots[buf].mRequestBufferCalled) { 530 ST_LOGE("queueBuffer: slot %d was enqueued without requesting a " 531 "buffer", buf); 532 return -EINVAL; 533 } 534 535 ST_LOGV("queueBuffer: slot=%d/%llu time=%#llx crop=[%d,%d,%d,%d] " 536 "tr=%#x scale=%s", 537 buf, mFrameCounter + 1, timestamp, 538 crop.left, crop.top, crop.right, crop.bottom, 539 transform, scalingModeName(scalingMode)); 540 541 const sp<GraphicBuffer>& graphicBuffer(mSlots[buf].mGraphicBuffer); 542 Rect bufferRect(graphicBuffer->getWidth(), graphicBuffer->getHeight()); 543 Rect croppedCrop; 544 crop.intersect(bufferRect, &croppedCrop); 545 if (croppedCrop != crop) { 546 ST_LOGE("queueBuffer: crop rect is not contained within the " 547 "buffer in slot %d", buf); 548 return -EINVAL; 549 } 550 551 mSlots[buf].mFence = fence; 552 mSlots[buf].mBufferState = BufferSlot::QUEUED; 553 mFrameCounter++; 554 mSlots[buf].mFrameNumber = mFrameCounter; 555 556 BufferItem item; 557 item.mAcquireCalled = mSlots[buf].mAcquireCalled; 558 item.mGraphicBuffer = mSlots[buf].mGraphicBuffer; 559 item.mCrop = crop; 560 item.mTransform = transform; 561 item.mScalingMode = scalingMode; 562 item.mTimestamp = timestamp; 563 item.mIsAutoTimestamp = isAutoTimestamp; 564 item.mFrameNumber = mFrameCounter; 565 item.mBuf = buf; 566 item.mFence = fence; 567 item.mIsDroppable = mDequeueBufferCannotBlock || async; 568 569 if (mQueue.empty()) { 570 // when the queue is empty, we can ignore "mDequeueBufferCannotBlock", and 571 // simply queue this buffer. 572 mQueue.push_back(item); 573 listener = mConsumerListener; 574 } else { 575 // when the queue is not empty, we need to look at the front buffer 576 // state and see if we need to replace it. 577 Fifo::iterator front(mQueue.begin()); 578 if (front->mIsDroppable) { 579 // buffer slot currently queued is marked free if still tracked 580 if (stillTracking(front)) { 581 mSlots[front->mBuf].mBufferState = BufferSlot::FREE; 582 // reset the frame number of the freed buffer so that it is the first in 583 // line to be dequeued again. 584 mSlots[front->mBuf].mFrameNumber = 0; 585 } 586 // and we record the new buffer in the queued list 587 *front = item; 588 } else { 589 mQueue.push_back(item); 590 listener = mConsumerListener; 591 } 592 } 593 594 mBufferHasBeenQueued = true; 595 mDequeueCondition.broadcast(); 596 597 output->inflate(mDefaultWidth, mDefaultHeight, mTransformHint, 598 mQueue.size()); 599 600 ATRACE_INT(mConsumerName.string(), mQueue.size()); 601 } // scope for the lock 602 603 // call back without lock held 604 if (listener != 0) { 605 listener->onFrameAvailable(); 606 } 607 return NO_ERROR; 608} 609 610void BufferQueue::cancelBuffer(int buf, const sp<Fence>& fence) { 611 ATRACE_CALL(); 612 ST_LOGV("cancelBuffer: slot=%d", buf); 613 Mutex::Autolock lock(mMutex); 614 615 if (mAbandoned) { 616 ST_LOGW("cancelBuffer: BufferQueue has been abandoned!"); 617 return; 618 } 619 620 if (buf < 0 || buf >= NUM_BUFFER_SLOTS) { 621 ST_LOGE("cancelBuffer: slot index out of range [0, %d]: %d", 622 NUM_BUFFER_SLOTS, buf); 623 return; 624 } else if (mSlots[buf].mBufferState != BufferSlot::DEQUEUED) { 625 ST_LOGE("cancelBuffer: slot %d is not owned by the client (state=%d)", 626 buf, mSlots[buf].mBufferState); 627 return; 628 } else if (fence == NULL) { 629 ST_LOGE("cancelBuffer: fence is NULL"); 630 return; 631 } 632 mSlots[buf].mBufferState = BufferSlot::FREE; 633 mSlots[buf].mFrameNumber = 0; 634 mSlots[buf].mFence = fence; 635 mDequeueCondition.broadcast(); 636} 637 638status_t BufferQueue::connect(int api, bool producerControlledByApp, QueueBufferOutput* output) { 639 ATRACE_CALL(); 640 ST_LOGV("connect: api=%d producerControlledByApp=%s", api, 641 producerControlledByApp ? "true" : "false"); 642 Mutex::Autolock lock(mMutex); 643 644 if (mAbandoned) { 645 ST_LOGE("connect: BufferQueue has been abandoned!"); 646 return NO_INIT; 647 } 648 649 if (mConsumerListener == NULL) { 650 ST_LOGE("connect: BufferQueue has no consumer!"); 651 return NO_INIT; 652 } 653 654 int err = NO_ERROR; 655 switch (api) { 656 case NATIVE_WINDOW_API_EGL: 657 case NATIVE_WINDOW_API_CPU: 658 case NATIVE_WINDOW_API_MEDIA: 659 case NATIVE_WINDOW_API_CAMERA: 660 if (mConnectedApi != NO_CONNECTED_API) { 661 ST_LOGE("connect: already connected (cur=%d, req=%d)", 662 mConnectedApi, api); 663 err = -EINVAL; 664 } else { 665 mConnectedApi = api; 666 output->inflate(mDefaultWidth, mDefaultHeight, mTransformHint, 667 mQueue.size()); 668 } 669 break; 670 default: 671 err = -EINVAL; 672 break; 673 } 674 675 mBufferHasBeenQueued = false; 676 mDequeueBufferCannotBlock = mConsumerControlledByApp && producerControlledByApp; 677 678 return err; 679} 680 681status_t BufferQueue::disconnect(int api) { 682 ATRACE_CALL(); 683 ST_LOGV("disconnect: api=%d", api); 684 685 int err = NO_ERROR; 686 sp<IConsumerListener> listener; 687 688 { // Scope for the lock 689 Mutex::Autolock lock(mMutex); 690 691 if (mAbandoned) { 692 // it is not really an error to disconnect after the surface 693 // has been abandoned, it should just be a no-op. 694 return NO_ERROR; 695 } 696 697 switch (api) { 698 case NATIVE_WINDOW_API_EGL: 699 case NATIVE_WINDOW_API_CPU: 700 case NATIVE_WINDOW_API_MEDIA: 701 case NATIVE_WINDOW_API_CAMERA: 702 if (mConnectedApi == api) { 703 freeAllBuffersLocked(); 704 mConnectedApi = NO_CONNECTED_API; 705 mDequeueCondition.broadcast(); 706 listener = mConsumerListener; 707 } else { 708 ST_LOGE("disconnect: connected to another api (cur=%d, req=%d)", 709 mConnectedApi, api); 710 err = -EINVAL; 711 } 712 break; 713 default: 714 ST_LOGE("disconnect: unknown API %d", api); 715 err = -EINVAL; 716 break; 717 } 718 } 719 720 if (listener != NULL) { 721 listener->onBuffersReleased(); 722 } 723 724 return err; 725} 726 727void BufferQueue::dump(String8& result, const char* prefix) const { 728 Mutex::Autolock _l(mMutex); 729 730 String8 fifo; 731 int fifoSize = 0; 732 Fifo::const_iterator i(mQueue.begin()); 733 while (i != mQueue.end()) { 734 fifo.appendFormat("%02d:%p crop=[%d,%d,%d,%d], " 735 "xform=0x%02x, time=%#llx, scale=%s\n", 736 i->mBuf, i->mGraphicBuffer.get(), 737 i->mCrop.left, i->mCrop.top, i->mCrop.right, 738 i->mCrop.bottom, i->mTransform, i->mTimestamp, 739 scalingModeName(i->mScalingMode) 740 ); 741 i++; 742 fifoSize++; 743 } 744 745 746 result.appendFormat( 747 "%s-BufferQueue mMaxAcquiredBufferCount=%d, mDequeueBufferCannotBlock=%d, default-size=[%dx%d], " 748 "default-format=%d, transform-hint=%02x, FIFO(%d)={%s}\n", 749 prefix, mMaxAcquiredBufferCount, mDequeueBufferCannotBlock, mDefaultWidth, 750 mDefaultHeight, mDefaultBufferFormat, mTransformHint, 751 fifoSize, fifo.string()); 752 753 struct { 754 const char * operator()(int state) const { 755 switch (state) { 756 case BufferSlot::DEQUEUED: return "DEQUEUED"; 757 case BufferSlot::QUEUED: return "QUEUED"; 758 case BufferSlot::FREE: return "FREE"; 759 case BufferSlot::ACQUIRED: return "ACQUIRED"; 760 default: return "Unknown"; 761 } 762 } 763 } stateName; 764 765 // just trim the free buffers to not spam the dump 766 int maxBufferCount = 0; 767 for (int i=NUM_BUFFER_SLOTS-1 ; i>=0 ; i--) { 768 const BufferSlot& slot(mSlots[i]); 769 if ((slot.mBufferState != BufferSlot::FREE) || (slot.mGraphicBuffer != NULL)) { 770 maxBufferCount = i+1; 771 break; 772 } 773 } 774 775 for (int i=0 ; i<maxBufferCount ; i++) { 776 const BufferSlot& slot(mSlots[i]); 777 const sp<GraphicBuffer>& buf(slot.mGraphicBuffer); 778 result.appendFormat( 779 "%s%s[%02d:%p] state=%-8s", 780 prefix, (slot.mBufferState == BufferSlot::ACQUIRED)?">":" ", i, buf.get(), 781 stateName(slot.mBufferState) 782 ); 783 784 if (buf != NULL) { 785 result.appendFormat( 786 ", %p [%4ux%4u:%4u,%3X]", 787 buf->handle, buf->width, buf->height, buf->stride, 788 buf->format); 789 } 790 result.append("\n"); 791 } 792} 793 794void BufferQueue::freeBufferLocked(int slot) { 795 ST_LOGV("freeBufferLocked: slot=%d", slot); 796 mSlots[slot].mGraphicBuffer = 0; 797 if (mSlots[slot].mBufferState == BufferSlot::ACQUIRED) { 798 mSlots[slot].mNeedsCleanupOnRelease = true; 799 } 800 mSlots[slot].mBufferState = BufferSlot::FREE; 801 mSlots[slot].mFrameNumber = 0; 802 mSlots[slot].mAcquireCalled = false; 803 804 // destroy fence as BufferQueue now takes ownership 805 if (mSlots[slot].mEglFence != EGL_NO_SYNC_KHR) { 806 eglDestroySyncKHR(mSlots[slot].mEglDisplay, mSlots[slot].mEglFence); 807 mSlots[slot].mEglFence = EGL_NO_SYNC_KHR; 808 } 809 mSlots[slot].mFence = Fence::NO_FENCE; 810} 811 812void BufferQueue::freeAllBuffersLocked() { 813 mBufferHasBeenQueued = false; 814 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) { 815 freeBufferLocked(i); 816 } 817} 818 819status_t BufferQueue::acquireBuffer(BufferItem *buffer, nsecs_t expectedPresent) { 820 ATRACE_CALL(); 821 Mutex::Autolock _l(mMutex); 822 823 // Check that the consumer doesn't currently have the maximum number of 824 // buffers acquired. We allow the max buffer count to be exceeded by one 825 // buffer, so that the consumer can successfully set up the newly acquired 826 // buffer before releasing the old one. 827 int numAcquiredBuffers = 0; 828 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) { 829 if (mSlots[i].mBufferState == BufferSlot::ACQUIRED) { 830 numAcquiredBuffers++; 831 } 832 } 833 if (numAcquiredBuffers >= mMaxAcquiredBufferCount+1) { 834 ST_LOGE("acquireBuffer: max acquired buffer count reached: %d (max=%d)", 835 numAcquiredBuffers, mMaxAcquiredBufferCount); 836 return INVALID_OPERATION; 837 } 838 839 // check if queue is empty 840 // In asynchronous mode the list is guaranteed to be one buffer 841 // deep, while in synchronous mode we use the oldest buffer. 842 if (mQueue.empty()) { 843 return NO_BUFFER_AVAILABLE; 844 } 845 846 Fifo::iterator front(mQueue.begin()); 847 848 // If expectedPresent is specified, we may not want to return a buffer yet. 849 // If it's specified and there's more than one buffer queued, we may 850 // want to drop a buffer. 851 if (expectedPresent != 0) { 852 const int MAX_REASONABLE_NSEC = 1000000000ULL; // 1 second 853 854 // The "expectedPresent" argument indicates when the buffer is expected 855 // to be presented on-screen. If the buffer's desired-present time 856 // is earlier (less) than expectedPresent, meaning it'll be displayed 857 // on time or possibly late if we show it ASAP, we acquire and return 858 // it. If we don't want to display it until after the expectedPresent 859 // time, we return PRESENT_LATER without acquiring it. 860 // 861 // To be safe, we don't defer acquisition if expectedPresent is 862 // more than one second in the future beyond the desired present time 863 // (i.e. we'd be holding the buffer for a long time). 864 // 865 // NOTE: code assumes monotonic time values from the system clock are 866 // positive. 867 868 // Start by checking to see if we can drop frames. We skip this check 869 // if the timestamps are being auto-generated by Surface -- if the 870 // app isn't generating timestamps explicitly, they probably don't 871 // want frames to be discarded based on them. 872 while (mQueue.size() > 1 && !mQueue[0].mIsAutoTimestamp) { 873 // If entry[1] is timely, drop entry[0] (and repeat). We apply 874 // an additional criteria here: we only drop the earlier buffer if 875 // our desiredPresent falls within +/- 1 second of the expected 876 // present. Otherwise, bogus desiredPresent times (e.g. 0 or 877 // a small relative timestamp), which normally mean "ignore the 878 // timestamp and acquire immediately", would cause us to drop 879 // frames. 880 // 881 // We may want to add an additional criteria: don't drop the 882 // earlier buffer if entry[1]'s fence hasn't signaled yet. 883 // 884 // (Vector front is [0], back is [size()-1]) 885 const BufferItem& bi(mQueue[1]); 886 nsecs_t desiredPresent = bi.mTimestamp; 887 if (desiredPresent < expectedPresent - MAX_REASONABLE_NSEC || 888 desiredPresent > expectedPresent) { 889 // This buffer is set to display in the near future, or 890 // desiredPresent is garbage. Either way we don't want to 891 // drop the previous buffer just to get this on screen sooner. 892 ST_LOGV("pts nodrop: des=%lld expect=%lld (%lld) now=%lld", 893 desiredPresent, expectedPresent, desiredPresent - expectedPresent, 894 systemTime(CLOCK_MONOTONIC)); 895 break; 896 } 897 ST_LOGV("pts drop: queue1des=%lld expect=%lld size=%d", 898 desiredPresent, expectedPresent, mQueue.size()); 899 if (stillTracking(front)) { 900 // front buffer is still in mSlots, so mark the slot as free 901 mSlots[front->mBuf].mBufferState = BufferSlot::FREE; 902 } 903 mQueue.erase(front); 904 front = mQueue.begin(); 905 } 906 907 // See if the front buffer is due. 908 nsecs_t desiredPresent = front->mTimestamp; 909 if (desiredPresent > expectedPresent && 910 desiredPresent < expectedPresent + MAX_REASONABLE_NSEC) { 911 ST_LOGV("pts defer: des=%lld expect=%lld (%lld) now=%lld", 912 desiredPresent, expectedPresent, desiredPresent - expectedPresent, 913 systemTime(CLOCK_MONOTONIC)); 914 return PRESENT_LATER; 915 } 916 917 ST_LOGV("pts accept: des=%lld expect=%lld (%lld) now=%lld", 918 desiredPresent, expectedPresent, desiredPresent - expectedPresent, 919 systemTime(CLOCK_MONOTONIC)); 920 } 921 922 int buf = front->mBuf; 923 *buffer = *front; 924 ATRACE_BUFFER_INDEX(buf); 925 926 ST_LOGV("acquireBuffer: acquiring { slot=%d/%llu, buffer=%p }", 927 front->mBuf, front->mFrameNumber, 928 front->mGraphicBuffer->handle); 929 // if front buffer still being tracked update slot state 930 if (stillTracking(front)) { 931 mSlots[buf].mAcquireCalled = true; 932 mSlots[buf].mNeedsCleanupOnRelease = false; 933 mSlots[buf].mBufferState = BufferSlot::ACQUIRED; 934 mSlots[buf].mFence = Fence::NO_FENCE; 935 } 936 937 // If the buffer has previously been acquired by the consumer, set 938 // mGraphicBuffer to NULL to avoid unnecessarily remapping this 939 // buffer on the consumer side. 940 if (buffer->mAcquireCalled) { 941 buffer->mGraphicBuffer = NULL; 942 } 943 944 mQueue.erase(front); 945 mDequeueCondition.broadcast(); 946 947 ATRACE_INT(mConsumerName.string(), mQueue.size()); 948 949 return NO_ERROR; 950} 951 952status_t BufferQueue::releaseBuffer( 953 int buf, uint64_t frameNumber, EGLDisplay display, 954 EGLSyncKHR eglFence, const sp<Fence>& fence) { 955 ATRACE_CALL(); 956 ATRACE_BUFFER_INDEX(buf); 957 958 if (buf == INVALID_BUFFER_SLOT || fence == NULL) { 959 return BAD_VALUE; 960 } 961 962 Mutex::Autolock _l(mMutex); 963 964 // If the frame number has changed because buffer has been reallocated, 965 // we can ignore this releaseBuffer for the old buffer. 966 if (frameNumber != mSlots[buf].mFrameNumber) { 967 return STALE_BUFFER_SLOT; 968 } 969 970 971 // Internal state consistency checks: 972 // Make sure this buffers hasn't been queued while we were owning it (acquired) 973 Fifo::iterator front(mQueue.begin()); 974 Fifo::const_iterator const end(mQueue.end()); 975 while (front != end) { 976 if (front->mBuf == buf) { 977 LOG_ALWAYS_FATAL("[%s] received new buffer(#%lld) on slot #%d that has not yet been " 978 "acquired", mConsumerName.string(), frameNumber, buf); 979 break; // never reached 980 } 981 front++; 982 } 983 984 // The buffer can now only be released if its in the acquired state 985 if (mSlots[buf].mBufferState == BufferSlot::ACQUIRED) { 986 mSlots[buf].mEglDisplay = display; 987 mSlots[buf].mEglFence = eglFence; 988 mSlots[buf].mFence = fence; 989 mSlots[buf].mBufferState = BufferSlot::FREE; 990 } else if (mSlots[buf].mNeedsCleanupOnRelease) { 991 ST_LOGV("releasing a stale buf %d its state was %d", buf, mSlots[buf].mBufferState); 992 mSlots[buf].mNeedsCleanupOnRelease = false; 993 return STALE_BUFFER_SLOT; 994 } else { 995 ST_LOGE("attempted to release buf %d but its state was %d", buf, mSlots[buf].mBufferState); 996 return -EINVAL; 997 } 998 999 mDequeueCondition.broadcast(); 1000 return NO_ERROR; 1001} 1002 1003status_t BufferQueue::consumerConnect(const sp<IConsumerListener>& consumerListener, 1004 bool controlledByApp) { 1005 ST_LOGV("consumerConnect controlledByApp=%s", 1006 controlledByApp ? "true" : "false"); 1007 Mutex::Autolock lock(mMutex); 1008 1009 if (mAbandoned) { 1010 ST_LOGE("consumerConnect: BufferQueue has been abandoned!"); 1011 return NO_INIT; 1012 } 1013 if (consumerListener == NULL) { 1014 ST_LOGE("consumerConnect: consumerListener may not be NULL"); 1015 return BAD_VALUE; 1016 } 1017 1018 mConsumerListener = consumerListener; 1019 mConsumerControlledByApp = controlledByApp; 1020 1021 return NO_ERROR; 1022} 1023 1024status_t BufferQueue::consumerDisconnect() { 1025 ST_LOGV("consumerDisconnect"); 1026 Mutex::Autolock lock(mMutex); 1027 1028 if (mConsumerListener == NULL) { 1029 ST_LOGE("consumerDisconnect: No consumer is connected!"); 1030 return -EINVAL; 1031 } 1032 1033 mAbandoned = true; 1034 mConsumerListener = NULL; 1035 mQueue.clear(); 1036 freeAllBuffersLocked(); 1037 mDequeueCondition.broadcast(); 1038 return NO_ERROR; 1039} 1040 1041status_t BufferQueue::getReleasedBuffers(uint32_t* slotMask) { 1042 ST_LOGV("getReleasedBuffers"); 1043 Mutex::Autolock lock(mMutex); 1044 1045 if (mAbandoned) { 1046 ST_LOGE("getReleasedBuffers: BufferQueue has been abandoned!"); 1047 return NO_INIT; 1048 } 1049 1050 uint32_t mask = 0; 1051 for (int i = 0; i < NUM_BUFFER_SLOTS; i++) { 1052 if (!mSlots[i].mAcquireCalled) { 1053 mask |= 1 << i; 1054 } 1055 } 1056 1057 // Remove buffers in flight (on the queue) from the mask where acquire has 1058 // been called, as the consumer will not receive the buffer address, so 1059 // it should not free these slots. 1060 Fifo::iterator front(mQueue.begin()); 1061 while (front != mQueue.end()) { 1062 if (front->mAcquireCalled) 1063 mask &= ~(1 << front->mBuf); 1064 front++; 1065 } 1066 1067 *slotMask = mask; 1068 1069 ST_LOGV("getReleasedBuffers: returning mask %#x", mask); 1070 return NO_ERROR; 1071} 1072 1073status_t BufferQueue::setDefaultBufferSize(uint32_t w, uint32_t h) { 1074 ST_LOGV("setDefaultBufferSize: w=%d, h=%d", w, h); 1075 if (!w || !h) { 1076 ST_LOGE("setDefaultBufferSize: dimensions cannot be 0 (w=%d, h=%d)", 1077 w, h); 1078 return BAD_VALUE; 1079 } 1080 1081 Mutex::Autolock lock(mMutex); 1082 mDefaultWidth = w; 1083 mDefaultHeight = h; 1084 return NO_ERROR; 1085} 1086 1087status_t BufferQueue::setDefaultMaxBufferCount(int bufferCount) { 1088 ATRACE_CALL(); 1089 Mutex::Autolock lock(mMutex); 1090 return setDefaultMaxBufferCountLocked(bufferCount); 1091} 1092 1093status_t BufferQueue::disableAsyncBuffer() { 1094 ATRACE_CALL(); 1095 Mutex::Autolock lock(mMutex); 1096 if (mConsumerListener != NULL) { 1097 ST_LOGE("disableAsyncBuffer: consumer already connected!"); 1098 return INVALID_OPERATION; 1099 } 1100 mUseAsyncBuffer = false; 1101 return NO_ERROR; 1102} 1103 1104status_t BufferQueue::setMaxAcquiredBufferCount(int maxAcquiredBuffers) { 1105 ATRACE_CALL(); 1106 Mutex::Autolock lock(mMutex); 1107 if (maxAcquiredBuffers < 1 || maxAcquiredBuffers > MAX_MAX_ACQUIRED_BUFFERS) { 1108 ST_LOGE("setMaxAcquiredBufferCount: invalid count specified: %d", 1109 maxAcquiredBuffers); 1110 return BAD_VALUE; 1111 } 1112 if (mConnectedApi != NO_CONNECTED_API) { 1113 return INVALID_OPERATION; 1114 } 1115 mMaxAcquiredBufferCount = maxAcquiredBuffers; 1116 return NO_ERROR; 1117} 1118 1119int BufferQueue::getMinUndequeuedBufferCount(bool async) const { 1120 // if dequeueBuffer is allowed to error out, we don't have to 1121 // add an extra buffer. 1122 if (!mUseAsyncBuffer) 1123 return mMaxAcquiredBufferCount; 1124 1125 // we're in async mode, or we want to prevent the app to 1126 // deadlock itself, we throw-in an extra buffer to guarantee it. 1127 if (mDequeueBufferCannotBlock || async) 1128 return mMaxAcquiredBufferCount+1; 1129 1130 return mMaxAcquiredBufferCount; 1131} 1132 1133int BufferQueue::getMinMaxBufferCountLocked(bool async) const { 1134 return getMinUndequeuedBufferCount(async) + 1; 1135} 1136 1137int BufferQueue::getMaxBufferCountLocked(bool async) const { 1138 int minMaxBufferCount = getMinMaxBufferCountLocked(async); 1139 1140 int maxBufferCount = mDefaultMaxBufferCount; 1141 if (maxBufferCount < minMaxBufferCount) { 1142 maxBufferCount = minMaxBufferCount; 1143 } 1144 if (mOverrideMaxBufferCount != 0) { 1145 assert(mOverrideMaxBufferCount >= minMaxBufferCount); 1146 maxBufferCount = mOverrideMaxBufferCount; 1147 } 1148 1149 // Any buffers that are dequeued by the producer or sitting in the queue 1150 // waiting to be consumed need to have their slots preserved. Such 1151 // buffers will temporarily keep the max buffer count up until the slots 1152 // no longer need to be preserved. 1153 for (int i = maxBufferCount; i < NUM_BUFFER_SLOTS; i++) { 1154 BufferSlot::BufferState state = mSlots[i].mBufferState; 1155 if (state == BufferSlot::QUEUED || state == BufferSlot::DEQUEUED) { 1156 maxBufferCount = i + 1; 1157 } 1158 } 1159 1160 return maxBufferCount; 1161} 1162 1163bool BufferQueue::stillTracking(const BufferItem *item) const { 1164 const BufferSlot &slot = mSlots[item->mBuf]; 1165 1166 ST_LOGV("stillTracking?: item: { slot=%d/%llu, buffer=%p }, " 1167 "slot: { slot=%d/%llu, buffer=%p }", 1168 item->mBuf, item->mFrameNumber, 1169 (item->mGraphicBuffer.get() ? item->mGraphicBuffer->handle : 0), 1170 item->mBuf, slot.mFrameNumber, 1171 (slot.mGraphicBuffer.get() ? slot.mGraphicBuffer->handle : 0)); 1172 1173 // Compare item with its original buffer slot. We can check the slot 1174 // as the buffer would not be moved to a different slot by the producer. 1175 return (slot.mGraphicBuffer != NULL && 1176 item->mGraphicBuffer->handle == slot.mGraphicBuffer->handle); 1177} 1178 1179BufferQueue::ProxyConsumerListener::ProxyConsumerListener( 1180 const wp<ConsumerListener>& consumerListener): 1181 mConsumerListener(consumerListener) {} 1182 1183BufferQueue::ProxyConsumerListener::~ProxyConsumerListener() {} 1184 1185void BufferQueue::ProxyConsumerListener::onFrameAvailable() { 1186 sp<ConsumerListener> listener(mConsumerListener.promote()); 1187 if (listener != NULL) { 1188 listener->onFrameAvailable(); 1189 } 1190} 1191 1192void BufferQueue::ProxyConsumerListener::onBuffersReleased() { 1193 sp<ConsumerListener> listener(mConsumerListener.promote()); 1194 if (listener != NULL) { 1195 listener->onBuffersReleased(); 1196 } 1197} 1198 1199}; // namespace android 1200