react-native-fast-image 8.8.0 → 8.9.0

package/README.md

@@ -173,6 +173,19 @@ For views that get reused for other content, such as rows in FlashList or recycl
 
 ---
 
+### `loop?: boolean | number`
+
+How many times an animated image (GIF, animated WebP) plays:
+
+- Not set **(Default)** - As many times as the file says (like a browser).
+- `true` - Loop forever.
+- `false` - Play once.
+- A number - Play that many times.
+
+Changing it restarts the animation.
+
+---
+
 ### `onLoadStart?: () => void`
 
 Called when the image starts to load.
@@ -243,11 +256,17 @@ FastImage.preload([
 ])
 ```
 
-It resolves when all the images have loaded or failed, with a result for each source, in order: `{ uri, ok, width, height, error }`. `width` and `height` are the image's size (as in `onLoad`), which is also a way to find an image's size without showing it. A few sources load at a time (3, or `SDWebImagePrefetcher`'s `maxConcurrentPrefetchCount` on iOS), so a long list doesn't hold up the images the app is showing, and at low priority unless the source sets `priority`. It never rejects:
+It resolves when all the images have loaded or failed, with a result for each source, in order: `{ uri, ok: true, width, height }` if it loaded, or `{ uri, ok: false, error }` if it didn't (checking `ok` narrows the type in TypeScript). `width` and `height` are the image's size (as in `onLoad`), which is also a way to find an image's size without showing it. A few sources load at a time (3, or `SDWebImagePrefetcher`'s `maxConcurrentPrefetchCount` on iOS), so a long list doesn't hold up the images the app is showing, and at low priority unless the source sets `priority`. It never rejects:
 
 ```js
 const results = await FastImage.preload(sources)
