kiteplayer-ffmpeg/io.github.yuroyami.kiteplayer.ffmpeg

Package-level declarations

Types

AudioAnalysis

object AudioAnalysis

Measurements over a whole file, decoded here rather than played.

KiteFFmpegAudioDecoderFactory

class KiteFFmpegAudioDecoderFactory : AudioDecoderFactory

Creates audio decoders.

KiteFFmpegMediaBackend

class KiteFFmpegMediaBackend(onWarning: (PlaybackWarning) -> Unit = {}, decoderOptions: Map<String, String> = emptyMap(), lowDelayDecode: Boolean = false) : MediaBackend

The FFmpeg backend, as one session-shaped object.

KiteFFmpegResampler

class KiteFFmpegResampler : AudioResamplerFactory

Converts sample rates with FFmpeg's libswresample, through the aresample filter of the KiteFFmpeg filter graph. Set it in AudioConfig.resampler.

KiteFFmpegSource

class KiteFFmpegSource : PlayerMediaSource, RecordingCapable

KiteFFmpegSourceFactory

class KiteFFmpegSourceFactory : MediaSourceFactory

The engine's source and decoders, over KiteFFmpeg.

KiteFFmpegVideoDecoderFactory

class KiteFFmpegVideoDecoderFactory : VideoDecoderFactory

Creates the platform-selected decoder and, where policy allows, its replay-safe software fallback.

KiteFFmpegVideoFrame

class KiteFFmpegVideoFrame : VideoFrame, SoftwareReadableFrame

A decoded video frame, still in native memory.

KiteFFmpegWebPainter

class KiteFFmpegWebPainter : AutoCloseable

Paints this backend's video frames into a web destination as RGBA, inside the codec module.

SnapshotFormat

enum SnapshotFormat : Enum<SnapshotFormat>

The standalone image formats a snapshot can take. Both encoders are in every KiteFFmpeg build.

SoftwareConverter

object SoftwareConverter

Turns a decoded CPU-readable frame into tightly packed RGBA on JVM and Android.

object SoftwareConverter

Turns a decoded frame into RGBA, on the CPU.

Thumbnail

data class Thumbnail(val position: Duration, val width: Int, val height: Int, val bytes: ByteArray, val format: SnapshotFormat)

One preview image: a complete file in format, width by height pixels, taken at position. Two thumbnails are equal when every field is, the contents of bytes included.

Thumbnails

object Thumbnails

Seek previews and library grids: images at positions, scaled and encoded in one call.

UploadPlanes

class UploadPlanes(val width: Int, val height: Int, val format: PlayerPixelFormat, val planes: List<UploadPlanes.UploadPlane>)

What a GPU renderer needs from a frame, in the backend's own words. The output module defines the renderer seam and never sees this backend; a consumer that owns both maps these two answers onto it in a handful of lines. The memcpy discipline lives HERE, once: a hardware frame crosses as its CVPixelBuffer with no copy at all, and a software frame crosses as its planes copied out whole (stride times rows, one memcpy each) still in their native pixel format, which is the law: YUV until the GPU, never RGBA on the CPU.

Waveform

data class Waveform(val bucketDuration: Duration, val peaks: FloatArray, val rms: FloatArray)

A file drawn as peaks and rms, one entry per bucket of bucketDuration, both in 0..1 and mono-mixed. A bucket nothing was decoded into reads zero in both. Two waveforms are equal when every field is, the contents of both arrays included.

Waveforms

object Waveforms

Audio apps draw the file. This decodes it into the shape they draw.

Functions

corePixelBufferOrNull

fun KiteFFmpegVideoFrame.corePixelBufferOrNull(): COpaquePointer?

The CVPixelBuffer of a VideoToolbox frame, or null when the frame is not that kind.

encode

fun SoftwareReadableFrame.encode(format: SnapshotFormat = SnapshotFormat.Jpeg): ByteArray

Encodes a frame with readable planes as a standalone image: a CapturedFrame from KitePlayer.captureFrame, or any software frame a backend produced.

interleavedFloat

fun AudioBuffer.interleavedFloat(): FloatArray

The buffer's samples as interleaved float, which is what the engine's ring and every audio device want.

uploadPlanesOrNull

fun KiteFFmpegVideoFrame.uploadPlanesOrNull(): UploadPlanes?

The frame's planes for texture upload, or null when the frame lives in hardware memory (use corePixelBufferOrNull there instead; downloading to feed a GPU that could wrap the surface directly would be the exact copy this path exists to avoid).

withVideoFilter

fun MediaItem.withVideoFilter(chain: FilterChain): MediaItem

The typed route to MediaItem.videoFilter: a chain built with KiteFFmpeg's videoFilters { } lands on the item as the string the graph builder reads. No opt-in needed, because the DSL is not raw FFmpeg syntax; the raw field stays behind KitePlayerLowLevelApi for chains the typed set lacks.