ImageProcessor.swift 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. //
  2. // ImageProcessor.swift
  3. // Kingfisher
  4. //
  5. // Created by Wei Wang on 2016/08/26.
  6. //
  7. // Copyright (c) 2019 Wei Wang <onevcat@gmail.com>
  8. //
  9. // Permission is hereby granted, free of charge, to any person obtaining a copy
  10. // of this software and associated documentation files (the "Software"), to deal
  11. // in the Software without restriction, including without limitation the rights
  12. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. // copies of the Software, and to permit persons to whom the Software is
  14. // furnished to do so, subject to the following conditions:
  15. //
  16. // The above copyright notice and this permission notice shall be included in
  17. // all copies or substantial portions of the Software.
  18. //
  19. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. // THE SOFTWARE.
  26. import Foundation
  27. import CoreGraphics
  28. #if canImport(AppKit) && !targetEnvironment(macCatalyst)
  29. import AppKit
  30. #endif
  31. /// Represents an item which could be processed by an `ImageProcessor`.
  32. ///
  33. /// - image: Input image. The processor should provide a way to apply
  34. /// processing on this `image` and return the result image.
  35. /// - data: Input data. The processor should provide a way to apply
  36. /// processing on this `data` and return the result image.
  37. public enum ImageProcessItem {
  38. /// Input image. The processor should provide a way to apply
  39. /// processing on this `image` and return the result image.
  40. case image(KFCrossPlatformImage)
  41. /// Input data. The processor should provide a way to apply
  42. /// processing on this `data` and return the result image.
  43. case data(Data)
  44. }
  45. /// An `ImageProcessor` would be used to convert some downloaded data to an image.
  46. public protocol ImageProcessor {
  47. /// Identifier of the processor. It will be used to identify the processor when
  48. /// caching and retrieving an image. You might want to make sure that processors with
  49. /// same properties/functionality have the same identifiers, so correct processed images
  50. /// could be retrieved with proper key.
  51. ///
  52. /// - Note: Do not supply an empty string for a customized processor, which is already reserved by
  53. /// the `DefaultImageProcessor`. It is recommended to use a reverse domain name notation string of
  54. /// your own for the identifier.
  55. var identifier: String { get }
  56. /// Processes the input `ImageProcessItem` with this processor.
  57. ///
  58. /// - Parameters:
  59. /// - item: Input item which will be processed by `self`.
  60. /// - options: The parsed options when processing the item.
  61. /// - Returns: The processed image.
  62. ///
  63. /// - Note: The return value should be `nil` if processing failed while converting an input item to image.
  64. /// If `nil` received by the processing caller, an error will be reported and the process flow stops.
  65. /// If the processing flow is not critical for your flow, then when the input item is already an image
  66. /// (`.image` case) and there is any errors in the processing, you could return the input image itself
  67. /// to keep the processing pipeline continuing.
  68. /// - Note: Most processor only supports CG-based images. watchOS is not supported for processors containing
  69. /// a filter, the input image will be returned directly on watchOS.
  70. func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?
  71. }
  72. extension ImageProcessor {
  73. /// Appends an `ImageProcessor` to another. The identifier of the new `ImageProcessor`
  74. /// will be "\(self.identifier)|>\(another.identifier)".
  75. ///
  76. /// - Parameter another: An `ImageProcessor` you want to append to `self`.
  77. /// - Returns: The new `ImageProcessor` will process the image in the order
  78. /// of the two processors concatenated.
  79. public func append(another: ImageProcessor) -> ImageProcessor {
  80. let newIdentifier = identifier.appending("|>\(another.identifier)")
  81. return GeneralProcessor(identifier: newIdentifier) {
  82. item, options in
  83. if let image = self.process(item: item, options: options) {
  84. return another.process(item: .image(image), options: options)
  85. } else {
  86. return nil
  87. }
  88. }
  89. }
  90. }
  91. func ==(left: ImageProcessor, right: ImageProcessor) -> Bool {
  92. return left.identifier == right.identifier
  93. }
  94. func !=(left: ImageProcessor, right: ImageProcessor) -> Bool {
  95. return !(left == right)
  96. }
  97. typealias ProcessorImp = ((ImageProcessItem, KingfisherParsedOptionsInfo) -> KFCrossPlatformImage?)
  98. struct GeneralProcessor: ImageProcessor {
  99. let identifier: String
  100. let p: ProcessorImp
  101. func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  102. return p(item, options)
  103. }
  104. }
  105. /// The default processor. It converts the input data to a valid image.
  106. /// Images of .PNG, .JPEG and .GIF format are supported.
  107. /// If an image item is given as `.image` case, `DefaultImageProcessor` will
  108. /// do nothing on it and return the associated image.
  109. public struct DefaultImageProcessor: ImageProcessor {
  110. /// A default `DefaultImageProcessor` could be used across.
  111. public static let `default` = DefaultImageProcessor()
  112. /// Identifier of the processor.
  113. /// - Note: See documentation of `ImageProcessor` protocol for more.
  114. public let identifier = ""
  115. /// Creates a `DefaultImageProcessor`. Use `DefaultImageProcessor.default` to get an instance,
  116. /// if you do not have a good reason to create your own `DefaultImageProcessor`.
  117. public init() {}
  118. /// Processes the input `ImageProcessItem` with this processor.
  119. ///
  120. /// - Parameters:
  121. /// - item: Input item which will be processed by `self`.
  122. /// - options: Options when processing the item.
  123. /// - Returns: The processed image.
  124. ///
  125. /// - Note: See documentation of `ImageProcessor` protocol for more.
  126. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  127. switch item {
  128. case .image(let image):
  129. return image.kf.scaled(to: options.scaleFactor)
  130. case .data(let data):
  131. return KingfisherWrapper.image(data: data, options: options.imageCreatingOptions)
  132. }
  133. }
  134. }
  135. /// Represents the rect corner setting when processing a round corner image.
  136. public struct RectCorner: OptionSet {
  137. /// Raw value of the rect corner.
  138. public let rawValue: Int
  139. /// Represents the top left corner.
  140. public static let topLeft = RectCorner(rawValue: 1 << 0)
  141. /// Represents the top right corner.
  142. public static let topRight = RectCorner(rawValue: 1 << 1)
  143. /// Represents the bottom left corner.
  144. public static let bottomLeft = RectCorner(rawValue: 1 << 2)
  145. /// Represents the bottom right corner.
  146. public static let bottomRight = RectCorner(rawValue: 1 << 3)
  147. /// Represents all corners.
  148. public static let all: RectCorner = [.topLeft, .topRight, .bottomLeft, .bottomRight]
  149. /// Creates a `RectCorner` option set with a given value.
  150. ///
  151. /// - Parameter rawValue: The value represents a certain corner option.
  152. public init(rawValue: Int) {
  153. self.rawValue = rawValue
  154. }
  155. var cornerIdentifier: String {
  156. if self == .all {
  157. return ""
  158. }
  159. return "_corner(\(rawValue))"
  160. }
  161. }
  162. #if !os(macOS)
  163. /// Processor for adding an blend mode to images. Only CG-based images are supported.
  164. public struct BlendImageProcessor: ImageProcessor {
  165. /// Identifier of the processor.
  166. /// - Note: See documentation of `ImageProcessor` protocol for more.
  167. public let identifier: String
  168. /// Blend Mode will be used to blend the input image.
  169. public let blendMode: CGBlendMode
  170. /// Alpha will be used when blend image.
  171. public let alpha: CGFloat
  172. /// Background color of the output image. If `nil`, it will stay transparent.
  173. public let backgroundColor: KFCrossPlatformColor?
  174. /// Creates a `BlendImageProcessor`.
  175. ///
  176. /// - Parameters:
  177. /// - blendMode: Blend Mode will be used to blend the input image.
  178. /// - alpha: Alpha will be used when blend image. From 0.0 to 1.0. 1.0 means solid image,
  179. /// 0.0 means transparent image (not visible at all). Default is 1.0.
  180. /// - backgroundColor: Background color to apply for the output image. Default is `nil`.
  181. public init(blendMode: CGBlendMode, alpha: CGFloat = 1.0, backgroundColor: KFCrossPlatformColor? = nil) {
  182. self.blendMode = blendMode
  183. self.alpha = alpha
  184. self.backgroundColor = backgroundColor
  185. var identifier = "com.onevcat.Kingfisher.BlendImageProcessor(\(blendMode.rawValue),\(alpha))"
  186. if let color = backgroundColor {
  187. identifier.append("_\(color.rgbaDescription)")
  188. }
  189. self.identifier = identifier
  190. }
  191. /// Processes the input `ImageProcessItem` with this processor.
  192. ///
  193. /// - Parameters:
  194. /// - item: Input item which will be processed by `self`.
  195. /// - options: Options when processing the item.
  196. /// - Returns: The processed image.
  197. ///
  198. /// - Note: See documentation of `ImageProcessor` protocol for more.
  199. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  200. switch item {
  201. case .image(let image):
  202. return image.kf.scaled(to: options.scaleFactor)
  203. .kf.image(withBlendMode: blendMode, alpha: alpha, backgroundColor: backgroundColor)
  204. case .data:
  205. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  206. }
  207. }
  208. }
  209. #endif
  210. #if os(macOS)
  211. /// Processor for adding an compositing operation to images. Only CG-based images are supported in macOS.
  212. public struct CompositingImageProcessor: ImageProcessor {
  213. /// Identifier of the processor.
  214. /// - Note: See documentation of `ImageProcessor` protocol for more.
  215. public let identifier: String
  216. /// Compositing operation will be used to the input image.
  217. public let compositingOperation: NSCompositingOperation
  218. /// Alpha will be used when compositing image.
  219. public let alpha: CGFloat
  220. /// Background color of the output image. If `nil`, it will stay transparent.
  221. public let backgroundColor: KFCrossPlatformColor?
  222. /// Creates a `CompositingImageProcessor`
  223. ///
  224. /// - Parameters:
  225. /// - compositingOperation: Compositing operation will be used to the input image.
  226. /// - alpha: Alpha will be used when compositing image.
  227. /// From 0.0 to 1.0. 1.0 means solid image, 0.0 means transparent image.
  228. /// Default is 1.0.
  229. /// - backgroundColor: Background color to apply for the output image. Default is `nil`.
  230. public init(compositingOperation: NSCompositingOperation,
  231. alpha: CGFloat = 1.0,
  232. backgroundColor: KFCrossPlatformColor? = nil)
  233. {
  234. self.compositingOperation = compositingOperation
  235. self.alpha = alpha
  236. self.backgroundColor = backgroundColor
  237. var identifier = "com.onevcat.Kingfisher.CompositingImageProcessor(\(compositingOperation.rawValue),\(alpha))"
  238. if let color = backgroundColor {
  239. identifier.append("_\(color.rgbaDescription)")
  240. }
  241. self.identifier = identifier
  242. }
  243. /// Processes the input `ImageProcessItem` with this processor.
  244. ///
  245. /// - Parameters:
  246. /// - item: Input item which will be processed by `self`.
  247. /// - options: Options when processing the item.
  248. /// - Returns: The processed image.
  249. ///
  250. /// - Note: See documentation of `ImageProcessor` protocol for more.
  251. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  252. switch item {
  253. case .image(let image):
  254. return image.kf.scaled(to: options.scaleFactor)
  255. .kf.image(
  256. withCompositingOperation: compositingOperation,
  257. alpha: alpha,
  258. backgroundColor: backgroundColor)
  259. case .data:
  260. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  261. }
  262. }
  263. }
  264. #endif
  265. /// Represents a radius specified in a `RoundCornerImageProcessor`.
  266. public enum Radius {
  267. /// The radius should be calculated as a fraction of the image width. Typically the associated value should be
  268. /// between 0 and 0.5, where 0 represents no radius and 0.5 represents using half of the image width.
  269. case widthFraction(CGFloat)
  270. /// The radius should be calculated as a fraction of the image height. Typically the associated value should be
  271. /// between 0 and 0.5, where 0 represents no radius and 0.5 represents using half of the image height.
  272. case heightFraction(CGFloat)
  273. /// Use a fixed point value as the round corner radius.
  274. case point(CGFloat)
  275. var radiusIdentifier: String {
  276. switch self {
  277. case .widthFraction(let f):
  278. return "w_frac_\(f)"
  279. case .heightFraction(let f):
  280. return "h_frac_\(f)"
  281. case .point(let p):
  282. return p.description
  283. }
  284. }
  285. public func compute(with size: CGSize) -> CGFloat {
  286. let cornerRadius: CGFloat
  287. switch self {
  288. case .point(let point):
  289. cornerRadius = point
  290. case .widthFraction(let widthFraction):
  291. cornerRadius = size.width * widthFraction
  292. case .heightFraction(let heightFraction):
  293. cornerRadius = size.height * heightFraction
  294. }
  295. return cornerRadius
  296. }
  297. }
  298. /// Processor for making round corner images. Only CG-based images are supported in macOS,
  299. /// if a non-CG image passed in, the processor will do nothing.
  300. ///
  301. /// - Note: The input image will be rendered with round corner pixels removed. If the image itself does not contain
  302. /// alpha channel (for example, a JPEG image), the processed image will contain an alpha channel in memory in order
  303. /// to show correctly. However, when cached to disk, Kingfisher respects the original image format by default. That
  304. /// means the alpha channel will be removed for these images. When you load the processed image from cache again, you
  305. /// will lose transparent corner.
  306. ///
  307. /// You could use `FormatIndicatedCacheSerializer.png` to force Kingfisher to serialize the image to PNG format in this
  308. /// case.
  309. ///
  310. public struct RoundCornerImageProcessor: ImageProcessor {
  311. /// Identifier of the processor.
  312. /// - Note: See documentation of `ImageProcessor` protocol for more.
  313. public let identifier: String
  314. /// The radius will be applied in processing. Specify a certain point value with `.point`, or a fraction of the
  315. /// target image with `.widthFraction`. or `.heightFraction`. For example, given a square image with width and
  316. /// height equals, `.widthFraction(0.5)` means use half of the length of size and makes the final image a round one.
  317. public let radius: Radius
  318. /// The target corners which will be applied rounding.
  319. public let roundingCorners: RectCorner
  320. /// Target size of output image should be. If `nil`, the image will keep its original size after processing.
  321. public let targetSize: CGSize?
  322. /// Background color of the output image. If `nil`, it will use a transparent background.
  323. public let backgroundColor: KFCrossPlatformColor?
  324. /// Creates a `RoundCornerImageProcessor`.
  325. ///
  326. /// - Parameters:
  327. /// - cornerRadius: Corner radius in point will be applied in processing.
  328. /// - targetSize: Target size of output image should be. If `nil`,
  329. /// the image will keep its original size after processing.
  330. /// Default is `nil`.
  331. /// - corners: The target corners which will be applied rounding. Default is `.all`.
  332. /// - backgroundColor: Background color to apply for the output image. Default is `nil`.
  333. ///
  334. /// - Note:
  335. ///
  336. /// This initializer accepts a concrete point value for `cornerRadius`. If you do not know the image size, but still
  337. /// want to apply a full round-corner (making the final image a round one), or specify the corner radius as a
  338. /// fraction of one dimension of the target image, use the `Radius` version instead.
  339. ///
  340. public init(
  341. cornerRadius: CGFloat,
  342. targetSize: CGSize? = nil,
  343. roundingCorners corners: RectCorner = .all,
  344. backgroundColor: KFCrossPlatformColor? = nil
  345. )
  346. {
  347. let radius = Radius.point(cornerRadius)
  348. self.init(radius: radius, targetSize: targetSize, roundingCorners: corners, backgroundColor: backgroundColor)
  349. }
  350. /// Creates a `RoundCornerImageProcessor`.
  351. ///
  352. /// - Parameters:
  353. /// - radius: The radius will be applied in processing.
  354. /// - targetSize: Target size of output image should be. If `nil`,
  355. /// the image will keep its original size after processing.
  356. /// Default is `nil`.
  357. /// - corners: The target corners which will be applied rounding. Default is `.all`.
  358. /// - backgroundColor: Background color to apply for the output image. Default is `nil`.
  359. public init(
  360. radius: Radius,
  361. targetSize: CGSize? = nil,
  362. roundingCorners corners: RectCorner = .all,
  363. backgroundColor: KFCrossPlatformColor? = nil
  364. )
  365. {
  366. self.radius = radius
  367. self.targetSize = targetSize
  368. self.roundingCorners = corners
  369. self.backgroundColor = backgroundColor
  370. self.identifier = {
  371. var identifier = ""
  372. if let size = targetSize {
  373. identifier = "com.onevcat.Kingfisher.RoundCornerImageProcessor" +
  374. "(\(radius.radiusIdentifier)_\(size)\(corners.cornerIdentifier))"
  375. } else {
  376. identifier = "com.onevcat.Kingfisher.RoundCornerImageProcessor" +
  377. "(\(radius.radiusIdentifier)\(corners.cornerIdentifier))"
  378. }
  379. if let backgroundColor = backgroundColor {
  380. identifier += "_\(backgroundColor)"
  381. }
  382. return identifier
  383. }()
  384. }
  385. /// Processes the input `ImageProcessItem` with this processor.
  386. ///
  387. /// - Parameters:
  388. /// - item: Input item which will be processed by `self`.
  389. /// - options: Options when processing the item.
  390. /// - Returns: The processed image.
  391. ///
  392. /// - Note: See documentation of `ImageProcessor` protocol for more.
  393. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  394. switch item {
  395. case .image(let image):
  396. let size = targetSize ?? image.kf.size
  397. return image.kf.scaled(to: options.scaleFactor)
  398. .kf.image(
  399. withRadius: radius,
  400. fit: size,
  401. roundingCorners: roundingCorners,
  402. backgroundColor: backgroundColor)
  403. case .data:
  404. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  405. }
  406. }
  407. }
  408. public struct Border {
  409. public var color: KFCrossPlatformColor
  410. public var lineWidth: CGFloat
  411. /// The radius will be applied in processing. Specify a certain point value with `.point`, or a fraction of the
  412. /// target image with `.widthFraction`. or `.heightFraction`. For example, given a square image with width and
  413. /// height equals, `.widthFraction(0.5)` means use half of the length of size and makes the final image a round one.
  414. public var radius: Radius
  415. /// The target corners which will be applied rounding.
  416. public var roundingCorners: RectCorner
  417. public init(
  418. color: KFCrossPlatformColor = .black,
  419. lineWidth: CGFloat = 4,
  420. radius: Radius = .point(0),
  421. roundingCorners: RectCorner = .all
  422. ) {
  423. self.color = color
  424. self.lineWidth = lineWidth
  425. self.radius = radius
  426. self.roundingCorners = roundingCorners
  427. }
  428. var identifier: String {
  429. "\(color.rgbaDescription)_\(lineWidth)_\(radius.radiusIdentifier)_\(roundingCorners.cornerIdentifier)"
  430. }
  431. }
  432. public struct BorderImageProcessor: ImageProcessor {
  433. public var identifier: String { "com.onevcat.Kingfisher.RoundCornerImageProcessor(\(border)" }
  434. public let border: Border
  435. public init(border: Border) {
  436. self.border = border
  437. }
  438. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  439. switch item {
  440. case .image(let image):
  441. return image.kf.addingBorder(border)
  442. case .data:
  443. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  444. }
  445. }
  446. }
  447. /// Represents how a size adjusts itself to fit a target size.
  448. ///
  449. /// - none: Not scale the content.
  450. /// - aspectFit: Scales the content to fit the size of the view by maintaining the aspect ratio.
  451. /// - aspectFill: Scales the content to fill the size of the view.
  452. public enum ContentMode {
  453. /// Not scale the content.
  454. case none
  455. /// Scales the content to fit the size of the view by maintaining the aspect ratio.
  456. case aspectFit
  457. /// Scales the content to fill the size of the view.
  458. case aspectFill
  459. }
  460. /// Processor for resizing images.
  461. /// If you need to resize a data represented image to a smaller size, use `DownsamplingImageProcessor`
  462. /// instead, which is more efficient and uses less memory.
  463. public struct ResizingImageProcessor: ImageProcessor {
  464. /// Identifier of the processor.
  465. /// - Note: See documentation of `ImageProcessor` protocol for more.
  466. public let identifier: String
  467. /// The reference size for resizing operation in point.
  468. public let referenceSize: CGSize
  469. /// Target content mode of output image should be.
  470. /// Default is `.none`.
  471. public let targetContentMode: ContentMode
  472. /// Creates a `ResizingImageProcessor`.
  473. ///
  474. /// - Parameters:
  475. /// - referenceSize: The reference size for resizing operation in point.
  476. /// - mode: Target content mode of output image should be.
  477. ///
  478. /// - Note:
  479. /// The instance of `ResizingImageProcessor` will follow its `mode` property
  480. /// and try to resizing the input images to fit or fill the `referenceSize`.
  481. /// That means if you are using a `mode` besides of `.none`, you may get an
  482. /// image with its size not be the same as the `referenceSize`.
  483. ///
  484. /// **Example**: With input image size: {100, 200},
  485. /// `referenceSize`: {100, 100}, `mode`: `.aspectFit`,
  486. /// you will get an output image with size of {50, 100}, which "fit"s
  487. /// the `referenceSize`.
  488. ///
  489. /// If you need an output image exactly to be a specified size, append or use
  490. /// a `CroppingImageProcessor`.
  491. public init(referenceSize: CGSize, mode: ContentMode = .none) {
  492. self.referenceSize = referenceSize
  493. self.targetContentMode = mode
  494. if mode == .none {
  495. self.identifier = "com.onevcat.Kingfisher.ResizingImageProcessor(\(referenceSize))"
  496. } else {
  497. self.identifier = "com.onevcat.Kingfisher.ResizingImageProcessor(\(referenceSize), \(mode))"
  498. }
  499. }
  500. /// Processes the input `ImageProcessItem` with this processor.
  501. ///
  502. /// - Parameters:
  503. /// - item: Input item which will be processed by `self`.
  504. /// - options: Options when processing the item.
  505. /// - Returns: The processed image.
  506. ///
  507. /// - Note: See documentation of `ImageProcessor` protocol for more.
  508. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  509. switch item {
  510. case .image(let image):
  511. return image.kf.scaled(to: options.scaleFactor)
  512. .kf.resize(to: referenceSize, for: targetContentMode)
  513. case .data:
  514. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  515. }
  516. }
  517. }
  518. /// Processor for adding blur effect to images. `Accelerate.framework` is used underhood for
  519. /// a better performance. A simulated Gaussian blur with specified blur radius will be applied.
  520. public struct BlurImageProcessor: ImageProcessor {
  521. /// Identifier of the processor.
  522. /// - Note: See documentation of `ImageProcessor` protocol for more.
  523. public let identifier: String
  524. /// Blur radius for the simulated Gaussian blur.
  525. public let blurRadius: CGFloat
  526. /// Creates a `BlurImageProcessor`
  527. ///
  528. /// - parameter blurRadius: Blur radius for the simulated Gaussian blur.
  529. public init(blurRadius: CGFloat) {
  530. self.blurRadius = blurRadius
  531. self.identifier = "com.onevcat.Kingfisher.BlurImageProcessor(\(blurRadius))"
  532. }
  533. /// Processes the input `ImageProcessItem` with this processor.
  534. ///
  535. /// - Parameters:
  536. /// - item: Input item which will be processed by `self`.
  537. /// - options: Options when processing the item.
  538. /// - Returns: The processed image.
  539. ///
  540. /// - Note: See documentation of `ImageProcessor` protocol for more.
  541. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  542. switch item {
  543. case .image(let image):
  544. let radius = blurRadius * options.scaleFactor
  545. return image.kf.scaled(to: options.scaleFactor)
  546. .kf.blurred(withRadius: radius)
  547. case .data:
  548. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  549. }
  550. }
  551. }
  552. /// Processor for adding an overlay to images. Only CG-based images are supported in macOS.
  553. public struct OverlayImageProcessor: ImageProcessor {
  554. /// Identifier of the processor.
  555. /// - Note: See documentation of `ImageProcessor` protocol for more.
  556. public let identifier: String
  557. /// Overlay color will be used to overlay the input image.
  558. public let overlay: KFCrossPlatformColor
  559. /// Fraction will be used when overlay the color to image.
  560. public let fraction: CGFloat
  561. /// Creates an `OverlayImageProcessor`
  562. ///
  563. /// - parameter overlay: Overlay color will be used to overlay the input image.
  564. /// - parameter fraction: Fraction will be used when overlay the color to image.
  565. /// From 0.0 to 1.0. 0.0 means solid color, 1.0 means transparent overlay.
  566. public init(overlay: KFCrossPlatformColor, fraction: CGFloat = 0.5) {
  567. self.overlay = overlay
  568. self.fraction = fraction
  569. self.identifier = "com.onevcat.Kingfisher.OverlayImageProcessor(\(overlay.rgbaDescription)_\(fraction))"
  570. }
  571. /// Processes the input `ImageProcessItem` with this processor.
  572. ///
  573. /// - Parameters:
  574. /// - item: Input item which will be processed by `self`.
  575. /// - options: Options when processing the item.
  576. /// - Returns: The processed image.
  577. ///
  578. /// - Note: See documentation of `ImageProcessor` protocol for more.
  579. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  580. switch item {
  581. case .image(let image):
  582. return image.kf.scaled(to: options.scaleFactor)
  583. .kf.overlaying(with: overlay, fraction: fraction)
  584. case .data:
  585. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  586. }
  587. }
  588. }
  589. /// Processor for tint images with color. Only CG-based images are supported.
  590. public struct TintImageProcessor: ImageProcessor {
  591. /// Identifier of the processor.
  592. /// - Note: See documentation of `ImageProcessor` protocol for more.
  593. public let identifier: String
  594. /// Tint color will be used to tint the input image.
  595. public let tint: KFCrossPlatformColor
  596. /// Creates a `TintImageProcessor`
  597. ///
  598. /// - parameter tint: Tint color will be used to tint the input image.
  599. public init(tint: KFCrossPlatformColor) {
  600. self.tint = tint
  601. self.identifier = "com.onevcat.Kingfisher.TintImageProcessor(\(tint.rgbaDescription))"
  602. }
  603. /// Processes the input `ImageProcessItem` with this processor.
  604. ///
  605. /// - Parameters:
  606. /// - item: Input item which will be processed by `self`.
  607. /// - options: Options when processing the item.
  608. /// - Returns: The processed image.
  609. ///
  610. /// - Note: See documentation of `ImageProcessor` protocol for more.
  611. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  612. switch item {
  613. case .image(let image):
  614. return image.kf.scaled(to: options.scaleFactor)
  615. .kf.tinted(with: tint)
  616. case .data:
  617. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  618. }
  619. }
  620. }
  621. /// Processor for applying some color control to images. Only CG-based images are supported.
  622. /// watchOS is not supported.
  623. public struct ColorControlsProcessor: ImageProcessor {
  624. /// Identifier of the processor.
  625. /// - Note: See documentation of `ImageProcessor` protocol for more.
  626. public let identifier: String
  627. /// Brightness changing to image.
  628. public let brightness: CGFloat
  629. /// Contrast changing to image.
  630. public let contrast: CGFloat
  631. /// Saturation changing to image.
  632. public let saturation: CGFloat
  633. /// InputEV changing to image.
  634. public let inputEV: CGFloat
  635. /// Creates a `ColorControlsProcessor`
  636. ///
  637. /// - Parameters:
  638. /// - brightness: Brightness changing to image.
  639. /// - contrast: Contrast changing to image.
  640. /// - saturation: Saturation changing to image.
  641. /// - inputEV: InputEV changing to image.
  642. public init(brightness: CGFloat, contrast: CGFloat, saturation: CGFloat, inputEV: CGFloat) {
  643. self.brightness = brightness
  644. self.contrast = contrast
  645. self.saturation = saturation
  646. self.inputEV = inputEV
  647. self.identifier = "com.onevcat.Kingfisher.ColorControlsProcessor(\(brightness)_\(contrast)_\(saturation)_\(inputEV))"
  648. }
  649. /// Processes the input `ImageProcessItem` with this processor.
  650. ///
  651. /// - Parameters:
  652. /// - item: Input item which will be processed by `self`.
  653. /// - options: Options when processing the item.
  654. /// - Returns: The processed image.
  655. ///
  656. /// - Note: See documentation of `ImageProcessor` protocol for more.
  657. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  658. switch item {
  659. case .image(let image):
  660. return image.kf.scaled(to: options.scaleFactor)
  661. .kf.adjusted(brightness: brightness, contrast: contrast, saturation: saturation, inputEV: inputEV)
  662. case .data:
  663. return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  664. }
  665. }
  666. }
  667. /// Processor for applying black and white effect to images. Only CG-based images are supported.
  668. /// watchOS is not supported.
  669. public struct BlackWhiteProcessor: ImageProcessor {
  670. /// Identifier of the processor.
  671. /// - Note: See documentation of `ImageProcessor` protocol for more.
  672. public let identifier = "com.onevcat.Kingfisher.BlackWhiteProcessor"
  673. /// Creates a `BlackWhiteProcessor`
  674. public init() {}
  675. /// Processes the input `ImageProcessItem` with this processor.
  676. ///
  677. /// - Parameters:
  678. /// - item: Input item which will be processed by `self`.
  679. /// - options: Options when processing the item.
  680. /// - Returns: The processed image.
  681. ///
  682. /// - Note: See documentation of `ImageProcessor` protocol for more.
  683. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  684. return ColorControlsProcessor(brightness: 0.0, contrast: 1.0, saturation: 0.0, inputEV: 0.7)
  685. .process(item: item, options: options)
  686. }
  687. }
  688. /// Processor for cropping an image. Only CG-based images are supported.
  689. /// watchOS is not supported.
  690. public struct CroppingImageProcessor: ImageProcessor {
  691. /// Identifier of the processor.
  692. /// - Note: See documentation of `ImageProcessor` protocol for more.
  693. public let identifier: String
  694. /// Target size of output image should be.
  695. public let size: CGSize
  696. /// Anchor point from which the output size should be calculate.
  697. /// The anchor point is consisted by two values between 0.0 and 1.0.
  698. /// It indicates a related point in current image.
  699. /// See `CroppingImageProcessor.init(size:anchor:)` for more.
  700. public let anchor: CGPoint
  701. /// Creates a `CroppingImageProcessor`.
  702. ///
  703. /// - Parameters:
  704. /// - size: Target size of output image should be.
  705. /// - anchor: The anchor point from which the size should be calculated.
  706. /// Default is `CGPoint(x: 0.5, y: 0.5)`, which means the center of input image.
  707. /// - Note:
  708. /// The anchor point is consisted by two values between 0.0 and 1.0.
  709. /// It indicates a related point in current image, eg: (0.0, 0.0) for top-left
  710. /// corner, (0.5, 0.5) for center and (1.0, 1.0) for bottom-right corner.
  711. /// The `size` property of `CroppingImageProcessor` will be used along with
  712. /// `anchor` to calculate a target rectangle in the size of image.
  713. ///
  714. /// The target size will be automatically calculated with a reasonable behavior.
  715. /// For example, when you have an image size of `CGSize(width: 100, height: 100)`,
  716. /// and a target size of `CGSize(width: 20, height: 20)`:
  717. /// - with a (0.0, 0.0) anchor (top-left), the crop rect will be `{0, 0, 20, 20}`;
  718. /// - with a (0.5, 0.5) anchor (center), it will be `{40, 40, 20, 20}`
  719. /// - while with a (1.0, 1.0) anchor (bottom-right), it will be `{80, 80, 20, 20}`
  720. public init(size: CGSize, anchor: CGPoint = CGPoint(x: 0.5, y: 0.5)) {
  721. self.size = size
  722. self.anchor = anchor
  723. self.identifier = "com.onevcat.Kingfisher.CroppingImageProcessor(\(size)_\(anchor))"
  724. }
  725. /// Processes the input `ImageProcessItem` with this processor.
  726. ///
  727. /// - Parameters:
  728. /// - item: Input item which will be processed by `self`.
  729. /// - options: Options when processing the item.
  730. /// - Returns: The processed image.
  731. ///
  732. /// - Note: See documentation of `ImageProcessor` protocol for more.
  733. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  734. switch item {
  735. case .image(let image):
  736. return image.kf.scaled(to: options.scaleFactor)
  737. .kf.crop(to: size, anchorOn: anchor)
  738. case .data: return (DefaultImageProcessor.default |> self).process(item: item, options: options)
  739. }
  740. }
  741. }
  742. /// Processor for downsampling an image. Compared to `ResizingImageProcessor`, this processor
  743. /// does not render the images to resize. Instead, it downsamples the input data directly to an
  744. /// image. It is a more efficient than `ResizingImageProcessor`. Prefer to use `DownsamplingImageProcessor` as possible
  745. /// as you can than the `ResizingImageProcessor`.
  746. ///
  747. /// Only CG-based images are supported. Animated images (like GIF) is not supported.
  748. public struct DownsamplingImageProcessor: ImageProcessor {
  749. /// Target size of output image should be. It should be smaller than the size of
  750. /// input image. If it is larger, the result image will be the same size of input
  751. /// data without downsampling.
  752. public let size: CGSize
  753. /// Identifier of the processor.
  754. /// - Note: See documentation of `ImageProcessor` protocol for more.
  755. public let identifier: String
  756. /// Creates a `DownsamplingImageProcessor`.
  757. ///
  758. /// - Parameter size: The target size of the downsample operation.
  759. public init(size: CGSize) {
  760. self.size = size
  761. self.identifier = "com.onevcat.Kingfisher.DownsamplingImageProcessor(\(size))"
  762. }
  763. /// Processes the input `ImageProcessItem` with this processor.
  764. ///
  765. /// - Parameters:
  766. /// - item: Input item which will be processed by `self`.
  767. /// - options: Options when processing the item.
  768. /// - Returns: The processed image.
  769. ///
  770. /// - Note: See documentation of `ImageProcessor` protocol for more.
  771. public func process(item: ImageProcessItem, options: KingfisherParsedOptionsInfo) -> KFCrossPlatformImage? {
  772. switch item {
  773. case .image(let image):
  774. guard let data = image.kf.data(format: .unknown) else {
  775. return nil
  776. }
  777. return KingfisherWrapper.downsampledImage(data: data, to: size, scale: options.scaleFactor)
  778. case .data(let data):
  779. return KingfisherWrapper.downsampledImage(data: data, to: size, scale: options.scaleFactor)
  780. }
  781. }
  782. }
  783. infix operator |>: AdditionPrecedence
  784. public func |>(left: ImageProcessor, right: ImageProcessor) -> ImageProcessor {
  785. return left.append(another: right)
  786. }
  787. extension KFCrossPlatformColor {
  788. var rgba: (r: CGFloat, g: CGFloat, b: CGFloat, a: CGFloat) {
  789. var r: CGFloat = 0
  790. var g: CGFloat = 0
  791. var b: CGFloat = 0
  792. var a: CGFloat = 0
  793. #if os(macOS)
  794. (usingColorSpace(.extendedSRGB) ?? self).getRed(&r, green: &g, blue: &b, alpha: &a)
  795. #else
  796. getRed(&r, green: &g, blue: &b, alpha: &a)
  797. #endif
  798. return (r, g, b, a)
  799. }
  800. var rgbaDescription: String {
  801. let components = self.rgba
  802. return String(format: "(%.2f,%.2f,%.2f,%.2f)", components.r, components.g, components.b, components.a)
  803. }
  804. }