react-native-fast-image 8.11.0 → 8.12.0

package/README.md

@@ -196,6 +196,12 @@ How the image is filtered when it's drawn smaller or larger than its size (like
 
 ---
 
+### `paused?: boolean`
+
+Pauses an animated image (GIF, and animated WebP on iOS) on the frame it's showing; `false` plays it again from there. Each image animates on its own, so pausing one doesn't pause others showing the same file.
+
+---
+
 ### `onLoadStart?: () => void`
 
 Called when the image starts to load.

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

@@ -18,6 +18,7 @@ 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.lang.reflect.Field;
 import java.nio.ByteBuffer;
 
 // Gives a view its own animation of a GIF. Glide gives every view that shows
@@ -64,6 +65,42 @@ final class FastImageGif {
         return copy;
     }
 
+    // GifDrawable.start() also starts counting plays again, so a paused GIF
+    // would play its whole loop count again when resumed; iOS continues it.
+    // The count isn't public: keep it across start() by reflection. A GIF
+    // that already finished its plays starts over, as on iOS. Without the
+    // fields (another Glide version), it counts again, as start() does.
+    @Nullable
+    private static final Field LOOP_COUNT = field("loopCount");
+    @Nullable
+    private static final Field MAX_LOOP_COUNT = field("maxLoopCount");
+
+    static void resume(GifDrawable gif) {
+        if (LOOP_COUNT == null || MAX_LOOP_COUNT == null) {
+            gif.start();
+            return;
+        }
+        try {
+            int played = LOOP_COUNT.getInt(gif);
+            int max = MAX_LOOP_COUNT.getInt(gif);
+            gif.start();
+            if (max == GifDrawable.LOOP_FOREVER || played < max) LOOP_COUNT.setInt(gif, played);
+        } catch (IllegalAccessException e) {
+            gif.start();
+        }
+    }
+
+    @Nullable
+    private static Field field(String name) {
+        try {
+            Field field = GifDrawable.class.getDeclaredField(name);
+            field.setAccessible(true);
+            return field.getType() == int.class ? field : null;
+        } catch (Exception e) {
+            return null;
+        }
+    }
+
     // ByteBufferGifDecoder's.
     private static int sampleSize(GifHeader header, int width, int height) {
         int exact = Math.min(header.getHeight() / height, header.getWidth() / width);

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

@@ -99,6 +99,11 @@ class FastImageViewManager extends SimpleViewManager<FastImageViewWithUrl> imple
         view.setImageRendering(imageRendering);
     }
 
+    @ReactProp(name = "paused")
+    public void setPaused(FastImageViewWithUrl view, boolean paused) {
+        view.setPaused(paused);
+    }
+
     @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

@@ -79,8 +79,26 @@ class FastImageViewWithUrl extends AppCompatImageView {
         // another view plays it.
         if (mOwnGif != null && getDrawable() == mOwnGif) {
             applyLoopCount(mOwnGif);
-            mOwnGif.stop();
-            mOwnGif.startFromFirstFrame();
+            if (!mPaused) {
+                mOwnGif.stop();
+                mOwnGif.startFromFirstFrame();
+            }
+        }
+    }
+
+    // Pauses GIFs on the frame they're showing (the view's own animation).
+    private boolean mPaused = false;
+
+    public void setPaused(boolean paused) {
+        if (paused == mPaused) return;
+        mPaused = paused;
+        if (mOwnGif != null && getDrawable() == mOwnGif) {
+            if (paused) {
+                mOwnGif.stop();
+            } else {
+                // Continues the loop count, as on iOS.
+                FastImageGif.resume(mOwnGif);
+            }
         }
     }
 
@@ -112,12 +130,27 @@ class FastImageViewWithUrl extends AppCompatImageView {
                     applyLoopCount(own);
                     super.onResourceReady(own, transition);
                     mOwnGif = own;
+                    // The target starts it; paused, it waits on its first frame.
+                    if (mPaused) own.stop();
                     return;
                 }
             }
             super.onResourceReady(resource, transition);
         }
 
