Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/SDWebImage/SDWebImageWebPCoder

A WebP coder plugin for SDWebImage, use libwebp
https://github.com/SDWebImage/SDWebImageWebPCoder

animated-webp carthage cocoapods ios macos sdwebimage tvos watchos webp

Last synced: about 2 months ago
JSON representation

A WebP coder plugin for SDWebImage, use libwebp

Host: GitHub
URL: https://github.com/SDWebImage/SDWebImageWebPCoder
Owner: SDWebImage
License: mit
Created: 2018-08-28T10:54:48.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-04-17T09:15:17.000Z (9 months ago)
Last Synced: 2024-10-29T13:13:37.601Z (2 months ago)
Topics: animated-webp, carthage, cocoapods, ios, macos, sdwebimage, tvos, watchos, webp
Language: Objective-C
Homepage:
Size: 4.3 MB
Stars: 220
Watchers: 9
Forks: 86
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome - SDWebImageWebPCoder - SDWebImageWebPCoder supports both WebP decoding and encoding, for Static WebP or Animated WebP as well. (iOS / webp)
awesome - SDWebImageWebPCoder - SDWebImageWebPCoder supports both WebP decoding and encoding, for Static WebP or Animated WebP as well. (iOS / webp)

README

        # SDWebImageWebPCoder

