1 /* 2 * Copyright (C) 2010 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebImageDecoder_h 32 #define WebImageDecoder_h 33 34 #include "WebCommon.h" 35 #include "WebImage.h" 36 #include "WebNonCopyable.h" 37 38 namespace WebCore { class ImageDecoder; } 39 40 namespace WebKit { 41 42 typedef WebCore::ImageDecoder WebImageDecoderPrivate; 43 class WebData; 44 45 class WebImageDecoder : public WebNonCopyable { 46 public: 47 enum Type { 48 TypeBMP, 49 TypeICO 50 }; 51 ~WebImageDecoder()52 ~WebImageDecoder() { reset(); } 53 WebImageDecoder(Type type)54 explicit WebImageDecoder(Type type) { init(type); } 55 56 // Sets data contents for underlying decoder. All the API methods 57 // require that setData() is called prior to their use. 58 WEBKIT_API void setData(const WebData& data, bool allDataReceived); 59 60 // Deletes owned decoder. 61 WEBKIT_API void reset(); 62 63 // Returns true if image decoding failed. 64 WEBKIT_API bool isFailed() const; 65 66 // Returns true if size information is available for the decoder. 67 WEBKIT_API bool isSizeAvailable() const; 68 69 // Returns the size of the image. 70 WEBKIT_API WebSize size() const; 71 72 // Gives frame count for the image. For multiple frames, decoder scans the image data for the count. 73 WEBKIT_API size_t frameCount() const; 74 75 // Returns if the frame at given index is completely decoded. 76 WEBKIT_API bool isFrameCompleteAtIndex(int index) const; 77 78 // Creates and returns WebImage from buffer at the index. 79 WEBKIT_API WebImage getFrameAtIndex(int index) const; 80 81 private: 82 // Creates type-specific decoder. 83 WEBKIT_API void init(Type type); 84 85 WebImageDecoderPrivate* m_private; 86 }; 87 88 } // namespace WebKit 89 90 #endif 91