Passing alpha to DeferredImageDecoder once decoding completes
[WebKit-https.git] / Source / WebCore / platform / graphics / chromium / ImageFrameGenerator.h
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 ImageFrameGenerator_h
27 #define ImageFrameGenerator_h
28
29 #include "DiscardablePixelRef.h"
30 #include "SkTypes.h"
31 #include "SkBitmap.h"
32 #include "SkSize.h"
33 #include "ThreadSafeDataTransport.h"
34 #include <wtf/PassOwnPtr.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/ThreadSafeRefCounted.h>
39 #include <wtf/ThreadingPrimitives.h>
40 #include <wtf/Vector.h>
41
42 namespace WebCore {
43
44 class ImageDecoder;
45 class ScaledImageFragment;
46 class SharedBuffer;
47
48 class ImageDecoderFactory {
49 public:
50     virtual ~ImageDecoderFactory() { }
51     virtual PassOwnPtr<ImageDecoder> create() = 0;
52 };
53
54 class ImageFrameGenerator : public ThreadSafeRefCounted<ImageFrameGenerator> {
55 public:
56     static PassRefPtr<ImageFrameGenerator> create(const SkISize& fullSize, PassRefPtr<SharedBuffer> data, bool allDataReceived)
57     {
58         return adoptRef(new ImageFrameGenerator(fullSize, data, allDataReceived));
59     }
60
61     ImageFrameGenerator(const SkISize& fullSize, PassRefPtr<SharedBuffer>, bool allDataReceived);
62     ~ImageFrameGenerator();
63
64     const ScaledImageFragment* decodeAndScale(const SkISize& scaledSize);
65
66     void setData(PassRefPtr<SharedBuffer>, bool allDataReceived);
67
68     void setImageDecoderFactoryForTesting(PassOwnPtr<ImageDecoderFactory> factory) { m_imageDecoderFactory = factory; }
69
70     bool hasAlpha();
71
72 private:
73     // These methods are called while m_decodeMutex is locked.
74     const ScaledImageFragment* tryToLockCompleteCache(const SkISize& scaledSize);
75     const ScaledImageFragment* tryToScale(const ScaledImageFragment* fullSizeImage, const SkISize& scaledSize);
76     const ScaledImageFragment* tryToResumeDecodeAndScale(const SkISize& scaledSize);
77     const ScaledImageFragment* tryToDecodeAndScale(const SkISize& scaledSize);
78
79     // Use the given decoder to decode. If a decoder is not given then try to create one.
80     PassOwnPtr<ScaledImageFragment> decode(ImageDecoder**);
81
82     SkISize m_fullSize;
83     ThreadSafeDataTransport m_data;
84     bool m_decodeFailedAndEmpty;
85     bool m_hasAlpha;
86     DiscardablePixelRefAllocator m_allocator;
87
88     OwnPtr<ImageDecoderFactory> m_imageDecoderFactory;
89
90     // Prevents multiple decode operations on the same data.
91     Mutex m_decodeMutex;
92
93     // Protect concurrent access to m_hasAlpha.
94     Mutex m_alphaMutex;
95 };
96
97 } // namespace WebCore
98
99 #endif