ffmpeg.libavutil.frame

@file @ingroup lavu_frame reference-counted frame API

Members

Enums

AVActiveFormatDescription
enum AVActiveFormatDescription
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AVFrameSideDataType
enum AVFrameSideDataType

@defgroup lavu_frame AVFrame @ingroup lavu_data

AV_FRAME_CROP_UNALIGNED
anonymousenum AV_FRAME_CROP_UNALIGNED

Flags for frame cropping.

Functions

av_frame_alloc
AVFrame* av_frame_alloc()

Allocate an AVFrame and set its fields to default values. The resulting struct must be freed using av_frame_free().

av_frame_apply_cropping
int av_frame_apply_cropping(AVFrame* frame, int flags)

Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields. If cropping is successful, the function will adjust the data pointers and the width/height fields, and set the crop fields to 0.

av_frame_clone
AVFrame* av_frame_clone(const(AVFrame)* src)

Create a new frame that references the same data as src.

av_frame_copy
int av_frame_copy(AVFrame* dst, const(AVFrame)* src)

Copy the frame data from src to dst.

av_frame_copy_props
int av_frame_copy_props(AVFrame* dst, const(AVFrame)* src)

Copy only "metadata" fields from src to dst.

av_frame_free
void av_frame_free(AVFrame** frame)

Free the frame and any dynamically allocated objects in it, e.g. extended_data. If the frame is reference counted, it will be unreferenced first.

av_frame_get_best_effort_timestamp
long av_frame_get_best_effort_timestamp(const(AVFrame)* frame)

Accessors for some AVFrame fields. These used to be provided for ABI compatibility, and do not need to be used anymore.

av_frame_get_buffer
int av_frame_get_buffer(AVFrame* frame, int align_)

Allocate new buffer(s) for audio or video data.

av_frame_get_channel_layout
long av_frame_get_channel_layout(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_channels
int av_frame_get_channels(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_color_range
AVColorRange av_frame_get_color_range(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_colorspace
AVColorSpace av_frame_get_colorspace(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_decode_error_flags
int av_frame_get_decode_error_flags(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_metadata
AVDictionary* av_frame_get_metadata(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_pkt_duration
long av_frame_get_pkt_duration(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_pkt_pos
long av_frame_get_pkt_pos(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_pkt_size
int av_frame_get_pkt_size(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_plane_buffer
AVBufferRef* av_frame_get_plane_buffer(AVFrame* frame, int plane)

Get the buffer reference a given data plane is stored in.

av_frame_get_qp_table
byte* av_frame_get_qp_table(AVFrame* f, int* stride, int* type)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_sample_rate
int av_frame_get_sample_rate(const(AVFrame)* frame)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_get_side_data
AVFrameSideData* av_frame_get_side_data(const(AVFrame)* frame, AVFrameSideDataType type)

@return a pointer to the side data of a given type on success, NULL if there is no side data with such type in this frame.

av_frame_is_writable
int av_frame_is_writable(AVFrame* frame)

Check if the frame data is writable.

av_frame_make_writable
int av_frame_make_writable(AVFrame* frame)

Ensure that the frame data is writable, avoiding data copy if possible.

av_frame_move_ref
void av_frame_move_ref(AVFrame* dst, AVFrame* src)

Move everything contained in src to dst and reset src.

av_frame_new_side_data
AVFrameSideData* av_frame_new_side_data(AVFrame* frame, AVFrameSideDataType type, int size)

Add a new side data to a frame.

av_frame_new_side_data_from_buf
AVFrameSideData* av_frame_new_side_data_from_buf(AVFrame* frame, AVFrameSideDataType type, AVBufferRef* buf)

Add a new side data to a frame from an existing AVBufferRef

av_frame_ref
int av_frame_ref(AVFrame* dst, const(AVFrame)* src)

Set up a new reference to the data described by the source frame.

av_frame_remove_side_data
void av_frame_remove_side_data(AVFrame* frame, AVFrameSideDataType type)

If side data of the supplied type exists in the frame, free it and remove it from the frame.

av_frame_set_best_effort_timestamp
void av_frame_set_best_effort_timestamp(AVFrame* frame, long val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_channel_layout
void av_frame_set_channel_layout(AVFrame* frame, long val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_channels
void av_frame_set_channels(AVFrame* frame, int val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_color_range
void av_frame_set_color_range(AVFrame* frame, AVColorRange val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_colorspace
void av_frame_set_colorspace(AVFrame* frame, AVColorSpace val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_decode_error_flags
void av_frame_set_decode_error_flags(AVFrame* frame, int val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_metadata
void av_frame_set_metadata(AVFrame* frame, AVDictionary* val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_pkt_duration
void av_frame_set_pkt_duration(AVFrame* frame, long val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_pkt_pos
void av_frame_set_pkt_pos(AVFrame* frame, long val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_pkt_size
void av_frame_set_pkt_size(AVFrame* frame, int val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_qp_table
int av_frame_set_qp_table(AVFrame* f, AVBufferRef* buf, int stride, int type)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_set_sample_rate
void av_frame_set_sample_rate(AVFrame* frame, int val)
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
av_frame_side_data_name
const(char)* av_frame_side_data_name(AVFrameSideDataType type)

@return a string identifying the side data type

av_frame_unref
void av_frame_unref(AVFrame* frame)

Unreference all the buffers referenced by frame and reset the frame fields.

av_get_colorspace_name
const(char)* av_get_colorspace_name(AVColorSpace val)

Get the name of a colorspace. @return a static string identifying the colorspace; can be NULL.

Manifest constants

AV_FRAME_FLAG_CORRUPT
enum AV_FRAME_FLAG_CORRUPT;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AV_FRAME_FLAG_DISCARD
enum AV_FRAME_FLAG_DISCARD;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
AV_NUM_DATA_POINTERS
enum AV_NUM_DATA_POINTERS;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FF_DECODE_ERROR_INVALID_BITSTREAM
enum FF_DECODE_ERROR_INVALID_BITSTREAM;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
FF_DECODE_ERROR_MISSING_REFERENCE
enum FF_DECODE_ERROR_MISSING_REFERENCE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

AVFrame
struct AVFrame

This structure describes decoded (raw) audio or video data.

AVFrameSideData
struct AVFrameSideData

Structure to hold side data for an AVFrame.

Meta