kiteffmpeg/io.github.yuroyami.kiteffmpeg.dsl

Package-level declarations

Types

Aresample

data class Aresample(val sampleRate: Int) : FilterStep

Atempo

data class Atempo(val tempo: Double) : FilterStep

AudioEncoderTuning

data class AudioEncoderTuning(val profile: String? = null, val bitrateBps: Long? = null)

AudioFilterBuilder

class AudioFilterBuilder

AudioFormat

data class AudioFormat(val sampleFormat: String? = null, val sampleRate: Int? = null, val channelLayout: String? = null) : FilterStep

Crop

data class Crop(val width: Int, val height: Int, val x: Int? = null, val y: Int? = null) : FilterStep

DecoderOptions

data class DecoderOptions(val skipLoopFilter: DecoderSkip? = null, val skipFrame: DecoderSkip? = null, val errorDetection: Set<ErrorDetection> = emptySet(), val threadType: DecoderThreadType? = null, val options: Map<String, String> = emptyMap())

Typed decoder options (KD-2), applied through the EXISTING av_opt_set funnel between codec-context creation and open. Control plane only (law 1): these configure an open, never a per-frame call. compile is the pure, golden-tested mapping to option pairs; a wrong key in options reproduces the funnel's measured EINVAL path rather than being filtered here.

DecoderSkip

enum DecoderSkip : Enum<DecoderSkip>

avcodec's skip ladder, by its own option value names.

DecoderThreadType

enum DecoderThreadType : Enum<DecoderThreadType>

Deinterlace

data class Deinterlace(val with: Deinterlacer = Deinterlacer.Bwdif) : FilterStep

Deinterlacer

enum Deinterlacer : Enum<Deinterlacer>

DrawBox

data class DrawBox(val x: Int, val y: Int, val width: Int, val height: Int, val color: String = "red", val thickness: Int = 3) : FilterStep

EncoderPreset

enum EncoderPreset : Enum<EncoderPreset>

data class Eq(val brightness: Double? = null, val contrast: Double? = null, val saturation: Double? = null, val gamma: Double? = null) : FilterStep

Neutral values compile away, so Eq(brightness = 0.1) sends exactly one knob.

ErrorDetection

enum ErrorDetection : Enum<ErrorDetection>

FilterChain

data class FilterChain(val steps: List<FilterStep>)

FilterStep

sealed interface FilterStep

The typed filter DSL (KD-1): a compilation layer onto the description STRINGS the existing FilterGraph.buildVideo/buildAudio already take. Nothing here crosses into C; the laws that bind it:

Format

data class Format(val format: PixelFormat) : FilterStep

Fps

data class Fps(val rate: Rational) : FilterStep

Loudnorm

data class Loudnorm(val integrated: Double = -24.0, val truePeak: Double = -2.0, val range: Double = 7.0) : FilterStep

EBU R128 loudness normalisation with the filter's own defaults.

Pad

data class Pad(val width: Int, val height: Int, val x: Int = -1, val y: Int = -1, val color: String = "black") : FilterStep

Pan

data class Pan(val layout: String, val outputs: List<String>) : FilterStep

A downmix or routing matrix: Pan("stereo", "c0=FL+0.7*FC", "c1=FR+0.7*FC"). The channel expressions are FFmpeg's own pan syntax, escaped as one value because pan's separator is the pipe, which the chain separator must not see.

QuarterTurn

enum QuarterTurn : Enum<QuarterTurn>

RateControl

sealed interface RateControl

Raw

data class Raw(val fragment: String) : FilterStep

The escape hatch (law 2): any chain fragment the typed set lacks, joined verbatim. Capability checks cannot see inside it; the caller owns that claim.

Scale

data class Scale(val width: Int, val height: Int) : FilterStep

Transpose

data class Transpose(val turn: QuarterTurn) : FilterStep

VideoEncoderTuning

data class VideoEncoderTuning(val preset: EncoderPreset? = null, val profile: String? = null, val tune: String? = null, val rateControl: RateControl? = null)

The typed encoder layer: sugar compiling INTO the existing options maps of the encoder specs. Zero C, zero new funnel; applyTo returns a new spec whose options carry the typed knobs as the exact av_opt_set strings the wrappers already send.

VideoFilterBuilder

class VideoFilterBuilder

Volume

data class Volume(val gain: Double) : FilterStep

Linear gain: 1.0 is unity, 0.5 is half amplitude.

Functions

audioFilters

fun audioFilters(block: AudioFilterBuilder.() -> Unit): FilterChain

escapeFilterValue

fun escapeFilterValue(value: String): String

The one escaping function every typed filter argument passes through (KD-1).

videoFilters

fun videoFilters(block: VideoFilterBuilder.() -> Unit): FilterChain