flutter::AndroidImageGenerator Class Reference

#include <android_image_generator.h>

Inheritance diagram for flutter::AndroidImageGenerator:

Public Member Functions
	~AndroidImageGenerator ()
const SkImageInfo &	GetInfo () override
	Returns basic information about the contents of the encoded image. This information can almost always be collected by just interpreting the header of a decoded image. More...
unsigned int	GetFrameCount () const override
	Get the number of frames that the encoded image stores. This method is always expected to be called before GetFrameInfo, as the underlying image decoder may interpret frame information that is then used when calling GetFrameInfo. More...
unsigned int	GetPlayCount () const override
	The number of times an animated image should play through before playback stops. More...
const ImageGenerator::FrameInfo	GetFrameInfo (unsigned int frame_index) override
	Get information about a single frame in the context of a multi-frame image, useful for animation and frame blending. This method should only ever be called after GetFrameCount has been called. This information is nonsensical for single-frame images. More...
SkISize	GetScaledDimensions (float desired_scale) override
	Given a scale value, find the closest image size that can be used for efficiently decoding the image. If subpixel image decoding is not supported by the decoder, this method should just return the original image size. More...
bool	GetPixels (const SkImageInfo &info, void *pixels, size_t row_bytes, unsigned int frame_index, std::optional< unsigned int > prior_frame) override
	Decode the image into a given buffer. This method is currently always used for sub-pixel image decoding. For full-sized still images, GetImage is always attempted first. More...
void	DecodeImage ()
Public Member Functions inherited from flutter::ImageGenerator
virtual	~ImageGenerator ()
virtual const SkImageInfo &	GetInfo ()=0
	Returns basic information about the contents of the encoded image. This information can almost always be collected by just interpreting the header of a decoded image. More...
virtual unsigned int	GetFrameCount () const =0
	Get the number of frames that the encoded image stores. This method is always expected to be called before GetFrameInfo, as the underlying image decoder may interpret frame information that is then used when calling GetFrameInfo. More...
virtual unsigned int	GetPlayCount () const =0
	The number of times an animated image should play through before playback stops. More...
virtual const FrameInfo	GetFrameInfo (unsigned int frame_index)=0
	Get information about a single frame in the context of a multi-frame image, useful for animation and frame blending. This method should only ever be called after GetFrameCount has been called. This information is nonsensical for single-frame images. More...
virtual SkISize	GetScaledDimensions (float scale)=0
	Given a scale value, find the closest image size that can be used for efficiently decoding the image. If subpixel image decoding is not supported by the decoder, this method should just return the original image size. More...
virtual bool	GetPixels (const SkImageInfo &info, void *pixels, size_t row_bytes, unsigned int frame_index=0, std::optional< unsigned int > prior_frame=std::nullopt)=0
	Decode the image into a given buffer. This method is currently always used for sub-pixel image decoding. For full-sized still images, GetImage is always attempted first. More...
sk_sp< SkImage >	GetImage ()
	Creates an SkImage based on the current ImageInfo of this ImageGenerator. More...

Static Public Member Functions
static bool	Register (JNIEnv *env)
static std::shared_ptr< ImageGenerator >	MakeFromData (sk_sp< SkData > data, const fml::RefPtr< fml::TaskRunner > &task_runner)
static void	NativeImageHeaderCallback (JNIEnv *env, jclass jcaller, jlong generator_pointer, int width, int height)

Additional Inherited Members
Static Public Attributes inherited from flutter::ImageGenerator
static const unsigned int	kInfinitePlayCount
	Frame count value to denote infinite looping. More...

Detailed Description

Definition at line 17 of file android_image_generator.h.

Constructor & Destructor Documentation

~AndroidImageGenerator()

flutter::AndroidImageGenerator::~AndroidImageGenerator ( )

default

Member Function Documentation

DecodeImage()

void flutter::AndroidImageGenerator::DecodeImage

(

)

