xmpkit 0.1.0

Pure Rust implementation of Adobe XMP Toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

<div align="center">

# XMPKit

<div>
  <img src="assets/logo-icon.svg" alt="XMPKit Logo" width="120" height="120">
</div>

**Pure Rust implementation of Adobe XMP Toolkit**

</div>

[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Apache licensed, Version 2.0][apache-badge]][apache-url]
[![Build Status][actions-badge]][actions-url]

[crates-badge]: https://img.shields.io/crates/v/xmpkit.svg
[crates-url]: https://crates.io/crates/xmpkit
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/cavivie/xmpkit/blob/master/LICENSE-MIT
[apache-badge]: https://img.shields.io/badge/license-APACHE2.0-blue.svg
[apache-url]: https://github.com/cavivie/xmpkit/blob/master/LICENSE-APACHE
[actions-badge]: https://github.com/cavivie/xmpkit/workflows/CI/badge.svg
[actions-url]: https://github.com/cavivie/xmpkit/actions?query=workflow%3ACI+branch%3Amain

## Overview

XMPKit is a pure Rust implementation of Adobe's XMP (Extensible Metadata Platform) Toolkit. It provides APIs for reading, writing, and manipulating XMP metadata in various file formats without any C++ dependencies.

## Features

- Pure Rust implementation (no C++ dependencies)
- Compatible with Adobe XMP standard
- Support for common file formats (JPEG, PNG, TIFF, etc.)
- Memory safe and high performance
- Zero-cost abstractions
- Cross-platform support (iOS, Android, HarmonyOS, macOS, Windows, Linux, Wasm)

## Quick Start

```rust
use xmpkit::XmpMeta;

// Parse XMP from string
let meta = XmpMeta::from_str(xmp_str)?;

// Get a property
if let Some(value) = meta.get_property("http://ns.adobe.com/xap/1.0/", "CreatorTool") {
    println!("Creator: {}", value);
}

// Set a property
meta.set_property("http://ns.adobe.com/xap/1.0/", "CreatorTool", "MyApp")?;

// Serialize back to XMP Packet
let xmp_packet = meta.serialize();
```

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
xmpkit = "0.1.0"
```

## Documentation

Full API documentation is available at [docs.rs/xmpkit](https://docs.rs/xmpkit).

For WebAssembly/JavaScript integration, see [WASM_JAVASCRIPT.md](docs/WASM_JAVASCRIPT.md).

## Project Status

### File Format Support

| Format | Extensions | Read XMP | Write XMP | Status |
|--------|-----------|----------|-----------|--------|
| JPEG | .jpg, .jpeg | Yes | Yes | Fully supported |
| PNG | .png | Yes | Yes | Fully supported |
| TIFF | .tif, .tiff | Yes | Yes | Fully supported |
| MP3 | .mp3 | Yes | Yes | Fully supported |
| GIF | .gif | Yes | Yes | Fully supported |
| MP4 | .mp4 | Yes | Yes | Fully supported |
| PDF | .pdf | No | No | Planned |
| WebP | .webp | No | No | Planned |

### Platform Support

| Platform | Architecture | File I/O | Memory I/O | Status |
|----------|-------------|----------|------------|--------|
| **Native Platforms** |
| macOS | x86_64, arm64 | Yes | Yes | Fully supported |
| Linux | x86_64, arm64 | Yes | Yes | Fully supported |
| Windows | x86_64, arm64 | Yes | Yes | Fully supported |
| iOS | arm64 | Yes | Yes | Fully supported |
| Android | arm64, armv7, x86_64 | Yes | Yes | Fully supported |
| HarmonyOS | arm64, armv7, x86_64 | Yes | Yes | Fully supported (use `ohos` feature for Node-API bindings) |
| **Web Platforms** |
| WebAssembly | wasm32 | No | Yes | Partial (use `from_bytes()` / `from_reader()`, see [WASM_WEBASSEMBLY](docs/WEB_ASSEMBLY.md)) |

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](docs/CONTRIBUTING.md) for guidelines.

## License

This project is licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## References

- [Adobe XMP Toolkit SDK - Rust](https://github.com/adobe/xmp-toolkit-rs)
- [Adobe XMP Toolkit SDK](https://github.com/adobe/XMP-Toolkit-SDK)
- [XMP Specification](https://www.adobe.com/devnet/xmp.html)