mlt-ffi 0.1.21

Diplomat FFI bindings for mlt-core
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

# mlt-ffi

[Diplomat](https://github.com/rust-diplomat/diplomat)-based FFI bindings for
`mlt-core`, providing MLT <-> MVT conversion from C, C++, and Kotlin.

## API

| Type               | Purpose                                                          |
| ------------------ | ---------------------------------------------------------------- |
| `MltConverter`     | `mlt_to_mvt(bytes)` and `mvt_to_mlt(bytes, encoder_options)` conversion |
| `MltEncoderOptions`| Builder wrapping `EncoderConfig` - construct with `new()`, toggle flags with setters |
| `MltBuffer`        | Owned result buffer with `.bytes` / `.len` accessors             |
| `ConvertError`     | `InvalidInput` or `EncodingFailed`                               |

## Usage examples

The round-trip tests are the primary documentation for each language:

- **C** - [`tests/c/test_round_trip.c`](tests/c/test_round_trip.c)
- **C++** - [`tests/cpp/test_round_trip.cpp`](tests/cpp/test_round_trip.cpp)
- **Kotlin** - [`tests/kotlin/TestRoundTrip.kt`](tests/kotlin/TestRoundTrip.kt)

## Building

```sh
cargo build --release -p mlt-ffi
```

## Regenerating bindings

```sh
just rust::sync-ffi-bindings
```

Requires `diplomat-tool`, `clang-format`, and `ktlint`.

## Running tests

```sh
just rust::test-ffi-c
just rust::test-ffi-cpp
just rust::test-ffi-kotlin
```