Граф связей класса AVFrame:Группы | |
| AV_FRAME_FLAGS | |
Файлы | |
| файл | frame.h |
Классы | |
| struct | AVFrameSideData |
| struct | AVRegionOfInterest |
| struct | AVFrame |
Определения типов | |
| typedef struct AVFrameSideData | AVFrameSideData |
| typedef struct AVRegionOfInterest | AVRegionOfInterest |
| typedef struct AVFrame | AVFrame |
Подробное описание
AVFrame is an abstraction for reference-counted raw multimedia data.
Типы
◆ AVFrameSideData
| typedef struct AVFrameSideData AVFrameSideData |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Structure to hold side data for an AVFrame.
sizeof(AVFrameSideData) is not a part of the public ABI, so new fields may be added to the end with a minor bump.
◆ AVRegionOfInterest
| typedef struct AVRegionOfInterest AVRegionOfInterest |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Structure describing a single Region Of Interest.
When multiple regions are defined in a single side-data block, they should be ordered from most to least important - some encoders are only capable of supporting a limited number of distinct regions, so will have to truncate the list.
When overlapping regions are defined, the first region containing a given area of the frame applies.
◆ AVFrame
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
This structure describes decoded (raw) audio or video data.
AVFrame must be allocated using av_frame_alloc(). Note that this only allocates the AVFrame itself, the buffers for the data must be managed through other means (see below). AVFrame must be freed with av_frame_free().
AVFrame is typically allocated once and then reused multiple times to hold different data (e.g. a single AVFrame to hold frames received from a decoder). In such a case, av_frame_unref() will free any references held by the frame and reset it to its original clean state before it is reused again.
The data described by an AVFrame is usually reference counted through the AVBuffer API. The underlying buffer references are stored in AVFrame.buf / AVFrame.extended_buf. An AVFrame is considered to be reference counted if at least one reference is set, i.e. if AVFrame.buf[0] != NULL. In such a case, every single data plane must be contained in one of the buffers in AVFrame.buf or AVFrame.extended_buf. There may be a single buffer for all the data, or one separate buffer for each plane, or anything in between.
sizeof(AVFrame) is not a part of the public ABI, so new fields may be added to the end with a minor bump.
Fields can be accessed through AVOptions, the name string used, matches the C structure field name for fields accessible through AVOptions. The AVClass for AVFrame can be obtained from avcodec_get_frame_class()
Перечисления
◆ AVFrameSideDataType
| enum AVFrameSideDataType |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
| Элементы перечислений | |
|---|---|
| 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. |
| AV_FRAME_DATA_SPHERICAL | The data represents the AVSphericalMapping structure defined in libavutil/spherical.h. |
| AV_FRAME_DATA_CONTENT_LIGHT_LEVEL | Content light level (based on CTA-861.3). This payload contains data in the form of the AVContentLightMetadata struct. |
| AV_FRAME_DATA_ICC_PROFILE | The data contains an ICC profile as an opaque octet buffer following the format described by ISO 15076-1 with an optional name defined in the metadata key entry "name". |
| AV_FRAME_DATA_QP_TABLE_PROPERTIES | Implementation-specific description of the format of AV_FRAME_QP_TABLE_DATA. The contents of this side data are undocumented and internal; use av_frame_set_qp_table() and av_frame_get_qp_table() to access this in a meaningful way instead. |
| AV_FRAME_DATA_QP_TABLE_DATA | Raw QP table data. Its format is described by AV_FRAME_DATA_QP_TABLE_PROPERTIES. Use av_frame_set_qp_table() and av_frame_get_qp_table() to access this instead. |
| AV_FRAME_DATA_S12M_TIMECODE | Timecode which conforms to SMPTE ST 12-1. The data is an array of 4 uint32_t where the first uint32_t describes how many (1-3) of the other timecodes are used. The timecode format is described in the av_timecode_get_smpte_from_framenum() function in libavutil/timecode.c. |
| AV_FRAME_DATA_DYNAMIC_HDR_PLUS | HDR dynamic metadata associated with a video frame. The payload is an AVDynamicHDRPlus type and contains information for color volume transform - application 4 of SMPTE 2094-40:2016 standard. |
| AV_FRAME_DATA_REGIONS_OF_INTEREST | Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size. |
См. определение в файле frame.h строка 48
◆ AVActiveFormatDescription
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
| Элементы перечислений | |
|---|---|
| AV_AFD_SAME | |
| AV_AFD_4_3 | |
| AV_AFD_16_9 | |
| AV_AFD_14_9 | |
| AV_AFD_4_3_SP_14_9 | |
| AV_AFD_16_9_SP_14_9 | |
| AV_AFD_SP_4_3 | |
См. определение в файле frame.h строка 184
◆ anonymous enum
| anonymous enum |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Flags for frame cropping.
| Элементы перечислений | |
|---|---|
| AV_FRAME_CROP_UNALIGNED | Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unaligned pointers. Passing unaligned data to FFmpeg API is generally not allowed, and causes undefined behavior (such as crashes). You can pass unaligned data only to FFmpeg APIs that are explicitly documented to accept it. Use this flag only if you absolutely know what you are doing. |
Функции
◆ av_frame_get_best_effort_timestamp()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Accessors for some AVFrame fields. These used to be provided for ABI compatibility, and do not need to be used anymore.
◆ av_frame_set_best_effort_timestamp()
◆ av_frame_get_pkt_duration()
◆ av_frame_set_pkt_duration()
◆ av_frame_get_pkt_pos()
◆ av_frame_set_pkt_pos()
◆ av_frame_get_channel_layout()
◆ av_frame_set_channel_layout()
◆ av_frame_get_channels()
| attribute_deprecated int av_frame_get_channels | ( | const AVFrame * | frame | ) |
◆ av_frame_set_channels()
◆ av_frame_get_sample_rate()
| attribute_deprecated int av_frame_get_sample_rate | ( | const AVFrame * | frame | ) |
◆ av_frame_set_sample_rate()
◆ av_frame_get_metadata()
| attribute_deprecated AVDictionary* av_frame_get_metadata | ( | const AVFrame * | frame | ) |
◆ av_frame_set_metadata()
| attribute_deprecated void av_frame_set_metadata | ( | AVFrame * | frame, |
| AVDictionary * | val | ||
| ) |
◆ av_frame_get_decode_error_flags()
| attribute_deprecated int av_frame_get_decode_error_flags | ( | const AVFrame * | frame | ) |
◆ av_frame_set_decode_error_flags()
◆ av_frame_get_pkt_size()
| attribute_deprecated int av_frame_get_pkt_size | ( | const AVFrame * | frame | ) |
◆ av_frame_set_pkt_size()
◆ av_frame_get_qp_table()
◆ av_frame_set_qp_table()
| attribute_deprecated int av_frame_set_qp_table | ( | AVFrame * | f, |
| AVBufferRef * | buf, | ||
| int | stride, | ||
| int | type | ||
| ) |
◆ av_frame_get_colorspace()
| attribute_deprecated enum AVColorSpace av_frame_get_colorspace | ( | const AVFrame * | frame | ) |
◆ av_frame_set_colorspace()
| attribute_deprecated void av_frame_set_colorspace | ( | AVFrame * | frame, |
| enum AVColorSpace | val | ||
| ) |
◆ av_frame_get_color_range()
| attribute_deprecated enum AVColorRange av_frame_get_color_range | ( | const AVFrame * | frame | ) |
◆ av_frame_set_color_range()
| attribute_deprecated void av_frame_set_color_range | ( | AVFrame * | frame, |
| enum AVColorRange | val | ||
| ) |
◆ av_get_colorspace_name()
| const char* av_get_colorspace_name | ( | enum AVColorSpace | val | ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Get the name of a colorspace.
- Возвращает
- a static string identifying the colorspace; can be NULL.
◆ av_frame_alloc()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Allocate an AVFrame and set its fields to default values. The resulting struct must be freed using av_frame_free().
- Возвращает
- An AVFrame filled with default values or NULL on failure.
- Заметки
- this only allocates the AVFrame itself, not the data buffers. Those must be allocated through other means, e.g. with av_frame_get_buffer() or manually.
Используется в AVAudioStream::decode_frame(), AVVideoStream::decode_frame() и AudioBaseDataSource::GetNextBuffer().
Граф вызова функции:◆ av_frame_free()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
Используется в AVAudioStream::decode_frame(), AVVideoStream::decode_frame() и AudioBaseDataSource::GetNextBuffer().
Граф вызова функции:◆ av_frame_ref()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
- Предупреждения
- : dst MUST have been either unreferenced with av_frame_unref(dst), or newly allocated with av_frame_alloc() before calling this function, or undefined behavior will occur.
- Возвращает
- 0 on success, a negative AVERROR on error
◆ av_frame_clone()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Create a new frame that references the same data as src.
This is a shortcut for av_frame_alloc()+av_frame_ref().
- Возвращает
- newly created AVFrame on success, NULL on error.
◆ av_frame_unref()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Unreference all the buffers referenced by frame and reset the frame fields.
◆ av_frame_move_ref()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Move everything contained in src to dst and reset src.
- Предупреждения
- : dst is not unreferenced, but directly overwritten without reading or deallocating its contents. Call av_frame_unref(dst) manually before calling this function to ensure that no memory is leaked.
◆ av_frame_get_buffer()
| int av_frame_get_buffer | ( | AVFrame * | frame, |
| int | align | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Allocate new buffer(s) for audio or video data.
The following fields must be set on frame before calling this function:
- format (pixel format for video, sample format for audio)
- width and height for video
- nb_samples and channel_layout for audio
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.
- Предупреждения
- : if frame already has been allocated, calling this function will leak memory. In addition, undefined behavior can occur in certain cases.
- Аргументы
-
frame frame in which to store the new buffers. align Required buffer size alignment. If equal to 0, alignment will be chosen automatically for the current CPU. It is highly recommended to pass 0 here unless you know what you are doing.
- Возвращает
- 0 on success, a negative AVERROR on error.
◆ av_frame_is_writable()
| int av_frame_is_writable | ( | AVFrame * | frame | ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Check if the frame data is writable.
- Возвращает
- A positive value if the frame data is writable (which is true if and only if each of the underlying buffers has only one reference, namely the one stored in this frame). Return 0 otherwise.
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).
◆ av_frame_make_writable()
| int av_frame_make_writable | ( | AVFrame * | frame | ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
- Возвращает
- 0 on success, a negative AVERROR on error.
◆ av_frame_copy()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
- Возвращает
- >= 0 on success, a negative AVERROR on error.
◆ av_frame_copy_props()
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
◆ av_frame_get_plane_buffer()
| AVBufferRef* av_frame_get_plane_buffer | ( | AVFrame * | frame, |
| int | plane | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Get the buffer reference a given data plane is stored in.
- Аргументы
-
plane index of the data plane of interest in frame->extended_data.
- Возвращает
- the buffer reference that contains the plane or NULL if the input frame is not valid.
◆ av_frame_new_side_data()
| AVFrameSideData* av_frame_new_side_data | ( | AVFrame * | frame, |
| enum AVFrameSideDataType | type, | ||
| int | size | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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
- Возвращает
- newly added side data on success, NULL on error
◆ av_frame_new_side_data_from_buf()
| AVFrameSideData* av_frame_new_side_data_from_buf | ( | AVFrame * | frame, |
| enum AVFrameSideDataType | type, | ||
| AVBufferRef * | buf | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
Add a new side data to a frame from an existing AVBufferRef
- Аргументы
-
frame a frame to which the side data should be added type the type of the added side data buf an AVBufferRef to add as side data. The ownership of the reference is transferred to the frame.
- Возвращает
- newly added side data on success, NULL on error. On failure the frame is unchanged and the AVBufferRef remains owned by the caller.
◆ av_frame_get_side_data()
| AVFrameSideData* av_frame_get_side_data | ( | const AVFrame * | frame, |
| enum AVFrameSideDataType | type | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
- Возвращает
- 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_remove_side_data()
| void av_frame_remove_side_data | ( | AVFrame * | frame, |
| enum AVFrameSideDataType | type | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
If side data of the supplied type exists in the frame, free it and remove it from the frame.
◆ av_frame_apply_cropping()
| int av_frame_apply_cropping | ( | AVFrame * | frame, |
| int | flags | ||
| ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
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.
In all cases, the cropping boundaries will be rounded to the inherent alignment of the pixel format. In some cases, such as for opaque hwaccel formats, the left/top cropping is ignored. The crop fields are set to 0 even if the cropping was rounded or ignored.
- Аргументы
-
frame the frame which should be cropped flags Some combination of AV_FRAME_CROP_* flags, or 0.
- Возвращает
- >= 0 on success, a negative AVERROR on error. If the cropping fields were invalid, AVERROR(ERANGE) is returned, and nothing is changed.
◆ av_frame_side_data_name()
| const char* av_frame_side_data_name | ( | enum AVFrameSideDataType | type | ) |
#include <C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h>
- Возвращает
- a string identifying the side data type
