blob: db3342745f50370047ceae5e5e0959a157807b0c [file] [log] [blame]
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include <vector>
#include "cc/paint/frame_metadata.h"
#include "cc/paint/paint_export.h"
#include "cc/paint/paint_image.h"
#include "third_party/skia/include/core/SkData.h"
#include "third_party/skia/include/core/SkImageInfo.h"
#include "third_party/skia/include/core/SkSize.h"
#include "third_party/skia/include/core/SkYUVAIndex.h"
#include "third_party/skia/include/core/SkYUVASizeInfo.h"
namespace cc {
// PaintImage Generator is a wrapper to provide a lazily decoded PaintImage to
// the compositor.
// Note that the implementation of this class must ensure thread safety, it can
// be called from any thread.
class CC_PAINT_EXPORT PaintImageGenerator : public SkRefCnt {
PaintImageGenerator(const PaintImageGenerator&) = delete;
~PaintImageGenerator() override;
PaintImageGenerator& operator=(const PaintImageGenerator&) = delete;
// Returns a reference to the encoded content of this image.
virtual sk_sp<SkData> GetEncodedData() const = 0;
// Decode into the given pixels, a block of memory of size at least
// (info.fHeight - 1) * rowBytes + (info.fWidth * bytesPerPixel). |info|
// represents the desired output format. Returns true on success.
// TODO(khushalsagar): |lazy_pixel_ref| is only present for
// DecodingImageGenerator tracing needs. Remove it.
virtual bool GetPixels(const SkImageInfo& info,
void* pixels,
size_t row_bytes,
size_t frame_index,
PaintImage::GeneratorClientId client_id,
uint32_t lazy_pixel_ref) = 0;
// Returns true if the generator supports YUV decoding, providing the output
// information in |info| and |color_space|.
virtual bool QueryYUVA8(SkYUVASizeInfo* info,
SkYUVAIndex indices[SkYUVAIndex::kIndexCount],
SkYUVColorSpace* color_space) const = 0;
// Decodes to YUV into the provided |planes| for each of the Y, U, and V
// planes, and returns true on success. The method should only be used if
// QueryYUVA8 returns true.
// |info| and |indices| need to exactly match the values returned by the
// query, except the info.fWidthBytes may be larger than the recommendation
// (but not smaller).
// TODO(khushalsagar): |lazy_pixel_ref| is only present for
// DecodingImageGenerator tracing needs. Remove it.
virtual bool GetYUVA8Planes(
const SkYUVASizeInfo& info,
const SkYUVAIndex indices[SkYUVAIndex::kIndexCount],
void* planes[3],
size_t frame_index,
uint32_t lazy_pixel_ref) = 0;
// Returns the smallest size that is at least as big as the requested size,
// such that we can decode to exactly that scale.
virtual SkISize GetSupportedDecodeSize(const SkISize& requested_size) const;
// Returns the content id to key the decoded output produced by this
// generator for a frame at |frame_index|. The generator promises that
// the output for repeated calls to decode a frame will be consistent across
// all generators for a PaintImage, if this function returns the same id.
virtual PaintImage::ContentId GetContentIdForFrame(size_t frame_index) const;
const SkImageInfo& GetSkImageInfo() const { return info_; }
const std::vector<FrameMetadata>& GetFrameMetadata() const { return frames_; }
// |info| is the info for this paint image generator.
PaintImageGenerator(const SkImageInfo& info,
std::vector<FrameMetadata> frames = {FrameMetadata()});
const SkImageInfo info_;
const PaintImage::ContentId generator_content_id_;
const std::vector<FrameMetadata> frames_;
} // namespace cc