kiteffmpeg/io.github.yuroyami.kiteffmpeg

Package-level declarations

Types

expect class AudioEncoder : AutoCloseable

One configured and opened audio encoder. Some codecs require a fixed input chunk size (AAC: 1024 samples). For those, route frames through FilterGraph.buildAudio and call FilterGraph.setOutputFrameSize with frameSize (Transcoder does this automatically).

actual class AudioEncoder : AutoCloseable

AudioEncoderSpec

data class AudioEncoderSpec(val codec: CodecId, val sampleRate: Int, val channels: Int = 2, val sampleFormat: SampleFormat = SampleFormat.None, val bitrateBps: Long, val options: Map<String, String> = emptyMap())

AudioInput

data class AudioInput(val sampleRate: Int, val sampleFormat: SampleFormat, val channels: Int, val timeBase: Rational)

Per-input description for FilterGraph.buildAudioMulti.

AudioStreamInfo

data class AudioStreamInfo(val sampleRate: Int, val channels: Int, val sampleFormat: SampleFormat, val channelLayoutMask: Long? = null)

Chapter

data class Chapter(val id: Long, val startMicros: Long, val endMicros: Long, val metadata: Map<String, String> = emptyMap())

One container chapter (KD-5), bounds in microseconds on the same ABSOLUTE timeline every other timestamp KiteFFmpeg reports uses (subtract MediaSource.startTimeMicros to move onto the relative timeline seeks accept).

ChromaLocation

enum ChromaLocation : Enum<ChromaLocation>

Where a chroma sample sits relative to its luma samples. Values match FFmpeg's AVChromaLocation.

CodecId

@JvmInline

value class CodecId(val name: String)

Codec identifier: symbolic name (h264, aac, libx264). Matches avcodec_find_*_by_name.

ColorInfo

data class ColorInfo(val matrix: ColorMatrix = ColorMatrix.Unspecified, val primaries: ColorPrimaries = ColorPrimaries.Unspecified, val transfer: ColorTransfer = ColorTransfer.Unspecified, val fullRange: Boolean = false, val chromaLocation: ChromaLocation = ChromaLocation.Unspecified, val rangeSpecified: Boolean = false, val matrixSpecified: Boolean = false, val primariesSpecified: Boolean = false, val transferSpecified: Boolean = false)

The colour metadata a renderer must honour to draw a frame correctly.

ColorMatrix

enum ColorMatrix : Enum<ColorMatrix>

The YCbCr to RGB matrix. Values match FFmpeg's AVColorSpace.

ColorPrimaries

enum ColorPrimaries : Enum<ColorPrimaries>

The colour primaries. Values match FFmpeg's AVColorPrimaries.

ColorTransfer

enum ColorTransfer : Enum<ColorTransfer>

The transfer function, meaning the gamma curve. Values match FFmpeg's AVColorTransferCharacteristic.

CopyStream

expect class CopyStream

An output stream fed by stream-copy. Opaque handle; packets flow through Remuxer/Transcoder.

actual class CopyStream

An output stream fed by stream-copy. Opaque handle; packets flow through Remuxer/Transcoder.

actual class CopyStream

An output stream fed by stream-copy. Opaque handle; packets flow through Remuxer/Transcoder.

actual class CopyStream

An output stream fed by stream-copy. Opaque handle; packets flow through Remuxer/Transcoder.

CorruptData

enum CorruptData : Enum<CorruptData>

What decoding does when FFmpeg reports damaged data.

Disposition

data class Disposition(val default: Boolean = false, val forced: Boolean = false, val hearingImpaired: Boolean = false, val visualImpaired: Boolean = false, val attachedPicture: Boolean = false)

What a container says a stream is for.

FFmpeg

expect object FFmpeg

Static facade for global FFmpeg state: version info, build flags and capability probing.

actual object FFmpeg

Static facade for global FFmpeg state: version info, build flags and capability probing.

actual object FFmpeg

Static facade for global FFmpeg state: version info, build flags and capability probing.

actual object FFmpeg

Static facade for global FFmpeg state: version info, build flags and capability probing.

actual object FFmpeg

The real web backend, over the generated binding.

FFmpegError

sealed class FFmpegError

Every KiteFFmpeg failure surfaces as FFmpegException wrapping a typed FFmpegError.

FFmpegException

class FFmpegException(val error: FFmpegError) : RuntimeException

The single exception type KiteFFmpeg throws for FFmpeg-related failures. Inspect error for the semantic category and code for the raw AVERROR_* value.

FFmpegIdentity

class FFmpegIdentity(val status: Int, val bypassed: Boolean, val bypassedStatus: Int, val cAbiVersion: String, val libraries: List<FFmpegLibraryIdentity>, val configurationsAgree: Boolean, val configurationsDisagreed: List<String>, val buildFFmpegRef: String, val buildLicenseFlavour: String, val buildProvisioningDir: String, val runtimeVersionInfo: String, val runtimeLicense: String, val provisioning: String)

The FFmpeg identity report: what this build was compiled against, what it is linked to, and whether the two are compatible.

FFmpegLibraryIdentity

class FFmpegLibraryIdentity(val name: String, val headerMajor: Int, val headerMinor: Int, val headerMicro: Int, val runtimeMajor: Int, val runtimeMinor: Int, val runtimeMicro: Int, val verdict: String)

One FFmpeg library's two version columns and the verdict comparing them.

FilterGraph

expect class FilterGraph : AutoCloseable