[![CI Status](http://img.shields.io/travis/SDWebImage/SDWebImageWebPCoder.svg?style=flat)](https://travis-ci.org/SDWebImage/SDWebImageWebPCoder)

[![Version](https://img.shields.io/cocoapods/v/SDWebImageWebPCoder.svg?style=flat)](http://cocoapods.org/pods/SDWebImageWebPCoder)

[![License](https://img.shields.io/cocoapods/l/SDWebImageWebPCoder.svg?style=flat)](http://cocoapods.org/pods/SDWebImageWebPCoder)

[![Platform](https://img.shields.io/cocoapods/p/SDWebImageWebPCoder.svg?style=flat)](http://cocoapods.org/pods/SDWebImageWebPCoder)

[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-brightgreen.svg?style=flat)](https://swift.org/package-manager/)

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/SDWebImage/SDWebImageWebPCoder)

[![codecov](https://codecov.io/gh/SDWebImage/SDWebImageWebPCoder/branch/master/graph/badge.svg)](https://codecov.io/gh/SDWebImage/SDWebImageWebPCoder)

Starting with the SDWebImage 5.0 version, we moved the WebP support code and [libwebp](https://github.com/webmproject/libwebp) from the Core Repo to this stand-alone repo.

SDWebImageWebPCoder supports both WebP decoding and encoding, for Static WebP or Animated WebP as well.

Note: Apple's ImageIO supports WebP decoding from iOS 14/tvOS 14/watchOS 7/macOS 11, so SDWebImage on those platform can also decode WebP images (using `SDWebImageAWebPCoder` built-in coder). However it may contains some limitation, check https://github.com/SDWebImage/SDWebImage/issues/3558, you can still force to use this coder on those platforms by adding this coder.

## Requirements

+ iOS 9.0

+ macOS 10.11

+ tvOS 9.0

+ watchOS 2.0

+ Xcode 11.0

## Installation

#### CocoaPods

SDWebImageWebPCoder is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:

```ruby

pod 'SDWebImageWebPCoder'

```

#### Carthage

SDWebImageWebPCoder is available through [Carthage](https://github.com/Carthage/Carthage).

```

github "SDWebImage/SDWebImageWebPCoder"

```

#### Swift Package Manager (Xcode 11+)

SDWebImageWebPCoder is available through [Swift Package Manager](https://swift.org/package-manager).

```swift

let package = Package(

    dependencies: [

        .package(url: "https://github.com/SDWebImage/SDWebImageWebPCoder.git", from: "0.3.0")

    ]

)

```

## Usage

### Add Coder

Before using SDWebImage to load WebP images, you need to register the WebP Coder to your coders manager. This step is recommended to be done after your App launch (like AppDelegate method).

+ Objective-C

```objective-c

// Add coder

SDImageWebPCoder *webPCoder = [SDImageWebPCoder sharedCoder];

[[SDImageCodersManager sharedManager] addCoder:webPCoder];

```

+ Swift

```swift

// Add coder

let WebPCoder = SDImageWebPCoder.shared

SDImageCodersManager.shared.addCoder(WebPCoder)

```

### Modify HTTP Accept Header

Some of image server provider may try to detect the client supported format, by default, SDWebImage use `image/*,*/*;q=0.8` for [Accept](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept). You can modify it with the `image/webp` as well.

+ Objective-C

```objective-c

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

```

+ Swift

```swift

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

```

### Loading

+ Objective-C

```objective-c

// WebP online image loading

NSURL *webpURL;

UIImageView *imageView;

[imageView sd_setImageWithURL:webpURL];

```

+ Swift

```swift

// WebP online image loading

let webpURL: URL

let imageView: UIImageView

imageView.sd_setImage(with: webpURL)

```

### Progressive Animation Loading (0.5.0+)

+ Objective-C

```objective-c

// WebP progressive loading for animated image

NSURL *webpURL;

SDAnimatedImageView *imageView;

imageView.shouldIncrementalLoad = YES;

[imageView sd_setImageWithURL:webpURL placeholderImage:nil options:SDWebImageProgressiveLoad];

```

+ Swift

```swift

// WebP progressive loading for animated image

let webpURL: URL

let imageView: SDAnimatedImageView

imageView.shouldIncrementalLoad = true

imageView.sd_setImage(with: webpURL, placeholderImage: nil, options: [.progressiveLoad])

```

### Decoding

+ Objective-C

```objective-c

// WebP image decoding

NSData *webpData;

UIImage *image = [[SDImageWebPCoder sharedCoder] decodedImageWithData:webpData options:nil];

```

+ Swift

```swift

// WebP image decoding

let webpData: Data

let image = SDImageWebPCoder.shared.decodedImage(with: data, options: nil)

```

### Thumbnail Decoding (0.4.0+)

+ Objective-C

```objective-c

// WebP thumbnail image decoding

NSData *webpData;

CGSize thumbnailSize = CGSizeMake(300, 300);

UIImage *thumbnailImage = [[SDImageWebPCoder sharedCoder] decodedImageWithData:webpData options:@{SDImageCoderDecodeThumbnailPixelSize : @(thumbnailSize)}];

```

+ Swift

```swift

// WebP thumbnail image decoding

let webpData: Data

let thumbnailSize = CGSize(width: 300, height: 300)

let image = SDImageWebPCoder.shared.decodedImage(with: data, options: [.decodeThumbnailPixelSize: thumbnailSize])

```

### Decoding with limit bytes (0.12.0+)

+ Objective-C

```objective-c

// WebP thumbnail image decoding

NSData *webpData;

NSUInteger limitBytes = 1024 * 1024; // 1MB

UIImage *image = [[SDImageWebPCoder sharedCoder] decodedImageWithData:webpData options:@{SDImageCoderDecodeScaleDownLimitBytes : @(limitBytes)}];

// The image pixel buffer is guaranteed to less than 1MB in RAM (may scale down or full size), suitable for large image

```

+ Swift

```swift

// WebP thumbnail image decoding

let webpData: Data

let limitBytes = 1024 * 1024 // 1MB

let image = 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

+ Objective-c

```objective-c

// WebP image encoding

UIImage *image;

NSData *webpData = [[SDImageWebPCoder sharedCoder] encodedDataWithImage:image format:SDImageFormatWebP options:nil];

// Animated encoding

NSArray *frames;

NSData *awebpData = [[SDImageWebPCoder sharedCoder] encodedDataWithFrames:frames loopCount:0 format:SDImageFormatWebP options:nil];

// Encode Quality

NSData *lossyWebpData = [[SDImageWebPCoder sharedCoder] encodedDataWithImage:image format:SDImageFormatWebP options:@{SDImageCoderEncodeCompressionQuality : @(0.1)}]; // [0, 1] compression quality

NSData *limitedWebpData = [[SDImageWebPCoder sharedCoder] encodedDataWithImage:image format:SDImageFormatWebP options:@{SDImageCoderEncodeMaxFileSize : @(1024 * 10)}]; // v0.6.0 feature, limit output file size <= 10KB

```

+ Swift

```swift

// WebP image encoding

let image: UIImage

let webpData = SDImageWebPCoder.shared.encodedData(with: image, format: .webP, options: nil)

// Animated encoding

let frames: [SDImageFrame]

let awebpData = SDImageWebPCoder.shared.encodedData(with: frames, loopCount: 0, format: .webP, options: nil)

// Encode Quality

let lossyWebpData = SDImageWebPCoder.shared.encodedData(with: image, format: .webP, options: [.encodeCompressionQuality: 0.1]) // [0, 1] compression quality

let limitedWebpData = 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+)

+ Objective-C

```objective-c

// WebP image thumbnail encoding

UIImage *image;

NSData *thumbnailWebpData = [[SDImageWebPCoder sharedCoder] encodedDataWithImage:image format:SDImageFormatWebP options:@{SDImageCoderEncodeMaxPixelSize : @(CGSizeMake(200, 200))}]; // v0.6.1 feature, encoding max pixel size

```

+ Swift

```swift

// WebP image thumbnail encoding

let image: UIImage

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

```

See more documentation in [SDWebImage Wiki - Coders](https://github.com/SDWebImage/SDWebImage/wiki/Advanced-Usage#custom-coder-420)

### Animated WebP Encoding (0.10+)

+ Objective-c

```objective-c

// Animated encoding

NSMutableArray *frames = [NSMutableArray array];

for (size_t i = 0; i < images.count; i++) {

    SDImageFrame *frame = [SDImageFrame frameWithImage:images[i] duration:0.1];

    [frames appendObject:frame];

}

NSData *awebpData = [[SDImageWebPCoder sharedCoder] encodedDataWithFrames:frames loopCount:0 format:SDImageFormatWebP options:nil];

```

+ Swift

```swift

// Animated encoding

var frames: [SDImageFrame] = []

for i in 0..method = 0;

// config->alpha_quality = 100;

```

+ Swift

```swift

let image: UIImage

let options = [.encodeWebPMethod: 0, .encodeWebPAlphaCompression: 100]

let data = SDImageWebPCoder.shared.encodedData(with: image, format: .webP, options: options)

// Will translate into:

// config->method = 0;

// config->alpha_quality = 100;

```

## Example

To run the example project, clone the repo, and run `pod install` from the root directory first. Then open `SDWebImageWebPCoder.xcworkspace`.

This is a demo to show how to use `WebP` and animated `WebP` images via `SDWebImageWebPCoderExample` target.

## Screenshot



These WebP images are from [WebP Gallery](https://developers.google.com/speed/webp/gallery1) and [GIF vs APNG vs WebP](http://littlesvr.ca/apng/gif_apng_webp.html)

## Author

[Bogdan Poplauschi](https://github.com/bpoplauschi)

[DreamPiggy](https://github.com/dreampiggy)

## License

SDWebImageWebPCoder is available under the MIT license. See [the LICENSE file](https://github.com/SDWebImage/SDWebImageWebPCoder/blob/master/LICENSE) for more info.