Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add APNG support when reading and decoding the data #143

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+78 −22
Open

add APNG support when reading and decoding the data #143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions FLAnimatedImage/FLAnimatedImage.h
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ extern const NSTimeInterval kFLAnimatedImageDelayTimeIntervalMinimum;

@property (nonatomic, assign, readonly) NSUInteger frameCacheSizeCurrent; // Current size of intelligently chosen buffer window; can range in the interval [1..frameCount]
@property (nonatomic, assign) NSUInteger frameCacheSizeMax; // Allow to cap the cache size; 0 means no specific limit (default)

@property (nonatomic, assign, readonly) CFStringRef imageSourceContainerType;
// Intended to be called from main thread synchronously; will return immediately.
// If the result isn't cached, will return `nil`; the caller should then pause playback, not increment frame counter and keep polling.
// After an initial loading time, depending on `frameCacheSize`, frames should be available immediately from the cache.
Expand All @@ -51,10 +51,13 @@ extern const NSTimeInterval kFLAnimatedImageDelayTimeIntervalMinimum;

// On success, the initializers return an `FLAnimatedImage` with all fields initialized, on failure they return `nil` and an error will be logged.
- (instancetype)initWithAnimatedGIFData:(NSData *)data;
// Don't know whether to combine with the method above and name it "initWithAnimatedData"
- (instancetype)initWithAnimatedPNGData:(NSData *)data;
// Pass 0 for optimalFrameCacheSize to get the default, predrawing is enabled by default.
- (instancetype)initWithAnimatedGIFData:(NSData *)data optimalFrameCacheSize:(NSUInteger)optimalFrameCacheSize predrawingEnabled:(BOOL)isPredrawingEnabled NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithAnimatedImageData:(NSData *)data optimalFrameCacheSize:(NSUInteger)optimalFrameCacheSize predrawingEnabled:(BOOL)isPredrawingEnabled NS_DESIGNATED_INITIALIZER;
+ (instancetype)animatedImageWithGIFData:(NSData *)data;

// Don't know whether to combine with the method above and name it "animatedImageWithData"
+ (instancetype)animatedImageWithPNGData:(NSData *)data;
@property (nonatomic, strong, readonly) NSData *data; // The data the receiver was initialized with; read-only

@end
Expand Down
91 changes: 72 additions & 19 deletions FLAnimatedImage/FLAnimatedImage.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,15 +174,20 @@ - (instancetype)init

- (instancetype)initWithAnimatedGIFData:(NSData *)data
{
return [self initWithAnimatedGIFData:data optimalFrameCacheSize:0 predrawingEnabled:YES];
return [self initWithAnimatedImageData:data optimalFrameCacheSize:0 predrawingEnabled:YES];
}

- (instancetype)initWithAnimatedGIFData:(NSData *)data optimalFrameCacheSize:(NSUInteger)optimalFrameCacheSize predrawingEnabled:(BOOL)isPredrawingEnabled
- (instancetype)initWithAnimatedPNGData:(NSData *)data
{
return [self initWithAnimatedImageData:data optimalFrameCacheSize:0 predrawingEnabled:YES];
}

