#include <frame.h>
Граф связей класса AVFrame:Подробное описание
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()
Данные класса
◆ data
| uint8_t* AVFrame::data[AV_NUM_DATA_POINTERS] |
pointer to the picture/channel planes. This might be different from the first allocated byte
Some decoders access areas outside 0,0 - width,height, please see avcodec_align_dimensions2(). Some filters and swscale can read up to 16 bytes beyond the planes, if these filters are to be used, then 16 extra bytes must be allocated.
NOTE: Except for hwaccel formats, pointers not needed by the format MUST be set to NULL.
См. определение в файле frame.h строка 309
Используется в AVAudioStream::decode_frame(), AVVideoStream::decode_frame() и AudioBaseDataSource::GetNextBuffer().
◆ linesize
| int AVFrame::linesize[AV_NUM_DATA_POINTERS] |
For video, size in bytes of each picture line. For audio, size in bytes of each plane.
For audio, only linesize[0] may be set. For planar audio, each channel plane must be the same size.
For video the linesizes should be multiples of the CPUs alignment preference, this is 16 or 32 for modern desktop CPUs. Some code requires such alignment other code can be slower without correct alignment, for yet other it makes no difference.
- Заметки
- The linesize may be larger than the size of usable data – there may be extra padding present for performance reasons.
См. определение в файле frame.h строка 326
Используется в AVVideoStream::decode_frame().
◆ extended_data
| uint8_t** AVFrame::extended_data |
pointers to the data planes/channels.
For video, this should simply point to data[].
For planar audio, each channel has a separate data pointer, and linesize[0] contains the size of each channel buffer. For packed audio, there is just one data pointer, and linesize[0] contains the total size of the buffer for all channels.
Note: Both data and extended_data should always be set in a valid frame, but for planar audio with more channels that can fit in data, extended_data must be used in order to access all channels.
◆ width
◆ height
| int AVFrame::height |
См. определение в файле frame.h строка 353
Используется в AVVideoStream::decode_frame().
◆ nb_samples
| int AVFrame::nb_samples |
number of audio samples (per channel) described by this frame
См. определение в файле frame.h строка 361
Используется в AVAudioStream::decode_frame() и AudioBaseDataSource::GetNextBuffer().
◆ format
| int AVFrame::format |
◆ key_frame
◆ pict_type
| enum AVPictureType AVFrame::pict_type |
◆ sample_aspect_ratio
| AVRational AVFrame::sample_aspect_ratio |
◆ pts
| int64_t AVFrame::pts |
◆ pkt_pts
| attribute_deprecated int64_t AVFrame::pkt_pts |
◆ pkt_dts
| int64_t AVFrame::pkt_dts |
DTS copied from the AVPacket that triggered returning this frame. (if frame threading isn't used) This is also the Presentation time of this AVFrame calculated from only AVPacket.dts values without pts values.
◆ coded_picture_number
| int AVFrame::coded_picture_number |
◆ display_picture_number
| int AVFrame::display_picture_number |
◆ quality
| int AVFrame::quality |
◆ opaque
◆ error
| attribute_deprecated uint64_t AVFrame::error[AV_NUM_DATA_POINTERS] |
◆ repeat_pict
| int AVFrame::repeat_pict |
◆ interlaced_frame
| int AVFrame::interlaced_frame |
◆ top_field_first
| int AVFrame::top_field_first |
◆ palette_has_changed
| int AVFrame::palette_has_changed |
◆ reordered_opaque
| int64_t AVFrame::reordered_opaque |
reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything). The user sets AVCodecContext.reordered_opaque to represent the input at that time, the decoder reorders values as needed and sets AVFrame.reordered_opaque to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
◆ sample_rate
◆ channel_layout
| uint64_t AVFrame::channel_layout |
◆ buf
| AVBufferRef* AVFrame::buf[AV_NUM_DATA_POINTERS] |
AVBuffer references backing the data for this frame. If all elements of this array are NULL, then this frame is not reference counted. This array must be filled contiguously – if buf[i] is non-NULL then buf[j] must also be non-NULL for all j < i.
There may be at most one AVBuffer per data plane, so for video this array always contains all the references. For planar audio with more than AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in this array. Then the extra AVBufferRef pointers are stored in the extended_buf array.
◆ extended_buf
| AVBufferRef** AVFrame::extended_buf |
For planar audio which requires more than AV_NUM_DATA_POINTERS AVBufferRef pointers, this array will hold all the references which cannot fit into AVFrame.buf.
Note that this is different from AVFrame.extended_data, which always contains all the pointers. This array only contains the extra pointers, which cannot fit into AVFrame.buf.
This array is always allocated using av_malloc() by whoever constructs the frame. It is freed in av_frame_unref().
◆ nb_extended_buf
| int AVFrame::nb_extended_buf |
◆ side_data
| AVFrameSideData** AVFrame::side_data |
◆ nb_side_data
◆ flags
| int AVFrame::flags |
Frame flags, a combination of AV_FRAME_FLAGS
◆ color_range
| enum AVColorRange AVFrame::color_range |
◆ color_primaries
| enum AVColorPrimaries AVFrame::color_primaries |
◆ color_trc
| enum AVColorTransferCharacteristic AVFrame::color_trc |
◆ colorspace
| enum AVColorSpace AVFrame::colorspace |
◆ chroma_location
| enum AVChromaLocation AVFrame::chroma_location |
◆ best_effort_timestamp
| int64_t AVFrame::best_effort_timestamp |
◆ pkt_pos
| int64_t AVFrame::pkt_pos |
◆ pkt_duration
| int64_t AVFrame::pkt_duration |
◆ metadata
| AVDictionary* AVFrame::metadata |
◆ decode_error_flags
| int AVFrame::decode_error_flags |
◆ channels
| int AVFrame::channels |
◆ pkt_size
| int AVFrame::pkt_size |
◆ qscale_table
| attribute_deprecated int8_t* AVFrame::qscale_table |
◆ qstride
| attribute_deprecated int AVFrame::qstride |
◆ qscale_type
◆ qp_table_buf
| attribute_deprecated AVBufferRef* AVFrame::qp_table_buf |
◆ hw_frames_ctx
| AVBufferRef* AVFrame::hw_frames_ctx |
For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame.
◆ opaque_ref
| AVBufferRef* AVFrame::opaque_ref |
AVBufferRef for free use by the API user. FFmpeg will never check the contents of the buffer ref. FFmpeg calls av_buffer_unref() on it when the frame is unreferenced. av_frame_copy_props() calls create a new reference with av_buffer_ref() for the target frame's opaque_ref field.
This is unrelated to the opaque field, although it serves a similar purpose.
◆ crop_top
◆ crop_bottom
◆ crop_left
◆ crop_right
◆ private_ref
| AVBufferRef* AVFrame::private_ref |
AVBufferRef for internal use by a single libav* library. Must not be used to transfer data between libraries. Has to be NULL when ownership of the frame leaves the respective library.
Code outside the FFmpeg libs should never check or change the contents of the buffer ref.
FFmpeg calls av_buffer_unref() on it when the frame is unreferenced. av_frame_copy_props() calls create a new reference with av_buffer_ref() for the target frame's private_ref field.
Объявления и описания членов структуры находятся в файле:
- C:/git/world-of-might-and-magic/lib/win32/x86/ffmpeg-4.2.2/include/libavutil/frame.h
