cross-image 0.2.1 → 0.2.3

package/README.md

@@ -1,7 +1,9 @@
 # @cross/image
 
 A pure JavaScript, dependency-free, cross-runtime image processing library for
-Deno, Node.js, and Bun.
+Deno, Node.js, and Bun. Decode, encode, manipulate, and process images in
+multiple formats including PNG, JPEG, WebP, GIF, and more—all without native
+dependencies.
 
 📚 **[Full Documentation](https://cross-image.56k.guru/)**
 
@@ -11,10 +13,11 @@ Deno, Node.js, and Bun.
 - 🔌 **Pluggable formats** - Easy to extend with custom formats
 - 📦 **Cross-runtime** - Works on Deno, Node.js (18+), and Bun
 - 🎨 **Multiple formats** - PNG, APNG, JPEG, WebP, GIF, TIFF, BMP, ICO, DNG,
-  PAM, PCX and ASCII support
+  PAM, PPM, PCX and ASCII support
 - ✂️ **Image manipulation** - Resize, crop, composite, and more
-- 🎛️ **Image processing** - Chainable `brightness`, `contrast`, `saturation`,
-  and `exposure` helpers
+- 🎛️ **Image processing** - Chainable filters including `brightness`,
+  `contrast`, `saturation`, `hue`, `exposure`, `blur`, `sharpen`, `sepia`, and
+  more
 - 🖌️ **Drawing operations** - Create, fill, and manipulate pixels
 - 🧩 **Multi-frame** - Decode/encode animated GIFs, APNGs and multi-page TIFFs
 - 🔧 **Simple API** - Easy to use, intuitive interface
@@ -30,21 +33,21 @@ import { Image } from "jsr:@cross/image";
 ### Node.js
 
 ```bash
-npx jsr add @cross/image
+npm install cross-image
 ```
 
 ```ts
-import { Image } from "@cross/image";
+import { Image } from "cross-image";
 ```
 
 ### Bun
 
 ```bash
-bunx jsr add @cross/image
+npm install cross-image
 ```
 
 ```ts
-import { Image } from "@cross/image";
+import { Image } from "cross-image";
 ```
 
 ## Quick Start
@@ -66,11 +69,13 @@ const canvas = Image.create(800, 600, 255, 255, 255); // white background
 // Composite the loaded image on top
 canvas.composite(image, 50, 50);
 
-// Apply image processing
+// Apply image processing filters
 canvas
   .brightness(0.1)
   .contrast(0.2)
-  .saturation(-0.1);
+  .saturation(-0.1)
+  .blur(1)
+  .sharpen(0.3);
 
 // Encode in a different format
 const jpeg = await canvas.encode("jpeg");
@@ -99,37 +104,160 @@ await writeFile("output.jpg", jpeg);
 
 ## Supported Formats
 
-| Format | Pure-JS     | Notes                           |
-| ------ | ----------- | ------------------------------- |
-| PNG    | ✅ Full     | Complete pure-JS implementation |
-| APNG   | ✅ Full     | Animated PNG with multi-frame   |
-| BMP    | ✅ Full     | Complete pure-JS implementation |
-| ICO    | ✅ Full     | Windows Icon format             |
-| GIF    | ✅ Full     | Animated GIF with multi-frame   |
-| DNG    | ✅ Full     | Linear DNG (Uncompressed RGBA)  |
-| PAM    | ✅ Full     | Netpbm PAM format               |
-| PCX    | ✅ Full     | ZSoft PCX (RLE compressed)      |
-| ASCII  | ✅ Full     | Text-based ASCII art            |
-| JPEG   | ⚠️ Baseline | Pure-JS baseline DCT only       |
-| WebP   | ⚠️ Lossless | Pure-JS lossless VP8L           |
-| TIFF   | ⚠️ Basic    | Pure-JS uncompressed + LZW      |
+| Format | Pure-JS     | Notes                                  |
+| ------ | ----------- | -------------------------------------- |
+| PNG    | ✅ Full     | Complete pure-JS implementation        |
+| APNG   | ✅ Full     | Animated PNG with multi-frame          |
+| BMP    | ✅ Full     | Complete pure-JS implementation        |
+| ICO    | ✅ Full     | Windows Icon format                    |
+| GIF    | ✅ Full     | Animated GIF with multi-frame          |
+| DNG    | ✅ Full     | Linear DNG (Uncompressed RGBA)         |
+| PAM    | ✅ Full     | Netpbm PAM format                      |
+| PPM    | ✅ Full     | Netpbm PPM format (P3/P6)              |
+| PCX    | ✅ Full     | ZSoft PCX (RLE compressed)             |
+| ASCII  | ✅ Full     | Text-based ASCII art                   |
+| JPEG   | ⚠️ Baseline | Pure-JS baseline DCT only              |
+| WebP   | ⚠️ Lossless | Pure-JS lossless VP8L                  |
+| TIFF   | ⚠️ Basic    | Pure-JS uncompressed, LZW, & grayscale |
 
 See the
-[full format support documentation](https://cross-image.56k.guru/formats.html)
-for detailed compatibility information.
+[full format support documentation](https://cross-image.56k.guru/formats/) for
+detailed compatibility information.
+
+## Metadata Support
+
+@cross/image provides comprehensive EXIF 3.0 compliant metadata support for
+image files, including camera information, GPS coordinates, and InteropIFD
+compatibility markers.
+
+### Supported Metadata Fields
+
+**Basic Metadata:**
+
+- `title`, `description`, `author`, `copyright`
+- `creationDate` - Date/time image was created
+
+**Camera Settings (JPEG, TIFF, WebP via XMP):**
+
+- `cameraMake`, `cameraModel` - Camera manufacturer and model
+- `lensMake`, `lensModel` - Lens information
+- `iso` - ISO speed rating
+- `exposureTime` - Shutter speed in seconds
+- `fNumber` - Aperture (f-number)
+- `focalLength` - Focal length in mm
+- `flash`, `whiteBalance` - Capture settings
+- `orientation` - Image orientation (1=normal, 3=180°, 6=90°CW, 8=90°CCW)
+- `software` - Software used
+- `userComment` - User notes
+
+**GPS Coordinates (All EXIF formats: JPEG, PNG, WebP, TIFF):**
+
+- `latitude`, `longitude` - GPS coordinates in decimal degrees
+- Full microsecond precision with DMS (degrees-minutes-seconds) conversion
+
+**DPI (JPEG, PNG, TIFF):**
+
+- `dpiX`, `dpiY` - Dots per inch for printing
+
+### EXIF 3.0 Specification Compliance
+
+The library implements the EXIF 3.0 specification with:
+
+- **50+ Exif Sub-IFD tags** for comprehensive camera metadata
+- **30+ IFD0 tags** for image information
+- **InteropIFD support** for format compatibility (R98/sRGB, R03/Adobe RGB,
+  THM/thumbnail)
+- **GPS IFD** with proper coordinate conversion
+- All EXIF data types (BYTE, ASCII, SHORT, LONG, RATIONAL, etc.)
+
+### Example Usage
+
+```typescript
+import { Image } from "@cross/image";
+
+// Load an image
+const data = await Deno.readFile("photo.jpg");
+const image = await Image.decode(data);
+
+// Set metadata
+image.setMetadata({
+  author: "Jane Photographer",
+  copyright: "© 2024",
+  cameraMake: "Canon",
+  cameraModel: "EOS R5",
+  iso: 800,
+  exposureTime: 0.004, // 1/250s
+  fNumber: 2.8,
+  focalLength: 50,
+});
+
+// Set GPS coordinates
+image.setPosition(40.7128, -74.0060); // NYC
+
+// Check what metadata a format supports
+const jpegSupports = Image.getSupportedMetadata("jpeg");
+console.log(jpegSupports); // Includes ISO, camera info, GPS, etc.
+
+// Save with metadata
+const jpeg = await image.save("jpeg");
+await Deno.writeFile("output.jpg", jpeg);
+
+// Metadata is preserved on reload!
+const loaded = await Image.decode(jpeg);
+console.log(loaded.metadata?.cameraMake); // "Canon"
+console.log(loaded.getPosition()); // { latitude: 40.7128, longitude: -74.0060 }
+```
+
+### Format-Specific Support
+
+Use `Image.getSupportedMetadata(format)` to check which fields are supported:
+
+```typescript
+Image.getSupportedMetadata("jpeg"); // Full camera metadata + GPS (21 fields)
+Image.getSupportedMetadata("tiff"); // Comprehensive EXIF + GPS + InteropIFD (23+ fields)
+Image.getSupportedMetadata("png"); // DateTime, GPS, DPI, basic text (9 fields)
+Image.getSupportedMetadata("webp"); // Enhanced XMP + GPS (15 fields - includes camera metadata!)
+```
+
+**Format Highlights:**
+
+- **JPEG**: Most comprehensive EXIF support, including all camera settings and
+  GPS
+- **TIFF**: Full EXIF 3.0 support with IFD structure, InteropIFD compatibility
+- **WebP**: Enhanced XMP implementation with Dublin Core, EXIF, and TIFF
+  namespaces
+- **PNG**: Basic EXIF support via eXIf chunk plus GPS coordinates
 
 ## Documentation
 
-- **[API Reference](https://cross-image.56k.guru/api.html)** - Complete API
+- **[API Reference](https://cross-image.56k.guru/api/)** - Complete API
   documentation
-- **[Examples](https://cross-image.56k.guru/examples.html)** - Usage examples
-  for common tasks
-- **[Format Support](https://cross-image.56k.guru/formats.html)** - Supported
+- **[Format Support](https://cross-image.56k.guru/formats/)** - Supported
   formats and specifications
-- **[JPEG Implementation](https://cross-image.56k.guru/implementation/jpeg-implementation.html)** -
+- **[Image Processing](https://cross-image.56k.guru/processing/)** - Filters,
+  manipulation, and color adjustments
+  - [Filters](https://cross-image.56k.guru/processing/filters/) - Blur, sharpen,
+    and noise reduction
+  - [Manipulation](https://cross-image.56k.guru/processing/manipulation/) -
+    Resize, crop, composite, and draw
+  - [Color Adjustments](https://cross-image.56k.guru/processing/color-adjustments/) -
+    Brightness, contrast, saturation, and more
+- **[Examples](https://cross-image.56k.guru/examples/)** - Practical examples
+  for common tasks
+  - [Decoding & Encoding](https://cross-image.56k.guru/examples/decoding-encoding/) -
+    Format-specific examples
+  - [Using Filters](https://cross-image.56k.guru/examples/filters/) - Filter
+    workflows and techniques
+  - [Manipulation](https://cross-image.56k.guru/examples/manipulation/) -
+    Resizing, cropping, and compositing
+  - [Multi-Frame Images](https://cross-image.56k.guru/examples/multi-frame/) -
+    Animated GIFs, APNGs, and TIFFs
+- **[JPEG Implementation](https://cross-image.56k.guru/implementation/jpeg-implementation/)** -
   Technical details for JPEG
-- **[WebP Implementation](https://cross-image.56k.guru/implementation/webp-implementation.html)** -
+- **[WebP Implementation](https://cross-image.56k.guru/implementation/webp-implementation/)** -
   Technical details for WebP
+- **[TIFF Implementation](https://cross-image.56k.guru/implementation/tiff-implementation/)** -
+  Technical details for TIFF
 
 ## Development
 

package/esm/mod.d.ts

@@ -2,7 +2,7 @@
  * @module @cross/image
  *
  * A pure JavaScript, dependency-free, cross-runtime image processing library.
- * Supports decoding, resizing, and encoding common image formats (PNG, APNG, JPEG, WebP, GIF, TIFF, BMP, ICO, DNG, PAM, PCX).
+ * Supports decoding, resizing, and encoding common image formats (PNG, APNG, JPEG, WebP, GIF, TIFF, BMP, ICO, DNG, PAM, PPM, PCX).
  * Includes image processing capabilities like compositing, level adjustments, and pixel manipulation.
  *
  * @example
@@ -55,5 +55,6 @@ export { ICOFormat } from "./src/formats/ico.js";
 export { DNGFormat } from "./src/formats/dng.js";
 export { PAMFormat } from "./src/formats/pam.js";
 export { PCXFormat } from "./src/formats/pcx.js";
+export { PPMFormat } from "./src/formats/ppm.js";
 export { ASCIIFormat } from "./src/formats/ascii.js";
 //# sourceMappingURL=mod.d.ts.map

package/esm/mod.js

@@ -2,7 +2,7 @@
  * @module @cross/image
  *
  * A pure JavaScript, dependency-free, cross-runtime image processing library.
- * Supports decoding, resizing, and encoding common image formats (PNG, APNG, JPEG, WebP, GIF, TIFF, BMP, ICO, DNG, PAM, PCX).
+ * Supports decoding, resizing, and encoding common image formats (PNG, APNG, JPEG, WebP, GIF, TIFF, BMP, ICO, DNG, PAM, PPM, PCX).
  * Includes image processing capabilities like compositing, level adjustments, and pixel manipulation.
  *
  * @example
@@ -54,4 +54,5 @@ export { ICOFormat } from "./src/formats/ico.js";
 export { DNGFormat } from "./src/formats/dng.js";
 export { PAMFormat } from "./src/formats/pam.js";
 export { PCXFormat } from "./src/formats/pcx.js";
+export { PPMFormat } from "./src/formats/ppm.js";
 export { ASCIIFormat } from "./src/formats/ascii.js";

package/esm/src/formats/jpeg.d.ts

@@ -1,4 +1,4 @@
-import type { ImageData, ImageFormat } from "../types.js";
+import type { ImageData, ImageFormat, ImageMetadata } from "../types.js";
 /**
  * JPEG format handler
  * Implements a basic JPEG decoder and encoder
@@ -30,6 +30,17 @@ export declare class JPEGFormat implements ImageFormat {
     private decodeUsingRuntime;
     private parseJFIF;
     private parseEXIF;
+    private parseExifSubIFD;
+    private parseGPSIFD;
+    private readRational;
     private createEXIFData;
+    private createGPSIFD;
+    private createExifSubIFD;
+    private toRational;
+    private writeRational;
+    /**
+     * Get the list of metadata fields supported by JPEG format
+     */
+    getSupportedMetadata(): Array<keyof ImageMetadata>;
 }
 //# sourceMappingURL=jpeg.d.ts.map