- (instancetype)initWithAnimatedImageData:(NSData *)data optimalFrameCacheSize:(NSUInteger)optimalFrameCacheSize predrawingEnabled:(BOOL)isPredrawingEnabled
{
// Early return if no data supplied!
BOOL hasData = ([data length] > 0);
if (!hasData) {
FLLog(FLLogLevelError, @"No animated GIF data supplied.");
FLLog(FLLogLevelError, @"No animated Image (GIF or PNG) data supplied.");
return nil;
}

Expand All @@ -205,15 +210,15 @@ - (instancetype)initWithAnimatedGIFData:(NSData *)data optimalFrameCacheSize:(NS
(__bridge CFDictionaryRef)@{(NSString *)kCGImageSourceShouldCache: @NO});
// Early return on failure!
if (!_imageSource) {
FLLog(FLLogLevelError, @"Failed to `CGImageSourceCreateWithData` for animated GIF data %@", data);
FLLog(FLLogLevelError, @"Failed to `CGImageSourceCreateWithData` for animated GIF or APNG data %@", data);
return nil;
}

// Early return if not GIF!
CFStringRef imageSourceContainerType = CGImageSourceGetType(_imageSource);
BOOL isGIFData = UTTypeConformsTo(imageSourceContainerType, kUTTypeGIF);
if (!isGIFData) {
FLLog(FLLogLevelError, @"Supplied data is of type %@ and doesn't seem to be GIF data %@", imageSourceContainerType, data);
// Early return if not GIF or PNG!
_imageSourceContainerType = CGImageSourceGetType(_imageSource);
BOOL isAnimatedData = [self isAnimatedData];
if (!isAnimatedData) {
FLLog(FLLogLevelError, @"Supplied data is of type %@ and doesn't seem to be GIF or APNG data %@", _imageSourceContainerType, data);
return nil;
}

Expand All @@ -228,8 +233,7 @@ - (instancetype)initWithAnimatedGIFData:(NSData *)data optimalFrameCacheSize:(NS
// };
// }
NSDictionary *imageProperties = (__bridge_transfer NSDictionary *)CGImageSourceCopyProperties(_imageSource, NULL);
_loopCount = [[[imageProperties objectForKey:(id)kCGImagePropertyGIFDictionary] objectForKey:(id)kCGImagePropertyGIFLoopCount] unsignedIntegerValue];

_loopCount = [self loopCountFromImageSource];
// Iterate through frame images
size_t imageCount = CGImageSourceGetCount(_imageSource);
NSUInteger skippedFrameCount = 0;
Expand Down Expand Up @@ -267,14 +271,23 @@ - (instancetype)initWithAnimatedGIFData:(NSData *)data optimalFrameCacheSize:(NS
// }

NSDictionary *frameProperties = (__bridge_transfer NSDictionary *)CGImageSourceCopyPropertiesAtIndex(_imageSource, i, NULL);
NSDictionary *framePropertiesGIF = [frameProperties objectForKey:(id)kCGImagePropertyGIFDictionary];

// Try to use the unclamped delay time; fall back to the normal delay time.
NSNumber *delayTime = [framePropertiesGIF objectForKey:(id)kCGImagePropertyGIFUnclampedDelayTime];
if (!delayTime) {
delayTime = [framePropertiesGIF objectForKey:(id)kCGImagePropertyGIFDelayTime];
NSNumber *delayTime;
if(UTTypeConformsTo(_imageSourceContainerType, kUTTypeGIF)){
NSDictionary *framePropertiesGIF = [frameProperties objectForKey:(id)kCGImagePropertyGIFDictionary];
// Try to use the unclamped delay time; fall back to the normal delay time.
delayTime = [framePropertiesGIF objectForKey:(id)kCGImagePropertyGIFUnclampedDelayTime];
if (!delayTime) {
delayTime = [framePropertiesGIF objectForKey:(id)kCGImagePropertyGIFDelayTime];
// If we don't get a delay time from the properties, fall back to `kDelayTimeIntervalDefault` or carry over the preceding frame's value.
}
}else{
//for the case of APNG
NSDictionary *framePropertiesAPNG = [frameProperties objectForKey:(id)kCGImagePropertyPNGDictionary];
delayTime = [framePropertiesAPNG objectForKey:(id)kCGImagePropertyAPNGUnclampedDelayTime];
if (!delayTime) {
delayTime = [framePropertiesAPNG objectForKey:(id)kCGImagePropertyAPNGDelayTime];
}
}
// If we don't get a delay time from the properties, fall back to `kDelayTimeIntervalDefault` or carry over the preceding frame's value.
const NSTimeInterval kDelayTimeIntervalDefault = 0.1;
if (!delayTime) {
if (i == 0) {
Expand Down Expand Up @@ -359,6 +372,11 @@ + (instancetype)animatedImageWithGIFData:(NSData *)data
return animatedImage;
}

+ (instancetype)animatedImageWithPNGData:(NSData *)data
{
FLAnimatedImage *animatedImage = [[FLAnimatedImage alloc] initWithAnimatedPNGData:data];
return animatedImage;
}

- (void)dealloc
{
Expand Down Expand Up @@ -508,8 +526,43 @@ + (CGSize)sizeForImage:(id)image


#pragma mark - Private Methods
#pragma mark Frame Loading
#pragma mark
- (BOOL) isAnimatedData
{
CFStringRef imageSourceContainerType = CGImageSourceGetType(_imageSource);
if(UTTypeConformsTo(imageSourceContainerType, kUTTypeGIF)){
return TRUE;
}else if(UTTypeConformsTo(imageSourceContainerType, kUTTypePNG)){
//PNG and APNG have same UTType, so see if it has metadata for animations
NSDictionary *imageProperties = (__bridge NSDictionary *)CGImageSourceCopyPropertiesAtIndex(_imageSource, 0, NULL);
NSDictionary *metaPNGData =[imageProperties objectForKey:@"{PNG}"];
if([metaPNGData objectForKey:@"DelayTime"] && [metaPNGData objectForKey:@"UnclampedDelayTime"]){
return TRUE;
}else{
return FALSE;
}
}else{
return FALSE;
}
}

-(NSUInteger) loopCountFromImageSource
{
NSDictionary *imageProperties = (__bridge_transfer NSDictionary *)CGImageSourceCopyProperties(_imageSource, NULL);

if(UTTypeConformsTo(_imageSourceContainerType, kUTTypeGIF)){
return [[[imageProperties objectForKey:(id)kCGImagePropertyGIFDictionary] objectForKey:(id)kCGImagePropertyGIFLoopCount] unsignedIntegerValue];
}else if(UTTypeConformsTo(_imageSourceContainerType, kUTTypePNG)){
return [[[imageProperties objectForKey:(id)kCGImagePropertyPNGDictionary] objectForKey:(id)kCGImagePropertyAPNGLoopCount] unsignedIntegerValue];
}
else{
FLLog(FLLogLevelError, @"Supplied data is of type %@ and doesn't seem to be GIF or APNG data", _imageSourceContainerType);
}
//default
return 0;
}

#pragma mark Frame Loading
- (UIImage *)imageAtIndex:(NSUInteger)index
{
// It's very important to use the cached `_imageSource` since the random access to a frame with `CGImageSourceCreateImageAtIndex` turns from an O(1) into an O(n) operation when re-initializing the image source every time.
Expand Down