Skip to content
EnaiumPublic

About

Kotlin Multiplatform bindings for x265: HEVC/H.265 encoding on JVM, Android, Kotlin/Native and the web.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

x265-kmp

Kotlin Multiplatform bindings for x265: HEVC/H.265 encoding on JVM, Android, Kotlin/Native and the web.

x265 is included as a Git submodule and compiled from source for every target. One C ABI (jni/include/x265_kmp.h) drives the JNI bridge, the Kotlin/Native cinterop and the WebAssembly build, so every platform shares the same parameter handling, input validation and result format.

Binding version: 1.0.1-fixed.4.2.0 (x265 4.2, binding revision 1).

Supported targets

Platform Kotlin target Native artifact
JVM jvm x265-kmp-jni-jvm-{linux,darwin}-{x86_64,aarch64}, x265-kmp-jni-jvm-windows-x86_64
Android android x265-kmp AAR with libx265_jni.so for every ABI
Android Native androidNativeArm64, androidNativeArm32, androidNativeX64, androidNativeX86 static archive embedded in the cinterop klib; link the NDK's libc++_shared.so
Linux linuxX64, linuxArm64 static archive embedded in the cinterop klib
Windows mingwX64 static archive embedded in the cinterop klib
macOS macosX64, macosArm64 static archive embedded in the cinterop klib
iOS iosX64, iosArm64, iosSimulatorArm64 static archive embedded in the cinterop klib
tvOS tvosArm64, tvosSimulatorArm64 static archive embedded in the cinterop klib
watchOS watchosArm64, watchosSimulatorArm64, watchosDeviceArm64 static archive embedded in the cinterop klib
Kotlin/JS js embedded WebAssembly module
Kotlin/Wasm wasmJs embedded WebAssembly module

The web targets compile x265 to a standalone .wasm module with Emscripten, embed the binary into the published klib and instantiate it synchronously through a small JS bridge. No resource lookup or async initialization is required at runtime.

The standalone module, the JS glue and the licence are also published as the @enaium/x265-kmp npm package (:x265-kmp:assembleWasmNpm stages it in build/npm, :x265-kmp:publishWasmNpm publishes it). The fixed version is already valid npm semver, so it is published verbatim under the latest tag. Plain JavaScript apps instantiate it without Kotlin:

import { initX265Kmp } from "@enaium/x265-kmp";

const x265 = await initX265Kmp();
console.log(x265.versionString());

The npm token is read from npm.publish.key in ~/.gradle/gradle.properties (or -Pnpm.publish.key=<token>); CI reads the NPM_PUBLISH_KEY secret.

Android has two paths: the JNI AAR (:examples:android-jvm) and the androidNative* Kotlin/Native targets (:examples:android-native). The native targets are compiled with the SDK NDK, so a consumer's libmain.so must link the NDK's libc++_shared.so and package it next to itself; the example does both. Kotlin/Native's own bundled libc++ is too old for the archive's C++ runtime symbols.

This build is 8-bit (Main profile) only. The web module runs x265 in its single-threaded mode: Emscripten has no pthreads, so jni/patches turns x265's frame-encoder thread into an inline call, and the encoder is forced to pools=none, one frame thread and no WPP. All JVM and Kotlin/Native targets use x265's normal thread pool.

Using the library

dependencies {
    implementation("cn.enaium.x265:x265-kmp:1.0.1-fixed.4.2.0")
}

The Android AAR and the JVM artifacts contain the native libraries. JVM consumers automatically receive the per-OS/arch JNI artifacts and NativeLoader extracts the matching one from the classpath.

Encoding

import cn.enaium.x265.*

val param = X265Param.create(width = 1280, height = 720).apply {
    preset(X265Preset.ULTRAFAST)     // real-time camera setting
    tune(X265Tune.ZERO_LATENCY)
    crf(28.0)                        // 0 = lossless, 51 = worst
    keyframeMax = 30
    logLevel = X265LogLevel.NONE
}

X265Encoder.open(param).use { encoder ->
    // VPS/SPS/PPS, required as MediaCodec's csd-0 or by a muxer.
    val parameterSets = encoder.headers().toAnnexB()

    val picture = X265Picture.i420(y, u, v, width, height, pts = presentationTimeUs)
    encoder.encode(picture)?.let { frame ->
        // frame.nals exposes every NAL unit; frame.toAnnexB() adds start codes.
        sink.write(frame.toAnnexB())
    }

    // B-frames and the lookahead delay pictures; drain them before closing.
    encoder.flush().forEach { sink.write(it.toAnnexB()) }
}

Every x265 option is reachable by name through set:

param.set("preset", "slow")
param.set("crf", 24)
param.set("bframes", 6)
param.set("aq-mode", 3)
param.set("repeat-headers", true)

