@momo-kits/native-kits 0.0.1-beta.3 → 0.0.1-beta.5

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDAnimatedImage.m

@@ -0,0 +1,392 @@
+/*
+ * 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 "SDAnimatedImage.h"
+#import "NSImage+Compatibility.h"
+#import "SDImageCoder.h"
+#import "SDImageCodersManager.h"
+#import "SDImageFrame.h"
+#import "UIImage+MemoryCacheCost.h"
+#import "UIImage+Metadata.h"
+#import "UIImage+MultiFormat.h"
+#import "SDImageCoderHelper.h"
+#import "SDImageAssetManager.h"
+#import "objc/runtime.h"
+
+static CGFloat SDImageScaleFromPath(NSString *string) {
+    if (string.length == 0 || [string hasSuffix:@"/"]) return 1;
+    NSString *name = string.stringByDeletingPathExtension;
+    __block CGFloat scale = 1;
+    
+    NSRegularExpression *pattern = [NSRegularExpression regularExpressionWithPattern:@"@[0-9]+\\.?[0-9]*x$" options:NSRegularExpressionAnchorsMatchLines error:nil];
+    [pattern enumerateMatchesInString:name options:kNilOptions range:NSMakeRange(0, name.length) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
+        scale = [string substringWithRange:NSMakeRange(result.range.location + 1, result.range.length - 2)].doubleValue;
+    }];
+    
+    return scale;
+}
+
+@interface SDAnimatedImage ()
+
+@property (nonatomic, strong) id<SDAnimatedImageCoder> animatedCoder;
+@property (nonatomic, assign, readwrite) SDImageFormat animatedImageFormat;
+@property (atomic, copy) NSArray<SDImageFrame *> *loadedAnimatedImageFrames; // Mark as atomic to keep thread-safe
+@property (nonatomic, assign, getter=isAllFramesLoaded) BOOL allFramesLoaded;
+
+@end
+
+@implementation SDAnimatedImage
+@dynamic scale; // call super
+
+#pragma mark - UIImage override method
++ (instancetype)imageNamed:(NSString *)name {
+#if __has_include(<UIKit/UITraitCollection.h>)
+    return [self imageNamed:name inBundle:nil compatibleWithTraitCollection:nil];
+#else
+    return [self imageNamed:name inBundle:nil];
+#endif
+}
+
+#if __has_include(<UIKit/UITraitCollection.h>)
++ (instancetype)imageNamed:(NSString *)name inBundle:(NSBundle *)bundle compatibleWithTraitCollection:(UITraitCollection *)traitCollection {
+    if (!traitCollection) {
+        traitCollection = UIScreen.mainScreen.traitCollection;
+    }
+    CGFloat scale = traitCollection.displayScale;
+    return [self imageNamed:name inBundle:bundle scale:scale];
+}
+#else
++ (instancetype)imageNamed:(NSString *)name inBundle:(NSBundle *)bundle {
+    return [self imageNamed:name inBundle:bundle scale:0];
+}
+#endif
+
+// 0 scale means automatically check
++ (instancetype)imageNamed:(NSString *)name inBundle:(NSBundle *)bundle scale:(CGFloat)scale {
+    if (!name) {
+        return nil;
+    }
+    if (!bundle) {
+        bundle = [NSBundle mainBundle];
+    }
+    SDImageAssetManager *assetManager = [SDImageAssetManager sharedAssetManager];
+    SDAnimatedImage *image = (SDAnimatedImage *)[assetManager imageForName:name];
+    if ([image isKindOfClass:[SDAnimatedImage class]]) {
+        return image;
+    }
+    NSString *path = [assetManager getPathForName:name bundle:bundle preferredScale:&scale];
+    if (!path) {
+        return image;
+    }
+    NSData *data = [NSData dataWithContentsOfFile:path];
+    if (!data) {
+        return image;
+    }
+    image = [[self alloc] initWithData:data scale:scale];
+    if (image) {
+        [assetManager storeImage:image forName:name];
+    }
+    
+    return image;
+}
+
++ (instancetype)imageWithContentsOfFile:(NSString *)path {
+    return [[self alloc] initWithContentsOfFile:path];
+}
+
++ (instancetype)imageWithData:(NSData *)data {
+    return [[self alloc] initWithData:data];
+}
+
++ (instancetype)imageWithData:(NSData *)data scale:(CGFloat)scale {
+    return [[self alloc] initWithData:data scale:scale];
+}
+
+- (instancetype)initWithContentsOfFile:(NSString *)path {
+    NSData *data = [NSData dataWithContentsOfFile:path];
+    return [self initWithData:data scale:SDImageScaleFromPath(path)];
+}
+
+- (instancetype)initWithData:(NSData *)data {
+    return [self initWithData:data scale:1];
+}
+
+- (instancetype)initWithData:(NSData *)data scale:(CGFloat)scale {
+    return [self initWithData:data scale:scale options:nil];
+}
+
+- (instancetype)initWithData:(NSData *)data scale:(CGFloat)scale options:(SDImageCoderOptions *)options {
+    if (!data || data.length == 0) {
+        return nil;
+    }
+    data = [data copy]; // avoid mutable data
+    id<SDAnimatedImageCoder> animatedCoder = nil;
+    for (id<SDImageCoder>coder in [SDImageCodersManager sharedManager].coders.reverseObjectEnumerator) {
+        if ([coder conformsToProtocol:@protocol(SDAnimatedImageCoder)]) {
+            if ([coder canDecodeFromData:data]) {
+                if (!options) {
+                    options = @{SDImageCoderDecodeScaleFactor : @(scale)};
+                }
+                animatedCoder = [[[coder class] alloc] initWithAnimatedImageData:data options:options];
+                break;
+            }
+        }
+    }
+    if (!animatedCoder) {
+        return nil;
+    }
+    return [self initWithAnimatedCoder:animatedCoder scale:scale];
+}
+
+- (instancetype)initWithAnimatedCoder:(id<SDAnimatedImageCoder>)animatedCoder scale:(CGFloat)scale {
+    if (!animatedCoder) {
+        return nil;
+    }
+    UIImage *image = [animatedCoder animatedImageFrameAtIndex:0];
+    if (!image) {
+        return nil;
+    }
+#if SD_MAC
+    self = [super initWithCGImage:image.CGImage scale:MAX(scale, 1) orientation:kCGImagePropertyOrientationUp];
+#else
+    self = [super initWithCGImage:image.CGImage scale:MAX(scale, 1) orientation:image.imageOrientation];
+#endif
+    if (self) {
+        // Only keep the animated coder if frame count > 1, save RAM usage for non-animated image format (APNG/WebP)
+        if (animatedCoder.animatedImageFrameCount > 1) {
+            _animatedCoder = animatedCoder;
+        }
+        NSData *data = [animatedCoder animatedImageData];
+        SDImageFormat format = [NSData sd_imageFormatForImageData:data];
+        _animatedImageFormat = format;
+    }
+    return self;
+}
+
+#pragma mark - Preload
+- (void)preloadAllFrames {
+    if (!_animatedCoder) {
+        return;
+    }
+    if (!self.isAllFramesLoaded) {
+        NSMutableArray<SDImageFrame *> *frames = [NSMutableArray arrayWithCapacity:self.animatedImageFrameCount];
+        for (size_t i = 0; i < self.animatedImageFrameCount; i++) {
+            UIImage *image = [self animatedImageFrameAtIndex:i];
+            NSTimeInterval duration = [self animatedImageDurationAtIndex:i];
+            SDImageFrame *frame = [SDImageFrame frameWithImage:image duration:duration]; // through the image should be nonnull, used as nullable for `animatedImageFrameAtIndex:`
+            [frames addObject:frame];
+        }
+        self.loadedAnimatedImageFrames = frames;
+        self.allFramesLoaded = YES;
+    }
+}
+
+- (void)unloadAllFrames {
+    if (!_animatedCoder) {
+        return;
+    }
+    if (self.isAllFramesLoaded) {
+        self.loadedAnimatedImageFrames = nil;
+        self.allFramesLoaded = NO;
+    }
+}
+
+#pragma mark - NSSecureCoding
+- (instancetype)initWithCoder:(NSCoder *)aDecoder {
+    self = [super initWithCoder:aDecoder];
+    if (self) {
+        _animatedImageFormat = [aDecoder decodeIntegerForKey:NSStringFromSelector(@selector(animatedImageFormat))];
+        NSData *animatedImageData = [aDecoder decodeObjectOfClass:[NSData class] forKey:NSStringFromSelector(@selector(animatedImageData))];
+        if (!animatedImageData) {
+            return self;
+        }
+        CGFloat scale = self.scale;
+        id<SDAnimatedImageCoder> animatedCoder = nil;
+        for (id<SDImageCoder>coder in [SDImageCodersManager sharedManager].coders.reverseObjectEnumerator) {
+            if ([coder conformsToProtocol:@protocol(SDAnimatedImageCoder)]) {
+                if ([coder canDecodeFromData:animatedImageData]) {
+                    animatedCoder = [[[coder class] alloc] initWithAnimatedImageData:animatedImageData options:@{SDImageCoderDecodeScaleFactor : @(scale)}];
+                    break;
+                }
+            }
+        }
+        if (!animatedCoder) {
+            return self;
+        }
+        if (animatedCoder.animatedImageFrameCount > 1) {
+            _animatedCoder = animatedCoder;
+        }
+    }
+    return self;
+}
+
+- (void)encodeWithCoder:(NSCoder *)aCoder {
+    [super encodeWithCoder:aCoder];
+    [aCoder encodeInteger:self.animatedImageFormat forKey:NSStringFromSelector(@selector(animatedImageFormat))];
+    NSData *animatedImageData = self.animatedImageData;
+    if (animatedImageData) {
+        [aCoder encodeObject:animatedImageData forKey:NSStringFromSelector(@selector(animatedImageData))];
+    }
+}
+
++ (BOOL)supportsSecureCoding {
+    return YES;
+}
+
+#pragma mark - SDAnimatedImageProvider
+
+- (NSData *)animatedImageData {
+    return [self.animatedCoder animatedImageData];
+}
+
+- (NSUInteger)animatedImageLoopCount {
+    return [self.animatedCoder animatedImageLoopCount];
+}
+
+- (NSUInteger)animatedImageFrameCount {
+    return [self.animatedCoder animatedImageFrameCount];
+}
+
+- (UIImage *)animatedImageFrameAtIndex:(NSUInteger)index {
+    if (index >= self.animatedImageFrameCount) {
+        return nil;
+    }
+    if (self.isAllFramesLoaded) {
+        SDImageFrame *frame = [self.loadedAnimatedImageFrames objectAtIndex:index];
+        return frame.image;
+    }
+    return [self.animatedCoder animatedImageFrameAtIndex:index];
+}
+
+- (NSTimeInterval)animatedImageDurationAtIndex:(NSUInteger)index {
+    if (index >= self.animatedImageFrameCount) {
+        return 0;
+    }
+    if (self.isAllFramesLoaded) {
+        SDImageFrame *frame = [self.loadedAnimatedImageFrames objectAtIndex:index];
+        return frame.duration;
+    }
+    return [self.animatedCoder animatedImageDurationAtIndex:index];
+}
+
+@end
+
+@implementation SDAnimatedImage (MemoryCacheCost)
+
+- (NSUInteger)sd_memoryCost {
+    NSNumber *value = objc_getAssociatedObject(self, @selector(sd_memoryCost));
+    if (value != nil) {
+        return value.unsignedIntegerValue;
+    }
+    
+    CGImageRef imageRef = self.CGImage;
+    if (!imageRef) {
+        return 0;
+    }
+    NSUInteger bytesPerFrame = CGImageGetBytesPerRow(imageRef) * CGImageGetHeight(imageRef);
+    NSUInteger frameCount = 1;
+    if (self.isAllFramesLoaded) {
+        frameCount = self.animatedImageFrameCount;
+    }
+    frameCount = frameCount > 0 ? frameCount : 1;
+    NSUInteger cost = bytesPerFrame * frameCount;
+    return cost;
+}
+
+@end
+
+@implementation SDAnimatedImage (Metadata)
+
+- (BOOL)sd_isAnimated {
+    return YES;
+}
+
+- (NSUInteger)sd_imageLoopCount {
+    return self.animatedImageLoopCount;
+}
+
+- (void)setSd_imageLoopCount:(NSUInteger)sd_imageLoopCount {
+    return;
+}
+
+- (NSUInteger)sd_imageFrameCount {
+    return self.animatedImageFrameCount;
+}
+
+- (SDImageFormat)sd_imageFormat {
+    return self.animatedImageFormat;
+}
+
+- (void)setSd_imageFormat:(SDImageFormat)sd_imageFormat {
+    return;
+}
+
+- (BOOL)sd_isVector {
+    return NO;
+}
+
+@end
+
+@implementation SDAnimatedImage (MultiFormat)
+
++ (nullable UIImage *)sd_imageWithData:(nullable NSData *)data {
+    return [self sd_imageWithData:data scale:1];
+}
+
++ (nullable UIImage *)sd_imageWithData:(nullable NSData *)data scale:(CGFloat)scale {
+    return [self sd_imageWithData:data scale:scale firstFrameOnly:NO];
+}
+
++ (nullable UIImage *)sd_imageWithData:(nullable NSData *)data scale:(CGFloat)scale firstFrameOnly:(BOOL)firstFrameOnly {
+    if (!data) {
+        return nil;
+    }
+    return [[self alloc] initWithData:data scale:scale options:@{SDImageCoderDecodeFirstFrameOnly : @(firstFrameOnly)}];
+}
+
+- (nullable NSData *)sd_imageData {
+    NSData *imageData = self.animatedImageData;
+    if (imageData) {
+        return imageData;
+    } else {
+        return [self sd_imageDataAsFormat:self.animatedImageFormat];
+    }
+}
+
+- (nullable NSData *)sd_imageDataAsFormat:(SDImageFormat)imageFormat {
+    return [self sd_imageDataAsFormat:imageFormat compressionQuality:1];
+}
+
+- (nullable NSData *)sd_imageDataAsFormat:(SDImageFormat)imageFormat compressionQuality:(double)compressionQuality {
+    return [self sd_imageDataAsFormat:imageFormat compressionQuality:compressionQuality firstFrameOnly:NO];
+}
+
+- (nullable NSData *)sd_imageDataAsFormat:(SDImageFormat)imageFormat compressionQuality:(double)compressionQuality firstFrameOnly:(BOOL)firstFrameOnly {
+    if (firstFrameOnly) {
+        // First frame, use super implementation
+        return [super sd_imageDataAsFormat:imageFormat compressionQuality:compressionQuality firstFrameOnly:firstFrameOnly];
+    }
+    NSUInteger frameCount = self.animatedImageFrameCount;
+    if (frameCount <= 1) {
+        // Static image, use super implementation
+        return [super sd_imageDataAsFormat:imageFormat compressionQuality:compressionQuality firstFrameOnly:firstFrameOnly];
+    }
+    // Keep animated image encoding, loop each frame.
+    NSMutableArray<SDImageFrame *> *frames = [NSMutableArray arrayWithCapacity:frameCount];
+    for (size_t i = 0; i < frameCount; i++) {
+        UIImage *image = [self animatedImageFrameAtIndex:i];
+        NSTimeInterval duration = [self animatedImageDurationAtIndex:i];
+        SDImageFrame *frame = [SDImageFrame frameWithImage:image duration:duration];
+        [frames addObject:frame];
+    }
+    UIImage *animatedImage = [SDImageCoderHelper animatedImageWithFrames:frames];
+    NSData *imageData = [animatedImage sd_imageDataAsFormat:imageFormat compressionQuality:compressionQuality firstFrameOnly:firstFrameOnly];
+    return imageData;
+}
+
+@end

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDAnimatedImagePlayer.h

@@ -0,0 +1,112 @@
+/*
+* 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 <Foundation/Foundation.h>
+#import "SDWebImageCompat.h"
+#import "SDImageCoder.h"
+
+typedef NS_ENUM(NSUInteger, SDAnimatedImagePlaybackMode) {
+    /**
+     * From first to last frame and stop or next loop.
+     */
+    SDAnimatedImagePlaybackModeNormal = 0,
+    /**
+     * From last frame to first frame and stop or next loop.
+     */
+    SDAnimatedImagePlaybackModeReverse,
+    /**
+     * From first frame to last frame and reverse again, like reciprocating.
+     */
+    SDAnimatedImagePlaybackModeBounce,
+    /**
+     * From last frame to first frame and reverse again, like reversed reciprocating.
+     */
+    SDAnimatedImagePlaybackModeReversedBounce,
+};
+
+/// A player to control the playback of animated image, which can be used to drive Animated ImageView or any rendering usage, like CALayer/WatchKit/SwiftUI rendering.
+@interface SDAnimatedImagePlayer : NSObject
+
+/// Current playing frame image. This value is KVO Compliance.
+@property (nonatomic, readonly, nullable) UIImage *currentFrame;
+
+/// Current frame index, zero based. This value is KVO Compliance.
+@property (nonatomic, readonly) NSUInteger currentFrameIndex;
+
+/// Current loop count since its latest animating. This value is KVO Compliance.
+@property (nonatomic, readonly) NSUInteger currentLoopCount;
+
+/// Total frame count for animated image rendering. Defaults is animated image's frame count.
+/// @note For progressive animation, you can update this value when your provider receive more frames.
+@property (nonatomic, assign) NSUInteger totalFrameCount;
+
+/// Total loop count for animated image rendering. Default is animated image's loop count.
+@property (nonatomic, assign) NSUInteger totalLoopCount;
+
+/// The animation playback rate. Default is 1.0
+/// `1.0` means the normal speed.
+/// `0.0` means stopping the animation.
+/// `0.0-1.0` means the slow speed.
+/// `> 1.0` means the fast speed.
+/// `< 0.0` is not supported currently and stop animation. (may support reverse playback in the future)
+@property (nonatomic, assign) double playbackRate;
+
+/// Asynchronous setup animation playback mode. Default mode is SDAnimatedImagePlaybackModeNormal.
+@property (nonatomic, assign) SDAnimatedImagePlaybackMode playbackMode;
+
+/// Provide a max buffer size by bytes. This is used to adjust frame buffer count and can be useful when the decoding cost is expensive (such as Animated WebP software decoding). Default is 0.
+/// `0` means automatically adjust by calculating current memory usage.
+/// `1` means without any buffer cache, each of frames will be decoded and then be freed after rendering. (Lowest Memory and Highest CPU)
+/// `NSUIntegerMax` means cache all the buffer. (Lowest CPU and Highest Memory)
+@property (nonatomic, assign) NSUInteger maxBufferSize;
+
+/// You can specify a runloop mode to let it rendering.
+/// Default is NSRunLoopCommonModes on multi-core device, NSDefaultRunLoopMode on single-core device
+@property (nonatomic, copy, nonnull) NSRunLoopMode runLoopMode;
+
+/// Create a player with animated image provider. If the provider's `animatedImageFrameCount` is less than 1, returns nil.
+/// The provider can be any protocol implementation, like `SDAnimatedImage`, `SDImageGIFCoder`, etc.
+/// @note This provider can represent mutable content, like progressive animated loading. But you need to update the frame count by yourself
+/// @param provider The animated provider
+- (nullable instancetype)initWithProvider:(nonnull id<SDAnimatedImageProvider>)provider;
+
+/// Create a player with animated image provider. If the provider's `animatedImageFrameCount` is less than 1, returns nil.
+/// The provider can be any protocol implementation, like `SDAnimatedImage` or `SDImageGIFCoder`, etc.
+/// @note This provider can represent mutable content, like progressive animated loading. But you need to update the frame count by yourself
+/// @param provider The animated provider
++ (nullable instancetype)playerWithProvider:(nonnull id<SDAnimatedImageProvider>)provider;
+
+/// The handler block when current frame and index changed.
+@property (nonatomic, copy, nullable) void (^animationFrameHandler)(NSUInteger index, UIImage * _Nonnull frame);
+
+/// The handler block when one loop count finished.
+@property (nonatomic, copy, nullable) void (^animationLoopHandler)(NSUInteger loopCount);
+
+/// Return the status whether animation is playing.
+@property (nonatomic, readonly) BOOL isPlaying;
+
+/// Start the animation. Or resume the previously paused animation.
+- (void)startPlaying;
+
+/// Pause the animation. Keep the current frame index and loop count.
+- (void)pausePlaying;
+
+/// Stop the animation. Reset the current frame index and loop count.
+- (void)stopPlaying;
+
+/// Seek to the desired frame index and loop count.
+/// @note This can be used for advanced control like progressive loading, or skipping specify frames.
+/// @param index The frame index
+/// @param loopCount The loop count
+- (void)seekToFrameAtIndex:(NSUInteger)index loopCount:(NSUInteger)loopCount;
+
+/// Clear the frame cache buffer. The frame cache buffer size can be controlled by `maxBufferSize`.
+/// By default, when stop or pause the animation, the frame buffer is still kept to ready for the next restart
+- (void)clearFrameBuffer;
+
+@end