Libav
Data Fields
AVFrame Struct Reference

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

#include <frame.h>

Data Fields

uint8_tdata [AV_NUM_DATA_POINTERS]
 pointer to the picture/channel planes. More...
 
int linesize [AV_NUM_DATA_POINTERS]
 For video, size in bytes of each picture line. More...
 
uint8_t ** extended_data
 pointers to the data planes/channels. More...
 
int width
 width and height of the video frame More...
 
int height
 
int nb_samples
 number of audio samples (per channel) described by this frame More...
 
int format
 format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames, enum AVSampleFormat for audio) More...
 
int key_frame
 1 -> keyframe, 0-> not More...
 
enum AVPictureType pict_type
 Picture type of the frame. More...
 
attribute_deprecated uint8_tbase [AV_NUM_DATA_POINTERS]
 
AVRational sample_aspect_ratio
 Sample aspect ratio for the video frame, 0/1 if unknown/unspecified. More...
 
int64_t pts
 Presentation timestamp in time_base units (time when frame should be shown to user). More...
 
int64_t pkt_pts
 PTS copied from the AVPacket that was decoded to produce this frame. More...
 
int64_t pkt_dts
 DTS copied from the AVPacket that triggered returning this frame. More...
 
int coded_picture_number
 picture number in bitstream order More...
 
int display_picture_number
 picture number in display order More...
 
int quality
 quality (between 1 (good) and FF_LAMBDA_MAX (bad)) More...
 
attribute_deprecated int reference
 
attribute_deprecated int8_t * qscale_table
 QP table. More...
 
attribute_deprecated int qstride
 QP store stride. More...
 
attribute_deprecated int qscale_type
 
attribute_deprecated uint8_tmbskip_table
 mbskip_table[mb]>=1 if MB didn't change stride= mb_width = (width+15)>>4 More...
 
attribute_deprecated int16_t(*[2] motion_val )[2]
 motion vector table More...
 
attribute_deprecated uint32_t * mb_type
 macroblock type table mb_type_base + mb_width + 2 More...
 
attribute_deprecated short * dct_coeff
 DCT coefficients. More...
 
attribute_deprecated int8_t * ref_index [2]
 motion reference frame index the order in which these are stored can depend on the codec. More...
 
voidopaque
 for some private data of the user More...
 
uint64_t error [AV_NUM_DATA_POINTERS]
 error More...
 
attribute_deprecated int type
 
int repeat_pict
 When decoding, this signals how much the picture must be delayed. More...
 
int interlaced_frame
 The content of the picture is interlaced. More...
 
int top_field_first
 If the content is interlaced, is top field displayed first. More...
 
int palette_has_changed
 Tell user application that palette has changed from previous frame. More...
 
attribute_deprecated int buffer_hints
 
attribute_deprecated struct AVPanScanpan_scan
 Pan scan. More...
 
int64_t reordered_opaque
 reordered opaque 64bit (generally an integer or a double precision float PTS but can be anything). More...
 
attribute_deprecated voidhwaccel_picture_private
 
attribute_deprecated struct AVCodecContextowner
 
attribute_deprecated voidthread_opaque
 
attribute_deprecated uint8_t motion_subsample_log2
 log2 of the size of the block which a single vector in motion_val represents: (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2) More...
 
int sample_rate
 Sample rate of the audio data. More...
 
uint64_t channel_layout
 Channel layout of the audio data. More...
 
AVBufferRefbuf [AV_NUM_DATA_POINTERS]
 AVBuffer references backing the data for this frame. More...
 
AVBufferRef ** 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. More...
 
int nb_extended_buf
 Number of elements in extended_buf. More...
 
AVFrameSideData ** side_data
 
int nb_side_data
 
int flags
 Frame flags, a combination of AV_FRAME_FLAGS. More...
 
enum AVColorRange color_range
 
enum AVColorPrimaries color_primaries
 
enum AVColorTransferCharacteristic color_trc
 
enum AVColorSpace colorspace
 
enum AVChromaLocation chroma_location
 

Detailed Description

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.

Definition at line 135 of file frame.h.

Field Documentation

§ data

uint8_t* AVFrame::data[AV_NUM_DATA_POINTERS]

pointer to the picture/channel planes.

This might be different from the first allocated byte

Definition at line 141 of file frame.h.

