third_party/WebKit/Source/platform/graphics/DeferredImageDecoder.h

/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DeferredImageDecoder_h
#define DeferredImageDecoder_h

#include "platform/PlatformExport.h"
#include "platform/geometry/IntSize.h"
#include "platform/image-decoders/ImageDecoder.h"
#include "third_party/skia/include/core/SkRWBuffer.h"
#include "third_party/skia/include/core/SkRefCnt.h"
#include "wtf/Allocator.h"
#include "wtf/Forward.h"
#include "wtf/Vector.h"
#include <memory>

class SkImage;

namespace blink {

class ImageFrameGenerator;
class SharedBuffer;
struct DeferredFrameData;

class PLATFORM_EXPORT DeferredImageDecoder final {
  WTF_MAKE_NONCOPYABLE(DeferredImageDecoder);
  USING_FAST_MALLOC(DeferredImageDecoder);

 public:
  static std::unique_ptr<DeferredImageDecoder> create(
      PassRefPtr<SharedBuffer> data,
      bool dataComplete,
      ImageDecoder::AlphaOption,
      ImageDecoder::ColorSpaceOption);

  static std::unique_ptr<DeferredImageDecoder> createForTesting(
      std::unique_ptr<ImageDecoder>);

  ~DeferredImageDecoder();

  String filenameExtension() const;

  sk_sp<SkImage> createFrameAtIndex(size_t);

  PassRefPtr<SharedBuffer> data();
  void setData(PassRefPtr<SharedBuffer> data, bool allDataReceived);

  bool isSizeAvailable();
  bool hasEmbeddedColorSpace() const;
  IntSize size() const;
  IntSize frameSizeAtIndex(size_t index) const;
  size_t frameCount();
  int repetitionCount() const;
  size_t clearCacheExceptFrame(size_t index);
  bool frameHasAlphaAtIndex(size_t index) const;
  bool frameIsCompleteAtIndex(size_t index) const;
  float frameDurationAtIndex(size_t index) const;
  size_t frameBytesAtIndex(size_t index) const;
  ImageOrientation orientationAtIndex(size_t index) const;
  bool hotSpot(IntPoint&) const;

 private:
  explicit DeferredImageDecoder(std::unique_ptr<ImageDecoder> actualDecoder);

  friend class DeferredImageDecoderTest;
  ImageFrameGenerator* frameGenerator() { return m_frameGenerator.get(); }

  void activateLazyDecoding();
  void prepareLazyDecodedFrames();

  sk_sp<SkImage> createFrameImageAtIndex(size_t index, bool knownToBeOpaque);

  void setDataInternal(PassRefPtr<SharedBuffer> data,
                       bool allDataReceived,
                       bool pushDataToDecoder);

  // Copy of the data that is passed in, used by deferred decoding.
  // Allows creating readonly snapshots that may be read in another thread.
  std::unique_ptr<SkRWBuffer> m_rwBuffer;
  bool m_allDataReceived;
  std::unique_ptr<ImageDecoder> m_actualDecoder;

  String m_filenameExtension;
  IntSize m_size;
  int m_repetitionCount;
  bool m_hasEmbeddedColorSpace = false;
  bool m_canYUVDecode;
  bool m_hasHotSpot;
  IntPoint m_hotSpot;

  // Caches frame state information.
  Vector<DeferredFrameData> m_frameData;
  RefPtr<ImageFrameGenerator> m_frameGenerator;
};

}  // namespace blink

#endif