X265Param is a thin wrapper over x265_param_parse, so the option names and value syntax are exactly the ones documented by x265 --help.

Frames, NAL units and timestamps

X265Frame carries the NAL units of one encoded picture plus the presentation and decoding timestamps x265 echoed back. X265Nal.data starts with the two-byte NAL header; x265's own start codes or length prefixes are stripped by the binding, so toAnnexB() emits exactly one start code per NAL. That matters for permissive parsers like ffmpeg (which tolerate doubled start codes) and strict consumers like MediaCodec (which do not).

X265Encoder.encode returns null while x265 buffers input for frame reordering. flush returns every remaining picture and must be called once after the last input frame.

Examples

The examples share one SDL3 + Dear ImGui app in examples/common (targets: jvm, macOS/Linux/Windows native, Android JVM, Android Native and wasmJs). Camera frames come from camera-kmp: Camera2 on Android, Camera2 NDK and V4L2 on Android Native, AVFoundation/V4L2/Media Foundation on the desktops and getUserMedia in the browser, so the same code runs on every target instead of an Android-only camera implementation.

The pipeline is camera-kmp I420 -> x265 ultrafast + zerolatency encode. Decoding uses the platform API where one exists: MediaCodec on Android (JVM and native) and WebCodecs in the browser; the desktop targets fall back to libde265 (cn.enaium.libde265:libde265-kmp). The UI shows the camera picture next to the decoded round trip with frame, byte and bitrate counters. A deterministic test pattern is used only until the camera delivers its first frame (or when no camera exists), so the preview never alternates between the test pattern and the camera.

The left-hand panel of the UI edits the capture parameters: image source (camera or a generated test pattern), resolution (320x240 through 1920x1080), clockwise rotation (0/90/180/270), front/back lens and horizontal mirroring. Rotation applies to both the preview and the output; the mirror option applies only to the encoded/decoded output, while the camera preview stays unmirrored. Changing one restarts the camera session and recreates the encoder/decoder chain for the new dimensions.

examples/common is also the wasmJs browser host: its Emscripten runtimes (sdl-kmp, imgui-kmp and camera-kmp) are installed as npm packages and served next to the Kotlin module, and requestAnimationFrame drives the shared loop.

The two Android host modules are thin wrappers around the shared code:

  • examples/android-jvm - an Android app whose SDLActivity.main() calls the shared runExample().
  • examples/android-native - an Android app that packages the libmain.so built by examples/common; it carries no camera or UI code of its own.
# desktop entry of the shared module
./gradlew :examples:common:linkDebugExecutableMacosArm64
./examples/common/build/bin/macosArm64/debugExecutable/common.kexe

./gradlew :examples:android-jvm:assembleDebug
./gradlew -PandroidAbis=arm64-v8a :examples:android-native:assembleDebug

./gradlew :examples:common:wasmJsBrowserDistribution
python3 -m http.server 8080 --directory examples/common/build/dist/wasmJs/productionExecutable
# open http://localhost:8080/ - serve over HTTPS or localhost for the camera

The SDL3 and imgui-kmp Java/Kotlin APIs are published on Maven Central (cn.enaium.sdl:sdl-kmp:1.0.14-fixed.3.4.18, cn.enaium.imgui:imgui-kmp:1.0.17-fixed.1.93.0); the browser runtimes are @enaium/sdl-kmp@1.0.14-fixed.3.4.18, @enaium/imgui-kmp@1.0.17-fixed.1.93.0 and @enaium/camera-kmp@1.0.0.

Building from source

git submodule update --init --recursive
./gradlew :x265-kmp:jvmTest                 # JNI + tests
./gradlew :examples:android-jvm:assembleDebug   # Android host
./gradlew :x265-kmp:buildWebWasm            # Emscripten module

Native targets are built through CMake. NASM is used for x86 assembly when it is on PATH (x265 falls back to portable C++ otherwise); AArch64 assembly is compiled with the C++ compiler.

The web build does not compile the submodule directly: prepareX265WasmSource runs git clone --shared into the build directory and applies jni/patches/x265-single-threaded-wasm.patch, so the checkout stays pristine and the stream still reports x265 4.2. The Android ARM64 build needs the NDK target triple for x265's raw .S rules, passed through ASM_FLAGS.

Licence

x265 is licensed under the GPL v2 (or a commercial licence from MulticoreWare). Linking it into an application makes the resulting work subject to the GPL unless a commercial x265 licence is obtained. The bindings themselves are released under the GPL-2.0-or-later.

About

Kotlin Multiplatform bindings for x265: HEVC/H.265 encoding on JVM, Android, Kotlin/Native and the web.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages