diff --git a/packages/pixel-dominant-colors/LICENSE b/packages/pixel-dominant-colors/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/pixel-dominant-colors/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/pixel-dominant-colors/README.md b/packages/pixel-dominant-colors/README.md new file mode 100644 index 0000000000..ea5a2a1147 --- /dev/null +++ b/packages/pixel-dominant-colors/README.md @@ -0,0 +1,103 @@ + + +# ![@thi.ng/pixel-dominant-colors](https://media.thi.ng/umbrella/banners-20230807/thing-pixel-dominant-colors.svg?60875ef0) + +[![npm version](https://img.shields.io/npm/v/@thi.ng/pixel-dominant-colors.svg)](https://www.npmjs.com/package/@thi.ng/pixel-dominant-colors) +![npm downloads](https://img.shields.io/npm/dm/@thi.ng/pixel-dominant-colors.svg) +[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi) + +> [!NOTE] +> This is one of 196 standalone projects, maintained as part +> of the [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo +> and anti-framework. +> +> 🚀 Please help me to work full-time on these projects by [sponsoring me on +> GitHub](https://github.com/sponsors/postspectacular). Thank you! ❤️ + +- [About](#about) +- [Status](#status) +- [Installation](#installation) +- [Dependencies](#dependencies) +- [Usage examples](#usage-examples) +- [API](#api) +- [Authors](#authors) +- [License](#license) + +## About + +k-means based dominant color extraction from images/pixel buffers. This is a support package for [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel). + +## Status + +**STABLE** - used in production + +[Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bpixel-dominant-colors%5D+in%3Atitle) + +## Installation + +```bash +yarn add @thi.ng/pixel-dominant-colors +``` + +ESM import: + +```ts +import * as pdc from "@thi.ng/pixel-dominant-colors"; +``` + +Browser ESM import: + +```html + +``` + +[JSDelivr documentation](https://www.jsdelivr.com/) + +For Node.js REPL: + +```js +const pdc = await import("@thi.ng/pixel-dominant-colors"); +``` + +Package sizes (brotli'd, pre-treeshake): ESM: 246 bytes + +## Dependencies + +- [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api) +- [@thi.ng/k-means](https://github.com/thi-ng/umbrella/tree/develop/packages/k-means) +- [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel) + +## Usage examples + +One project in this repo's +[/examples](https://github.com/thi-ng/umbrella/tree/develop/examples) +directory is using this package: + +| Screenshot | Description | Live demo | Source | +|:-----------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------|:------------------------------------------------------|:-----------------------------------------------------------------------------------| +| | Color palette generation via dominant color extraction from uploaded images | [Demo](https://demo.thi.ng/umbrella/dominant-colors/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/dominant-colors) | + +## API + +[Generated API docs](https://docs.thi.ng/umbrella/pixel-dominant-colors/) + +TODO + +## Authors + +- [Karsten Schmidt](https://thi.ng) + +If this project contributes to an academic publication, please cite it as: + +```bibtex +@misc{thing-pixel-dominant-colors, + title = "@thi.ng/pixel-dominant-colors", + author = "Karsten Schmidt", + note = "https://thi.ng/pixel-dominant-colors", + year = 2021 +} +``` + +## License + +© 2021 - 2024 Karsten Schmidt // Apache License 2.0 diff --git a/packages/pixel-dominant-colors/api-extractor.json b/packages/pixel-dominant-colors/api-extractor.json new file mode 100644 index 0000000000..bc73f2cc02 --- /dev/null +++ b/packages/pixel-dominant-colors/api-extractor.json @@ -0,0 +1,3 @@ +{ + "extends": "../../api-extractor.json" +} diff --git a/packages/pixel-dominant-colors/package.json b/packages/pixel-dominant-colors/package.json new file mode 100644 index 0000000000..349c4d3901 --- /dev/null +++ b/packages/pixel-dominant-colors/package.json @@ -0,0 +1,80 @@ +{ + "name": "@thi.ng/pixel-dominant-colors", + "version": "1.0.0", + "description": "k-means based dominant color extraction from images/pixel buffers", + "type": "module", + "module": "./index.js", + "typings": "./index.d.ts", + "sideEffects": false, + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://thi.ng/pixel-dominant-colors", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/postspectacular" + }, + { + "type": "patreon", + "url": "https://patreon.com/thing_umbrella" + } + ], + "author": "Karsten Schmidt (https://thi.ng)", + "license": "Apache-2.0", + "scripts": { + "build": "yarn build:esbuild && yarn build:decl", + "build:decl": "tsc --declaration --emitDeclarationOnly", + "build:esbuild": "esbuild --format=esm --platform=neutral --target=es2022 --tsconfig=tsconfig.json --outdir=. src/**/*.ts", + "clean": "bun ../../tools/src/clean-package.ts", + "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts", + "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose", + "doc:readme": "bun ../../tools/src/module-stats.ts && bun ../../tools/src/readme.ts", + "pub": "yarn npm publish --access public", + "test": "bun test", + "tool:tangle": "../../node_modules/.bin/tangle src/**/*.ts" + }, + "dependencies": { + "@thi.ng/api": "^8.11.6", + "@thi.ng/k-means": "^0.6.93", + "@thi.ng/pixel": "^6.1.37" + }, + "devDependencies": { + "@microsoft/api-extractor": "^7.47.0", + "esbuild": "^0.23.0", + "typedoc": "^0.26.3", + "typescript": "^5.5.3" + }, + "keywords": [ + "analysis", + "color", + "cluster", + "image", + "k-means", + "typescript" + ], + "publishConfig": { + "access": "public" + }, + "browser": { + "process": false, + "setTimeout": false + }, + "engines": { + "node": ">=18" + }, + "files": [ + "./*.js", + "./*.d.ts" + ], + "exports": { + ".": { + "default": "./index.js" + } + }, + "thi.ng": { + "parent": "@thi.ng/pixel", + "year": 2021 + } +} diff --git a/packages/pixel-dominant-colors/src/index.ts b/packages/pixel-dominant-colors/src/index.ts new file mode 100644 index 0000000000..a752f8fd2b --- /dev/null +++ b/packages/pixel-dominant-colors/src/index.ts @@ -0,0 +1,52 @@ +import type { Fn2 } from "@thi.ng/api"; +import type { KMeansOpts } from "@thi.ng/k-means"; +import { kmeans } from "@thi.ng/k-means/kmeans"; +import type { FloatBuffer } from "@thi.ng/pixel/float"; + +/** + * Options for {@link dominantColors}, an extension of + * [KMeansOpts](https://docs.thi.ng/umbrella/k-means/interfaces/KMeansOpts.html). + */ +export interface DominantColorOpts extends KMeansOpts { + /** + * Predicate used to only include pixels in the analysis for which the + * filter returns truthy result. E.g. to pre-exclude weakly saturated or + * dark colors etc. The second arg is the index of the pixel in the image's + * pixel buffer. + * + * If omitted, all pixels will be included (default). + */ + filter: Fn2; +} + +/** + * Takes a {@link FloatBuffer} and applies k-means clustering to extract the + * `num` dominant colors from the given image. The clustering can be configured + * via optionally provided `opts`. Returns array of `{ color, area }` objects + * (sorted by descending area), where `color` is a cluster's dominant color and + * `area` the normalized cluster size. + * + * @remarks + * See thi.ng/k-means for details about clustering implementation & options. + * + * @param img - + * @param num - + * @param opts - + */ +export const dominantColors = ( + img: FloatBuffer, + num: number, + opts: Partial = {} +) => { + const n = img.width * img.height; + const mapped: Float32Array[] = []; + const filter = opts.filter || (() => true); + for (let i = 0, j = 0, s = img.stride[0]; i < n; i++, j += s) { + const p = img.data.subarray(j, j + s); + if (filter(p, i)) mapped.push(p); + } + if (!mapped.length) return []; + return kmeans(Math.min(num, mapped.length), mapped, opts) + .sort((a, b) => b.items.length - a.items.length) + .map((c) => ({ color: [...c.centroid], area: c.items.length / n })); +}; diff --git a/packages/pixel-dominant-colors/test/main.test.ts b/packages/pixel-dominant-colors/test/main.test.ts new file mode 100644 index 0000000000..985ff09506 --- /dev/null +++ b/packages/pixel-dominant-colors/test/main.test.ts @@ -0,0 +1,4 @@ +import { expect, test } from "bun:test"; +// import { } from "../src/index.js" + +test.todo("pixel-dominant-colors", () => {}); diff --git a/packages/pixel-dominant-colors/test/tsconfig.json b/packages/pixel-dominant-colors/test/tsconfig.json new file mode 100644 index 0000000000..10a781ee02 --- /dev/null +++ b/packages/pixel-dominant-colors/test/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "types": ["bun-types"], + "noEmit": true + }, + "include": ["./**/*.ts"] +} diff --git a/packages/pixel-dominant-colors/tpl.readme.md b/packages/pixel-dominant-colors/tpl.readme.md new file mode 100644 index 0000000000..c7032b98b0 --- /dev/null +++ b/packages/pixel-dominant-colors/tpl.readme.md @@ -0,0 +1,35 @@ + + + + +## About + +{{pkg.description}} + +{{meta.status}} + +{{repo.supportPackages}} + +{{repo.relatedPackages}} + +{{meta.blogPosts}} + +## Installation + +{{pkg.install}} + +{{pkg.size}} + +## Dependencies + +{{pkg.deps}} + +{{repo.examples}} + +## API + +{{pkg.docs}} + +TODO + + diff --git a/packages/pixel-dominant-colors/tsconfig.json b/packages/pixel-dominant-colors/tsconfig.json new file mode 100644 index 0000000000..1cd5465cf2 --- /dev/null +++ b/packages/pixel-dominant-colors/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}