See all tickets marked for the 5.12.5 release
- Workaround iOS 15+ force decode again using Image Renderer(preferred) and RGB888 #3334
See all tickets marked for the 5.12.4 release
- Fix imageView blinks with option
SDImageCacheQueryDiskDataSync
#3327 - Workaround the iOS 15+ Force Decode may return black image because of CoreGraphics #3332
See all tickets marked for the 5.12.3 release
- Fix #3320 decodedAndScaledDownImageWithImage does not render the image completely #3321 Thanks @ty0x2333
See all tickets marked for the 5.12.2 release
- Eliminates accumulated floating point errors. #3312
- Don't copy image data for incremental decoding. #3304
See all tickets marked for the 5.12.1 release
- Fix ProMotion display issues #3280
- Add tvos check when use targetTimestamp in displaylink #3286
- Revert "Fix image source release in iOS 15" in 5.12.0 #3281
- Since UTI is an standard, we can use it directly to avoid warning on iOS 15
- Fix test error #3283
- Port travis configuration to github actions #3285
See all tickets marked for the 5.12.0 release
- Do a extra memory cache sync when weak cache feature enabled && Change the default value for shouldUseWeakMemoryCache to NO #3239
- Fix imageFromCacheForKey with options and context behavior, matching the async version one. #3238
- Feature: allow user to custom acceptable status code and content type #3227
- Change the default delegate method to allows optional cert in SSL verify, matches URLSession's behavior #3241
- Added sd_imageFrameCount convenient API for UIAinmatedImage/NSBitmapImageRep #3243
- Make SDAnimatedImageRep confirms to correct copy semantic #3258
- Fix image source release in iOS 15 #3276
- Fix wrong memory cost in _UIAnimatedImage #3237
- Fix pixel ratio thumbnail calculation #3277
- Fix the warning, enable APPLICATION_EXTENSION_API_ONLY for all framework target #3236
See all tickets marked for the 5.11.1 release
- Change the .originalStoreCaheType and .originalQueryCacheType into .disk, Now we will store the full image data into disk and re-query the full image data by default #3219
- Change the willTerminate auto clean cache logic into sync version #3210
- Fix the bug that when querying original cache miss, the download process will be skipped. This is not designed behavior #3221
- Ensure the invalid URLSeesion will receive the cancel callback and does not trigger the any exception from framework #3205
- Fix spelling error in SDWebImageDownloaderOperation #3220
See all tickets marked for the 5.11.0 release
- Added the new context option SDWebImageContextOriginalImageCache, which control the cache instance used for original full size image query/write when using transformer #3184
- Increase progressive decoding performance by using the progressive decoder's result instead of re-decoding the full image data #3182
- Avoid the strong retain during download decoding, this can make the download operation fast to destroy and reduce memory peak, especially in progressive decoding #3183
- Don't encode/decode image when app will terminated #3149
See all tickets marked for the 5.10.4 release
- Don't unnecessarily copy image data in the Download Operation #3167
See all tickets marked for the 5.10.3 release
- Fixed the store cache type was specified to
SDImageCacheTypeDisk
that pictures shouldn't cache to memory. #3157
See all tickets marked for the 5.10.2 release
- Fix the case that we setFinished=YES before NSOperation started. This may cause exception from Foundation #3146
See all tickets marked for the 5.10.1 release
- Fix the race condition when user cancel the network loading will not trigger the completion block #3142
- Fix deprecation warnings for OSSpinLock #3137
See all tickets marked for the 5.10.0 release
- Bumped the min deployment target version to iOS 9, macOS 10.11. Bumped the min Xcode version to Xcode 11 #3130
- This effect the downstream dependencies like SDWebImageWebPCoder, you may update them to the latest version at the same time.
- Add animation playback mode for SDAnimatedImageView/Player, including reverse, bounce and reversed bounce #3115
- Added the options and context arg for Image Loader custom protocol, this can be used for advanced user to grab and check for context for current loading URL to process the logic #3129
- Replace all current dispatch_semaphore usage into the os_unfair_lock, use OSSpinLock for lower firmware #3128
See all tickets marked for the 5.9.5 release
- Add animationImages support when using SDAnimatedImageView #3113
See all tickets marked for the 5.9.4 release
- Fix race condition when using transitions that are canceled and then switched to a new transition or load operation #3108 #3107
- Fixed the store cache type was specified to
SDImageCacheTypeDisk
that no pictures were obtained when the disk had pictures #3110
See all tickets marked for the 5.9.3 release
- Fix coder priority inverse in SDAnimatedImage #3101
- Fix that SDImageCache will automatically store the disk image into memory cache even if store cache type is disk #3104
See all tickets marked for the 5.9.2 release
- Fix the issue that SDAnimatedImageView will trigger an empty callback when animation stopped. This will cause some bad effect such as rendering a empty image or placeholder image (especially on iOS 14) #3092
- Fix:
duration
is not used in SDWebImageTransition convenience initializers. #3094
See all tickets marked for the 5.9.1 release
- Fix the issue of SDAnimatedImage initWithContentsOfFile where the path name less than 3 characters #3081
See all tickets marked for the 5.9.0 release
- Supports built-in WebP/AWebP codec from ImageIO for iOS 14/tvOS 14/macOS 11/watchOS 7 #3048
- To use, add
SDImageAWebPCoder
to your coders manager. Note built-in WebP currently supports decoding only, for encoding, you still needSDImageWebPCoder
- Add the support to pass small bytes to
decodedAndScaledDownLargeImage
, which always scale down (at least 1x1 pixel) but not return the original size #3067
- Supports the user to customize the default disk cache directory, which can be used to share cache for App && App Extension #3066
- Adjust the current behavior to use transition. Now it automatically do transition when manager callback asynchronously (if user see waiting, then do transition) #3074
- Fix the bug when the thumbnail pixel size is larger than the pixel size, and the image has EXIF orientation, the final UIImage will use wrong image orientation #3070
- Fix the image format detection for smaller SVG which less than 100 Bytes #3072
See all tickets marked for the 5.8.4 release
- Try to copy the local NSMutableDictionary before calling CGImageSourceCreateImageAtIndex, try to solve the rare crash inside ImageIO call stack #3052
- Fix race condition when use transition but canceling an operation #3053
See all tickets marked for the 5.8.3 release
- Add the support for that UIImage+MultiFormat methods on SDAnimatedImage, which supports encoding the animation like GIF/APNG/WebP with lower compression quality #3047
- Fix the issue of iOS 14 vector image rendering on SDAnimatedImageView #3046
See all tickets marked for the 5.8.2 release
- Fix the issue that SDAnimatedImageView can not render static image on iOS 14. #3043
- Fix the
maxPixelSize
logic issue will cause a upscale in SDImageIOAnimatedCoder #3039
See all tickets marked for the 5.8.1 release
- Added the convenient transition with duration APIs #3027
- Fix the issue that the NSURLRequest method should not be nil, which may cause Crash #3037
- Fix the issue when
maxPixelSize
is larger than image size will cause a upscale in ImageIO #3015 - Change to use
kCGImageSourceCreateThumbnailFromImageAlways
to solve the issue when HEIC/JPEG contains an embed thumbnail but its size is much smaller than providedmaxPixelSize
#3038 - SDAnimatedImagePlayer seek returning nil image fix #3030
- Fixing Typos throughout project #3026
See all tickets marked for the 5.8.0 release
- Add query original cache for transformed image without downloading #2992
- This can be used to query the original image from cache then do transforming when transformed key cache miss, without any downloading happened.
- Added autoplay control property to AnimatedImageView (autoPlayAnimatedImage) #3003
- Mark the black list formal error code, support remove the failed URL from black list #2997
- Polish the error description between image decode failed and image size is 0 #3005
- Add the convenient request/response modifier, which provide HTTP header directly #2990
- Added the convenient transition options for macOS user. Deprecate the old timingFunction, which can use System API to achieve #2985
- Feature pass the set operation key into context option from upstream. Fix the potential retain cycle if user use custom manager #2986
- Feature: Encoding options supports embed thumbnail (works for JPEG/HEIF/AVIF) #2988
- Support the SwiftPM Objective-C user to use
#improt <SDWebImage/SDWebImage.h>
#2987
See all tickets marked for the 5.7.4 release
- Fix the issue that NSOperation conforms to
SDWebImageOperation
check failed. Fix cancelling prefetcher hung up #2999 #2998
See all tickets marked for the 5.7.3 release
- Fix the encoding options which does not passthrough the correct value to ImageIO #2989
See all tickets marked for the 5.7.2 release
- SDAnimatedImageView animation rendering should not use CGContext force decoding, use
kCGImageSourceShouldCacheImmediately
instead which can avoid OOM for large number of GIFs #2977 - Fix that when first play animated image and use maxBufferSize to 0, the calculation does not works (The CGImage is nil) #2982
- Rename the private header
UIColor+HexString
andNSBezierPath+SDRoundedCorners
with SD prefix, to avoid the conflict when using CocoaPods #2983
See all tickets marked for the 5.7.1 release
- Don't copy attributes from originalImage to transformedImage when caching transformedImage #2976. Thanks @bdaz
- Fix the wrong value assignment for SDAnimatedImageView code on macOS, warning #2974
See all tickets marked for the 5.7.0 release
- Added the async version API to query disk image data only
- Added the sync API to query disk image with context and options, which matches the async version
- Feature supports encoding options like max file size, max pixel size, as well as background color when using JPEG for alpha image #2972
- You can use
.encodeMaxFileSize
to limit the desired lossy file size, better than compression quality - You can use
.encodeMaxPixelSize
to limit the pixel size, like thumbnail encoding
- Refactory the current thumbnail && transformer about cache key. Developer should have the API to calculate the cache key from thumbnail or transformer, not hard-coded. #2966
- Added new query cache type support, including the SDImageCache API and context option #2968
- You use
.queryCacheType
to query image from memory/disk/both cache during image pipeline loading
- Fix the issue for Carthage/SwiftPM framework version symbols, this should match the framework name SDWebImage, or will get a link error when used #2971 #2969
- Simplify the xattr helper method's code with modern Objective-C syntax #2967. Thanks @huangboju
- Change the behavior to return the abstract type for unknown image format, this can solve the accident issue for custom coder who provide a new format #2973
See all tickets marked for the 5.6.1 release
- Keep the progressive decoding process only exist one per image download. Cancel the unused progressive decoding when full pixel data is available. #2483
- Fix the NotificationCenter does not remove the observer and little private header garden #2959
See all tickets marked for the 5.6.0 release
- Added the URLSessionTaskMetrics support for downloader && operation, which can be used for network metrics #2937
- Typically you use custom operation class to collect all metrics in your app. You can also collect metrics for single url request level. Check the #2937 example code to grab the download token and check metrics.
- Feature - better support for vector format detection, now PDF rasterized bitmap is built-in #2936
- Pass
.thumbnailPixelSize
to control the PDF bitmap size. If you want vector PDF rendering, you still need to use SDWebImagePDFCoder. - Vector image like SVG (via SDWebImageSVGCoder) and PDF (via SDWebImagePDFCoder), or system symbol images, can be detected by new API
sd_isVector
. - Vector image does not pass to transformer by default, because they support dynamic size changing. Pass
.transformVectorImage
option to allow transformation.
- Add a better check to handle the cases when call
storeImage
without imageData #2953 - Which means, if you store image to disk without data, we will use extra information via
sd_imageFormat
or custom image class, to choose the the image format (including GIF and PDF) for encoding. Previously we only encode it into PNG or JPEG.
- Feature add context option for cache, loader and coder, deprecated SDWebImageContextCustomManager #2955
- This makes it easy to use custom loader, cache, and decoder, without need to create a dummy SDWebImageManager instance.
- Fix the rare case when call
SDWebImageDownloaderOperation.cancel
, the completion block may callback twice #2954
- Suppress the deprecation warning when min deployment target version set to iOS 13+ or macCatalyst
- Complete all the SDWebImage error code with the localized description, make it easy for debugging #2948
See all tickets marked for the 5.5.2 release
- Fix the issue that
maxBufferSize
property does not correctly works forSDAnimatedImageView
#2934
See all tickets marked for the 5.5.1 release
- Fix the SDAnimatedImageView's progressive animation bug, which reset the frame index to 0 each time new frames available #2931
See all tickets marked for the 5.5.0 release
- Supports to load the large web image with thumbnail, control the limit size and aspect ratio #2922 #2810
- Better than resize transformer, which does not allocate full pixel RAM and faster on CPU. If you've already use transformer to generate thumbnail, you'd better have a try
- Works for both animated images and progressive images, each frame using the thumbnail decoding
- Applies for Vector Format like SVG/PDF as well, see more in Coder Plugin List
- Support all transformer method on CIImage based UIImage/NSImage #2918
- For CIImage based UIImage/NSImage, using the CIFilter to take shortcut, which is faster and lazy (rasterize on demand)
- Support to use the creation date and the change date to determine the disk cache expire date compare #2915
- Using UIGraphicsImageRenderer on iOS 10+, save memory when image bitmap is RGB(-25%) or Grayscale(-75%) #2907
- Provide the polyfill APIs for firmware iOS 10- and macOS. If you already use
SDGraphicsBeginImageContext
for drawing, you'd better replace that instead.
- Fix Gaussian Blur's bug which take half of the blur radius compared to the standard, should match Core Image's behavior #2927
See all tickets marked for the 5.4.3 release
- Fix the SDAnimatedImageView's progressive animation bug, which reset the frame index to 0 each time new frames available #2931
See all tickets marked for the 5.4.2 release
- SDAnimatedImage now only keep the animated coder when frame count >=1 , else we will behave like UIImage to save RAM usage #2924
See all tickets marked for the 5.4.1 release
- Fix the issue that "There may be no complete callback when download the picture of the local path" #2917
See all tickets marked for the 5.4.0 release
- Allows advanced user to read/write extended metadata associated with image data from disk cache #2898
- This metadata will be processed at the same time when store or query the image. The metadata should conforms to
NSCoding
for archive and unarchive.
- Add
SDWebImageWaitStoreCache
, which wait for all the async disk cache written finished and then callback, useful for advanced user who want to touch the cache right in completion block #2900
- Using one global function to ensure we always sync all the UIImage category associated object status correctly inside our framework #2902
- Fix the thread safe issue with Downloader and DownloaderOperation during cancel #2903
See all tickets marked for the 5.3.4 release
- Fix the SDAnimatedImageView's progressive animation bug, which reset the frame index to 0 each time new frames available #2931
See all tickets marked for the 5.3.3 release
- Fix the crash when using NSCache delegate with SDMemoryCache default implementation on dealloc #2899
See all tickets marked for the 5.3.2 release
- Fix animated image playback bugs that cause rendering frame is previous frame index #2895. Thanks @ZXIOU
See all tickets marked for the 5.3.1 release
- Fix the case even when Animated Image View is not visible, user call startAnimating can still do animation #2888
See all tickets marked for the 5.3.0 release
- Refactoring the SDAnimatedImageView with player backend called
SDAnimatedImagePlayer
, make it easier for common usage. #2882 - The player use protocol based implementation, which can be used for many scenarios, like WatchKit, CALayer, or even SwiftUI. See wiki
- Supports the control of AnimatedImage View/Player 's play rate #2885
- Supports the runloop mode control for macOS. Which can be useful when user want to pause animation when drag the mouse, or presenting modal window #2886
- Decrypt the encrypted image data after download and just before decoding. #2866
- Provide a built-in convenience for Base64-encoded image data. See wiki
- Modify the HTTP response after download, paired with request modifier #2866
- Can be used for custom HTTP header check, mock data, etc. See wiki
See all tickets marked for the 5.2.5 release
- Fix macOS SDWebImageIndicator center layout issue when indicator was initialized with 0 frame #2875
See all tickets marked for the 5.2.4 release
- Fix the regression issue that SDAnimatedImageView on macOS will change the wrong duration speed when pause and resume again #2873
- Fix SDAnimatedImage on macOS use extra animates property check, which is not intuitive and cause extra setup before usage #2874
See all tickets marked for the 5.2.3 release
- Revert the change for APNG constants fix for iOS 8 devices which cause crash #2863
See all tickets marked for the 5.2.2 release
- Fix warnings when deployment target version set to iOS 13+ #2860 #2859
See all tickets marked for the 5.2.1 release
- Make the SDWebImageDownloadToken to not retain the completion block so that user don't need weak-strong dance #2856 #2855
- Try to fix the test case
test15DownloaderLIFOExecutionOrder
#2857
See all tickets marked for the 5.2.0 release
- Full compatible with Catalyst (UIKit for macOS)
- Supports CococaPods and SwiftPM only. Carthage need their own toolchain upgrade in the future
- Provide the build script to build xcframework contains Mac Catalyst variant, see Installation Guide.
- Supports HEIC sequence (animated) image on iOS 13/macOS 10.15+ #2849
- Note the HEIC animated coder does not enable by default. Add
SDImageHEICCoder
if you need the animation.
- Note the HEIC animated coder does not enable by default. Add
- Refactor APNG and GIF coder implementation with abstract base class #2846
- Now we use
SDImageIOAnimatedCoder
base class for all animated Image/IO coder implementation. Developer can get use of this as well.
- Now we use
- Support to clear frame buffer or reset frame index when stopped for SDAnimatedImageView #2815
- Fix the downloader LIFO order inverse issue when adding new urls during previous url query #2852 #2823
- Fix the macOS SDAnimatedImageRep to match Netscape standard of GIF loop count, which should use 1 when there are no loop count information #2847 #2155
See all tickets marked for the 5.1.1 release
- Fix that some option mask check with local BOOL variable, error result on 32 bit device. #2819 #2817
- Fix the macOS that SDAnimatedImageView does not works for imageScaling and imageAlignment properties #2820
- Fix the case when SDAnimatedImageView dealloc on the fetch queue, will cause it trigger the UIKit/AppKit method on non-main queue and captured by UI Main Thread Checker #2825
See all tickets marked for the 5.1.0 release
- Add support for Swift Package Manager #2756
- Supports global control on options and context for individual image request #2736
- Supports store original image to cache for transformer via
SDWebImageContextOriginalStoreCacheType
#2590 - Add a new option
SDWebImageMatchAnimatedImageClass
, to ensure we always match the custom image class instead of UIImage/NSImage class #2801
- Expose the memoryCache and diskCache object on
SDImageCache
, Make it useful for user who have custom property beyondSDImageCacheConfig
#2779
- Fix SDAnimatedImageView's frame buffer bug when display link is pause #2782
- Fix the bug that UIButton setBackgroundImage convenient method does not pass the options arg to next function call #2785
- Add a autoreleasepool when prefetch many images #2792
- Feature supports dynamic style indicator for iOS 13, fix indicator color on macOS 10.14+ #2753
- Fix for CocoaPods modular headers warning by removing the custom modulemap #2749
- Follow App Store submit rule, upgrade the minimum Xcode version to Xcode 10.0 #2780
- Provide a script target to directly build all SDWebImage framework and generate all in one XCFramework from Xcode 11 #2764
- Ensure we always callback user's completion block even when cancelled with
SDWebImageErrorCancelled
error code #2692
This may effect some users. In previous 4.0~5.0 version, we will not callback completion block when we receive cancel
call. (including all View Category/Cache/Manager/Downloader APIs)
But from 5.1, we always callback on this case with error code SDWebImageErrorCancelled
. You can filter this error code if you don't care about cancel.
This change makes usages like Dispatch Group, observer, or any logic which relay on the completion's callback become acceptable, which is not reliable and will cause issue in previous versions.
- Change that the
sd_imageProgress
property to not auto-create instance by framework #2763
Now, we don't create the NSProgress object from internal method call, this does not affect user's KVO usage.
- Change the default value of accept request header #2772
Now, the default HTTP header filed Accept
, use image/*,*/*;q=0.8
, instead of image/*;q=0.8
.
See all tickets marked for the 5.0.6 release
- Fix the SDAnimatedImageRep which use the deprecated API and cause compile issue on Xcode 11 #2745
See all tickets marked for the 5.0.5 release
- Fix the Static Library target issue of headers, which cause the integrated application failed to Archive because of copied headers #2741
See all tickets marked for the 5.0.4 release
- Fix get button background image operation key bug #2737
- Fix that
CGImageDestinationCreateWithData
0 count arg will log a warning #2739
- Fix the example NSLog issue, and replace the unavailable test image dataset #2740
See all tickets marked for the 5.0.3 release
- Fix SDWebImageDecodeFirstFrameOnly flag is ignored when image loaded from cache #2725
- Fix that SDAnimatedImageView initWithImage will skip the initialize logic and crash #2728
- Replace if judge with MAX() function in scale less than 1 #2710
- Replace the private prefix header files with the manually import for each implementation files #2723
- Added many test case to ensure the code behavior and coverage #2711
- Update the documentation coverage for jazzy. Use the correct format to provide class/protocol/type API Documentation #2722
See all tickets marked for the 5.0.2 release
- Fix the bug of SDAnimatedImageView on macOS, which can only render
SDAnimatedImage
but not normal NSImage (including animated image) #2706 - Fix that
CGImageCreateDecoded:orientation:
use the wrong aspect ratio when orientation is left/leftMirrored/right/rightMirrored #2708 - Fix one bug of sd_colorAtPoint:, which set the alpha value default to 255 and should be 1. #2708
- Fixes typo in SDImageCacheConfig maxDiskAge info #2699
See all tickets marked for the 5.0.1 release
- Fixes crash for apng coder when properties are nil #2691
- Fix rounded corner bug which leads to image upside down #2673
- Fix tint image bug which leads to image upside down #2674
- Fix the Travis-CI script about code coverage submit #2676
See all tickets marked for the 5.0.0 release
- Introduce
SDAnimatedImageView
andSDAnimatedImage
for full stack solution of animated images. - Supports custom coders for nearly every animated image format.
- Supports progressive loading for animated images.
- iOS/tvOS/macOS cross-platform support.
- Using transformer to apply image processing after image was loaded.
- Built-in transformer for common usage: Rounded Corner, Resize, Crop, Flip, Rotate, Tint Color, Blur Effect, Core Image Filter...
- Convenient category methods for
UIImage
/NSImage
- Using
SDImageLoader
protocol to implements your own image loader. - Not limited on HTTP, you can even using SDWebImage with PhotoKit and third-party SDKs.
- Supports multiple loaders at the same time when using
SDImageLoadersManager
.
- Using
SDImageCache
protocol to implement your own image cache. - Standalone disk cache and memory cache class for advanced usage and customization.
- Supports multiple caches at the same time when using
SDImageCachesManager
.
- Use indicator to provide a loading view, customizable.
- Built-in Activity Indicator and Progress Indicator.
- iOS/tvOS/macOS cross-platform support.
- All external image format coders are plugins. Supports WebP, HEIF, BPG, FLIF, SVG, PDF... Choose what you need in: Coder Plugin List
- PhotoKit loader as a plugin: SDWebImagePhotosPlugin
- FLAnimatedImage integration as a plugin: SDWebImageFLPlugin
- YYImage/YYCache integration as a plugin: SDWebImageYYPlugin
- Better Swift support with some manual renaming APIs.
- Full nullability annotation.
- Using class property for shared instance.
- Using
NS_TYPED_ENUM
andNS_STRING_ENUM
for better generated APIs.
- Using context option to control detail behavior for each image request beyond the limit of enums.
- Using prefetcher to manage token (list of URL requests) to avoid conflict.
- Use request modifier to modify constructed URLRequest.
- Supports the latest Xcode 10.
- Supports iOS 8.0+/tvOS 9.0+/watchOS 2.0+/macOS 10.10+.
- MapKit support for Carthage moved the standalone
SDWebImageMapKit
target. - Using module map and umbrella headers.
Check 5.0 migration guide for the migration from 4.x to 5.x.
See all tickets marked for the 5.0.0-beta6 release
- Fix the issue that SDWebImagePrefetch in 5.x, will submit all prefetch URLs to manager without any concurrent limit #2631
- Fix the current transformer cache key generating rules, try to keep the image file extension #2635
- Move some internal classes into private header files, make it easy to maintain the code #2634
See all tickets marked for the 4.4.6 release
- Fix the unused user header search path warning for CocoaPods 1.6.0. #2622
- Fix that WebP with custom ICC Profile will randomly crash, because
CGColorSpaceCreateWithICCProfile
does not copy the ICC data pointer #2621 - Fix the issue when WebP contains the ICC Profile with colorSpace other than RGB, which cause the CGImageCreate failed #2627
- Update the libwebp dependency to support using 1.0 version and above #2625
- Nil imageData before decode process to free memory #2624
See all tickets marked for the 5.0.0-beta5 release
- Fix encoding options does not works #2602
- Remove unnecessary CGImage check when encode first frame #2609
See all tickets marked for the 4.4.5 release
- Revert the modular framework, try to fix some user's install issue when using SDWebImage in prefix header #2604
- Fix wrong decompression scale calculation #2608
- Fix shouldDecode check when image format is GIF #2606
- Fix modify data pointer if webp image scaled down #2607
See all tickets marked for the 5.0.0 release
- Expose the graphics helper method for coder plugin author and fix scale issue #2523
- Decrease animated decode times when cache enable #2468
- Remove kCGImageSourceShouldCache option when creating image source #2472
- Add autoreleasepool to release autorelease objects in advance when using GCD #2474
- Add protect when custom animated image class image data is nil during progressive animation check #2466
- Fix background download #2500
- Merged targets + MapKit dedicated target for Carthage installs #2476. Carthage user now does not enable MapKit support by default.
- Upgrade Xcode 10 + using xcconfig for project settings #2494
Behavior:
- Move webp component (and libwebp dependency) to SDWebImage/SDWebImageWebPCoder #2469. Any user who use WebP in 5.0.0 should add SDWebImageWebPCoder to your Podfile or Cartfile instead.
- Refactory cache path about namespace && final cache directory #2535. Now the default disk cache path was moved to suitable path with the namespace.
- Use the memory bytes size, instead of pixel size to calculate the memory cost function #2568. Now the memory cost function use bytes size instead of pixels count.
Swift Only:
- Fix the accident changes of Swift API naming for
sd_imageDataAsFormat:
#2517
You can always check 5.0 migration guide for the latest information for these changes.
See all tickets marked for the 5.0.0 release
- Minimum progress interval config for
SDWebImageDownloader
#2415 #2437 1d8454d - Feature disk cache migration from 4.x #2417 #2433
- Add
SDImageFormatHEIF
representmif1
&&msf1
brands #2423 (imported from 4.4.3) - Add default
HTTP User-Agent
for specific system #2409 (imported from 4.4.3) - Replace
valueForKey
withobjectForKey
when access NSDictionary #2399 - Improved unit tests #2438 #2434
- Enhanced contributing guide #2416
- Adopt all the protocol APIs which contains getter value to use property instead, to make the API easy to use or Swift user #2452
- Remove
sd_setAnimationImagesWithURLs
API, because its cause ambiguity, behave not consistently and have rare use case #2459 - Improved
SDAnimatedImage
protocol withinitWithData:scale:options:
#2453 - Extra args for
SDSetImageBlock
(addedcacheType
andimageURL
) #2449
- Fix that using
NS_TYPED_ENUM
onSDImageFormat
cause the existing Swift API (sd_UTTypeFromImageFormat
) naming changed #2413 - Fix that downloader options about image decoding is not correctly set #2414
- Make download receive response notification only dispatch to specific observer #2426
- Fix a race condition during progressive animation load in
SDAnimatedImageView
#2435 - Fix the bug that
SDWebImageContextCacheKeyFilter
wrongly be used as cache serializer and cause crash #2451 - Fix resource key invalid when clean cached disk file #2462
- Add no expiration file support of disk cache #2461
See all tickets marked for the 5.0.0 release
- Add
SDImageCoderWebImageContext
coder option, which allow custom coder plugin, to receive the context option from top-level API #2405 - Updated all existing diagrams for 5.0 release + added new ones (small detailed diagrams for the most important components) #2407
- Fix nullable key for
sd_imageLoadOperationForKey
#2389 - Replace
__bridge_transfer
with__bridge
when convert fromCFStringRef
toNSString
#2392 - Rename
sd_UTTypeFromSDImageFormat
tosd_UTTypeFromImageFormat
#2395 - Change
SDImageFormat
to useNS_TYPED_EXTENSIBLE_ENUM
instead of fixed enum, to allow custom coder plugins to extend it #2400
See all tickets marked for the 4.4.4 release
- Fix memory cache image cost miscalculation for 4.x #2486
- Fix background download for 4.x #2570
- Fix race condition for creation of download operation when isCancelled is YES but isFinished is NO #2574
- Fix the current image cost (pixels) for FLAnimatedImage #2558
- Fix the FLAnimatedImage compatible code issue by introduce a private API #2588
- Fix that WebP image with ICC Profile does not show color correctly, should use the profile colorspace instead of device colorspace #2585
- Fix potential memory leaks for ICCP && optimize ICCP handler #2596
- Fix that WebP decoder in master branch, does not consider the global
shouldDecompressImages
config and always do pre-draw for static WebP images #2592 - Fix rare crash when NSMapTable empty keys #2556
- Retain operation when post download related notifications (Hopefully fix, but if you face crash, please open a issue) #2576
- Prioritize SDWebImageDownloaderHighPriority if operation already exists #2575
- Let SD can be imported using static library by CocoaPods using
DEFINES_MODULE
#2549
See all tickets marked for the 4.4.3 release
- Revert the hack code for
FLAnimatedImage
, because of theFLAnimatedImage
initializer method blocks the main queue #2441 - Fix extention long length of file name #2516 6c6d848
- Fix resource key invalid when clean cached disk file #2463
- Fix the test case
testFLAnimatedImageViewSetImageWithURL
because of remote resource is not available #2450 - Add default
HTTP User-Agent
for specific system #2409 - Add
SDImageFormatHEIF
representmif1
&&msf1
brands #2423 - remove
addProgressCallback
, addcreateDownloaderOperationWithUrl
#2336 - Fix the bug when
FLAnimatedImageView
firstly show one EXIF rotation JPEGUIImage
, later animated GIFFLAnimatedImage
will also be rotated #2406 - Replace
SDWebImageDownloaderOperation
withNSOperation<SDWebImageDownloaderOperationInterface>
to make generic #2397 - Fix wrong image cache type when disk and memory cache missed #2529
- Fix FLAnimatedImage version check issue for custom property
optimalFrameCacheSize
&&predrawingEnabled
#2543
- Add autoreleasepool to release autorelease objects in advance when using GCD for 4.x #2475
- Optimize when scale = 1 #2520
- Updated URLs after project was transfered to SDWebImage organization #2510 f9d05d9
- Tidy up spacing for
README.md
#2511 - Remove versioneye from README #2424
See all tickets marked for the 4.4.2 release
- Ability to change the clear cache option
SDImageCacheConfig.diskCacheExpireType
#2357 - Add option to enable or disable weak memory cache for
SDImageCache
viaSDImageCacheConfig.shouldUseWeakMemoryCache
#2379 - Add cache control for
FLAnimatedImage
, this allow user to disable memory cache for associatedFLAnimatedImage
instance #2378 - Add
diskImageDataForKey:
sync API forSDImageCache
to directly get the image data from disk #2391
SDWebImageManager.runningOperations
type changed fromArray
toSet
#2382- Keep the information about image's original compressed format #2390
- Fix
FLAnimatedImageView+WebCache
delayed draw due to #2047 which is now reverted #2393 - Check for nullable key when cancel image load operation #2386
- Replace
__bridge_transfer
with__bridge
when convert fromCFStringRef
toNSString
#2394
See all tickets marked for the 5.0.0 release
- the new requirements are iOS 8.0+ and macOS 10.10+ #2147
- Xcode 9+
See the 5.0 Migration Guide for a list of comprehensive changes and the way to update your code
-
Introduce
SDAnimatedImageView
,SDAnimatedImage
and refactor the way we handle animated images #2140 -
Added APNG support via dedicated coder
SDImageAPNGCoder
#2149 -
Refactored
SDWebImageDownloader
configs, separated them into a dedicatedSDWebImageDownloaderConfig
object #2263 -
Refactored the way we work with the scale factor #2266
-
Created request and response modifier #2261
-
Refactor Cache Path API #2276
-
Refactor custom cache serializer & headers filter for request level #2280
-
Refactor cache - Support custom memory cache & disk cache #2282
-
Refactor cache - Support custom web cache #2278
-
Refactor - custom image loader - Supports loader protocol #2256
-
Use
SDWebImageAvoidDecodeImage
to allow user to control force decode feature for individual image request #2283 -
SDImageCache
supports disk cache writing options. SeeSDImageCacheConfig diskCacheWritingOptions
#2148 -
SDImageCache
now usesNSData writeToFile:options:error
instead ofNSFileManager createFileAtPath:contents:attributes
#2148 -
Moved
SDImageCache maxMemoryCost
andSDImageCache maxMemoryCountLimit
toSDImageCacheConfig
#2151 -
Added
SDImageCache diskImageDataExistsWithKey:
synchronous method #2151 -
Moved
UIImage sd_imageLoopCount
andUIImage isGIF
(and renamed tosd_isAnimated
) toUIImage+Metadata
category, removed the outdated methods #2152 -
Move context and other type definitions to a separate header (
SDWebImageDefine
) to allow to be included without dependency #2188 -
Pass
context
arg from the top level APIs to the bottom level APIs to allow specify logic in the future #2189 d6a3e2c c24c3d3 -
Refactor the image indicator by creating
SDWebImageIndicator
andSDWebImageProgressIndicator
protocols and two concrete classes that implement activity and progress indicators for both UIKit and AppKit #2185 46b62cf -
Refactor the implementation of
SDWebImagePrefetcher
so it behaves more like a "shared instance" object, similar to other platform classes. Each instance will manage its own list of urls. #2191 1efc247 92f3d2c bc164d6 -
Refactored and enhanced the way we allow image transformations. Switched from a single delegate method to composition of
SDImageTransformer
#2219 -
API style refactoring - #2250
- Use property instead of setters and getters to make the property available in Swift
- Use class property with the correct name instead of
+(instanceType)sharedInstance
in singleton to make it more easy to use in Swift. The generated interface should be simpleopen class var shared { get }
- Add all nullability annotation to avoid any
AnyObject!
implicitly unwrapped optionals (Except thatnull_resettable
) - Add all Core Foundation Ownership using
CF_RETURNS_RETAINED
for Get Rule andCF_RETURNS_NOT_RETAINED
for Create Rule to avoid anyUnmanaged
CF value - Change all key for Dictionary with
NS_STRING_ENUM
to make it easy to use in Swift with dot syntax - Change all global value type which represent enum with
NS_TYPED_ENUM
to make it easy to use in Swift with dot syntax
-
Remove the extra calculation of image orientation for ImageIO coder & Fix macOS image orientation #2271
-
Added
SDWebImageError
(defined asNS_ERROR_ENUM
) to group all our errors together #2290 -
Added tests for macOS
-
Add the
SDWebImageContextStoreCacheType
context option to specify target cache type when the image is downloaded by manager and will store to cache #2360 -
Feature watchOS
WKInterfaceImage
withsd_setImageWithURL
#2331 -
Add options to specify query cache sync/async behavior #2312
SDWebImageManager loadImageWithURL:options:progress:completed:
changed thecompleted
param requirement fromnullable
tononnull
#2164
See all tickets marked for the 4.4.1 release
- Coder
- Fix that WebP (including Animated WebP) decoding issue on iOS 12 #2348 #2347
- Downloader
- Fix that the downloader operation may not call the completion block when requesting the same image url in race condition #2346 #2344
See all tickets marked for the 4.4.0 release
- View Category
- Add the support for watchOS to use View Category method (
sd_setImageWithURL:
) on WKInterfaceImage #2343 - Add optimalFrameCacheSize && predrawingEnabled options for FLAnimatedImage #2323
- Add the support for watchOS to use View Category method (
- Cache
- Add
SDImageCacheScaleDownLargeImages
to allow cache to scale down large images if need #2281 #2273
- Add
- View Category
- Add
UIViewAnimationOptionAllowUserInteraction
as default options for convenient image transition #2315
- Add
- Manager
- Replace
@synchronized
with dispatch_semaphore_t in SDWebImageManager #2340
- Replace
- Coder
- Remove the extra calculation of image orientation for ImageIO coder #2313
- Remove the duplicated process to force decode (draw on bitmap context) in Image/IO's progressive decoding #2314
- Common
- Minor optimize for dispatch_queue_async_safe #2329
- Coder
- Fix that force decode not works for alpha-channel images #2272 #2297
- Fix WebP Encoding only works for RGBA8888 CGImage but not other color mode #2318
- Fix the thread-safe issue for coders manager #2274 #2249 #1484
- Fix the wrong declaration of NSArray generics #2260
- Fix function storeImageDataToDisk description #2301
See all tickets marked for the 4.3.3 release
- Manager
- Add cacheSerializer to allow user provide modified version of data when storing the disk cache in SDWebImageManager #2245
- Add a delegate method to control the custom logic when blocking the failed url #2246
- Project
- Enable CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF and fix warning #2242
See all tickets marked for the 4.3.2 release
- Download Operation
- Fix that iOS 8 NSURLSessionTaskPriorityHigh symbol not defined in Foundation framework and cause crash #2231 #2230
- Downloader
- Follow Apple's doc, add NSOperation only after all configuration done #2232
See all tickets marked for the 4.3.1 release
- Cache
- Fix that SDImageCacheQueryDataWhenInMemory should response cacheType to memory cache when the in-memory cache hit #2218
- Project
- Fix the macOS wrong minimum deployment target version to 10.9 #2206
- Download Operation
- Decode the image in the operation level's queue instead of URLSession delegate queue #2199
- Coder
- Create a subclass of NSBitmapImageRep to fix the GIF frame duration issue on macOS #2223
- View Category
- Expose the read write to FLAnimatedImage associate to the UIImage to allow advanced feature like placeholder #2220
- Cache
- Create a subclass of NSCache using a weak cache #2228
- Download Operation
- Improvement download operation for priority and some protect #2208
- Project
- Fix CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF warning #2225
See all tickets marked for the 4.3.0 release
- View Category
- Add NSProgress API in
sd_imageProgress
property represent the image loading progress, this allow user add KVO on it for complicated logic #2172 - Add Image Transition API in
sd_imageTransition
property support custom image transition after image load finished #2182 - Add NSButton WebCache category on macOS #2183
- Add NSProgress API in
- Cache
- Add query cache options for query method #2162
- Add sync version API diskImageDataExistsWithKey and diskCacheWritingOptions #2190
- Manager
- Add a option SDWebImageFromCacheOnly to load the image from cache only and prevent network #2186
- Coder
- Fix GIF loopCount when the GIF image has no Netscape 2.0 loop extension #2155
- View Category
- Fix the issue that
setAnimationImagesWithURLs
weak reference may dealloc before the animated images was set #2178
- Fix the issue that
- Cache
- Fix the getSize method which use the default file manager instead of current file manager #2180
- Manager
- Fix the leak of runningOperations on race condition #2177
- Downloader
- Ensure all the session delegate completionHandler called and fix the leak when response error code below iOS 10 #2197
- Fix dispatch_sync blocking the main queue on race condition #2184
- Fix the thread-safe issue for headers mutable dictionary in downlaoder #2204
- Download Operation
- Fix that 0 pixels error should be used when width OR height is zero but not AND #2160
- Use the synchronized to access NSURLCache and try fix the potential thread-safe problem #2174
- Prefetcher
- Fix the issue that prefetcher will cause stack overflow when the input urls list is huge because of recursion function call #2196
- View Category
- Use the associate object to store the FLAnimatedImage into memory cache, avoid blinking or UIView transition #2181
- Cache
- Remove the extra memory warning notification for AutoPurgeCache #2153
- Downloader
- Avoid user accidentally invalidates the session used in shared downloader #2154
- Project
- Update the spec file to define the dependency version for libwebp #2169
See all tickets marked for the 4.2.3 release
- Add a public API to allow user to invalidate URLSession used in SDWebImageDownloader to avoid memory leak on non-singleton instance #2116
- Add a SDWebImageExternalCustomManagerKey context arguments to allow user to custom image manager for UIView category #2115
- Allow custom SDWebImageDownloaderOperation to handle HTTP redirect #2123
- Fix that FLAnimatedImageView blink and flash when collectionView reload #2102 #2106
- Fix that SDWebImagePrefetcher startPrefetchingAtIndex accident crash #2110 #2111
- Fix that Progressive WebP decoding not showing on iOS 11.2 #2130 #2131
- Fix crash in method implementation of sd_cancelImageLoadOperationWithKey, and avoid retain of operation #2113 #2125 #2132
- Fix Clang Static Analyzer warning for number nil check from Xcode 9.2 #2142 #2143
- Adopt the current requirement, change ImageIO coder's canDecodeFromHEIC to actual implementation #2146 #2138
- When store image with no data for SDImageCache, check whether it contains alpha to use PNG or JPEG format #2136
See all tickets marked for the 4.2.2 release
- Update our iOS demo to modern way, add a
UIProgressView
to show image download progress #2096
- Fix that completion block and set image block are called asynchronously for
UIView+WebCache
#2093 #2097 #2092 - Fix WebP progressive decoding may do extra calculate #2095
See all tickets marked for the 4.2.1 release
- Feature refactor built-in coders and support animated webp on macOS #2082 (reusable code into
SDWebImageCoderHelper
;SDWebImageFrame
abstracts animated images frames)
- Fixed EXIF orientation method will crash on iOS 7 because it’s an iOS 8 above API #2082
See all tickets marked for the 4.2.0 release
- Refactor decoding code and provide decoding plugin #1991
- HEIC format support #2080 #1853 #2038
- Welcome back our previous
UIImage+GIF
category for animated GIF! Not enabled by default. #2064 - Add the animated GIF encoding support for
SDWebImageGIFCoder
onmacOS
(useNSImage
API) #2067 - Implemented
-[NSImage isGIF]
method to return whether currentNSImage
has GIF representation #2071 - Allow user to provide reading options such as mapped file to improve performance in
SDImageCache
disk cache #2057 - Add progressive image load for WebP images #1991 #1987 #1986
- CI builds use Xcode 9
- Fixed our tests and improved the code coverage #2068
- Fixed lost orientation issues #1991 #2034 #2026 #1014 #1040 #815
- Fixed
UIImage(GIF) sd_animatedGIFWithData
crash #1991 #1837 - Fixed progressive WebP height issue #2066
- Fixed
SDWebImageManager.m __destroy_helper_block_
crash #2048 #1941 - Fixed cached image filename are sometimes generated with invalid path extensions #2061
- Fixed GIF performance problem #1901 by creating
FLAnimatedImage
instance on global queue #2047
- Updated diagrams
See all tickets marked for the 4.1.2 release
- Fix
SDWebImageDownloaderOperation
not calldone
when useSDWebImageDownloaderIgnoreCachedResponse
#2049 - Static
WebP
decoding little enhancement. Do not need createWebP
iterator for static images #2050 - Change
finished
check fromequal
toequal or greater than
to protect accident condition #2051
See all tickets marked for the 4.1.1 release
- Fixed crash on
[SDWebImageDownloaderOperation reset]_block_invoke
2f892f9 fixes #1883 - Fixed
SDWebImageDownloadOperation
imageData
multi-thread issue #2011 fixes #1998[SDWebImageDownloaderOperation URLSession:dataTask:didReceiveData:]
crash - Fixed
CFRelease
onNULL
ifCGImageSourceRef
create failed #1978 fixes #1968 #1834 #1947 - Fixed request cache policy #1994 #2032 fixes #1993 #1861 #1623 was introduced by #1737 (unit test #2031)
- Fixed
CGBitmapContextCreate
bitmap memory leak #1976 replaces #1860 fixes #1974 - Fixed issue #2001, add
sd_currentBackgroundImageURL
andsd_backgroundImageURLForState:
forUIButton
#2002 - Set
UIButton
placeholer-image even if the url isnil
#2043 fixes #1721 #1964 replaces #1790 - Use
CGImageSourceCreateIncremental
to perform progressive decoding instead of decode partial data each time from the beginning to improve performance and remove that gray background #2040 fixes #1899 - Fix SDWebImage v4 can not import libwebp framework's header files #1983 fixes #1887
- Fix unreachable code build warning on
macOS
#1984
- Performance enhancement related to single
WebP
and animatedWebP
decoding #1985 fixes #1999 #1885 - Use
FOUNDATION_EXPORT
overextern
#1977 - Move common test logic to
SDTestCase
#1980 - Enabled
CLANG_WARN_STRICT_PROTOTYPES
#1995 #2027 fixes #2022 - Update
macOS Demo
deployment target to10.10
to support build onXcode 9
#2035
- Updated Manual Installation section #2030 fixes #2012
See all tickets marked for the 4.1.0 release
- add ability to change
NSURLSessionConfiguration
used bySDWebImageDownloader
#1891 fixes #1870 - support animated GIF on
macOS
#1975 - cleanup the Swift interface by making unavailable all methods with missing params that have alternatives - see #1797 - this may cause require some changes in the Swift code
- handle
NSURLErrorNetworkConnectionLost
#1767 - fixed
CFBundleVersion
andCFBundleShortVersionString
not valid for all platforms #1784 + 23a8be8 fixes #1780 - fixed
UIActivityIndicator
not always initialized on main thread #1802 + a6af214 fixes #1801 SDImageCacheConfig
forward declaration changed to import #1805- making image downloading cache policy more clearer #1737
- added
@autoreleasepool
toSDImageCache.storeImage
#1849 - fixed 32bit machine
long long
type transfer to NSInteger may become negative #1879 - fixed crash on multiple concurrent downloads when accessing
self.URLOperations
dictionary #1911 fixes #1909 #1950 #1835 #1838 - fixed crash due to incorrectly retained pointer to operation
self
which appears to create a dangled pointer #1940 fixes #1807 #1858 #1859 #1821 #1925 #1883 #1816 #1716 - fixed Swift naming collision (due to the Obj-C interface that offers multiple variants of the same method but with mixed and missing params) #1797 fixes #1764
- coding style #1971
- fixed Umbrella header warning for the FLAnimatedImage (while using Carthage) d9f7cf4 (replaces #1781) fixes #1776
- fixed issue where animated image arrays could be populated out of order (order of download) #1452
- fixed animated WebP decoding issue, including canvas size, the support for dispose method and the duration per frame #1952 (replaces #1694) fixes #1951
- #1778 #1779 #1788 #1799 b1c3bb7 (replaces #1806) 0df32ea #1847 5eb83c3 (replaces #1828) #1946 #1966
See all tickets marked for the 4.0.0 release Versions 4.0.0-beta and 4.0.0-beta 2 list all the changes.
See all tickets marked for the 4.0.0 release
- Add an option to scale down large images #787 00bf467 efad1e5 8d1a0ae. Fixed #538, #880 and #586. This one is a more robust solution than #884 or #894. Can be activated via
SDWebImageScaleDownLargeImages
orSDWebImageDownloaderScaleDownLargeImages
- Fixed #1668 CGContextDrawImage: invalid context 0x0 - b366d84
See all tickets marked for the 4.0.0 release
- support for watchOS and OS X platforms #1595
- the
SDWebImage xcodeproj
contains the following targets:SDWebImage iOS static
(iOS static lib)SDWebImage watchOS static
(watchOS static lib)SDWebImage OSX
(OSX dynamic framework)SDWebImage iOS
(iOS dynamic framework)SDWebImage tvOS
(tvOS dynamic framework)SDWebImage watchOS
(watchOS dynamic framework)- the
SDWebImage Demo xcodeproj
contains the following targets:SDWebImage OSX Demo
SDWebImage iOS Demo
SDWebImage TV Demo
SDWebImage Watch Demo
- bumped
libwep
version to0.5.1
- improved unit testing code coverage (35% -> 77%) and integrated CodeCov
- removed all deprecated methods (that we carried around for backwards compatibility in previous versions) #774
- Renamed
SDWebImageManager
downloadImageWithURL:options:progress:completed:
toloadImageWithURL:options:progress:completed:
as it makes more sense, since we check the cache first and download only if needed a32a177 - Deleted targets:
SDWebImage+MKAnnotation
,SDWebImage+WebP
,SDWebImageFramework
:SDWebImage
target that build as a static library (all subspecs included) ->libSDWebImage.a
SDWebImageiOS
andSDWebImagetvOS
targets that build as dynamic frameworks
- Renamed the dynamic frameworks targets from
WebImage
toSDWebImage
. Renamed theWebImage.h
toSDWebImage.h
to match the framework naming - Renamed the schemes for consistency. Updated the Tests Podfile + project.
- For #883 Fix multiple requests for same image and then canceling one, several breaking changes were needed:
SDWebImageDownloader
method- downloadImageWithURL:options:progress:completed:
now returns aSDWebImageDownloadToken *
instead ofid <SDWebImageOperation>
(give the ability to cancel downloads using the returned token)SDWebImageDownloaderOperation
initializer- initWithRequest:options:progress:completed:cancelled
split into- initWithRequest:options
andaddHandlersForProgress:completed:
. Note: there is no more cancel block
- Modern Objective-C syntax done in 64382b9 includes:
- initializers now return
instancetype
instead ofid
- explicit designated initializers (i.e. for
SDImageCache
)
- initializers now return
- For #1575 GIF support using FLAnimatedImage, several changes were needed:
- replaced type
SDWebImageQueryCompletedBlock
withSDCacheQueryCompletedBlock
and added anNSData *
param - because of the change above, the
done
param ofSDImageCache
queryDiskCacheForKey:done:
is now aSDCacheQueryCompletedBlock
and those blocks must now include anNSData *
param - replaced type
SDWebImageCompletionWithFinishedBlock
withSDInternalCompletionBlock
and added anNSData *
param - because of the change above, the
completed
param ofSDWebImageManager
loadImageWithURL:options:progress:completed:
is nowSDInternalCompletionBlock
and those blocks must now include anNSData *
param - for consistency with the previous change, also renamed
SDWebImageCompletionBlock
toSDExternalCompletionBlock
UIImage
will no longer respond tosd_animatedGIFNamed:
orsd_animatedImageByScalingAndCroppingToSize:
- replaced type
- Xcode 7 Objective-C updates (Lightweight Generics and Nullability) #1581
- breaks compatibility at least for Swift users of the framework
- watchOS and OS X support #1595 required
- renamed
SDWebImage
iOS static lib target toSDWebImage iOS static
for clarity
- renamed
- improving the unit tests code coverage #1681 required
- Refactored
NSData
ImageContentType
category, instead of returning the contentType as a string, the new added methodsd_imageFormatForImageData
will return aSDImageFormat
enum value SDImageCache
configuration properties moved intoSDImageCacheConfig
(which is now available viaconfig
property):shouldDecompressImages
shouldDisableiCloud
shouldCacheImagesInMemory
maxCacheAge
maxCacheSize
- The
storeImage:
methods fromSDImageCache
were async already, but declared as sync. Properly marked them as async + added completion. Got rid of the recalculate param. If theNSData
is provided, use it. Otherwise, recalculate from theUIImage
- Removed the synchronous methods
diskImageExistsForURL:
andcachedImageExistsForURL:
fromSDWebImageManager
- Removed the synchronous method
diskImageExistsWithKey:
fromSDImageCache
- Get rid of the confusion caused by
cleanDisk
andclearDisk
onSDImageCache
. RenamedcleanDisk
todeleteOldFiles
. No longer expose the syncclearDisk
anddeleteOldFiles
, just the async ones. - Renamed
SDImageCache
queryDiskCacheForKey:done:
toqueryCacheOperationForKey:done:
- Another
SDImageCache
clarification:imageFromDiskCacheForKey:
used to also check the memory cache which I think is misleading. NowimageFromDiskCacheForKey
only checks the disk cache and the new methodimageFromCacheForKey
checks both caches - Got rid of
removeImageForKey:
andremoveImageForKey:fromDisk:
fromSDImageCache
that looked sync but were async. Left only the 2 async ones - Removed
UIImageView
sd_cancelCurrentHighlightedImageLoad
- Refactored
- Added
sd_
prefix to the activity indicator related methods (setShowActivityIndicatorView:
,setIndicatorStyle:
,showActivityIndicatorView
,addActivityIndicator
,removeActivityIndicator
) #1640 - Use
dispatch_main_async_safe
for all the completion blocks on the main queue (used to bedispatch_sync
) - avoiding locks. - Removed
dispatch_main_sync_safe
as it can be mistakenly used - Add
url
as param to progress blockSDWebImageDownloaderProgressBlock
- #984
- Switched our GIF support to a better implementation: FLAnimatedImage by Flipboard #1575
- requires iOS 8+ (it's the only way due to FLAnimatedImage requirements)
- the implementation relies on a
WebCache
category on top ofFLAnimatedImageView
- details in the README
- Converted any remaining code to Modern Objective-C syntax - 64382b9
- Xcode 7 Objective-C updates (Lightweight Generics and Nullability) #1581
- via #1595 Clarified and simplified the usage of
TARGET_OS_*
macros. AddedSD_MAC
,SD_UIKIT
,SD_IOS
,SD_TV
,SD_WATCH
. The biggest issue here wasTARGET_OS_MAC
was 1 for all platforms and we couldn't rely on it. - Replaces #1398 Allow to customise cache and image downloader instances used with
SDWebImageManager
- added a new initializer (initWithCache:downloader:
) 9112170 UIImage
responds tosd_imageData
andsd_imageDataAsFormat:
via theMultiFormat
category. Those methods transform aUIImage
to theNSData
representation 82d1f2e- Created
SDWebImageDownloaderOperationInterface
to describe the behavior of a downloader operation. Any custom operation must conform to this protocol df3b6a5 - Refactored all the duplicate code from our
WebCache
categories into aUIView
WebCache
category. All the other categories will make calls to this one. Customization of setting the image is done via thesetImageBlock
and theoperationKey
e1840c3 - Due to the change above, the activity indicator can now be added to
UIButton
,MKAnnotationView
,UIImageView
- Animated WebP support #1438
- The shared objects (not really singletons) should allow subclassing, therefore the return type of the shared resource method should be
instancetype
and not a fixed type - c57cf7e - Allow to specify
NSURLSessionConfiguration
forSDWebImageDownloader
#1654 - Add
url
as param to progress blockSDWebImageDownloaderProgressBlock
- #984
- Fix multiple requests for same image and then canceling one #883 + 8a78586
- Fixed #1444 and the master build thanks to @kenmaz
- Fixed an issue with the
SDWebImageDownloaderOperation
:cancelInternal
was not called because of the old mechanism rellying on thethread
property - probably because that thread did not have a runloop. Removed that and now cancelInternal is called as expected f4bdae6 - Replaced #781 on replacing dispatch_sync with dispatch_async for the main queue 062e50a f7e8246 c77adf4 fdb8b2c 265ace4 0c47bc3. Check for main queue instead of main thread.
- Fixed #1619 iOS 10 crash (
setObjectForKey: object cannot be nil
) - #1676 7940577 - Fixed #1326 #1424 (
Carthage bitcode issue
) - #1593 - Fixed #1639 via #1657 (
Add support for downloading images behind redirect
) - Replaced #1537 via 9cd6779 - fixed a potential retain cycle
- Updated
dispatch_main_async_safe
macro in order to avoid redefinition when included as Pod - Fixed #1089 by updating the docs on the calling queue for the
progressBlock
(background queue) - Fixed a compilation issue on
FLAnimatedImageView+WebCache
- #1687
- Fixed #1608 #1623 #1644 Crash in
[NSURLCache cachedResponseForRequest:]
- the fix is actually avoiding to accessNSURLCache
which appears to generate a race condition. We only call it if necesarry (SDWebImageRefreshCached
is used and the image cannot be cached by the system when it's too big or behind authentication)
- SDWebImage 3.8.0 get wrong image #1589 - the issue was caused by the changes in 3.8.0 (Removed the URL query params from the filename (key) fb0cdb6d 1bf62d4 #1584 - fixes #1433 #1553 #1583 #1585) - Reverted.
- Note: The solution for those issues (i.e. #1433 #1553) is to set the
SDWebImageManager
cacheKeyFilter
block and do their own calculations there.
- Had to update the iOS deployment target to 7.0 from 5 - 6545a3a
- Replace deprecated
NSURLConnection
withNSURLSession
#1578 #1586 - fixes #1291 #1318 #823 #1566 #1515 - Allow to customise cache and image downloader instances used with
SDWebImageManager
86fc47bf7b - fixes #1398 #870
- Removed the URL query params from the filename (key) fb0cdb6d 1bf62d4 #1584 - fixes #1433 #1553 #1583 #1585
- Fixed the WebP build with the official 1.0.0 CocoaPods release f1a471e - fixes #1444
- Updated doc:
removeImageForKey:
not synchronous e6e5c51 - fixes #1379 #1415
- Changed the libwebp git url so that people from China can access it - #1390 (from
https://chromium.googlesource.com/webm/libwebp
tohttps://github.com/webmproject/libwebp
)
- Added
cancelAllDownloads
method toSDWebImageDownloader
#1504 - Added API to save image
NSData
to disk cache:[SDImageCache storeImageDataToDisk:forKey:]
#1453
- Fix #1449: Version 3.7.5 breaks semantic versioning (removes public API). Re-added
sd_setImageWithPreviousCachedImageWithURL:andPlaceholderImage:options:progress:completed:
and deprecated it. Will remove it in 4.0.0 b40124c - Fix
CGContextDrawImage: invalid context 0x0
- #1496 (fixes #1401 #1454 #1457) - Fix
CGBitmapContextCreateImage: invalid context 0x0
- #1464 (fixes #1423) - Fix changed image size when loading from disk #1540 (fixes #1437)
- Repair memory release in the iPad environment #1549 (had to switch
#if TARGET_OS_IPHONE
to#if TARGET_OS_IOS
) - Fixed completion logic in
MKAnnotationView+WebCache
#1547 - Optimize the decoder to avoid unwanted blended layer - #1527 (fixes #1524)
- Protect against malformed frame for GIFs - #1447
- updated doc: #1462 #1466 #1486 #1532 #1461
- fixed #1425 and #1426 - Continuation of Fix #1366, addresses #1350 and reverts a part of #1221 - from commit 6406d8e, the wrong usage of
dispatch_apply
- fixed #1422 - Added a fallback for #976 so that if there are images saved with the old format (no extension), they can still be loaded
- bumped
libwep
version to0.4.4
- added tvOS support #1327 and #1358 - fix #1368 and #1302
- #1217 contains several of the above fixes
- fix #391 -> option to cache only on Disk. will replace #1130
- fix #343 -> iCloud backup Option
- fix #371 -> CGBitmapContextCreate: unsupported parameter combination + #1268 #1412 #1340
- fix #576 -> scale set to screen scale
- fix #1035 -> progress queue with dispatch_async
- new feature -> activity indicator using auto layout. The activity indicator feature will replace #131
- #1218 progress callbacks now report on main thread - fixes #1035
- #1321 Added a new constructor to SDWebImagePrefetcher - replaces #956
- #976 append the original path extension to the hash filename - fixes #967
- replaced #999 with #1221
- added cache tests #1125
- #1236 fixes #1203
- bf899e2 fixes #1261 #1263 compilation issue CocoaPods vs non-CocoaPods
- #1367 fixes a bug where image scale & orientation are ignored when decoding / decompressing an image
- cac21e1 fixes #1366, addresses #1350 and reverts a part of #1221 - from commit 6406d8e, the wrong usage of dispatch_apply
- #1363 fixes #1361 sd_cancelBackgroundImageLoadForState
- #1348 Create a strong ref of weakOperation in the entry of The image download subOperation, use the strong ref instead weakOperation. At the same time, repair some logic of the 'If cancelled'
- dcb7985 replaces #1345 - Load local credential file
- #1323 don't to perform download if url is "" but not nil
- #1310 Added support for SDWebImageAvoidAutoSetImage option to UIButton and highlighted UIImageView categories
- #1308 Added Swift installation tips
- 32923fa Xcode 7.1 updates
- #1297 cleaner implementation of failedUrl error handling - fixes #1275
- #1280 Fix sd_animatedImageByScalingAndCroppingToSize
- Remove logging from the image prefetcher - #1276
- Fix typos #1256 #1257 #1258 #1331 #1290
-
Adds support for iOS 8+ Framework and Carthage #1071 #1081 #1101
-
[Refactor] Use
NSMutableSet
for failed URLs' storage instead of array #1076 -
Make a constant for the error domain #1011
-
Improve operation behavior #988
-
Bug fix:
Collection <__NSArrayM: > was mutated while being enumerated
#985 -
added
SDWebImageAvoidAutoSetImage
option to avoid automatic image addition inUIImageView
and let developer to do it himself #1188 -
Added support for custom disk cache folder with fall back for caches directory #1153
-
Added some files to the workspace so they are easier to edit 8431481
-
[Memory Issue] Clear
SDWebImagePrefetcher
progressBlock
when it has completed #1017 -
avoid warning
<Error>: ImageIO: CGImageSourceCreateWithData data parameter is nil
ifimageData
is nil 88ee3c6 #1018 -
allow override
diskCachePath
#1041 -
Use
__typeof(self)
when assigningweak
reference for block #1054 -
[Refactor] Implement cache cost calculation as a inline function #1075
-
Fix parenthesis to avoid crashes #1104
-
Add
NSCache
countLimit property #1140 -
failedURLs
can be removed at the appropriate time #1111 -
Purge
NSCache
on system memory notifications #1143 -
Determines at runtime is
UIApplication
is available as per #1082 #1085 -
Fixes http://git.chromium.org/webm/libwebp.git/info/refs not valid #1175 + Reverted #1193 + #1177
-
404 image url was causing the test to fail 0e761f4
-
Fix for transparency being lost in transformed images. #1121
-
Add handling for additional error codes that shouldn't be considered a permanent failure #1159
-
add webp accepted content type only if
WebP
enabled #1178 -
fix
ImageIO: CGImageSourceCreateWithData
data parameter is nil #1167 -
Applied patch for issue #1074 SDWebImage residing in swift module breaks the debugger #1138
-
Fixed URLs with trailing parameters get assigned an incorrect image scale value #1157 #1158
-
Add newline to avoid compiler warning in
WebImage.h
#1199
- bumped
libwep
version to0.4.3
- implement
SDWebImageDownloaderAllowInvalidSSLCertificates
option - #937 - flag to transform animated images (
SDWebImageTransformAnimatedImage
) - #703 - allows user to override default
SDWebImageDownloaderOperation
- #876 - adds option to decompress images and select prefetcher queue - #996
- fixed #809
cancelAll
crash - #838 - fixed #900 by adding a new flag
SD_LOG_NONE
that allows silencing the SD logs from the Prefetcher - fixed #895 unsafe setImage in
setImageWithURL:
- #896 - fix
NSNotificationCenter
dispatch on subthreads - #987 - fix
SDWebImageDownloader
threading issue - #1046 - fixed duplicate failed urls are added into
failedURLs
- #994 - increased default
maxConcurrentOperationCount
, fixes #527 - #897 - handle empty urls
NSArray
- #929 - decoding webp, depends on source image data alpha status - #936
- fix #610 display progressive jpeg issue - #840
- the code from
SDWebImageDownloaderOperation connection:didFailWithError:
should match the code fromconnectionDidFinishLoading:
. This fixes #872 - 7f39e5e 304 - Not Modified
HTTP status code handling - #942- cost compute fix - #941
- initialise
kPNGSignatureData
data - #981
- documentation updated
- fixed
sd_imageOrientationFromImageData:
crash if imageSource is nil - #819 #813 #808 #828 - temporary fix - fixed
SDWebImageCombinedOperation cancel
crash (also visible asSDWebImageManager cancelAll
) - 28109c4 #798 #809 - fixed duplicate symbols when using with webp via pods - #795
- fixed missing
mark
frompragma mark
- #827
- Add category for imageView's highlighted state
UIImageView+HighlightedWebCache
- #646 #765 - Keep a reference to the image URL - #560
- Pass imageURL in completedBlock - #770
- Implemented NTLM auth support. Replaced deprecated auth challenge methods from
NSURLConnectionDelegate
- #711 50c4d1d - Ability to suspend image downloaders
SDWebImageDownloader setSuspended:
- #734 - Delay the loading of the placeholder image until after load - #701
- Ability to save images to cache directly - #714
- Support for image orientation - #764
- Added async
SDImageCache removeImageForKey:withCompletion:
- #732 cd4b925 - Exposed cache paths - #339
- Exposed
SDWebImageManager cacheKeyForURL:
- 5fd21e5 - Exposing
SDWebImageManager
instance from theSDWebImagePrefetcher
class - 6c409cd SDWebImageManager
uses the shared instance ofSDWebImageDownloader
- 0772019- Refactor the cancel logic - #771 6d01e80 23874cd a6f11b3
- Added method
SDWebImageManager cachedImageExistsForURL:
to check if an image exists in either the disk OR the memory cache - #644 - Added option to use the cached image instead of the placeholder for
UIImageView
. Replaces #541 - #599 30f6726 - Created workspace + added unit tests target
- Updated documentation - #476 #384 #526 #376 a8f5627
- Fixed Xcode 6 builds - #741 0b47342
- Fixed
diskImageExistsWithKey:
deadlock - #625 6e4fbaf For consistency, added async methods inSDWebImageManager
cachedImageExistsForURL:completion:
anddiskImageExistsForURL:completion:
- Fixed race condition that causes cancellation of one download operation to stop a run loop that is now used for another download operation. Race is introduced through
performSelector:onThread:withObject:waitUntilDone:
- #698 - Fixed race condition between operation cancelation and loading finish - 39db378 #621 #783
- Fixed race condition in SDWebImageManager if one operation is cancelled - f080e38 #699
- Fixed issue where cancelled operations aren't removed from
runningOperations
- #68 - Should not add url to failedURLs when timeout, cancel and so on - #766 #707
- Fixed potential object mutated while being enumerated crash - #727 #728 (revert a threading fix from #727)
- Fixed
NSURLConnection
response statusCode not valid (e.g. 404), downloader never stops its runloop and hangs the operation queue - #735 - Fixed
SDWebImageRefreshCached
bug for large images - #744 - Added proper handling for
SDWebImageDownloaderLowPriority
- #713 #745 - Fixed fixing potential bug when sending a nil url for UIButton+WebCache - #761 #763
- Fixed issue #529 - if the
cacheKeyFilter
was set, this was ignored when computing thescaledImageForKey
. For most of the developers that did not setcacheKeyFilter
, the code will work exactly the same - eb91fdd - Returning error in setImage completedBlock if the url was nil. Added
dispatch_main_async_safe
macro - #505 af3e4f8 - Avoid premature completion of prefetcher if request fails - #751
- Return nil from
SDScaledImageForKey
if the input image is nil - #365 #750 - Do not load placeholder image if
SDWebImageDelayPlaceholder
option specified - #780 - Make sure we call the
startPrefetchingAtIndex:
method from main queue - #694 - Save image in cache before calling completion block - #700
- Fixed arm64 warnings - #685 #720 #721 #687
- Improved logging - #721
- Added
SDWebImageCompat.m
toSDWebImage+MKAnnotation
target
- Fix iOS 7 related issues
- Move
WebP
support to a dedicated target - Removed strong reference to
UIImageView
which was causing a crash in the nested block - Fix timeout issue
- Add some methods that allow to check if an image exists on disk without taking it off disk and decompressing it first
- Add
calculateSizeWithCompletionBlock
- Add multiple download of images for animationImages property of
UIImageView
- Add background task for disk cleanup #306
- Fix dead thread issue on iOS 5 #444, #399, #466
- Make IO operations cancelable to fix perf issue with heavy images #462
- Fix crash
Collection <__NSArrayM: ...> was mutated while being enumerated.
#471
- WebP image format support #410
- Animated GIF support #375
- Custom image cache search paths #156
- Bug fixes
SDWebImageRefreshCached
download option #326- New
SDWebImageManager
delegate methods ebd63a88c1 - Fix long standing issue with alpha en JPEGs #299
- Add synchronous disk-cache loading method #297
- Fix
SDWebImageCacheMemoryOnly
flag - Bug fixes
- Complete rewrite of the library using
GCD
,ARC
,NSCache
and blocks - Drop compatibility with iOS 3 and 4