Remove all previous hack code. Create a SDWebImageFLCoder to decode just FLAnimatedImage for GIF.

Example/Podfile.lock

@@ -18,7 +18,7 @@ EXTERNAL SOURCES:
 
 CHECKOUT OPTIONS:
   SDWebImage:
-    :commit: fe2fede60f9c6efcadfac8b90e8cae579656fffb
+    :commit: aff324b0d09ab4a1736807ca1abc549032b9238a
     :git: https://github.com/rs/SDWebImage.git
 
 SPEC CHECKSUMS:

Example/SDWebImageFLPlugin/SDViewController.m

@@ -8,7 +8,6 @@
 
 #import "SDViewController.h"
 #import <SDWebImageFLPlugin/SDWebImageFLPlugin.h>
-#import <FLAnimatedImage/FLAnimatedImageView.h>
 
 @interface SDViewController ()
 
@@ -18,6 +17,9 @@ @implementation SDViewController
 
 - (void)viewDidLoad {
     [super viewDidLoad];
+    [[SDImageCodersManager sharedManager] addCoder:[SDWebImageFLCoder sharedCoder]];
+
+
 	// Do any additional setup after loading the view, typically from a nib.
     FLAnimatedImageView *animatedImageView = [[FLAnimatedImageView alloc] initWithFrame:self.view.frame];
     animatedImageView.contentMode = UIViewContentModeScaleAspectFit;

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/FLAnimatedImageView+WebCache.h

@@ -15,33 +15,25 @@
 #import "FLAnimatedImage.h"
 #endif
 
-
-/**
- *  A category for the FLAnimatedImage imageView class that hooks it to the SDWebImage system.
- *  Very similar to the base class category (UIImageView (WebCache))
- */
-@interface FLAnimatedImageView (WebCache)
-
 /**
  * Optimal frame cache size of FLAnimatedImage during initializer. (1.0.11 version later)
  * This value will help you set `optimalFrameCacheSize` arg of FLAnimatedImage initializer after image load.
  * Defaults to 0.
  */
-@property (nonatomic, assign) NSUInteger sd_optimalFrameCacheSize;
-
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextOptimalFrameCacheSize;
 /**
  * Predrawing control of FLAnimatedImage during initializer. (1.0.11 version later)
  * This value will help you set `predrawingEnabled` arg of FLAnimatedImage initializer after image load.
  * Defaults to YES.
  */
-@property (nonatomic, assign) BOOL sd_predrawingEnabled;
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPredrawingEnabled;
+
 
 /**
- * Cache control for associated FLAnimatedImage object for memory cache. When enabled, we will bind created FLAnimatedImage instance to UIImage, and store it into memory cache to avoid create this instance cause decoding performance. See `UIImage+FLAnimatedImage`.
- * When enabled, this may consume more memory, if you are facing memory issue, disable it and let FLAnimatedImage been created just in time and dealloced as it not been used. However, when disabled, this may impact performance since we need query disk cache, create FLAnimatedImage and decoding even when the current GIF url is cached.
- * Defatuls to YES;
+ *  A category for the FLAnimatedImage imageView class that hooks it to the SDWebImage system.
+ *  Very similar to the base class category (UIImageView (WebCache))
  */
-@property (nonatomic, assign) BOOL sd_cacheFLAnimatedImage;
+@interface FLAnimatedImageView (WebCache)
 
 /**
  * Load the image at the given url (either from cache or download) and load it in this imageView. It works with both static and dynamic images

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/FLAnimatedImageView+WebCache.m

@@ -7,49 +7,11 @@
  */
 
 #import "FLAnimatedImageView+WebCache.h"
-#import "objc/runtime.h"
 
-@implementation FLAnimatedImageView (WebCache)
-
-// These property based options will moved to `SDWebImageContext` in 5.x, to allow per-image-request level options instead of per-imageView-level options
-- (NSUInteger)sd_optimalFrameCacheSize {
-    NSUInteger optimalFrameCacheSize = 0;
-    NSNumber *value = objc_getAssociatedObject(self, @selector(sd_optimalFrameCacheSize));
-    if ([value isKindOfClass:[NSNumber class]]) {
-        optimalFrameCacheSize = value.unsignedShortValue;
-    }
-    return optimalFrameCacheSize;
-}
-
-- (void)setSd_optimalFrameCacheSize:(NSUInteger)sd_optimalFrameCacheSize {
-    objc_setAssociatedObject(self, @selector(sd_optimalFrameCacheSize), @(sd_optimalFrameCacheSize), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
-}
-
-- (BOOL)sd_predrawingEnabled {
-    BOOL predrawingEnabled = YES;
-    NSNumber *value = objc_getAssociatedObject(self, @selector(sd_predrawingEnabled));
-    if ([value isKindOfClass:[NSNumber class]]) {
-        predrawingEnabled = value.boolValue;
-    }
-    return predrawingEnabled;
-}
-
-- (void)setSd_predrawingEnabled:(BOOL)sd_predrawingEnabled {
-    objc_setAssociatedObject(self, @selector(sd_predrawingEnabled), @(sd_predrawingEnabled), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
-}
-
-- (BOOL)sd_cacheFLAnimatedImage {
-    BOOL cacheFLAnimatedImage = YES;
-    NSNumber *value = objc_getAssociatedObject(self, @selector(sd_cacheFLAnimatedImage));
-    if ([value isKindOfClass:[NSNumber class]]) {
-        cacheFLAnimatedImage = value.boolValue;
-    }
-    return cacheFLAnimatedImage;
-}
+SDWebImageContextOption _Nonnull const SDWebImageContextOptimalFrameCacheSize = @"optimalFrameCacheSize";
+SDWebImageContextOption _Nonnull const SDWebImageContextPredrawingEnabled = @"predrawingEnabled";
 
-- (void)setSd_cacheFLAnimatedImage:(BOOL)sd_cacheFLAnimatedImage {
-    objc_setAssociatedObject(self, @selector(sd_cacheFLAnimatedImage), @(sd_cacheFLAnimatedImage), OBJC_ASSOCIATION_RETAIN_NONATOMIC);
-}
+@implementation FLAnimatedImageView (WebCache)
 
 - (void)sd_setImageWithURL:(nullable NSURL *)url {
     [self sd_setImageWithURL:url placeholderImage:nil options:0 progress:nil completed:nil];
@@ -85,48 +47,31 @@ - (void)sd_setImageWithURL:(nullable NSURL *)url
                    context:(nullable SDWebImageContext *)context
                   progress:(nullable SDImageLoaderProgressBlock)progressBlock
                  completed:(nullable SDExternalCompletionBlock)completedBlock {
+    SDWebImageMutableContext *mutableContext;
+    if (context) {
+        mutableContext = [context mutableCopy];
+    } else {
+        mutableContext = [NSMutableDictionary dictionary];
+    }
+    mutableContext[SDWebImageContextSetImageOperationKey] = NSStringFromClass(self.class);
     __weak typeof(self)weakSelf = self;
     [self sd_internalSetImageWithURL:url
                     placeholderImage:placeholder
                              options:options
-                             context:context
+                             context:mutableContext
                        setImageBlock:^(UIImage *image, NSData *imageData) {
                            __strong typeof(weakSelf)strongSelf = weakSelf;
                            if (!strongSelf) {
                                return;
                            }
-                           // Step 1. Check memory cache (associate object)
-                           FLAnimatedImage *associatedAnimatedImage = image.sd_FLAnimatedImage;
-                           if (associatedAnimatedImage) {
-                               // Asscociated animated image exist
-                               strongSelf.animatedImage = associatedAnimatedImage;
-                               strongSelf.image = nil;
-                               return;
-                           }
-                           // Step 2. Check if original compressed image data is "GIF"
-                           BOOL isGIF = (image.sd_imageFormat == SDImageFormatGIF || [NSData sd_imageFormatForImageData:imageData] == SDImageFormatGIF);
-                           if (!isGIF) {
-                               strongSelf.image = image;
-                               strongSelf.animatedImage = nil;
-                               return;
-                           }
-                           // Step 3. Check if data exist or query disk cache
-                           if (!imageData) {
-                               NSString *key = [[SDWebImageManager sharedManager] cacheKeyForURL:url];
-                               imageData = [[SDImageCache sharedImageCache] diskImageDataForKey:key];
-                           }
-                           // Step 4. Create FLAnimatedImage
-                           FLAnimatedImage *animatedImage = [[FLAnimatedImage alloc] initWithAnimatedGIFData:imageData optimalFrameCacheSize:strongSelf.sd_optimalFrameCacheSize predrawingEnabled:strongSelf.sd_predrawingEnabled];
-                           // Step 5. Set animatedImage or normal image
+                           FLAnimatedImage *animatedImage = image.sd_FLAnimatedImage;
                            if (animatedImage) {
-                               if (strongSelf.sd_cacheFLAnimatedImage) {
-                                   image.sd_FLAnimatedImage = animatedImage;
-                               }
+                               // FLAnimatedImage framework contains a bug that cause GIF been rotated if previous rendered image orientation is not Up. We have to call `setImage:` with non-nil image to reset the state. See `https://github.com/rs/SDWebImage/issues/2402`
+                               strongSelf.image = animatedImage.posterImage;
                                strongSelf.animatedImage = animatedImage;
-                               strongSelf.image = nil;
                            } else {
-                               strongSelf.animatedImage = nil;
                                strongSelf.image = image;
+                               strongSelf.animatedImage = nil;
                            }
                        }
                             progress:progressBlock

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/SDWebImageFLCoder.h

@@ -0,0 +1,18 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <SDWebImage/SDWebImage.h>
+
+// A coder which decode the GIF image, into `FLAnimatedImage` representation and bind the associated object. See `UIImage+SDWebImageFLPlugin` for more detailed information.
+// When you want to use `FLAnimatedImageView` to load image, be sure to add this coder before `SDImageGIFCoder`, to ensure this coder been processed before `SDImageGIFCoder`
+
+@interface SDWebImageFLCoder : NSObject <SDImageCoder>
+
+@property (nonatomic, class, readonly, nonnull) SDWebImageFLCoder *sharedCoder;
+
+@end

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/SDWebImageFLCoder.m

@@ -0,0 +1,75 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageFLCoder.h"
+#import "FLAnimatedImageView+WebCache.h"
+
+@implementation SDWebImageFLCoder
+
++ (SDWebImageFLCoder *)sharedCoder {
+    static SDWebImageFLCoder *coder;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        coder = [[SDWebImageFLCoder alloc] init];
+    });
+    return coder;
+}
+
+- (BOOL)canDecodeFromData:(NSData *)data {
+    return ([NSData sd_imageFormatForImageData:data] == SDImageFormatGIF);
+}
+
+- (UIImage *)decodedImageWithData:(NSData *)data options:(SDImageCoderOptions *)options {
+    SDWebImageContext *context = options[SDImageCoderWebImageContext];
+    NSString *operationKey = context[SDWebImageContextSetImageOperationKey];
+    Class imageViewClass = NSClassFromString(operationKey);
+
+    // Check if image request come from `FLAnimatedImageView`
+    if (imageViewClass && [imageViewClass isSubclassOfClass:FLAnimatedImageView.class]) {
+        // Parse args
+        BOOL predrawingEnabled = YES;
+        if (context[SDWebImageContextPredrawingEnabled]) {
+            predrawingEnabled = [context[SDWebImageContextPredrawingEnabled] boolValue];
+        }
+        NSUInteger optimalFrameCacheSize = 0;
+        if (context[SDWebImageContextOptimalFrameCacheSize]) {
+            optimalFrameCacheSize = [context[SDWebImageContextOptimalFrameCacheSize] unsignedIntegerValue];
+        }
+        // Create FLAnimatedImage
+        FLAnimatedImage *animatedImage = [[FLAnimatedImage alloc] initWithAnimatedGIFData:data optimalFrameCacheSize:optimalFrameCacheSize predrawingEnabled:predrawingEnabled];
+        if (!animatedImage) {
+            return nil;
+        }
+
+        return [UIImage sd_imageWithFLAnimatedImage:animatedImage];
+    } else {
+        UIImage *image;
+        NSArray<id<SDImageCoder>> *coders = [SDImageCodersManager sharedManager].coders;
+        for (id<SDImageCoder> coder in coders.reverseObjectEnumerator) {
+            if (coder == self) {
+                continue;
+            }
+            if ([coder canDecodeFromData:data]) {
+                image = [coder decodedImageWithData:data options:options];
+                break;
+            }
+        }
+
+        return image;
+    }
+}
+
+- (BOOL)canEncodeToFormat:(SDImageFormat)format {
+    return NO;
+}
+
+- (NSData *)encodedDataWithImage:(UIImage *)image format:(SDImageFormat)format options:(SDImageCoderOptions *)options {
+    return nil;
+}
+
+@end

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/UIImage+SDWebImageFLPlugin.h

@@ -19,4 +19,13 @@
  */
 @property (nonatomic, strong, nullable) FLAnimatedImage *sd_FLAnimatedImage;
 
+/**
+ Create a UIImage instance, which bind FLAnimatedImage using the `sd_FLAnimatedImage` on it.
+ This will use `posterImage` on FLAnimatedImage to create a new UIImage and specify the associate object. To avoid cycle retain.
+
+ @param animatedImage FLAnimatedImage instance
+ @return The UIImage which bind FLAnimatedImage on it
+ */
++ (nullable instancetype)sd_imageWithFLAnimatedImage:(nullable FLAnimatedImage *)animatedImage;
+
 @end

SDWebImageFLPlugin/Classes/FLAnimatedImageBridge/UIImage+SDWebImageFLPlugin.m

@@ -7,6 +7,7 @@
  */
 
 #import "UIImage+SDWebImageFLPlugin.h"
+#import <SDWebImage/SDWebImage.h>
 #import "objc/runtime.h"
 
 @implementation UIImage (SDWebImageFLPlugin)
@@ -19,4 +20,18 @@ - (void)setSd_FLAnimatedImage:(FLAnimatedImage *)sd_FLAnimatedImage {
     objc_setAssociatedObject(self, @selector(sd_FLAnimatedImage), sd_FLAnimatedImage, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
 }
 
++ (instancetype)sd_imageWithFLAnimatedImage:(FLAnimatedImage *)animatedImage {
+    UIImage *posterImage = animatedImage.posterImage;
+    CGImageRef imageRef = posterImage.CGImage;
+    if (!imageRef) {
+        return nil;
+    }
+    UIImage *image = [[UIImage alloc] initWithCGImage:imageRef scale:posterImage.scale orientation:posterImage.imageOrientation];
+
+    image.sd_FLAnimatedImage = animatedImage;
+    image.sd_isDecoded = YES; // Avoid force decode and loss the associate object
+
+    return image;
+}
+
 @end

SDWebImageFLPlugin/Module/SDWebImageFLPlugin.h

@@ -12,6 +12,7 @@
 
 #import <SDWebImageFLPlugin/FLAnimatedImageView+WebCache.h>
 #import <SDWebImageFLPlugin/UIImage+SDWebImageFLPlugin.h>
+#import <SDWebImageFLPlugin/SDWebImageFLCoder.h>
 
 
 FOUNDATION_EXPORT double SDWebImageFLPluginVersionNumber;