Merge pull request #14 from airbnb/nsilverman-loader-fix

Cancel loading tasks when a new animation is set
airbnb · Nov 30, 2016 · a48910c · a48910c
2 parents 9302b80 + 74f5653
commit a48910c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 8 deletions.
diff --git a/lottie/src/main/java/com/airbnb/lottie/LottieAnimationView.java b/lottie/src/main/java/com/airbnb/lottie/LottieAnimationView.java
@@ -58,6 +58,7 @@ public static LottieAnimationView forScreenshotTest(Context context) {
         @Override
         public void onCompositionLoaded(LottieComposition composition) {
             setComposition(composition);
+            compositionLoader = null;
         }
     };
 
@@ -70,6 +71,7 @@ public void onCompositionLoaded(LottieComposition composition) {
     private boolean setProgressWhenCompositionSet;
     private boolean playAnimationWhenCompositionSet;
 
+    @Nullable private LottieComposition.Cancellable compositionLoader;
     /** Can be null because it is created async */
     @Nullable private LottieComposition composition;
     private boolean hasInvalidatedThisFrame;
@@ -201,7 +203,8 @@ public void setAnimation(final String animationName) {
         playAnimationWhenCompositionSet = false;
 
         this.animationName = animationName;
-        LottieComposition.fromFile(getContext(), animationName, loadedListener);
+        cancelLoaderTask();
+        compositionLoader = LottieComposition.fromFile(getContext(), animationName, loadedListener);
     }
 
     /**
@@ -213,7 +216,15 @@ public void setAnimation(final JSONObject json) {
         setProgressWhenCompositionSet = false;
         playAnimationWhenCompositionSet = false;
 
-        LottieComposition.fromJson(getContext(), json, loadedListener);
+        cancelLoaderTask();
+        compositionLoader = LottieComposition.fromJson(getContext(), json, loadedListener);
+    }
+
+    private void cancelLoaderTask() {
+        if (compositionLoader != null) {
+            compositionLoader.cancel();
+            compositionLoader = null;
+        }
     }
 
     public void setComposition(@NonNull LottieComposition composition) {

diff --git a/lottie/src/main/java/com/airbnb/lottie/model/LottieComposition.java b/lottie/src/main/java/com/airbnb/lottie/model/LottieComposition.java
@@ -22,6 +22,10 @@ public interface OnCompositionLoadedListener {
         void onCompositionLoaded(LottieComposition composition);
     }
 
+    public interface Cancellable {
+        void cancel();
+    }
+
     /**
      * The largest bitmap drawing cache can be is 8,294,400 bytes. There are 4 bytes per pixel leaving ~2.3M pixels available.
      * Reduce the number a little bit for safety.
@@ -30,14 +34,16 @@ public interface OnCompositionLoadedListener {
      */
     private static final int MAX_PIXELS = 1000;
 
-    public static void fromFile(Context context, String fileName, OnCompositionLoadedListener loadedListener) {
+    public static Cancellable fromFile(Context context, String fileName, OnCompositionLoadedListener loadedListener) {
         InputStream file;
         try {
             file = context.getAssets().open(fileName);
         } catch (IOException e) {
             throw new IllegalStateException("Unable to find file " + fileName, e);
         }
-        new FileCompositionLoader(loadedListener).execute(file);
+        FileCompositionLoader loader = new FileCompositionLoader(loadedListener);
+        loader.execute(file);
+        return loader;
     }
 
     public static LottieComposition fromFileSync(Context context, String fileName) {
@@ -50,8 +56,10 @@ public static LottieComposition fromFileSync(Context context, String fileName) {
         return fromInputStream(file);
     }
 
-    public static void fromJson(Context context, JSONObject json, OnCompositionLoadedListener loadedListener) {
-        new JsonCompositionLoader(loadedListener).execute(json);
+    public static Cancellable fromJson(Context context, JSONObject json, OnCompositionLoadedListener loadedListener) {
+        JsonCompositionLoader loader = new JsonCompositionLoader(loadedListener);
+        loader.execute(json);
+        return loader;
     }
 
     private static LottieComposition fromInputStream(InputStream file) {
@@ -175,7 +183,7 @@ public boolean hasMattes() {
         return hasMattes;
     }
 
-    private static final class FileCompositionLoader extends AsyncTask<InputStream, Void, LottieComposition> {
+    private static final class FileCompositionLoader extends CompositionLoader<InputStream> {
 
         private final OnCompositionLoadedListener loadedListener;
 
@@ -194,7 +202,7 @@ protected void onPostExecute(LottieComposition composition) {
         }
     }
 
-    private static final class JsonCompositionLoader extends AsyncTask<JSONObject, Void, LottieComposition> {
+    private static final class JsonCompositionLoader extends CompositionLoader<JSONObject> {
 
         private final OnCompositionLoadedListener loadedListener;
 
@@ -212,4 +220,14 @@ protected void onPostExecute(LottieComposition composition) {
             loadedListener.onCompositionLoaded(composition);
         }
     }
+
+    private abstract static class CompositionLoader<Params>
+            extends AsyncTask<Params, Void, LottieComposition>
+            implements Cancellable {
+
+        @Override
+        public void cancel() {
+            cancel(true);
+        }
+    }
 }