YYImage.m 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254
  1. //
  2. // YYImage.m
  3. // YYImage <https://github.com/ibireme/YYImage>
  4. //
  5. // Created by ibireme on 14/10/20.
  6. // Copyright (c) 2015 ibireme.
  7. //
  8. // This source code is licensed under the MIT-style license found in the
  9. // LICENSE file in the root directory of this source tree.
  10. //
  11. #import "YYImage.h"
  12. /**
  13. An array of NSNumber objects, shows the best order for path scale search.
  14. e.g. iPhone3GS:@[@1,@2,@3] iPhone5:@[@2,@3,@1] iPhone6 Plus:@[@3,@2,@1]
  15. */
  16. static NSArray *_NSBundlePreferredScales() {
  17. static NSArray *scales;
  18. static dispatch_once_t onceToken;
  19. dispatch_once(&onceToken, ^{
  20. CGFloat screenScale = [UIScreen mainScreen].scale;
  21. if (screenScale <= 1) {
  22. scales = @[@1,@2,@3];
  23. } else if (screenScale <= 2) {
  24. scales = @[@2,@3,@1];
  25. } else {
  26. scales = @[@3,@2,@1];
  27. }
  28. });
  29. return scales;
  30. }
  31. /**
  32. Add scale modifier to the file name (without path extension),
  33. From @"name" to @"name@2x".
  34. e.g.
  35. <table>
  36. <tr><th>Before </th><th>After(scale:2)</th></tr>
  37. <tr><td>"icon" </td><td>"icon@2x" </td></tr>
  38. <tr><td>"icon " </td><td>"icon @2x" </td></tr>
  39. <tr><td>"icon.top" </td><td>"icon.top@2x" </td></tr>
  40. <tr><td>"/p/name" </td><td>"/p/name@2x" </td></tr>
  41. <tr><td>"/path/" </td><td>"/path/" </td></tr>
  42. </table>
  43. @param scale Resource scale.
  44. @return String by add scale modifier, or just return if it's not end with file name.
  45. */
  46. static NSString *_NSStringByAppendingNameScale(NSString *string, CGFloat scale) {
  47. if (!string) return nil;
  48. if (fabs(scale - 1) <= __FLT_EPSILON__ || string.length == 0 || [string hasSuffix:@"/"]) return string.copy;
  49. return [string stringByAppendingFormat:@"@%@x", @(scale)];
  50. }
  51. /**
  52. Return the path scale.
  53. e.g.
  54. <table>
  55. <tr><th>Path </th><th>Scale </th></tr>
  56. <tr><td>"icon.png" </td><td>1 </td></tr>
  57. <tr><td>"icon@2x.png" </td><td>2 </td></tr>
  58. <tr><td>"icon@2.5x.png" </td><td>2.5 </td></tr>
  59. <tr><td>"icon@2x" </td><td>1 </td></tr>
  60. <tr><td>"icon@2x..png" </td><td>1 </td></tr>
  61. <tr><td>"icon@2x.png/" </td><td>1 </td></tr>
  62. </table>
  63. */
  64. static CGFloat _NSStringPathScale(NSString *string) {
  65. if (string.length == 0 || [string hasSuffix:@"/"]) return 1;
  66. NSString *name = string.stringByDeletingPathExtension;
  67. __block CGFloat scale = 1;
  68. NSRegularExpression *pattern = [NSRegularExpression regularExpressionWithPattern:@"@[0-9]+\\.?[0-9]*x$" options:NSRegularExpressionAnchorsMatchLines error:nil];
  69. [pattern enumerateMatchesInString:name options:kNilOptions range:NSMakeRange(0, name.length) usingBlock:^(NSTextCheckingResult *result, NSMatchingFlags flags, BOOL *stop) {
  70. if (result.range.location >= 3) {
  71. scale = [string substringWithRange:NSMakeRange(result.range.location + 1, result.range.length - 2)].doubleValue;
  72. }
  73. }];
  74. return scale;
  75. }
  76. @implementation YYImage {
  77. YYImageDecoder *_decoder;
  78. NSArray *_preloadedFrames;
  79. dispatch_semaphore_t _preloadedLock;
  80. NSUInteger _bytesPerFrame;
  81. }
  82. + (YYImage *)imageNamed:(NSString *)name {
  83. if (name.length == 0) return nil;
  84. if ([name hasSuffix:@"/"]) return nil;
  85. NSString *res = name.stringByDeletingPathExtension;
  86. NSString *ext = name.pathExtension;
  87. NSString *path = nil;
  88. CGFloat scale = 1;
  89. // If no extension, guess by system supported (same as UIImage).
  90. NSArray *exts = ext.length > 0 ? @[ext] : @[@"", @"png", @"jpeg", @"jpg", @"gif", @"webp", @"apng"];
  91. NSArray *scales = _NSBundlePreferredScales();
  92. for (int s = 0; s < scales.count; s++) {
  93. scale = ((NSNumber *)scales[s]).floatValue;
  94. NSString *scaledName = _NSStringByAppendingNameScale(res, scale);
  95. for (NSString *e in exts) {
  96. path = [[NSBundle mainBundle] pathForResource:scaledName ofType:e];
  97. if (path) break;
  98. }
  99. if (path) break;
  100. }
  101. if (path.length == 0) return nil;
  102. NSData *data = [NSData dataWithContentsOfFile:path];
  103. if (data.length == 0) return nil;
  104. return [[self alloc] initWithData:data scale:scale];
  105. }
  106. + (YYImage *)imageWithContentsOfFile:(NSString *)path {
  107. return [[self alloc] initWithContentsOfFile:path];
  108. }
  109. + (YYImage *)imageWithData:(NSData *)data {
  110. return [[self alloc] initWithData:data];
  111. }
  112. + (YYImage *)imageWithData:(NSData *)data scale:(CGFloat)scale {
  113. return [[self alloc] initWithData:data scale:scale];
  114. }
  115. - (instancetype)initWithContentsOfFile:(NSString *)path {
  116. NSData *data = [NSData dataWithContentsOfFile:path];
  117. return [self initWithData:data scale:_NSStringPathScale(path)];
  118. }
  119. - (instancetype)initWithData:(NSData *)data {
  120. return [self initWithData:data scale:1];
  121. }
  122. - (instancetype)initWithData:(NSData *)data scale:(CGFloat)scale {
  123. if (data.length == 0) return nil;
  124. if (scale <= 0) scale = [UIScreen mainScreen].scale;
  125. _preloadedLock = dispatch_semaphore_create(1);
  126. @autoreleasepool {
  127. YYImageDecoder *decoder = [YYImageDecoder decoderWithData:data scale:scale];
  128. YYImageFrame *frame = [decoder frameAtIndex:0 decodeForDisplay:YES];
  129. UIImage *image = frame.image;
  130. if (!image) return nil;
  131. self = [self initWithCGImage:image.CGImage scale:decoder.scale orientation:image.imageOrientation];
  132. if (!self) return nil;
  133. _animatedImageType = decoder.type;
  134. if (decoder.frameCount > 1) {
  135. _decoder = decoder;
  136. _bytesPerFrame = CGImageGetBytesPerRow(image.CGImage) * CGImageGetHeight(image.CGImage);
  137. _animatedImageMemorySize = _bytesPerFrame * decoder.frameCount;
  138. }
  139. self.yy_isDecodedForDisplay = YES;
  140. }
  141. return self;
  142. }
  143. - (NSData *)animatedImageData {
  144. return _decoder.data;
  145. }
  146. - (void)setPreloadAllAnimatedImageFrames:(BOOL)preloadAllAnimatedImageFrames {
  147. if (_preloadAllAnimatedImageFrames != preloadAllAnimatedImageFrames) {
  148. if (preloadAllAnimatedImageFrames && _decoder.frameCount > 0) {
  149. NSMutableArray *frames = [NSMutableArray new];
  150. for (NSUInteger i = 0, max = _decoder.frameCount; i < max; i++) {
  151. UIImage *img = [self animatedImageFrameAtIndex:i];
  152. if (img) {
  153. [frames addObject:img];
  154. } else {
  155. [frames addObject:[NSNull null]];
  156. }
  157. }
  158. dispatch_semaphore_wait(_preloadedLock, DISPATCH_TIME_FOREVER);
  159. _preloadedFrames = frames;
  160. dispatch_semaphore_signal(_preloadedLock);
  161. } else {
  162. dispatch_semaphore_wait(_preloadedLock, DISPATCH_TIME_FOREVER);
  163. _preloadedFrames = nil;
  164. dispatch_semaphore_signal(_preloadedLock);
  165. }
  166. }
  167. }
  168. #pragma mark - protocol NSCoding
  169. - (instancetype)initWithCoder:(NSCoder *)aDecoder {
  170. NSNumber *scale = [aDecoder decodeObjectForKey:@"YYImageScale"];
  171. NSData *data = [aDecoder decodeObjectForKey:@"YYImageData"];
  172. if (data.length) {
  173. self = [self initWithData:data scale:scale.doubleValue];
  174. } else {
  175. self = [super initWithCoder:aDecoder];
  176. }
  177. return self;
  178. }
  179. - (void)encodeWithCoder:(NSCoder *)aCoder {
  180. if (_decoder.data.length) {
  181. [aCoder encodeObject:@(self.scale) forKey:@"YYImageScale"];
  182. [aCoder encodeObject:_decoder.data forKey:@"YYImageData"];
  183. } else {
  184. [super encodeWithCoder:aCoder]; // Apple use UIImagePNGRepresentation() to encode UIImage.
  185. }
  186. }
  187. #pragma mark - protocol YYAnimatedImage
  188. - (NSUInteger)animatedImageFrameCount {
  189. return _decoder.frameCount;
  190. }
  191. - (NSUInteger)animatedImageLoopCount {
  192. return _decoder.loopCount;
  193. }
  194. - (NSUInteger)animatedImageBytesPerFrame {
  195. return _bytesPerFrame;
  196. }
  197. - (UIImage *)animatedImageFrameAtIndex:(NSUInteger)index {
  198. if (index >= _decoder.frameCount) return nil;
  199. dispatch_semaphore_wait(_preloadedLock, DISPATCH_TIME_FOREVER);
  200. UIImage *image = _preloadedFrames[index];
  201. dispatch_semaphore_signal(_preloadedLock);
  202. if (image) return image == (id)[NSNull null] ? nil : image;
  203. return [_decoder frameAtIndex:index decodeForDisplay:YES].image;
  204. }
  205. - (NSTimeInterval)animatedImageDurationAtIndex:(NSUInteger)index {
  206. NSTimeInterval duration = [_decoder frameDurationAtIndex:index];
  207. /*
  208. http://opensource.apple.com/source/WebCore/WebCore-7600.1.25/platform/graphics/cg/ImageSourceCG.cpp
  209. Many annoying ads specify a 0 duration to make an image flash as quickly as
  210. possible. We follow Safari and Firefox's behavior and use a duration of 100 ms
  211. for any frames that specify a duration of <= 10 ms.
  212. See <rdar://problem/7689300> and <http://webkit.org/b/36082> for more information.
  213. See also: http://nullsleep.tumblr.com/post/16524517190/animated-gif-minimum-frame-delay-browser.
  214. */
  215. if (duration < 0.011f) return 0.100f;
  216. return duration;
  217. }
  218. @end