Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metasmile/NSGIF2
Convert live photos and videos into animated GIFs in iOS, or extract frames from them.
https://github.com/metasmile/NSGIF2
animated-gif gif gif-library
Last synced: 25 days ago
JSON representation
Convert live photos and videos into animated GIFs in iOS, or extract frames from them.
- Host: GitHub
- URL: https://github.com/metasmile/NSGIF2
- Owner: metasmile
- License: mit
- Fork: true (NSRare/NSGIF)
- Created: 2016-03-31T06:26:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-12-04T11:25:41.000Z (almost 6 years ago)
- Last Synced: 2024-08-03T05:21:35.042Z (about 1 month ago)
- Topics: animated-gif, gif, gif-library
- Language: Objective-C
- Homepage:
- Size: 1000 KB
- Stars: 82
- Watchers: 5
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ios - NSGIF2 - Simplify creation of a GIF from the provided video file url. (Media / GIF)
- awesome-ios-star - NSGIF2 - Simplify creation of a GIF from the provided video file url. (Media / GIF)
README
[](https://github.com/vsouza/awesome-ios#gif)
[](http://waffle.io/metasmile/NSGIF2)
Create a GIF from the provided video file url, Or extract images from videos.
*This repository has been separated from original repo along with some nontrivial different features, designs, and improvements. Please do diff each other, and visit [original repo](https://github.com/NSRare/NSGIF) for more information if you need.*
## Installation
### Framework Requirements
```
Accelerate.framework
```
There are 2 ways you can add NSGIF to your project:
### Manual
Simply import the 'NSGIF' into your project then import the following in the class you want to use it:
```objective-c
#import "NSGIF.h"
```
### From CocoaPods
```ruby
pod "NSGIF2"
```
## Usage - GIF from a video
Default request automatically set essential options such as the best frame count, delay time, output temp file name, or size. see interface file for more options.
### Write 1 line to export
```objective-c
[NSGIF create:[NSGIFRequest requestWithSourceVideo:tempVideoFileURL] completion:^(NSURL *GifURL) {
//GifURL is to nil if it failed or stopped.
}];
```
### If you need more.
```objective-c
NSGIFRequest * request = [NSGIFRequest requestWithSourceVideo:tempVideoFileURL destination:gifFileURL];
request.progressHandler = ^(double progress, NSUInteger position, NSUInteger length, CMTime time, BOOL *stop, NSDictionary *frameProperties) {
NSLog(@"%f - %lu - %lu - %lld - %@", progress, position, length, time.value, frameProperties);
};
[NSGIF create:request completion:^(NSURL *GifURL) {
//GifURL is to nil if it failed or stopped.
}];
```
### Interrupt process for given request
```objective-c
request.progressHandler = ^(double progress, NSUInteger position, NSUInteger length, CMTime time, BOOL *stop, NSDictionary *frameProperties) {
BOOL cancelationCondition = YES;
if(cancelationCondition){
*stop = YES;
}
};
```
## Options - NSGIFRequest
```objective-c
/* required.
* a file's url of source video */
@property(nullable, nonatomic) NSURL * sourceVideoFile;
/* optional.
* defaults to nil.
* automatically assign the file name of source video (ex: IMG_0000.MOV -> IMG_0000.gif) */
@property(nullable, nonatomic) NSURL * destinationVideoFile;
/* optional but important.
* Defaults to NSGIFScaleOptimize (not set).
* This option will affect gif file size, memory usage and processing speed. */
@property(nonatomic, assign) NSGIFScale scalePreset;
/* optional but important.
* Defaults to 4.
* number of frames in seconds.
* This option will affect gif file size, memory usage and processing speed. */
@property(nonatomic, assign) NSUInteger framesPerSecond;
/* optional but defaults is recommended.
* Defaults is to not set.
* How far along the video track we want to move, in seconds. It will automatically assign from duration of video and framesPerSecond. */
@property(nonatomic, assign) NSUInteger frameCount;
/* optional.
* Defaults to 0,
* the number of times the GIF will repeat. which means repeat infinitely. */
@property(nonatomic, assign) NSUInteger loopCount;
/* optional.
* Defaults to 0.13.
* unit is 10ms, 1/100s, the amount of time for each frame in the GIF.
* This option will NOT affect gif file size, memory usage and processing speed. It affect only FPS. */
@property(nonatomic, assign) CGFloat delayTime;
/* optional.
* Defaults is to not set. unit is seconds, which means unlimited */
@property(nonatomic, assign) NSTimeInterval maxDuration;
/* optional.
* Defaults is to not set.
* This option will crop(via AspectFill Mode) fast while create each images. Their size will be automatically calculated.
* ex)
* square : aspectRatioToCrop = CGSizeMake(1,1)
* 16:9 : aspectRatioToCrop = CGSizeMake(16,9) */
@property(nonatomic, assign) CGSize aspectRatioToCrop;
/* optional.
* Defaults is nil */
@property (nonatomic, copy, nullable) NSGIFProgressHandler progressHandler;
/* gif creation job is now proceeding */
@property(atomic, readonly) BOOL proceeding;
```
## Usage - Extract each frames from a video to images.
```objective-c
NSFrameExtractingRequest * request = [NSFrameExtractingRequest requestWithSourceVideo:videoURL];
request.progressHandler = ^(double progress, NSUInteger offset, NSUInteger length, CMTime time, BOOL *stop, NSDictionary *frameProperties) {
// normalized progress, Zero to 1.
};
request.framesPerSecond = 2;
[NSGIF extract:request completion:^(NSArray *extractedFrameImageUrls) {
//complete.
}];
```
## Options - NSFrameExtractingRequest
```objective-c
/* required.
* a file's url of source video */
@property(nullable, nonatomic) NSURL * sourceVideoFile;
/* optional.
* defaults to temp directory.
*/
@property(nullable, nonatomic) NSURL * destinationDirectory;
/* optional.
* Defaults to jpg.
* This property will be affect to UTType(Automatically detected) of extracting image file.
*/
@property(nonatomic, readwrite, nullable) NSString * extension;
/* optional but important.
* Defaults to NSGIFScaleOptimize (not set).
* This option will affect gif file size, memory usage and processing speed. */
@property(nonatomic, assign) NSGIFScale scalePreset;
/* optional.
* Defaults is to not set. unit is seconds, which means unlimited */
@property(nonatomic, assign) NSTimeInterval maxDuration;
/* optional but important.
* Defaults to 4.
* number of frames in seconds.
* This option will affect gif file size, memory usage and processing speed. */
@property(nonatomic, assign) NSUInteger framesPerSecond;
/* optional but defaults is recommended.
* Defaults is to not set.
* How far along the video track we want to move, in seconds. It will automatically assign from duration of video and framesPerSecond. */
@property(nonatomic, assign) NSUInteger frameCount;
/* optional.
* Defaults is to not set.
* This option will crop(via AspectFill Mode) fast while create each images. Their size will be automatically calculated.
* ex)
* square : aspectRatioToCrop = CGSizeMake(1,1)
* 16:9 : aspectRatioToCrop = CGSizeMake(16,9) */
@property(nonatomic, assign) CGSize aspectRatioToCrop;
/* optional.
* Defaults is nil */
@property (nonatomic, copy, nullable) NSGIFProgressHandler progressHandler;
/* readonly
* status for gif creating job 'YES' equals to 'now proceeding'
*/
@property(atomic, readonly) BOOL proceeding;
```
## In the future, I will add a feature that can
* create from a provided photo url.
* perform simultaneous processing with provided specific chunk size.
* seek for specific point.
* generate infinite lengh of GIFs (Split with specific chunk size -> encoding -> merge each encoded piece of gifs.)
* use APIs which is pefectly similar with PhotosKit of iOS.
Pull requests are more than welcomed!
## License
Usage is provided under the [MIT License](http://http//opensource.org/licenses/mit-license.php). See LICENSE for the full details.