blob: 8a5e009d9fa1598bc23120ec0f3c158cd5ef7639 [file] [log] [blame]
/*
* Copyright (C) 2010 Igalia S.L.
* Copyright (C) 2011 ProFUSION embedded systems
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "CairoUtilities.h"
#if USE(CAIRO)
#include "AffineTransform.h"
#include "Color.h"
#include "FloatPoint.h"
#include "FloatRect.h"
#include "IntRect.h"
#include "Path.h"
#include "PlatformPathCairo.h"
#include "RefPtrCairo.h"
#include "Region.h"
#include <wtf/Assertions.h>
#include <wtf/NeverDestroyed.h>
#include <wtf/UniqueArray.h>
#include <wtf/Vector.h>
#if ENABLE(ACCELERATED_2D_CANVAS)
#if USE(EGL) && USE(LIBEPOXY)
#include "EpoxyEGL.h"
#endif
#include <cairo-gl.h>
#endif
#if OS(WINDOWS)
#include <cairo-win32.h>
#endif
namespace WebCore {
#if USE(FREETYPE) && !PLATFORM(GTK)
const cairo_font_options_t* getDefaultCairoFontOptions()
{
static NeverDestroyed<cairo_font_options_t*> options = cairo_font_options_create();
return options;
}
#endif
void copyContextProperties(cairo_t* srcCr, cairo_t* dstCr)
{
cairo_set_antialias(dstCr, cairo_get_antialias(srcCr));
size_t dashCount = cairo_get_dash_count(srcCr);
Vector<double> dashes(dashCount);
double offset;
cairo_get_dash(srcCr, dashes.data(), &offset);
cairo_set_dash(dstCr, dashes.data(), dashCount, offset);
cairo_set_line_cap(dstCr, cairo_get_line_cap(srcCr));
cairo_set_line_join(dstCr, cairo_get_line_join(srcCr));
cairo_set_line_width(dstCr, cairo_get_line_width(srcCr));
cairo_set_miter_limit(dstCr, cairo_get_miter_limit(srcCr));
cairo_set_fill_rule(dstCr, cairo_get_fill_rule(srcCr));
}
void setSourceRGBAFromColor(cairo_t* context, const Color& color)
{
if (color.isExtended())
cairo_set_source_rgba(context, color.asExtended().red(), color.asExtended().green(), color.asExtended().blue(), color.asExtended().alpha());
else {
float red, green, blue, alpha;
color.getRGBA(red, green, blue, alpha);
cairo_set_source_rgba(context, red, green, blue, alpha);
}
}
void appendPathToCairoContext(cairo_t* to, cairo_t* from)
{
auto cairoPath = cairo_copy_path(from);
cairo_append_path(to, cairoPath);
cairo_path_destroy(cairoPath);
}
void setPathOnCairoContext(cairo_t* to, cairo_t* from)
{
cairo_new_path(to);
appendPathToCairoContext(to, from);
}
void appendWebCorePathToCairoContext(cairo_t* context, const Path& path)
{
if (path.isEmpty())
return;
appendPathToCairoContext(context, path.platformPath()->context());
}
void appendRegionToCairoContext(cairo_t* to, const cairo_region_t* region)
{
if (!region)
return;
const int rectCount = cairo_region_num_rectangles(region);
for (int i = 0; i < rectCount; ++i) {
cairo_rectangle_int_t rect;
cairo_region_get_rectangle(region, i, &rect);
cairo_rectangle(to, rect.x, rect.y, rect.width, rect.height);
}
}
static cairo_operator_t toCairoCompositeOperator(CompositeOperator op)
{
switch (op) {
case CompositeClear:
return CAIRO_OPERATOR_CLEAR;
case CompositeCopy:
return CAIRO_OPERATOR_SOURCE;
case CompositeSourceOver:
return CAIRO_OPERATOR_OVER;
case CompositeSourceIn:
return CAIRO_OPERATOR_IN;
case CompositeSourceOut:
return CAIRO_OPERATOR_OUT;
case CompositeSourceAtop:
return CAIRO_OPERATOR_ATOP;
case CompositeDestinationOver:
return CAIRO_OPERATOR_DEST_OVER;
case CompositeDestinationIn:
return CAIRO_OPERATOR_DEST_IN;
case CompositeDestinationOut:
return CAIRO_OPERATOR_DEST_OUT;
case CompositeDestinationAtop:
return CAIRO_OPERATOR_DEST_ATOP;
case CompositeXOR:
return CAIRO_OPERATOR_XOR;
case CompositePlusDarker:
return CAIRO_OPERATOR_DARKEN;
case CompositePlusLighter:
return CAIRO_OPERATOR_ADD;
case CompositeDifference:
return CAIRO_OPERATOR_DIFFERENCE;
default:
return CAIRO_OPERATOR_SOURCE;
}
}
cairo_operator_t toCairoOperator(CompositeOperator op, BlendMode blendOp)
{
switch (blendOp) {
case BlendMode::Normal:
return toCairoCompositeOperator(op);
case BlendMode::Multiply:
return CAIRO_OPERATOR_MULTIPLY;
case BlendMode::Screen:
return CAIRO_OPERATOR_SCREEN;
case BlendMode::Overlay:
return CAIRO_OPERATOR_OVERLAY;
case BlendMode::Darken:
return CAIRO_OPERATOR_DARKEN;
case BlendMode::Lighten:
return CAIRO_OPERATOR_LIGHTEN;
case BlendMode::ColorDodge:
return CAIRO_OPERATOR_COLOR_DODGE;
case BlendMode::ColorBurn:
return CAIRO_OPERATOR_COLOR_BURN;
case BlendMode::HardLight:
return CAIRO_OPERATOR_HARD_LIGHT;
case BlendMode::SoftLight:
return CAIRO_OPERATOR_SOFT_LIGHT;
case BlendMode::Difference:
return CAIRO_OPERATOR_DIFFERENCE;
case BlendMode::Exclusion:
return CAIRO_OPERATOR_EXCLUSION;
case BlendMode::Hue:
return CAIRO_OPERATOR_HSL_HUE;
case BlendMode::Saturation:
return CAIRO_OPERATOR_HSL_SATURATION;
case BlendMode::Color:
return CAIRO_OPERATOR_HSL_COLOR;
case BlendMode::Luminosity:
return CAIRO_OPERATOR_HSL_LUMINOSITY;
default:
return CAIRO_OPERATOR_OVER;
}
}
void drawPatternToCairoContext(cairo_t* cr, cairo_surface_t* image, const IntSize& imageSize, const FloatRect& tileRect,
const AffineTransform& patternTransform, const FloatPoint& phase, cairo_operator_t op, const FloatRect& destRect)
{
// Avoid NaN
if (!std::isfinite(phase.x()) || !std::isfinite(phase.y()))
return;
cairo_save(cr);
RefPtr<cairo_surface_t> clippedImageSurface = 0;
if (tileRect.size() != imageSize) {
IntRect imageRect = enclosingIntRect(tileRect);
clippedImageSurface = adoptRef(cairo_image_surface_create(CAIRO_FORMAT_ARGB32, imageRect.width(), imageRect.height()));
RefPtr<cairo_t> clippedImageContext = adoptRef(cairo_create(clippedImageSurface.get()));
cairo_set_source_surface(clippedImageContext.get(), image, -tileRect.x(), -tileRect.y());
cairo_paint(clippedImageContext.get());
image = clippedImageSurface.get();
}
cairo_pattern_t* pattern = cairo_pattern_create_for_surface(image);
cairo_pattern_set_extend(pattern, CAIRO_EXTEND_REPEAT);
// Due to a limitation in pixman, cairo cannot handle transformation matrices with values bigger than 32768. If the value is
// bigger, cairo is not able to paint anything, and this is the reason for the missing backgrounds reported in
// https://bugs.webkit.org/show_bug.cgi?id=154283.
// When drawing a pattern there are 2 matrices that can overflow this limitation, and they are the current transformation
// matrix (which translates user space coordinates to coordinates of the output device) and the pattern matrix (which translates
// user space coordinates to pattern coordinates). The overflow happens only in the translation components of the matrices.
// To avoid the problem in the transformation matrix what we do is remove the translation components of the transformation matrix
// and perform the translation by moving the destination rectangle instead. For this, we calculate such a translation amount (dx, dy)
// that its opposite translate (-dx, -dy) will zero the translation components of the transformation matrix. We move the current
// transformation matrix by (-dx, -dy) and move the destination rectangle by (dx, dy). We also need to apply the same translation to
// the pattern matrix, so we get the same pattern coordinates for the new destination rectangle. (dx, dy) is caclucated by transforming
// the current translation components by the inverse matrix of the current transformation matrix.
cairo_matrix_t ctm;
cairo_get_matrix(cr, &ctm);
double dx = 0, dy = 0;
cairo_matrix_transform_point(&ctm, &dx, &dy);
cairo_matrix_t inv = ctm;
if (cairo_matrix_invert(&inv) == CAIRO_STATUS_SUCCESS)
cairo_matrix_transform_distance(&inv, &dx, &dy);
cairo_translate(cr, -dx, -dy);
FloatRect adjustedDestRect(destRect);
adjustedDestRect.move(dx, dy);
// Regarding the pattern matrix, what we do is reduce the translation component of the matrix taking advantage of the fact that we
// are drawing a repeated pattern. This means that, assuming that (w, h) is the size of the pattern, samplig it at (x, y) is the same
// than sampling it at (x mod w, y mod h), so we transform the translation component of the pattern matrix in that way.
cairo_matrix_t patternMatrix = toCairoMatrix(patternTransform);
// dx and dy are added here as well to compensate the previous translation of the destination rectangle.
double phaseOffsetX = phase.x() + tileRect.x() * patternTransform.a() + dx;
double phaseOffsetY = phase.y() + tileRect.y() * patternTransform.d() + dy;
// this is where we perform the (x mod w, y mod h) metioned above, but with floats instead of integers.
phaseOffsetX -= std::trunc(phaseOffsetX / (tileRect.width() * patternTransform.a())) * tileRect.width() * patternTransform.a();
phaseOffsetY -= std::trunc(phaseOffsetY / (tileRect.height() * patternTransform.d())) * tileRect.height() * patternTransform.d();
cairo_matrix_t phaseMatrix = {1, 0, 0, 1, phaseOffsetX, phaseOffsetY};
cairo_matrix_t combined;
cairo_matrix_multiply(&combined, &patternMatrix, &phaseMatrix);
cairo_matrix_invert(&combined);
cairo_pattern_set_matrix(pattern, &combined);
cairo_set_operator(cr, op);
cairo_set_source(cr, pattern);
cairo_pattern_destroy(pattern);
cairo_rectangle(cr, adjustedDestRect.x(), adjustedDestRect.y(), adjustedDestRect.width(), adjustedDestRect.height());
cairo_fill(cr);
cairo_restore(cr);
}
RefPtr<cairo_surface_t> copyCairoImageSurface(cairo_surface_t* originalSurface)
{
// Cairo doesn't provide a way to copy a cairo_surface_t.
// See http://lists.cairographics.org/archives/cairo/2007-June/010877.html
// Once cairo provides the way, use the function instead of this.
IntSize size = cairoSurfaceSize(originalSurface);
RefPtr<cairo_surface_t> newSurface = adoptRef(cairo_surface_create_similar(originalSurface,
cairo_surface_get_content(originalSurface), size.width(), size.height()));
RefPtr<cairo_t> cr = adoptRef(cairo_create(newSurface.get()));
cairo_set_source_surface(cr.get(), originalSurface, 0, 0);
cairo_set_operator(cr.get(), CAIRO_OPERATOR_SOURCE);
cairo_paint(cr.get());
return newSurface;
}
void copyRectFromCairoSurfaceToContext(cairo_surface_t* from, cairo_t* to, const IntSize& offset, const IntRect& rect)
{
cairo_set_source_surface(to, from, offset.width(), offset.height());
cairo_rectangle(to, rect.x(), rect.y(), rect.width(), rect.height());
cairo_fill(to);
}
void copyRectFromOneSurfaceToAnother(cairo_surface_t* from, cairo_surface_t* to, const IntSize& sourceOffset, const IntRect& rect, const IntSize& destOffset, cairo_operator_t cairoOperator)
{
RefPtr<cairo_t> context = adoptRef(cairo_create(to));
cairo_translate(context.get(), destOffset.width(), destOffset.height());
cairo_set_operator(context.get(), cairoOperator);
copyRectFromCairoSurfaceToContext(from, context.get(), sourceOffset, rect);
}
IntSize cairoSurfaceSize(cairo_surface_t* surface)
{
switch (cairo_surface_get_type(surface)) {
case CAIRO_SURFACE_TYPE_IMAGE:
return IntSize(cairo_image_surface_get_width(surface), cairo_image_surface_get_height(surface));
#if ENABLE(ACCELERATED_2D_CANVAS)
case CAIRO_SURFACE_TYPE_GL:
return IntSize(cairo_gl_surface_get_width(surface), cairo_gl_surface_get_height(surface));
#endif
#if OS(WINDOWS)
case CAIRO_SURFACE_TYPE_WIN32:
surface = cairo_win32_surface_get_image(surface);
ASSERT(surface);
ASSERT(cairo_surface_get_type(surface) == CAIRO_SURFACE_TYPE_IMAGE);
return IntSize(cairo_image_surface_get_width(surface), cairo_image_surface_get_height(surface));
#endif
default:
ASSERT_NOT_REACHED();
return IntSize();
}
}
void flipImageSurfaceVertically(cairo_surface_t* surface)
{
ASSERT(cairo_surface_get_type(surface) == CAIRO_SURFACE_TYPE_IMAGE);
IntSize size = cairoSurfaceSize(surface);
ASSERT(!size.isEmpty());
int stride = cairo_image_surface_get_stride(surface);
int halfHeight = size.height() / 2;
uint8_t* source = static_cast<uint8_t*>(cairo_image_surface_get_data(surface));
auto tmp = makeUniqueArray<uint8_t>(stride);
for (int i = 0; i < halfHeight; ++i) {
uint8_t* top = source + (i * stride);
uint8_t* bottom = source + ((size.height()-i-1) * stride);
memcpy(tmp.get(), top, stride);
memcpy(top, bottom, stride);
memcpy(bottom, tmp.get(), stride);
}
}
void cairoSurfaceSetDeviceScale(cairo_surface_t* surface, double xScale, double yScale)
{
// This function was added pretty much simultaneous to when 1.13 was branched.
#if HAVE(CAIRO_SURFACE_SET_DEVICE_SCALE)
cairo_surface_set_device_scale(surface, xScale, yScale);
#else
UNUSED_PARAM(surface);
ASSERT_UNUSED(xScale, 1 == xScale);
ASSERT_UNUSED(yScale, 1 == yScale);
#endif
}
void cairoSurfaceGetDeviceScale(cairo_surface_t* surface, double& xScale, double& yScale)
{
#if HAVE(CAIRO_SURFACE_SET_DEVICE_SCALE)
cairo_surface_get_device_scale(surface, &xScale, &yScale);
#else
UNUSED_PARAM(surface);
xScale = 1;
yScale = 1;
#endif
}
RefPtr<cairo_region_t> toCairoRegion(const Region& region)
{
RefPtr<cairo_region_t> cairoRegion = adoptRef(cairo_region_create());
for (const auto& rect : region.rects()) {
cairo_rectangle_int_t cairoRect = rect;
cairo_region_union_rectangle(cairoRegion.get(), &cairoRect);
}
return cairoRegion;
}
cairo_matrix_t toCairoMatrix(const AffineTransform& transform)
{
return cairo_matrix_t { transform.a(), transform.b(), transform.c(), transform.d(), transform.e(), transform.f() };
}
} // namespace WebCore
#endif // USE(CAIRO)