FFmpeg
Data Fields
AVFrame Struct Reference

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

#include <frame.h>

Data Fields

uint8_t * data [AV_NUM_DATA_POINTERS]
 pointer to the picture/channel planes. More...
 
int linesize [AV_NUM_DATA_POINTERS]
 For video, a positive or negative value, which is typically indicating the size in bytes of each picture line, but it can also be: More...
 
uint8_t ** extended_data
 pointers to the data planes/channels. More...
 
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...
 
attribute_deprecated int key_frame
 1 -> keyframe, 0-> not More...
 
enum AVPictureType pict_type
 Picture type of the frame. More...
 
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_dts
 DTS copied from the AVPacket that triggered returning this frame. More...
 
AVRational time_base
 Time base for the timestamps in this frame. More...
 
attribute_deprecated int coded_picture_number
 picture number in bitstream order More...
 
attribute_deprecated int display_picture_number
 picture number in display order More...
 
int quality
 quality (between 1 (good) and FF_LAMBDA_MAX (bad)) More...
 
void * opaque
 Frame owner's private data. More...
 
int repeat_pict
 Number of fields in this frame which should be repeated, i.e. More...
 
attribute_deprecated int interlaced_frame
 The content of the picture is interlaced. More...
 
attribute_deprecated int top_field_first
 If the content is interlaced, is top field displayed first. More...
 
attribute_deprecated int palette_has_changed
 Tell user application that palette has changed from previous frame. More...
 
attribute_deprecated int64_t reordered_opaque
 reordered opaque 64 bits (generally an integer or a double precision float PTS but can be anything). More...
 
int sample_rate
 Sample rate of the audio data. More...
 
attribute_deprecated 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
 MPEG vs JPEG YUV range. More...
 
enum AVColorPrimaries color_primaries
 
enum AVColorTransferCharacteristic color_trc
 
enum AVColorSpace colorspace
 YUV colorspace type. More...
 
enum AVChromaLocation chroma_location
 
int64_t best_effort_timestamp
 frame timestamp estimated using various heuristics, in stream time base More...
 
attribute_deprecated int64_t pkt_pos
 reordered pos from the last AVPacket that has been input into the decoder More...
 
attribute_deprecated int64_t pkt_duration
 duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown. More...
 
AVDictionarymetadata
 metadata. More...
 
int decode_error_flags
 decode error flags of the frame, set to a combination of FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there were errors during the decoding. More...
 
attribute_deprecated int channels
 number of audio channels, only used for audio. More...
 
attribute_deprecated int pkt_size
 size of the corresponding packet containing the compressed frame. More...
 
AVBufferRefhw_frames_ctx
 For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame. More...
 
AVBufferRefopaque_ref
 Frame owner's private data. More...
 
AVBufferRefprivate_ref
 AVBufferRef for internal use by a single libav* library. More...
 
AVChannelLayout ch_layout
 Channel layout of the audio data. More...
 
int64_t duration
 Duration of the frame, in the same units as pts. More...
 
Video dimensions

Video frames only.

The coded dimensions (in pixels) of the video frame, i.e. the size of the rectangle that contains some well-defined values.

Note
The part of the frame intended for display/presentation is further restricted by the Cropping rectangle.
int width
 
int height
 
Cropping

Video frames only. The number of pixels to discard from the the top/bottom/left/right border of the frame to obtain the sub-rectangle of the frame intended for presentation.

size_t crop_top
 
size_t crop_bottom
 
size_t crop_left
 
size_t crop_right
 

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.

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

Examples
decode_audio.c, decode_filter_audio.c, decode_filter_video.c, decode_video.c, demux_decode.c, encode_audio.c, encode_video.c, extract_mvs.c, filter_audio.c, hw_decode.c, mux.c, qsv_decode.c, qsv_transcode.c, transcode.c, transcode_aac.c, vaapi_encode.c, and vaapi_transcode.c.

Definition at line 340 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. For video, it could even point to the end of the image data.

All pointers in data and extended_data must point into one of the AVBufferRef in buf or extended_buf.

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: Pointers not needed by the format MUST be set to NULL.

Attention
In case of video, the data[] pointers can point to the end of image data in order to reverse line order, when used in combination with negative values in the linesize[] array.
Examples
decode_audio.c, decode_filter_audio.c, decode_filter_video.c, decode_video.c, demux_decode.c, encode_audio.c, encode_video.c, hw_decode.c, mux.c, qsv_decode.c, and vaapi_encode.c.

Definition at line 361 of file frame.h.

