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 "SkBitmap.h"
30#include "SkSize.h"
31#include "SkTypes.h"
32#include "platform/PlatformExport.h"
33#include "platform/graphics/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/ThreadingPrimitives.h"
39#include "wtf/ThreadSafeRefCounted.h"
40#include "wtf/Vector.h"
41
42namespace blink {
43
44class ImageDecoder;
45class ImagePlanes;
46class SharedBuffer;
47
48class PLATFORM_EXPORT ImageDecoderFactory {
49    WTF_MAKE_NONCOPYABLE(ImageDecoderFactory);
50public:
51    ImageDecoderFactory() {}
52    virtual ~ImageDecoderFactory() { }
53    virtual PassOwnPtr<ImageDecoder> create() = 0;
54};
55
56class PLATFORM_EXPORT ImageFrameGenerator : public ThreadSafeRefCounted<ImageFrameGenerator> {
57    WTF_MAKE_NONCOPYABLE(ImageFrameGenerator);
58public:
59    static PassRefPtr<ImageFrameGenerator> create(const SkISize& fullSize, PassRefPtr<SharedBuffer> data, bool allDataReceived, bool isMultiFrame = false)
60    {
61        return adoptRef(new ImageFrameGenerator(fullSize, data, allDataReceived, isMultiFrame));
62    }
63
64    ImageFrameGenerator(const SkISize& fullSize, PassRefPtr<SharedBuffer>, bool allDataReceived, bool isMultiFrame);
65    ~ImageFrameGenerator();
66
67    // Decodes and scales the specified frame indicated by |index|. Dimensions
68    // and output format are specified in |info|. Decoded pixels are written
69    // into |pixels| with a stride of |rowBytes|.
70    //
71    // Returns true if decoding was successful.
72    bool decodeAndScale(const SkImageInfo&, size_t index, void* pixels, size_t rowBytes);
73
74    // Decodes YUV components directly into the provided memory planes.
75    bool decodeToYUV(SkISize componentSizes[3], void* planes[3], size_t rowBytes[3]);
76
77    void setData(PassRefPtr<SharedBuffer>, bool allDataReceived);
78
79    // Creates a new SharedBuffer containing the data received so far.
80    void copyData(RefPtr<SharedBuffer>*, bool* allDataReceived);
81
82    SkISize getFullSize() const { return m_fullSize; }
83
84    bool isMultiFrame() const { return m_isMultiFrame; }
85
86    // FIXME: Return alpha state for each frame.
87    bool hasAlpha(size_t);
88
89    bool getYUVComponentSizes(SkISize componentSizes[3]);
90
91private:
92    class ExternalMemoryAllocator;
93    friend class ImageFrameGeneratorTest;
94    friend class DeferredImageDecoderTest;
95    // For testing. |factory| will overwrite the default ImageDecoder creation logic if |factory->create()| returns non-zero.
96    void setImageDecoderFactory(PassOwnPtr<ImageDecoderFactory> factory) { m_imageDecoderFactory = factory; }
97
98    void setHasAlpha(size_t index, bool hasAlpha);
99
100    // These methods are called while m_decodeMutex is locked.
101    SkBitmap tryToResumeDecode(const SkISize& scaledSize, size_t index);
102
103    // Use the given decoder to decode. If a decoder is not given then try to create one.
104    // Returns true if decoding was complete.
105    bool decode(size_t index, ImageDecoder**, SkBitmap*);
106
107    SkISize m_fullSize;
108    ThreadSafeDataTransport m_data;
109    bool m_isMultiFrame;
110    bool m_decodeFailedAndEmpty;
111    Vector<bool> m_hasAlpha;
112    int m_decodeCount;
113    OwnPtr<ExternalMemoryAllocator> m_externalAllocator;
114
115    OwnPtr<ImageDecoderFactory> m_imageDecoderFactory;
116
117    // Prevents multiple decode operations on the same data.
118    Mutex m_decodeMutex;
119
120    // Protect concurrent access to m_hasAlpha.
121    Mutex m_alphaMutex;
122};
123
124} // namespace blink
125
126#endif
127