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