YYImage 1.0.4

YYImage 1.0.4

×

测试已测试✗
Lang语言 Obj-CObjective C
许可证 MIT
发布最新发布2016年11月

由 ibireme 维护。

YYImage 1.0.4

         

iOS 的图像框架，用于显示/编码/解码动画 WebP、APNG、GIF 等图像。
（它是 YYKit 的组件）

niconiconi~

特点

  • 使用以下类型显示/编码/解码动画图像：
        WebP、APNG、GIF。
  • 使用以下类型显示/编码/解码静止图像：
        WebP、PNG、GIF、JPEG、JP2、TIFF、BMP、ICO、ICNS。
  • 使用以下类型进行基线/渐进/交织图像解码：
        PNG、GIF、JPEG、BMP。
  • 显示基于帧的图像动画和精灵表动画。
  • 动态内存缓冲区，以降低内存使用。
  • 完全兼容于 UIImage 和 UIImageView 类。
  • 可扩展的协议，用于自定义图像动画。
  • 完全文档化。

使用方法

显示动画图像

// File: [email protected]
UIImage *image = [YYImage imageNamed:@"ani.gif"];
UIImageView *imageView = [[YYAnimatedImageView alloc] initWithImage:image];
[self.view addSubView:imageView];

显示帧动画

// Files: frame1.png, frame2.png, frame3.png
NSArray *paths = @[@"/ani/frame1.png", @"/ani/frame2.png", @"/ani/frame3.png"];
NSArray *times = @[@0.1, @0.2, @0.1];
UIImage *image = [YYFrameImage alloc] initWithImagePaths:paths frameDurations:times repeats:YES];
UIImageView *imageView = [YYAnimatedImageView alloc] initWithImage:image];
[self.view addSubView:imageView];

显示精灵表动画

// 8 * 12 sprites in a single sheet image
UIImage *spriteSheet = [UIImage imageNamed:@"sprite-sheet"];
NSMutableArray *contentRects = [NSMutableArray new];
NSMutableArray *durations = [NSMutableArray new];
for (int j = 0; j < 12; j++) {
   for (int i = 0; i < 8; i++) {
       CGRect rect;
       rect.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
       rect.origin.x = img.size.width / 8 * i;
       rect.origin.y = img.size.height / 12 * j;
       [contentRects addObject:[NSValue valueWithCGRect:rect]];
       [durations addObject:@(1 / 60.0)];
   }
}
YYSpriteSheetImage *sprite;
sprite = [[YYSpriteSheetImage alloc] initWithSpriteSheetImage:img
                                                contentRects:contentRects
                                              frameDurations:durations
                                                   loopCount:0];
YYAnimatedImageView *imageView = [YYAnimatedImageView new];
imageView.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
imageView.image = sprite;
[self.view addSubView:imageView];

动画控制

YYAnimatedImageView *imageView = ...;
// pause:
[imageView stopAnimating];
// play:
[imageView startAnimating];
// set frame index:
imageView.currentAnimatedImageIndex = 12;
// get current status
image.currentIsPlayingAnimation;

图像解码器

// Decode single frame:
NSData *data = [NSData dataWithContentsOfFile:@"/tmp/image.webp"];
YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:2.0];
UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;

// Progressive:
NSMutableData *data = [NSMutableData new];
YYImageDecoder *decoder = [[YYImageDecoder alloc] initWithScale:2.0];
while(newDataArrived) {
   [data appendData:newData];
   [decoder updateData:data final:NO];
   if (decoder.frameCount > 0) {
       UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
       // progressive display...
   }
}
[decoder updateData:data final:YES];
UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
// final display...

图像编码器

// Encode still image:
YYImageEncoder *jpegEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeJPEG];
jpegEncoder.quality = 0.9;
[jpegEncoder addImage:image duration:0];
NSData jpegData = [jpegEncoder encode];

// Encode animated image:
YYImageEncoder *webpEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeWebP];
webpEncoder.loopCount = 5;
[webpEncoder addImage:image0 duration:0.1];
[webpEncoder addImage:image1 duration:0.15];
[webpEncoder addImage:image2 duration:0.2];
NSData webpData = [webpEncoder encode];

图像类型检测

// Get image type from image data
YYImageType type = YYImageDetectType(data); 
if (type == YYImageTypePNG) ...

安装

手动

  1. 下载 YYImage 子目录中的所有文件。
  2. 将源文件添加到您的 Xcode 项目中。
  3. 链接所需框架
    • UIKit
    • CoreFoundation
    • QuartzCore
    • AssetsLibrary
    • ImageIO
    • Accelerate
    • MobileCoreServices
    • libz
  4. 导入 YYImage.h。
  5. 注意：如果您想支持 WebP 格式，您可能需要将 Vendor/WebP.framework（静态库）添加到您的 Xcode 项目中。

Faq

问题：为什么我不能显示 WebP 图像？

答案：确保您已将 WebP.framework 添加到项目中。您可以调用 YYImageWebPAvailable() 来检查 WebP 子规范是否正确安装。

问题：为什么我不能播放 APNG 动画？

A: 应该在你的项目构建设置中禁用 压缩 PNG 文件 和 从 PNG 文件中移除文字元数据。或者你也可以将你的 APNG 文件的扩展名重命名为 apng。

文档

完整的 API 文档可在线查阅 CocoaDocs。
你也可以使用 appledoc 在本地安装文档。

需求

该库需要支持 iOS 6.0+ 和 Xcode 7.0+。

许可证

YYImage 在 MIT 许可证下提供。详见 LICENSE 文件。



中文介绍

YYImage：功能强大的 iOS 图像框架。
(该项目是 YYKit 组件之一)

niconiconi~