Referenced by aac_decode_er_frame(), aac_decode_frame_int(), aac_encode_frame(), ac3_decode_frame(), activate(), add_coefficients(), adpcm_decode_frame(), adx_encode_frame(), alloc_frame(), alloc_picture(), alpha_inverse_prediction(), amf_copy_surface(), amr_wb_encode_frame(), aom_decode(), aom_encode(), ape_decode_frame(), apng_encode_frame(), apply_filter(), apply_motion_generic(), aptx_decode_frame(), aptx_encode_frame(), audio_decode_frame(), audio_get_buffer(), aura_decode_frame(), av_frame_apply_cropping(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), av_frame_replace(), av_frame_unref(), av_hwframe_get_buffer(), avcodec_fill_audio_frame(), average_slice16(), average_slice8(), averageiir2d(), avgblur_opencl_filter_frame(), avs_decode_frame(), avui_decode_frame(), avui_encode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bilateralo_planes(), bink_decode_plane(), binkb_decode_plane(), bitpacked_decode_uyvy422(), bitpacked_decode_yuv422p10(), black_counter(), blend_slice_packed_rgb(), blockdetect_filter_frame(), blur(), blur_frame(), blur_planes(), blurdetect_filter_frame(), bmp_decode_frame(), bmp_encode_frame(), bmv_aud_decode_frame(), buffer_needs_copy(), calc_avgy16(), calc_avgy8(), calc_cropping_offsets(), calc_diffs(), calculate_sums(), call_cuda_kernel(), call_resize_kernel(), cas_slice16(), cas_slice8(), cbs_vp8_read_unit(), cbs_vp9_assemble_fragment(), cbs_vp9_read_unit(), cbs_vp9_write_unit(), cdg_border_preset(), cdg_decode_flush(), cdg_decode_frame(), cdg_load_palette(), cdg_scroll(), cdg_tile_block(), cdxl_decode_ham6(), cdxl_decode_ham8(), cdxl_decode_raw(), cdxl_decode_rgb(), cfhd_decode(), cfhd_encode_frame(), channelmap_filter_frame(), chroma_mc_bi(), cinaudio_decode_frame(), cinvideo_decode_frame(), clear_plane(), clear_slice16(), clear_slice8(), cmv_decode_frame(), cmv_decode_inter(), cmv_decode_intra(), cng_decode_frame(), cng_encode_frame(), color_balance16(), color_balance16_p(), color_balance8(), color_balance8_p(), color_frame(), colorcontrast_slice16(), colorcontrast_slice16p(), colorcontrast_slice8(), colorcontrast_slice8p(), colorcorrect_slice16(), colorcorrect_slice8(), colorize_slice16(), colorize_slice8(), colorizey_slice16(), colorizey_slice8(), colormap_slice(), comp_block(), compare(), compare_fields(), compute_crc_of_packets(), compute_sat_hue_metrics16(), compute_sat_hue_metrics8(), config_output(), config_video_output(), control_port_cb(), conv_cuda_convert(), convert_frame(), convolve(), copy_avframe_to_pixel_buffer(), copy_block(), copy_chroma(), copy_fields(), copy_frame(), copy_frame_to_buffer(), copy_from(), copy_plane(), copy_processed_frame(), copy_uv_planes(), copyadd_block(), cover_rect(), cpia_decode_frame(), create_clusters(), create_cv_pixel_buffer(), cri_decode_frame(), cuda_bilateral_process_internal(), cuda_get_buffer(), cuda_transfer_data(), cudachromakey_process_internal(), cuvid_output_frame(), cyuv_decode_frame(), d3d11va_get_buffer(), d3d11va_transfer_data(), d3d12va_get_buffer(), d3d12va_transfer_data(), davs2_dump_frames(), dct_get(), ddagrab_request_frame(), dds_decode(), deband_16_c(), deband_16_coupling_c(), deband_8_c(), deband_8_coupling_c(), decimate_frame(), decode(), decode_alcd(), decode_argb(), decode_argb_frame(), decode_argbi(), decode_argx(), decode_argxi(), decode_avcf(), decode_aybr(), decode_aybri(), decode_block(), decode_blocks(), decode_byry(), decode_byryi(), decode_c82i(), decode_c82p(), decode_ca2i(), decode_ca2p(), decode_ca4i(), decode_ca4p(), decode_dcac(), decode_frame(), decode_frame_common(), decode_frame_lscr(), decode_huff(), decode_idat_chunk(), decode_index(), decode_index_palmap(), decode_index_tilemap(), decode_inter(), decode_inter_plane(), decode_intra(), decode_intra_plane(), decode_mad1(), decode_mad1_24(), decode_mb_row_no_filter(), decode_mvdv(), decode_packet(), decode_plane(), decode_raw_intra(), decode_raw_intra_rgb(), decode_rgb(), decode_rgb24_frame(), decode_rgbi(), decode_rgbx(), decode_rgbxi(), decode_rle(), decode_rle16(), decode_rle_bpp2(), decode_rle_bpp4(), decode_runlen(), decode_runlen_rgb(), decode_slice(), decode_slice_thread(), decode_speedhq_border(), decode_speedhq_field(), decode_tag(), decode_write(), decode_ybr(), decode_ybr10(), decode_ybr10i(), decode_ybri(), decode_ybyr(), decode_yry10(), decode_yry10i(), decode_yuv_frame(), decrypt_sync_frame(), deint_vaapi_filter_frame(), deinterlace_plane_slice(), deinterlace_slice(), deshake_transform_c(), detect_scene_change(), dfa_decode_frame(), dfpwm_dec_frame(), dfpwm_enc_frame(), diagonal_transformation(), disp_palette(), displace_packed(), displace_planar(), display_frame(), dng_decode_jpeg(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), do_alphamerge(), do_backgroundkey16_slice(), do_backgroundkey_slice(), do_chromahold16_slice(), do_chromahold_slice(), do_chromakey16_slice(), do_chromakey_slice(), do_denoise(), do_despill_slice(), do_hsvhold16_slice(), do_hsvhold_slice(), do_hsvkey16_slice(), do_hsvkey_slice(), do_lumakey_slice16(), do_lumakey_slice8(), do_morpho(), do_slice(), do_swap(), do_swizzle(), do_vflip(), downscale(), dpcm_decode_frame(), draw_axis_rgb(), draw_axis_yuv(), draw_blank_frame(), draw_carpet_slice(), draw_glyphs(), draw_gradients_slice(), draw_gradients_slice16(), draw_gradients_slice32_planar(), draw_horiz_band(), draw_mouse_pointer(), draw_qrcode(), draw_sono(), draw_spatial(), draw_text(), draw_triangle_slice(), drawline(), drawtext(), drm_get_buffer(), dss_sp_decode_frame(), dx2_decode_slice_410(), dx2_decode_slice_420(), dx2_decode_slice_444(), dx2_decode_slice_5x5(), dx2_decode_slice_rgb(), dxtory_decode_v1_410(), dxtory_decode_v1_420(), dxtory_decode_v1_444(), dxtory_decode_v1_rgb(), dxv_decode(), dxv_encode(), dxva2_get_buffer(), dxva2_map_frame(), dxva2_transfer_data_from(), dxva2_unmap_frame(), eightsvx_decode_frame(), encode(), encode_apng(), encode_bitstream(), encode_frame(), encode_gbrp10(), encode_gbrp12(), encode_headers(), encode_picture_ls(), encode_rgb48_10bit(), encode_scanline_rle(), encode_scanline_zip(), encode_slice(), encode_yuv422p10(), epx2_slice(), epx3_slice(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), evrc_decode_frame(), extend_edges(), extract_field(), extract_plane(), fade_borders16(), fade_borders8(), ff_amf_receive_packet(), ff_aom_image_copy_16_to_8(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_d3d12va_common_end_frame(), ff_d3d12va_get_surface_index(), ff_dxva2_get_surface_index(), ff_frame_pool_get(), ff_frame_to_dnn_classify(), ff_frame_to_dnn_detect(), ff_h263_decode_frame(), ff_h274_apply_film_grain(), ff_ivi_decode_frame(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mediacodec_sw_buffer_copy_yuv420_planar(), ff_mediacodec_sw_buffer_copy_yuv420_semi_planar(), ff_mjpeg_decode_frame_from_buf(), ff_mpeg4_encode_mb(), ff_opencl_filter_work_size_from_image(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_qsv_map_frame_to_surface(), ff_sws_slice_worker(), ff_vaapi_get_surface_id(), ff_vaapi_vpp_get_surface_id(), ff_vc1_interp_mc(), ff_vc1_mc_1mv(), ff_vc1_mc_4mv_chroma(), ff_vc1_mc_4mv_luma(), ff_vdpau_get_surface_id(), ff_vk_decode_prepare_frame(), ff_vk_exec_add_dep_frame(), ff_vk_exec_mirror_sem_value(), ff_vk_exec_update_frame(), ff_vk_frame_barrier(), ff_vk_set_descriptor_image(), ffat_encode_callback(), ffmal_copy_frame(), ffmmal_add_packet(), ffmmal_fill_input_port(), ffmmal_set_ref(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_picture(), fill_picture_monoblack(), fill_picture_rgb(), fill_tile4(), fill_tileX(), fill_yuv_image(), filter(), filter16_brng(), filter16_tout(), filter16_vrep(), filter8_brng(), filter8_tout(), filter8_vrep(), filter_1phase(), filter_frame(), filter_frame16(), filter_frame8(), filter_mb_row(), filter_rgb(), filter_rgb_planar(), filter_slice(), filter_slice_alpha(), filter_slice_alpha16(), filter_slice_chroma(), filter_slice_chroma16(), filter_slice_grey_edge(), filter_slice_luma(), filter_slice_luma16(), filter_slice_packed(), filter_slice_planar(), filter_slice_rgba_packed(), filter_slice_rgba_planar(), find_min_max(), find_min_max_16(), find_min_max_planar(), find_min_max_planar_16(), fits_encode_frame(), fixed_borders16(), fixed_borders8(), fixstride(), flac_decode_frame(), flac_encode_frame(), flashsv2_encode_frame(), flashsv_encode_frame(), flip(), flip_bayer(), flush_frame(), frame_copy_video(), frame_hash(), frame_is_aligned(), frame_offset(), fuzz_video_get_buffer(), g2m_decode_frame(), g722_decode_frame(), g723_1_decode_frame(), g723_1_encode_frame(), gather_data_for_cel(), gather_data_for_subcel(), gdv_decode_frame(), gem_decode_frame(), generate_missing_ref(), get_audio_buffer(), get_audio_frame(), get_cv_pixel_info(), get_encode_buffer(), get_frame_defaults(), get_frame_mb(), get_input(), get_next_ac3_eac3_sync_frame(), get_next_adts_frame(), get_pixel16_uv(), get_pixel_uv(), get_sample(), get_scene_score(), get_surface(), get_video_buffer(), get_zeropadded_input(), decklink_frame::GetBytes(), getpix(), getpix_integrate(), gif_encode_frame(), gif_fill(), gif_fill_rect(), gif_read_image(), gsm_decode_frame(), handle_p_frame_apng(), handle_p_frame_png(), handle_small_bpp(), hap_decode(), hcom_decode(), hdr_decode_frame(), hdr_encode_frame(), headphone_convolute(), headphone_fast_convolute(), hls_prediction_unit(), hnm_decode_frame(), horizontal_frame_pack(), hqx_filter(), idcin_decode_frame(), idcin_decode_vlcs(), idct_put(), ilbc_decode_frame(), ilbc_encode_frame(), import_map(), imx_decode_frame(), init(), init_image(), inject_frame(), inter_pred(), interleave_cols_to_any(), interp_lowres(), interpolate(), ipu_decode_frame(), ipvideo_decode_format_06_opcodes(), ipvideo_decode_format_10_opcodes(), ipvideo_decode_format_11_opcodes(), ir2_decode_frame(), is_frozen(), is_same1(), is_same1_16(), is_same3(), is_same3_16(), is_same4(), is_same4_16(), jpeg2000_decode_frame(), kmsgrab_read_packet(), lag_decode_frame(), lavfi_read_packet(), lead_decode_frame(), libcelt_dec_decode(), libcodec2_decode(), libcodec2_encode(), libdav1d_receive_frame(), libgsm_decode_frame(), libgsm_encode_frame(), libjxl_encode_frame(), libkvazaar_encode(), libopenjpeg_encode_frame(), libopus_decode(), libopus_encode(), librav1e_receive_packet(), librsvg_decode_frame(), libshine_encode_frame(), libspeex_decode_frame(), libuavs3d_decode_frame(), libx265_encode_frame(), libxevd_image_copy(), libxeve_encode(), ljpeg_encode_bgr(), ljpeg_encode_yuv_mb(), load_input_picture(), load_palette(), lowpass16(), luma_abs_diff(), luma_mc_bi(), m101_decode_frame(), magy_decode_frame(), magy_decode_slice(), magy_decode_slice10(), main(), map_frame_to_surface(), margins_borders16(), margins_borders8(), match_video_size(), mc_dir_part(), mediacodec_send(), mediacodec_wrap_hw_buffer(), median_16(), median_8(), mf_a_avframe_to_sample(), mf_v_avframe_to_sample(), minmax_slice16(), minmax_slice8(), mirror_borders16(), mirror_borders8(), misc4_decode(), mjpeg_decode_scan(), mlp_encode_frame(), monochrome_slice16(), monochrome_slice8(), morpho_slice(), mp3lame_encode_frame(), MPA_encode_frame(), msp2_decode_frame(), msrle_decode_8_16_24_32(), msrle_decode_pal4(), msrle_encode_frame(), mss2_decode_frame(), mvc_decode_frame(), mxpeg_check_dimensions(), mxpeg_decode_frame(), nppscale_deinterleave(), nppscale_interleave(), nppscale_resize(), nppsharpen_sharpen(), npptranspose_rotate(), npptranspose_transpose(), nvenc_copy_frame(), oggvorbis_decode_frame(), omx_encode_frame(), opencl_get_buffer(), opencl_map_frame(), opencl_transfer_data_from(), opencl_transfer_data_to(), opencl_unmap_frame(), oscilloscope_filter_frame(), output_data(), output_frame(), output_single_frame(), output_video_frame(), overlay_ass_image(), overlay_cuda_blend(), overlay_opencl_blend(), overlay_vaapi_blend(), pack_yuv(), paf_audio_decode(), pam_encode_frame(), pcm_bluray_decode_frame(), pcm_bluray_encode_frame(), pcm_decode_frame(), pcm_dvd_decode_frame(), pcm_dvd_encode_frame(), pcm_encode_frame(), pcx_decode_frame(), pcx_encode_frame(), photocd_decode_frame(), pick_color16(), pick_color8(), pick_pixel1(), pick_pixel1_16(), pick_pixel3(), pick_pixel3_16(), pick_pixel4(), pick_pixel4_16(), picmemset(), picmemset_8bpp(), pix_decode_frame(), pixelize_slice(), plot_spectrum_column(), pnm_decode_frame(), pnm_encode_frame(), postprocess_chroma(), postprocess_luma(), pp_filter_frame(), pred_regular_chroma(), predict_intra(), predict_slice(), prepare_frame(), prepare_impulse(), print_frame(), print_long_term(), print_short_term(), process(), process_16(), process_bayer(), process_frame(), process_planar(), process_planar_16(), process_slice(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), ptx_decode_frame(), push_single_pic(), put_blocks(), put_lines_bits(), put_lines_bytes(), qcelp_decode_frame(), qdm2_decode_frame(), qdmc_decode_frame(), qoa_decode_frame(), qoi_decode_frame(), qoi_encode_frame(), qsv_decode(), qsv_fill_border(), qsv_frame_lock(), qsv_get_buffer(), qsv_get_continuous_buffer(), qsv_map_from(), qsv_map_to(), qsv_transfer_data_child(), qsv_transfer_data_to(), qsvenc_fill_padding_area(), qsvenc_get_continuous_buffer(), qtrle_encode_line(), query_frame(), queue_frame(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), raw_decode(), raw_encode(), rd_frame(), rdft_horizontal16(), rdft_horizontal8(), read_highpass(), read_in_data(), read_packet_vs(), reflect_borders16(), reflect_borders8(), remap_opencl_process_frame(), render_slice(), request_frame(), rka_decode_frame(), rkmpp_retrieve_frame(), rl2_decode_frame(), roq_dpcm_encode_frame(), rpza_encode_stream(), rscc_decode_frame(), run_postproc(), run_test(), s302m_decode_frame(), s302m_encode2_frame(), sbc_encode_frame(), scale_vt_filter_frame(), scalecuda_resize(), scroll_slice(), seqvideo_decode(), set_frame_data(), set_pixel1(), set_pixel1_16(), set_pixel3(), set_pixel3_16(), set_pixel4(), set_pixel4_16(), set_processing_window(), setup_frame(), sga_decode_frame(), sgirle_decode_frame(), shuffleplanes_filter_frame(), sipr_decode_frame(), siren_decode(), skip_check(), slice_get_derivative(), smc_encode_frame(), smc_encode_stream(), smear_borders16(), smear_borders8(), smka_decode_frame(), source_request_frame(), sub2video_get_blank_frame(), sub2video_push_ref(), sub2video_update(), submit_frame(), sunrast_decode_frame(), sunrast_encode_frame(), super2xsai(), svc_decode_frame(), svc_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), svq3_mc_dir_part(), synth_superframe(), targa_encode_frame(), targa_encode_normal(), targa_encode_rle(), tdsc_decode_frame(), temperature_slice16(), temperature_slice16p(), temperature_slice32(), temperature_slice8(), temperature_slice8p(), tgq_idct_put_mb(), tgq_idct_put_mb_dconly(), tgv_decode_frame(), tgv_decode_inter(), thumbnail(), tm2_decode_blocks(), tmv_decode_frame(), to_meta_with_crop(), tonemap(), tonemap_vaapi_filter_frame(), tqi_idct_put(), transpose_vt_filter_frame(), truemotion2rt_decode_frame(), truespeech_decode_frame(), try_push_frame(), tta_decode_frame(), twolame_encode_frame(), txd_decode_frame(), uavs3d_output_callback(), ulti_convert_yuv(), uninit(), unpack_gray(), unpack_yuv(), update_histogram_diff(), update_sono_rgb(), update_sono_yuv(), upload_texture(), utvideo_encode_frame(), v210_decode_slice(), v308_decode_frame(), v308_encode_frame(), v408_decode_frame(), v408_encode_frame(), v410_decode_slice(), v410_encode_frame(), v4l2_buffer_buf_to_swframe(), v4l2_buffer_swframe_to_buf(), vaapi_encode_issue(), vaapi_encode_send_frame(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_unmap_frame(), vble_restore_plane(), vbn_decode_frame(), vbn_encode(), vc1_decode_skip_blocks(), vcr1_decode_frame(), vdpau_get_buffer(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), vectorscope16(), vectorscope8(), verify_md5(), vertical_frame_pack(), vibrance_slice16(), vibrance_slice16p(), vibrance_slice8(), vibrance_slice8p(), video_decode(), video_decode_example(), video_frame_cksum(), video_get_buffer(), videotoolbox_postproc_frame(), vmd_decode(), vmdaudio_decode_frame(), vmdvideo_decode_frame(), vp56_render_mb(), vp7_fade_frame(), vp8_lossy_decode_alpha(), vp9_raw_reorder_frame_parse(), vpx_decode(), vpx_encode(), vqa_decode_frame_pal8(), vt_get_buffer(), vt_map_frame(), vt_transfer_data_to(), vt_unmap(), vulkan_get_buffer(), vulkan_transfer_data(), wavesynth_decode(), wbmp_decode_frame(), wbmp_encode_frame(), weave_slice(), wrap_borders16(), wrap_borders8(), write_audio_frame(), ws_snd_decode_frame(), X264_frame(), x8_init_block_index(), xan_decode_frame(), xan_wc3_copy_pixel_run(), xan_wc3_output_pixel_run(), xavs2_copy_frame(), xavs2_copy_frame_with_shift(), XAVS_frame(), xbm_decode_frame(), xbm_encode_frame(), xface_decode_frame(), xface_encode_frame(), xpm_decode_frame(), xv_write_packet(), xvid_encode_frame(), xvid_encode_init(), xwd_decode_frame(), xwd_encode_frame(), y216_decode_frame(), y41p_decode_frame(), y41p_encode_frame(), yop_decode_frame(), yuv4_decode_frame(), yuv4_encode_frame(), yuv4_write_packet(), zero12v_decode_frame(), and zerocodec_decode_frame().

◆ linesize

int AVFrame::linesize[AV_NUM_DATA_POINTERS]

For video, a positive or negative value, which is typically indicating the size in bytes of each picture line, but it can also be:

  • the negative byte size of lines for vertical flipping (with data[n] pointing to the end of the data
  • a positive or negative multiple of the byte size as for accessing even and odd fields of a frame (possibly flipped)

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.

Note
The linesize may be larger than the size of usable data – there may be extra padding present for performance reasons.
Attention
In case of video, line size values can be negative to achieve a vertically inverted iteration over image lines.
Examples
decode_filter_video.c, decode_video.c, demux_decode.c, encode_video.c, hw_decode.c, mux.c, and qsv_decode.c.

Definition at line 385 of file frame.h.

Referenced by activate(), add_coefficients(), alloc_picture(), alpha_inverse_prediction(), amf_copy_surface(), aom_decode(), aom_encode(), apng_encode_frame(), apply_filter(), apply_motion_generic(), audio_get_buffer(), aura_decode_frame(), av_frame_ref(), av_frame_replace(), avcodec_fill_audio_frame(), average_slice16(), average_slice8(), averageiir2d(), avs_decode_frame(), avui_decode_frame(), avui_encode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bilateralo_planes(), bink_decode_plane(), binkb_decode_plane(), bitpacked_decode_uyvy422(), bitpacked_decode_yuv422p10(), black_counter(), blend_slice_packed_rgb(), blockdetect_filter_frame(), blur(), blur_frame(), blur_planes(), blurdetect_filter_frame(), bmp_decode_frame(), bmp_encode_frame(), buffer_needs_copy(), calc_avgy16(), calc_avgy8(), calc_cropping_offsets(), calc_diffs(), calculate_sums(), cas_slice16(), cas_slice8(), cdg_border_preset(), cdg_decode_flush(), cdg_decode_frame(), cdg_scroll(), cdg_tile_block(), cdxl_decode_ham6(), cdxl_decode_ham8(), cdxl_decode_raw(), cdxl_decode_rgb(), cfhd_decode(), cfhd_encode_frame(), chroma_mc_bi(), cinvideo_decode_frame(), clear_plane(), clear_slice16(), clear_slice8(), cmv_decode_inter(), cmv_decode_intra(), color_balance16(), color_balance16_p(), color_balance8(), color_balance8_p(), color_frame(), colorcontrast_slice16(), colorcontrast_slice16p(), colorcontrast_slice8(), colorcontrast_slice8p(), colorcorrect_slice16(), colorcorrect_slice8(), colorize_slice16(), colorize_slice8(), colorizey_slice16(), colorizey_slice8(), colormap_slice(), comp_block(), compare(), compare_fields(), compute_crc_of_packets(), compute_sat_hue_metrics16(), compute_sat_hue_metrics8(), config_output(), config_video_output(), conv_cuda_convert(), convert_frame(), copy_block(), copy_chroma(), copy_fields(), copy_frame(), copy_frame_to_buffer(), copy_from(), copy_plane(), copy_processed_frame(), copy_uv_planes(), copyadd_block(), cover_rect(), cpia_decode_frame(), create_clusters(), cri_decode_frame(), cuda_bilateral_process_internal(), cuda_get_buffer(), cuda_transfer_data(), cudachromakey_process_internal(), cuvid_output_frame(), cyuv_decode_frame(), d3d11va_transfer_data(), d3d12va_get_buffer(), d3d12va_transfer_data(), davs2_dump_frames(), dct_get(), dds_decode(), deband_16_c(), deband_16_coupling_c(), deband_8_c(), deband_8_coupling_c(), decimate_frame(), decode(), decode_alcd(), decode_argb(), decode_argb_frame(), decode_argbi(), decode_argx(), decode_argxi(), decode_avcf(), decode_aybr(), decode_aybri(), decode_block(), decode_blocks(), decode_byry(), decode_byryi(), decode_c82i(), decode_c82p(), decode_ca2i(), decode_ca2p(), decode_ca4i(), decode_ca4p(), decode_dcac(), decode_frame(), decode_frame_common(), decode_frame_lscr(), decode_huff(), decode_idat_chunk(), decode_index(), decode_index_palmap(), decode_index_tilemap(), decode_inter(), decode_inter_plane(), decode_intra(), decode_intra_plane(), decode_mad1(), decode_mad1_24(), decode_mvdv(), decode_packet(), decode_plane(), decode_raw_intra(), decode_raw_intra_rgb(), decode_rgb(), decode_rgb24_frame(), decode_rgbi(), decode_rgbx(), decode_rgbxi(), decode_rle(), decode_rle16(), decode_rle_bpp2(), decode_rle_bpp4(), decode_runlen(), decode_runlen_rgb(), decode_slice(), decode_slice_thread(), decode_speedhq_border(), decode_speedhq_field(), decode_write(), decode_ybr(), decode_ybr10(), decode_ybr10i(), decode_ybri(), decode_ybyr(), decode_yry10(), decode_yry10i(), decode_yuv_frame(), deinterlace_plane_slice(), deinterlace_slice(), deshake_transform_c(), detect_scene_change(), dfa_decode_frame(), dirac_decode_data_unit(), displace_packed(), displace_planar(), display_frame(), dng_decode_jpeg(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), dnxhd_load_picture(), do_alphamerge(), do_backgroundkey16_slice(), do_backgroundkey_slice(), do_chromahold16_slice(), do_chromahold_slice(), do_chromakey16_slice(), do_chromakey_slice(), do_denoise(), do_despill_slice(), do_hsvhold16_slice(), do_hsvhold_slice(), do_hsvkey16_slice(), do_hsvkey_slice(), do_lumakey_slice16(), do_lumakey_slice8(), do_morpho(), do_slice(), do_swap(), do_swizzle(), do_vflip(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_blank_frame(), draw_carpet_slice(), draw_glyphs(), draw_gradients_slice(), draw_gradients_slice16(), draw_gradients_slice32_planar(), draw_horiz_band(), draw_qrcode(), draw_slice(), draw_sono(), draw_spatial(), draw_text(), draw_triangle_slice(), drawline(), drawtext(), dx2_decode_slice_410(), dx2_decode_slice_420(), dx2_decode_slice_444(), dx2_decode_slice_5x5(), dx2_decode_slice_rgb(), dxtory_decode_v1_410(), dxtory_decode_v1_420(), dxtory_decode_v1_444(), dxtory_decode_v1_rgb(), dxv_decode(), dxv_encode(), dxva2_map_frame(), dxva2_transfer_data_from(), encode(), encode_bitstream(), encode_frame(), encode_gbrp10(), encode_gbrp12(), encode_picture_ls(), encode_rgb48_10bit(), encode_scanline_rle(), encode_scanline_zip(), encode_slice(), encode_yuv422p10(), epx2_slice(), epx3_slice(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), extend_edges(), extract_field(), extract_plane(), fade_borders16(), fade_borders8(), ff_alloc_picture(), ff_aom_image_copy_16_to_8(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_frame_pool_get(), ff_frame_to_dnn_classify(), ff_frame_to_dnn_detect(), ff_h263_decode_frame(), ff_h274_apply_film_grain(), ff_init_block_index(), ff_ivi_decode_frame(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mediacodec_sw_buffer_copy_yuv420_planar(), ff_mediacodec_sw_buffer_copy_yuv420_semi_planar(), ff_mjpeg_decode_frame_from_buf(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_qsv_map_frame_to_surface(), ff_sws_slice_worker(), ff_vp56_decode_mbs(), ffmal_copy_frame(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_picture(), fill_picture_monoblack(), fill_picture_rgb(), fill_tile4(), fill_tileX(), fill_yuv_image(), filter(), filter16_brng(), filter16_tout(), filter16_vrep(), filter8_brng(), filter8_tout(), filter8_vrep(), filter_1phase(), filter_frame(), filter_frame16(), filter_frame8(), filter_rgb(), filter_rgb_planar(), filter_slice(), filter_slice_alpha(), filter_slice_alpha16(), filter_slice_chroma(), filter_slice_chroma16(), filter_slice_grey_edge(), filter_slice_luma(), filter_slice_luma16(), filter_slice_packed(), filter_slice_planar(), filter_slice_rgba_packed(), filter_slice_rgba_planar(), find_min_max(), find_min_max_16(), find_min_max_planar(), find_min_max_planar_16(), fits_encode_frame(), fixed_borders16(), fixed_borders8(), fixstride(), flashsv2_encode_frame(), flip(), flip_bayer(), frame_copy_video(), frame_hash(), frame_is_aligned(), frame_offset(), fuzz_video_get_buffer(), g2m_decode_frame(), gather_data_for_cel(), gather_data_for_subcel(), gdv_decode_frame(), gem_decode_frame(), generate_missing_ref(), get_audio_buffer(), get_buffer(), get_cv_pixel_info(), get_encode_buffer(), get_frame_mb(), get_input(), get_pixel16_uv(), get_pixel_uv(), get_scene_score(), get_video_buffer(), get_zeropadded_input(), decklink_frame::GetBytes(), decklink_frame::GetFlags(), getpix(), decklink_frame::GetRowBytes(), gif_encode_frame(), gif_fill(), gif_fill_rect(), gif_read_image(), gray16(), gray8(), h264_fill_mbaff_ref_list(), h264_frame_start(), handle_p_frame_apng(), handle_p_frame_png(), handle_pic_linesizes(), handle_small_bpp(), hap_decode(), hdr_decode_frame(), hdr_encode_frame(), hls_prediction_unit(), horizontal_frame_pack(), hqx_filter(), idcin_decode_vlcs(), idct_put(), import_map(), imx_decode_frame(), init(), inject_frame(), inter_pred(), interleave_cols_to_any(), interp_lowres(), interpolate(), ipu_decode_frame(), ipvideo_decode_format_06_opcodes(), ipvideo_decode_format_10_opcodes(), ipvideo_decode_format_11_opcodes(), ir2_decode_frame(), is_frozen(), is_same1(), is_same1_16(), is_same3(), is_same3_16(), is_same4(), is_same4_16(), lag_decode_frame(), lead_decode_frame(), libdav1d_receive_frame(), libjxl_encode_frame(), libkvazaar_encode(), libopenjpeg_encode_frame(), librav1e_receive_packet(), librsvg_decode_frame(), libx265_encode_frame(), libxevd_image_copy(), libxeve_encode(), ljpeg_encode_bgr(), ljpeg_encode_yuv_mb(), load_input_picture(), load_palette(), lowpass16(), luma_abs_diff(), luma_mc_bi(), m101_decode_frame(), magy_decode_frame(), magy_decode_slice(), magy_decode_slice10(), main(), map_frame_to_surface(), margins_borders16(), margins_borders8(), mediacodec_wrap_sw_buffer(), median_16(), median_8(), mf_v_avframe_to_sample(), minmax_slice16(), minmax_slice8(), mirror_borders16(), mirror_borders8(), monochrome_slice16(), monochrome_slice8(), morpho_slice(), mp3lame_encode_frame(), msp2_decode_frame(), msrle_decode_8_16_24_32(), msrle_decode_pal4(), mss2_decode_frame(), mvc_decode_frame(), mxpeg_check_dimensions(), nppscale_deinterleave(), nppscale_interleave(), nppscale_resize(), nppsharpen_sharpen(), npptranspose_rotate(), npptranspose_transpose(), nvenc_copy_frame(), nvenc_upload_frame(), omx_encode_frame(), opencl_map_frame(), opencl_transfer_data_from(), opus_decode_packet(), oscilloscope_filter_frame(), output_frame(), output_single_frame(), output_video_frame(), overlay_ass_image(), overlay_cuda_blend(), pack_yuv(), pam_encode_frame(), pcx_decode_frame(), pcx_encode_frame(), photocd_decode_frame(), pick_color16(), pick_color8(), pick_pixel1(), pick_pixel1_16(), pick_pixel3(), pick_pixel3_16(), pick_pixel4(), pick_pixel4_16(), picmemset(), picmemset_8bpp(), pix_decode_frame(), pixelize_slice(), plot_spectrum_column(), pnm_decode_frame(), pnm_encode_frame(), postprocess_chroma(), postprocess_luma(), pp_filter_frame(), predict_intra(), predict_slice(), prepare_impulse(), process(), process_16(), process_bayer(), process_frame(), process_planar(), process_planar_16(), process_slice(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), ptx_decode_frame(), put_blocks(), put_lines_bits(), put_lines_bytes(), qoi_decode_frame(), qoi_encode_frame(), qsv_fill_border(), qsv_frame_lock(), qsv_get_continuous_buffer(), qsv_transfer_data_from(), qsvenc_fill_padding_area(), qsvenc_get_continuous_buffer(), qtrle_encode_line(), raw_decode(), raw_encode(), rd_frame(), rdft_horizontal16(), rdft_horizontal8(), read_highpass(), read_in_data(), read_packet_vs(), reflect_borders16(), reflect_borders8(), request_frame(), rl2_decode_frame(), rpza_encode_stream(), run_postproc(), run_test(), scale_field(), scalecuda_resize(), scroll_slice(), seq_decode_op1(), seq_decode_op2(), seq_decode_op3(), seqvideo_decode(), set_frame(), set_frame_data(), set_pixel1(), set_pixel1_16(), set_pixel3(), set_pixel3_16(), set_pixel4(), set_pixel4_16(), set_processing_window(), setup_frame(), sgirle_decode_frame(), shuffleplanes_filter_frame(), skip_check(), slice_get_derivative(), smc_encode_stream(), smear_borders16(), smear_borders8(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), sunrast_decode_frame(), sunrast_encode_frame(), super2xsai(), svc_decode_frame(), svc_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), targa_encode_normal(), targa_encode_rle(), tdsc_decode_frame(), temperature_slice16(), temperature_slice16p(), temperature_slice32(), temperature_slice8(), temperature_slice8p(), tgq_idct_put_mb(), tgq_idct_put_mb_dconly(), tgv_decode_frame(), tgv_decode_inter(), thumbnail(), tm2_decode_blocks(), tmv_decode_frame(), to_meta_with_crop(), tonemap(), tqi_idct_put(), truemotion2rt_decode_frame(), try_push_frame(), txd_decode_frame(), uavs3d_output_callback(), ulti_convert_yuv(), unpack_gray(), unpack_yuv(), update_histogram_diff(), update_sono_rgb(), update_sono_yuv(), upload_texture(), utvideo_encode_frame(), v210_decode_slice(), v308_decode_frame(), v308_encode_frame(), v408_decode_frame(), v408_encode_frame(), v410_decode_slice(), v410_encode_frame(), v4l2_buffer_buf_to_swframe(), v4l2_buffer_swframe_to_buf(), vaapi_map_frame(), vble_restore_plane(), vbn_decode_frame(), vbn_encode(), vcr1_decode_frame(), vdpau_transfer_data_from(), vectorscope16(), vectorscope8(), verify_md5(), vertical_frame_pack(), vibrance_slice16(), vibrance_slice16p(), vibrance_slice8(), vibrance_slice8p(), video_decode(), video_decode_example(), video_frame_cksum(), video_get_buffer(), video_image_display(), vmd_decode(), vp7_fade_frame(), vp8_lossy_decode_alpha(), vpx_decode(), vpx_encode(), vqa_decode_frame_pal8(), vt_map_frame(), vulkan_transfer_data(), wbmp_decode_frame(), wbmp_encode_frame(), weave_slice(), wrap_borders16(), wrap_borders8(), X264_frame(), x8_init_block_index(), xan_decode_frame(), xan_wc3_copy_pixel_run(), xan_wc3_output_pixel_run(), xavs2_copy_frame(), xavs2_copy_frame_with_shift(), XAVS_frame(), xbm_decode_frame(), xbm_encode_frame(), xface_decode_frame(), xface_encode_frame(), xpm_decode_frame(), xv_write_packet(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), y216_decode_frame(), y41p_decode_frame(), y41p_encode_frame(), yop_decode_frame(), yuv4_decode_frame(), yuv4_encode_frame(), yuv4_write_packet(), zero12v_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.

Examples
demux_decode.c, filter_audio.c, and transcode_aac.c.

Definition at line 401 of file frame.h.

Referenced by ac3_decode_frame(), activate(), adpcm_decode_frame(), adx_decode_frame(), alac_encode_frame(), amplify_channel(), amrnb_decode_frame(), amrwb_decode_frame(), apac_decode(), apply_window_and_mdct(), atrac1_decode_frame(), atrac3_decode_frame(), atrac3al_decode_frame(), atrac3p_decode_frame(), atrac9_decode_block(), audio_decode_frame(), audio_frame_cksum(), audio_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), av_frame_replace(), av_frame_unref(), av_hwframe_get_buffer(), avcodec_fill_audio_frame(), binkaudio_receive_frame(), bonk_decode(), celt_frame_setup_input(), channelmap_filter_frame(), compand_delay(), compand_drain(), compand_nodelay(), compute_frame_rms(), compute_frame_std_dev(), config_filter(), connect_ports(), convert_coeffs(), cook_decode_frame(), copy_input_samples(), decode_element(), decode_frame(), decode_packet(), drc_channel(), dsd_channel(), encode_frame(), fastaudio_decode(), fdk_aac_decode_frame(), ff_dca_lbr_filter_frame(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_frame_pool_get(), ff_twinvq_decode_frame(), fft_channel(), filter_channel(), filter_channel_dbl(), filter_channels(), filter_frame(), filter_frame_fixed(), filter_frame_float(), find_peak_magnitude(), fir_quantum(), flush_frame(), frame_configure_elements(), frame_copy_audio(), ftr_decode_frame(), fuzz_video_get_buffer(), g723_1_decode_frame(), get_audio_buffer(), get_frame_defaults(), get_input(), get_video_buffer(), imc_decode_frame(), libvorbis_encode_frame(), mace_decode_frame(), mcompand_channel(), mlp_encode_frame(), move_audio(), mpc7_decode_frame(), mpc8_decode_frame(), on2avc_reconstruct_channel(), on2avc_reconstruct_channel_ext(), opus_decode_packet(), osq_decode_block(), output_audio_frame(), output_frame(), pad_last_frame(), pcm_decode_frame(), pcm_encode_frame(), perform_compression(), perform_dc_correction(), plot_freqs(), process_output(), psy_channel(), push_frame(), qsvenc_get_continuous_buffer(), read_decode_convert_and_store(), receive_samples(), request_frame(), reverse_samples(), rka_decode_frame(), rnnoise_channels(), run_channel_cwt_prepare(), run_channel_fft(), sample_noise_block(), send_silence(), shorten_decode_frame(), sofalizer_convolute(), sofalizer_fast_convolute(), spatial_activate(), speex_decode_frame(), step_collect_psy_metrics(), tak_decode_frame(), take_samples(), try_push_frame(), vb_stereo(), video_get_buffer(), vorbis_decode_frame(), wavarc_decode(), wavpack_decode_block(), wavpack_encode_frame(), wma_decode_superframe(), and xma_decode_packet().

◆ width

int AVFrame::width
Examples
decode_filter_video.c, decode_video.c, demux_decode.c, encode_video.c, hw_decode.c, mux.c, qsv_decode.c, and vaapi_encode.c.

Definition at line 412 of file frame.h.

Referenced by activate(), alloc_frame(), alloc_picture(), alpha_inverse_prediction(), aom_decode(), aom_encode(), apng_encode_frame(), apply_color_indexing_transform(), apply_filter(), apply_palette(), av_buffersrc_add_frame_flags(), av_frame_apply_cropping(), av_frame_copy(), av_frame_get_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), av_frame_replace(), avcodec_default_get_buffer2(), bidirectional_obmc(), bilateral_obmc(), black_counter(), blend_frame(), blend_slice_packed_rgb(), blur(), buffer_needs_copy(), calc_diffs(), cdg_border_preset(), cfhd_decode(), clear_slice16(), clear_slice8(), close_output(), color_frame(), colorcontrast_slice16(), colorcontrast_slice16p(), colorcontrast_slice8(), colorcontrast_slice8p(), compare(), config_input(), configure_video_filters(), contain_valid_detection_bbox(), conv_cuda_convert(), copy_from(), copy_uv_planes(), cover_rect(), cuda_bilateral_process_internal(), cuda_get_buffer(), cudachromakey_process_internal(), cudaupload_filter_frame(), cuvid_output_frame(), d3d11va_get_buffer(), d3d11va_transfer_data(), d3d12va_get_buffer(), d3d12va_transfer_data(), davs2_dump_frames(), dds_decode(), decklink_write_video_packet(), decode(), decode_alcd(), decode_avcf(), decode_frame(), decode_frame_common(), decode_index(), decode_mad1(), decode_mad1_24(), decode_packet(), decode_rle(), decode_runlen_rgb(), decode_slice(), decode_speedhq_border(), decode_speedhq_field(), decode_write(), deint_vaapi_filter_frame(), display_frame(), dnn_detect_parse_yolo_output(), dnn_detect_post_proc_ssd(), dnn_detect_post_proc_tf(), do_alphamerge(), do_backgroundkey16_slice(), do_backgroundkey_slice(), do_blend(), do_chromahold16_slice(), do_chromahold_slice(), do_chromakey16_slice(), do_chromakey_slice(), do_denoise(), do_despill_slice(), do_hsvhold16_slice(), do_hsvhold_slice(), do_hsvkey16_slice(), do_hsvkey_slice(), do_lumakey_slice16(), do_lumakey_slice8(), do_slice(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_carpet_slice(), draw_glyphs(), draw_gradients_slice(), draw_gradients_slice16(), draw_gradients_slice32_planar(), draw_qrcode(), draw_text(), draw_triangle_slice(), drawtext(), drm_get_buffer(), drm_transfer_data_from(), dump_spherical(), dx2_decode_slice_410(), dx2_decode_slice_420(), dx2_decode_slice_444(), dx2_decode_slice_5x5(), dx2_decode_slice_rgb(), dxva2_get_buffer(), enc_open(), encode_apng(), encode_frame(), encode_scanline_rle(), encode_scanline_zip(), epx2_slice(), epx3_slice(), extend_edges(), ff_amf_receive_packet(), ff_dnn_fill_gettingoutput_task(), ff_encode_alloc_frame(), ff_filter_frame(), ff_frame_pool_get(), ff_frame_to_dnn_detect(), ff_h274_apply_film_grain(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mjpeg_decode_sos(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_qp_table_extract(), ff_v4l2_buffer_buf_to_avframe(), ff_vaapi_vpp_init_params(), ff_videotoolbox_alloc_frame(), ffmal_copy_frame(), fill_iplimage_from_frame(), fill_model_input_tf(), filter(), filter16_brng(), filter16_tout(), filter16_vrep(), filter8_brng(), filter8_tout(), filter8_vrep(), filter_1phase(), filter_frame(), filter_frame_ref(), filter_rgb(), filter_rgb_planar(), filter_slice_alpha(), filter_slice_alpha16(), filter_slice_chroma(), filter_slice_chroma16(), filter_slice_luma(), filter_slice_luma16(), filter_slice_packed(), filter_slice_planar(), find_min_max(), find_min_max_16(), find_min_max_planar(), find_min_max_planar_16(), fixstride(), format_init(), frame_copy_props(), frame_copy_video(), frame_hash(), fuzz_video_get_buffer(), get_buffer(), get_encode_buffer(), get_output_ov(), get_output_tf(), get_pixel16_uv(), get_pixel_uv(), get_scene_score(), get_video_buffer(), getpix(), getpix_integrate(), gif_fill(), graphs_build(), h264_field_start(), handle_p_frame_apng(), horizontal_frame_pack(), hqx_filter(), ifilter_parameters_from_frame(), import_map(), infer_completion_callback(), init(), init_filter(), init_stage(), inter_pred(), interpolate(), inverse_prediction(), ipvideo_format_06_secondpass(), kmsgrab_read_packet(), libdav1d_receive_frame(), libjxl_encode_frame(), libkvazaar_encode(), librav1e_receive_packet(), librsvg_decode_frame(), libx265_encode_set_roi(), ljpeg_encode_bgr(), load_palette(), lowpass16(), luma_abs_diff(), main(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), misc_vaapi_filter_frame(), monochrome_slice16(), monochrome_slice8(), nppscale_filter_frame_ref(), nppscale_scale(), nppsharpen_sharpen(), nvdec_av1_start_frame(), nvdec_mjpeg_start_frame(), nvdec_mpeg12_start_frame(), nvdec_mpeg4_start_frame(), nvdec_vc1_start_frame(), nvdec_vp8_start_frame(), nvdec_vp9_start_frame(), opencl_get_buffer(), opencl_map_frame(), oscilloscope_filter_frame(), output_single_frame(), output_video_frame(), overlay_ass_image(), overlay_cuda_blend(), overlay_vaapi_blend(), overlay_vulkan_blend(), pixscope_filter_frame(), pp_filter_frame(), predict_slice(), procamp_vaapi_filter_frame(), process(), process_16(), process_bayer(), process_frame(), process_planar(), process_planar_16(), qsv_fill_border(), qsv_frame_lock(), qsv_get_buffer(), qsv_get_continuous_buffer(), qsv_map_from(), qsv_map_to(), qsv_transfer_data_from(), qsvenc_fill_padding_area(), qsvenc_get_continuous_buffer(), query_frame(), queue_frame(), queue_picture(), raw_encode(), read_packet_vs(), rkmpp_retrieve_frame(), rpza_encode_frame(), scale_frame(), scale_vaapi_filter_frame(), scalecuda_resize(), scroll(), send_frame(), sender_thread(), set_frame_data(), set_processing_window(), setup_mb_info(), setup_roi(), show_frame(), shuffleplanes_filter_frame(), smc_encode_stream(), sub2video_frame(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), super2xsai(), sws_frame_start(), temperature_slice16(), temperature_slice16p(), temperature_slice32(), temperature_slice8(), temperature_slice8p(), thumbnail(), tonemap_vaapi_filter_frame(), transcode_subtitles(), transfer_data_alloc(), transpose_vaapi_filter_frame(), update_frame_pool(), update_histogram_diff(), update_sono_rgb(), update_sono_yuv(), upload_texture(), vaapi_encode_send_frame(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_transfer_data_from(), var_size_bmc(), vbn_encode(), vdpau_get_buffer(), vectorscope16(), vectorscope8(), vertical_frame_pack(), vibrance_slice16(), vibrance_slice16p(), vibrance_slice8(), vibrance_slice8p(), video_frame_cksum(), video_thread(), vk_av1_fill_pict(), vk_av1_start_frame(), vk_h264_fill_pict(), vk_h264_start_frame(), vk_hevc_fill_pict(), vk_hevc_start_frame(), vpx_encode(), vt_get_buffer(), vt_map_from(), vt_transfer_data_from(), vulkan_get_buffer(), vulkan_transfer_data(), and X264_frame().

◆ height

int AVFrame::height
Examples
decode_filter_video.c, decode_video.c, demux_decode.c, encode_video.c, hw_decode.c, mux.c, qsv_decode.c, and vaapi_encode.c.

Definition at line 412 of file frame.h.

Referenced by activate(), alloc_frame(), alloc_picture(), alpha_inverse_prediction(), aom_decode(), aom_encode(), apng_encode_frame(), apply_filter(), apply_palette(), av_buffersrc_add_frame_flags(), av_frame_apply_cropping(), av_frame_copy(), av_frame_get_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), av_frame_replace(), avcodec_default_get_buffer2(), bidirectional_obmc(), bilateral_obmc(), black_counter(), blend_frame(), blend_slice_packed_rgb(), blur(), buffer_needs_copy(), calc_diffs(), cfhd_decode(), clear_slice16(), clear_slice8(), close_output(), color_frame(), colorcontrast_slice16(), colorcontrast_slice16p(), colorcontrast_slice8(), colorcontrast_slice8p(), compare(), config_input(), configure_video_filters(), conv_cuda_convert(), copy_uv_planes(), cover_rect(), cpia_decode_frame(), cuda_bilateral_process_internal(), cuda_get_buffer(), cudachromakey_process_internal(), cudaupload_filter_frame(), cuvid_output_frame(), d3d11va_get_buffer(), d3d11va_transfer_data(), d3d12va_get_buffer(), davs2_dump_frames(), dds_decode(), decklink_write_video_packet(), decode(), decode_alcd(), decode_avcf(), decode_entropy_coded_image(), decode_frame(), decode_frame_common(), decode_index(), decode_mad1(), decode_mad1_24(), decode_packet(), decode_rle(), decode_runlen_rgb(), decode_speedhq_border(), decode_speedhq_field(), decode_write(), deint_vaapi_filter_frame(), display_frame(), dnn_detect_parse_yolo_output(), dnn_detect_post_proc_ssd(), dnn_detect_post_proc_tf(), do_alphamerge(), do_backgroundkey16_slice(), do_backgroundkey_slice(), do_blend(), do_chromahold16_slice(), do_chromahold_slice(), do_chromakey16_slice(), do_chromakey_slice(), do_denoise(), do_despill_slice(), do_hsvhold16_slice(), do_hsvhold_slice(), do_hsvkey16_slice(), do_hsvkey_slice(), do_lumakey_slice16(), do_lumakey_slice8(), do_slice(), do_swizzle(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_carpet_slice(), draw_glyphs(), draw_gradients_slice(), draw_gradients_slice16(), draw_gradients_slice32_planar(), draw_qrcode(), draw_sono(), draw_text(), draw_triangle_slice(), drawtext(), drm_get_buffer(), drm_transfer_data_from(), dump_spherical(), dx2_decode_slice_410(), dx2_decode_slice_420(), dxva2_get_buffer(), enc_open(), encode_apng(), encode_frame(), encode_scanline_rle(), encode_scanline_zip(), epx2_slice(), epx3_slice(), extend_edges(), ff_amf_receive_packet(), ff_dnn_fill_gettingoutput_task(), ff_encode_alloc_frame(), ff_filter_frame(), ff_frame_pool_get(), ff_frame_to_dnn_detect(), ff_h263_decode_frame(), ff_h274_apply_film_grain(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mjpeg_decode_frame_from_buf(), ff_mjpeg_decode_sos(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_qp_table_extract(), ff_v4l2_buffer_buf_to_avframe(), ff_vaapi_vpp_init_params(), ff_videotoolbox_alloc_frame(), ffmal_copy_frame(), fill_iplimage_from_frame(), fill_model_input_tf(), filter(), filter16_brng(), filter16_tout(), filter16_vrep(), filter8_brng(), filter8_tout(), filter8_vrep(), filter_1phase(), filter_frame(), filter_frame_ref(), filter_slice(), filter_slice_alpha(), filter_slice_alpha16(), filter_slice_chroma(), filter_slice_chroma16(), filter_slice_luma(), filter_slice_luma16(), filter_slice_packed(), filter_slice_planar(), filter_slice_rgb(), find_min_max(), find_min_max_16(), find_min_max_planar(), find_min_max_planar_16(), fixstride(), format_init(), frame_copy_props(), frame_copy_video(), frame_hash(), fuzz_video_get_buffer(), get_buffer(), get_encode_buffer(), get_output_ov(), get_output_tf(), get_pixel16_uv(), get_pixel_uv(), get_scene_score(), get_video_buffer(), decklink_frame::GetBytes(), getpix(), getpix_integrate(), gif_fill(), gif_read_image(), h264_field_start(), horizontal_frame_pack(), hqx_filter(), ifilter_parameters_from_frame(), import_map(), infer_completion_callback(), init(), init_filter(), init_stage(), inter_pred(), interpolate(), kmsgrab_read_packet(), libdav1d_receive_frame(), libjxl_encode_frame(), libkvazaar_encode(), librav1e_receive_packet(), librsvg_decode_frame(), libx265_encode_set_roi(), ljpeg_encode_bgr(), load_palette(), lowpass16(), luma_abs_diff(), main(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), misc_vaapi_filter_frame(), monochrome_slice16(), monochrome_slice8(), nppscale_filter_frame_ref(), nppscale_scale(), nppsharpen_sharpen(), nvdec_av1_start_frame(), nvdec_mjpeg_start_frame(), nvdec_mpeg12_start_frame(), nvdec_mpeg4_start_frame(), nvdec_vc1_start_frame(), nvdec_vp8_start_frame(), nvdec_vp9_start_frame(), opencl_get_buffer(), opencl_map_frame(), oscilloscope_filter_frame(), output_single_frame(), output_video_frame(), overlay_ass_image(), overlay_cuda_blend(), overlay_vaapi_blend(), overlay_vulkan_blend(), pixscope_filter_frame(), pp_filter_frame(), procamp_vaapi_filter_frame(), process(), process_16(), process_bayer(), process_frame(), process_planar(), process_planar_16(), qsv_fill_border(), qsv_frame_lock(), qsv_get_buffer(), qsv_get_continuous_buffer(), qsv_map_from(), qsv_map_to(), qsv_transfer_data_from(), qsvenc_fill_padding_area(), qsvenc_get_continuous_buffer(), query_frame(), queue_frame(), queue_picture(), raw_encode(), read_in_data(), read_packet_vs(), rkmpp_retrieve_frame(), rpza_encode_frame(), run_postproc(), scale_field(), scale_frame(), scale_vaapi_filter_frame(), scalecuda_resize(), scroll(), send_frame(), sender_thread(), set_frame_data(), set_processing_window(), setup_mb_info(), setup_roi(), show_frame(), shuffleplanes_filter_frame(), smc_encode_stream(), sub2video_frame(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), super2xsai(), sws_frame_start(), sws_scale_frame(), temperature_slice16(), temperature_slice16p(), temperature_slice32(), temperature_slice8(), temperature_slice8p(), thumbnail(), tonemap_slice(), tonemap_vaapi_filter_frame(), transcode_subtitles(), transfer_data_alloc(), transpose_vaapi_filter_frame(), update_frame_pool(), update_histogram_diff(), upload_texture(), vaapi_encode_send_frame(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_transfer_data_from(), var_size_bmc(), vbn_decode_frame(), vbn_encode(), vdpau_get_buffer(), vectorscope16(), vectorscope8(), vertical_frame_pack(), vibrance_slice16(), vibrance_slice16p(), vibrance_slice8(), vibrance_slice8p(), video_frame_cksum(), video_thread(), vk_av1_fill_pict(), vk_av1_start_frame(), vk_h264_fill_pict(), vk_h264_start_frame(), vk_hevc_fill_pict(), vk_hevc_start_frame(), vpx_encode(), vt_get_buffer(), vt_map_from(), vt_transfer_data_from(), vulkan_get_buffer(), vulkan_transfer_data(), and X264_frame().

◆ nb_samples

int AVFrame::nb_samples

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

Examples
decode_audio.c, decode_filter_audio.c, demux_decode.c, encode_audio.c, filter_audio.c, mux.c, and transcode_aac.c.

Definition at line 420 of file frame.h.

Referenced by aac_decode_er_frame(), aac_decode_frame_int(), aac_encode_frame(), ac3_decode_frame(), activate(), adpcm_decode_frame(), adx_decode_frame(), alac_encode_frame(), alloc_audio_frame(), amplify_channel(), amrnb_decode_frame(), amrwb_decode_frame(), apac_decode(), ape_decode_frame(), apply_window_and_mdct(), aptx_decode_frame(), aptx_encode_frame(), atrac1_decode_frame(), atrac3_decode_frame(), atrac3al_decode_frame(), atrac3p_decode_frame(), atrac9_decode_frame(), audio_decode_frame(), audio_frame_cksum(), audio_thread(), audio_ts_process(), av_frame_copy(), av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), av_frame_replace(), avcodec_fill_audio_frame(), binkaudio_receive_frame(), bmv_aud_decode_frame(), bonk_decode(), celt_frame_setup_input(), check_consistency(), cinaudio_decode_frame(), cng_decode_frame(), cng_encode_frame(), compand_delay(), compand_drain(), compand_nodelay(), compute_frame_rms(), compute_frame_std_dev(), consume_update(), convolve(), cook_decode_frame(), copy_input_samples(), current_segment_finished(), decode(), decode_element(), decode_frame(), decode_packet(), decode_tag(), decoder_decode_frame(), dfpwm_dec_frame(), dfpwm_enc_frame(), do_decode(), dpcm_decode_frame(), dsd_channel(), dss_sp_decode_frame(), eightsvx_decode_frame(), enc_stats_write(), encode_audio_frame(), encode_frame(), eval_pts(), evrc_decode_frame(), fastaudio_decode(), fdk_aac_decode_frame(), ff_dca_lbr_filter_frame(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_encode_encode_cb(), ff_filter_frame(), ff_frame_pool_get(), ff_framequeue_add(), ff_framequeue_skip_samples(), ff_inlink_consume_frame(), ff_inlink_make_frame_writable(), ff_twinvq_decode_frame(), ffat_decode(), ffat_encode_callback(), fft_channel(), fg_output_frame(), filter_channel(), filter_channel_dbl(), filter_channels(), filter_frame(), filter_frame_fixed(), filter_frame_float(), find_peak_magnitude(), fir_frame(), flac_decode_frame(), flac_encode_frame(), flush_frame(), frame_configure_elements(), frame_copy_audio(), frame_is_aligned(), frame_samples(), ftr_decode_frame(), g722_decode_frame(), g723_1_decode_frame(), g723_1_encode_frame(), get_audio_buffer(), get_audio_frame(), get_buffer(), get_input(), gsm_decode_frame(), hcom_decode(), headphone_convolute(), headphone_fast_convolute(), headphone_frame(), ilbc_decode_frame(), imc_decode_frame(), lavfi_read_packet(), libcelt_dec_decode(), libcodec2_decode(), libgsm_decode_frame(), libopus_decode(), libopus_encode(), libspeex_decode_frame(), libvorbis_encode_frame(), LLVMFuzzerTestOneInput(), mace_decode_frame(), main(), mf_a_avframe_to_sample(), misc4_decode(), mlp_encode_frame(), move_audio(), mp3lame_encode_frame(), mpc7_decode_frame(), mpc8_decode_frame(), oggvorbis_decode_frame(), on2avc_decode_frame(), opus_decode_packet(), osq_decode_block(), osq_receive_frame(), output_audio_frame(), output_data(), output_frame(), packet_decode(), pad_last_frame(), paf_audio_decode(), pcm_bluray_decode_frame(), pcm_bluray_encode_frame(), pcm_decode_frame(), pcm_dvd_decode_frame(), pcm_dvd_encode_frame(), pcm_encode_frame(), perform_compression(), perform_dc_correction(), print_frame(), process_output(), push_frame(), push_samples(), push_single_pic(), qcelp_decode_frame(), qdm2_decode_frame(), qdmc_decode_frame(), qoa_decode_frame(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), read_decode_convert_and_store(), receive_samples(), request_frame(), rka_decode_frame(), run_channel_cwt_prepare(), run_channel_fft(), run_test(), s302m_decode_frame(), s302m_encode2_frame(), sbc_decode_frame(), sbc_encode_frame(), select_frame(), shorten_decode_frame(), show_frame(), sipr_decode_frame(), siren_decode(), smka_decode_frame(), sofalizer_convolute(), sofalizer_fast_convolute(), spatial_activate(), speex_decode_frame(), step_collect_psy_metrics(), synth_superframe(), tak_decode_frame(), take_samples(), truespeech_decode_frame(), try_push_frame(), tta_decode_frame(), tta_encode_frame(), twolame_encode_frame(), update_frame_pool(), vb_stereo(), vmdaudio_decode_frame(), vorbis_decode_frame(), wavarc_decode(), wavesynth_decode(), wavpack_decode_block(), wavpack_encode_frame(), wma_decode_superframe(), wmapro_decode_packet(), write_audio_frame(), ws_snd_decode_frame(), and xma_decode_packet().

◆ format

int AVFrame::format

format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames, enum AVSampleFormat for audio)

Examples
demux_decode.c, encode_audio.c, encode_video.c, filter_audio.c, hw_decode.c, mux.c, and vaapi_encode.c.

Definition at line 427 of file frame.h.

Referenced by activate(), alloc_audio_frame(), alloc_frame(), alloc_picture(), amf_copy_surface(), aom_encode(), apng_encode_frame(), aptx_decode_frame(), audio_decode_frame(), audio_frame_cksum(), audio_thread(), av_buffersrc_add_frame_flags(), av_frame_apply_cropping(), av_frame_copy(), av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), av_frame_replace(), av_hwframe_get_buffer(), av_hwframe_map(), avfilter_link(), bmp_decode_frame(), celt_frame_setup_input(), clear_unused_frames(), close_output(), color_frame(), config_filter(), config_input(), config_output(), config_props(), configure_video_filters(), copy_uv_planes(), create_cv_pixel_buffer(), create_filtergraph(), cuda_get_buffer(), cuvid_output_frame(), d3d11va_get_buffer(), d3d11va_transfer_data(), d3d12va_get_buffer(), d3d12va_transfer_data(), davs2_dump_frames(), decode_frame_common(), decode_write(), deint_vaapi_filter_frame(), do_slice(), do_vflip(), downscale(), draw_qrcode(), drm_get_buffer(), drm_map_from(), drm_transfer_data_from(), dxva2_get_buffer(), dxva2_map_frame(), dxva2_map_from(), dxva2_transfer_data_from(), dxva2_transfer_data_to(), enc_open(), encode_apng(), encode_frame(), ff_amf_receive_packet(), ff_aom_image_copy_16_to_8(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_default_get_video_buffer2(), ff_encode_alloc_frame(), ff_filter_frame(), ff_frame_pool_get(), ff_frame_to_dnn_classify(), ff_frame_to_dnn_detect(), ff_h263_decode_frame(), ff_h274_apply_film_grain(), ff_libwebp_get_frame(), ff_load_image(), ff_mjpeg_decode_frame_from_buf(), ff_mjpeg_decode_sos(), ff_opencl_filter_work_size_from_image(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_qsv_map_frame_to_surface(), ff_videotoolbox_alloc_frame(), ffmal_copy_frame(), ffmmal_set_ref(), fill_frameinfo_by_link(), filter_1phase(), filter_frame(), filter_frame_ref(), fixstride(), flip_bayer(), flush_frame(), frame_copy_audio(), frame_copy_video(), frame_hash(), get_audio_buffer(), get_buffer(), get_cv_pixel_info(), get_frame_defaults(), get_input(), get_surface(), get_video_buffer(), h264_field_start(), handle_p_frame_png(), handle_pic_linesizes(), have_alpha_planar(), horizontal_frame_pack(), iccgen_filter_frame(), ifilter_parameters_from_frame(), init(), is_full_range(), jpeg2000_decode_tile(), kmsgrab_read_packet(), lavfi_read_packet(), libjxl_encode_frame(), libkvazaar_encode(), librav1e_receive_packet(), main(), map_frame_to_surface(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), misc_vaapi_filter_frame(), nppscale_filter_frame_ref(), nppscale_scale(), nvenc_copy_frame(), opencl_get_buffer(), opencl_map_frame(), opencl_map_from(), opencl_map_to(), opencl_transfer_data_from(), output_audio_frame(), output_frame(), output_single_frame(), output_video_frame(), overlay_vaapi_blend(), pad_last_frame(), pick_format(), print_digraph(), print_link_prop(), procamp_vaapi_filter_frame(), process_frame(), process_output(), push_frame(), qsv_fill_border(), qsv_frame_lock(), qsv_get_buffer(), qsv_map_from(), qsv_transfer_data_from(), qsvenc_fill_padding_area(), qsvenc_get_continuous_buffer(), queue_picture(), raw_encode(), read_in_data(), read_packet_vs(), receive_samples(), request_frame(), rkmpp_retrieve_frame(), rpza_encode_frame(), run_test(), scale_frame(), scale_vaapi_filter_frame(), send_frame(), sender_thread(), set_sdl_yuv_conversion_mode(), show_frame(), sofalizer_convolute(), sofalizer_fast_convolute(), sub2video_get_blank_frame(), submit_frame(), sws_frame_start(), take_samples(), tiff_unpack_strip(), tonemap_vaapi_filter_frame(), transfer_data_alloc(), transpose_vaapi_filter_frame(), try_push_frame(), update_frame_pool(), update_sono_yuv(), upload_texture(), v4l2_buffer_buf_to_swframe(), v4l2_buffer_swframe_to_buf(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_map_from(), vaapi_map_to_memory(), vaapi_transfer_data_from(), vaapi_vpp_frame_is_rgb(), vbn_encode(), vdpau_get_buffer(), vdpau_transfer_data_from(), verify_md5(), vertical_frame_pack(), video_frame_cksum(), video_frame_process(), video_thread(), vt_get_buffer(), vt_map_frame(), vt_map_from(), vt_transfer_data_from(), vulkan_get_buffer(), vulkan_map_from(), vulkan_transfer_data(), vulkan_transfer_data_from(), X264_frame(), and xavs2_encode_frame().

◆ key_frame

attribute_deprecated int AVFrame::key_frame

1 -> keyframe, 0-> not

Deprecated:
Use AV_FRAME_FLAG_KEY instead

Definition at line 436 of file frame.h.

Referenced by activate(), ff_encode_get_frame(), frame_copy_props(), and request_frame().

◆ pict_type

enum AVPictureType AVFrame::pict_type

Picture type of the frame.

Definition at line 442 of file frame.h.

Referenced by activate(), aom_decode(), aom_encode(), av1_frame_alloc(), avs_decode_frame(), avui_decode_frame(), bfi_decode_frame(), bitpacked_decode(), bmp_decode_frame(), cdxl_decode_frame(), cllc_decode_frame(), cmv_decode_frame(), cpia_decode_frame(), create_encoder_dict_h264(), cri_decode_frame(), davs2_dump_frames(), dds_decode(), decode_frame(), decode_frame_lscr(), decode_idat_chunk(), dirac_decode_data_unit(), dng_decode_tiles(), dnxhd_decode_frame(), do_video_out(), dvvideo_decode_frame(), dxv_decode(), eb_send_frame(), encode_frame(), ff_draw_horiz_band(), ff_mpeg4_encode_mb(), ff_print_debug_info2(), ff_vc1_parse_frame_header_adv(), ff_vp56_decode_mbs(), filter_frame(), fits_decode_frame(), frame_copy_props(), g2m_decode_frame(), gem_decode_frame(), gif_decode_frame(), h264_frame_start(), h264_select_output_frame(), hap_decode(), hdr_decode_frame(), hnm_decode_frame(), hq_hqa_decode_frame(), imx_decode_frame(), ipu_decode_frame(), jpeg2000_decode_frame(), lag_decode_frame(), lead_decode_frame(), libdav1d_receive_frame(), librsvg_decode_frame(), libuavs3d_decode_frame(), libx265_encode_frame(), m101_decode_frame(), magy_decode_frame(), mobiclip_decode(), msp2_decode_frame(), mss2_decode_frame(), mvc_decode_frame(), mxpeg_decode_frame(), nvenc_send_frame(), omx_encode_frame(), pcx_decode_frame(), photocd_decode_frame(), pix_decode_frame(), pixlet_decode_frame(), pnm_decode_frame(), pp_filter_frame(), process_frame(), ptx_decode_frame(), qoi_decode_frame(), qsv_decode(), queue_picture(), ratecontrol_1pass(), raw_decode(), request_frame(), rscc_decode_frame(), screenpresso_decode_frame(), select_frame(), set_direct_mv(), setup_frame(), sga_decode_frame(), sgirle_decode_frame(), show_frame(), sunrast_decode_frame(), svc_encode_frame(), svq1_decode_frame(), svq1_decode_frame_header(), tdsc_decode_frame(), testsrc_vulkan_activate(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), truemotion2rt_decode_frame(), txd_decode_frame(), uavs3d_output_callback(), v308_decode_frame(), v408_decode_frame(), v410_decode_frame(), v4l2_send_frame(), vaapi_encode_send_frame(), vble_decode_frame(), vbn_decode_frame(), vc1_decode_frame(), vcr1_decode_frame(), video_frame_process(), vp8_lossless_decode_frame(), vpx_encode(), wbmp_decode_frame(), xbm_decode_frame(), xpm_decode_frame(), xvid_encode_frame(), xwd_decode_frame(), y216_decode_frame(), y41p_decode_frame(), yuv4_decode_frame(), zero12v_decode_frame(), and zerocodec_decode_frame().

◆ sample_aspect_ratio

AVRational AVFrame::sample_aspect_ratio

◆ pts

int64_t AVFrame::pts

Presentation timestamp in time_base units (time when frame should be shown to user).

Examples
decode_filter_video.c, demux_decode.c, encode_video.c, filter_audio.c, mux.c, qsv_transcode.c, transcode.c, and transcode_aac.c.

Definition at line 452 of file frame.h.

Referenced by a64multi_encode_frame(), activate(), adjust_frame_pts_to_encoder_tb(), amr_wb_encode_frame(), aom_encode(), audio_thread(), audio_ts_process(), av_buffersrc_add_frame_flags(), binkaudio_receive_frame(), cfhd_encode_frame(), compand_delay(), compand_drain(), compute_crc_of_packets(), consume_update(), copy_frame(), create_subcc_packet(), current_segment_finished(), cuvid_output_frame(), davs2_dump_frames(), ddagrab_request_frame(), dec_enc(), decode_packet(), decoder_decode_frame(), decoder_thread(), deint_vaapi_filter_frame(), display_frame(), dnn_classify_flush_frame(), dnn_detect_flush_frame(), do_audio_out(), do_blend(), do_video_out(), draw_spatial(), draw_text(), eb_send_frame(), enc_stats_write(), encode(), encode_audio_frame(), encode_frame(), encode_superframe(), encode_write_frame(), ff_ac3_encode_frame_common_end(), ff_amf_receive_packet(), ff_encode_encode_cb(), ff_framesync_dualinput_get(), ff_inlink_evaluate_timeline_at_frame(), ff_inlink_process_commands(), ff_qsvvpp_filter_frame(), ff_rate_estimate_qscale(), ff_v4l2_buffer_avframe_to_buf(), ff_v4l2_buffer_buf_to_avframe(), ff_yadif_filter_frame(), ff_yadif_request_frame(), ffat_decode(), ffmal_copy_frame(), ffmmal_add_packet(), ffmmal_fill_input_port(), fg_output_frame(), fg_output_step(), filter_callback(), filter_frame(), filter_frame_ref(), filter_thread(), fir_frame(), flac_encode_frame(), flush_frame(), forced_kf_apply(), forward_frame(), frame_copy_props(), frame_data_submit(), frame_end(), framesync_inject_frame(), geq_filter_frame(), get_audio_frame(), get_best_frame(), get_frame(), get_frame_defaults(), get_input(), get_video_frame(), handle_input(), headphone_frame(), interpolate(), lavfi_read_packet(), libkvazaar_encode(), librav1e_receive_packet(), libuavs3d_decode_frame(), libwebp_anim_encode_frame(), libx265_encode_frame(), libxevd_return_frame(), libxeve_encode(), load_input_picture(), main(), map_frame_to_surface(), mediacodec_buffer_release(), mediacodec_send(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), mf_avframe_to_sample(), misc_vaapi_filter_frame(), MPA_encode_frame(), nppscale_filter_frame_ref(), nppscale_scale(), nvenc_send_frame(), omx_encode_frame(), output_audio_frame(), output_frame(), output_single_frame(), overlay_cuda_blend(), overlay_vaapi_blend(), packet_decode(), plot_spectrum_column(), procamp_vaapi_filter_frame(), process_frame(), push_frame(), push_samples(), qsv_decode(), read_frame(), request_frame(), return_frame(), rkmpp_retrieve_frame(), roq_dpcm_encode_frame(), scale_frame(), scale_vaapi_filter_frame(), select_frame(), send_frame(), send_silence(), set_output_frame(), setup_frame(), shift_frame(), show_frame(), sierpinski_request_frame(), source_request_frame(), spatial_activate(), sub2video_frame(), sub2video_push_ref(), submit_frame(), svc_decode_frame(), svc_encode_frame(), testsrc_vulkan_activate(), tonemap_vaapi_filter_frame(), transcode_subtitles(), transpose_vaapi_filter_frame(), try_push_frame(), twolame_encode_frame(), uavs3d_output_callback(), update(), update_context(), update_mono_detection(), update_out_phase_detection(), vaapi_encode_send_frame(), video_decode_example(), video_duration_estimate(), video_frame_process(), video_sync_process(), video_thread(), vmd_read_packet(), vp9_decode_frame(), vp9_raw_reorder_filter(), vp9_raw_reorder_make_output(), vpx_encode(), vtenc_frame(), vtenc_send_frame(), wma_decode_superframe(), write_audio_frame(), write_frame(), write_uncoded_frame_internal(), xavs2_encode_frame(), XAVS_frame(), xfade_activate(), and xfade_opencl_activate().

◆ pkt_dts

int64_t AVFrame::pkt_dts

◆ time_base

AVRational AVFrame::time_base

◆ coded_picture_number

attribute_deprecated int AVFrame::coded_picture_number

picture number in bitstream order

Definition at line 474 of file frame.h.

Referenced by ff_mpv_frame_start(), frame_copy_props(), h264_frame_start(), show_frame(), and uavs3d_output_callback().

◆ display_picture_number

attribute_deprecated int AVFrame::display_picture_number

picture number in display order

Definition at line 479 of file frame.h.

Referenced by dirac_decode_frame(), frame_copy_props(), get_delayed_pic(), show_frame(), and uavs3d_output_callback().

◆ quality

int AVFrame::quality

quality (between 1 (good) and FF_LAMBDA_MAX (bad))

Definition at line 485 of file frame.h.

Referenced by cinepak_encode_frame(), do_video_out(), encode_frame(), filter_1phase(), frame_copy_props(), ratecontrol_1pass(), roq_encode_frame(), svq1_encode_frame(), and xvid_encode_frame().

◆ opaque

void* AVFrame::opaque

Frame owner's private data.

This field may be set by the code that allocates/owns the frame data. It is then not touched by any library functions, except:

See also
opaque_ref the reference-counted analogue

Definition at line 501 of file frame.h.

Referenced by decoder_thread(), ff_encode_reordered_opaque(), fg_send_command(), filter_thread(), frame_copy_props(), frame_data_submit(), handle_input(), librav1e_receive_packet(), libwebp_anim_encode_frame(), libx265_encode_frame(), list_add_frame(), list_remove_head(), map_frame(), nvenc_store_frame_data(), output_frame(), setup_frame(), transcode_subtitles(), and vaapi_encode_send_frame().

◆ repeat_pict

int AVFrame::repeat_pict

Number of fields in this frame which should be repeated, i.e.

the total duration of this frame should be repeat_pict + 2 normal field durations.

For interlaced frames this field may be set to 1, which signals that this frame should be presented as 3 fields: beginning with the first field (as determined by AV_FRAME_FLAG_TOP_FIELD_FIRST being set or not), followed by the second field, and then the first field again.

For progressive frames this field may be set to a multiple of 2, which signals that this frame's duration should be (repeat_pict + 2) / 2 normal frame durations.

Note
This field is computed from MPEG2 repeat_first_field flag and its associated flags, H.264 pic_struct from picture timing SEI, and their analogues in other codecs. Typically it should only be used when higher-layer timing information is not available.

Definition at line 521 of file frame.h.

Referenced by ff_yadif_filter_frame(), filter_frame(), frame_copy_props(), qsv_decode(), show_frame(), submit_frame(), and video_duration_estimate().

◆ interlaced_frame

attribute_deprecated int AVFrame::interlaced_frame

The content of the picture is interlaced.

Deprecated:
Use AV_FRAME_FLAG_INTERLACED instead

Definition at line 530 of file frame.h.

Referenced by activate(), ff_encode_get_frame(), ff_yadif_filter_frame(), filter(), filter_frame(), frame_copy_props(), get_frame(), query_frame(), request_frame(), and return_frame().

◆ top_field_first

attribute_deprecated int AVFrame::top_field_first

If the content is interlaced, is top field displayed first.

Deprecated:
Use AV_FRAME_FLAG_TOP_FIELD_FIRST instead

Definition at line 538 of file frame.h.

Referenced by ff_encode_get_frame(), filter(), filter_frame(), and frame_copy_props().

◆ palette_has_changed

attribute_deprecated int AVFrame::palette_has_changed

◆ reordered_opaque

attribute_deprecated 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

Deprecated:
Use AV_CODEC_FLAG_COPY_OPAQUE instead

Definition at line 561 of file frame.h.

Referenced by ff_encode_reordered_opaque(), frame_copy_props(), frame_data_submit(), libdav1d_receive_frame(), librav1e_receive_packet(), libwebp_anim_encode_frame(), libx265_encode_frame(), nvenc_store_frame_data(), and setup_frame().

◆ sample_rate

int AVFrame::sample_rate

◆ channel_layout

attribute_deprecated uint64_t AVFrame::channel_layout

◆ buf

AVBuffer references backing the data for this frame.

All the pointers in data and extended_data must point inside one of the buffers in buf or extended_buf. 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.

Definition at line 590 of file frame.h.

Referenced by alloc_frame(), audio_get_buffer(), av1_receive_frame_internal(), av_buffersrc_add_frame_flags(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_ref(), av_frame_replace(), av_frame_unref(), av_hwframe_transfer_data(), avcodec_send_frame(), avcodec_send_packet(), bitpacked_decode_uyvy422(), close_output(), cuda_get_buffer(), d3d11va_get_buffer(), d3d12va_get_buffer(), davs2_dump_frames(), ddagrab_request_frame(), do_swap(), drm_get_buffer(), dxva2_get_buffer(), encode_simple_internal(), ff_amf_receive_packet(), ff_decode_receive_frame(), ff_encode_get_frame(), ff_encode_receive_frame(), ff_frame_pool_get(), ff_h264_build_ref_list(), ff_h264_ref_picture(), ff_h264_unref_picture(), ff_hevc_set_new_ref(), ff_hevc_unref_frame(), ff_hwframe_map_create(), ff_hwframe_map_replace(), ff_mpeg_ref_picture(), ff_nvenc_receive_packet(), ff_print_debug_info2(), ff_videotoolbox_alloc_frame(), ff_vk_decode_frame(), ff_vvc_set_new_ref(), ff_vvc_unref_frame(), ffmmal_set_ref(), fg_output_frame(), fg_send_command(), filter_thread(), fix_sub_duration_heartbeat(), flashsv_encode_frame(), frame_add_buf(), frame_context_setup(), frame_encode(), frame_needs_copy(), frame_worker_thread(), fuzz_video_get_buffer(), generate_missing_ref(), get_audio_buffer(), get_video_buffer(), h264_decode_frame(), h264_initialise_ref_list(), h264_slice_init(), kmsgrab_read_packet(), libdav1d_receive_frame(), librav1e_receive_packet(), mediacodec_wrap_hw_buffer(), nvenc_send_frame(), opencl_get_buffer(), pic_is_unused(), process_subtitle(), qsv_frame_lock(), qsv_get_buffer(), qsv_get_continuous_buffer(), qsv_transfer_data_child(), qsvenc_get_continuous_buffer(), raw_decode(), read_packet_vs(), rkmpp_retrieve_frame(), sch_dec_send(), send_to_enc(), sub2video_frame(), subtitle_wrap_frame(), sws_frame_start(), try_push_frame(), v4l2_buffer_buf_to_swframe(), v4l2_buffer_swframe_to_buf(), v4l2_receive_packet(), vaapi_get_buffer(), vdpau_get_buffer(), video_get_buffer(), videotoolbox_postproc_frame(), vp8_find_free_buffer(), vpx_decode(), vt_get_buffer(), vulkan_get_buffer(), and wait_delayed_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 604 of file frame.h.

Referenced by audio_get_buffer(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_ref(), av_frame_replace(), av_frame_unref(), ff_frame_pool_get(), get_audio_buffer(), and try_push_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 649 of file frame.h.

Referenced by activate(), alloc_frame(), aom_decode(), av1_frame_alloc(), avs_decode_frame(), avui_decode_frame(), bfi_decode_frame(), bitpacked_decode(), bmp_decode_frame(), cdxl_decode_frame(), cfhd_decode(), cllc_decode_frame(), cmv_decode_frame(), copy_frame(), cpia_decode_frame(), cri_decode_frame(), cuvid_output_frame(), dds_decode(), decode_frame(), decode_frame_lscr(), decode_idat_chunk(), decode_slice(), deint_vaapi_filter_frame(), deinterlace_plane_slice(), deinterlace_slice(), dirac_decode_data_unit(), dng_decode_tiles(), dnxhd_decode_frame(), dnxhd_decode_header(), dnxhd_decode_macroblock(), dnxhd_load_picture(), do_video_out(), dvvideo_decode_frame(), dxv_decode(), enc_open(), encode_frame(), encode_slice(), eval_pts(), ff_dxva2_hevc_fill_picture_parameters(), ff_encode_get_frame(), ff_hevc_bump_frame(), ff_hevc_output_frame(), ff_hevc_unref_frame(), ff_v4l2_buffer_buf_to_avframe(), ff_vp56_decode_mbs(), ff_vvc_bump_frame(), ff_vvc_output_frame(), ff_vvc_unref_frame(), ff_yadif_filter_frame(), ffmal_copy_frame(), ffmmal_add_packet(), ffmmal_fill_input_port(), ffmmal_read_frame(), ffmmal_stop_decoder(), fg_output_frame(), fill_vaapi_pic(), filter(), filter_frame(), filter_slice(), fits_decode_frame(), forced_kf_apply(), frame_copy_props(), g2m_decode_frame(), gem_decode_frame(), generate_missing_ref(), get_frame(), get_frame_defaults(), gif_decode_frame(), h264_frame_start(), hap_decode(), hdr_decode_frame(), hnm_decode_frame(), hq_hqa_decode_frame(), imx_decode_frame(), ipu_decode_frame(), jpeg2000_decode_frame(), lag_decode_frame(), lead_decode_frame(), libdav1d_receive_frame(), librsvg_decode_frame(), m101_decode_frame(), magy_decode_frame(), mark_ref(), mobiclip_decode(), msp2_decode_frame(), mss2_decode_frame(), mvc_decode_frame(), mxpeg_decode_frame(), nvenc_send_frame(), output_frame(), packet_decode(), photocd_decode_frame(), pix_decode_frame(), pixlet_decode_frame(), pnm_decode_frame(), prores_encode_frame(), qoi_decode_frame(), qsv_decode(), query_frame(), raw_decode(), reconfig_encoder(), request_frame(), return_frame(), rkmpp_retrieve_frame(), rscc_decode_frame(), scale_frame(), screenpresso_decode_frame(), select_frame(), setup_roi(), sga_decode_frame(), sgirle_decode_frame(), show_frame(), speedhq_decode_frame(), submit_frame(), tdsc_decode_frame(), testsrc_vulkan_activate(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), truemotion2rt_decode_frame(), uavs3d_output_callback(), v308_decode_frame(), v408_decode_frame(), v410_decode_frame(), vble_decode_frame(), vbn_decode_frame(), vc1_decode_frame(), vcr1_decode_frame(), vdpau_hevc_start_frame(), video_frame_process(), video_sync_process(), vp8_lossless_decode_frame(), wbmp_decode_frame(), xbm_decode_frame(), xpm_decode_frame(), xwd_decode_frame(), y216_decode_frame(), y41p_decode_frame(), yuv4_decode_frame(), zero12v_decode_frame(), and zerocodec_decode_frame().

◆ 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

frame timestamp estimated using various heuristics, in stream time base

  • encoding: unused
  • decoding: set by libavcodec, read by user.
Examples
decode_filter_video.c, and transcode.c.

Definition at line 676 of file frame.h.

Referenced by decode_packet(), decoder_decode_frame(), frame_copy_props(), get_frame_defaults(), main(), show_frame(), and video_frame_process().

◆ pkt_pos

attribute_deprecated int64_t AVFrame::pkt_pos

reordered pos from the last AVPacket that has been input into the decoder

  • encoding: unused
  • decoding: Read by user.
    Deprecated:
    use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user data from packets to frames

Definition at line 687 of file frame.h.

Referenced by copy_frame(), create_subcc_packet(), cuvid_output_frame(), do_blend(), eval_pts(), ff_inlink_evaluate_timeline_at_frame(), filter_frame(), filter_frame_ref(), frame_copy_props(), get_frame_defaults(), lavfi_read_packet(), nppscale_filter_frame_ref(), nppscale_scale(), overlay_cuda_blend(), scale_frame(), select_frame(), set_output_frame(), and uavs3d_output_callback().

◆ pkt_duration

attribute_deprecated int64_t AVFrame::pkt_duration

duration of the corresponding packet, expressed in AVStream->time_base units, 0 if unknown.

  • encoding: unused
  • decoding: Read by user.

    Deprecated:
    use duration instead

Definition at line 700 of file frame.h.

Referenced by ff_filter_frame(), filter_frame(), frame_copy_props(), get_frame_defaults(), send_frame(), show_frame(), and write_uncoded_frame_internal().

◆ metadata

AVDictionary* AVFrame::metadata

◆ decode_error_flags

int AVFrame::decode_error_flags

decode error flags of the frame, set to a combination of FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there were errors during the decoding.

  • encoding: unused
  • decoding: set by libavcodec, read by user.

Definition at line 717 of file frame.h.

Referenced by ac3_decode_frame(), cpia_decode_frame(), ff_v4l2_buffer_buf_to_avframe(), frame_copy_props(), output_frame(), and packet_decode().

◆ channels

attribute_deprecated int AVFrame::channels

◆ pkt_size

attribute_deprecated int AVFrame::pkt_size

size of the corresponding packet containing the compressed frame.

It is set to a negative value if unknown.

  • encoding: unused
  • decoding: set by libavcodec, read by user.
    Deprecated:
    use AV_CODEC_FLAG_COPY_OPAQUE to pass through arbitrary user data from packets to frames

Definition at line 745 of file frame.h.

Referenced by copy_frame(), cuvid_output_frame(), filter_frame(), frame_copy_props(), get_frame_defaults(), set_output_frame(), and uavs3d_output_callback().

◆ hw_frames_ctx

AVBufferRef* AVFrame::hw_frames_ctx

◆ opaque_ref

AVBufferRef* AVFrame::opaque_ref

Frame owner's private data.

This field may be set by the code that allocates/owns the frame data. It is then not touched by any library functions, except:

See also
opaque the plain pointer analogue

Definition at line 768 of file frame.h.

Referenced by audio_thread(), av_frame_unref(), enc_open(), enc_stats_write(), ff_encode_reordered_opaque(), frame_copy_props(), frame_data(), frame_data_c(), frame_data_submit(), librav1e_receive_packet(), libwebp_anim_encode_frame(), libx265_encode_frame(), nvenc_store_frame_data(), setup_frame(), show_frame(), vaapi_encode_send_frame(), and video_thread().

◆ crop_top

size_t AVFrame::crop_top

◆ crop_bottom

size_t AVFrame::crop_bottom

◆ crop_left

size_t AVFrame::crop_left

◆ crop_right

size_t AVFrame::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.

Definition at line 797 of file frame.h.

Referenced by av_frame_unref(), ff_nvdec_get_ref_idx(), ff_nvdec_start_frame(), ff_nvdec_start_frame_sep_ref(), ff_videotoolbox_alloc_frame(), frame_copy_props(), nvdec_av1_start_frame(), nvdec_mjpeg_start_frame(), nvdec_mpeg12_start_frame(), nvdec_mpeg4_start_frame(), nvdec_retrieve_data(), nvdec_vc1_start_frame(), nvdec_vp8_start_frame(), and nvdec_vp9_start_frame().

◆ ch_layout

AVChannelLayout AVFrame::ch_layout

◆ duration

int64_t AVFrame::duration

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