2 * Copyright (C) 2012 Google Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "platform/graphics/Canvas2DLayerBridge.h"
30 #include "GrContext.h"
32 #include "SkSurface.h"
33 #include "platform/TraceEvent.h"
34 #include "platform/graphics/Canvas2DLayerManager.h"
35 #include "platform/graphics/GraphicsLayer.h"
36 #include "public/platform/Platform.h"
37 #include "public/platform/WebCompositorSupport.h"
38 #include "public/platform/WebGraphicsContext3D.h"
39 #include "public/platform/WebGraphicsContext3DProvider.h"
40 #include "wtf/RefCountedLeakCounter.h"
44 InvalidMailboxIndex = -1,
47 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, canvas2DLayerBridgeInstanceCounter, ("Canvas2DLayerBridge"));
52 static PassRefPtr<SkSurface> createSkSurface(GrContext* gr, const IntSize& size, int msaaSampleCount = 0)
57 SkImageInfo info = SkImageInfo::MakeN32Premul(size.width(), size.height());
58 return adoptRef(SkSurface::NewRenderTarget(gr, info, msaaSampleCount));
61 PassRefPtr<Canvas2DLayerBridge> Canvas2DLayerBridge::create(const IntSize& size, OpacityMode opacityMode, int msaaSampleCount)
63 TRACE_EVENT_INSTANT0("test_gpu", "Canvas2DLayerBridgeCreation");
64 OwnPtr<WebGraphicsContext3DProvider> contextProvider = adoptPtr(Platform::current()->createSharedOffscreenGraphicsContext3DProvider());
67 RefPtr<SkSurface> surface(createSkSurface(contextProvider->grContext(), size, msaaSampleCount));
70 RefPtr<Canvas2DLayerBridge> layerBridge;
71 OwnPtr<SkDeferredCanvas> canvas = adoptPtr(SkDeferredCanvas::Create(surface.get()));
72 layerBridge = adoptRef(new Canvas2DLayerBridge(contextProvider.release(), canvas.release(), surface.release(), msaaSampleCount, opacityMode));
73 return layerBridge.release();
76 Canvas2DLayerBridge::Canvas2DLayerBridge(PassOwnPtr<WebGraphicsContext3DProvider> contextProvider, PassOwnPtr<SkDeferredCanvas> canvas, PassRefPtr<SkSurface> surface, int msaaSampleCount, OpacityMode opacityMode)
79 , m_contextProvider(contextProvider)
81 , m_msaaSampleCount(msaaSampleCount)
83 , m_didRecordDrawCommand(false)
84 , m_isSurfaceValid(true)
86 , m_framesSinceMailboxRelease(0)
87 , m_destructionInProgress(false)
88 , m_rateLimitingEnabled(false)
93 , m_releasedMailboxInfoIndex(InvalidMailboxIndex)
97 ASSERT(m_contextProvider);
98 // Used by browser tests to detect the use of a Canvas2DLayerBridge.
99 TRACE_EVENT_INSTANT0("test_gpu", "Canvas2DLayerBridgeCreation");
100 m_layer = adoptPtr(Platform::current()->compositorSupport()->createExternalTextureLayer(this));
101 m_layer->setOpaque(opacityMode == Opaque);
102 m_layer->setBlendBackgroundColor(opacityMode != Opaque);
103 GraphicsLayer::registerContentsLayer(m_layer->layer());
104 m_layer->setRateLimitContext(m_rateLimitingEnabled);
105 m_canvas->setNotificationClient(this);
107 canvas2DLayerBridgeInstanceCounter.increment();
111 Canvas2DLayerBridge::~Canvas2DLayerBridge()
113 ASSERT(m_destructionInProgress);
114 ASSERT(!Canvas2DLayerManager::get().isInList(this));
116 freeReleasedMailbox();
118 Vector<MailboxInfo>::iterator mailboxInfo;
119 for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); ++mailboxInfo) {
120 ASSERT(mailboxInfo->m_status != MailboxInUse);
121 ASSERT(mailboxInfo->m_status != MailboxReleased || m_contextProvider->context3d()->isContextLost() || !m_isSurfaceValid);
126 canvas2DLayerBridgeInstanceCounter.decrement();
130 void Canvas2DLayerBridge::beginDestruction()
132 ASSERT(!m_destructionInProgress);
133 setRateLimitingEnabled(false);
134 m_canvas->silentFlush();
136 freeTransientResources();
138 m_destructionInProgress = true;
139 GraphicsLayer::unregisterContentsLayer(m_layer->layer());
140 m_canvas->setNotificationClient(0);
143 m_layer->clearTexture();
144 // Orphaning the layer is required to trigger the recration of a new layer
145 // in the case where destruction is caused by a canvas resize. Test:
146 // virtual/gpu/fast/canvas/canvas-resize-after-paint-without-layout.html
147 m_layer->layer()->removeFromParent();
148 // To anyone who ever hits this assert: Please update crbug.com/344666
150 ASSERT(!m_bytesAllocated);
153 void Canvas2DLayerBridge::setIsHidden(bool hidden)
155 ASSERT(!m_destructionInProgress);
156 bool newHiddenValue = hidden || m_destructionInProgress;
157 if (m_isHidden == newHiddenValue)
160 m_isHidden = newHiddenValue;
162 freeTransientResources();
166 void Canvas2DLayerBridge::willAccessPixels()
168 // A readback operation may alter the texture parameters, which may affect
169 // the compositor's behavior. Therefore, we must trigger copy-on-write
170 // even though we are not technically writing to the texture, only to its
172 m_surface->notifyContentWillChange(SkSurface::kRetain_ContentChangeMode);
175 void Canvas2DLayerBridge::freeTransientResources()
177 ASSERT(!m_destructionInProgress);
178 freeReleasedMailbox();
180 freeMemoryIfPossible(bytesAllocated());
181 ASSERT(!hasTransientResources());
184 bool Canvas2DLayerBridge::hasTransientResources() const
186 return !m_destructionInProgress && (hasReleasedMailbox() || bytesAllocated());
189 void Canvas2DLayerBridge::limitPendingFrames()
191 ASSERT(!m_destructionInProgress);
193 freeTransientResources();
196 if (m_didRecordDrawCommand) {
198 m_didRecordDrawCommand = false;
199 if (m_framesPending > 1) {
200 // Turn on the rate limiter if this layer tends to accumulate a
201 // non-discardable multi-frame backlog of draw commands.
202 setRateLimitingEnabled(true);
204 if (m_rateLimitingEnabled) {
208 ++m_framesSinceMailboxRelease;
209 if (releasedMailboxHasExpired()) {
210 freeReleasedMailbox();
214 void Canvas2DLayerBridge::prepareForDraw()
216 ASSERT(!m_destructionInProgress);
218 if (!checkSurfaceValid()) {
220 // drop pending commands because there is no surface to draw to
221 m_canvas->silentFlush();
225 context()->makeContextCurrent();
228 void Canvas2DLayerBridge::storageAllocatedForRecordingChanged(size_t bytesAllocated)
230 ASSERT(!m_destructionInProgress);
231 intptr_t delta = (intptr_t)bytesAllocated - (intptr_t)m_bytesAllocated;
232 m_bytesAllocated = bytesAllocated;
233 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this, delta);
236 size_t Canvas2DLayerBridge::storageAllocatedForRecording()
238 return m_canvas->storageAllocatedForRecording();
241 void Canvas2DLayerBridge::flushedDrawCommands()
243 ASSERT(!m_destructionInProgress);
244 storageAllocatedForRecordingChanged(storageAllocatedForRecording());
248 void Canvas2DLayerBridge::skippedPendingDrawCommands()
250 ASSERT(!m_destructionInProgress);
251 // Stop triggering the rate limiter if SkDeferredCanvas is detecting
252 // and optimizing overdraw.
253 setRateLimitingEnabled(false);
254 flushedDrawCommands();
257 void Canvas2DLayerBridge::setRateLimitingEnabled(bool enabled)
259 ASSERT(!m_destructionInProgress);
260 if (m_rateLimitingEnabled != enabled) {
261 m_rateLimitingEnabled = enabled;
262 m_layer->setRateLimitContext(m_rateLimitingEnabled);
266 size_t Canvas2DLayerBridge::freeMemoryIfPossible(size_t bytesToFree)
268 ASSERT(!m_destructionInProgress);
269 size_t bytesFreed = m_canvas->freeMemoryIfPossible(bytesToFree);
270 m_bytesAllocated -= bytesFreed;
272 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this, -((intptr_t)bytesFreed));
276 void Canvas2DLayerBridge::flush()
278 ASSERT(!m_destructionInProgress);
279 if (m_canvas->hasPendingCommands()) {
280 TRACE_EVENT0("cc", "Canvas2DLayerBridge::flush");
281 freeReleasedMailbox(); // To avoid unnecessary triple-buffering
286 bool Canvas2DLayerBridge::releasedMailboxHasExpired()
288 // This heuristic indicates that the canvas is not being
289 // actively presented by the compositor (3 frames rendered since
290 // last mailbox release), suggesting that double buffering is not required.
291 return hasReleasedMailbox() && m_framesSinceMailboxRelease > 2;
294 Canvas2DLayerBridge::MailboxInfo* Canvas2DLayerBridge::releasedMailboxInfo()
296 return hasReleasedMailbox() ? &m_mailboxes[m_releasedMailboxInfoIndex] : 0;
299 bool Canvas2DLayerBridge::hasReleasedMailbox() const
301 return m_releasedMailboxInfoIndex != InvalidMailboxIndex;
304 void Canvas2DLayerBridge::freeReleasedMailbox()
306 if (!m_isSurfaceValid || m_contextProvider->context3d()->isContextLost())
308 MailboxInfo* mailboxInfo = releasedMailboxInfo();
312 ASSERT(mailboxInfo->m_status == MailboxReleased);
313 if (mailboxInfo->m_mailbox.syncPoint) {
314 context()->waitSyncPoint(mailboxInfo->m_mailbox.syncPoint);
315 mailboxInfo->m_mailbox.syncPoint = 0;
317 // Invalidate texture state in case the compositor altered it since the copy-on-write.
318 if (mailboxInfo->m_image) {
319 if (isHidden() || releasedMailboxHasExpired())
320 mailboxInfo->m_image->getTexture()->resetFlag(static_cast<GrTextureFlags>(GrTexture::kReturnToCache_FlagBit));
321 mailboxInfo->m_image->getTexture()->textureParamsModified();
322 mailboxInfo->m_image.clear();
324 mailboxInfo->m_status = MailboxAvailable;
325 m_releasedMailboxInfoIndex = InvalidMailboxIndex;
326 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
329 WebGraphicsContext3D* Canvas2DLayerBridge::context()
331 // Check on m_layer is necessary because context() may be called during
332 // the destruction of m_layer
333 if (m_layer && !m_destructionInProgress)
334 checkSurfaceValid(); // To ensure rate limiter is disabled if context is lost.
335 return m_contextProvider ? m_contextProvider->context3d() : 0;
338 bool Canvas2DLayerBridge::checkSurfaceValid()
340 ASSERT(!m_destructionInProgress);
341 if (m_destructionInProgress || !m_isSurfaceValid)
343 if (m_contextProvider->context3d()->isContextLost()) {
344 m_isSurfaceValid = false;
347 m_imageBuffer->notifySurfaceInvalid();
348 setRateLimitingEnabled(false);
350 return m_isSurfaceValid;
353 bool Canvas2DLayerBridge::restoreSurface()
355 ASSERT(!m_destructionInProgress);
356 if (m_destructionInProgress)
358 ASSERT(m_layer && !m_isSurfaceValid);
360 WebGraphicsContext3D* sharedContext = 0;
361 // We must clear the mailboxes before calling m_layer->clearTexture() to prevent
362 // re-entry via mailboxReleased from operating on defunct GrContext objects.
364 m_releasedMailboxInfoIndex = InvalidMailboxIndex;
365 m_layer->clearTexture();
366 m_contextProvider = adoptPtr(Platform::current()->createSharedOffscreenGraphicsContext3DProvider());
367 if (m_contextProvider)
368 sharedContext = m_contextProvider->context3d();
370 if (sharedContext && !sharedContext->isContextLost()) {
371 IntSize size(m_canvas->getTopDevice()->width(), m_canvas->getTopDevice()->height());
372 RefPtr<SkSurface> surface(createSkSurface(m_contextProvider->grContext(), size, m_msaaSampleCount));
374 m_surface = surface.release();
375 m_canvas->setSurface(m_surface.get());
376 m_isSurfaceValid = true;
377 // FIXME: draw sad canvas picture into new buffer crbug.com/243842
381 return m_isSurfaceValid;
384 bool Canvas2DLayerBridge::prepareMailbox(WebExternalTextureMailbox* outMailbox, WebExternalBitmap* bitmap)
386 if (m_destructionInProgress) {
387 // It can be hit in the following sequence.
388 // 1. Canvas draws something.
389 // 2. The compositor begins the frame.
390 // 3. Javascript makes a context be lost.
395 // Using accelerated 2d canvas with software renderer, which
396 // should only happen in tests that use fake graphics contexts
397 // or in Android WebView in software mode. In this case, we do
398 // not care about producing any results for this canvas.
399 m_canvas->silentFlush();
403 if (!checkSurfaceValid())
406 WebGraphicsContext3D* webContext = context();
408 // Release to skia textures that were previouosly released by the
409 // compositor. We do this before acquiring the next snapshot in
410 // order to cap maximum gpu memory consumption.
411 webContext->makeContextCurrent();
414 RefPtr<SkImage> image = adoptRef(m_canvas->newImageSnapshot());
416 // Early exit if canvas was not drawn to since last prepareMailbox
417 if (image->uniqueID() == m_lastImageId)
419 m_lastImageId = image->uniqueID();
421 MailboxInfo* mailboxInfo = createMailboxInfo();
422 mailboxInfo->m_status = MailboxInUse;
423 mailboxInfo->m_image = image;
425 ASSERT(mailboxInfo->m_mailbox.syncPoint == 0);
426 ASSERT(mailboxInfo->m_image.get());
427 ASSERT(mailboxInfo->m_image->getTexture());
429 // Because of texture sharing with the compositor, we must invalidate
430 // the state cached in skia so that the deferred copy on write
431 // in SkSurface_Gpu does not make any false assumptions.
432 mailboxInfo->m_image->getTexture()->textureParamsModified();
434 webContext->bindTexture(GL_TEXTURE_2D, mailboxInfo->m_image->getTexture()->getTextureHandle());
435 webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
436 webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
437 webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE);
438 webContext->texParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE);
439 webContext->produceTextureCHROMIUM(GL_TEXTURE_2D, mailboxInfo->m_mailbox.name);
441 // With hidden canvases, we release the SkImage immediately because
442 // there is no need for animations to be double buffered.
443 mailboxInfo->m_image.clear();
446 mailboxInfo->m_mailbox.syncPoint = webContext->insertSyncPoint();
448 webContext->bindTexture(GL_TEXTURE_2D, 0);
449 // Because we are changing the texture binding without going through skia,
450 // we must dirty the context.
451 m_contextProvider->grContext()->resetContext(kTextureBinding_GrGLBackendState);
453 // set m_parentLayerBridge to make sure 'this' stays alive as long as it has
455 ASSERT(!mailboxInfo->m_parentLayerBridge);
456 mailboxInfo->m_parentLayerBridge = this;
457 *outMailbox = mailboxInfo->m_mailbox;
462 Canvas2DLayerBridge::MailboxInfo* Canvas2DLayerBridge::createMailboxInfo() {
463 ASSERT(!m_destructionInProgress);
464 MailboxInfo* mailboxInfo;
465 for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); mailboxInfo++) {
466 if (mailboxInfo->m_status == MailboxAvailable) {
471 // No available mailbox: create one.
472 m_mailboxes.grow(m_mailboxes.size() + 1);
473 mailboxInfo = &m_mailboxes.last();
474 context()->genMailboxCHROMIUM(mailboxInfo->m_mailbox.name);
475 // Worst case, canvas is triple buffered. More than 3 active mailboxes
476 // means there is a problem.
477 // For the single-threaded case, this value needs to be at least
478 // kMaxSwapBuffersPending+1 (in render_widget.h).
479 // Because of crbug.com/247874, it needs to be kMaxSwapBuffersPending+2.
480 // TODO(piman): fix this.
481 ASSERT(m_mailboxes.size() <= 4);
482 ASSERT(mailboxInfo < m_mailboxes.end());
486 void Canvas2DLayerBridge::mailboxReleased(const WebExternalTextureMailbox& mailbox, bool lostResource)
488 freeReleasedMailbox(); // Never have more than one mailbox in the released state.
489 bool contextLost = !m_isSurfaceValid || m_contextProvider->context3d()->isContextLost();
490 Vector<MailboxInfo>::iterator mailboxInfo;
491 for (mailboxInfo = m_mailboxes.begin(); mailboxInfo < m_mailboxes.end(); ++mailboxInfo) {
492 if (nameEquals(mailboxInfo->m_mailbox, mailbox)) {
493 mailboxInfo->m_mailbox.syncPoint = mailbox.syncPoint;
494 ASSERT(mailboxInfo->m_status == MailboxInUse);
495 ASSERT(mailboxInfo->m_parentLayerBridge.get() == this);
498 // No need to clean up the mailbox resource, but make sure the
499 // mailbox can also be reusable once the context is restored.
500 mailboxInfo->m_status = MailboxAvailable;
501 m_releasedMailboxInfoIndex = InvalidMailboxIndex;
502 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
503 } else if (lostResource) {
504 // In case of the resource is lost, we need to delete the backing
505 // texture and remove the mailbox from list to avoid reusing it
507 if (mailboxInfo->m_image) {
508 mailboxInfo->m_image->getTexture()->resetFlag(
509 static_cast<GrTextureFlags>(GrTexture::kReturnToCache_FlagBit));
510 mailboxInfo->m_image->getTexture()->textureParamsModified();
511 mailboxInfo->m_image.clear();
513 size_t i = mailboxInfo - m_mailboxes.begin();
514 m_mailboxes.remove(i);
515 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
516 // Here we need to return early since mailboxInfo removal would
517 // also clear m_parentLayerBridge reference.
520 mailboxInfo->m_status = MailboxReleased;
521 m_releasedMailboxInfoIndex = mailboxInfo - m_mailboxes.begin();
522 m_framesSinceMailboxRelease = 0;
524 freeReleasedMailbox();
526 ASSERT(!m_destructionInProgress);
527 Canvas2DLayerManager::get().layerTransientResourceAllocationChanged(this);
530 // Trigger Canvas2DLayerBridge self-destruction if this is the
531 // last live mailbox and the layer bridge is not externally
533 mailboxInfo->m_parentLayerBridge.clear();
539 WebLayer* Canvas2DLayerBridge::layer() const
541 ASSERT(!m_destructionInProgress);
543 return m_layer->layer();
546 void Canvas2DLayerBridge::finalizeFrame()
548 ASSERT(!m_destructionInProgress);
549 Canvas2DLayerManager::get().layerDidDraw(this);
550 m_didRecordDrawCommand = true;
553 Platform3DObject Canvas2DLayerBridge::getBackingTexture()
555 ASSERT(!m_destructionInProgress);
556 if (!checkSurfaceValid())
560 GrRenderTarget* renderTarget = m_canvas->getTopDevice()->accessRenderTarget();
562 return renderTarget->asTexture()->getTextureHandle();
567 Canvas2DLayerBridge::MailboxInfo::MailboxInfo(const MailboxInfo& other) {
568 // This copy constructor should only be used for Vector reallocation
569 // Assuming 'other' is to be destroyed, we transfer m_image ownership
570 // rather than do a refcount dance.
571 memcpy(&m_mailbox, &other.m_mailbox, sizeof(m_mailbox));
572 m_image = const_cast<MailboxInfo*>(&other)->m_image.release();
573 m_status = other.m_status;