[iOS] PDFDocumentImage should not create a cached image larger than 4M pixels
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageBuffer.h
index 113268d..6df7994 100644 (file)
  *    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 COMPUTER, INC. ``AS IS'' AND ANY
+ * 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 COMPUTER, INC. OR
+ * 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
 
 #include "AffineTransform.h"
 #include "ColorSpace.h"
-#include "FloatRect.h"
 #include "GraphicsTypes.h"
+#include "GraphicsTypes3D.h"
 #include "IntSize.h"
 #include "ImageBufferData.h"
-#include <wtf/ByteArray.h>
+#include "PlatformLayer.h"
+#include <runtime/Uint8ClampedArray.h>
 #include <wtf/Forward.h>
-#include <wtf/OwnPtr.h>
-#include <wtf/PassOwnPtr.h>
-#include <wtf/PassRefPtr.h>
+#include <wtf/RefPtr.h>
 #include <wtf/Vector.h>
 
-#if (PLATFORM(MAC) && PLATFORM(CA) && !defined(BUILDING_ON_TIGER) && !defined(BUILDING_ON_LEOPARD) && !defined(BUILDING_ON_SNOW_LEOPARD))
-#define WTF_USE_IOSURFACE_CANVAS_BACKING_STORE 1
-#endif
-
 namespace WebCore {
 
-    class GraphicsContext;
-    class Image;
-    class ImageData;
-    class IntPoint;
-    class IntRect;
-
-    enum Multiply {
-        Premultiplied,
-        Unmultiplied
-    };
-
-    enum RenderingMode {
-        Unaccelerated,
-        Accelerated
-    };
-
-    class ImageBuffer {
-        WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
-    public:
-        // Will return a null pointer on allocation failure.
-        static PassOwnPtr<ImageBuffer> create(const IntSize& size, ColorSpace colorSpace = ColorSpaceDeviceRGB, RenderingMode renderingMode = Unaccelerated)
-        {
-            bool success = false;
-            OwnPtr<ImageBuffer> buf(new ImageBuffer(size, colorSpace, renderingMode, success));
-            if (success)
-                return buf.release();
-            return 0;
-        }
-
-        ~ImageBuffer();
-
-        const IntSize& size() const { return m_size; }
-        int width() const { return m_size.width(); }
-        int height() const { return m_size.height(); }
-        
-        size_t dataSize() const;
-        
-        GraphicsContext* context() const;
-
-        bool isAccelerated() const { return m_accelerateRendering; }
-        bool drawsUsingCopy() const; // If the image buffer has to render using a copied image, it will return true.
-        PassRefPtr<Image> copyImage() const; // Return a new image that is a copy of the buffer.
-
-        PassRefPtr<ByteArray> getUnmultipliedImageData(const IntRect&) const;
-        PassRefPtr<ByteArray> getPremultipliedImageData(const IntRect&) const;
-
-        void putUnmultipliedImageData(ByteArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint);
-        void putPremultipliedImageData(ByteArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint);
-        
-        String toDataURL(const String& mimeType, const double* quality = 0) const;
-#if !PLATFORM(CG)
-        AffineTransform baseTransform() const { return AffineTransform(); }
-        void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
-        void platformTransformColorSpace(const Vector<int>&);
+class FloatRect;
+class GraphicsContext;
+class GraphicsContext3D;
+class Image;
+class ImageData;
+class IntPoint;
+class IntRect;
+
+enum Multiply {
+    Premultiplied,
+    Unmultiplied
+};
+
+enum BackingStoreCopy {
+    CopyBackingStore, // Guarantee subsequent draws don't affect the copy.
+    DontCopyBackingStore // Subsequent draws may affect the copy.
+};
+
+enum ScaleBehavior {
+    Scaled,
+    Unscaled
+};
+
+class ImageBuffer {
+    WTF_MAKE_NONCOPYABLE(ImageBuffer); WTF_MAKE_FAST_ALLOCATED;
+    friend class IOSurface;
+public:
+    // Will return a null pointer on allocation failure.
+    static std::unique_ptr<ImageBuffer> create(const FloatSize& size, RenderingMode renderingMode, float resolutionScale = 1, ColorSpace colorSpace = ColorSpaceSRGB)
+    {
+        bool success = false;
+        std::unique_ptr<ImageBuffer> buffer(new ImageBuffer(size, resolutionScale, colorSpace, renderingMode, success));
+        if (!success)
+            return nullptr;
+        return buffer;
+    }
+
+    // Create an image buffer compatible with the context, with suitable resolution for drawing into the buffer and then into this context.
+    static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, const GraphicsContext&, bool hasAlpha = true);
+    static std::unique_ptr<ImageBuffer> createCompatibleBuffer(const FloatSize&, float resolutionScale, ColorSpace, const GraphicsContext&, bool hasAlpha);
+
+    static FloatSize compatibleBufferSize(const FloatSize&, const GraphicsContext&);
+    bool isCompatibleWithContext(const GraphicsContext&) const;
+
+    WEBCORE_EXPORT ~ImageBuffer();
+
+    // The actual resolution of the backing store
+    const IntSize& internalSize() const { return m_size; }
+    const IntSize& logicalSize() const { return m_logicalSize; }
+
+    FloatSize sizeForDestinationSize(FloatSize) const;
+
+    float resolutionScale() const { return m_resolutionScale; }
+
+    WEBCORE_EXPORT GraphicsContext& context() const;
+
+    WEBCORE_EXPORT RefPtr<Image> copyImage(BackingStoreCopy = CopyBackingStore, ScaleBehavior = Scaled) const;
+    WEBCORE_EXPORT static RefPtr<Image> sinkIntoImage(std::unique_ptr<ImageBuffer>, ScaleBehavior = Scaled);
+    // Give hints on the faster copyImage Mode, return DontCopyBackingStore if it supports the DontCopyBackingStore behavior
+    // or return CopyBackingStore if it doesn't.  
+    static BackingStoreCopy fastCopyImageMode();
+
+    enum CoordinateSystem { LogicalCoordinateSystem, BackingStoreCoordinateSystem };
+
+    RefPtr<Uint8ClampedArray> getUnmultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
+    RefPtr<Uint8ClampedArray> getPremultipliedImageData(const IntRect&, CoordinateSystem = LogicalCoordinateSystem) const;
+
+    void putByteArray(Multiply multiplied, Uint8ClampedArray*, const IntSize& sourceSize, const IntRect& sourceRect, const IntPoint& destPoint, CoordinateSystem = LogicalCoordinateSystem);
+    
+    void convertToLuminanceMask();
+    
+    String toDataURL(const String& mimeType, const double* quality = 0, CoordinateSystem = LogicalCoordinateSystem) const;
+#if !USE(CG)
+    AffineTransform baseTransform() const { return AffineTransform(); }
+    void transformColorSpace(ColorSpace srcColorSpace, ColorSpace dstColorSpace);
+    void platformTransformColorSpace(const Vector<int>&);
 #else
-        AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, m_size.height()); }
+    AffineTransform baseTransform() const { return AffineTransform(1, 0, 0, -1, 0, m_data.backingStoreSize.height()); }
+#endif
+    PlatformLayer* platformLayer() const;
+
+#if USE(CAIRO)
+    NativeImagePtr nativeImage() const;
 #endif
 
