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