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 "../platform/WebCommon.h"
35#include "../platform/WebImage.h"
36#include "../platform/WebNonCopyable.h"
37
38namespace blink {
39
40class ImageDecoder;
41class WebData;
42typedef ImageDecoder WebImageDecoderPrivate;
43
44class WebImageDecoder : public WebNonCopyable {
45public:
46    enum Type {
47        TypeBMP,
48        TypeICO
49    };
50
51    ~WebImageDecoder() { reset(); }
52
53    explicit WebImageDecoder(Type type) { init(type); }
54
55    // Sets data contents for underlying decoder. All the API methods
56    // require that setData() is called prior to their use.
57    BLINK_EXPORT void setData(const WebData& data, bool allDataReceived);
58
59    // Deletes owned decoder.
60    BLINK_EXPORT void reset();
61
62    // Returns true if image decoding failed.
63    BLINK_EXPORT bool isFailed() const;
64
65    // Returns true if size information is available for the decoder.
66    BLINK_EXPORT bool isSizeAvailable() const;
67
68    // Returns the size of the image.
69    BLINK_EXPORT WebSize size() const;
70
71    // Gives frame count for the image. For multiple frames, decoder scans the image data for the count.
72    BLINK_EXPORT size_t frameCount() const;
73
74    // Returns if the frame at given index is completely decoded.
75    BLINK_EXPORT bool isFrameCompleteAtIndex(int index) const;
76
77    // Creates and returns WebImage from buffer at the index.
78    BLINK_EXPORT WebImage getFrameAtIndex(int index) const;
79
80private:
81    // Creates type-specific decoder.
82    BLINK_EXPORT void init(Type type);
83
84    WebImageDecoderPrivate* m_private;
85};
86
87} // namespace blink
88
89#endif
90