2011-03-15 John Bauman <jbauman@chromium.org>
[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 "GraphicsTypes.h"
35 #include "IntSize.h"
36 #include "ImageBufferData.h"
37 #include <wtf/ByteArray.h>
38 #include <wtf/Forward.h>
39 #include <wtf/OwnPtr.h>
40 #include <wtf/PassOwnPtr.h>
41 #include <wtf/PassRefPtr.h>
42 #include <wtf/Vector.h>
43
44 #if (PLATFORM(MAC) && PLATFORM(CA) && !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD))
45 #define WTF_USE_IOSURFACE_CANVAS_BACKING_STORE 1
46 #endif
47
48 namespace WebCore {
49
50     class GraphicsContext;
51     class Image;
52     class ImageData;
53     class IntPoint;
54     class IntRect;
55
56     enum Multiply {
57         Premultiplied,
58         Unmultiplied
59     };
60
61     enum RenderingMode {
62         Unaccelerated,
63         Accelerated
64     };
65
66     class ImageBuffer {
67         WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
68     public:
69         // Will return a null pointer on allocation failure.
70         static PassOwnPtr<ImageBuffer> create(const IntSize& size, ColorSpace colorSpace = ColorSpaceDeviceRGB, RenderingMode renderingMode = Unaccelerated)
71         {
72             bool success = false;
73             OwnPtr<ImageBuffer> buf(new ImageBuffer(size, colorSpace, renderingMode, success));
74             if (success)
75                 return buf.release();
76             return 0;
77         }
78
79         ~ImageBuffer();
80
81         const IntSize& size() const { return m_size; }
82         int width() const { return m_size.width(); }
83         int height() const { return m_size.height(); }
84         
85         size_t dataSize() const;
86         
87         GraphicsContext* context() const;
88
89         bool drawsUsingCopy() const; // If the image buffer has to render using a copied image, it will return true.
90         PassRefPtr<Image> copyImage() const; // Return a new image that is a copy of the buffer.
91
92         PassRefPtr<ByteArray> getUnmultipliedImageData(const IntRect&) const;
93         PassRefPtr<ByteArray> getPremultipliedImageData(const IntRect&) const;
94
95         void putUnmultipliedImageData(ByteArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint);
96         void putPremultipliedImageData(ByteArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint);
97         
98         String toDataURL(const String& mimeType, const double* quality = 0) const;
99 #if !PLATFORM(CG)
100         AffineTransform baseTransform() const { return AffineTransform(); }
101         void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
102         void platformTransformColorSpace(const Vector<int>&);
103 #else
104         AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, m_size.height()); }
105 #endif
106
107     private:
108         void clip(GraphicsContext*, const FloatRect&) const;
109
110         // The draw method draws the contents of the buffer without copying it.
111         void draw(GraphicsContext*, ColorSpace styleColorSpace, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1),
112                              CompositeOperator = CompositeSourceOver, bool useLowQualityScale = false);
113         void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
114                          const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
115         friend class GraphicsContext;
116         friend class GeneratedImage;
117
118     private:
119         ImageBufferData m_data;
120
121         IntSize m_size;
122         bool m_accelerateRendering;
123         OwnPtr<GraphicsContext> m_context;
124
125 #if !PLATFORM(CG)
126         Vector<int> m_linearRgbLUT;
127         Vector<int> m_deviceRgbLUT;
128 #endif
129
130         // This constructor will place its success into the given out-variable
131         // so that create() knows when it should return failure.
132         ImageBuffer(const IntSize&, ColorSpace colorSpace, RenderingMode renderingMode, bool& success);
133     };
134
135 #if PLATFORM(CG) || USE(SKIA)
136     String ImageDataToDataURL(const ImageData& input, const String& mimeType, const double* quality);
137 #endif
138
139 } // namespace WebCore
140
141 #endif // ImageBuffer_h