-    private:
-        void clip(GraphicsContext*, const FloatRect&) const;
+    // FIXME: current implementations of this method have the restriction that they only work
+    // with textures that are RGB or RGBA format, and UNSIGNED_BYTE type.
+    bool copyToPlatformTexture(GraphicsContext3D&, GC3Denum, Platform3DObject, GC3Denum, bool, bool);
+
+    // These functions are used when clamping the ImageBuffer which is created for filter, masker or clipper.
+    static bool sizeNeedsClamping(const FloatSize&);
+    static bool sizeNeedsClamping(const FloatSize&, FloatSize& scale);
+    static FloatSize clampedSize(const FloatSize&);
+    static FloatSize clampedSize(const FloatSize&, FloatSize& scale);
+    static FloatRect clampedRect(const FloatRect&);
+
+private:
+#if USE(CG)
+    // The returned image might be larger than the internalSize(). If you want the smaller
+    // image, crop the result.
+    RetainPtr<CGImageRef> copyNativeImage(BackingStoreCopy = CopyBackingStore) const;
+    static RetainPtr<CGImageRef> sinkIntoNativeImage(std::unique_ptr<ImageBuffer>);
+    void flushContext() const;
+#endif
+    
+    void draw(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal);
+    void drawPattern(GraphicsContext&, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, const FloatRect& destRect, BlendMode = BlendModeNormal);
 
-        // The draw method draws the contents of the buffer without copying it.
-        void draw(GraphicsContext*, ColorSpace styleColorSpace, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1),
-                             CompositeOperator = CompositeSourceOver, bool useLowQualityScale = false);
-        void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
-                         const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
-        friend class GraphicsContext;
-        friend class GeneratedImage;
+    static void drawConsuming(std::unique_ptr<ImageBuffer>, GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1), CompositeOperator = CompositeSourceOver, BlendMode = BlendModeNormal);
 
-    private:
-        ImageBufferData m_data;
+    inline void genericConvertToLuminanceMask();
 
-        IntSize m_size;
-        bool m_accelerateRendering;
-        OwnPtr<GraphicsContext> m_context;
+    friend class GraphicsContext;
+    friend class GeneratedImage;
+    friend class CrossfadeGeneratedImage;
+    friend class NamedImageGeneratedImage;
+    friend class GradientImage;
 
-#if !PLATFORM(CG)
-        Vector<int> m_linearRgbLUT;
-        Vector<int> m_deviceRgbLUT;
-#endif
+private:
+    ImageBufferData m_data;
+    IntSize m_size;
+    IntSize m_logicalSize;
+    float m_resolutionScale;
 
-        // This constructor will place its success into the given out-variable
-        // so that create() knows when it should return failure.
-        ImageBuffer(const IntSize&, ColorSpace colorSpace, RenderingMode renderingMode, bool& success);
-    };
+    // This constructor will place its success into the given out-variable
+    // so that create() knows when it should return failure.
+    WEBCORE_EXPORT ImageBuffer(const FloatSize&, float resolutionScale, ColorSpace, RenderingMode, bool& success);
+};
 
-#if PLATFORM(CG) || USE(SKIA)
-    String ImageDataToDataURL(const ImageData& input, const String& mimeType, const double* quality);
+#if USE(CG)
+String ImageDataToDataURL(const ImageData&, const String& mimeType, const double* quality);
 #endif
 
 } // namespace WebCore