Definition at line 87 of file android_image_generator.cc.

                                        {
  DoDecodeImage();
 
  header_decoded_latch_.Signal();
  fully_decoded_latch_.Signal();
}

GetFrameCount()

unsigned int flutter::AndroidImageGenerator::GetFrameCount ( ) const

overridevirtual

Get the number of frames that the encoded image stores. This method is always expected to be called before GetFrameInfo, as the underlying image decoder may interpret frame information that is then used when calling GetFrameInfo.

Returns

The number of frames that the encoded image stores. This will always be 1 for single-frame images.

Implements flutter::ImageGenerator.

Definition at line 32 of file android_image_generator.cc.

                                                        {
  return 1;
}

GetFrameInfo()

const ImageGenerator::FrameInfo flutter::AndroidImageGenerator::GetFrameInfo ( unsigned int  frame_index )

overridevirtual

Get information about a single frame in the context of a multi-frame image, useful for animation and frame blending. This method should only ever be called after GetFrameCount has been called. This information is nonsensical for single-frame images.

Parameters

[in]

frame_index

The index of the frame to get information about.

Returns

Information about the given frame. If the image is single-frame, a default result is returned.

See also

GetFrameCount

Implements flutter::ImageGenerator.

Definition at line 40 of file android_image_generator.cc.

                              {
  return {.required_frame = std::nullopt,
          .duration = 0,
          .disposal_method = SkCodecAnimation::DisposalMethod::kKeep};
}

GetInfo()

const SkImageInfo & flutter::AndroidImageGenerator::GetInfo ( )

overridevirtual

Returns basic information about the contents of the encoded image. This information can almost always be collected by just interpreting the header of a decoded image.

Returns

Size and color information describing the image.

Note

This method is executed on the UI thread and used for layout purposes by the framework, and so this method should not perform long synchronous tasks.

Implements flutter::ImageGenerator.

Definition at line 27 of file android_image_generator.cc.

                                                  {
  header_decoded_latch_.Wait();
  return image_info_;
}

GetPixels()

bool flutter::AndroidImageGenerator::GetPixels ( const SkImageInfo &  info, void *  pixels, size_t  row_bytes, unsigned int  frame_index, std::optional< unsigned int >  prior_frame  )

overridevirtual

Decode the image into a given buffer. This method is currently always used for sub-pixel image decoding. For full-sized still images, GetImage is always attempted first.

Parameters

[in]	info	The desired size and color info of the decoded image to be returned. The implementation of GetScaledDimensions determines which sizes are supported by the image decoder.
[in]	pixels	The location where the raw decoded image data should be written.
[in]	row_bytes	The total number of bytes that should make up a single row of decoded image data (i.e. width * bytes_per_pixel).
[in]	frame_index	Which frame to decode. This is only useful for multi-frame images.
[in]	prior_frame	Optional frame index parameter for multi-frame images which specifies the previous frame that should be use for blending. This hints to the decoder that it should use a previously cached frame instead of decoding dependency frame(s). If an empty value is supplied, the decoder should decode any necessary frames first.

Returns

True if the image was successfully decoded.

Note

This method performs potentially long synchronous work, and so it should never be executed on the UI thread. Image decoders do not require GPU acceleration, and so threads without a GPU context may also be used.

See also

GetScaledDimensions

Implements flutter::ImageGenerator.

Definition at line 51 of file android_image_generator.cc.

                                                                             {
  fully_decoded_latch_.Wait();
 
  if (!software_decoded_data_) {
    return false;
  }
 
  if (kRGBA_8888_SkColorType != info.colorType()) {
    return false;
  }
 
  switch (info.alphaType()) {
    case kOpaque_SkAlphaType:
      if (kOpaque_SkAlphaType != GetInfo().alphaType()) {
        return false;
      }
      break;
    case kPremul_SkAlphaType:
      break;
    default:
      return false;
  }
 
  // TODO(bdero): Override `GetImage()` to use `SkImage::FromAHardwareBuffer` on
  // API level 30+ once it's updated to do symbol lookups and not get
  // preprocessed out in Skia. This will allow for avoiding this copy in
  // cases where the result image doesn't need to be resized.
  memcpy(pixels, software_decoded_data_->data(),
         software_decoded_data_->size());
  return true;
}