-const failed = results.filter((result) => !result.ok)
+for (const result of results) {
+    if (result.ok) {
+        console.log(result.uri, result.width, result.height)
+    } else {
+        console.warn(result.uri, result.error)
+    }
+}
 ```
 
 ### `FastImage.clearMemoryCache: () => Promise<void>`

package/android/src/main/java/com/dylanvann/fastimage/FastImageGif.java

@@ -0,0 +1,73 @@
+package com.dylanvann.fastimage;
+
+import android.content.Context;
+import android.graphics.Bitmap;
+
+import androidx.annotation.Nullable;
+
+import com.bumptech.glide.Glide;
+import com.bumptech.glide.gifdecoder.GifDecoder;
+import com.bumptech.glide.gifdecoder.GifHeader;
+import com.bumptech.glide.gifdecoder.GifHeaderParser;
+import com.bumptech.glide.gifdecoder.StandardGifDecoder;
+import com.bumptech.glide.load.Transformation;
+import com.bumptech.glide.load.engine.Resource;
+import com.bumptech.glide.load.engine.bitmap_recycle.BitmapPool;
+import com.bumptech.glide.load.resource.UnitTransformation;
+import com.bumptech.glide.load.resource.bitmap.BitmapResource;
+import com.bumptech.glide.load.resource.gif.GifBitmapProvider;
+import com.bumptech.glide.load.resource.gif.GifDrawable;
+
+import java.nio.ByteBuffer;
+
+// Gives a view its own animation of a GIF. Glide gives every view that shows
+// the same GIF (same url and size) a GifDrawable over one frame loader (it's
+// in the cached drawable's constant state), so they animate as one: a view
+// whose GIF stopped (the `loop` prop) keeps drawing another view's frames, and
+// restarting one throws while another view plays it. A copy has its own
+// decoder and frame loader over the same data, so each view animates on its
+// own, as with React Native's Image and on iOS. Decoded like Glide's
+// ByteBufferGifDecoder does, at the size the image was loaded at, and cropped
+// or fitted with the same transformation.
+final class FastImageGif {
+    private FastImageGif() {}
+
+    // Null if the GIF can't be decoded again (then the view shows Glide's).
+    @Nullable
+    static GifDrawable copy(Context context, GifDrawable gif, int width, int height) {
+        if (width <= 0 || height <= 0) return null;
+        ByteBuffer data = gif.getBuffer();
+        GifHeader header = new GifHeaderParser().setData(data).parseHeader();
+        if (header.getNumFrames() <= 0 || header.getStatus() != GifDecoder.STATUS_OK) return null;
+        Glide glide = Glide.get(context);
+        BitmapPool bitmapPool = glide.getBitmapPool();
+        GifDecoder decoder = new StandardGifDecoder(
+                new GifBitmapProvider(bitmapPool, glide.getArrayPool()),
+                header, gif.getBuffer(), sampleSize(header, width, height));
+        decoder.setDefaultBitmapConfig(Bitmap.Config.ARGB_8888);
+        decoder.advance();
+        Bitmap firstFrame = decoder.getNextFrame();
+        if (firstFrame == null) {
+            decoder.clear();
+            return null;
+        }
+        GifDrawable copy = new GifDrawable(
+                context, decoder, UnitTransformation.<Bitmap>get(), width, height, firstFrame);
+        Transformation<Bitmap> transformation = gif.getFrameTransformation();
+        if (transformation != null && !(transformation instanceof UnitTransformation)) {
+            // As GifDrawableTransformation does.
+            Resource<Bitmap> frame = new BitmapResource(firstFrame, bitmapPool);
+            Resource<Bitmap> transformed = transformation.transform(context, frame, width, height);
+            if (!frame.equals(transformed)) frame.recycle();
+            copy.setFrameTransformation(transformation, transformed.get());
+        }
+        return copy;
+    }
+
+    // ByteBufferGifDecoder's.
+    private static int sampleSize(GifHeader header, int width, int height) {
+        int exact = Math.min(header.getHeight() / height, header.getWidth() / width);
+        int powerOfTwo = exact == 0 ? 0 : Integer.highestOneBit(exact);
+        return Math.max(1, powerOfTwo);
+    }
+}

package/android/src/main/java/com/dylanvann/fastimage/FastImageRequestListener.java

@@ -54,9 +54,9 @@ public class FastImageRequestListener implements RequestListener<Drawable> {
         final FastImageViewWithUrl view = (FastImageViewWithUrl) ((ImageViewTarget) target).getView();
         view.onImageLoaded();
         if (resource instanceof GifDrawable) {
-            // Play the GIF as many times as the file says, as iOS does. Glide
+            // The `loop` prop, or the file's own loop count as on iOS. Glide
             // loops every GIF forever by default (#651).
-            ((GifDrawable) resource).setLoopCount(GifDrawable.LOOP_INTRINSIC);
+            view.applyLoopCount((GifDrawable) resource);
         }
         if (!events) return false;
         boolean local = !(model instanceof GlideUrl);

package/android/src/main/java/com/dylanvann/fastimage/FastImageViewManager.java

@@ -89,6 +89,11 @@ class FastImageViewManager extends SimpleViewManager<FastImageViewWithUrl> imple
         view.setRecyclingKey(recyclingKey);
     }
 
+    @ReactProp(name = "loopCount", defaultInt = -1)
+    public void setLoopCount(FastImageViewWithUrl view, int loopCount) {
+        view.setLoopCount(loopCount);
+    }
+
     @ReactProp(name = "resizeMode")
     public void setResizeMode(FastImageViewWithUrl view, String resizeMode) {
         final FastImageViewWithUrl.ScaleType scaleType = FastImageViewConverter.getScaleType(resizeMode);

package/android/src/main/java/com/dylanvann/fastimage/FastImageViewWithUrl.java

@@ -7,6 +7,7 @@ import android.annotation.SuppressLint;
 import android.content.Context;
 import android.graphics.drawable.Drawable;
 
+import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.appcompat.widget.AppCompatImageView;
 import androidx.core.view.ViewCompat;
@@ -14,9 +15,11 @@ import androidx.core.view.ViewCompat;
 import com.bumptech.glide.RequestBuilder;
 import com.bumptech.glide.RequestManager;
 import com.bumptech.glide.load.model.GlideUrl;
+import com.bumptech.glide.load.resource.gif.GifDrawable;
 import com.bumptech.glide.request.Request;
 import com.bumptech.glide.request.target.DrawableImageViewTarget;
 import com.bumptech.glide.request.target.SizeReadyCallback;
+import com.bumptech.glide.request.transition.Transition;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.bridge.WritableNativeMap;
@@ -61,6 +64,68 @@ class FastImageViewWithUrl extends AppCompatImageView {
         if (!ViewCompat.isLaidOut(this)) layout(0, 0, 0, 0);
     }
 
+    // How many times GIFs play: -1 for the file's own loop count (the `loop`
+    // prop not set), 0 for forever, or a number of times.
+    private int mLoopCount = -1;
+
+    public void setLoopCount(int loopCount) {
+        if (loopCount == mLoopCount) return;
+        mLoopCount = loopCount;
+        // Apply it to the GIF that's showing, and play it again. Only this
+        // view's own animation: restarting one Glide shares throws while
+        // another view plays it.
+        if (mOwnGif != null && getDrawable() == mOwnGif) {
+            applyLoopCount(mOwnGif);
+            mOwnGif.stop();
+            mOwnGif.startFromFirstFrame();
+        }
+    }
+
+    // The GIF this view shows as its own animation (FastImageGif), recycled
+    // when the view stops showing it.
+    @Nullable
+    private GifDrawable mOwnGif;
+
+    // Shows each GIF as this view's own animation. Glide's target also starts
+    // and stops it with the Activity, as it does Glide's own GifDrawable.
+    private final class OwnGifTarget extends DrawableImageViewTarget {
+        OwnGifTarget() {
+            super(FastImageViewWithUrl.this);
+        }
+
+        @Override
+        public void onResourceReady(@NonNull Drawable resource, @Nullable Transition<? super Drawable> transition) {
+            if (resource instanceof GifDrawable) {
+                GifDrawable own = FastImageGif.copy(
+                        getContext(), (GifDrawable) resource, mLoadingWidth, mLoadingHeight);
+                if (own != null) {
+                    applyLoopCount(own);
+                    super.onResourceReady(own, transition);
+                    mOwnGif = own;
+                    return;
+                }
+            }
+            super.onResourceReady(resource, transition);
+        }
+
+        @Override
+        protected void setResource(@Nullable Drawable resource) {
+            super.setResource(resource);
+            // Not shown anymore (replaced, cleared or failed): free its frames.
+            if (mOwnGif != null && mOwnGif != resource) {
+                mOwnGif.stop();
+                mOwnGif.recycle();
+                mOwnGif = null;
+            }
+        }
+    }
+
+    void applyLoopCount(GifDrawable gif) {
+        gif.setLoopCount(mLoopCount == -1 ? GifDrawable.LOOP_INTRINSIC
+                : mLoopCount == 0 ? GifDrawable.LOOP_FOREVER
+                : mLoopCount);
+    }
+
     // Glide crops or fits the bitmap for the scale type when it loads, so a
     // new resizeMode needs a reload to take effect (#762).
     public void setResizeMode(ScaleType scaleType) {
@@ -179,7 +244,7 @@ class FastImageViewWithUrl extends AppCompatImageView {
         mLoadingRequest = request;
         mLoadingWidth = 0;
         mLoadingHeight = 0;
-        DrawableImageViewTarget target = new DrawableImageViewTarget(this);
+        OwnGifTarget target = new OwnGifTarget();
         target.getSize(new SizeReadyCallback() {
             @Override
             public void onSizeReady(int width, int height) {

package/dist/index.cjs.js

@@ -63,11 +63,17 @@ function tintColorFromStyle(style) {
 	}
 	return style && typeof style === "object" ? style.tintColor : void 0;
 }
+function loopCount(loop) {
+	if (loop === void 0) return -1;
+	if (loop === true) return 0;
+	if (loop === false) return 1;
+	return Number.isFinite(loop) ? Math.max(1, Math.floor(loop)) : 0;
+}
 function withoutCache(source) {
 	const { cache: _cache, ...rest } = source || {};
 	return rest;
 }
-function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgress, onLoad, onError, onLoadEnd, style, fallback, children, resizeMode = "cover", forwardedRef, onLayout, pointerEvents, ...viewProps }) {
+function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgress, onLoad, onError, onLoadEnd, style, fallback, children, resizeMode = "cover", loop, forwardedRef, onLayout, pointerEvents, ...viewProps }) {
 	const { onClick, ...props } = viewProps;
 	const wrapperProps = {
 		onLayout,
@@ -108,6 +114,7 @@ function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgre
 	}, /* @__PURE__ */ react.default.createElement(FastImageView, {
 		...imageProps,
 		tintColor: resolvedTintColor,
+		loopCount: loopCount(loop),
 		style: react_native.StyleSheet.absoluteFill,
 		source: resolvedSource,
 		defaultSource: resolvedDefaultSource,
@@ -125,18 +132,29 @@ const FastImageComponent = (0, react.forwardRef)((props, ref) => /* @__PURE__ */
 	...props
 }));
 FastImageComponent.displayName = "FastImage";
+const noResult = {
+	ok: false,
+	error: "No result"
+};
 const FastImage = FastImageComponent;
 FastImage.resizeMode = resizeMode;
 FastImage.cacheControl = cacheControl;
 FastImage.priority = priority;
 FastImage.preload = (sources) => Promise.resolve(react_native.NativeModules.FastImageView.preload(sources.map((s) => s || {}))).then((results) => sources.map((source, i) => {
 	var _results$i;
-	return {
-		uri: source ? source.uri : void 0,
-		...(_results$i = results === null || results === void 0 ? void 0 : results[i]) !== null && _results$i !== void 0 ? _results$i : {
-			ok: false,
-			error: "No result"
-		}
+	const uri = source ? source.uri : void 0;
+	const result = (_results$i = results === null || results === void 0 ? void 0 : results[i]) !== null && _results$i !== void 0 ? _results$i : noResult;
+	if (!result.ok) return {
+		...result,
+		uri
+	};
+	return typeof uri === "string" ? {
+		...result,
+		uri
+	} : {
+		ok: false,
+		error: "Invalid source: no uri",
+		uri
 	};
 }));
 FastImage.clearMemoryCache = () => react_native.NativeModules.FastImageView.clearMemoryCache();

package/dist/index.cjs.js.flow

@@ -43,14 +43,21 @@ export type ResizeModes = $Values<ResizeMode>
 export type Priorities = $Values<Priority>
 export type CacheControls = $Values<CacheControl>
 
-export type PreloadResult = {|
+export type PreloadSuccess = {|
+    uri: string,
+    ok: true,
+    width: number,
+    height: number,
+|}
+
+export type PreloadFailure = {|
     uri?: string,
-    ok: boolean,
-    width?: number,
-    height?: number,
-    error?: string,
+    ok: false,
+    error: string,
 |}
 
+export type PreloadResult = PreloadSuccess | PreloadFailure
+
 export type PreloadFn = (
     sources: Array<FastImageSource>,
 ) => Promise<Array<PreloadResult>>
@@ -76,6 +83,7 @@ export type FastImageProps = $ReadOnly<{|
     resizeMode?: ?ResizeModes,
     fallback?: ?boolean,
     recyclingKey?: ?string,
+    loop?: ?(boolean | number),
     testID?: ?string,
 |}>
 

package/dist/index.d.ts

@@ -69,6 +69,12 @@ export interface FastImageProps extends AccessibilityProps, ViewProps {
      * image. Unlike changing `key`, the view is kept.
      */
     recyclingKey?: string | null;
+    /**
+     * How many times an animated image (GIF, animated WebP) plays: the file's
+     * own loop count by default, `true` to loop forever, `false` to play once,
+     * or a number of times. Changing it restarts the animation.
+     */
+    loop?: boolean | number;
     onLoadStart?(): void;
     onProgress?(event: OnProgressEvent): void;
     onLoad?(event: OnLoadEvent): void;
@@ -102,13 +108,18 @@ export interface FastImageProps extends AccessibilityProps, ViewProps {
      */
     children?: React.ReactNode;
 }
-export interface PreloadResult {
+export interface PreloadSuccess {
+    uri: string;
+    ok: true;
+    width: number;
+    height: number;
+}
+export interface PreloadFailure {
     uri?: string;
-    ok: boolean;
-    width?: number;
-    height?: number;
-    error?: string;
+    ok: false;
+    error: string;
 }
+export type PreloadResult = PreloadSuccess | PreloadFailure;
 export interface FastImageStaticProperties {
     resizeMode: typeof resizeMode;
     priority: typeof priority;

package/dist/index.js

@@ -40,11 +40,17 @@ function tintColorFromStyle(style) {
 	}
 	return style && typeof style === "object" ? style.tintColor : void 0;
 }
+function loopCount(loop) {
+	if (loop === void 0) return -1;
+	if (loop === true) return 0;
+	if (loop === false) return 1;
+	return Number.isFinite(loop) ? Math.max(1, Math.floor(loop)) : 0;
+}
 function withoutCache(source) {
 	const { cache: _cache, ...rest } = source || {};
 	return rest;
 }
-function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgress, onLoad, onError, onLoadEnd, style, fallback, children, resizeMode = "cover", forwardedRef, onLayout, pointerEvents, ...viewProps }) {
+function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgress, onLoad, onError, onLoadEnd, style, fallback, children, resizeMode = "cover", loop, forwardedRef, onLayout, pointerEvents, ...viewProps }) {
 	const { onClick, ...props } = viewProps;
 	const wrapperProps = {
 		onLayout,
@@ -85,6 +91,7 @@ function FastImageBase({ source, defaultSource, tintColor, onLoadStart, onProgre
 	}, /* @__PURE__ */ React.createElement(FastImageView, {
 		...imageProps,
 		tintColor: resolvedTintColor,
+		loopCount: loopCount(loop),
 		style: StyleSheet.absoluteFill,
 		source: resolvedSource,
 		defaultSource: resolvedDefaultSource,
@@ -102,18 +109,29 @@ const FastImageComponent = forwardRef((props, ref) => /* @__PURE__ */ React.crea
 	...props
 }));
 FastImageComponent.displayName = "FastImage";
+const noResult = {
+	ok: false,
+	error: "No result"
+};
 const FastImage = FastImageComponent;
 FastImage.resizeMode = resizeMode;
 FastImage.cacheControl = cacheControl;
 FastImage.priority = priority;
 FastImage.preload = (sources) => Promise.resolve(NativeModules.FastImageView.preload(sources.map((s) => s || {}))).then((results) => sources.map((source, i) => {
 	var _results$i;
-	return {
-		uri: source ? source.uri : void 0,
-		...(_results$i = results === null || results === void 0 ? void 0 : results[i]) !== null && _results$i !== void 0 ? _results$i : {
-			ok: false,
-			error: "No result"
-		}
+	const uri = source ? source.uri : void 0;
+	const result = (_results$i = results === null || results === void 0 ? void 0 : results[i]) !== null && _results$i !== void 0 ? _results$i : noResult;
+	if (!result.ok) return {
+		...result,
+		uri
+	};
+	return typeof uri === "string" ? {
+		...result,
+		uri
+	} : {
+		ok: false,
+		error: "Invalid source: no uri",
+		uri
 	};
 }));
 FastImage.clearMemoryCache = () => NativeModules.FastImageView.clearMemoryCache();

package/dist/index.js.flow

@@ -43,14 +43,21 @@ export type ResizeModes = $Values<ResizeMode>
 export type Priorities = $Values<Priority>
 export type CacheControls = $Values<CacheControl>
 
-export type PreloadResult = {|
+export type PreloadSuccess = {|
+    uri: string,
+    ok: true,
+    width: number,
+    height: number,
+|}
+
+export type PreloadFailure = {|
     uri?: string,
-    ok: boolean,
-    width?: number,
-    height?: number,
-    error?: string,
+    ok: false,
+    error: string,
 |}
 
+export type PreloadResult = PreloadSuccess | PreloadFailure
+
 export type PreloadFn = (
     sources: Array<FastImageSource>,
 ) => Promise<Array<PreloadResult>>
@@ -76,6 +83,7 @@ export type FastImageProps = $ReadOnly<{|
     resizeMode?: ?ResizeModes,
     fallback?: ?boolean,
     recyclingKey?: ?string,
+    loop?: ?(boolean | number),
     testID?: ?string,
 |}>
 

package/ios/FastImage/FFFastImageView.h

@@ -22,6 +22,9 @@
 // When it changes, the next image doesn't replace the current one: the view
 // clears first (for views reused for other content, like list rows).
 @property (nonatomic, copy) NSString *recyclingKey;
+// How many times animated images play: -1 for the file's own loop count (the
+// `loop` prop not set), 0 for forever, or a number of times.
+@property (nonatomic, assign) NSInteger loopCount;
 
 @end
 

package/ios/FastImage/FFFastImageView.m

@@ -47,9 +47,31 @@ static CFTimeInterval FFFEnteredBackgroundAt = 0;
     self = [super init];
     self.resizeMode = RCTResizeModeCover;
     self.clipsToBounds = YES;
+    _loopCount = -1;
     return self;
 }
 
+- (void) setLoopCount: (NSInteger)loopCount {
+    if (_loopCount == loopCount) {
+        return;
+    }
+    _loopCount = loopCount;
+    // SDAnimatedImageView uses animationRepeatCount (0 is forever) instead of
+    // the file's loop count when shouldCustomLoopCount is set, for the next
+    // image it shows.
+    self.shouldCustomLoopCount = loopCount >= 0;
+    if (loopCount >= 0) {
+        self.animationRepeatCount = loopCount;
+    } else if (self.player && [self.image conformsToProtocol: @protocol(SDAnimatedImage)]) {
+        self.player.totalLoopCount = [(id<SDAnimatedImage>) self.image animatedImageLoopCount];
+    }
+    // Apply it to the image that's showing, and play it again.
+    if (self.player) {
+        [self.player seekToFrameAtIndex: 0 loopCount: 0];
+        [self startAnimating];
+    }
+}
+
 - (void) setResizeMode: (RCTResizeMode)resizeMode {
     if (_resizeMode != resizeMode) {
         _resizeMode = resizeMode;

package/ios/FastImage/FFFastImageViewManager.m

@@ -18,6 +18,7 @@ RCT_EXPORT_VIEW_PROPERTY(source, FFFastImageSource)
 RCT_EXPORT_VIEW_PROPERTY(defaultSource, UIImage)
 RCT_EXPORT_VIEW_PROPERTY(resizeMode, RCTResizeMode)
 RCT_EXPORT_VIEW_PROPERTY(recyclingKey, NSString)
+RCT_EXPORT_VIEW_PROPERTY(loopCount, NSInteger)
 RCT_EXPORT_VIEW_PROPERTY(onFastImageLoadStart, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onFastImageProgress, RCTDirectEventBlock)
 RCT_EXPORT_VIEW_PROPERTY(onFastImageError, RCTDirectEventBlock)

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-native-fast-image",
-    "version": "8.8.0",
+    "version": "8.9.0",
     "description": "🚩 FastImage, performant React Native image component.",
     "keywords": [
         "cache",
@@ -52,6 +52,7 @@
         "@types/react-native": "^0.69.5",
         "@types/react-test-renderer": "^17.0.1",
         "maestro-runner": "1.1.27",
+        "odiff-bin": "^4.5.0",
         "oxfmt": "0.70.0",
         "oxlint": "1.85.0",
         "pretty-format": "^30.5.1",