1/*
2 * Copyright (C) 2012 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
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef DeferredImageDecoder_h
27#define DeferredImageDecoder_h
28
29#include "SkBitmap.h"
30#include "SkPixelRef.h"
31#include "platform/PlatformExport.h"
32#include "platform/geometry/IntSize.h"
33#include "platform/graphics/ImageFrameGenerator.h"
34#include "platform/graphics/ImageSource.h"
35#include "platform/image-decoders/ImageDecoder.h"
36#include "wtf/Forward.h"
37#include "wtf/OwnPtr.h"
38#include "wtf/Vector.h"
39
40namespace blink {
41
42class ImageFrameGenerator;
43class SharedBuffer;
44
45class PLATFORM_EXPORT DeferredImageDecoder {
46    WTF_MAKE_NONCOPYABLE(DeferredImageDecoder);
47public:
48    ~DeferredImageDecoder();
49    static PassOwnPtr<DeferredImageDecoder> create(const SharedBuffer& data, ImageSource::AlphaOption, ImageSource::GammaAndColorProfileOption);
50
51    static PassOwnPtr<DeferredImageDecoder> createForTesting(PassOwnPtr<ImageDecoder>);
52
53    static bool isLazyDecoded(const SkBitmap&);
54
55    static void setEnabled(bool);
56    static bool enabled();
57
58    String filenameExtension() const;
59
60    ImageFrame* frameBufferAtIndex(size_t index);
61
62    void setData(SharedBuffer& data, bool allDataReceived);
63
64    bool isSizeAvailable();
65    bool hasColorProfile() const;
66    IntSize size() const;
67    IntSize frameSizeAtIndex(size_t index) const;
68    size_t frameCount();
69    int repetitionCount() const;
70    size_t clearCacheExceptFrame(size_t);
71    bool frameHasAlphaAtIndex(size_t index) const;
72    bool frameIsCompleteAtIndex(size_t) const;
73    float frameDurationAtIndex(size_t) const;
74    unsigned frameBytesAtIndex(size_t index) const;
75    ImageOrientation orientation() const;
76    bool hotSpot(IntPoint&) const;
77
78    // For testing.
79    ImageFrameGenerator* frameGenerator() { return m_frameGenerator.get(); }
80
81private:
82    explicit DeferredImageDecoder(PassOwnPtr<ImageDecoder> actualDecoder);
83    void prepareLazyDecodedFrames();
84    SkBitmap createBitmap(size_t index);
85    void activateLazyDecoding();
86
87    RefPtr<SharedBuffer> m_data;
88    bool m_allDataReceived;
89    unsigned m_lastDataSize;
90    bool m_dataChanged;
91    OwnPtr<ImageDecoder> m_actualDecoder;
92
93    String m_filenameExtension;
94    IntSize m_size;
95    ImageOrientation m_orientation;
96    int m_repetitionCount;
97    bool m_hasColorProfile;
98
99    Vector<OwnPtr<ImageFrame> > m_lazyDecodedFrames;
100    RefPtr<ImageFrameGenerator> m_frameGenerator;
101
102    static bool s_enabled;
103};
104
105} // namespace blink
106
107#endif
108