A compiled libavfilter graph. Build with FilterGraph.buildVideo / FilterGraph.buildAudio (single input) or buildVideoMulti / buildAudioMulti (N inputs: overlay, amix, …). Feed frames through process (single input) or feedInput (any input). Close it when done.

actual class FilterGraph : AutoCloseable

Frame

expect class Frame : AutoCloseable

One decoded frame (video or audio), backed by an opaque native owner. Close it to release the buffers.

actual class Frame : AutoCloseable

One decoded frame (video or audio), backed by an opaque native owner. Close it to release the buffers.

actual class Frame : AutoCloseable

AVFrame-backed Frame implementation. The native pointer (nativeFrame) is internal: users go through info / copyPlanesToByteArray; the filter graph & encoder modules in this package read the pointer directly for zero-copy hand-offs.

actual class Frame : AutoCloseable

One decoded frame (video or audio), backed by an opaque native owner. Close it to release the buffers.

actual class Frame : AutoCloseable

A decoded frame, as a handle into the codec module.

FrameInfo

data class FrameInfo(val streamIndex: Int, val type: MediaType, val pts: Long, val timeBase: Rational, val width: Int = 0, val height: Int = 0, val pixelFormat: PixelFormat = PixelFormat.None, val sampleCount: Int = 0, val sampleRate: Int = 0, val channelCount: Int = 0, val sampleFormat: SampleFormat = SampleFormat.None, val channelLayoutMask: Long? = null, val duration: Long = 0, val isKeyframe: Boolean = false, val color: ColorInfo = ColorInfo.Unspecified, val sampleAspectRatio: Rational = Rational(1, 1), val isHardware: Boolean = false)

Immutable per-frame metadata snapshot: no native handle, safe to hold forever.

HardwareAccel

enum HardwareAccel : Enum<HardwareAccel>

A hardware acceleration a decoder can be opened with (KiteFFmpeg window 3).

KiteFFmpegLowLevelApi

@RequiresOptIn(level = RequiresOptIn.Level.ERROR, message = "Low-level KiteFFmpeg API: native-backed handles, manual lifetimes, and no stability promise. Opt in with @OptIn(KiteFFmpegLowLevelApi::class) if you are building a player or another pipeline that must drive demuxing and decoding as separate stages.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.TYPEALIAS])

annotation class KiteFFmpegLowLevelApi

Marks API that hands out opaque native-backed owners, manual lifetimes, or a stage of the pipeline that the caller must drive itself.

KiteFFmpegWeb

object KiteFFmpegWeb

Loads the codec, which on the web is a separate wasm module fetched over the network.

MediaByteSource

interface MediaByteSource : AutoCloseable

Media bytes from caller code instead of a path: the custom I/O door. A player streams through its own HTTP client with its own TLS and auth, reads from an encrypted store, a torrent, a cache, or a byte array it already holds, and FFmpeg demuxes those bytes exactly as it would a file's.

MediaInfo

data class MediaInfo(val durationMicros: Long?, val formatName: String, val metadata: Map<String, String>, val chapters: List<Chapter>)

The container-level facts in one value (KD-5): what a player's media screen shows before any stream is selected. Assembled from the source's own members, so it can never disagree with them.

MediaSink

expect class MediaSink : AutoCloseable

An open output file (muxer). Add every encoder first, video and audio, because the muxer's header freezes the stream list. Then push frames through the encoders. Close the sink to write the trailer and flush buffers.

actual class MediaSink : AutoCloseable

MediaSource

expect class MediaSource : AutoCloseable

An opened input: a local file or a URL. It owns the container cursor and per-stream resources, and closing it releases them all. Confine it to one coroutine context, because the underlying media objects are not safe to call concurrently.

actual class MediaSource : AutoCloseable

An open container, over the codec module.

MediaType

enum MediaType : Enum<MediaType>

What kind of data flows on a stream / through a codec / out of a filter graph.

Packet

expect class Packet : AutoCloseable

A demuxed packet the caller owns.

actual class Packet : AutoCloseable

A demuxed packet the caller owns.

actual class Packet : AutoCloseable

A demuxed packet the caller owns.

actual class Packet : AutoCloseable

A demuxed packet the caller owns.

actual class Packet : AutoCloseable

A demuxed packet the caller owns.

PacketReader

expect class PacketReader : AutoCloseable

Reads owned packets from one MediaSource cursor under the caller's control. This is the demuxing half of a player, kept separate from decoding so audio and video decoding can proceed independently and a seek can replace the caller's queued generation explicitly.

actual class PacketReader : AutoCloseable

Reads packets from a container, one at a time, under the caller's control.

actual class PacketReader : AutoCloseable

PixelFormat

@JvmInline

value class PixelFormat(val name: String)

The pixel format of a video frame, named exactly as FFmpeg names it (yuv420p, nv12, …). The platform bridge translates the name to an AV_PIX_FMT_* value.

Rational

class Rational : Comparable<Rational>

FFmpeg's AVRational: an exact fraction. Use it for time-bases, frame rates and aspect ratios. Float conversion is lossy; do all arithmetic on the rational form when possible.

Remuxer

expect object Remuxer

Lossless container rewrite: ffmpeg -c copy. Packets move from input to output without touching a decoder or encoder, so a full-length movie remuxes in seconds and bit-exact quality is preserved. Use it to change containers (mp4 → mkv), strip streams, cut on keyframes, or re-wrap after a download.

actual object Remuxer

SampleFormat

@JvmInline

value class SampleFormat(val name: String)

Audio sample format. Planar variants store each channel in its own plane; packed variants interleave channels. s16 / s16p is the most common decoder output.

SeekDirection

expect enum SeekDirection : Enum<SeekDirection>