ui/base/resource/lottie_resource.cc

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

#include "ui/base/resource/lottie_resource.h"

#include <memory>
#include <utility>
#include <vector>

#include "base/functional/bind.h"
#include "base/memory/ref_counted_memory.h"
#include "base/notreached.h"
#include "cc/paint/paint_op_buffer.h"
#include "cc/paint/record_paint_canvas.h"
#include "cc/paint/skottie_color_map.h"
#include "cc/paint/skottie_wrapper.h"
#include "skia/buildflags.h"
#include "third_party/skia/include/core/SkColor.h"
#include "ui/base/models/image_model.h"
#include "ui/color/color_id.h"
#include "ui/color/color_provider.h"
#include "ui/gfx/canvas.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/image/image_skia.h"
#include "ui/gfx/image/image_skia_rep.h"
#include "ui/gfx/image/image_skia_source.h"
#include "ui/lottie/animation.h"

namespace ui {

namespace {

#if BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)

// A descendant of |gfx::ImageSkiaSource| that simply uses one
// |gfx::ImageSkiaRep| for all scales.
class LottieImageSource : public gfx::ImageSkiaSource {
 public:
  explicit LottieImageSource(const gfx::ImageSkiaRep& rep) : rep_(rep) {}
  LottieImageSource(const LottieImageSource&) = delete;
  LottieImageSource& operator=(const LottieImageSource&) = delete;
  ~LottieImageSource() override = default;

  // gfx::ImageSkiaSource overrides:
  gfx::ImageSkiaRep GetImageForScale(float scale) override { return rep_; }
  bool HasRepresentationAtAllScales() const override { return true; }

