My Project
MMAL_BUFFER_HEADER_T Struct Reference

#include <mmal_buffer.h>

Public Attributes

struct MMAL_BUFFER_HEADER_Tnext
 
struct MMAL_BUFFER_HEADER_PRIVATE_Tpriv
 
uint32_t cmd
 
uint8_t * data
 
uint32_t alloc_size
 
uint32_t length
 
uint32_t offset
 
uint32_t flags
 
int64_t pts
 
int64_t dts
 
MMAL_BUFFER_HEADER_TYPE_SPECIFIC_Ttype
 
void * user_data
 

Detailed Description

Definition of the buffer header structure. A buffer header does not directly carry the data to be passed to a component but instead it references the actual data using a pointer (and an associated length). It also contains an internal area which can be used to store command to be associated with the external data.

Definition at line 69 of file mmal_buffer.h.

Member Data Documentation

◆ alloc_size

uint32_t MMAL_BUFFER_HEADER_T::alloc_size

Allocated size in bytes of payload buffer

Definition at line 80 of file mmal_buffer.h.

◆ cmd

uint32_t MMAL_BUFFER_HEADER_T::cmd

Defines what the buffer header contains. This is a FourCC with 0 as a special value meaning stream data

Definition at line 75 of file mmal_buffer.h.

◆ data

uint8_t* MMAL_BUFFER_HEADER_T::data

Pointer to the start of the payload buffer (should not be changed by component)

Definition at line 78 of file mmal_buffer.h.

◆ dts

int64_t MMAL_BUFFER_HEADER_T::dts

Decode timestamp in microseconds (dts = pts, except in the case of video streams with B frames). MMAL_TIME_UNKNOWN is used when the dts is unknown.

Definition at line 90 of file mmal_buffer.h.

◆ flags

uint32_t MMAL_BUFFER_HEADER_T::flags

Flags describing properties of a buffer header (see Buffer header flags)

Definition at line 85 of file mmal_buffer.h.

◆ length

uint32_t MMAL_BUFFER_HEADER_T::length

Number of bytes currently used in the payload buffer (starting from offset)

Definition at line 81 of file mmal_buffer.h.

◆ next

struct MMAL_BUFFER_HEADER_T* MMAL_BUFFER_HEADER_T::next

Used to link several buffer headers together

Definition at line 71 of file mmal_buffer.h.

◆ offset

uint32_t MMAL_BUFFER_HEADER_T::offset

Offset in bytes to the start of valid data in the payload buffer

Definition at line 83 of file mmal_buffer.h.

◆ priv

struct MMAL_BUFFER_HEADER_PRIVATE_T* MMAL_BUFFER_HEADER_T::priv

Data private to the framework

Definition at line 73 of file mmal_buffer.h.

◆ pts

int64_t MMAL_BUFFER_HEADER_T::pts

Presentation timestamp in microseconds. MMAL_TIME_UNKNOWN is used when the pts is unknown.

Definition at line 88 of file mmal_buffer.h.

◆ type

MMAL_BUFFER_HEADER_TYPE_SPECIFIC_T* MMAL_BUFFER_HEADER_T::type

Type specific data that's associated with a payload buffer

Definition at line 95 of file mmal_buffer.h.

◆ user_data

void* MMAL_BUFFER_HEADER_T::user_data

Field reserved for use by the client

Definition at line 97 of file mmal_buffer.h.


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