Requirements

Installation

CocoaPods

pod'SDWebImageWebPCoder'

Carthage

github "SDWebImage/SDWebImageWebPCoder"

Swift Package Manager (Xcode 11+)

letpackage=Package(    dependencies:[.package(url:"https://github.com/SDWebImage/SDWebImageWebPCoder.git", from:"0.3.0")])

Usage

Add Coder

// Add coderSDImageWebPCoder *webPCoder = [SDImageWebPCodersharedCoder];[[SDImageCodersManagersharedManager]addCoder:webPCoder];

// Add coderletWebPCoder=SDImageWebPCoder.sharedSDImageCodersManager.shared.addCoder(WebPCoder)

Modify HTTP Accept Header

[[SDWebImageDownloadersharedDownloader]setValue:@"image/webp,image/*,*/*;q=0.8"forHTTPHeaderField:@"Accept"];

SDWebImageDownloader.shared.setValue("image/webp,image/*,*/*;q=0.8", forHTTPHeaderField:"Accept")

Loading

// WebP online image loadingNSURL *webpURL;UIImageView *imageView;[imageViewsd_setImageWithURL:webpURL];

// WebP online image loadingletwebpURL:URLletimageView:UIImageViewimageView.sd_setImage(with: webpURL)

Progressive Animation Loading (0.5.0+)

// WebP progressive loading for animated imageNSURL *webpURL;SDAnimatedImageView *imageView;imageView.shouldIncrementalLoad =YES;[imageViewsd_setImageWithURL:webpURLplaceholderImage:niloptions:SDWebImageProgressiveLoad];

// WebP progressive loading for animated imageletwebpURL:URLletimageView:SDAnimatedImageViewimageView.shouldIncrementalLoad=trueimageView.sd_setImage(with: webpURL, placeholderImage:nil, options:[.progressiveLoad])

Decoding

// WebP image decodingNSData *webpData;UIImage *image = [[SDImageWebPCodersharedCoder]decodedImageWithData:webpDataoptions:nil];

// WebP image decodingletwebpData:Dataletimage=SDImageWebPCoder.shared.decodedImage(with: data, options:nil)

Thumbnail Decoding (0.4.0+)

// WebP thumbnail image decodingNSData *webpData;CGSize thumbnailSize = CGSizeMake(300,300);UIImage *thumbnailImage = [[SDImageWebPCodersharedCoder]decodedImageWithData:webpDataoptions:@{SDImageCoderDecodeThumbnailPixelSize : @(thumbnailSize)}];

// WebP thumbnail image decodingletwebpData:DataletthumbnailSize=CGSize(width:300, height:300)letimage=SDImageWebPCoder.shared.decodedImage(with: data, options:[.decodeThumbnailPixelSize: thumbnailSize])

Decoding with limit bytes (0.12.0+)

// WebP thumbnail image decodingNSData *webpData;NSUInteger limitBytes =1024 *1024;// 1MBUIImage *image = [[SDImageWebPCodersharedCoder]decodedImageWithData:webpDataoptions:@{SDImageCoderDecodeScaleDownLimitBytes : @(limitBytes)}];// The image pixel buffer is guaranteed to less than 1MB in RAM (may scale down or full size), suitable for large image

// WebP thumbnail image decodingletwebpData:DataletlimitBytes=1024*1024 // 1MBletimage=SDImageWebPCoder.shared.decodedImage(with: data, options:[.decodeScaleDownLimitBytes: limitBytes])// The image pixel buffer is guaranteed to less than 1MB in RAM (may scale down or full size), suitable for large image

Encoding

// WebP image encodingUIImage *image;NSData *webpData = [[SDImageWebPCodersharedCoder]encodedDataWithImage:imageformat:SDImageFormatWebPoptions:nil];// Animated encodingNSArray<SDImageFrames *> *frames;NSData *awebpData = [[SDImageWebPCodersharedCoder]encodedDataWithFrames:framesloopCount:0format:SDImageFormatWebPoptions:nil];// Encode QualityNSData *lossyWebpData = [[SDImageWebPCodersharedCoder]encodedDataWithImage:imageformat:SDImageFormatWebPoptions:@{SDImageCoderEncodeCompressionQuality : @(0.1)}];// [0, 1] compression qualityNSData *limitedWebpData = [[SDImageWebPCodersharedCoder]encodedDataWithImage:imageformat:SDImageFormatWebPoptions:@{SDImageCoderEncodeMaxFileSize : @(1024 *10)}];// v0.6.0 feature, limit output file size <= 10KB

// WebP image encodingletimage:UIImageletwebpData=SDImageWebPCoder.shared.encodedData(with: image, format:.webP, options:nil)// Animated encodingletframes:[SDImageFrame]letawebpData=SDImageWebPCoder.shared.encodedData(with: frames, loopCount:0, format:.webP, options:nil)// Encode QualityletlossyWebpData=SDImageWebPCoder.shared.encodedData(with: image, format:.webP, options:[.encodeCompressionQuality:0.1]) // [0, 1] compression qualityletlimitedWebpData=SDImageWebPCoder.shared.encodedData(with: image, format:.webP, options:[.encodeMaxFileSize:1024*10]) // v0.6.0 feature, limit output file size <= 10KB

Thumbnail Encoding (0.6.1+)

// WebP image thumbnail encodingUIImage *image;NSData *thumbnailWebpData = [[SDImageWebPCodersharedCoder]encodedDataWithImage:imageformat:SDImageFormatWebPoptions:@{SDImageCoderEncodeMaxPixelSize : @(CGSizeMake(200,200))}];// v0.6.1 feature, encoding max pixel size

// WebP image thumbnail encodingletimage:UIImageletthumbnailWebpData=SDImageWebPCoder.shared.encodedData(with: image, format:.webP, options:[.encodeMaxPixelSize:CGSize(width:200, height:200)]) // v0.6.1 feature, encoding max pixel size

Animated WebP Encoding (0.10+)

// Animated encodingNSMutableArray<SDImageFrames *> *frames = [NSMutableArrayarray];for (size_t i =0; i < images.count; i++) {    SDImageFrame *frame = [SDImageFrameframeWithImage:images[i]duration:0.1];    [framesappendObject:frame];}NSData *awebpData = [[SDImageWebPCodersharedCoder]encodedDataWithFrames:framesloopCount:0format:SDImageFormatWebPoptions:nil];

// Animated encodingvarframes:[SDImageFrame]=[]foriin0..<images.count{letframe=SDImageFrame(image:images[i], duration:0.1)    frames.append(frame)}letawebpData=SDImageWebPCoder.shared.encodedData(with: frames, loopCount:0, format:.webP, options:nil)

Advanced WebP codec options (0.8+)

UIImage *image;SDImageCoderOptions *options = @{SDImageCoderEncodeWebPMethod: @(0), SDImageCoderEncodeWebPAlphaCompression: @(100)};NSData *data = [SDImageWebPCoder.sharedCoderencodedDataWithImage:imageformat:SDImageFormatWebPoptions:options];// Will translate into:// config->method = 0;// config->alpha_quality = 100;

letimage:UIImageletoptions=[.encodeWebPMethod:0,.encodeWebPAlphaCompression:100]letdata=SDImageWebPCoder.shared.encodedData(with: image, format:.webP, options: options)// Will translate into:// config->method = 0;// config->alpha_quality = 100;

Example

Screenshot

Author

License