Add SDImageYYCoder class, to support treat YYImageDecoder as custom coder class

Author: dreampiggy

Example/Podfile.lock

@@ -14,20 +14,25 @@ PODS:
   - YYImage/Core (1.0.4)
 
 DEPENDENCIES:
-  - SDWebImage/Core (from `[email protected]:rs/SDWebImage.git`, branch `5.x`)
+  - "SDWebImage/Core (from `[email protected]:rs/SDWebImage.git`, branch `5.x`)"
   - SDWebImageYYPlugin (from `../`)
 
+SPEC REPOS:
+  https://github.com/cocoapods/specs.git:
+    - YYCache
+    - YYImage
+
 EXTERNAL SOURCES:
   SDWebImage:
     :branch: 5.x
-    :git: [email protected]:rs/SDWebImage.git
+    :git: "[email protected]:rs/SDWebImage.git"
   SDWebImageYYPlugin:
-    :path: ../
+    :path: "../"
 
 CHECKOUT OPTIONS:
   SDWebImage:
     :commit: 2bb336bc12a5690dd11988c0bc8bef2c7318508d
-    :git: [email protected]:rs/SDWebImage.git
+    :git: "[email protected]:rs/SDWebImage.git"
 
 SPEC CHECKSUMS:
   SDWebImage: 8e4aaf5805e954ad426702adf5a8c012a7f581d1
@@ -37,4 +42,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: f8c72633fbc009d6f1bfe12afb37eb2cdaccdb13
 
-COCOAPODS: 1.4.0
+COCOAPODS: 1.5.3

Example/SDWebImageYYPlugin.xcodeproj/project.pbxproj

@@ -208,7 +208,6 @@
 				6003F587195388D20070C39A /* Frameworks */,
 				6003F588195388D20070C39A /* Resources */,
 				053E29CB027BC9446808DA05 /* [CP] Embed Pods Frameworks */,
-				1E73D407B46B3CEE69E8FD87 /* [CP] Copy Pods Resources */,
 			);
 			buildRules = (
 			);
@@ -227,8 +226,6 @@
 				6003F5AA195388D20070C39A /* Sources */,
 				6003F5AB195388D20070C39A /* Frameworks */,
 				6003F5AC195388D20070C39A /* Resources */,
-				005F82905EBA1CA9A655C3C6 /* [CP] Embed Pods Frameworks */,
-				371F4E9CA414CF22DBE83FA3 /* [CP] Copy Pods Resources */,
 			);
 			buildRules = (
 			);
@@ -297,21 +294,6 @@
 /* End PBXResourcesBuildPhase section */
 
 /* Begin PBXShellScriptBuildPhase section */
-		005F82905EBA1CA9A655C3C6 /* [CP] Embed Pods Frameworks */ = {
-			isa = PBXShellScriptBuildPhase;
-			buildActionMask = 2147483647;
-			files = (
-			);
-			inputPaths = (
-			);
-			name = "[CP] Embed Pods Frameworks";
-			outputPaths = (
-			);
-			runOnlyForDeploymentPostprocessing = 0;
-			shellPath = /bin/sh;
-			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-SDWebImageYYPlugin_Tests/Pods-SDWebImageYYPlugin_Tests-frameworks.sh\"\n";
-			showEnvVarsInLog = 0;
-		};
 		053E29CB027BC9446808DA05 /* [CP] Embed Pods Frameworks */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;
@@ -336,36 +318,6 @@
 			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-SDWebImageYYPlugin_Example/Pods-SDWebImageYYPlugin_Example-frameworks.sh\"\n";
 			showEnvVarsInLog = 0;
 		};
