Merge pull request #28 from SDWebImage/demo/upgrade

dreampiggy · web-flow · commit 300c6681c251 · 2025-02-26T18:54:13.000+08:00
Enhance PhotosKit error handling case and update demo
diff --git a/Example/SDWebImagePhotosPlugin.xcodeproj/project.pbxproj b/Example/SDWebImagePhotosPlugin.xcodeproj/project.pbxproj
@@ -653,7 +653,7 @@
 				GCC_C_LANGUAGE_STANDARD = gnu11;
 				INFOPLIST_FILE = "SDWebImagePhotosPlugin_Example macOS/Info.plist";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
-				MACOSX_DEPLOYMENT_TARGET = 10.13;
+				MACOSX_DEPLOYMENT_TARGET = 10.15;
 				MTL_ENABLE_DEBUG_INFO = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.dreampiggy.SDWebImagePhotosPlugin-Example-macOS";
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -683,7 +683,7 @@
 				GCC_C_LANGUAGE_STANDARD = gnu11;
 				INFOPLIST_FILE = "SDWebImagePhotosPlugin_Example macOS/Info.plist";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
-				MACOSX_DEPLOYMENT_TARGET = 10.13;
+				MACOSX_DEPLOYMENT_TARGET = 10.15;
 				MTL_ENABLE_DEBUG_INFO = NO;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.dreampiggy.SDWebImagePhotosPlugin-Example-macOS";
 				PRODUCT_NAME = "$(TARGET_NAME)";
@@ -737,7 +737,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 9.3;
+				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				ONLY_ACTIVE_ARCH = YES;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
@@ -783,7 +783,7 @@
 				GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE;
 				GCC_WARN_UNUSED_FUNCTION = YES;
 				GCC_WARN_UNUSED_VARIABLE = YES;
-				IPHONEOS_DEPLOYMENT_TARGET = 9.3;
+				IPHONEOS_DEPLOYMENT_TARGET = 10.0;
 				SDKROOT = iphoneos;
 				TARGETED_DEVICE_FAMILY = "1,2";
 				VALIDATE_PRODUCT = YES;
diff --git a/Example/SDWebImagePhotosPlugin.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/Example/SDWebImagePhotosPlugin.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>PreviewsEnabled</key>
+	<false/>
+</dict>
+</plist>
diff --git a/Example/SDWebImagePhotosPlugin/MasterViewController.m b/Example/SDWebImagePhotosPlugin/MasterViewController.m
@@ -125,10 +125,22 @@ - (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(N
     }
     
     cell.customTextLabel.text = [NSString stringWithFormat:@"Image #%ld", (long)indexPath.row];
+    SDWebImageMutableContext *context = [@{SDWebImageContextStoreCacheType : @(SDImageCacheTypeNone)} mutableCopy];
+    BOOL supportsHDR = NO;
+    if (@available(iOS 16.0, *)) {
+        supportsHDR = UIScreen.mainScreen.potentialEDRHeadroom > 1.0;
+    }
+    if (supportsHDR) {
+        if (@available(iOS 17.0, *)) {
+            cell.customImageView.preferredImageDynamicRange = UIImageDynamicRangeHigh; // Enable Image View Level control for HDR
+        }
+        context[SDWebImageContextPhotosRequestImageData] = @(YES); // Photos Library only load HDR info when requestImageData
+        context[SDWebImageContextImageDecodeToHDR] = @(YES); // When decoding HDR data, we need explicit enable HDR decoding
+    }
     [cell.customImageView sd_setImageWithURL:self.objects[indexPath.row]
                             placeholderImage:placeholderImage
                                      options:SDWebImageFromLoaderOnly
-                                     context:@{SDWebImageContextStoreCacheType : @(SDImageCacheTypeNone)}]; // Disable memory cache query/store
+                                     context:context]; // Disable memory cache query/store
     return cell;
 }
 
diff --git a/Example/SDWebImagePhotosPlugin/SDAppDelegate.m b/Example/SDWebImagePhotosPlugin/SDAppDelegate.m
@@ -8,6 +8,7 @@
 
 #import "SDAppDelegate.h"
 #import "MasterViewController.h"
+#import <SDWebImage/SDWebImage.h>
 
 @implementation SDAppDelegate
 