+        // The target starts animations again when the Activity does: not a
+        // paused one, and the view's own GIF continues its loop count (start()
+        // would count again).
+        @Override
+        public void onStart() {
+            if (mPaused) return;
+            if (mOwnGif != null && getDrawable() == mOwnGif) {
+                FastImageGif.resume(mOwnGif);
+            } else {
+                super.onStart();
+            }
+        }
+
         @Override
         protected void setResource(@Nullable Drawable resource) {
             super.setResource(resource);

package/dist/index.cjs.js.flow

@@ -91,6 +91,7 @@ export type FastImageProps = $ReadOnly<{|
     recyclingKey?: ?string,
     loop?: ?(boolean | number),
     imageRendering?: ?('auto' | 'smooth' | 'pixelated'),
+    paused?: ?boolean,
     testID?: ?string,
 |}>
 

package/dist/index.d.ts

@@ -88,6 +88,12 @@ export interface FastImageProps extends AccessibilityProps, ViewProps {
      * pixels, e.g. for pixel art).
      */
     imageRendering?: 'auto' | 'smooth' | 'pixelated';
+    /**
+     * Pauses an animated image (GIF, and animated WebP on iOS) on the frame
+     * it's showing; `false` plays it again from there. Each image animates on
+     * its own, so pausing one doesn't pause others showing the same file.
+     */
+    paused?: boolean;
     onLoadStart?(): void;
     onProgress?(event: OnProgressEvent): void;
     onLoad?(event: OnLoadEvent): void;

package/dist/index.js.flow

@@ -91,6 +91,7 @@ export type FastImageProps = $ReadOnly<{|
     recyclingKey?: ?string,
     loop?: ?(boolean | number),
     imageRendering?: ?('auto' | 'smooth' | 'pixelated'),
+    paused?: ?boolean,
     testID?: ?string,
 |}>
 

package/ios/FastImage/FFFastImageView.h

@@ -28,6 +28,8 @@
 // How the image is filtered when drawn at another size: auto, smooth or
 // pixelated.
 @property (nonatomic, copy) NSString *imageRendering;
+// Pauses animated images on the frame they're showing.
+@property (nonatomic, assign) BOOL paused;
 
 @end
 

package/ios/FastImage/FFFastImageView.m

@@ -85,9 +85,28 @@ static CFTimeInterval FFFEnteredBackgroundAt = 0;
     } 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.
+    // Apply it to the image that's showing, and play it again (unless it's
+    // paused: then it waits on the first frame).
     if (self.player) {
         [self.player seekToFrameAtIndex: 0 loopCount: 0];
+        if (!_paused) {
+            [self startAnimating];
+        }
+    }
+}
+
+- (void) setPaused: (BOOL)paused {
+    if (_paused == paused) {
+        return;
+    }
+    _paused = paused;
+    // SDAnimatedImageView starts an animated image when it's shown, and again
+    // when the view comes back on screen, unless autoPlayAnimatedImage is off.
+    // Stopping keeps the frame it's on (resetFrameIndexWhenStopped is off).
+    self.autoPlayAnimatedImage = !paused;
+    if (paused) {
+        [self stopAnimating];
+    } else {
         [self startAnimating];
     }
 }

package/ios/FastImage/FFFastImageViewManager.m

@@ -20,6 +20,7 @@ RCT_EXPORT_VIEW_PROPERTY(resizeMode, RCTResizeMode)
 RCT_EXPORT_VIEW_PROPERTY(recyclingKey, NSString)
 RCT_EXPORT_VIEW_PROPERTY(loopCount, NSInteger)
 RCT_EXPORT_VIEW_PROPERTY(imageRendering, NSString)
+RCT_EXPORT_VIEW_PROPERTY(paused, BOOL)
 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.11.0",
+    "version": "8.12.0",
     "description": "🚩 FastImage, performant React Native image component.",
     "keywords": [
         "cache",
@@ -51,6 +51,7 @@
         "@types/react": "^17.0.14",
         "@types/react-native": "^0.69.5",
         "@types/react-test-renderer": "^17.0.1",
+        "conventional-changelog-angular": "8.3.1",
         "maestro-runner": "1.1.27",
         "odiff-bin": "^4.5.0",
         "oxfmt": "0.70.0",