Combine event and touch action regions into a single class
[WebKit-https.git] / Source / WebCore / rendering / RenderLayerFilters.cpp
1 /*
2  * Copyright (C) 2012 Adobe Systems Incorporated. All rights reserved.
3  * Copyright (C) 2013 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above
10  *    copyright notice, this list of conditions and the following
11  *    disclaimer.
12  * 2. Redistributions in binary form must reproduce the above
13  *    copyright notice, this list of conditions and the following
14  *    disclaimer in the documentation and/or other materials
15  *    provided with the distribution.
16  * 
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
26  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30
31 #include "config.h"
32 #include "RenderLayerFilters.h"
33
34 #include "CachedSVGDocument.h"
35 #include "CachedSVGDocumentReference.h"
36 #include "RenderSVGResourceFilter.h"
37 #include <wtf/NeverDestroyed.h>
38
39 namespace WebCore {
40
41 RenderLayerFilters::RenderLayerFilters(RenderLayer& layer)
42     : m_layer(layer)
43 {
44 }
45
46 RenderLayerFilters::~RenderLayerFilters()
47 {
48     removeReferenceFilterClients();
49 }
50
51 void RenderLayerFilters::setFilter(RefPtr<CSSFilter>&& filter)
52 {
53     m_filter = WTFMove(filter);
54 }
55
56 bool RenderLayerFilters::hasFilterThatMovesPixels() const
57 {
58     return m_filter && m_filter->hasFilterThatMovesPixels();
59 }
60
61 bool RenderLayerFilters::hasFilterThatShouldBeRestrictedBySecurityOrigin() const
62 {
63     return m_filter && m_filter->hasFilterThatShouldBeRestrictedBySecurityOrigin();
64 }
65
66 void RenderLayerFilters::notifyFinished(CachedResource&)
67 {
68     m_layer.filterNeedsRepaint();
69 }
70
71 void RenderLayerFilters::updateReferenceFilterClients(const FilterOperations& operations)
72 {
73     removeReferenceFilterClients();
74
75     for (auto& operation : operations.operations()) {
76         if (!is<ReferenceFilterOperation>(*operation))
77             continue;
78
79         auto& referenceOperation = downcast<ReferenceFilterOperation>(*operation);
80         auto* documentReference = referenceOperation.cachedSVGDocumentReference();
81         if (auto* cachedSVGDocument = documentReference ? documentReference->document() : nullptr) {
82             // Reference is external; wait for notifyFinished().
83             cachedSVGDocument->addClient(*this);
84             m_externalSVGReferences.append(cachedSVGDocument);
85         } else {
86             // Reference is internal; add layer as a client so we can trigger filter repaint on SVG attribute change.
87             auto* filterElement = m_layer.renderer().document().getElementById(referenceOperation.fragment());
88             if (!filterElement)
89                 continue;
90             auto* renderer = filterElement->renderer();
91             if (!is<RenderSVGResourceFilter>(renderer))
92                 continue;
93             downcast<RenderSVGResourceFilter>(*renderer).addClientRenderLayer(&m_layer);
94             m_internalSVGReferences.append(filterElement);
95         }
96     }
97 }
98
99 void RenderLayerFilters::removeReferenceFilterClients()
100 {
101     for (auto& resourceHandle : m_externalSVGReferences)
102         resourceHandle->removeClient(*this);
103
104     m_externalSVGReferences.clear();
105
106     for (auto& filterElement : m_internalSVGReferences) {
107         if (auto* renderer = filterElement->renderer())
108             downcast<RenderSVGResourceContainer>(*renderer).removeClientRenderLayer(&m_layer);
109     }
110     m_internalSVGReferences.clear();
111 }
112
113 void RenderLayerFilters::buildFilter(RenderElement& renderer, float scaleFactor, RenderingMode renderingMode)
114 {
115     if (!m_filter) {
116         m_filter = CSSFilter::create();
117         m_filter->setFilterScale(scaleFactor);
118         m_filter->setRenderingMode(renderingMode);
119     } else if (m_filter->filterScale() != scaleFactor) {
120         m_filter->setFilterScale(scaleFactor);
121         m_filter->clearIntermediateResults();
122     }
123
124     // If the filter fails to build, remove it from the layer. It will still attempt to
125     // go through regular processing (e.g. compositing), but never apply anything.
126     // FIXME: this rebuilds the entire effects chain even if the filter style didn't change.
127     if (!m_filter->build(renderer, renderer.style().filter(), FilterConsumer::FilterProperty))
128         m_filter = nullptr;
129 }
130
131 GraphicsContext* RenderLayerFilters::beginFilterEffect(GraphicsContext& destinationContext, const LayoutRect& filterBoxRect, const LayoutRect& dirtyRect, const LayoutRect& layerRepaintRect)
132 {
133     if (!m_filter)
134         return nullptr;
135
136     auto& filter = *m_filter;
137     auto filterSourceRect = filter.computeSourceImageRectForDirtyRect(filterBoxRect, dirtyRect);
138     if (filterSourceRect.isEmpty())
139         return nullptr;
140
141     bool hasUpdatedBackingStore = filter.updateBackingStoreRect(filterSourceRect);
142     if (!filter.hasFilterThatMovesPixels())
143         m_repaintRect = dirtyRect;
144     else {
145         if (hasUpdatedBackingStore)
146             m_repaintRect = filterSourceRect;
147         else {
148             m_repaintRect = dirtyRect;
149             m_repaintRect.unite(layerRepaintRect);
150             m_repaintRect.intersect(filterSourceRect);
151         }
152     }
153     m_paintOffset = filterSourceRect.location();
154     resetDirtySourceRect();
155
156     filter.determineFilterPrimitiveSubregion();
157
158     filter.allocateBackingStoreIfNeeded(destinationContext);
159     auto* sourceGraphicsContext = filter.inputContext();
160     if (!sourceGraphicsContext || filter.filterRegion().isEmpty() || ImageBuffer::sizeNeedsClamping(filter.filterRegion().size()))
161         return nullptr;
162
163     // Translate the context so that the contents of the layer is captured in the offscreen memory buffer.
164     sourceGraphicsContext->save();
165     sourceGraphicsContext->translate(-m_paintOffset);
166     sourceGraphicsContext->clearRect(m_repaintRect);
167     sourceGraphicsContext->clip(m_repaintRect);
168
169     return sourceGraphicsContext;
170 }
171
172 void RenderLayerFilters::applyFilterEffect(GraphicsContext& destinationContext)
173 {
174     ASSERT(m_filter->inputContext());
175
176     LOG_WITH_STREAM(Filters, stream << "\nRenderLayerFilters " << this << " applyFilterEffect");
177
178     auto& filter = *m_filter;
179     filter.inputContext()->restore();
180
181     filter.apply();
182
183     // Get the filtered output and draw it in place.
184     LayoutRect destRect = filter.outputRect();
185     destRect.move(m_paintOffset.x(), m_paintOffset.y());
186
187     if (auto* outputBuffer = filter.output())
188         destinationContext.drawImageBuffer(*outputBuffer, snapRectToDevicePixels(destRect, m_layer.renderer().document().deviceScaleFactor()));
189
190     filter.clearIntermediateResults();
191
192     LOG_WITH_STREAM(Filters, stream << "RenderLayerFilters " << this << " applyFilterEffect done\n");
193 }
194
195 } // namespace WebCore