Referenced by aac_encode_frame(), aasc_decode_frame(), ac3_decode_frame(), add_frame_default(), adpcm_decode_frame(), adpcm_encode_frame(), adx_encode_frame(), aic_decode_slice(), alloc_frame_buffer(), alloc_picture(), alpha_inverse_prediction(), amr_decode_fix_avctx(), amr_wb_encode_frame(), amrnb_decode_frame(), amrwb_decode_frame(), ape_decode_frame(), apply_loop_filter(), apply_motion_generic(), audio_decode_example(), audio_decode_frame(), audio_get_buffer(), aura_decode_frame(), av_buffersrc_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), avfilter_copy_buf_props(), avs_decode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bink_decode_plane(), binkb_decode_plane(), blend_frame(), bmp_decode_frame(), bmp_encode_frame(), bmv_aud_decode_frame(), buffer_needs_copy(), buffer_offset(), cavs_decode_frame(), cdg_border_preset(), cdg_decode_frame(), cdg_load_palette(), cdg_scroll(), cdg_tile_block(), cdxl_decode_ham6(), cdxl_decode_ham8(), cdxl_decode_rgb(), channelmap_filter_frame(), chroma_mc(), cinaudio_decode_frame(), cinepak_decode_frame(), cinepak_decode_vectors(), cinvideo_decode_frame(), cmv_decode_frame(), cmv_decode_inter(), cmv_decode_intra(), cng_decode_frame(), cng_encode_frame(), color_request_frame(), comp_block(), compat_read(), copy_frame_default(), copy_from(), copy_luma(), copy_output(), copy_picture_field(), copy_processed_frame(), create_clusters(), cyuv_decode_frame(), dct_get(), deblocking_filter_CTB(), decode_argb_frame(), decode_block(), decode_frame(), decode_frame_byterun1(), decode_frame_ilbm(), decode_pic(), decode_rgb24_frame(), decode_slice(), decode_tag(), decode_wmv9(), decode_yuv_frame(), dfa_decode_frame(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), dpcm_decode_frame(), draw_char(), drawbox(), dv_decode_video_segment(), dv_encode_video_segment(), dxtory_decode_v1_410(), dxtory_decode_v1_420(), dxtory_decode_v1_444(), dxtory_decode_v1_rgb(), dxtory_decode_v2_410(), dxtory_decode_v2_420(), dxtory_decode_v2_444(), dxtory_decode_v2_565(), dxtory_decode_v2_rgb(), dxva2_get_buffer(), dxva2_retrieve_data(), eightsvx_decode_frame(), encode_bitstream(), encode_frame(), encode_mb_internal(), encode_picture_ls(), encode_slice(), encode_thread(), erase_line(), erase_screen(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), execute_code(), Faac_encode_frame(), ff_alloc_picture(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_cavs_init_pic(), ff_cavs_next_mb(), ff_dxva2_get_surface(), ff_er_frame_end(), ff_estimate_b_frame_motion(), ff_estimate_p_frame_motion(), ff_filter_frame(), ff_get_buffer(), ff_get_format(), ff_h263_decode_frame(), ff_h264_decode_slice_header(), ff_h264_draw_horiz_band(), ff_h264_fill_default_ref_list(), ff_hevc_output_frame(), ff_init_block_index(), ff_ivi_decode_frame(), ff_jpegls_decode_picture(), ff_mjpeg_decode_frame(), ff_mpeg4_encode_mb(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_msmpeg4_pred_dc(), ff_pre_estimate_p_frame_motion(), ff_reget_buffer(), ff_rtjpeg_decode_frame_yuv420(), ff_rv34_decode_frame(), ff_vaapi_get_surface_id(), ff_vc1_decode_blocks(), ff_vdpau_get_surface_id(), ff_vp9_decode_block(), ffv1_decode_frame(), fic_decode_slice(), fic_draw_cursor(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_yuv_image(), filter_frame(), filter_slice(), filter_slice_chroma(), filter_slice_luma(), find_slice_quant(), flac_decode_frame(), flac_encode_frame(), flashsv_decode_block(), flashsv_decode_frame(), flashsv_encode_frame(), flic_decode_frame_15_16BPP(), flic_decode_frame_8BPP(), frame_copy_video(), frame_end(), frame_start(), g2m_decode_frame(), g722_decode_frame(), g722_encode_frame(), g723_1_decode_frame(), g726_reset(), gather_data_for_cel(), gather_data_for_subcel(), generate_missing_ref(), get_audio_buffer(), get_audio_frame(), get_frame_defaults(), get_frame_mb(), get_video_buffer(), get_video_frame(), gif_decode_frame(), gif_encode_frame(), gif_read_image(), gsm_decode_frame(), guess_mv(), h263_mv4_search(), hls_pcm_sample(), hls_residual_coding(), hnm_decode_frame(), horizontal_frame_pack(), hscroll(), idcin_decode_frame(), idcin_decode_vlcs(), idct_put(), ilbc_decode_frame(), ilbc_encode_frame(), init_image(), inter_recon(), intra_recon(), ipvideo_decode_opcodes(), ir2_decode_frame(), is_intra_more_likely(), join_request_frame(), jpeg2000_decode_tile(), lag_decode_frame(), libgsm_decode_frame(), libgsm_encode_frame(), libopenjpeg_copy_packed16(), libopenjpeg_copy_packed8(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), libopenjpeg_copy_unpacked16(), libopenjpeg_copy_unpacked8(), libopenjpeg_copyto16(), libopenjpeg_copyto8(), libopus_decode(), libopus_encode(), libschroedinger_decode_frame(), libspeex_decode_frame(), libwebp_encode_frame(), libx265_encode_frame(), ljpeg_decode_rgb_scan(), ljpeg_decode_yuv_scan(), ljpeg_encode_bgr(), ljpeg_encode_yuv_mb(), load_encode_and_write(), load_input_picture(), loop_filter(), loopfilter_subblock(), luma_mc(), mb_var_thread(), mc_dir_part(), mimic_decode_frame(), mjpeg_decode_scan(), mjpeg_decode_scan_progressive_ac(), mm_decode_frame(), mm_decode_inter(), mm_decode_intra(), mp3lame_encode_frame(), mp_decode_frame(), mp_get_yuv_from_rgb(), mp_read_changes_map(), mp_set_rgb_from_yuv(), MPA_encode_frame(), mpeg_er_decode_mb(), mpeg_field_start(), mpv_decode_mb_internal(), mpv_motion_internal(), msrle_decode_frame(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_frame(), msvideo1_decode_16bit(), msvideo1_decode_8bit(), mvc_decode_frame(), mxpeg_check_dimensions(), mxpeg_decode_frame(), output_data(), output_frame(), pack_yuv(), paf_audio_decode(), paf_video_decode(), pam_encode_frame(), parse_transform_color_indexing(), pcm_bluray_decode_frame(), pcm_decode_frame(), pcm_dvd_decode_frame(), pcm_encode_frame(), pcx_decode_frame(), pcx_encode_frame(), pic_as_field(), picmemset(), picmemset_8bpp(), pix_decode_frame(), pnm_decode_frame(), pnm_encode_frame(), prefetch_motion(), prepare_avpic(), print_long_term(), print_short_term(), ptx_decode_frame(), qcelp_decode_frame(), qdm2_decode_frame(), qtrle_decode_16bpp(), qtrle_decode_1bpp(), qtrle_decode_24bpp(), qtrle_decode_2n4bpp(), qtrle_decode_32bpp(), qtrle_decode_8bpp(), qtrle_decode_frame(), queue_picture(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), raw_decode(), reconstruct_and_encode_image(), ref_frame(), release_delayed_buffers(), render_slice(), request_frame(), restore_tqb_pixels(), rl2_decode_frame(), roq_decode_frame(), roq_dpcm_encode_frame(), rpza_decode_stream(), rv30_loop_filter(), rv34_mc(), rv40_loop_filter(), s302m_decode_frame(), sao_filter_CTB(), select_input_picture(), seqvideo_decode(), set_palette(), sgirle_decode_frame(), shuffleplanes_filter_frame(), sipr_decode_frame(), skip_check(), smc_decode_stream(), smka_decode_frame(), source_request_frame(), sse_mb(), sunrast_decode_frame(), sunrast_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), svq1_encode_plane(), svq3_decode_frame(), svq3_mc_dir_part(), synth_superframe(), targa_encode_normal(), targa_encode_rle(), tgq_idct_put_mb(), tgq_idct_put_mb_dconly(), tgv_decode_frame(), tgv_decode_inter(), tm2_decode_blocks(), tmv_decode_frame(), to_meta_with_crop(), tqi_idct_put(), truemotion1_decode_16bit(), truemotion1_decode_24bit(), truespeech_decode_frame(), tscc2_decode_slice(), tta_decode_frame(), twolame_encode_frame(), txd_decode_frame(), ulti_convert_yuv(), unrefcount_frame(), utvideo_encode_frame(), v410_decode_frame(), v410_encode_frame(), vble_restore_plane(), vc1_decode_skip_blocks(), vc1_interp_mc(), vc1_mc_1mv(), vc1_mc_4mv_chroma(), vc1_mc_4mv_chroma4(), vc1_mc_4mv_luma(), vcr1_decode_frame(), vda_h264_end_frame(), vda_old_h264_end_frame(), vda_retrieve_data(), vdpau_get_buffer(), vdpau_retrieve_data(), verify_md5(), vertical_frame_pack(), video_decode_example(), video_encode_example(), video_get_buffer(), vmd_decode(), vmdaudio_decode_frame(), vmdvideo_decode_frame(), vp3_decode_frame(), vp3_update_thread_context(), vp56_decode_mb(), vp78_decode_frame(), vp7_fade_frame(), vp8_decode(), vp8_decode_mb_row_no_filter(), vp8_encode(), vp8_filter_mb_row(), vp8_find_free_buffer(), vp8_lossy_decode_alpha(), vp8_mc_chroma(), vp8_mc_luma(), vp9_decode_frame(), vqa_decode_chunk(), vqa_decode_frame(), wavpack_encode_frame(), ws_snd_decode_frame(), X264_frame(), x8_init_block_index(), xan_decode_chroma(), xan_decode_frame(), xan_decode_frame_type0(), xan_decode_frame_type1(), xan_wc3_copy_pixel_run(), xan_wc3_output_pixel_run(), XAVS_frame(), xbm_decode_frame(), xbm_encode_frame(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), yop_decode_frame(), and zerocodec_decode_frame().

§ 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.

Note
The linesize may be larger than the size of usable data – there may be extra padding present for performance reasons.

Definition at line 153 of file frame.h.

Referenced by aasc_decode_frame(), add_frame_default(), aic_decode_slice(), alloc_frame_buffer(), alloc_picture(), alpha_inverse_prediction(), apply_color_indexing_transform(), apply_loop_filter(), apply_motion_generic(), audio_decode_frame(), audio_get_buffer(), aura_decode_frame(), av_buffersrc_buffer(), av_frame_ref(), available_samples(), avcodec_fill_audio_frame(), avfilter_copy_buf_props(), avresample_convert_frame(), avs_decode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bink_decode_plane(), binkb_decode_plane(), blend_frame(), bmp_decode_frame(), bmp_encode_frame(), buffer_needs_copy(), buffer_offset(), cdg_border_preset(), cdg_decode_frame(), cdg_scroll(), cdg_tile_block(), cdxl_decode_ham6(), cdxl_decode_ham8(), cdxl_decode_rgb(), chroma_mc(), cinepak_decode_vectors(), cinvideo_decode_frame(), cmv_decode_inter(), cmv_decode_intra(), color_request_frame(), comp_block(), compat_read(), convert_frame(), copy_frame_default(), copy_from(), copy_luma(), copy_output(), copy_picture_field(), copy_processed_frame(), create_clusters(), cyuv_decode_frame(), dct_get(), deblocking_filter_CTB(), decode_argb_frame(), decode_block(), decode_frame(), decode_frame_byterun1(), decode_frame_ilbm(), decode_pic(), decode_rgb24_frame(), decode_slice(), decode_subblock(), decode_wmv9(), decode_yuv_frame(), dfa_decode_frame(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), dnxhd_load_picture(), draw_char(), draw_slice(), drawbox(), dv_decode_video_segment(), dv_encode_video_segment(), dxtory_decode_v1_410(), dxtory_decode_v1_420(), dxtory_decode_v1_444(), dxtory_decode_v1_rgb(), dxtory_decode_v2_410(), dxtory_decode_v2_420(), dxtory_decode_v2_444(), dxtory_decode_v2_565(), dxtory_decode_v2_rgb(), encode_bitstream(), encode_frame(), encode_picture_ls(), encode_slice(), erase_line(), erase_screen(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), execute_code(), ff_alloc_picture(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_cavs_init_pic(), ff_draw_horiz_band(), ff_er_frame_end(), ff_filter_frame(), ff_get_buffer(), ff_h264_decode_slice_header(), ff_h264_draw_horiz_band(), ff_h264_fill_mbaff_ref_list(), ff_hevc_output_frame(), ff_init_block_index(), ff_ivi_decode_frame(), ff_jpegls_decode_picture(), ff_mjpeg_decode_frame(), ff_mjpeg_decode_sof(), ff_mpv_frame_start(), ff_rtjpeg_decode_frame_yuv420(), ff_vc1_decode_blocks(), ff_vp56_decode_frame(), ff_vp9_decode_block(), ffv1_decode_frame(), fic_decode_slice(), fic_draw_cursor(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_yuv_image(), filter_frame(), filter_slice(), filter_slice_chroma(), filter_slice_luma(), find_slice_quant(), flashsv_decode_block(), flashsv_decode_frame(), flashsv_encode_frame(), flic_decode_frame_15_16BPP(), flic_decode_frame_8BPP(), frame_copy_video(), frame_start(), g2m_decode_frame(), gather_data_for_cel(), gather_data_for_subcel(), generate_missing_ref(), get_audio_buffer(), get_buffer(), get_frame_mb(), get_video_buffer(), get_video_frame(), gif_encode_frame(), gif_read_image(), guess_mv(), hls_pcm_sample(), hls_prediction_unit(), hls_residual_coding(), horizontal_frame_pack(), hscroll(), idcin_decode_vlcs(), idct_put(), init_block_index(), inter_recon(), intra_recon(), ipvideo_decode_opcodes(), ir2_decode_frame(), is_intra_more_likely(), join_request_frame(), jpeg2000_decode_tile(), lag_decode_frame(), libopenjpeg_copy_packed16(), libopenjpeg_copy_packed8(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), libopenjpeg_copy_unpacked16(), libopenjpeg_copy_unpacked8(), libopenjpeg_copyto16(), libopenjpeg_copyto8(), libschroedinger_decode_frame(), libwebp_encode_frame(), libx265_encode_frame(), ljpeg_encode_bgr(), ljpeg_encode_yuv_mb(), load_input_picture(), loopfilter_subblock(), luma_mc(), mm_decode_inter(), mm_decode_intra(), mp3lame_encode_frame(), mp_get_yuv_from_rgb(), mp_read_changes_map(), mp_set_rgb_from_yuv(), mpeg_field_start(), mpeg_motion_internal(), mpv_decode_mb_internal(), msrle_decode_frame(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_dct_block(), mss4_decode_frame(), mss4_decode_image_block(), msvideo1_decode_16bit(), msvideo1_decode_8bit(), mvc_decode_frame(), mxpeg_check_dimensions(), opus_decode_packet(), output_frame(), pack_yuv(), paf_video_decode(), pam_encode_frame(), pcx_decode_frame(), pcx_encode_frame(), pic_as_field(), picmemset(), picmemset_8bpp(), pix_decode_frame(), pnm_decode_frame(), pnm_encode_frame(), prepare_avpic(), process_audio_stream(), ptx_decode_frame(), put_dc(), qtrle_decode_16bpp(), qtrle_decode_1bpp(), qtrle_decode_24bpp(), qtrle_decode_2n4bpp(), qtrle_decode_32bpp(), qtrle_decode_8bpp(), qtrle_decode_frame(), qtrle_encode_line(), queue_picture(), raw_decode(), reconstruct_and_encode_image(), render_slice(), request_frame(), restore_tqb_pixels(), rl2_decode_frame(), rpza_decode_stream(), sao_filter_CTB(), seq_decode_op1(), seq_decode_op2(), seq_decode_op3(), seqvideo_decode(), sgirle_decode_frame(), shuffleplanes_filter_frame(), skip_check(), smc_decode_stream(), sunrast_decode_frame(), sunrast_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), svq1_encode_plane(), svq3_decode_frame(), targa_encode_normal(), targa_encode_rle(), tgq_idct_put_mb(), tgq_idct_put_mb_dconly(), tgv_decode_frame(), tgv_decode_inter(), tm2_decode_blocks(), tmv_decode_frame(), to_meta_with_crop(), tqi_idct_put(), truemotion1_decode_16bit(), truemotion1_decode_24bit(), tscc2_decode_slice(), txd_decode_frame(), ulti_convert_yuv(), unrefcount_frame(), utvideo_encode_frame(), v410_decode_frame(), v410_encode_frame(), vble_restore_plane(), vc1_decode_frame(), vc1_interp_mc(), vc1_mc_1mv(), vc1_mc_4mv_chroma(), vc1_mc_4mv_luma(), vcr1_decode_frame(), vda_retrieve_data(), vdpau_retrieve_data(), verify_md5(), vertical_frame_pack(), video_decode_example(), video_encode_example(), video_get_buffer(), vmd_decode(), vp3_decode_frame(), vp3_draw_horiz_band(), vp7_fade_frame(), vp8_decode(), vp8_encode(), vp8_lossy_decode_alpha(), vp9_decode_frame(), vqa_decode_chunk(), write_to_fifo(), X264_frame(), x8_decode_intra_mb(), x8_init_block_index(), x8_setup_spatial_predictor(), xan_decode_chroma(), xan_decode_frame(), xan_decode_frame_type0(), xan_decode_frame_type1(), xan_wc3_copy_pixel_run(), xan_wc3_output_pixel_run(), XAVS_frame(), xbm_decode_frame(), xbm_encode_frame(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), yop_decode_frame(), and zerocodec_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.

Definition at line 169 of file frame.h.

Referenced by adpcm_decode_frame(), adpcm_encode_frame(), adx_decode_frame(), alac_encode_frame(), apply_window_and_mdct(), atrac1_decode_frame(), atrac3_decode_frame(), atrac3p_decode_frame(), audio_get_buffer(), av_buffersink_get_samples(), av_buffersrc_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), avfilter_copy_buf_props(), buffer_offset(), calc_ptr_alignment(), channelmap_filter_frame(), compand_delay(), compand_drain(), compand_nodelay(), compat_read(), convert_frame(), cook_decode_frame(), copy_input_samples(), dca_decode_frame(), decode_element(), decode_frame(), fdk_aac_decode_frame(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_get_buffer(), ff_get_format(), ff_twinvq_decode_frame(), filter_frame(), flush(), frame_configure_elements(), frame_copy_audio(), get_audio_buffer(), get_frame_defaults(), get_input(), get_video_buffer(), imc_decode_frame(), join_request_frame(), libvorbis_encode_frame(), mace_decode_frame(), mp_decode_frame(), mpc7_decode_frame(), mpc8_decode_frame(), on2avc_reconstruct_channel(), on2avc_reconstruct_stereo(), opus_decode_packet(), output_frame(), pad_last_frame(), pcm_decode_frame(), process_audio_stream(), process_output(), read_decode_convert_and_store(), read_from_fifo(), release_delayed_buffers(), request_frame(), return_audio_frame(), shorten_decode_frame(), tak_decode_frame(), unrefcount_frame(), video_get_buffer(), vorbis_decode_frame(), vorbis_encode_frame(), wavpack_decode_block(), wma_decode_superframe(), and write_to_fifo().

§ width

int AVFrame::width

§ height

int AVFrame::height

§ nb_samples

int AVFrame::nb_samples

number of audio samples (per channel) described by this frame

Definition at line 179 of file frame.h.

Referenced by aac_decode_er_frame(), aac_decode_frame_int(), aac_encode_frame(), ac3_decode_frame(), adpcm_decode_frame(), adpcm_encode_frame(), adx_decode_frame(), alac_encode_frame(), alloc_audio_frame(), amr_decode_fix_avctx(), amrnb_decode_frame(), amrwb_decode_frame(), ape_decode_frame(), apply_window_and_mdct(), atrac1_decode_frame(), atrac3_decode_frame(), atrac3p_decode_frame(), audio_decode_example(), audio_decode_frame(), audio_encode_example(), av_buffersink_get_samples(), av_frame_copy(), av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), avfilter_copy_buf_props(), avresample_convert_frame(), bmv_aud_decode_frame(), buffer_offset(), cinaudio_decode_frame(), cng_decode_frame(), cng_encode_frame(), compand_delay(), compand_drain(), compand_nodelay(), compat_read(), config_output(), convert_frame(), cook_decode_frame(), copy_input_samples(), dca_decode_frame(), decode_audio(), decode_element(), decode_frame(), decode_packet(), decode_tag(), do_audio_out(), dpcm_decode_frame(), eightsvx_decode_frame(), encode_frame(), Faac_encode_frame(), fdk_aac_decode_frame(), ff_af_queue_add(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_twinvq_decode_frame(), filter_frame(), flac_decode_frame(), flac_encode_frame(), flush(), frame_configure_elements(), frame_copy_audio(), g722_decode_frame(), g722_encode_frame(), g723_1_decode_frame(), g726_reset(), get_audio_buffer(), get_audio_frame(), get_input(), gsm_decode_frame(), ilbc_decode_frame(), imc_decode_frame(), join_request_frame(), libgsm_decode_frame(), libopus_decode(), libopus_encode(), libspeex_decode_frame(), libvorbis_encode_frame(), mace_decode_frame(), mp3lame_encode_frame(), mp_decode_frame(), mpc7_decode_frame(), mpc8_decode_frame(), on2avc_decode_frame(), opus_decode_packet(), output_data(), pad_last_frame(), paf_audio_decode(), pcm_bluray_decode_frame(), pcm_decode_frame(), pcm_dvd_decode_frame(), pcm_encode_frame(), process_audio_stream(), process_output(), qcelp_decode_frame(), qdm2_decode_frame(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), read_decode_convert_and_store(), return_audio_frame(), s302m_decode_frame(), shorten_decode_frame(), sipr_decode_frame(), smka_decode_frame(), synth_superframe(), tak_decode_frame(), truespeech_decode_frame(), tta_decode_frame(), twolame_encode_frame(), unrefcount_frame(), update_frame_pool(), vmdaudio_decode_frame(), vorbis_decode_frame(), vorbis_encode_frame(), wavpack_decode_block(), wavpack_encode_frame(), wma_decode_superframe(), write_to_fifo(), and ws_snd_decode_frame().

§ format

int AVFrame::format

§ key_frame

int AVFrame::key_frame

1 -> keyframe, 0-> not

Definition at line 191 of file frame.h.

Referenced by a64multi_encode_frame(), a64multi_encode_init(), aic_decode_frame(), av_frame_copy_props(), avfilter_copy_buf_props(), avfilter_copy_frame_props(), avs_decode_frame(), bfi_decode_frame(), bmp_decode_frame(), bmp_encode_frame(), cllc_decode_frame(), cmv_decode_frame(), decode_frame(), decode_nal_units(), decode_postinit(), decode_slice(), dnxhd_decode_frame(), dnxhd_encode_init(), dvvideo_decode_frame(), dvvideo_encode_frame(), encode_frame(), encode_init(), encode_init_ls(), encode_picture(), encode_slice(), ff_get_format(), ff_h263_decode_frame(), ff_mjpeg_decode_sof(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_vp56_decode_frame(), ffv1_decode_frame(), ffv1_encode_frame(), fic_decode_block(), fic_decode_frame(), filter_frame(), flashsv_encode_frame(), frame_start(), g2m_decode_frame(), get_frame_defaults(), gif_encode_init(), h261_decode_frame(), h264_decode_frame(), h264_frame_start(), hevc_frame_start(), hnm_decode_frame(), jpeg2000_decode_frame(), lag_decode_frame(), libschroedinger_encode_frame(), ljpeg_encode_init(), mpeg1_decode_picture(), mpeg1_encode_sequence_header(), mpeg_decode_picture_coding_extension(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_frame(), mxpeg_decode_frame(), paf_video_decode(), pam_encode_init(), pcx_encode_init(), pix_decode_frame(), png_enc_init(), pnm_decode_frame(), pnm_encode_init(), qtrle_encode_frame(), qtrle_encode_line(), raw_decode(), raw_encode_init(), request_frame(), storeframe(), sunrast_encode_init(), svq1_encode_frame(), svq3_decode_frame(), targa_encode_init(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), utvideo_encode_frame(), v410_decode_frame(), v410_encode_frame(), vble_decode_frame(), vc1_decode_frame(), vcr1_decode_frame(), vp8_lossless_decode_frame(), vp9_decode_frame(), XAVS_frame(), xbm_decode_frame(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), and zerocodec_decode_frame().

§ pict_type

enum AVPictureType AVFrame::pict_type

Picture type of the frame.

Definition at line 196 of file frame.h.

Referenced by a64multi_encode_frame(), a64multi_encode_init(), aic_decode_frame(), av_frame_copy_props(), avfilter_copy_buf_props(), avfilter_copy_frame_props(), avs_decode_frame(), bfi_decode_frame(), bmp_decode_frame(), bmp_encode_frame(), cavs_decode_frame(), cdxl_decode_frame(), cllc_decode_frame(), cmv_decode_frame(), decode_frame(), decode_mb_i(), decode_pic(), decode_postinit(), decode_slice_header(), dnxhd_decode_frame(), dnxhd_encode_init(), do_video_out(), do_video_stats(), dvvideo_decode_frame(), dvvideo_encode_frame(), encode_frame(), encode_init(), encode_init_ls(), encode_picture(), estimate_best_b_count(), execute_code(), ff_draw_horiz_band(), ff_er_frame_end(), ff_h263_decode_frame(), ff_h264_draw_horiz_band(), ff_mjpeg_decode_sof(), ff_mpeg4_encode_mb(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_print_debug_info(), ff_vc1_parse_frame_header_adv(), ff_vp56_decode_frame(), ffv1_decode_frame(), ffv1_encode_init(), fic_decode_block(), fic_decode_frame(), filter_frame(), flashsv_encode_frame(), frame_start(), g2m_decode_frame(), gif_encode_init(), h261_decode_frame(), hnm_decode_frame(), is_intra_more_likely(), jpeg2000_decode_frame(), ljpeg_encode_init(), mimic_decode_frame(), mpeg1_decode_picture(), mpeg_decode_picture_coding_extension(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_frame(), mxpeg_decode_frame(), paf_video_decode(), pam_encode_init(), pcx_decode_frame(), pcx_encode_init(), pix_decode_frame(), png_enc_init(), pnm_decode_frame(), pnm_encode_init(), ptx_decode_frame(), qtrle_encode_frame(), raw_decode(), raw_encode_init(), request_frame(), rv10_decode_packet(), select_frame(), select_input_picture(), set_mv_intra(), storeframe(), sunrast_decode_frame(), sunrast_encode_init(), svq1_decode_frame(), svq1_decode_frame_header(), svq1_encode_frame(), svq1_encode_plane(), svq3_decode_frame(), targa_encode_init(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), txd_decode_frame(), utvideo_encode_frame(), v410_decode_frame(), v410_encode_frame(), vaapi_mpeg4_start_frame(), vble_decode_frame(), vc1_decode_frame(), vcr1_decode_frame(), vp3_decode_frame(), vp8_encode(), vp8_lossless_decode_frame(), vp9_decode_frame(), X264_frame(), XAVS_frame(), xbm_decode_frame(), xbm_encode_init(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), and zerocodec_decode_frame().

§ base

Definition at line 200 of file frame.h.

§ sample_aspect_ratio

AVRational AVFrame::sample_aspect_ratio

§ pts

int64_t AVFrame::pts

§ pkt_pts

int64_t AVFrame::pkt_pts

PTS copied from the AVPacket that was decoded to produce this frame.

Definition at line 216 of file frame.h.

Referenced by av_frame_copy_props(), decode_video(), ff_decode_frame_props(), get_video_frame(), libschroedinger_decode_frame(), and movie_get_frame().

§ pkt_dts

int64_t AVFrame::pkt_dts

DTS copied from the AVPacket that triggered returning this frame.

Definition at line 221 of file frame.h.

Referenced by av_frame_copy_props(), avcodec_decode_audio4(), avcodec_decode_video2(), decode_video(), ff_thread_decode_frame(), and get_video_frame().

§ coded_picture_number

int AVFrame::coded_picture_number

§ display_picture_number

int AVFrame::display_picture_number

picture number in display order

Definition at line 230 of file frame.h.

Referenced by av_frame_copy_props(), ff_write_pass1_stats(), load_input_picture(), and select_input_picture().

§ quality

int AVFrame::quality

§ reference

attribute_deprecated int AVFrame::reference

Definition at line 239 of file frame.h.

Referenced by ff_get_buffer().

§ qscale_table

attribute_deprecated int8_t* AVFrame::qscale_table

QP table.

Definition at line 245 of file frame.h.

§ qstride

attribute_deprecated int AVFrame::qstride

QP store stride.

Definition at line 250 of file frame.h.

§ qscale_type

attribute_deprecated int AVFrame::qscale_type

Definition at line 253 of file frame.h.

§ mbskip_table

attribute_deprecated uint8_t* AVFrame::mbskip_table

mbskip_table[mb]>=1 if MB didn't change stride= mb_width = (width+15)>>4

Definition at line 260 of file frame.h.

§ motion_val

attribute_deprecated int16_t(*[2] AVFrame::motion_val)[2]

motion vector table

example:
int mv_sample_log2= 4 - motion_subsample_log2;
int mb_width= (width+15)>>4;
int mv_stride= (mb_width << mv_sample_log2) + 1;
motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];

Definition at line 273 of file frame.h.

§ mb_type

attribute_deprecated uint32_t* AVFrame::mb_type

macroblock type table mb_type_base + mb_width + 2

Definition at line 280 of file frame.h.

§ dct_coeff

attribute_deprecated short* AVFrame::dct_coeff

DCT coefficients.

Definition at line 286 of file frame.h.

§ ref_index

attribute_deprecated int8_t* AVFrame::ref_index[2]

motion reference frame index the order in which these are stored can depend on the codec.

Definition at line 293 of file frame.h.

§ opaque

void* AVFrame::opaque

for some private data of the user

Definition at line 299 of file frame.h.

Referenced by av_frame_copy_props().

§ error

uint64_t AVFrame::error[AV_NUM_DATA_POINTERS]

§ type

attribute_deprecated int AVFrame::type

Definition at line 308 of file frame.h.

Referenced by avcodec_default_get_buffer2().

§ repeat_pict

int AVFrame::repeat_pict

When decoding, this signals how much the picture must be delayed.

extra_delay = repeat_pict / (2*fps)

Definition at line 315 of file frame.h.

Referenced by av_frame_copy_props(), decode_postinit(), mpeg_field_start(), output_picture2(), and vc1_decode_frame().

§ interlaced_frame

int AVFrame::interlaced_frame

§ top_field_first

int AVFrame::top_field_first

§ palette_has_changed

int AVFrame::palette_has_changed

§ buffer_hints

attribute_deprecated int AVFrame::buffer_hints

Definition at line 334 of file frame.h.

§ pan_scan

attribute_deprecated struct AVPanScan* AVFrame::pan_scan

Pan scan.

Definition at line 340 of file frame.h.

§ reordered_opaque

int64_t AVFrame::reordered_opaque

reordered opaque 64bit (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

Deprecated:
in favor of pkt_pts

Definition at line 352 of file frame.h.

Referenced by av_frame_copy_props(), and ff_decode_frame_props().

§ hwaccel_picture_private

attribute_deprecated void* AVFrame::hwaccel_picture_private
Deprecated:
this field is unused

Definition at line 358 of file frame.h.

§ owner

attribute_deprecated struct AVCodecContext* AVFrame::owner

Definition at line 361 of file frame.h.

§ thread_opaque

attribute_deprecated void* AVFrame::thread_opaque

Definition at line 363 of file frame.h.

§ motion_subsample_log2

attribute_deprecated uint8_t AVFrame::motion_subsample_log2

log2 of the size of the block which a single vector in motion_val represents: (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)

Definition at line 370 of file frame.h.

§ sample_rate

int AVFrame::sample_rate

§ channel_layout

uint64_t AVFrame::channel_layout

§ buf

AVBuffer references backing the data for this frame.

If all elements of this array are NULL, then this frame is not reference counted.

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.

Definition at line 393 of file frame.h.

Referenced by alloc_frame(), audio_get_buffer(), av_buffersrc_add_frame(), av_buffersrc_buffer(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_make_writable(), av_frame_ref(), av_frame_unref(), compat_read(), decode_frame_header(), dxva2_get_buffer(), ff_alloc_picture(), ff_get_buffer(), ff_h264_decode_ref_pic_list_reordering(), ff_h264_decode_slice_header(), ff_h264_fill_default_ref_list(), ff_h264_ref_picture(), ff_h264_unref_picture(), ff_hevc_set_new_ref(), ff_hevc_unref_frame(), ff_mpeg_ref_picture(), ff_mpv_frame_start(), ff_thread_release_buffer(), find_ref_idx(), find_unused_picture(), frame_needs_copy(), frame_start(), frame_worker_thread(), generate_missing_ref(), get_audio_buffer(), get_video_buffer(), h264_decode_frame(), hevc_decode_frame(), hevc_update_thread_context(), join_request_frame(), load_input_picture(), pic_is_unused(), raw_decode(), release_unused_pictures(), vda_h264_alloc_frame(), vda_h264_end_frame(), vdpau_get_buffer(), video_get_buffer(), and vp9_decode_frame().

§ 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().

Definition at line 407 of file frame.h.

Referenced by audio_get_buffer(), av_buffersrc_buffer(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_ref(), av_frame_unref(), ff_get_buffer(), get_audio_buffer(), and join_request_frame().

§ nb_extended_buf

int AVFrame::nb_extended_buf

§ side_data

AVFrameSideData** AVFrame::side_data

§ nb_side_data

int AVFrame::nb_side_data

§ flags

int AVFrame::flags

Frame flags, a combination of AV_FRAME_FLAGS.

Definition at line 434 of file frame.h.

Referenced by av_frame_copy_props(), and h264_decode_frame().

§ color_range

enum AVColorRange AVFrame::color_range

Definition at line 436 of file frame.h.

Referenced by av_frame_copy_props(), ff_decode_frame_props(), and get_frame_defaults().

§ color_primaries

enum AVColorPrimaries AVFrame::color_primaries

Definition at line 438 of file frame.h.

Referenced by av_frame_copy_props(), ff_decode_frame_props(), and get_frame_defaults().

§ color_trc

enum AVColorTransferCharacteristic AVFrame::color_trc

Definition at line 440 of file frame.h.

Referenced by av_frame_copy_props(), ff_decode_frame_props(), and get_frame_defaults().

§ colorspace

enum AVColorSpace AVFrame::colorspace

Definition at line 442 of file frame.h.

Referenced by av_frame_copy_props(), ff_decode_frame_props(), and get_frame_defaults().

§ chroma_location

enum AVChromaLocation AVFrame::chroma_location

Definition at line 444 of file frame.h.

Referenced by av_frame_copy_props(), ff_decode_frame_props(), and get_frame_defaults().


The documentation for this struct was generated from the following file: