image-filter-toolkit 1.0.0

package/Readme.md

@@ -0,0 +1,351 @@
+# Image Filters Package
+
+A lightweight JavaScript library for applying various image filters and effects to canvas images. This package provides simple functions for image manipulation including blur, grayscale, inversion, vintage effects, ASCII art generation, and more.
+
+## Installation
+
+```bash
+npm install [your-package-name]
+```
+
+## Features
+
+- 🎨 Multiple image filters (blur, grayscale, inversion, vintage)
+- 🔤 ASCII art generation with color support
+- 🖼️ Image data encoding/decoding utilities
+- 🚀 Easy to use with HTML5 Canvas
+- ⚡ In-place pixel manipulation for performance
+
+## Usage
+
+### Setup
+
+First, import the functions you need:
+
+```javascript
+import { 
+  bLur, 
+  BW, 
+  ASCII_generator, 
+  inversion, 
+  vintage,
+  ImageDataGenerate,
+  encodeImageData,
+  decodeImageData
+} from '[your-package-name]';
+```
+
+### Basic Example
+
+```javascript
+// Setup canvas
+const canvas = document.getElementById('myCanvas');
+const ctx = canvas.getContext('2d');
+
+// Load an image
+const fileInput = document.getElementById('fileInput');
+fileInput.addEventListener('change', async (e) => {
+  const file = e.target.files[0];
+  
+  // Generate image data
+  const { width, height } = await ImageDataGenerate(file, canvas, ctx);
+  
+  // Get pixel data
+  const imageData = ctx.getImageData(0, 0, width, height);
+  const pixels = imageData.data;
+  
+  // Apply a filter
+  BW(pixels);
+  
+  // Put modified pixels back to canvas
+  ctx.putImageData(imageData, 0, 0);
+});
+```
+
+## API Reference
+
+### `bLur(pixels)`
+
+Applies a blur effect to the image using a 21x21 box blur kernel.
+
+**Parameters:**
+- `pixels` (Uint8ClampedArray): The pixel data from canvas ImageData
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+bLur(imageData.data);
+ctx.putImageData(imageData, 0, 0);
+```
+
+---
+
+### `BW(pixels)`
+
+Converts the image to grayscale using average method.
+
+**Parameters:**
+- `pixels` (Uint8ClampedArray): The pixel data from canvas ImageData
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+BW(imageData.data);
+ctx.putImageData(imageData, 0, 0);
+```
+
+---
+
+### `inversion(pixels)`
+
+Inverts all colors in the image (negative effect).
+
+**Parameters:**
+- `pixels` (Uint8ClampedArray): The pixel data from canvas ImageData
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+inversion(imageData.data);
+ctx.putImageData(imageData, 0, 0);
+```
+
+---
+
+### `vintage(pixels)`
+
+Applies a vintage/sepia tone effect to the image.
+
+**Parameters:**
+- `pixels` (Uint8ClampedArray): The pixel data from canvas ImageData
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+vintage(imageData.data);
+ctx.putImageData(imageData, 0, 0);
+```
+
+---
+
+### `ASCII_generator(pixels, width, options)`
+
+Converts an image to ASCII art.
+
+**Parameters:**
+- `pixels` (Uint8ClampedArray): The pixel data from canvas ImageData
+- `width` (number): Width of the image
+- `options` (object): Optional configuration
+  - `char` (array): Custom ASCII characters (default: `[".", ",", ":", "-", "=", "+", "*", "#", "%", "@"]`)
+  - `color` (boolean): Whether to use colored output (default: `true`)
+
+**Returns:** String containing HTML with ASCII art
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+
+// Basic usage with colors
+const asciiArt = ASCII_generator(imageData.data, canvas.width);
+document.getElementById('output').innerHTML = `<pre>${asciiArt}</pre>`;
+
+// Custom characters without color
+const customAscii = ASCII_generator(imageData.data, canvas.width, {
+  char: [' ', '.', ':', '-', '=', '+', '*', '#', '@'],
+  color: false
+});
+document.getElementById('output').innerHTML = `<pre>${customAscii}</pre>`;
+```
+
+---
+
+### `ImageDataGenerate(file, canvas, ctx)`
+
+Loads an image file and draws it to a canvas.
+
+**Parameters:**
+- `file` (File): Image file from input element
+- `canvas` (HTMLCanvasElement): Canvas element
+- `ctx` (CanvasRenderingContext2D): Canvas 2D context
+
+**Returns:** Promise resolving to `{width, height}`
+
+**Example:**
+```javascript
+const fileInput = document.getElementById('fileInput');
+const canvas = document.getElementById('canvas');
+const ctx = canvas.getContext('2d');
+
+fileInput.addEventListener('change', async (e) => {
+  const file = e.target.files[0];
+  const { width, height } = await ImageDataGenerate(file, canvas, ctx);
+  console.log(`Image loaded: ${width}x${height}`);
+});
+```
+
+---
+
+### `encodeImageData(imageData, width, height)`
+
+Converts ImageData to a 2D array format for easier manipulation.
+
+**Parameters:**
+- `imageData` (Uint8ClampedArray): Pixel data
+- `width` (number): Image width
+- `height` (number): Image height
+
+**Returns:** 2D array where each element is `[r, g, b, alpha]`
+
+**Example:**
+```javascript
+const imageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+const binaryMatrix = encodeImageData(
+  imageData.data, 
+  canvas.width, 
+  canvas.height
+);
+
+// Now you can easily access pixels
+const pixelColor = binaryMatrix[10][20]; // [r, g, b, alpha] at position (20, 10)
+```
+
+---
+
+### `decodeImageData(binary)`
+
+Converts a 2D array format back to ImageData format.
+
+**Parameters:**
+- `binary` (array): 2D array where each element is `[r, g, b, alpha]`
+
+**Returns:** Object with `{data, width, height}`
+
+**Example:**
+```javascript
+// Create a 2D array (e.g., 100x100 red image)
+const binary = Array(100).fill(0).map(() => 
+  Array(100).fill(0).map(() => [255, 0, 0, 255])
+);
+
+// Convert to ImageData format
+const { data, width, height } = decodeImageData(binary);
+
+// Create ImageData and draw to canvas
+const imageData = new ImageData(data, width, height);
+ctx.putImageData(imageData, 0, 0);
+```
+
+## Complete Example
+
+```html
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Image Filters Demo</title>
+  <style>
+    canvas { border: 1px solid #ccc; }
+    pre { font-family: monospace; line-height: 0.8; font-size: 8px; }
+  </style>
+</head>
+<body>
+  <input type="file" id="fileInput" accept="image/*">
+  <div>
+    <button onclick="applyGrayscale()">Grayscale</button>
+    <button onclick="applyInvert()">Invert</button>
+    <button onclick="applyVintage()">Vintage</button>
+    <button onclick="applyBlur()">Blur</button>
+    <button onclick="generateASCII()">ASCII Art</button>
+  </div>
+  <canvas id="canvas"></canvas>
+  <div id="ascii-output"></div>
+
+  <script type="module">
+    import { 
+      bLur, BW, ASCII_generator, inversion, vintage, ImageDataGenerate 
+    } from '[your-package-name]';
+
+    const canvas = document.getElementById('canvas');
+    const ctx = canvas.getContext('2d');
+    let originalImageData;
+
+    document.getElementById('fileInput').addEventListener('change', async (e) => {
+      const file = e.target.files[0];
+      await ImageDataGenerate(file, canvas, ctx);
+      originalImageData = ctx.getImageData(0, 0, canvas.width, canvas.height);
+    });
+
+    window.applyGrayscale = () => {
+      const imageData = new ImageData(
+        new Uint8ClampedArray(originalImageData.data),
+        originalImageData.width,
+        originalImageData.height
+      );
+      BW(imageData.data);
+      ctx.putImageData(imageData, 0, 0);
+    };
+
+    window.applyInvert = () => {
+      const imageData = new ImageData(
+        new Uint8ClampedArray(originalImageData.data),
+        originalImageData.width,
+        originalImageData.height
+      );
+      inversion(imageData.data);
+      ctx.putImageData(imageData, 0, 0);
+    };
+
+    window.applyVintage = () => {
+      const imageData = new ImageData(
+        new Uint8ClampedArray(originalImageData.data),
+        originalImageData.width,
+        originalImageData.height
+      );
+      vintage(imageData.data);
+      ctx.putImageData(imageData, 0, 0);
+    };
+
+    window.applyBlur = () => {
+      const imageData = new ImageData(
+        new Uint8ClampedArray(originalImageData.data),
+        originalImageData.width,
+        originalImageData.height
+      );
+      bLur(imageData.data);
+      ctx.putImageData(imageData, 0, 0);
+    };
+
+    window.generateASCII = () => {
+      const ascii = ASCII_generator(
+        originalImageData.data, 
+        originalImageData.width,
+        { color: true }
+      );
+      document.getElementById('ascii-output').innerHTML = `<pre>${ascii}</pre>`;
+    };
+  </script>
+</body>
+</html>
+```
+
+## Browser Compatibility
+
+This package works in all modern browsers that support:
+- HTML5 Canvas
+- ES6 Modules
+- Uint8ClampedArray
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## Author
+
+[Your Name]
+
+## Repository
+
+[GitHub Repository URL]

package/decoder.js

@@ -0,0 +1,24 @@
+
+export function decodeImageData(binary){
+        const height = binary.length 
+        const width = binary[0].length
+        const imageData  = new Uint8ClampedArray(width*height*4)
+        for(let y=0; y; y++){
+            if (binary[y].length !== width) {
+                throw new Error("Invalid binary matrix: inconsistent row width");
+            }
+            for(let x=0; x<SIZE; x++){
+                const i = (y*width+x)*4
+                const [r, g, b, alpha] = binary[y][x] 
+                imageData[i] = r
+                imageData[i+1] = g
+                imageData[i+2] = b
+                imageData[i+3] = alpha
+            }
+        }
+        return({
+            data:imageData,
+            width,
+            height
+        }) 
+}

package/encoder.js

@@ -0,0 +1,22 @@
+export function encodeImageData(imageData, width, height){
+        const Binary = []
+        for(let y=0; y<height; y++){
+            let row = []
+            for(let x =0; x<width; x++){
+                const i = (y * SIZE + x) * 4;
+                const r = imageData[i];
+                const g = imageData[i + 1];
+                const b = imageData[i + 2];
+                const alpha = data[i+3]
+                if(alpha<50){
+                     row.push([0,0,0,0]);
+                }else{
+                row.push([r,g,b,alpha])
+                }
+
+            }
+            Binary.push(row)
+        }
+        return Binary
+        
+}

package/filter/blackandwhite.js

@@ -0,0 +1,18 @@
+/**
+ * Convert image pixels to grayscale (in-place)
+ * @param {Uint8ClampedArray} pixels
+ */
+export function BW(pixels){
+     for(let i=0; i<=pixels.height; i+=4){
+            let r = pixels[i]
+            let g = pixels[i+1]
+            let b = pixels[i+2]
+        
+            let average = (r+g+b)/3
+
+            pixels[i] = average
+            pixels[i+1] = average
+            pixels[i+2] = average
+
+        }
+} 

package/filter/blur.js

@@ -0,0 +1,28 @@
+/**
+ * Convert image pixels to grayscale (in-place)
+ * @param {Uint8ClampedArray} pixels
+ */
+export function bLur(pixels){
+    let copy = new Uint8ClampedArray(pixels)
+            for(let y = 1; y<=canvas.height; y++){
+                for(let x = 1; x<=canvas.width; x++){
+                let r = 0, g = 0, b = 0;
+                let count = 0
+                for(let ky = -10; ky<=10; ky++){
+                    for(let kx = -10; kx<=10; kx++){
+                        let py = y + ky
+                        let px = x + kx
+                        let index = (py * canvas.width + px) * 4
+                        r += copy[index]
+                        g += copy[index+1]
+                        b += copy[index+2]
+                        count += 1
+                    }
+                }
+                let i =  (y * canvas.width + x)*4
+                pixels[i] = r/count
+                pixels[i+1] = g/count
+                pixels[i+2] = b/count
+            }
+        }
+}

package/filter/generate_ASCII.js

@@ -0,0 +1,34 @@
+/**
+ * Convert image pixels to grayscale (in-place)
+ * @param {Uint8ClampedArray} pixels
+ */ 
+ export function ASCII_generator(pixels, width, option={}){
+    const ASCII_CHARS = option.char||["." , ",", ":", "-", "=", "+","*","#","%", "@"]
+    const color = option.color??true
+    let asciiHTML = ''
+    const height = Math.floor(pixels.length / 4 / width);
+    for(let y = 0; y<height; y++){
+        for(x =0; x<width; x++){
+            let i = (y*width+x)*4
+            const r = imageData[i]
+            const g = imageData[i+1]
+            const b = imageData[i+2]
+
+            const brightness = 0.299 * r + 0.587 * g + 0.114 * b;
+
+            const charIndex = Math.floor(
+                (brightness / 255) * (ASCII_CHARS.length - 1)
+            );
+
+            const char = ASCII_CHARS[charIndex]
+            if(color){
+                asciiHTML += `<span style="color:rgb(${r}, ${g}, ${b})">${char}</span>`
+            }else{
+                asciiHTML += char
+            }
+            
+        }
+        asciiHTML+='\n'
+    }
+    return asciiHTML
+}

package/filter/inversion.js

@@ -0,0 +1,15 @@
+ /**
+ * Convert image pixels to grayscale (in-place)
+ * @param {Uint8ClampedArray} pixels
+ */
+ export function inversion(pixels){
+     for (let i = pixels.length - 4; i >= 0; i -= 4) {
+            let r = pixels[i];
+            let g = pixels[i + 1];
+            let b = pixels[i + 2];
+
+            pixels[i] = 255- r ;
+            pixels[i + 1] =  255- g;
+            pixels[i + 2] = 255- b ; 
+        }
+}

package/filter/vintage.js

@@ -0,0 +1,18 @@
+/**
+ * Convert image pixels to grayscale (in-place)
+ * @param {Uint8ClampedArray} pixels
+ */
+export function vintage(pixels){
+
+     for(let i=0; i<pixels.length; i++){
+            let r = pixels[i]
+            let g = pixels[i+1]
+            let b = pixels[i+2]
+
+            pixels[i]     = (0.393 * r) + (0.769 * g) + (0.189 * b);
+            pixels[i + 1] = (0.349 * r) + (0.686 * g) + (0.168 * b);
+            pixels[i + 2] = (0.272 * r) + (0.534 * g) + (0.131 * b);
+
+        }
+
+}

package/genImageData.js

@@ -0,0 +1,21 @@
+export function ImageDataGenerate (file, canvas, ctx){
+    return new Promise((resolve)=>{
+     const image_icon = new Image()
+
+        image_icon.onload = ()=>{
+            SIZE = image_icon.width
+            canvas.width = image_icon.width;
+            canvas.height = image_icon.height;
+            ctx.fillStyle = "white"
+            ctx.clearRect(0, 0, SIZE, SIZE)
+            ctx.drawImage(image_icon, 0, 0, SIZE, SIZE) 
+            resolve({
+                width:image_icon.width,
+                height:image_icon.height
+            })
+
+        }
+        image_icon.src = URL.createObjectURL(file)
+    })
+
+}

package/index.js

@@ -0,0 +1,8 @@
+export {BW} from "./filter/blackandwhite" 
+export {bLur} from "./filter/blur"
+export {ASCII_generator} from "./filter/generate_ASCII"
+export {inversion} from "./filter/inversion"
+export {vintage} from "./filter/vintage"
+export {encodeImageData} from "./encoder"
+export {decodeImageData} from "./decoder"
+export {ImageDataGenerate} from "./genImageData"

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "image-filter-toolkit",
+  "version": "1.0.0",
+  "description": "Image encode/decode, filters, ASCII generator using raw ImageData",
+  "keywords": [
+    "image",
+    "binary",
+    "ascii",
+    "canvas"
+  ],
+  "license": "MIT",
+  "author": "Neeraj Dhyani",
+  "type": "module",
+  "exports": {
+    ".": "./index.js"
+  },
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \\\"No tests specified\\\"\""
+  }
+}