// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "cc/paint/paint_image.h"

#include <memory>
#include <sstream>
#include <utility>

#include "base/atomic_sequence_num.h"
#include "base/hash/hash.h"
#include "base/logging.h"
#include "base/types/optional_util.h"
#include "cc/paint/paint_image_builder.h"
#include "cc/paint/paint_image_generator.h"
#include "cc/paint/paint_record.h"
#include "cc/paint/skia_paint_image_generator.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "third_party/skia/include/core/SkCPURecorder.h"
#include "third_party/skia/include/core/SkColorSpace.h"
#include "third_party/skia/include/core/SkImage.h"
#include "third_party/skia/include/core/SkImageInfo.h"
#include "third_party/skia/include/core/SkPixmap.h"
#include "third_party/skia/include/core/SkRefCnt.h"
#include "third_party/skia/include/core/SkSize.h"
#include "third_party/skia/include/core/SkYUVAPixmaps.h"
#include "third_party/skia/include/gpu/ganesh/GrBackendSurface.h"
#include "ui/gfx/geometry/skia_conversions.h"

namespace cc {
namespace {
base::AtomicSequenceNumber g_next_image_id;
base::AtomicSequenceNumber g_next_image_content_id;
base::AtomicSequenceNumber g_next_generator_client_id;
}  // namespace

const PaintImage::Id PaintImage::kNonLazyStableId = -1;
const size_t PaintImage::kDefaultFrameIndex = 0u;
const PaintImage::Id PaintImage::kInvalidId = -2;
const PaintImage::ContentId PaintImage::kInvalidContentId = -1;
const PaintImage::GeneratorClientId PaintImage::kDefaultGeneratorClientId = 0;

ImageHeaderMetadata::ImageHeaderMetadata() = default;
ImageHeaderMetadata::ImageHeaderMetadata(const ImageHeaderMetadata& other) =
    default;
ImageHeaderMetadata& ImageHeaderMetadata::operator=(
    const ImageHeaderMetadata& other) = default;
ImageHeaderMetadata::ImageHeaderMetadata::~ImageHeaderMetadata() = default;

PaintImage::PaintImage() = default;
PaintImage::PaintImage(const PaintImage& other) = default;
PaintImage::PaintImage(PaintImage&& other) = default;
PaintImage::~PaintImage() = default;

PaintImage& PaintImage::operator=(const PaintImage& other) = default;
PaintImage& PaintImage::operator=(PaintImage&& other) = default;

bool PaintImage::IsSameForTesting(const PaintImage& other) const {
  return sk_image_ == other.sk_image_ &&
         !!paint_record_ == !!other.paint_record_ &&
         (!paint_record_ ||
          &paint_record_->GetFirstOp() == &other.paint_record_->GetFirstOp()) &&
         paint_record_rect_ == other.paint_record_rect_ &&
         content_id_ == other.content_id_ &&
         paint_image_generator_ == other.paint_image_generator_ &&
         id_ == other.id_ && animation_type_ == other.animation_type_ &&
         completion_state_ == other.completion_state_ &&
         is_multipart_ == other.is_multipart_ &&
         texture_backing_ == other.texture_backing_ &&
         deferred_paint_record_ == other.deferred_paint_record_;
  // Do not check may_be_lcp_candidate_ as it should not affect any rendering
  // operation, only metrics collection.
}

// static
PaintImage::DecodingMode PaintImage::GetConservative(DecodingMode one,
                                                     DecodingMode two) {
  if (one == two)
    return one;
  if (one == DecodingMode::kSync || two == DecodingMode::kSync)
    return DecodingMode::kSync;
  if (one == DecodingMode::kUnspecified || two == DecodingMode::kUnspecified)
    return DecodingMode::kUnspecified;
  DCHECK_EQ(one, DecodingMode::kAsync);
  DCHECK_EQ(two, DecodingMode::kAsync);
  return DecodingMode::kAsync;
}

// static
PaintImage::Id PaintImage::GetNextId() {
  return g_next_image_id.GetNext();
}

// static
PaintImage::ContentId PaintImage::GetNextContentId() {
  return g_next_image_content_id.GetNext();
}

// static
PaintImage::GeneratorClientId PaintImage::GetNextGeneratorClientId() {
  // These IDs must start from 1, since 0 is the kDefaultGeneratorClientId.
  return g_next_generator_client_id.GetNext() + 1;
}

// static
PaintImage PaintImage::CreateFromBitmap(SkBitmap bitmap) {
  if (bitmap.drawsNothing())
    return PaintImage();

  return PaintImageBuilder::WithDefault()
      .set_id(PaintImage::GetNextId())
      .set_image(SkImages::RasterFromBitmap(bitmap),
                 PaintImage::GetNextContentId())
      .TakePaintImage();
}

const sk_sp<SkImage>& PaintImage::GetSkImage() const {
  return cached_sk_image_;
}

sk_sp<SkImage> PaintImage::GetSwSkImage() const {
  if (texture_backing_) {
    auto image = texture_backing_->GetSkImageViaReadback();
    if (image && reinterpret_as_srgb_) {
      image = image->reinterpretColorSpace(SkColorSpace::MakeSRGB());
    }
    return image;
  } else if (cached_sk_image_ && cached_sk_image_->isTextureBacked()) {
    return cached_sk_image_->makeNonTextureImage();
  }
  return cached_sk_image_;
}

sk_sp<SkImage> PaintImage::GetAcceleratedSkImage() const {
  DCHECK(!cached_sk_image_ || cached_sk_image_->isTextureBacked());
  return cached_sk_image_;
}

bool PaintImage::readPixels(const SkImageInfo& dst_info,
                            void* dst_pixels,
                            size_t dst_row_bytes,
                            int src_x,
                            int src_y) const {
  if (texture_backing_) {
    auto dst_info_adjusted = dst_info;
    if (reinterpret_as_srgb_) {
      // To reinterpret the read pixels as sRGB, set `dst_info_adjusted`'s
      // color space to match the texture's space. This only works when the
      // caller expects sRGB pixels.
      CHECK(!dst_info.colorSpace() ||
            SkColorSpace::Equals(dst_info.colorSpace(),
                                 SkColorSpace::MakeSRGB().get()));
      dst_info_adjusted = dst_info.makeColorSpace(
          texture_backing_->GetSkImageInfo().refColorSpace());
    }
    return texture_backing_->readPixels(dst_info_adjusted, dst_pixels,
                                        dst_row_bytes, src_x, src_y);
  } else if (cached_sk_image_) {
    return cached_sk_image_->readPixels(dst_info, dst_pixels, dst_row_bytes,
                                        src_x, src_y);
  }
  return false;
}

SkImageInfo PaintImage::GetSkImageInfo(AuxImage aux_image) const {
  switch (aux_image) {
    case AuxImage::kDefault:
      if (paint_image_generator_) {
        const auto info = paint_image_generator_->GetSkImageInfo();
        return reinterpret_as_srgb_
                   ? info.makeColorSpace(SkColorSpace::MakeSRGB())
                   : info;
      } else if (texture_backing_) {
        const auto info = texture_backing_->GetSkImageInfo();
        return reinterpret_as_srgb_
                   ? info.makeColorSpace(SkColorSpace::MakeSRGB())
                   : info;
      } else if (cached_sk_image_) {
        return cached_sk_image_->imageInfo();
      } else if (deferred_paint_record_) {
        auto size = deferred_paint_record_->GetSize();
        return SkImageInfo::MakeUnknown(base::ClampCeil(size.width()),
                                        base::ClampCeil(size.height()));
      }
      return SkImageInfo::MakeUnknown();
    case AuxImage::kGainmap:
      DCHECK(gainmap_paint_image_generator_);
      return gainmap_paint_image_generator_->GetSkImageInfo();
  }
}

gpu::Mailbox PaintImage::GetMailbox() const {
  DCHECK(texture_backing_);
  return texture_backing_->GetMailbox();
}

const scoped_refptr<PaintWorkletInput> PaintImage::GetPaintWorkletInput()
    const {
  if (!IsPaintWorklet()) {
    return nullptr;
  }
  scoped_refptr<PaintWorkletInput> paint_worklet_input(
      static_cast<PaintWorkletInput*>(deferred_paint_record().get()));
  return paint_worklet_input;
}

bool PaintImage::IsOpaque() const {
  if (IsPaintWorklet())
    return deferred_paint_record_->KnownToBeOpaque();
  return GetSkImageInfo().isOpaque();
}

void PaintImage::CreateSkImage() {
  DCHECK(!cached_sk_image_);

  if (sk_image_) {
    cached_sk_image_ = sk_image_;
  } else if (paint_record_) {
    cached_sk_image_ = SkImages::DeferredFromPicture(
        paint_record_->ToSkPicture(gfx::RectToSkRect(paint_record_rect_)),
        SkISize::Make(paint_record_rect_.width(), paint_record_rect_.height()),
        nullptr, nullptr, SkImages::BitDepth::kU8, SkColorSpace::MakeSRGB());
  } else if (paint_image_generator_) {
    cached_sk_image_ = SkImages::DeferredFromGenerator(
        std::make_unique<SkiaPaintImageGenerator>(paint_image_generator_,
                                                  kDefaultFrameIndex,
                                                  kDefaultGeneratorClientId));
  }
}

SkISize PaintImage::GetSupportedDecodeSize(const SkISize& requested_size,
                                           AuxImage aux_image) const {
  switch (aux_image) {
    case AuxImage::kDefault:
      if (paint_image_generator_) {
        return paint_image_generator_->GetSupportedDecodeSize(requested_size);
      }
      return SkISize::Make(width(), height());
    case AuxImage::kGainmap:
      if (gainmap_paint_image_generator_) {
        return gainmap_paint_image_generator_->GetSupportedDecodeSize(
            requested_size);
      }
      // Note that this is different from the default image behavior.
      return SkISize(0, 0);
  }
}

bool PaintImage::Decode(SkPixmap pixmap,
                        size_t frame_index,
                        AuxImage aux_image,
                        GeneratorClientId client_id) const {
  // We only support decode to supported decode size.
  DCHECK(pixmap.dimensions() ==
         GetSupportedDecodeSize(pixmap.dimensions(), aux_image));
  switch (aux_image) {
    case AuxImage::kDefault:
      if (reinterpret_as_srgb_) {
        // To reinterpret the generated pixels as sRGB, set `pixmap`'s color
        // space to match the generator's space. This only works when the
        // caller expects sRGB pixels.
        CHECK(!pixmap.colorSpace() ||
              SkColorSpace::Equals(pixmap.colorSpace(),
                                   SkColorSpace::MakeSRGB().get()));
        pixmap.setColorSpace(
            paint_image_generator_->GetSkImageInfo().refColorSpace());
      }
      if (paint_image_generator_) {
        return paint_image_generator_->GetPixels(pixmap, frame_index, client_id,
                                                 stable_id());
      }
      return DecodeFromSkImage(pixmap, frame_index, client_id);
    case AuxImage::kGainmap:
      DCHECK(gainmap_paint_image_generator_);
      return gainmap_paint_image_generator_->GetPixels(pixmap, frame_index,
                                                       client_id, stable_id());
  }
}

bool PaintImage::DecodeYuv(const SkYUVAPixmaps& pixmaps,
                           size_t frame_index,
                           AuxImage aux_image,
                           GeneratorClientId client_id) const {
  // This function assumes that the color space being applied to `pixmaps`
  // is the same color space returned by `GetSkImageInfo()`.
  DCHECK(pixmaps.isValid());
  const uint32_t lazy_pixel_ref = stable_id();
  switch (aux_image) {
    case AuxImage::kDefault:
      DCHECK(paint_image_generator_);
      return paint_image_generator_->GetYUVAPlanes(pixmaps, frame_index,
                                                   lazy_pixel_ref, client_id);
    case AuxImage::kGainmap:
      DCHECK(gainmap_paint_image_generator_);
      return gainmap_paint_image_generator_->GetYUVAPlanes(
          pixmaps, frame_index, lazy_pixel_ref, client_id);
  }
}

bool PaintImage::DecodeFromSkImage(SkPixmap pixmap,
                                   size_t frame_index,
                                   GeneratorClientId client_id) const {
  sk_sp<SkColorSpace> color_space = pixmap.refColorSpace();
  auto image = GetSkImageForFrame(frame_index, client_id);
  DCHECK(image);
  if (color_space) {
    image = image->makeColorSpace(skcpu::Recorder::TODO(), color_space, {});
    if (!image)
      return false;
  }
  return image->readPixels(pixmap, 0, 0, SkImage::kDisallow_CachingHint);
}

bool PaintImage::ShouldAnimate() const {
  return animation_type_ == AnimationType::kAnimated &&
         repetition_count_ != kAnimationNone && FrameCount() > 1;
}

PaintImage::FrameKey PaintImage::GetKeyForFrame(size_t frame_index) const {
  DCHECK_LT(frame_index, FrameCount());

  return FrameKey(GetContentIdForFrame(frame_index), frame_index);
}

PaintImage::ContentId PaintImage::GetContentIdForFrame(
    size_t frame_index) const {
  if (paint_image_generator_)
    return paint_image_generator_->GetContentIdForFrame(frame_index);

  DCHECK_NE(content_id_, kInvalidContentId);
  return content_id_;
}

bool PaintImage::IsTextureBacked() const {
  if (texture_backing_)
    return true;
  if (cached_sk_image_)
    return cached_sk_image_->isTextureBacked();
  return false;
}

gfx::Size PaintImage::GetSize(AuxImage aux_image) const {
  return gfx::SkISizeToSize(GetSkISize(aux_image));
}

gfx::ContentColorUsage PaintImage::GetContentColorUsage() const {
  // Right now, JS paint worklets can only be in sRGB
  if (IsPaintWorklet()) {
    return gfx::ContentColorUsage::kSRGB;
  }

  // Gainmap images are always HDR.
  if (HasGainmapInfo()) {
    return gfx::ContentColorUsage::kHDR;
  }

  const auto* color_space = GetSkImageInfo().colorSpace();

  // Assume the image will be sRGB if we don't know yet.
  if (!color_space || color_space->isSRGB()) {
    return gfx::ContentColorUsage::kSRGB;
  }

  skcms_TransferFunction fn;
  color_space->transferFn(&fn);
  if (skcms_TransferFunction_isPQish(&fn) ||
      skcms_TransferFunction_isHLGish(&fn) ||
      skcms_TransferFunction_isPQ(&fn) || skcms_TransferFunction_isHLG(&fn)) {
    return gfx::ContentColorUsage::kHDR;
  }

  // If it's not HDR and not SRGB, report it as WCG.
  return gfx::ContentColorUsage::kWideColorGamut;
}

const ImageHeaderMetadata* PaintImage::GetImageHeaderMetadata() const {
  if (paint_image_generator_)
    return paint_image_generator_->GetMetadataForDecodeAcceleration();
  return nullptr;
}

bool PaintImage::IsYuv(
    const SkYUVAPixmapInfo::SupportedDataTypes& supported_data_types,
    AuxImage aux_image,
    SkYUVAPixmapInfo* info) const {
  SkYUVAPixmapInfo temp_info;
  if (!info)
    info = &temp_info;

  // ImageDecoder will fill out the SkYUVColorSpace in |info| depending on the
  // codec's specification.
  switch (aux_image) {
    case AuxImage::kDefault:
      return paint_image_generator_ &&
             paint_image_generator_->QueryYUVA(supported_data_types, info);
    case AuxImage::kGainmap:
      return gainmap_paint_image_generator_ &&
             gainmap_paint_image_generator_->QueryYUVA(supported_data_types,
                                                       info);
  }
}

bool PaintImage::NeedsLayer() const {
  return IsPaintWorklet() && deferred_paint_record_->NeedsLayer();
}

const std::vector<FrameMetadata>& PaintImage::GetFrameMetadata() const {
  DCHECK_EQ(animation_type_, AnimationType::kAnimated);
  DCHECK(paint_image_generator_);

  return paint_image_generator_->GetFrameMetadata();
}

size_t PaintImage::FrameCount() const {
  if (!*this)
    return 0u;
  return paint_image_generator_
             ? paint_image_generator_->GetFrameMetadata().size()
             : 1u;
}

sk_sp<SkImage> PaintImage::GetSkImageForFrame(
    size_t index,
    GeneratorClientId client_id) const {
  DCHECK_LT(index, FrameCount());
  DCHECK(!IsTextureBacked());

  // |client_id| and |index| are only relevant for generator backed images which
  // perform lazy decoding and can be multi-frame.
  if (!paint_image_generator_) {
    DCHECK_EQ(index, kDefaultFrameIndex);
    return GetSwSkImage();
  }

  // The internally cached SkImage is constructed using the default frame index
  // and GeneratorClientId. Avoid creating a new SkImage.
  if (index == kDefaultFrameIndex && client_id == kDefaultGeneratorClientId)
    return GetSwSkImage();

  sk_sp<SkImage> image =
      SkImages::DeferredFromGenerator(std::make_unique<SkiaPaintImageGenerator>(
          paint_image_generator_, index, client_id));
  if (image && reinterpret_as_srgb_) {
    image = image->reinterpretColorSpace(SkColorSpace::MakeSRGB());
  }
  return image;
}

std::string PaintImage::ToString() const {
  std::ostringstream str;
  str << "sk_image_: " << sk_image_
      << " paint_record_: " << base::OptionalToPtr(paint_record_)
      << " paint_record_rect_: " << paint_record_rect_.ToString()
      << " paint_image_generator_: " << paint_image_generator_
      << " id_: " << id_
      << " animation_type_: " << static_cast<int>(animation_type_)
      << " completion_state_: " << static_cast<int>(completion_state_)
      << " is_multipart_: " << is_multipart_
      << " may_be_lcp_candidate_: " << may_be_lcp_candidate_
      << " has gainmap: " << HasGainmapInfo() << " is YUV: "
      << IsYuv(SkYUVAPixmapInfo::SupportedDataTypes::All(), AuxImage::kDefault);
  return str.str();
}

PaintImage::FrameKey::FrameKey(ContentId content_id, size_t frame_index)
    : content_id_(content_id), frame_index_(frame_index) {
  hash_ = base::HashInts(static_cast<uint64_t>(content_id_),
                         static_cast<uint64_t>(frame_index_));
}

bool PaintImage::FrameKey::operator==(const FrameKey& other) const {
  return content_id_ == other.content_id_ && frame_index_ == other.frame_index_;
}

bool PaintImage::FrameKey::operator!=(const FrameKey& other) const {
  return !(*this == other);
}

std::string PaintImage::FrameKey::ToString() const {
  std::ostringstream str;
  str << "content_id: " << content_id_ << ","
      << "frame_index: " << frame_index_;
  return str.str();
}

}  // namespace cc