Go to the documentation of this file.
25 #ifndef AVUTIL_FRAME_H
26 #define AVUTIL_FRAME_H
301 #define AV_NUM_DATA_POINTERS 8
430 #if FF_API_ERROR_FRAME
525 #define AV_FRAME_FLAG_CORRUPT (1 << 0)
529 #define AV_FRAME_FLAG_DISCARD (1 << 2)
596 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
597 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
598 #define FF_DECODE_ERROR_CONCEALMENT_ACTIVE 4
599 #define FF_DECODE_ERROR_DECODE_SLICES 8
682 #if FF_API_FRAME_GET_SET
AVBufferRef ** extended_buf
For planar audio which requires more than AV_NUM_DATA_POINTERS AVBufferRef pointers,...
enum AVColorTransferCharacteristic color_trc
attribute_deprecated void av_frame_set_color_range(AVFrame *frame, enum AVColorRange val)
attribute_deprecated void av_frame_set_sample_rate(AVFrame *frame, int val)
enum AVColorRange color_range
MPEG vs JPEG YUV range.
attribute_deprecated int av_frame_get_sample_rate(const AVFrame *frame)
attribute_deprecated int qstride
QP store stride.
AVColorTransferCharacteristic
Color Transfer Characteristic.
@ AV_FRAME_DATA_QP_TABLE_PROPERTIES
Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA.
int av_frame_get_buffer(AVFrame *frame, int align)
Allocate new buffer(s) for audio or video data.
attribute_deprecated int av_frame_get_pkt_size(const AVFrame *frame)
AVFrameSideData * av_frame_get_side_data(const AVFrame *frame, enum AVFrameSideDataType type)
@ AV_FRAME_DATA_A53_CC
ATSC A53 Part 4 Closed Captions.
AVFrameSideData * av_frame_new_side_data(AVFrame *frame, enum AVFrameSideDataType type, int size)
Add a new side data to a frame.
int coded_picture_number
picture number in bitstream order
enum AVColorPrimaries color_primaries
@ AV_FRAME_CROP_UNALIGNED
Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unalig...
@ AV_FRAME_DATA_S12M_TIMECODE
Timecode which conforms to SMPTE ST 12-1.
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
void * opaque
for some private data of the user
enum AVColorSpace colorspace
YUV colorspace type.
This structure describes decoded (raw) audio or video data.
int av_frame_make_writable(AVFrame *frame)
Ensure that the frame data is writable, avoiding data copy if possible.
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
int top_field_first
If the content is interlaced, is top field displayed first.
int64_t pkt_duration
duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown.
@ AV_FRAME_DATA_DISPLAYMATRIX
This side data contains a 3x3 transformation matrix describing an affine transformation that needs to...
attribute_deprecated int av_frame_get_channels(const AVFrame *frame)
int flags
Frame flags, a combination of AV_FRAME_FLAGS.
AVColorPrimaries
Chromaticity coordinates of the source primaries.
AVBufferRef * buf[AV_NUM_DATA_POINTERS]
AVBuffer references backing the data for this frame.
attribute_deprecated int64_t av_frame_get_pkt_pos(const AVFrame *frame)
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.
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
attribute_deprecated int8_t * av_frame_get_qp_table(AVFrame *f, int *stride, int *type)
AVBufferRef * opaque_ref
AVBufferRef for free use by the API user.
enum AVChromaLocation chroma_location
const char * av_get_colorspace_name(enum AVColorSpace val)
Get the name of a colorspace.
attribute_deprecated int8_t * qscale_table
QP table.
@ AV_FRAME_DATA_MATRIXENCODING
The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.
attribute_deprecated int64_t av_frame_get_pkt_duration(const AVFrame *frame)
attribute_deprecated AVBufferRef * qp_table_buf
int key_frame
1 -> keyframe, 0-> not
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Structure describing a single Region Of Interest.
int channels
number of audio channels, only used for audio.
int64_t pkt_pos
reordered pos from the last AVPacket that has been input into the decoder
@ AV_FRAME_DATA_AUDIO_SERVICE_TYPE
This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defi...
attribute_deprecated AVDictionary * av_frame_get_metadata(const AVFrame *frame)
AVFrame * av_frame_clone(const AVFrame *src)
Create a new frame that references the same data as src.
attribute_deprecated void av_frame_set_pkt_pos(AVFrame *frame, int64_t val)
attribute_deprecated void av_frame_set_metadata(AVFrame *frame, AVDictionary *val)
@ AV_FRAME_DATA_SPHERICAL
The data represents the AVSphericalMapping structure defined in libavutil/spherical....
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Rational number (pair of numerator and denominator).
attribute_deprecated enum AVColorRange av_frame_get_color_range(const AVFrame *frame)
uint32_t self_size
Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
AVActiveFormatDescription
@ AV_FRAME_DATA_ICC_PROFILE
The data contains an ICC profile as an opaque octet buffer following the format described by ISO 1507...
@ AV_FRAME_DATA_MASTERING_DISPLAY_METADATA
Mastering display metadata associated with a video frame.
AVFrameSideData * av_frame_new_side_data_from_buf(AVFrame *frame, enum AVFrameSideDataType type, AVBufferRef *buf)
Add a new side data to a frame from an existing AVBufferRef.
int64_t pkt_dts
DTS copied from the AVPacket that triggered returning this frame.
attribute_deprecated int64_t pkt_pts
PTS copied from the AVPacket that was decoded to produce this frame.
@ AV_FRAME_DATA_AFD
Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVAc...
attribute_deprecated int av_frame_get_decode_error_flags(const AVFrame *frame)
attribute_deprecated void av_frame_set_channel_layout(AVFrame *frame, int64_t val)
int64_t best_effort_timestamp
frame timestamp estimated using various heuristics, in stream time base
enum AVPictureType pict_type
Picture type of the frame.
@ AV_FRAME_DATA_REPLAYGAIN
ReplayGain information in the form of the AVReplayGain struct.
@ AV_FRAME_DATA_PANSCAN
The data is the AVPanScan struct defined in libavcodec.
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
int quality
quality (between 1 (good) and FF_LAMBDA_MAX (bad))
int sample_rate
Sample rate of the audio data.
attribute_deprecated uint64_t error[AV_NUM_DATA_POINTERS]
#define AV_NUM_DATA_POINTERS
int av_frame_is_writable(AVFrame *frame)
Check if the frame data is writable.
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
#define attribute_deprecated
void av_frame_remove_side_data(AVFrame *frame, enum AVFrameSideDataType type)
Remove and free all side data instances of the given type.
uint64_t channel_layout
Channel layout of the audio data.
attribute_deprecated enum AVColorSpace av_frame_get_colorspace(const AVFrame *frame)
AVBufferRef * private_ref
AVBufferRef for internal use by a single libav* library.
@ AV_FRAME_DATA_SKIP_SAMPLES
Recommmends skipping the specified number of samples.
AVChromaLocation
Location of chroma samples.
int interlaced_frame
The content of the picture is interlaced.
int nb_samples
number of audio samples (per channel) described by this frame
@ AV_FRAME_DATA_CONTENT_LIGHT_LEVEL
Content light level (based on CTA-861.3).
int top
Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge ...
uint8_t ** extended_data
pointers to the data planes/channels.
AVColorSpace
YUV colorspace type.
attribute_deprecated void av_frame_set_pkt_size(AVFrame *frame, int val)
attribute_deprecated void av_frame_set_decode_error_flags(AVFrame *frame, int val)
@ AV_FRAME_DATA_STEREO3D
Stereoscopic 3d metadata.
void av_frame_move_ref(AVFrame *dst, AVFrame *src)
Move everything contained in src to dst and reset src.
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
AVFrameSideData ** side_data
int decode_error_flags
decode error flags of the frame, set to a combination of FF_DECODE_ERROR_xxx flags if the decoder pro...
@ AV_FRAME_DATA_GOP_TIMECODE
The GOP timecode in 25 bit timecode format.
AVRational sample_aspect_ratio
Sample aspect ratio for the video frame, 0/1 if unknown/unspecified.
AVBufferRef * hw_frames_ctx
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame.
@ AV_FRAME_DATA_DYNAMIC_HDR_PLUS
HDR dynamic metadata associated with a video frame.
attribute_deprecated int qscale_type
attribute_deprecated void av_frame_set_channels(AVFrame *frame, int val)
int palette_has_changed
Tell user application that palette has changed from previous frame.
@ AV_FRAME_DATA_VIDEO_ENC_PARAMS
Encoding parameters for a video frame, as described by AVVideoEncParams.
AVDictionary * metadata
metadata.
attribute_deprecated int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame)
Accessors for some AVFrame fields.
struct AVDictionary AVDictionary
attribute_deprecated void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val)
enum AVFrameSideDataType type
int pkt_size
size of the corresponding packet containing the compressed frame.
int64_t reordered_opaque
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything).
attribute_deprecated void av_frame_set_colorspace(AVFrame *frame, enum AVColorSpace val)
A reference to a data buffer.
Structure to hold side data for an AVFrame.
@ AV_FRAME_DATA_QP_TABLE_DATA
Raw QP table data.
const char * av_frame_side_data_name(enum AVFrameSideDataType type)
@ AV_FRAME_DATA_REGIONS_OF_INTEREST
Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is ...
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
@ AV_FRAME_DATA_MOTION_VECTORS
Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec A...
AVBufferRef * av_frame_get_plane_buffer(AVFrame *frame, int plane)
Get the buffer reference a given data plane is stored in.
AVColorRange
MPEG vs JPEG YUV range.
int display_picture_number
picture number in display order
AVRational qoffset
Quantisation offset.
@ AV_FRAME_DATA_DOWNMIX_INFO
Metadata relevant to a downmix procedure.
attribute_deprecated int64_t av_frame_get_channel_layout(const AVFrame *frame)
attribute_deprecated int av_frame_set_qp_table(AVFrame *f, AVBufferRef *buf, int stride, int type)
int repeat_pict
When decoding, this signals how much the picture must be delayed.
int nb_extended_buf
Number of elements in extended_buf.
attribute_deprecated void av_frame_set_pkt_duration(AVFrame *frame, int64_t val)