FFmpeg
3.2.10
|
AVFrame is an abstraction for reference-counted raw multimedia data. More...
Modules | |
AV_FRAME_FLAGS | |
Flags describing additional frame properties. | |
Files | |
file | frame.h |
reference-counted frame API | |
Data Structures | |
struct | AVFrameSideData |
Structure to hold side data for an AVFrame. More... | |
struct | AVFrame |
This structure describes decoded (raw) audio or video data. More... | |
AVFrame is an abstraction for reference-counted raw multimedia data.
enum AVFrameSideDataType |
Enumerator | |
---|---|
AV_FRAME_DATA_PANSCAN | The data is the AVPanScan struct defined in libavcodec. |
AV_FRAME_DATA_A53_CC | ATSC A53 Part 4 Closed Captions. A53 CC bitstream is stored as uint8_t in AVFrameSideData.data. The number of bytes of CC data is AVFrameSideData.size. |
AV_FRAME_DATA_STEREO3D | Stereoscopic 3d metadata. The data is the AVStereo3D struct defined in libavutil/stereo3d.h. |
AV_FRAME_DATA_MATRIXENCODING | The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h. |
AV_FRAME_DATA_DOWNMIX_INFO | Metadata relevant to a downmix procedure. The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h. |
AV_FRAME_DATA_REPLAYGAIN | ReplayGain information in the form of the AVReplayGain struct. |
AV_FRAME_DATA_DISPLAYMATRIX | This side data contains a 3x3 transformation matrix describing an affine transformation that needs to be applied to the frame for correct presentation. See libavutil/display.h for a detailed description of the data. |
AV_FRAME_DATA_AFD | Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVActiveFormatDescription enum. |
AV_FRAME_DATA_MOTION_VECTORS | Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec AVCodecContext flags2 option). The data is the AVMotionVector struct defined in libavutil/motion_vector.h. |
AV_FRAME_DATA_SKIP_SAMPLES | Recommmends skipping the specified number of samples. This is exported only if the "skip_manual" AVOption is set in libavcodec. This has the same format as AV_PKT_DATA_SKIP_SAMPLES. u32le number of samples to skip from start of this packet u32le number of samples to skip from end of this packet u8 reason for start skip u8 reason for end skip (0=padding silence, 1=convergence) |
AV_FRAME_DATA_AUDIO_SERVICE_TYPE | This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defined in avcodec.h. |
AV_FRAME_DATA_MASTERING_DISPLAY_METADATA | Mastering display metadata associated with a video frame. The payload is an AVMasteringDisplayMetadata type and contains information about the mastering display color volume. |
AV_FRAME_DATA_GOP_TIMECODE | The GOP timecode in 25 bit timecode format. Data format is 64-bit integer. This is set on the first frame of a GOP that has a temporal reference of 0. |
int64_t av_frame_get_best_effort_timestamp | ( | const AVFrame * | frame | ) |
Accessors for some AVFrame fields.
The position of these field in the structure is not part of the ABI, they should not be accessed directly outside libavutil.
Referenced by main().
void av_frame_set_best_effort_timestamp | ( | AVFrame * | frame, |
int64_t | val | ||
) |
int64_t av_frame_get_pkt_duration | ( | const AVFrame * | frame | ) |
void av_frame_set_pkt_duration | ( | AVFrame * | frame, |
int64_t | val | ||
) |
int64_t av_frame_get_pkt_pos | ( | const AVFrame * | frame | ) |
void av_frame_set_pkt_pos | ( | AVFrame * | frame, |
int64_t | val | ||
) |
int64_t av_frame_get_channel_layout | ( | const AVFrame * | frame | ) |
Referenced by print_frame().
void av_frame_set_channel_layout | ( | AVFrame * | frame, |
int64_t | val | ||
) |
int av_frame_get_channels | ( | const AVFrame * | frame | ) |
void av_frame_set_channels | ( | AVFrame * | frame, |
int | val | ||
) |
int av_frame_get_sample_rate | ( | const AVFrame * | frame | ) |
void av_frame_set_sample_rate | ( | AVFrame * | frame, |
int | val | ||
) |
AVDictionary* av_frame_get_metadata | ( | const AVFrame * | frame | ) |
void av_frame_set_metadata | ( | AVFrame * | frame, |
AVDictionary * | val | ||
) |
int av_frame_get_decode_error_flags | ( | const AVFrame * | frame | ) |
void av_frame_set_decode_error_flags | ( | AVFrame * | frame, |
int | val | ||
) |
int av_frame_get_pkt_size | ( | const AVFrame * | frame | ) |
void av_frame_set_pkt_size | ( | AVFrame * | frame, |
int | val | ||
) |
AVDictionary** avpriv_frame_get_metadatap | ( | AVFrame * | frame | ) |
int8_t* av_frame_get_qp_table | ( | AVFrame * | f, |
int * | stride, | ||
int * | type | ||
) |
int av_frame_set_qp_table | ( | AVFrame * | f, |
AVBufferRef * | buf, | ||
int | stride, | ||
int | type | ||
) |
enum AVColorSpace av_frame_get_colorspace | ( | const AVFrame * | frame | ) |
void av_frame_set_colorspace | ( | AVFrame * | frame, |
enum AVColorSpace | val | ||
) |
enum AVColorRange av_frame_get_color_range | ( | const AVFrame * | frame | ) |
void av_frame_set_color_range | ( | AVFrame * | frame, |
enum AVColorRange | val | ||
) |
const char* av_get_colorspace_name | ( | enum AVColorSpace | val | ) |
Get the name of a colorspace.
AVFrame* av_frame_alloc | ( | void | ) |
Allocate an AVFrame and set its fields to default values.
The resulting struct must be freed using av_frame_free().
Referenced by alloc_audio_frame(), alloc_picture(), audio_decode_example(), audio_encode_example(), filter_encode_write_frame(), init_input_frame(), init_output_frame(), main(), video_decode_example(), and video_encode_example().
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.
frame | frame to be freed. The pointer will be set to NULL. |
Referenced by audio_decode_example(), audio_encode_example(), close_stream(), encode_write_frame(), filter_encode_write_frame(), init_output_frame(), load_encode_and_write(), main(), read_decode_convert_and_store(), video_decode_example(), and video_encode_example().
Set up a new reference to the data described by the source frame.
Copy frame properties from src to dst and create a new reference for each AVBufferRef from src.
If src is not reference counted, new buffers are allocated and the data is copied.
Create a new frame that references the same data as src.
This is a shortcut for av_frame_alloc()+av_frame_ref().
void av_frame_unref | ( | AVFrame * | frame | ) |
Unreference all the buffers referenced by frame and reset the frame fields.
Referenced by decode_packet(), and main().
Move everything contained in src to dst and reset src.
int av_frame_get_buffer | ( | AVFrame * | frame, |
int | align | ||
) |
Allocate new buffer(s) for audio or video data.
The following fields must be set on frame before calling this function:
This function will fill AVFrame.data and AVFrame.buf arrays and, if necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. For planar formats, one buffer will be allocated for each plane.
frame | frame in which to store the new buffers. |
align | required buffer size alignment |
Referenced by alloc_audio_frame(), alloc_picture(), get_input(), and init_output_frame().
int av_frame_is_writable | ( | AVFrame * | frame | ) |
Check if the frame data is writable.
If 1 is returned the answer is valid until av_buffer_ref() is called on any of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).
int av_frame_make_writable | ( | AVFrame * | frame | ) |
Ensure that the frame data is writable, avoiding data copy if possible.
Do nothing if the frame is writable, allocate new buffers and copy the data if it is not.
Referenced by fill_yuv_image(), and write_audio_frame().
Copy the frame data from src to dst.
This function does not allocate anything, dst must be already initialized and allocated with the same parameters as src.
This function only copies the frame data (i.e. the contents of the data / extended data arrays), not any other properties.
Copy only "metadata" fields from src to dst.
Metadata for the purpose of this function are those fields that do not affect the data layout in the buffers. E.g. pts, sample rate (for audio) or sample aspect ratio (for video), but not width/height or channel layout. Side data is also copied.
AVBufferRef* av_frame_get_plane_buffer | ( | AVFrame * | frame, |
int | plane | ||
) |
Get the buffer reference a given data plane is stored in.
plane | index of the data plane of interest in frame->extended_data. |
AVFrameSideData* av_frame_new_side_data | ( | AVFrame * | frame, |
enum AVFrameSideDataType | type, | ||
int | size | ||
) |
Add a new side data to a frame.
frame | a frame to which the side data should be added |
type | type of the added side data |
size | size of the side data |
AVFrameSideData* av_frame_get_side_data | ( | const AVFrame * | frame, |
enum AVFrameSideDataType | type | ||
) |
Referenced by decode_packet().
void av_frame_remove_side_data | ( | AVFrame * | frame, |
enum AVFrameSideDataType | type | ||
) |
If side data of the supplied type exists in the frame, free it and remove it from the frame.
const char* av_frame_side_data_name | ( | enum AVFrameSideDataType | type | ) |