@@ -17,9 +18,14 @@ @implementation SDAppDelegate
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
 {
     // Override point for customization after application launch.
+    if (@available(iOS 14.0, *)) {
+        [SDImageCodersManager.sharedManager addCoder:SDImageAWebPCoder.sharedCoder];
+    }
+    if (@available(iOS 13.0, *)) {
+        [SDImageCodersManager.sharedManager addCoder:SDImageHEICCoder.sharedCoder];
+    }
     
     self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
-    // Override point for customization after application launch.
     
     MasterViewController *masterViewController = [[MasterViewController alloc] initWithNibName:@"MasterViewController" bundle:nil];
     self.navigationController = [[UINavigationController alloc] initWithRootViewController:masterViewController];
diff --git a/Example/SDWebImagePhotosPlugin_Example macOS/AppDelegate.m b/Example/SDWebImagePhotosPlugin_Example macOS/AppDelegate.m
@@ -7,6 +7,7 @@
 //
 
 #import "AppDelegate.h"
+#import <SDWebImage/SDWebImage.h>
 
 @interface AppDelegate ()
 
@@ -16,6 +17,10 @@ @implementation AppDelegate
 
 - (void)applicationDidFinishLaunching:(NSNotification *)aNotification {
     // Insert code here to initialize your application
+    if (@available(macOS 11.0, *)) {
+        [SDImageCodersManager.sharedManager addCoder:SDImageAWebPCoder.sharedCoder];
+    }
+    [SDImageCodersManager.sharedManager addCoder:SDImageHEICCoder.sharedCoder];
 }
 
 
diff --git a/Example/SDWebImagePhotosPlugin_Example macOS/ViewController.m b/Example/SDWebImagePhotosPlugin_Example macOS/ViewController.m
@@ -8,6 +8,7 @@
 
 #import "ViewController.h"
 #import <SDWebImagePhotosPlugin/SDWebImagePhotosPlugin.h>
+#import <SDWebImagePhotosPlugin/SDWebImagePhotosDefine.h>
 #import "TestCollectionViewItem.h"
 
 @interface ViewController () <NSCollectionViewDelegate, NSCollectionViewDataSource>
@@ -81,8 +82,18 @@ - (void)reloadData {
 - (NSCollectionViewItem *)collectionView:(NSCollectionView *)collectionView itemForRepresentedObjectAtIndexPath:(NSIndexPath *)indexPath {
     TestCollectionViewItem *cell = [collectionView makeItemWithIdentifier:@"TestCollectionViewItem" forIndexPath:indexPath];
     NSURL *photosURL = self.objects[indexPath.item];
+    BOOL supportsHDR = NSScreen.mainScreen.maximumPotentialExtendedDynamicRangeColorComponentValue > 1.0;
+    SDWebImageMutableContext *context = [@{SDWebImageContextStoreCacheType: @(SDImageCacheTypeNone)} mutableCopy];
+    if (supportsHDR) {
+        if (@available (macOS 14.0, *)) {
+            cell.imageViewDisplay.preferredImageDynamicRange = NSImageDynamicRangeHigh; // Enable Image View Level control for HDR
+        }
+        context[SDWebImageContextPhotosRequestImageData] = @(YES); // Photos Library only load HDR info when requestImageData
+        context[SDWebImageContextImageDecodeToHDR] = @(YES); // When decoding HDR data, we need explicit enable HDR decoding
+    }
+    cell.imageViewDisplay.animates = YES;
     cell.imageViewDisplay.sd_imageTransition = SDWebImageTransition.fadeTransition;
-    [cell.imageViewDisplay sd_setImageWithURL:photosURL placeholderImage:nil options:SDWebImageFromLoaderOnly context:@{SDWebImageContextStoreCacheType: @(SDImageCacheTypeNone)}];
+    [cell.imageViewDisplay sd_setImageWithURL:photosURL placeholderImage:nil options:SDWebImageFromLoaderOnly context:context];
     return cell;
 }
 
diff --git a/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.h b/SDWebImagePhotosPlugin/Classes/PHAsset+SDWebImagePhotosPlugin.h
@@ -11,7 +11,7 @@
 @interface PHAsset (SDWebImagePhotosPlugin)
 
 /// The convenience way to retrive the URL representation of PHAsset. The same as `+[NSURL sd_URLWithAsset:]`.
-/// @note This API always return new object in Objective-C/struct in Swift of URL.
+/// @note This API always create and return new object in Objective-C/struct in Swift of URL. (which does not store the URL inside PHAssets, to avoid retain cycle)
 @property (nonatomic, strong, readonly, nonnull) NSURL *sd_URLRepresentation;
 
 @end
diff --git a/SDWebImagePhotosPlugin/Classes/SDImagePhotosLoader.m b/SDWebImagePhotosPlugin/Classes/SDImagePhotosLoader.m
@@ -86,12 +86,14 @@ - (instancetype)init {
     return self;
 }
 
+#if SD_UIKIT
 - (void)didReceiveMemoryWarning:(NSNotification *)notification {
     for (SDImagePhotosLoaderOperation *operation in self.operationsTable) {
         [operation cancel];
     }
     [self.operationsTable removeAllObjects];
 }
+#endif
 
 #pragma mark - Helper
 + (BOOL)isAnimatedImageWithUTType:(NSString *)UTType {
@@ -156,11 +158,20 @@ - (BOOL)canRequestImageForURL:(NSURL *)url {
             NSString *localIdentifier = url.sd_assetLocalIdentifier;
             PHFetchResult<PHAsset *> *fetchResult = [PHAsset fetchAssetsWithLocalIdentifiers:@[localIdentifier] options:fetchOptions];
             asset = fetchResult.firstObject;
+            if (!asset) {
+                NSString *desc = [NSString stringWithFormat:@"Invalid PHAsset localIdentifier: %@", localIdentifier];
+                NSError *error = [NSError errorWithDomain:SDWebImagePhotosErrorDomain code:SDWebImagePhotosErrorInvalidLocalIdentifier userInfo:@{NSLocalizedDescriptionKey: desc}];
+                if (completedBlock) {
+                    completedBlock(nil, nil, error, YES);
+                }
+                return;
+            }
         }
         // Check whether we should request only image asset
-        if (!asset || (self.requestImageAssetOnly && asset.mediaType != PHAssetMediaTypeImage)) {
+        if (self.requestImageAssetOnly && asset.mediaType != PHAssetMediaTypeImage) {
             // Call error
-            NSError *error = [NSError errorWithDomain:SDWebImagePhotosErrorDomain code:SDWebImagePhotosErrorNotImageAsset userInfo:nil];
+            NSString *desc = [NSString stringWithFormat:@"Unsupported PHAsset localIdentifier: %d, PHAssetMediaType: %d", asset.localIdentifier, asset.mediaType];
+            NSError *error = [NSError errorWithDomain:SDWebImagePhotosErrorDomain code:SDWebImagePhotosErrorNotImageAsset userInfo:@{NSLocalizedDescriptionKey: desc}];
             if (completedBlock) {
                 completedBlock(nil, nil, error, YES);
             }
@@ -263,7 +274,7 @@ - (void)fetchImageWithAsset:(PHAsset *)asset operation:(SDImagePhotosLoaderOpera
     
     __weak typeof(operation) weakOperation = operation;
     PHImageRequestID requestID = [[PHImageManager defaultManager] requestImageForAsset:asset targetSize:targetSize contentMode:contentMode options:requestOptions resultHandler:^(UIImage * _Nullable result, NSDictionary * _Nullable info) {
-        if (weakOperation.isCancelled) {
+        if (weakOperation.isCancelled || [info[PHImageCancelledKey] boolValue]) {
             // Cancelled
             NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:nil];
             if (completedBlock) {
@@ -319,7 +330,7 @@ - (void)fetchImageDataWithAsset:(PHAsset *)asset operation:(SDImagePhotosLoaderO
     
     __weak typeof(operation) weakOperation = operation;
     PHImageRequestID requestID = [(id<PHImageManager>)[PHImageManager defaultManager] requestImageDataForAsset:asset options:requestOptions resultHandler:^(NSData * _Nullable imageData, NSString * _Nullable dataUTI, SDImageOrientation orientation, NSDictionary * _Nullable info) {
-        if (weakOperation.isCancelled) {
+        if (weakOperation.isCancelled || [info[PHImageCancelledKey] boolValue]) {
             // Cancelled
             NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorCancelled userInfo:nil];
             if (completedBlock) {
diff --git a/SDWebImagePhotosPlugin/Classes/SDWebImagePhotosError.h b/SDWebImagePhotosPlugin/Classes/SDWebImagePhotosError.h
@@ -10,9 +10,12 @@
 
 FOUNDATION_EXPORT NSErrorDomain const SDWebImagePhotosErrorDomain;
 
+/// The error domain for SDWebImagePhotosPlugin's NSError
 typedef NS_ERROR_ENUM(SDWebImagePhotosErrorDomain, SDWebImagePhotosError) {
     /// Photos framework access is not authorized by user
     SDWebImagePhotosErrorNotAuthorized = 10001,
     /// Photos URL is not image asset type (like Video or Audio)
-    SDWebImagePhotosErrorNotImageAsset = 10002
+    SDWebImagePhotosErrorNotImageAsset = 10002,
+    /// Photos local identifier failed to query PHAsset, is this valid ?
+    SDWebImagePhotosErrorInvalidLocalIdentifier = 10003
 };
