kiteffmpeg/io.github.yuroyami.kiteffmpeg/FrameInfo

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, val hdr: HdrMetadata? = null)

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

Constructors

FrameInfo

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

Types

Companion

object Companion

The sentinel FFmpeg uses for a missing timestamp.

Properties

channelCount

val channelCount: Int

channelLayoutMask

val channelLayoutMask: Long?

Which speaker each channel of this audio frame belongs to, as FFmpeg's native order mask.

color

val color: ColorInfo

The colour metadata a renderer must honour. Ignoring it produces a picture that is present and wrong, which is worse than one that is absent: hues shift, or black turns grey.

duration

val duration: Long

The decoder's own duration for this frame, in timeBase units. 0 when it gave none.

hasPts

val hasPts: Boolean

False when the frame carries no timestamp (AV_NOPTS_VALUE). ptsSeconds is meaningless then.

hdr

val hdr: HdrMetadata?

The static HDR metadata this frame carries: from the bitstream, such as an HEVC SEI message, or from the container. Null on every SDR frame. Like color, the decoder is the authority here, and a raw HEVC or MPEG-TS stream declares it only in the bitstream.

height

val height: Int

isHardware

val isHardware: Boolean

True when the pixels live in GPU or hardware memory rather than in main memory.

isKeyframe

val isKeyframe: Boolean

True when this frame can be decoded without any earlier frame.

pixelFormat

val pixelFormat: PixelFormat

pts

val pts: Long