GetPlayCount()

unsigned int flutter::AndroidImageGenerator::GetPlayCount ( ) const

overridevirtual

The number of times an animated image should play through before playback stops.

Returns

If this image is animated, the number of times the animation should play through is returned, otherwise it'll just return 1. If the animation should loop forever, kInfinitePlayCount is returned.

Implements flutter::ImageGenerator.

Definition at line 36 of file android_image_generator.cc.

                                                       {
  return 1;
}

GetScaledDimensions()

SkISize flutter::AndroidImageGenerator::GetScaledDimensions ( float  scale )

overridevirtual

Given a scale value, find the closest image size that can be used for efficiently decoding the image. If subpixel image decoding is not supported by the decoder, this method should just return the original image size.

Parameters

[in]

scale

The desired scale factor of the image for decoding.

Returns

The closest image size that can be used for efficiently decoding the image.

Note

This method is called prior to GetPixels in order to query for supported sizes.

See also

GetPixels

Implements flutter::ImageGenerator.

Definition at line 47 of file android_image_generator.cc.

                                                                      {
  return GetInfo().dimensions();
}

MakeFromData()

std::shared_ptr< ImageGenerator > flutter::AndroidImageGenerator::MakeFromData ( sk_sp< SkData >  data, const fml::RefPtr< fml::TaskRunner > &  task_runner  )

static

Definition at line 175 of file android_image_generator.cc.

                                                 {
  std::shared_ptr<AndroidImageGenerator> generator(
      new AndroidImageGenerator(std::move(data)));
 
  fml::TaskRunner::RunNowOrPostTask(
      task_runner, [generator]() { generator->DecodeImage(); });
 
  if (generator->IsValidImageData()) {
    return generator;
  }
 
  return nullptr;
}

NativeImageHeaderCallback()

void flutter::AndroidImageGenerator::NativeImageHeaderCallback ( JNIEnv *  env, jclass  jcaller, jlong  generator_pointer, int  width, int  height  )

static

Definition at line 191 of file android_image_generator.cc.

                                                                  {
  AndroidImageGenerator* generator =
      reinterpret_cast<AndroidImageGenerator*>(generator_address);
 
  generator->image_info_ = SkImageInfo::Make(
      width, height, kRGBA_8888_SkColorType, kPremul_SkAlphaType);
  generator->header_decoded_latch_.Signal();
}

Register()

bool flutter::AndroidImageGenerator::Register ( JNIEnv *  env )

static

Definition at line 149 of file android_image_generator.cc.

                                                {
  g_flutter_jni_class = new fml::jni::ScopedJavaGlobalRef<jclass>(
      env, env->FindClass("io/flutter/embedding/engine/FlutterJNI"));
  FML_DCHECK(!g_flutter_jni_class->is_null());
 
  g_decode_image_method = env->GetStaticMethodID(
      g_flutter_jni_class->obj(), "decodeImage",
      "(Ljava/nio/ByteBuffer;J)Landroid/graphics/Bitmap;");
  FML_DCHECK(g_decode_image_method);
 
  static const JNINativeMethod header_decoded_method = {
      .name = "nativeImageHeaderCallback",
      .signature = "(JII)V",
      .fnPtr = reinterpret_cast<void*>(
          &AndroidImageGenerator::NativeImageHeaderCallback),
  };
  if (env->RegisterNatives(g_flutter_jni_class->obj(), &header_decoded_method,
                           1) != 0) {
    FML_LOG(ERROR)
        << "Failed to register FlutterJNI.nativeImageHeaderCallback method";
    return false;
  }
 
  return true;
}

---

The documentation for this class was generated from the following files:

• shell/platform/android/android_image_generator.h
• shell/platform/android/android_image_generator.cc