Metadata related to a captured frame. More...

Classes
struct	Plane
	Per-plane frame metadata. More...

Public Types
enum	Status { FrameSuccess, FrameError, FrameCancelled, FrameStartup }
	Define the frame completion status. More...

Public Member Functions
Span< Plane >	planes ()
	Retrieve the array of per-plane metadata. More...

Span< const Plane >	planes () const
	Retrieve the array of per-plane metadata. More...

Public Attributes
Status	status
	Status of the frame. More...

unsigned int	sequence
	Frame sequence number. More...

uint64_t	timestamp
	Time when the frame was captured. More...

Detailed Description

Metadata related to a captured frame.

The FrameMetadata structure stores all metadata related to a captured frame, as stored in a FrameBuffer, such as capture status, timestamp and bytes used.

Member Enumeration Documentation

◆ Status

enum libcamera::FrameMetadata::Status

Define the frame completion status.

Enumerator
FrameSuccess	The frame has been captured with success and contains valid data. All fields of the FrameMetadata structure are valid.
FrameError	The frame data is partly or fully corrupted, missing or otherwise invalid. This can for instance indicate a hardware transmission error, or invalid data produced by the sensor during its startup phase. The sequence and timestamp fields of the FrameMetadata structure is valid, all the other fields may be invalid.
FrameCancelled	Capture stopped before the frame completed. The frame data is not valid. All fields of the FrameMetadata structure but the status field are invalid.
FrameStartup	The frame has been successfully captured. However, the IPA is in a cold-start or reset phase and will result in image quality parameters producing unusable images. Applications are recommended to not consume these frames. All other fields of the FrameMetadata structure are valid.

Member Function Documentation

◆ planes() [1/2]

libcamera::FrameMetadata::planes ( )

inline

Retrieve the array of per-plane metadata.

Returns: The array of per-plane metadata

◆ planes() [2/2]

libcamera::FrameMetadata::planes ( ) const

inline

Retrieve the array of per-plane metadata.

Returns: The array of per-plane metadata

Member Data Documentation

◆ sequence

libcamera::FrameMetadata::sequence

Frame sequence number.

The sequence number is a monotonically increasing number assigned to the frames captured by the stream. The value is increased by one for each frame. Gaps in the sequence numbers indicate dropped frames.

◆ status

libcamera::FrameMetadata::status

Status of the frame.

The validity of other fields of the FrameMetadata structure depends on the status value.

◆ timestamp

libcamera::FrameMetadata::timestamp

Time when the frame was captured.

The timestamp is expressed as a number of nanoseconds relative to the system clock since an unspecified time point.

Todo:: Be more precise on what timestamps refer to.

The documentation for this struct was generated from the following files:

include/libcamera/framebuffer.h
src/libcamera/framebuffer.cpp

Classes

Public Types

Public Member Functions

Public Attributes