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

KiteFFmpegVideoFrame

class KiteFFmpegVideoFrame : VideoFrame, SoftwareReadableFrame

A decoded video frame, still in native memory.

The pixels are not copied here and they never reach Kotlin memory unless a renderer asks for them. That is the whole point: a 1080p frame is 3.11 MB and a 4K 10-bit frame is 24.9 MB, so copying at 60 frames a second would cost between 187 MB/s and 1.5 GB/s for nothing.

Properties

closedCaptions

open override val closedCaptions: ByteArray?

The A/53 caption bytes FFmpeg's decoder attached to this picture (#236). Unreadable side data costs this picture's captions and nothing more.

colorSpace

open override val colorSpace: ColorSpaceInfo

crop

open override val crop: PictureCrop?

The container's crop, already checked to fit this frame.

duration

open override val duration: Pts?

generation

open override val generation: Generation

hardwareSurface

open override val hardwareSurface: HwSurfaceKind?

hasPts

val hasPts: Boolean

False when the decoder gave this frame no timestamp, so pts was counted forward from the previous frame rather than read from the media.

hdr

open override val hdr: HdrStaticMetadata?

The decoder's own reading first, because a raw HEVC or MPEG-TS stream says it only in the bitstream.

mirrored

open override val mirrored: Boolean

Whether the stream's display matrix also mirrors the picture. No default, for the same reason.

pixelFormat

open override val pixelFormat: PlayerPixelFormat

planeCount

open override val planeCount: Int

planeFormat

open override val planeFormat: PlayerPixelFormat

The downloaded copy's format for a VideoToolbox frame, which downloads it on first read.

pts

open override val pts: Pts

Already on the engine's relative timeline, and synthesised when the decoder gave none.

rotationDegrees

open override val rotationDegrees: Int

The stream's own clockwise rotation, from the container's display matrix.

sceneMaxNits

open override val sceneMaxNits: Float?

The peak of this frame's scene, from the Dolby Vision RPU the decoder read, in nits.

size

open override val size: VideoSize

Functions

open override fun close()

copyPlane

open override fun copyPlane(index: Int, into: ByteArray, offset: Int)

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.

planeHeight

open override fun planeHeight(index: Int): Int

planeStride

open override fun planeStride(index: Int): Int

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).