特性

  • 支持播放/编码/解码以下类型的动画图像：
        WebP, APNG, GIF。
  • 支持显示/编码/解码以下类型的静态图像：
        WebP, PNG, GIF, JPEG, JP2, TIFF, BMP, ICO, ICNS。
  • 支持以下类型的图片渐进式/逐行扫描/隔行扫描解码：
        PNG, GIF, JPEG, BMP。
  • 支持由多张图片构成的帧动画播放，以及单张图片的 sprite sheet 动画。
  • 高效的动态内存缓存管理，确保高效率低内存使用下的动画播放。
  • 完全兼容 UIImage 和 UIImageView，使用方便。
  • 保留可扩展的接口，以支持自定义动画。
  • 每个类和方法都有完善的文档注释。

用法

显示动画类型的图片

// 文件: [email protected]
UIImage *image = [YYImage imageNamed:@"ani.gif"];
UIImageView *imageView = [[YYAnimatedImageView alloc] initWithImage:image];
[self.view addSubView:imageView];

播放帧动画

// 文件: frame1.png, frame2.png, frame3.png
NSArray *paths = @[@"/ani/frame1.png", @"/ani/frame2.png", @"/ani/frame3.png"];
NSArray *times = @[@0.1, @0.2, @0.1];
UIImage *image = [YYFrameImage alloc] initWithImagePaths:paths frameDurations:times repeats:YES];
UIImageView *imageView = [YYAnimatedImageView alloc] initWithImage:image];
[self.view addSubView:imageView];

播放 sprite sheet 动画

// 8 * 12 sprites in a single sheet image
UIImage *spriteSheet = [UIImage imageNamed:@"sprite-sheet"];
NSMutableArray *contentRects = [NSMutableArray new];
NSMutableArray *durations = [NSMutableArray new];
for (int j = 0; j < 12; j++) {
   for (int i = 0; i < 8; i++) {
       CGRect rect;
       rect.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
       rect.origin.x = img.size.width / 8 * i;
       rect.origin.y = img.size.height / 12 * j;
       [contentRects addObject:[NSValue valueWithCGRect:rect]];
       [durations addObject:@(1 / 60.0)];
   }
}
YYSpriteSheetImage *sprite;
sprite = [[YYSpriteSheetImage alloc] initWithSpriteSheetImage:img
                                                contentRects:contentRects
                                              frameDurations:durations
                                                   loopCount:0];
YYAnimatedImageView *imageView = [YYAnimatedImageView new];
imageView.size = CGSizeMake(img.size.width / 8, img.size.height / 12);
imageView.image = sprite;
[self.view addSubView:imageView];

动画播放控制

YYAnimatedImageView *imageView = ...;
// 暂停:
[imageView stopAnimating];
// 播放:
[imageView startAnimating];
// 设置播放进度:
imageView.currentAnimatedImageIndex = 12;
// 获取播放状态:
image.currentIsPlayingAnimation;
//上面两个属性都支持 KVO。

图片解码

// 解码单帧图片:
NSData *data = [NSData dataWithContentsOfFile:@"/tmp/image.webp"];
YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:2.0];
UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;

// 渐进式图片解码 (可用于图片下载显示):
NSMutableData *data = [NSMutableData new];
YYImageDecoder *decoder = [[YYImageDecoder alloc] initWithScale:2.0];
while(newDataArrived) {
   [data appendData:newData];
   [decoder updateData:data final:NO];
   if (decoder.frameCount > 0) {
       UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
       // progressive display...
   }
}
[decoder updateData:data final:YES];
UIImage image = [decoder frameAtIndex:0 decodeForDisplay:YES].image;
// final display...

图片编码

// 编码静态图 (支持各种常见图片格式):
YYImageEncoder *jpegEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeJPEG];
jpegEncoder.quality = 0.9;
[jpegEncoder addImage:image duration:0];
NSData jpegData = [jpegEncoder encode];

// 编码动态图 (支持 GIF/APNG/WebP):
YYImageEncoder *webpEncoder = [[YYImageEncoder alloc] initWithType:YYImageTypeWebP];
webpEncoder.loopCount = 5;
[webpEncoder addImage:image0 duration:0.1];
[webpEncoder addImage:image1 duration:0.15];
[webpEncoder addImage:image2 duration:0.2];
NSData webpData = [webpEncoder encode];

图片类型探测

// 获取图片类型
YYImageType type = YYImageDetectType(data); 
if (type == YYImageTypePNG) ...

安装

手动安装

  1. 下载 YYImage 文件夹内的所有内容。
  2. 将 YYImage 内的源文件添加(拖放)到你的工程中。
  3. 链接以下 frameworks
    • UIKit
    • CoreFoundation
    • QuartzCore
    • AssetsLibrary
    • ImageIO
    • Accelerate
    • MobileCoreServices
    • libz
  4. 导入 YYImage.h。
  5. 注意：如需支持 WebP，将 Vendor/WebP.framework(静态库) 加入到你的工程中。

常见问题

问：为什么我不能显示 WebP 图片？

A: 请确保 WebP.framework 已经被添加到你的工程中。你可以调用 YYImageWebPAvailable() 来检查 WebP 组件是否已正确安装。

问：为什么我不能播放 APNG 动画？

A: 你应该禁用 Build Settings 中的 压缩 PNG 文件 和 从 PNG 文件中移除文字元数据。或者你也可以把 APNG 文件的扩展名改为 apng。

文档

你可以在 CocoaDocs 查看在线 API 文档，也可以使用 appledoc 在本地生成文档。

系统要求

该项目最低支持 iOS 6.0 和 Xcode 7.0。

许可证

YYImage 使用 MIT 许可证，详情见 LICENSE 文件。

相关链接

移动端图片格式调研

iOS 处理图片的一些小技巧