Adopt CGIOSurfaceContextCreateImageReference to avoid unnecessary readback
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageBuffer.h
1 /*
2  * Copyright (C) 2006 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2007, 2008, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #ifndef ImageBuffer_h
29 #define ImageBuffer_h
30
31 #include "AffineTransform.h"
32 #include "ColorSpace.h"
33 #include "GraphicsTypes.h"
34 #include "GraphicsTypes3D.h"
35 #include "IntSize.h"
36 #include "ImageBufferData.h"
37 #include "PlatformLayer.h"
38 #include <runtime/Uint8ClampedArray.h>
39 #include <wtf/Forward.h>
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/Vector.h>
42
43 namespace WebCore {
44
45 class FloatRect;
46 class GraphicsContext;
47 class GraphicsContext3D;
48 class Image;
49 class ImageData;
50 class IntPoint;
51 class IntRect;
52
53 enum Multiply {
54     Premultiplied,
55     Unmultiplied
56 };
57
58 enum BackingStoreCopy {
59     CopyBackingStore, // Guarantee subsequent draws don't affect the copy.
60     DontCopyBackingStore // Subsequent draws may affect the copy.
61 };
62
63 enum ScaleBehavior {
64     Scaled,
65     Unscaled
66 };
67
68 class ImageBuffer {
69     WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
70     friend class IOSurface;
71 public:
72     // Will return a null pointer on allocation failure.
73     static std::unique_ptr<ImageBuffer> create(const FloatSize& size, RenderingMode renderingMode, float resolutionScale = 1, ColorSpace colorSpace = ColorSpaceSRGB)
74     {
75         bool success = false;
76         std::unique_ptr<ImageBuffer> buffer(new ImageBuffer(size, resolutionScale, colorSpace, renderingMode, success));
77         if (!success)
78             return nullptr;
79         return buffer;
80     }
81
82     static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, float resolutionScale, ColorSpace, const GraphicsContext&, bool hasAlpha);
83
84     WEBCORE_EXPORT ~ImageBuffer();
85
86     // The actual resolution of the backing store
87     const IntSize& internalSize() const { return m_size; }
88     const IntSize& logicalSize() const { return m_logicalSize; }
89
90     float resolutionScale() const { return m_resolutionScale; }
91
92     WEBCORE_EXPORT GraphicsContext& context() const;
93
94     WEBCORE_EXPORT RefPtr<Image> copyImage(BackingStoreCopy = CopyBackingStore, ScaleBehavior = Scaled) const;
95     WEBCORE_EXPORT static RefPtr<Image> sinkIntoImage(std::unique_ptr<ImageBuffer>, ScaleBehavior = Scaled);
96     // Give hints on the faster copyImage Mode, return DontCopyBackingStore if it supports the DontCopyBackingStore behavior
97     // or return CopyBackingStore if it doesn't.  
98     static BackingStoreCopy fastCopyImageMode();
99
100     enum CoordinateSystem { LogicalCoordinateSystem, BackingStoreCoordinateSystem };
101
102     PassRefPtr<Uint8ClampedArray> getUnmultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
103     PassRefPtr<Uint8ClampedArray> getPremultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
104
105     void putByteArray(Multiply multiplied, Uint8ClampedArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint, CoordinateSystem = LogicalCoordinateSystem);
106     
107     void convertToLuminanceMask();
108     
109     String toDataURL(const String& mimeType, const double* quality = 0, CoordinateSystem = LogicalCoordinateSystem) const;
110 #if !USE(CG)
111     AffineTransform baseTransform() const { return AffineTransform(); }
112     void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
113     void platformTransformColorSpace(const Vector<int>&);
114 #else
115     AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, m_data.backingStoreSize.height()); }
116 #endif
117     PlatformLayer* platformLayer() const;
118
119     // FIXME: current implementations of this method have the restriction that they only work
120     // with textures that are RGB or RGBA format, and UNSIGNED_BYTE type.
121     bool copyToPlatformTexture(GraphicsContext3D&, GC3Denum, Platform3DObject, GC3Denum, bool, bool);
122
123     // These functions are used when clamping the ImageBuffer which is created for filter, masker or clipper.
124     static bool sizeNeedsClamping(const FloatSize&);
125     static bool sizeNeedsClamping(const FloatSize&, FloatSize& scale);
126     static FloatSize clampedSize(const FloatSize&);
127     static FloatSize clampedSize(const FloatSize&, FloatSize& scale);
128     static FloatRect clampedRect(const FloatRect&);
129
130 private:
131 #if USE(CG)
132     // The returned image might be larger than the internalSize(). If you want the smaller
133     // image, crop the result.
134     RetainPtr<CGImageRef> copyNativeImage(BackingStoreCopy = CopyBackingStore) const;
135     static RetainPtr<CGImageRef> sinkIntoNativeImage(std::unique_ptr<ImageBuffer>);
136     void flushContext() const;
137 #endif
138     void clip(GraphicsContext&, const FloatRect&) const;
139
140     void draw(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal, bool useLowQualityScale = false);
141     void drawPattern(GraphicsContext&, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, const FloatRect& destRect, BlendMode = BlendModeNormal);
142
143     static void drawConsuming(std::unique_ptr<ImageBuffer>, GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal, bool useLowQualityScale = false);
144
145     inline void genericConvertToLuminanceMask();
146
147     friend class GraphicsContext;
148     friend class GeneratedImage;
149     friend class CrossfadeGeneratedImage;
150     friend class NamedImageGeneratedImage;
151     friend class GradientImage;
152
153 private:
154     ImageBufferData m_data;
155     IntSize m_size;
156     IntSize m_logicalSize;
157     float m_resolutionScale;
158
159     // This constructor will place its success into the given out-variable
160     // so that create() knows when it should return failure.
161     WEBCORE_EXPORT ImageBuffer(const FloatSize&, float resolutionScale, ColorSpace, RenderingMode, bool& success);
162 };
163
164 #if USE(CG)
165 String ImageDataToDataURL(const ImageData&, const String& mimeType, const double* quality);
166 #endif
167
168 } // namespace WebCore
169
170 #endif // ImageBuffer_h