blob: 22db709166cb716f4608d55799d473b52485622f [file] [log] [blame]
/*
* Copyright (C) 2010 Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "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 THE COPYRIGHT
* OWNER 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 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef WebImageDecoder_h
#define WebImageDecoder_h
#include "WebCommon.h"
#include "WebImage.h"
#include "WebNonCopyable.h"
namespace WebCore { class ImageDecoder; }
namespace WebKit {
typedef WebCore::ImageDecoder WebImageDecoderPrivate;
class WebData;
class WebImageDecoder : public WebNonCopyable {
public:
enum Type {
TypeBMP,
TypeICO
};
~WebImageDecoder() { reset(); }
explicit WebImageDecoder(Type type) { init(type); }
// Sets data contents for underlying decoder. All the API methods
// require that setData() is called prior to their use.
WEBKIT_API void setData(const WebData& data, bool allDataReceived);
// Deletes owned decoder.
WEBKIT_API void reset();
// Returns true if image decoding failed.
WEBKIT_API bool isFailed() const;
// Returns true if size information is available for the decoder.
WEBKIT_API bool isSizeAvailable() const;
// Returns the size of the image.
WEBKIT_API WebSize size() const;
// Gives frame count for the image. For multiple frames, decoder scans the image data for the count.
WEBKIT_API size_t frameCount() const;
// Returns if the frame at given index is completely decoded.
WEBKIT_API bool isFrameCompleteAtIndex(int index) const;
// Creates and returns WebImage from buffer at the index.
WEBKIT_API WebImage getFrameAtIndex(int index) const;
private:
// Creates type-specific decoder.
WEBKIT_API void init(Type type);
WebImageDecoderPrivate* m_private;
};
} // namespace WebKit
#endif