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 "platform/PlatformExport.h"
31#include "platform/geometry/IntSize.h"
32#include "platform/graphics/ImageFrameGenerator.h"
33#include "platform/graphics/ImageSource.h"
34#include "platform/image-decoders/ImageDecoder.h"
35#include "wtf/Forward.h"
36#include "wtf/OwnPtr.h"
37#include "wtf/Vector.h"
38
39namespace WebCore {
40
41class ImageFrameGenerator;
42class SharedBuffer;
43
44class PLATFORM_EXPORT DeferredImageDecoder {
45    WTF_MAKE_NONCOPYABLE(DeferredImageDecoder);
46public:
47    ~DeferredImageDecoder();
48    static PassOwnPtr<DeferredImageDecoder> create(const SharedBuffer& data, ImageSource::AlphaOption, ImageSource::GammaAndColorProfileOption);
49
50    static PassOwnPtr<DeferredImageDecoder> createForTesting(PassOwnPtr<ImageDecoder>);
51
52    static bool isLazyDecoded(const SkBitmap&);
53
54    static void setEnabled(bool);
55
56    String filenameExtension() const;
57
58    ImageFrame* frameBufferAtIndex(size_t index);
59
60    void setData(SharedBuffer* data, bool allDataReceived);
61
62    bool isSizeAvailable();
63    IntSize size() const;
64    IntSize frameSizeAtIndex(size_t index) const;
65    size_t frameCount();
66    int repetitionCount() const;
67    size_t clearCacheExceptFrame(size_t);
68    bool frameHasAlphaAtIndex(size_t index) const;
69    bool frameIsCompleteAtIndex(size_t) const;
70    float frameDurationAtIndex(size_t) const;
71    unsigned frameBytesAtIndex(size_t index) const;
72    ImageOrientation orientation() const;
73    bool hotSpot(IntPoint&) const;
74
75    // For testing.
76    ImageFrameGenerator* frameGenerator() { return m_frameGenerator.get(); }
77
78private:
79    explicit DeferredImageDecoder(PassOwnPtr<ImageDecoder> actualDecoder);
80    void prepareLazyDecodedFrames();
81    SkBitmap createBitmap(size_t index);
82    SkBitmap createSkiaDiscardableBitmap(size_t index);
83    SkBitmap createLazyDecodingBitmap(size_t index);
84    void activateLazyDecoding();
85    void setData(PassRefPtr<SharedBuffer>, bool allDataReceived);
86
87    RefPtr<SharedBuffer> m_data;
88    bool m_allDataReceived;
89    OwnPtr<ImageDecoder> m_actualDecoder;
90
91    String m_filenameExtension;
92    IntSize m_size;
93    ImageOrientation m_orientation;
94    int m_repetitionCount;
95
96    Vector<OwnPtr<ImageFrame> > m_lazyDecodedFrames;
97    RefPtr<ImageFrameGenerator> m_frameGenerator;
98
99    static bool s_enabled;
100    static bool s_skiaDiscardableMemoryEnabled;
101};
102
103} // namespace WebCore
104
105#endif
106