 private:
  gfx::ImageSkiaRep rep_;
};

// Uses |LottieImageSource| to create a |gfx::ImageSkia| from an |Animation|.
gfx::ImageSkia CreateImageSkia(lottie::Animation* content) {
  const gfx::Size size = content->GetOriginalSize();

  cc::InspectableRecordPaintCanvas record_canvas(size);
  gfx::Canvas canvas(&record_canvas, 1.0);
#if DCHECK_IS_ON()
  gfx::Rect clip_rect;
  DCHECK(canvas.GetClipBounds(&clip_rect));
  DCHECK(clip_rect.Contains(gfx::Rect(size)));
#endif
  content->PaintFrame(&canvas, 0.f, size);

  const gfx::ImageSkiaRep rep(record_canvas.ReleaseAsRecord(), size, 0.f);
  return gfx::ImageSkia(std::make_unique<LottieImageSource>(rep),
                        rep.pixel_size());
}

// Creates a |cc::SkottieColorMap| with theme colors from a |ui::ColorProvider|.
cc::SkottieColorMap CreateColorMap(const ui::ColorProvider* color_provider) {
  return {
#if BUILDFLAG(IS_CHROMEOS)
      cc::SkottieMapColor("cros.sys.illo.color1",
                          color_provider->GetColor(ui::kColorNativeColor1)),
      cc::SkottieMapColor(
          "cros.sys.illo.color1.1",
          color_provider->GetColor(ui::kColorNativeColor1Shade1)),
      cc::SkottieMapColor(
          "cros.sys.illo.color1.2",
          color_provider->GetColor(ui::kColorNativeColor1Shade2)),
      cc::SkottieMapColor("cros.sys.illo.color2",
                          color_provider->GetColor(ui::kColorNativeColor2)),
      cc::SkottieMapColor("cros.sys.illo.color3",
                          color_provider->GetColor(ui::kColorNativeColor3)),
      cc::SkottieMapColor("cros.sys.illo.color4",
                          color_provider->GetColor(ui::kColorNativeColor4)),
      cc::SkottieMapColor("cros.sys.illo.color5",
                          color_provider->GetColor(ui::kColorNativeColor5)),
      cc::SkottieMapColor("cros.sys.illo.color6",
                          color_provider->GetColor(ui::kColorNativeColor6)),
      cc::SkottieMapColor("cros.sys.illo.base",
                          color_provider->GetColor(ui::kColorNativeBaseColor)),
      cc::SkottieMapColor(
          "cros.sys.illo.secondary",
          color_provider->GetColor(ui::kColorNativeSecondaryColor)),
      cc::SkottieMapColor(
          "cros.sys.illo.on-primary-container",
          color_provider->GetColor(ui::kColorNativeOnPrimaryContainerColor)),
      cc::SkottieMapColor(
          "cros.sys.illo.analog",
          color_provider->GetColor(ui::kColorNativeAnalogColor)),
      cc::SkottieMapColor("cros.sys.illo.muted",
                          color_provider->GetColor(ui::kColorNativeMutedColor)),
      cc::SkottieMapColor(
          "cros.sys.illo.complement",
          color_provider->GetColor(ui::kColorNativeComplementColor)),
      cc::SkottieMapColor(
          "cros.sys.illo.on-gradient",
          color_provider->GetColor(ui::kColorNativeOnGradientColor)),

      // TODO(b/329334699): Colors below are deprecated and will be removed when
      // the users are cleaned up.
      cc::SkottieMapColor("_CrOS_Color1",
                          color_provider->GetColor(ui::kColorNativeColor1)),
      cc::SkottieMapColor(
          "_CrOS_Color1Shade1",
          color_provider->GetColor(ui::kColorNativeColor1Shade1)),
      cc::SkottieMapColor(
          "_CrOS_Color1Shade2",
          color_provider->GetColor(ui::kColorNativeColor1Shade2)),
      cc::SkottieMapColor("_CrOS_Color2",
                          color_provider->GetColor(ui::kColorNativeColor2)),
      cc::SkottieMapColor("_CrOS_Color3",
                          color_provider->GetColor(ui::kColorNativeColor3)),
      cc::SkottieMapColor("_CrOS_Color4",
                          color_provider->GetColor(ui::kColorNativeColor4)),
      cc::SkottieMapColor("_CrOS_Color5",
                          color_provider->GetColor(ui::kColorNativeColor5)),
      cc::SkottieMapColor("_CrOS_Color6",
                          color_provider->GetColor(ui::kColorNativeColor6)),
      cc::SkottieMapColor("_CrOS_BaseColor",
                          color_provider->GetColor(ui::kColorNativeBaseColor)),
      cc::SkottieMapColor(
          "_CrOS_SecondaryColor",
          color_provider->GetColor(ui::kColorNativeSecondaryColor)),
#endif
      cc::SkottieMapColor(
          "cdds.sys.color.illo-primary-min",
          color_provider->GetColor(ui::kColorSysIlloPrimaryMin)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-primary-low",
          color_provider->GetColor(ui::kColorSysIlloPrimaryLow)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-primary-mid",
          color_provider->GetColor(ui::kColorSysIlloPrimaryMid)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-primary-high",
          color_provider->GetColor(ui::kColorSysIlloPrimaryHigh)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-primary-max",
          color_provider->GetColor(ui::kColorSysIlloPrimaryMax)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-secondary-min",
          color_provider->GetColor(ui::kColorSysIlloSecondaryMin)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-secondary-low",
          color_provider->GetColor(ui::kColorSysIlloSecondaryLow)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-secondary-mid",
          color_provider->GetColor(ui::kColorSysIlloSecondaryMid)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-secondary-high",
          color_provider->GetColor(ui::kColorSysIlloSecondaryHigh)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-secondary-max",
          color_provider->GetColor(ui::kColorSysIlloSecondaryMax)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-tertiary-min",
          color_provider->GetColor(ui::kColorSysIlloTertiaryMin)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-tertiary-low",
          color_provider->GetColor(ui::kColorSysIlloTertiaryLow)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-tertiary-mid",
          color_provider->GetColor(ui::kColorSysIlloTertiaryMid)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-tertiary-high",
          color_provider->GetColor(ui::kColorSysIlloTertiaryHigh)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-tertiary-max",
          color_provider->GetColor(ui::kColorSysIlloTertiaryMax)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-neutral-min",
          color_provider->GetColor(ui::kColorSysIlloNeutralMin)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-neutral-low",
          color_provider->GetColor(ui::kColorSysIlloNeutralLow)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-neutral-mid",
          color_provider->GetColor(ui::kColorSysIlloNeutralMid)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-neutral-high",
          color_provider->GetColor(ui::kColorSysIlloNeutralHigh)),
      cc::SkottieMapColor(
          "cdds.sys.color.illo-neutral-max",
          color_provider->GetColor(ui::kColorSysIlloNeutralMax)),
      cc::SkottieMapColor("cdds.sys.color.error",
                          color_provider->GetColor(ui::kColorSysError)),
      cc::SkottieMapColor(
          "cdds.sys.color.error-container",
          color_provider->GetColor(ui::kColorSysErrorContainer))};
}

// Used for a |ui::ImageModel::ImageGenerator|.
gfx::ImageSkia CreateImageSkiaWithCurrentTheme(
    std::vector<uint8_t> bytes,
    const ui::ColorProvider* color_provider) {
  auto content = std::make_unique<lottie::Animation>(
      cc::SkottieWrapper::UnsafeCreateSerializable(std::move(bytes)),
      CreateColorMap(color_provider));
  return CreateImageSkia(content.get());
}

#endif  // BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)

}  // namespace

gfx::ImageSkia ParseLottieAsStillImage(std::vector<uint8_t> data) {
#if BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)
  auto content = std::make_unique<lottie::Animation>(
      cc::SkottieWrapper::UnsafeCreateSerializable(std::move(data)));
  return CreateImageSkia(content.get());
#else
  NOTREACHED();
#endif  // BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)
}

ui::ImageModel ParseLottieAsThemedStillImage(std::vector<uint8_t> data) {
#if BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)
  const gfx::Size size = std::make_unique<lottie::Animation>(
                             cc::SkottieWrapper::UnsafeCreateSerializable(data))
                             ->GetOriginalSize();
  return ui::ImageModel::FromImageGenerator(
      base::BindRepeating(&CreateImageSkiaWithCurrentTheme, std::move(data)),
      size);
#else
  NOTREACHED();
#endif  // BUILDFLAG(SKIA_SUPPORT_SKOTTIE) && BUILDFLAG(USE_BLINK)
}

}  // namespace ui