xmpkit 0.1.3

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

# Building for OpenHarmony/HarmonyOS

This guide explains how to build xmpkit for OpenHarmony/HarmonyOS platforms.

## Prerequisites

1. Install Rust toolchain:
   ```bash
   rustup target add aarch64-unknown-linux-ohos
   rustup target add armv7-unknown-linux-ohos
   rustup target add x86_64-unknown-linux-ohos
   ```

2. Install HarmonyOS NDK and set environment variable:
   ```bash
   export OHOS_NDK_HOME=/path/to/openharmony/ndk
   ```

3. Install `ohrs` CLI tool:
   ```bash
   cargo install ohrs
   ```

## Building

### Using ohrs (Recommended)

The `ohrs` tool simplifies the build process:

```bash
# Build for all architectures
ohrs build --features ohos

# Build for specific architecture
ohrs build --features ohos --arch aarch64

# Build release version
ohrs build --features ohos --release
```

The build artifacts will be placed in the `dist` directory:
- `dist/arm64-v8a/libxmpkit.so` - ARM64 version
- `dist/armeabi-v7a/libxmpkit.so` - ARMv7 version
- `dist/x86_64/libxmpkit.so` - x86_64 version

### Using cargo directly

You can also build directly with cargo:

```bash
# Build for ARM64
cargo build --features ohos --lib --release --target aarch64-unknown-linux-ohos

# Build for ARMv7
cargo build --features ohos --lib --release --target armv7-unknown-linux-ohos

# Build for x86_64
cargo build --features ohos --lib --release --target x86_64-unknown-linux-ohos
```

The built `.so` files will be in `target/{target-triple}/release/`.

## Integration

1. Copy the `.so` files to your OpenHarmony project's `libs` directory:
   ```
   libs/
   ├── arm64-v8a/
   │   └── libxmpkit.so
   ├── armeabi-v7a/
   │   └── libxmpkit.so
   └── x86_64/
       └── libxmpkit.so
   ```

2. Use in ArkTS:
   ```typescript
   import { XmpFile, XmpMeta } from 'libxmpkit.so';
   
   const file = new XmpFile();
   file.fromBytes(fileBytes);
   const meta = file.getXmp();
   ```

## Troubleshooting

### Missing environment variables

If you see errors about missing environment variables when using `ohrs build`, ensure:
- `OHOS_NDK_HOME` is set correctly
- You have the latest version of `ohrs`: `cargo install --force ohrs`
- Create `.cargo/config.toml` to set environment variables:
  ```toml
  [env]
  OHOS_NDK_HOME = { value = "/path/to/openharmony", force = false }
  ```

### Linker errors

If you encounter linker errors, ensure:
- The HarmonyOS NDK is properly installed
- The correct toolchain is selected
- Environment variables are set correctly