Clean up image subsampling code, make it less iOS-specific
[WebKit-https.git] / Source / WebCore / platform / graphics / ImageSource.cpp
1 /*
2  * Copyright (C) 2006 Apple Inc.  All rights reserved.
3  * Copyright (C) 2007 Alp Toker <alp.toker@collabora.co.uk>
4  * Copyright (C) 2008, Google Inc. All rights reserved.
5  * Copyright (C) 2007-2009 Torch Mobile, Inc
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
20  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
23  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
24  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "ImageSource.h"
31
32 #if !USE(CG)
33
34 #include "ImageDecoder.h"
35
36 #include "ImageOrientation.h"
37 #include "NotImplemented.h"
38
39 namespace WebCore {
40
41 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
42 unsigned ImageSource::s_maxPixelsPerDecodedImage = 1024 * 1024;
43 #endif
44
45 ImageSource::ImageSource(ImageSource::AlphaOption alphaOption, ImageSource::GammaAndColorProfileOption gammaAndColorProfileOption)
46     : m_decoder(0)
47     , m_alphaOption(alphaOption)
48     , m_gammaAndColorProfileOption(gammaAndColorProfileOption)
49 {
50 }
51
52 ImageSource::~ImageSource()
53 {
54     clear(true);
55 }
56
57 void ImageSource::clear(bool destroyAll, size_t clearBeforeFrame, SharedBuffer* data, bool allDataReceived)
58 {
59     if (!destroyAll) {
60         if (m_decoder)
61             m_decoder->clearFrameBufferCache(clearBeforeFrame);
62         return;
63     }
64
65     delete m_decoder;
66     m_decoder = 0;
67     if (data)
68         setData(data, allDataReceived);
69 }
70
71 bool ImageSource::initialized() const
72 {
73     return m_decoder;
74 }
75
76 void ImageSource::setData(SharedBuffer* data, bool allDataReceived)
77 {
78     // Make the decoder by sniffing the bytes.
79     // This method will examine the data and instantiate an instance of the appropriate decoder plugin.
80     // If insufficient bytes are available to determine the image type, no decoder plugin will be
81     // made.
82     if (!m_decoder) {
83         m_decoder = static_cast<NativeImageDecoderPtr>(NativeImageDecoder::create(*data, m_alphaOption, m_gammaAndColorProfileOption));
84 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
85         if (m_decoder && s_maxPixelsPerDecodedImage)
86             m_decoder->setMaxNumPixels(s_maxPixelsPerDecodedImage);
87 #endif
88     }
89
90     if (m_decoder)
91         m_decoder->setData(data, allDataReceived);
92 }
93
94 String ImageSource::filenameExtension() const
95 {
96     return m_decoder ? m_decoder->filenameExtension() : String();
97 }
98
99 SubsamplingLevel ImageSource::subsamplingLevelForScale(float) const
100 {
101     return 0;
102 }
103
104 bool ImageSource::allowSubsamplingOfFrameAtIndex(size_t) const
105 {
106     return false;
107 }
108
109 bool ImageSource::isSizeAvailable()
110 {
111     return m_decoder && m_decoder->isSizeAvailable();
112 }
113
114 IntSize ImageSource::size(ImageOrientationDescription description) const
115 {
116     return frameSizeAtIndex(0, 0, description);
117 }
118
119 IntSize ImageSource::frameSizeAtIndex(size_t index, SubsamplingLevel, ImageOrientationDescription description) const
120 {
121     if (!m_decoder)
122         return IntSize();
123
124     IntSize size = m_decoder->frameSizeAtIndex(index);
125     if ((description.respectImageOrientation() == RespectImageOrientation) && m_decoder->orientation().usesWidthAsHeight())
126         return IntSize(size.height(), size.width());
127
128     return size;
129 }
130
131 bool ImageSource::getHotSpot(IntPoint& hotSpot) const
132 {
133     return m_decoder ? m_decoder->hotSpot(hotSpot) : false;
134 }
135
136 size_t ImageSource::bytesDecodedToDetermineProperties() const
137 {
138     return 0;
139 }
140
141 int ImageSource::repetitionCount()
142 {
143     return m_decoder ? m_decoder->repetitionCount() : cAnimationNone;
144 }
145
146 size_t ImageSource::frameCount() const
147 {
148     return m_decoder ? m_decoder->frameCount() : 0;
149 }
150
151 PassNativeImagePtr ImageSource::createFrameAtIndex(size_t index, SubsamplingLevel)
152 {
153     if (!m_decoder)
154         return 0;
155
156     ImageFrame* buffer = m_decoder->frameBufferAtIndex(index);
157     if (!buffer || buffer->status() == ImageFrame::FrameEmpty)
158         return 0;
159
160     // Zero-height images can cause problems for some ports.  If we have an
161     // empty image dimension, just bail.
162     if (size().isEmpty())
163         return 0;
164
165     // Return the buffer contents as a native image.  For some ports, the data
166     // is already in a native container, and this just increments its refcount.
167     return buffer->asNewNativeImage();
168 }
169
170 float ImageSource::frameDurationAtIndex(size_t index)
171 {
172     if (!m_decoder)
173         return 0;
174
175     ImageFrame* buffer = m_decoder->frameBufferAtIndex(index);
176     if (!buffer || buffer->status() == ImageFrame::FrameEmpty)
177         return 0;
178
179     // Many annoying ads specify a 0 duration to make an image flash as quickly as possible.
180     // We follow Firefox's behavior and use a duration of 100 ms for any frames that specify
181     // a duration of <= 10 ms. See <rdar://problem/7689300> and <http://webkit.org/b/36082>
182     // for more information.
183     const float duration = buffer->duration() / 1000.0f;
184     if (duration < 0.011f)
185         return 0.100f;
186     return duration;
187 }
188
189 ImageOrientation ImageSource::orientationAtIndex(size_t) const
190 {
191     return m_decoder ? m_decoder->orientation() : DefaultImageOrientation;
192 }
193
194 bool ImageSource::frameHasAlphaAtIndex(size_t index)
195 {
196     if (!m_decoder)
197         return true;
198     return m_decoder->frameHasAlphaAtIndex(index);
199 }
200
201 bool ImageSource::frameIsCompleteAtIndex(size_t index)
202 {
203     if (!m_decoder)
204         return false;
205
206     ImageFrame* buffer = m_decoder->frameBufferAtIndex(index);
207     return buffer && buffer->status() == ImageFrame::FrameComplete;
208 }
209
210 unsigned ImageSource::frameBytesAtIndex(size_t index, SubsamplingLevel) const
211 {
212     if (!m_decoder)
213         return 0;
214     return m_decoder->frameBytesAtIndex(index);
215 }
216
217 }
218
219 #endif // USE(CG)