-		1E73D407B46B3CEE69E8FD87 /* [CP] Copy Pods Resources */ = {
-			isa = PBXShellScriptBuildPhase;
-			buildActionMask = 2147483647;
-			files = (
-			);
-			inputPaths = (
-			);
-			name = "[CP] Copy Pods Resources";
-			outputPaths = (
-			);
-			runOnlyForDeploymentPostprocessing = 0;
-			shellPath = /bin/sh;
-			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-SDWebImageYYPlugin_Example/Pods-SDWebImageYYPlugin_Example-resources.sh\"\n";
-			showEnvVarsInLog = 0;
-		};
-		371F4E9CA414CF22DBE83FA3 /* [CP] Copy Pods Resources */ = {
-			isa = PBXShellScriptBuildPhase;
-			buildActionMask = 2147483647;
-			files = (
-			);
-			inputPaths = (
-			);
-			name = "[CP] Copy Pods Resources";
-			outputPaths = (
-			);
-			runOnlyForDeploymentPostprocessing = 0;
-			shellPath = /bin/sh;
-			shellScript = "\"${SRCROOT}/Pods/Target Support Files/Pods-SDWebImageYYPlugin_Tests/Pods-SDWebImageYYPlugin_Tests-resources.sh\"\n";
-			showEnvVarsInLog = 0;
-		};
 		56E885A70EC351C1F1512B57 /* [CP] Check Pods Manifest.lock */ = {
 			isa = PBXShellScriptBuildPhase;
 			buildActionMask = 2147483647;

SDWebImageYYPlugin/Classes/YYImage/YYImageBridge/SDImageYYCoder.h

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the SDWebImage-YYImage package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <YYImage/YYImage.h>
+#import <SDWebImage/SDImageCoder.h>
+
+/**
+ YYImageEncoder && YYImageDecoder bridge to supports SDWebImage coder protocol. This class use YYImage's decoding && encoding system. It supports any image format listed in `YYImageType`.
+ @note This class conforms to `SDProgressiveImageCoder` && `SDAnimatedImageCoder`, supports static progressive decoding and animation decoding. However, it does not supports progressive animation decoding like `SDImageGIFCoder`. Which means you can not use any method in `SDAnimatedImageProvider` protocol if you create the instance with `initIncrementalWithOptions:` method.
+ */
+@interface SDImageYYCoder : NSObject <SDImageCoder, SDProgressiveImageCoder, SDAnimatedImageCoder>
+
+@property (nonatomic, class, readonly, nonnull) SDImageYYCoder *sharedCoder;
+
+/**
+ The wrapped `YYImageDecoder` instance, to support static progressive and animation decoding.
+ @note This property is only useful for static progressive or animation decoding. For normal decoding process, we will use a temporary `YYImageDecoder` to do decoding because it does not need to keep decoded context.
+ */
+@property (nonatomic, strong, readonly, nonnull) YYImageDecoder *decoder;
+
+@end

SDWebImageYYPlugin/Classes/YYImage/YYImageBridge/SDImageYYCoder.m

@@ -0,0 +1,180 @@
+/*
+ * This file is part of the SDWebImage-YYImage package.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDImageYYCoder.h"
+
+static inline YYImageType YYImageTypeFromSDImageFormat(SDImageFormat format) {
+    switch (format) {
+        case SDImageFormatJPEG:
+            return YYImageTypeJPEG;
+        case SDImageFormatPNG:
+            return YYImageTypePNG;
+        case SDImageFormatGIF:
+            return YYImageTypeGIF;
+        case SDImageFormatTIFF:
+            return YYImageTypeTIFF;
+        case SDImageFormatWebP:
+            return YYImageTypeWebP;
+        default:
+            return YYImageTypeUnknown;
+    }
+}
+
+@interface SDImageYYCoder ()
+
+@property (nonatomic, strong) YYImageDecoder *decoder;
+
+@end
+
+@implementation SDImageYYCoder
+
++ (SDImageYYCoder *)sharedCoder {
+    static dispatch_once_t onceToken;
+    static SDImageYYCoder *coder;
+    dispatch_once(&onceToken, ^{
+        coder = [[SDImageYYCoder alloc] init];
+    });
+    
+    return coder;
+}
+
+- (instancetype)init {
+    self = [super init];
+    if (self) {
+        self.decoder = [[YYImageDecoder alloc] initWithScale:1];
+    }
+    return self;
+}
+
+#pragma mark - SDImageCoder
+
+- (BOOL)canDecodeFromData:(NSData *)data {
+    YYImageType type = YYImageDetectType((__bridge CFDataRef)(data));
+    return type != YYImageTypeUnknown;
+}
+
+- (UIImage *)decodedImageWithData:(NSData *)data options:(SDImageCoderOptions *)options {
+    if (!data) {
+        return nil;
+    }
+    CGFloat scale = 1;
+    NSNumber *scaleFactor = options[SDImageCoderDecodeScaleFactor];
+    if (scaleFactor != nil) {
+        scale = [scaleFactor doubleValue];
+        if (scale < 1) {
+            scale = 1;
+        }
+    }
+    
+    YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:scale];
+    YYImageFrame *frame = [decoder frameAtIndex:0 decodeForDisplay:NO];
+    
+    return frame.image;
+}
+
+- (BOOL)canEncodeToFormat:(SDImageFormat)format {
+    YYImageType type = YYImageTypeFromSDImageFormat(format);
+    return type != YYImageTypeUnknown;
+}
+
+- (NSData *)encodedDataWithImage:(UIImage *)image format:(SDImageFormat)format options:(SDImageCoderOptions *)options {
+    double compressionQuality = 1;
+    if (options[SDImageCoderEncodeCompressionQuality]) {
+        compressionQuality = [options[SDImageCoderEncodeCompressionQuality] doubleValue];
+    }
+    
+    YYImageType type = YYImageTypeFromSDImageFormat(format);
+    NSData *data = [YYImageEncoder encodeImage:image type:type quality:compressionQuality];
+    
+    return data;
+}
+
+#pragma mark - SDProgressiveImageCoder
+
+- (BOOL)canIncrementalDecodeFromData:(nullable NSData *)data {
+    YYImageType type = YYImageDetectType((__bridge CFDataRef)(data));
+    return type != YYImageTypeUnknown;
+}
+
+- (instancetype)initIncrementalWithOptions:(SDImageCoderOptions *)options {
+    self = [super init];
+    if (self) {
+        CGFloat scale = 1;
+        NSNumber *scaleFactor = options[SDImageCoderDecodeScaleFactor];
+        if (scaleFactor != nil) {
+            scale = [scaleFactor doubleValue];
+            if (scale < 1) {
+                scale = 1;
+            }
+        }
+        self.decoder = [[YYImageDecoder alloc] initWithScale:scale];
+    }
+    
+    return self;
+}
+
+- (void)updateIncrementalData:(NSData *)data finished:(BOOL)finished {
+    if (self.decoder.isFinalized) {
+        return;
+    }
+    
+    [self.decoder updateData:data final:finished];
+}
+
+- (UIImage *)incrementalDecodedImageWithOptions:(SDImageCoderOptions *)options {
+    YYImageFrame *frame = [self.decoder frameAtIndex:0 decodeForDisplay:NO];
+    
+    return frame.image;
+}
+
+#pragma mark - SDAnimatedImageCoder
+
+- (instancetype)initWithAnimatedImageData:(NSData *)data options:(SDImageCoderOptions *)options {
+    if (!data) {
+        return nil;
+    }
+    self = [super init];
+    if (self) {
+        CGFloat scale = 1;
+        NSNumber *scaleFactor = options[SDImageCoderDecodeScaleFactor];
+        if (scaleFactor != nil) {
+            scale = [scaleFactor doubleValue];
+            if (scale < 1) {
+                scale = 1;
+            }
+        }
+        YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:scale];
+        if (!decoder) {
+            return nil;
+        }
+        self.decoder = decoder;
+    }
+    return self;
+}
+
+- (NSData *)animatedImageData {
+    return self.decoder.data;
+}
+
+- (NSUInteger)animatedImageFrameCount {
+    return self.decoder.frameCount;
+}
+
+- (NSUInteger)animatedImageLoopCount {
+    return self.decoder.loopCount;
+}
+
+- (UIImage *)animatedImageFrameAtIndex:(NSUInteger)index {
+    YYImageFrame *frame = [self.decoder frameAtIndex:index decodeForDisplay:NO];
+    return frame.image;
+}
+
+- (NSTimeInterval)animatedImageDurationAtIndex:(NSUInteger)index {
+    return [self.decoder frameDurationAtIndex:index];
+}
+
+@end

SDWebImageYYPlugin/Module/SDWebImageYYPlugin.h

@@ -22,6 +22,7 @@
 #import <SDWebImageYYPlugin/SDAnimatedImage+YYAddtions.h>
 #import <SDWebImageYYPlugin/YYAnimatedImageView+WebCache.h>
 #import <SDWebImageYYPlugin/YYImage+SDAddtions.h>
+#import <SDWebImageYYPlugin/SDImageYYCoder.h>
 #endif
 
 FOUNDATION_EXPORT double SDWebImageYYPluginVersionNumber;