src/third_party/WebKit/Source/platform/graphics/Canvas2DLayerBridge.h

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *
   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.
  13  *
  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.
  24  */
  25
  26 #ifndef Canvas2DLayerBridge_h
  27 #define Canvas2DLayerBridge_h
  28
  29 #include "SkDeferredCanvas.h"
  30 #include "SkImage.h"
  31 #include "platform/PlatformExport.h"
  32 #include "platform/geometry/IntSize.h"
  33 #include "platform/graphics/ImageBufferSurface.h"
  34 #include "public/platform/WebExternalTextureLayer.h"
  35 #include "public/platform/WebExternalTextureLayerClient.h"
  36 #include "public/platform/WebExternalTextureMailbox.h"
  37 #include "third_party/khronos/GLES2/gl2.h"
  38 #include "wtf/DoublyLinkedList.h"
  39 #include "wtf/PassOwnPtr.h"
  40 #include "wtf/RefCounted.h"
  41 #include "wtf/RefPtr.h"
  42
  43 namespace blink {
  44 class WebGraphicsContext3D;
  45 class WebGraphicsContext3DProvider;
  46 }
  47
  48 class Canvas2DLayerBridgeTest;
  49
  50 namespace WebCore {
  51
  52 class PLATFORM_EXPORT Canvas2DLayerBridge : public blink::WebExternalTextureLayerClient, public SkDeferredCanvas::NotificationClient, public DoublyLinkedListNode<Canvas2DLayerBridge>, public RefCounted<Canvas2DLayerBridge> {
  53     WTF_MAKE_NONCOPYABLE(Canvas2DLayerBridge);
  54 public:
  55     static PassRefPtr<Canvas2DLayerBridge> create(const IntSize&, OpacityMode, int msaaSampleCount);
  56
  57     virtual ~Canvas2DLayerBridge();
  58
  59     // blink::WebExternalTextureLayerClient implementation.
  60     virtual blink::WebGraphicsContext3D* context() OVERRIDE;
  61     virtual bool prepareMailbox(blink::WebExternalTextureMailbox*, blink::WebExternalBitmap*) OVERRIDE;
  62     virtual void mailboxReleased(const blink::WebExternalTextureMailbox&) OVERRIDE;
  63
  64     // SkDeferredCanvas::NotificationClient implementation
  65     virtual void prepareForDraw() OVERRIDE;
  66     virtual void storageAllocatedForRecordingChanged(size_t) OVERRIDE;
  67     virtual void flushedDrawCommands() OVERRIDE;
  68     virtual void skippedPendingDrawCommands() OVERRIDE;
  69
  70     // ImageBufferSurface implementation
  71     void willUse();
  72     SkCanvas* canvas() const { return m_canvas.get(); }
  73     bool isValid();
  74     blink::WebLayer* layer() const;
  75     Platform3DObject getBackingTexture();
  76     bool isAccelerated() const { return true; }
  77     void setIsHidden(bool);
  78
  79     // Methods used by Canvas2DLayerManager
  80     virtual size_t freeMemoryIfPossible(size_t); // virtual for mocking
  81     virtual void flush(); // virtual for mocking
  82     virtual size_t storageAllocatedForRecording(); // virtual for faking
  83     size_t bytesAllocated() const { return m_bytesAllocated; }
  84     void limitPendingFrames();
  85     void freeReleasedMailbox();
  86     bool hasReleasedMailbox() const;
  87     void freeTransientResources();
  88     bool hasTransientResources() const;
  89     bool isHidden() { return m_isHidden; }
  90
  91     void beginDestruction();
  92
  93 protected:
  94     Canvas2DLayerBridge(PassOwnPtr<blink::WebGraphicsContext3DProvider>, PassOwnPtr<SkDeferredCanvas>, int, OpacityMode);
  95     void setRateLimitingEnabled(bool);
  96     bool releasedMailboxHasExpired();
  97
  98     OwnPtr<SkDeferredCanvas> m_canvas;
  99     OwnPtr<blink::WebExternalTextureLayer> m_layer;
 100     OwnPtr<blink::WebGraphicsContext3DProvider> m_contextProvider;
 101     int m_msaaSampleCount;
 102     size_t m_bytesAllocated;
 103     bool m_didRecordDrawCommand;
 104     bool m_surfaceIsValid;
 105     int m_framesPending;
 106     int m_framesSinceMailboxRelease;
 107     bool m_destructionInProgress;
 108     bool m_rateLimitingEnabled;
 109     bool m_isHidden;
 110
 111     friend class WTF::DoublyLinkedListNode<Canvas2DLayerBridge>;
 112     friend class ::Canvas2DLayerBridgeTest;
 113     Canvas2DLayerBridge* m_next;
 114     Canvas2DLayerBridge* m_prev;
 115
 116     enum MailboxStatus {
 117         MailboxInUse,
 118         MailboxReleased,
 119         MailboxAvailable,
 120     };
 121
 122     struct MailboxInfo {
 123         blink::WebExternalTextureMailbox m_mailbox;
 124         RefPtr<SkImage> m_image;
 125         MailboxStatus m_status;
 126         RefPtr<Canvas2DLayerBridge> m_parentLayerBridge;
 127
 128         MailboxInfo(const MailboxInfo&);
 129         MailboxInfo() {}
 130     };
 131     MailboxInfo* createMailboxInfo();
 132     MailboxInfo* releasedMailboxInfo();
 133
 134     uint32_t m_lastImageId;
 135     Vector<MailboxInfo> m_mailboxes;
 136     int m_releasedMailboxInfoIndex;
 137 };
 138 }
 139 #endif