SwiftyGif
High performance & easy to use Gif engine
Features
- UIImage and UIImageView extension based
- Remote GIFs with customizable loader
- Great CPU/Memory performances
- Control playback
- Allow control of display quality by using 'levelOfIntegrity'
- Allow control CPU/memory tradeoff via 'memoryLimit'
Installation
With CocoaPods
source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!
pod 'SwiftyGif'
With Carthage
Follow the usual Carthage instructions on how to add a framework to an application. When adding SwiftyGif among the frameworks listed in Cartfile, apply its syntax for GitHub repositories:
github "kirualex/SwiftyGif"
With Swift Package Manager
https://github.com/kirualex/SwiftyGif.git
How to Use
Project files
As of now, Xcode xcassets folders do not recognize .gif as images. This means you need to put your .gif oustide of the assets. I recommend creating a group gif for instance.
Quick Start
SwiftyGif uses familiar UIImage and UIImageView to display gifs.
Programmaticaly
import SwiftyGif
do {
let gif = try UIImage(gifName: "MyImage.gif")
let imageview = UIImageView(gifImage: gif, loopCount: 3) // Will loop 3 times
imageview.frame = view.bounds
view.addSubview(imageview)
} catch {
print(error)
}
Directly from nib/storyboard
@IBOutlet var myImageView : UIImageView!
...
let gif = try UIImage(gifName: "MyImage.gif")
self.myImageView.setGifImage(gif, loopCount: -1) // Will loop forever
Remote GIFs
// You can also set it with an URL pointing to your gif
let url = URL(string: "...")
let loader = UIActivityIndicatorView(style: .white)
cell.gifImageView.setGifFromURL(url, customLoader: loader)
Performances
A SwiftyGifManager can hold one or several UIImageView using the same memory pool. This allows you to tune the memory limits to you convenience. If no manager is declared, SwiftyGif will just use the SwiftyGifManager.defaultManager.
Level of integrity
Setting a lower level of integrity will allow for frame skipping, lowering both CPU and memory usage. This can be a good option if you need to preview a lot of gifs at the same time.
do {
let gif = try UIImage(gifName: "MyImage.gif", levelOfIntegrity:0.5)
} catch {
print(error)
}
Controls
SwiftyGif offer various controls on the current UIImageView playing your gif file.
self.myImageView.startAnimatingGif()
self.myImageView.stopAnimatingGif()
self.myImageView.showFrameAtIndexDelta(delta: Int)
self.myImageView.showFrameAtIndex(index: Int)
To allow easy use of those controls, some utility methods are provided :
self.myImageView.isAnimatingGif() // Returns wether the gif is currently playing
self.myImageView.gifImage!.framesCount() // Returns number of frames for this gif
Delegate
You can declare a SwiftyGifDelegate to receive updates on the gif lifecycle. For instance, if you want your controller MyController to act as the delegate:
override func viewDidLoad() {
super.viewDidLoad()
self.imageView.delegate = self
}
Then simply add an extension:
extension MyController : SwiftyGifDelegate {
func gifURLDidFinish(sender: UIImageView) {
print("gifURLDidFinish")
}
func gifURLDidFail(sender: UIImageView) {
print("gifURLDidFail")
}
func gifDidStart(sender: UIImageView) {
print("gifDidStart")
}
func gifDidLoop(sender: UIImageView) {
print("gifDidLoop")
}
func gifDidStop(sender: UIImageView) {
print("gifDidStop")
}
}
Benchmark
Display 1 Image
| CPU Usage(average) | Memory Usage(average) | |
|---|---|---|
| FLAnimatedImage | 35% | 9,5Mb |
| SwiftyGif | 2% | 18,4Mb |
| SwiftyGif(memoryLimit:10) | 34% | 9,5Mb |
Display 6 Images
| CPU Usage(average) | Memory Usage(average) | |
|---|---|---|
| FLAnimatedImage | 65% | 25,1Mb |
| SwiftyGif | 22% | 105Mb |
| SwiftyGif(memoryLimit:20) | 45% | 26Mb |
Measured on an iPhone 6S, iOS 9.3.1 and Xcode 7.3.
2.8k Jan 7, 2023
561 Sep 9, 2022
2.1k Dec 30, 2022
343 Oct 29, 2022
72 Sep 19, 2022
290 Dec 17, 2022
1.3k Dec 20, 2022
5 May 7, 2022
1 Jan 1, 2022
95 Jun 24, 2022
16 Jan 4, 2023
80 Dec 20, 2022
232 Jan 2, 2023
35 Jan 1, 2023
1.2k Dec 17, 2022
28 Oct 28, 2022
1.7k Jan 3, 2023
1.8k Jan 3, 2023
1k Nov 9, 2022