Pailead

Pailead works just like the Palette library on Android and other tools like node-vibrant but is completely written in Swift and optimized for macOS, iOS, tvOS, and even watchOS.

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. For usage and installation instructions, visit their website. To integrate Pailead into your Xcode project using CocoaPods, specify it in your Podfile:

pod "Pailead"

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding Pailead as a dependency is as easy as adding it to the dependencies value of your Package.swift.

Swift 4

dependencies: [
.package(url: "https://github.com/pducks32/Pailead.git", from: "1.4.0")
]

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate Pailead into your Xcode project using Carthage, specify it in your Cartfile:

github "pducks32/Pailead"

Usage

Extracting Palette

All images are resized to 1000 pixels to speed up extraction, but don't worry this hasn't been shown to degrade the quality of the palette.

let image = <#Image#>
Pailead.extractPalette(from: image) { palette in
<#Do Something with Palette#>
}

Palette Swatches

The generated palette generates useful swatches to use in your UI or as a loading background perhaps. All swatches are actual colors found in the MMCQ calculation though it will generate some if no suitable ones can be found. These are:

• Muted Swatch (middle range luma and low saturation)
• Dark Muted Swatch (low range luma)
• Light Muted Swatch (high range luma)
• Vibrant Swatch (middle range luma and high saturation)
• Dark Vibrant Swatch (low range luma)
• Light Vibrant Swatch (high range luma)

How it works

Modified Mean Cut Quantization

That's a big word. The image's pixels are grouped and counted. Then they are laid out in RGB space. From there the quantizer finds RGB boxes that encapsulate the pixels equally. From these boxes the average color is generated and then sorted by how common it is in the image.

Todo

• ☑ Switch to swatches
• ☑ Add palette
• ☐ Paralleize pixel extraction (clustering is already parallized)
• ☐ Add more performance tests
• ☐ Make better docs with example uses
• ☐ Optimize processing loop
• ☐ Add support for other clustering algorithms

Name

If palette is pronounced pa-let then Pailead is pronounced pa-lid.

The word comes from the Irish word paileád meaning palette which is what this library extracts.

Author

• @pducks32 (Patrick Metcalfe, [email protected])