Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beaunouvelle/faceaware
An extension that gives UIImageView the ability to focus on faces within an image.
https://github.com/beaunouvelle/faceaware
carthage cocoapods detect-faces extension face-detection hacktoberfest ios photos swift uiimageview
Last synced: about 2 months ago
JSON representation
An extension that gives UIImageView the ability to focus on faces within an image.
- Host: GitHub
- URL: https://github.com/beaunouvelle/faceaware
- Owner: BeauNouvelle
- License: mit
- Archived: true
- Created: 2016-07-22T14:15:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-08-01T12:44:20.000Z (over 4 years ago)
- Last Synced: 2024-05-16T03:48:15.608Z (6 months ago)
- Topics: carthage, cocoapods, detect-faces, extension, face-detection, hacktoberfest, ios, photos, swift, uiimageview
- Language: Swift
- Homepage:
- Size: 1.99 MB
- Stars: 3,023
- Watchers: 65
- Forks: 227
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FaceAware
Sometimes the aspect ratios of images we need to work with don't quite fit within the confines of our UIImageViews.
In most cases we can use AspectFill to fit the image to the bounds of a UIImageView without stretching or leaving whitespace, however when it comes to photos of people, it's quite often to have the faces cropped out if they're not perfectly centered.
This is where FaceAware comes in.
It will analyse an image either through `UIImageView`'s `image` property, or one you set using one of the built in functions and focus in on any faces it can find within.
The most common use for FaceAware is with avatars.
With FaceAware your users will no longer have to crop and adjust their profile pictures.
Based on these two older projects:
* [BetterFace-Swift](https://github.com/croath/UIImageView-BetterFace-Swift)
* [FaceAwareFill](https://github.com/Julioacarrettoni/UIImageView_FaceAwareFill)
Both of which don't seem to be maintained anymore.
## Requirements ##
* Swift 5.1
* iOS 8.0+
* Xcode 11
## Installation ##
#### Manual ####
Simply drag `UIImageView+FaceAware.swift` into your project.
#### Carthage ####
- Add `github "BeauNouvelle/FaceAware"` to your `Cartfile`
More information on installing and setting up Carthage can be found here:
https://github.com/Carthage/Carthage
#### Cocoapods ####
- Add `pod 'FaceAware'` to your pod file.
- Add `import FaceAware` to the top of your files where you wish to use it.
## Usage ##
There are a few ways to get your image views focussing in on faces within images.
#### Interface Builder ####
This is the easiest method and doesn't require writing any code.
The extension makes use of `@IBDesignable` and `@IBInspectable` so you can turn on focusOnFaces from within IB. However you won't actually see the extension working until you run your project.
#### Code ####
You can set `focusOnFaces` to `true`.
```swift
someImageView.focusOnFaces = true
```
Be sure to set this *after* setting your image. If no image is present when this is called, there will be no faces to focus on.
------
Alternatively you can use:
```swift
someImageView.set(image: myImage, focusOnFaces: true)
```
Which elimates the worry of not having an image previously set.
------
You can also recieve a callback for when face detection and any image adjustments have been completed by passing in a closure to the `didFocusOnFaces` property.
```swift
someImageView.didFocusOnFaces = {
print("Did finish focussing")
}
```
#### Debugging ####
FaceAware now features a debug mode which draws red squares around any detected faces within an image. To enable you can set the `debug` property to true.
```swift
someImageView.debug = true
```
You can also set this flag within interface builder.
## More help? Questions? ##
Reach out to me on Twitter [@beaunouvelle](https://twitter.com/BeauNouvelle)
Also, if you're using this in your project and you like it, please let me know so I can continue working on it!
## Future Plans ##
- [ ] Add an option to only focus on largest/closest face in photo.