Merge pull request #7 from SDWebImage/feature_request_image_data

Feature: request image data context option to always request image data

Author: dreampiggy

Example/Tests/SDPhotosPluginTests.m

@@ -97,14 +97,16 @@ - (void)testUIImageViewSetImageWithGIFAsset {
                                   context:@{SDWebImageContextCustomManager : manager}
                                  progress:nil
                                 completed:^(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL) {
+                                    // Strong retain imageView to avoid immediatelly dealloc
+                                    expect(imageView.image).equal(image);
                                     // Expect animated image
                                     expect(image.sd_isAnimated).to.beTruthy();
                                     [expectation fulfill];
                                 }];
         });
     }];
 
-    [self waitForExpectationsWithTimeout:kAsyncTestTimeout handler:nil];
+    [self waitForExpectationsWithTimeout:kAsyncTestTimeout * 2 handler:nil];
 }
 
 #pragma mark - Util

README.md

@@ -155,6 +155,7 @@ imageView.sd_setImage(with: photosURL, placeholderImage: nil, context:[.photosIm
 
 1. Since Photos Library image is already stored on the device disk. And query speed is fast enough for small resolution image. You can use `SDWebImageContextStoreCacheType` with `SDImageCacheTypeNone` to disable cache storage. And use `SDWebImageFromLoaderOnly` to disable cache query.
 2. If you use `PHImageRequestOptionsDeliveryModeOpportunistic` (by default) to load the image, PhotosKit will return a degraded thumb image firstly and again with the full pixel image. When the image is degraded, the loader completion block will set `finished = NO`. But this will not trigger the View Category completion block, only trigger a image refresh (like progressive loading behavior for network image using `SDWebImageProgressiveLoad`)
+3. By default, we will prefer using Photos [requestImageForAsset:targetSize:contentMode:options:resultHandler:](https://developer.apple.com/documentation/photokit/phimagemanager/1616964-requestimageforasset?language=objc) API for normal images, using [requestImageDataForAsset:options:resultHandler:](https://developer.apple.com/documentation/photokit/phimagemanager/1616957-requestimagedataforasset?language=objc) for animated images like GIF asset. If you need the raw image data for further image processing, you can always pass `SDWebImageContextPhotosRequestImageData` context option to force using the request data API instead. Note when request data, the `targetSize` and `contentMode` options are ignored. If you need smaller image size, consider using [Image Transformer](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#image-transformer-50) feature from SDWebImage 5.0
 
 ## Warning
 

SDWebImagePhotosPlugin/Classes/SDWebImagePhotosDefine.h

@@ -40,3 +40,11 @@ FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPhotos
  A PHImageRequestOptions instance used in the Photos Library image request process. If you do not provide, we will use the default options to fetch the image (PHImageRequestOptions)
  */
 FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPhotosImageRequestOptions;
+
+/**
+ A Bool value specify whether or not, to use `requestImageDataForAsset:options:resultHandler:` instead of `requestImageForAsset:targetSize:contentMode:options:resultHandler:` API to request Asset's Image.
+ By default, we automatically use `requestImageDataForAsset` for Animated Asset (GIF images), use `requestImageForAsset` for other Asset. If you provide a custom value, always using that value instead.
+ If you care about the raw image data, you can enable this context option to get the raw image data in completion block.
+ @note When query the raw image data, the `targetSize` and `contentMode` are ignored. You can use image transformer or other ways from your propose. See Apple's documentation for more details information. (NSNumber *)
+ */
+FOUNDATION_EXPORT SDWebImageContextOption _Nonnull const SDWebImageContextPhotosRequestImageData;

SDWebImagePhotosPlugin/Classes/SDWebImagePhotosDefine.m

@@ -15,3 +15,4 @@
 
 SDWebImageContextOption _Nonnull const SDWebImageContextPhotosFetchOptions = @"photosFetchOptions";
 SDWebImageContextOption _Nonnull const SDWebImageContextPhotosImageRequestOptions = @"photosImageRequestOptions";
+SDWebImageContextOption _Nonnull const SDWebImageContextPhotosRequestImageData = @"photosRequestImageData";

SDWebImagePhotosPlugin/Classes/SDWebImagePhotosLoader.m

@@ -156,15 +156,21 @@ - (BOOL)canRequestImageForURL:(NSURL *)url {
             return;
         }
 
-        // Check UTType
-        NSString *uniformTypeIdentifier;
-        if ([asset respondsToSelector:@selector(uniformTypeIdentifier)]) {
-            uniformTypeIdentifier = [asset valueForKey:NSStringFromSelector(@selector(uniformTypeIdentifier))];
+        // Request image data instead of image
+        BOOL requestImageData;
+        if (context[SDWebImageContextPhotosRequestImageData]) {
+            requestImageData = [context[SDWebImageContextPhotosRequestImageData] boolValue];
+        } else {
+            // Check UTType
+            NSString *uniformTypeIdentifier;
+            if ([asset respondsToSelector:@selector(uniformTypeIdentifier)]) {
+                uniformTypeIdentifier = [asset valueForKey:NSStringFromSelector(@selector(uniformTypeIdentifier))];
+            }
+            // Check Animated Image, which need the original image data
+            requestImageData = [[self class] isAnimatedImageWithUTType:uniformTypeIdentifier];
         }
 
-        // Check Animated Image, which need the original image data
-        if ([[self class] isAnimatedImageWithUTType:uniformTypeIdentifier]) {
-            // Animated image need load raw image data
+        if (requestImageData) {
             [self fetchImageDataWithAsset:asset operation:operation url:url options:options context:context progress:progressBlock completed:completedBlock];
         } else {
             [self fetchImageWithAsset:asset operation:operation url:url options:options context:context progress:progressBlock completed:completedBlock];