f9bc92049a4f63184eb653c161b0108358ec2910
[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 COMPUTER, 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 COMPUTER, 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 "FloatRect.h"
34 #include "GraphicsContext.h"
35 #if USE(ACCELERATED_COMPOSITING)
36 #include "PlatformLayer.h"
37 #endif
38 #include "GraphicsTypes.h"
39 #include "GraphicsTypes3D.h"
40 #include "IntSize.h"
41 #include "ImageBufferData.h"
42 #include <wtf/Forward.h>
43 #include <wtf/OwnPtr.h>
44 #include <wtf/PassOwnPtr.h>
45 #include <wtf/PassRefPtr.h>
46 #include <wtf/Uint8ClampedArray.h>
47 #include <wtf/Vector.h>
48
49 namespace WebCore {
50
51     class Image;
52     class ImageData;
53     class IntPoint;
54     class IntRect;
55     class GraphicsContext3D;
56
57     enum Multiply {
58         Premultiplied,
59         Unmultiplied
60     };
61
62     enum RenderingMode {
63         Unaccelerated,
64         UnacceleratedNonPlatformBuffer, // Use plain memory allocation rather than platform API to allocate backing store.
65         Accelerated
66     };
67     
68     enum BackingStoreCopy {
69         CopyBackingStore, // Guarantee subsequent draws don't affect the copy.
70         DontCopyBackingStore // Subsequent draws may affect the copy.
71     };
72
73     enum DeferralMode {
74         NonDeferred,
75         Deferred
76     };
77
78     enum ScaleBehavior {
79         Scaled,
80         Unscaled
81     };
82
83     class ImageBuffer {
84         WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
85     public:
86         // Will return a null pointer on allocation failure.
87         static PassOwnPtr<ImageBuffer> create(const IntSize& size, float resolutionScale = 1, ColorSpace colorSpace = ColorSpaceDeviceRGB, RenderingMode renderingMode = Unaccelerated, DeferralMode deferralMode = NonDeferred)
88         {
89             bool success = false;
90             OwnPtr<ImageBuffer> buf = adoptPtr(new ImageBuffer(size, resolutionScale, colorSpace, renderingMode, deferralMode, success));
91             if (!success)
92                 return nullptr;
93             return buf.release();
94         }
95
96         static PassOwnPtr<ImageBuffer> createCompatibleBuffer(const IntSize&, float resolutionScale, ColorSpace, const GraphicsContext*, bool hasAlpha);
97
98         ~ImageBuffer();
99
100         // The actual resolution of the backing store
101         const IntSize& internalSize() const { return m_size; }
102         const IntSize& logicalSize() const { return m_logicalSize; }
103
104         GraphicsContext* context() const;
105
106         PassRefPtr<Image> copyImage(BackingStoreCopy = CopyBackingStore, ScaleBehavior = Scaled) const;
107
108         enum CoordinateSystem { LogicalCoordinateSystem, BackingStoreCoordinateSystem };
109
110         PassRefPtr<Uint8ClampedArray> getUnmultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
111         PassRefPtr<Uint8ClampedArray> getPremultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
112
113         void putByteArray(Multiply multiplied, Uint8ClampedArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint, CoordinateSystem = LogicalCoordinateSystem);
114         
115         void convertToLuminanceMask();
116         
117         String toDataURL(const String& mimeType, const double* quality = 0, CoordinateSystem = LogicalCoordinateSystem) const;
118 #if !USE(CG)
119         AffineTransform baseTransform() const { return AffineTransform(); }
120         void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
121         void platformTransformColorSpace(const Vector<int>&);
122 #else
123         AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, internalSize().height()); }
124 #endif
125 #if USE(ACCELERATED_COMPOSITING)
126         PlatformLayer* platformLayer() const;
127 #endif
128
129         // FIXME: current implementations of this method have the restriction that they only work
130         // with textures that are RGB or RGBA format, and UNSIGNED_BYTE type.
131         bool copyToPlatformTexture(GraphicsContext3D&, Platform3DObject, GC3Denum, bool, bool);
132
133         void reportMemoryUsage(MemoryObjectInfo*) const;
134
135     private:
136 #if USE(CG)
137         NativeImagePtr copyNativeImage(BackingStoreCopy = CopyBackingStore) const;
138 #endif
139         void clip(GraphicsContext*, const FloatRect&) const;
140
141         void draw(GraphicsContext*, ColorSpace, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, bool useLowQualityScale = false);
142         void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
143
144         inline void genericConvertToLuminanceMask();
145
146         friend class GraphicsContext;
147         friend class GeneratedImage;
148         friend class CrossfadeGeneratedImage;
149         friend class GeneratorGeneratedImage;
150
151     private:
152         ImageBufferData m_data;
153         IntSize m_size;
154         IntSize m_logicalSize;
155         float m_resolutionScale;
156         OwnPtr<GraphicsContext> m_context;
157
158         // This constructor will place its success into the given out-variable
159         // so that create() knows when it should return failure.
160         ImageBuffer(const IntSize&, float resolutionScale, ColorSpace, RenderingMode, DeferralMode, bool& success);
161 #if USE(SKIA)
162         ImageBuffer(const IntSize&, float resolutionScale, ColorSpace, const GraphicsContext*, bool hasAlpha, bool& success);
163 #endif
164     };
165
166 #if USE(CG) || USE(SKIA)
167     String ImageDataToDataURL(const ImageData&, const String& mimeType, const double* quality);
168 #endif
169
170 } // namespace WebCore
171
172 #endif // ImageBuffer_h