FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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...
 
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...
 
voidopaque
 for some private data of the user More...
 
attribute_deprecated uint64_t error [AV_NUM_DATA_POINTERS]
 
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...
 
int64_t reordered_opaque
 reordered opaque 64bit (generally an integer or a double precision float PTS but can be anything). 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
 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
 
AVBufferRefhw_frames_ctx
 For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame. More...
 
int64_t best_effort_timestamp
 frame timestamp estimated using various heuristics, in stream time base Code outside libavutil should access this field using: av_frame_get_best_effort_timestamp(frame) More...
 
int64_t pkt_pos
 reordered pos from the last AVPacket that has been input into the decoder Code outside libavutil should access this field using: av_frame_get_pkt_pos(frame) More...
 
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...
 
int channels
 number of audio channels, only used for audio. More...
 
int pkt_size
 size of the corresponding packet containing the compressed frame. More...
 
attribute_deprecated int8_t * qscale_table
 QP table Not to be accessed directly from outside libavutil. More...
 
attribute_deprecated int qstride
 QP store stride Not to be accessed directly from outside libavutil. More...
 
attribute_deprecated int qscale_type
 
AVBufferRefqp_table_buf
 Not to be accessed directly from outside libavutil. More...
 

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. Similarly fields that are marked as to be only accessed by av_opt_ptr() can be reordered. This allows 2 forks to add fields without breaking compatibility with each other.

Examples:
decoding_encoding.c, demuxing_decoding.c, filter_audio.c, filtering_audio.c, filtering_video.c, muxing.c, qsvdec.c, transcode_aac.c, and transcoding.c.

Definition at line 180 of file frame.h.

Field Documentation

uint8_t* AVFrame::data[AV_NUM_DATA_POINTERS]

pointer to the picture/channel planes.

This might be different from the first allocated byte

Some decoders access areas outside 0,0 - width,height, please see avcodec_align_dimensions2(). Some filters and swscale can read up to 16 bytes beyond the planes, if these filters are to be used, then 16 extra bytes must be allocated.

NOTE: Except for hwaccel formats, pointers not needed by the format MUST be set to NULL.

Examples:
decoding_encoding.c, demuxing_decoding.c, filtering_audio.c, filtering_video.c, muxing.c, qsvdec.c, and transcode_aac.c.

Definition at line 194 of file frame.h.

Referenced by aac_decode_er_frame(), aac_decode_frame_int(), aac_encode_frame(), aasc_decode_frame(), ac3_decode_frame(), acolor(), acolor16(), add_frame_default(), adpcm_decode_frame(), adpcm_encode_frame(), adx_encode_frame(), aflat(), aflat16(), aic_decode_slice(), alloc_frame(), alloc_frame_buffer(), alloc_frame_empty(), alloc_out_frame(), alloc_picture(), alpha_inverse_prediction(), amr_wb_encode_frame(), amrnb_decode_frame(), amrwb_decode_frame(), amv_encode_picture(), analyze_plane(), ape_decode_frame(), apng_do_inverse_blend(), apng_encode_frame(), apply_filter(), apply_loop_filter(), apply_motion_generic(), apply_palette(), apply_unsharp_c(), audio_decode_example(), audio_decode_frame(), audio_get_buffer(), aura_decode_frame(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), avcodec_decode_video2(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), avs_decode_frame(), avui_decode_frame(), avui_encode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bink_decode_plane(), binkb_decode_plane(), blend_frames16(), blend_frames8(), blend_image(), blur(), bmp_decode_frame(), bmp_encode_frame(), bmv_aud_decode_frame(), buffer_needs_copy(), buffer_offset(), burn_frame(), calc_combed_score(), calc_diffs(), 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_raw(), cdxl_decode_rgb(), cfhd_decode(), channelmap_filter_frame(), chroma(), chroma16(), chroma_mc_bi(), cinaudio_decode_frame(), cinepak_decode_frame(), cinepak_decode_vectors(), cinepak_encode_init(), cinvideo_decode_frame(), clear_image(), cmv_decode_frame(), cmv_decode_inter(), cmv_decode_intra(), cng_decode_frame(), cng_encode_frame(), color(), color16(), color_graticule(), color_graticule16(), common_uninit(), comp_block(), compare(), compare_fields(), compress_texture(), compute_crc_of_packets(), compute_sat_hue_metrics(), config_output(), config_video_output(), convert(), copy_chroma(), copy_fields(), copy_frame(), copy_frame_default(), copy_from(), copy_output(), copy_pad(), copy_picture_field(), copy_processed_frame(), cover_rect(), cpia_decode_frame(), create_clusters(), create_cv_pixel_buffer(), cuda_get_buffer(), cuda_transfer_data_from(), cuda_transfer_data_to(), cyuv_decode_frame(), dct_get(), dds_decode(), deband_16_c(), deband_8_c(), deblocking_filter_CTB(), debug_mean_error(), decimate_frame(), decklink_write_video_packet(), decode(), decode_argb_frame(), decode_b(), decode_block(), decode_frame(), decode_frame_common(), decode_idat_chunk(), decode_mb(), decode_mb_row_no_filter(), decode_nal_units(), decode_packet(), decode_pic(), decode_rgb24_frame(), decode_rle(), decode_slice(), decode_slice_thread(), decode_tag(), decode_wmv9(), decode_write_frame(), decode_yuv_frame(), decompress_texture_thread(), DEFINE_BLEND8(), deinterlace_slice(), deshake_transform_c(), dfa_decode_frame(), dirac_decode_data_unit(), dirac_decode_frame(), dirac_decode_frame_internal(), dirac_decode_picture_header(), disp_palette(), displace_packed(), displace_planar(), display_frame(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), do_chromakey_slice(), do_colorkey_slice(), do_psnr(), do_ssim(), do_swap(), do_swizzle(), downscale(), dpcm_decode_frame(), draw_axis_rgb(), draw_axis_yuv(), draw_background(), draw_bar_rgb(), draw_bar_yuv(), draw_blank_frame(), draw_char(), draw_curves(), draw_dot(), draw_frame(), draw_glyphs(), draw_horiz_band(), draw_htext(), draw_htext16(), draw_sono(), draw_text(), draw_vtext(), draw_vtext16(), drawline(), drawtext(), dss_sp_decode_frame(), dv_decode_video_segment(), dv_encode_video_segment(), 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(), dxva2_get_buffer(), dxva2_retrieve_data(), eightsvx_decode_frame(), encode_apng(), encode_bitstream(), encode_frame(), encode_gbrp10(), encode_gbrp12(), encode_headers(), encode_mb_internal(), encode_picture_ls(), encode_q_branch(), encode_rgb48_10bit(), encode_slice(), encode_thread(), envelope_instant(), envelope_instant16(), envelope_peak(), envelope_peak16(), erase_line(), erase_screen(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), evrc_decode_frame(), execute_code(), extract_field(), Faac_encode_frame(), fade(), ff_alloc_picture(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_cavs_init_pic(), ff_cavs_next_mb(), ff_color_frame(), ff_dxva2_get_surface(), ff_er_frame_end(), ff_estimate_b_frame_motion(), ff_estimate_p_frame_motion(), ff_filter_frame_framed(), ff_h263_decode_frame(), ff_h264_decode_slice_header(), ff_h264_remove_all_refs(), ff_hevc_hls_residual_coding(), ff_hevc_output_frame(), ff_init_block_index(), ff_intra_pred_8_16x16_msa(), ff_intra_pred_8_32x32_msa(), ff_ivi_decode_frame(), ff_jpegls_decode_lse(), ff_jpegls_decode_picture(), 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(), ff_mjpeg_decode_sos(), ff_mpeg4_encode_mb(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_msmpeg4_pred_dc(), ff_opencl_apply_unsharp(), ff_opencl_deshake_process_inout_buf(), ff_opencl_transform(), ff_opencl_unsharp_process_inout_buf(), ff_pre_estimate_p_frame_motion(), ff_print_debug_info2(), ff_rtjpeg_decode_frame_yuv420(), ff_rv34_decode_frame(), ff_snow_common_end(), ff_snow_frame_start(), ff_snow_get_buffer(), ff_snow_pred_block(), ff_snow_release_buffer(), ff_tlog_ref(), ff_vaapi_get_surface_id(), ff_vc1_interp_mc(), ff_vc1_mc_1mv(), ff_vc1_mc_4mv_chroma(), ff_vc1_mc_4mv_chroma4(), ff_vc1_mc_4mv_luma(), ff_vdpau_get_surface_id(), ff_video_frame_pool_get(), ff_videotoolbox_buffer_create(), ff_xvmc_decode_mb(), ff_xvmc_field_end(), ff_xvmc_field_start(), ff_xvmc_init_block(), ffat_encode_callback(), ffmal_copy_frame(), ffmmal_set_ref(), fic_decode_slice(), fic_draw_cursor(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_picture(), fill_picture_monoblack(), fill_picture_rgb(), fill_yuv_image(), filter(), filter_3x3(), filter_5x5(), filter_brng(), filter_color2(), filter_frame(), filter_mb_row(), filter_rgb(), filter_rgb24(), filter_rgb48(), filter_rgba(), filter_rgba64(), filter_slice(), filter_slice16(), filter_slice8(), filter_slice_alpha(), filter_slice_chroma(), filter_slice_luma(), filter_tout(), filter_vrep(), filter_xyz(), find_slice_quant(), fixstride(), flac_decode_frame(), flac_encode_frame(), flashsv2_encode_frame(), flashsv_decode_block(), flashsv_decode_frame(), flashsv_encode_frame(), flat(), flic_decode_frame_15_16BPP(), flic_decode_frame_8BPP(), flip(), flip_swap_frame(), frame_copy_video(), frame_end(), frame_start(), free_sequence_buffers(), g2m_decode_frame(), g722_decode_frame(), g722_encode_frame(), g723_1_decode_frame(), g723_1_encode_frame(), gather_data_for_cel(), gather_data_for_subcel(), generate_missing_ref(), geq_filter_frame(), get_4block_rd(), get_audio_buffer(), get_audio_frame(), get_block_rd(), get_buffer(), get_buffer2(), get_buffer_internal(), get_buffer_with_edge(), get_cv_pixel_info(), get_frame(), get_frame_defaults(), get_frame_mb(), get_pixel_uv(), get_sample(), get_scene_score(), get_scene_score16(), get_video_buffer(), getpix(), gif_encode_frame(), gif_fill(), gif_fill_rect(), gif_image_write_image(), gif_read_image(), graticule16_green_column(), graticule16_green_row(), graticule_green_column(), graticule_green_row(), gray_frame(), green_graticule(), green_graticule16(), gsm_decode_frame(), guess_mv(), h263_mv4_search(), h264_decode_frame(), halfpel_interpol(), handle_p_frame_apng(), handle_p_frame_png(), handle_small_bpp(), hl_decode_mb(), hls_pcm_sample(), hls_prediction_unit(), hls_transform_unit(), hnm_decode_frame(), horizontal_frame_pack(), hqx_filter(), hscroll(), idcin_decode_frame(), idcin_decode_vlcs(), idct_put(), ilbc_decode_frame(), ilbc_encode_frame(), init(), init_axis_color(), init_axis_from_file(), init_axis_from_font(), init_image(), inter_pred(), interleave_cols_to_any(), interpolate_refplane(), intra_recon(), ipvideo_decode_opcodes(), ir2_decode_frame(), irdft_horizontal(), is_intra_more_likely(), iterative_me(), jpeg2000_decode_frame(), lag_decode_frame(), lavfi_read_packet(), libcelt_dec_decode(), libgsm_decode_frame(), libgsm_encode_frame(), libkvazaar_encode(), libopenjpeg_copy_packed12(), libopenjpeg_copy_packed16(), libopenjpeg_copy_packed8(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), libopenjpeg_copy_unpacked16(), libopenjpeg_copy_unpacked8(), libopenjpeg_copyto16(), libopenjpeg_copyto8(), libopenjpeg_encode_frame(), libopus_decode(), libopus_encode(), libschroedinger_decode_frame(), libshine_encode_frame(), libspeex_decode_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(), load_palette(), loop_filter(), loopfilter_sb(), lowpass16(), luma_abs_diff(), luma_mc_bi(), luma_mc_uni(), 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(), MPV_motion_lowres(), msrle_decode_8_16_24_32(), msrle_decode_frame(), msrle_decode_pal4(), 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(), nppscale_deinterleave(), nppscale_interleave(), nppscale_resize(), nvenc_encode_frame(), oggvorbis_decode_frame(), output_data(), output_frame(), output_single_frame(), overlay_ass_image(), 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(), pick_color(), picmemset(), picmemset_8bpp(), pix_decode_frame(), plot_freqs(), plot_spectrum_column(), pnm_decode_frame(), pnm_encode_frame(), pp_filter_frame(), predict_slice(), predict_slice_buffered(), prefetch_motion(), print_frame(), print_long_term(), print_short_term(), process_frame(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), ptx_decode_frame(), push_single_pic(), put_blocks(), qcelp_decode_frame(), qdm2_decode_frame(), qsv_get_buffer(), 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(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), raw_decode(), raw_encode(), rd_frame(), rdft_horizontal(), read16_fft_bin(), read8_fft_bin(), reconstruct_and_encode_image(), ref_frame(), ref_from_h264pic(), reget_buffer_internal(), release_delayed_buffers(), remap_packed(), remap_planar(), render_default_font(), render_freetype(), render_slice(), request_frame(), rl2_decode_frame(), roq_decode_frame(), roq_dpcm_encode_frame(), rpza_decode_stream(), rscc_decode_frame(), run_postproc(), run_test(), rv30_loop_filter(), rv34_mc(), rv40_loop_filter(), s302m_decode_frame(), s302m_encode2_frame(), sao_filter_CTB(), scale_slice(), scale_vaapi_filter_frame(), screenpresso_decode_frame(), select_input_picture(), selective_color(), seqvideo_decode(), set_frame(), set_palette(), set_processing_window(), sgirle_decode_frame(), shuffleplanes_filter_frame(), sipr_decode_frame(), skip_check(), smc_decode_stream(), smka_decode_frame(), smvjpeg_decode_frame(), sofalizer_convolute(), sofalizer_fast_convolute(), sse_mb(), sub2video_get_blank_frame(), sub2video_heartbeat(), sub2video_push_ref(), sub2video_update(), submit_frame(), sunrast_decode_frame(), sunrast_encode_frame(), svc_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), svq1_encode_plane(), svq3_decode_frame(), svq3_mc_dir_part(), synth_superframe(), targa_encode_frame(), targa_encode_normal(), targa_encode_rle(), tdsc_decode_frame(), tdsc_decode_jpeg_tile(), tdsc_decode_tiles(), tdsc_parse_tdsf(), 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(), try_push_frame(), tscc2_decode_slice(), tta_decode_frame(), twolame_encode_frame(), txd_decode_frame(), ulti_convert_yuv(), uninit(), unpack_yuv(), unrefcount_frame(), update_histogram_diff(), update_histogram_frame(), update_sono_rgb(), update_sono_yuv(), utvideo_encode_frame(), v308_decode_frame(), v308_encode_frame(), v408_decode_frame(), v408_encode_frame(), v410_decode_frame(), v410_encode_frame(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_unmap_frame(), validate_avframe_allocation(), vble_restore_plane(), vc1_decode_skip_blocks(), vcr1_decode_frame(), vda_old_h264_end_frame(), vdadec_decode(), vdpau_get_buffer(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), vectorscope16(), vectorscope8(), verify_md5(), vertical_frame_pack(), video_decode(), video_decode_example(), video_encode_example(), video_get_buffer(), videotoolbox_retrieve_data(), vmd_decode(), vmdaudio_decode_frame(), vmdvideo_decode_frame(), vp56_decode_mb(), vp78_decode_frame(), vp7_fade_frame(), vp8_decode(), vp8_encode(), vp8_find_free_buffer(), vp8_lossy_decode_alpha(), vp8_mc_chroma(), vp8_mc_luma(), vp9_decode_frame(), vqa_decode_chunk(), vqa_decode_frame(), wavesynth_decode(), wavpack_encode_frame(), write_audio_frame(), write_palette(), 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(), xbr_filter(), xface_decode_frame(), xface_encode_frame(), 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().

int AVFrame::linesize[AV_NUM_DATA_POINTERS]

For video, size in bytes of each picture line.

For audio, size in bytes of each plane.

For audio, only linesize[0] may be set. For planar audio, each channel plane must be the same size.

For video the linesizes should be multiples of the CPUs alignment preference, this is 16 or 32 for modern desktop CPUs. Some code requires such alignment other code can be slower without correct alignment, for yet other it makes no difference.

Note
The linesize may be larger than the size of usable data – there may be extra padding present for performance reasons.
Examples:
decoding_encoding.c, demuxing_decoding.c, filtering_video.c, and muxing.c.

Definition at line 211 of file frame.h.

Referenced by aasc_decode_frame(), acolor(), acolor16(), add_frame_default(), aflat(), aflat16(), aic_decode_slice(), alloc_frame(), alloc_frame_buffer(), alloc_frame_empty(), alloc_out_frame(), alloc_picture(), alpha_inverse_prediction(), amv_encode_picture(), analyze_plane(), apng_do_inverse_blend(), apng_encode_frame(), apply_color_indexing_transform(), apply_filter(), apply_loop_filter(), apply_motion_generic(), apply_unsharp_c(), audio_get_buffer(), aura_decode_frame(), av_frame_ref(), available_samples(), avcodec_fill_audio_frame(), avresample_convert_frame(), avs_decode_frame(), avui_decode_frame(), avui_encode_frame(), bethsoftvid_decode_frame(), bfi_decode_frame(), bink_decode_plane(), binkb_decode_plane(), blend_frames16(), blend_frames8(), blend_image(), blur(), bmp_decode_frame(), bmp_encode_frame(), buffer_needs_copy(), buffer_offset(), burn_frame(), calc_combed_score(), calc_diffs(), cdg_border_preset(), cdg_decode_frame(), cdg_scroll(), cdg_tile_block(), cdxl_decode_ham6(), cdxl_decode_ham8(), cdxl_decode_raw(), cdxl_decode_rgb(), cfhd_decode(), checkstride(), chroma(), chroma16(), chroma_mc_bi(), cinepak_decode_vectors(), cinepak_encode_init(), cinvideo_decode_frame(), clear_image(), cmv_decode_inter(), cmv_decode_intra(), color(), color16(), color_graticule(), color_graticule16(), comp_block(), compare(), compare_fields(), compress_texture(), compute_crc_of_packets(), compute_sat_hue_metrics(), config_output(), config_video_output(), convert_frame(), copy_chroma(), copy_fields(), copy_frame(), copy_frame_default(), copy_from(), copy_output(), copy_pad(), copy_picture_field(), copy_processed_frame(), cover_rect(), cpia_decode_frame(), create_clusters(), cuda_get_buffer(), cuda_transfer_data_from(), cuda_transfer_data_to(), cyuv_decode_frame(), dct_get(), dds_decode(), deband_16_c(), deband_8_c(), deblocking_filter_CTB(), debug_mean_error(), decimate_frame(), decode(), decode_argb_frame(), decode_b(), decode_block(), decode_frame(), decode_idat_chunk(), decode_nal_units(), decode_packet(), decode_pic(), decode_rgb24_frame(), decode_rle(), decode_sb(), decode_sb_mem(), decode_slice(), decode_slice_thread(), decode_wmv9(), decode_write_frame(), decode_yuv_frame(), decompress_texture_thread(), DEFINE_BLEND8(), deinterlace_slice(), deshake_transform_c(), dfa_decode_frame(), dirac_decode_data_unit(), disp_palette(), displace_packed(), displace_planar(), display_frame(), dnxhd_decode_macroblock(), dnxhd_encode_picture(), dnxhd_load_picture(), do_chromakey_slice(), do_colorkey_slice(), do_psnr(), do_ssim(), do_swap(), do_swizzle(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_background(), draw_bar_rgb(), draw_bar_yuv(), draw_blank_frame(), draw_char(), draw_curves(), draw_dot(), draw_frame(), draw_glyphs(), draw_horiz_band(), draw_htext(), draw_htext16(), draw_slice(), draw_sono(), draw_text(), draw_vtext(), draw_vtext16(), drawline(), drawtext(), dv_decode_video_segment(), dv_encode_video_segment(), 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(), encode_apng(), encode_bitstream(), encode_frame(), encode_gbrp10(), encode_gbrp12(), encode_picture_ls(), encode_q_branch(), encode_rgb48_10bit(), encode_slice(), envelope_instant(), envelope_instant16(), envelope_peak(), envelope_peak16(), erase_line(), erase_screen(), escape124_decode_frame(), escape130_decode_frame(), estimate_best_b_count(), eval_motion_dist(), execute_code(), extract_field(), fade(), ff_alloc_picture(), ff_apply_vector_2x2(), ff_apply_vector_4x4(), ff_cavs_init_pic(), ff_color_frame(), ff_draw_horiz_band(), ff_er_frame_end(), ff_filter_frame_framed(), ff_h263_decode_frame(), ff_h264_decode_slice_header(), ff_h264_draw_horiz_band(), ff_h264_fill_mbaff_ref_list(), ff_hevc_hls_residual_coding(), ff_hevc_output_frame(), ff_init_block_index(), ff_intra_pred_8_16x16_msa(), ff_intra_pred_8_32x32_msa(), ff_ivi_decode_frame(), ff_jpegls_decode_picture(), 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(), ff_mjpeg_decode_sof(), ff_mpv_frame_start(), ff_opencl_apply_unsharp(), ff_opencl_deshake_process_inout_buf(), ff_opencl_transform(), ff_opencl_unsharp_process_inout_buf(), ff_print_debug_info2(), ff_rtjpeg_decode_frame_yuv420(), ff_snow_common_init_after_header(), ff_snow_get_buffer(), ff_snow_release_buffer(), ff_tlog_ref(), ff_vc1_interp_mc(), ff_vc1_mc_1mv(), ff_vc1_mc_4mv_chroma(), ff_vc1_mc_4mv_luma(), ff_video_frame_pool_get(), ff_vp56_decode_mbs(), ffmal_copy_frame(), fic_decode_slice(), fic_draw_cursor(), fill_frame_from_iplimage(), fill_iplimage_from_frame(), fill_picture(), fill_picture_monoblack(), fill_picture_rgb(), fill_yuv_image(), filter(), filter_3x3(), filter_5x5(), filter_brng(), filter_color2(), filter_frame(), filter_rgb(), filter_rgb24(), filter_rgb48(), filter_rgba(), filter_rgba64(), filter_slice(), filter_slice16(), filter_slice8(), filter_slice_alpha(), filter_slice_chroma(), filter_slice_luma(), filter_tout(), filter_vrep(), filter_xyz(), find_slice_quant(), fixstride(), flashsv2_encode_frame(), flashsv_decode_block(), flashsv_decode_frame(), flashsv_encode_frame(), flat(), flic_decode_frame_15_16BPP(), flic_decode_frame_8BPP(), flip(), flip_swap_frame(), frame_copy_video(), frame_end(), frame_start(), g2m_decode_frame(), gather_data_for_cel(), gather_data_for_subcel(), generate_missing_ref(), geq_filter_frame(), get_4block_rd(), get_audio_buffer(), get_block_rd(), get_buffer(), get_buffer_with_edge(), get_cv_pixel_info(), get_dc(), get_frame(), get_frame_mb(), get_pixel_uv(), get_scene_score(), get_scene_score16(), get_video_buffer(), getpix(), gif_encode_frame(), gif_fill(), gif_fill_rect(), gif_image_write_image(), gif_read_image(), graticule16_green_column(), graticule16_green_row(), graticule_green_column(), graticule_green_row(), gray_frame(), green_graticule(), green_graticule16(), guess_mv(), h264_decode_frame(), h264_frame_start(), halfpel_interpol(), hls_pcm_sample(), hls_prediction_unit(), hls_transform_unit(), horizontal_frame_pack(), hqx_filter(), hscroll(), idcin_decode_vlcs(), idct_put(), init(), init_axis_color(), init_axis_from_file(), init_axis_from_font(), init_block_index(), inter_pred(), interleave_cols_to_any(), interpolate_refplane(), intra_recon(), ipvideo_decode_opcodes(), ir2_decode_frame(), irdft_horizontal(), is_intra_more_likely(), iterative_me(), lag_decode_frame(), lavfi_read_packet(), libkvazaar_encode(), libopenjpeg_copy_packed12(), libopenjpeg_copy_packed16(), libopenjpeg_copy_packed8(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), libopenjpeg_copy_unpacked16(), libopenjpeg_copy_unpacked8(), libopenjpeg_copyto16(), libopenjpeg_copyto8(), libopenjpeg_encode_frame(), libschroedinger_decode_frame(), libx265_encode_frame(), ljpeg_encode_bgr(), ljpeg_encode_yuv_mb(), load_input_picture(), load_palette(), loopfilter_sb(), lowpass16(), luma_abs_diff(), luma_mc_bi(), luma_mc_uni(), mediacodec_wrap_buffer(), 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(), mpeg_motion_lowres(), mpv_decode_mb_internal(), msrle_decode_8_16_24_32(), msrle_decode_frame(), msrle_decode_pal4(), 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(), nppscale_deinterleave(), nppscale_interleave(), nppscale_resize(), nvenc_encode_frame(), opus_decode_packet(), output_frame(), output_single_frame(), overlay_ass_image(), pack_yuv(), paf_video_decode(), pam_encode_frame(), pcx_decode_frame(), pcx_encode_frame(), pick_color(), picmemset(), picmemset_8bpp(), pix_decode_frame(), plot_freqs(), plot_spectrum_column(), pnm_decode_frame(), pnm_encode_frame(), pp_filter_frame(), predict_slice(), predict_slice_buffered(), process_frame(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), ptx_decode_frame(), push_single_pic(), put_blocks(), 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(), raw_encode(), rd_frame(), rdft_horizontal(), read16_fft_bin(), read8_fft_bin(), reconstruct_and_encode_image(), ref_from_h264pic(), remap_packed(), remap_planar(), render_default_font(), render_freetype(), render_slice(), request_frame(), rl2_decode_frame(), rpza_decode_stream(), rscc_decode_frame(), run_postproc(), run_test(), sao_filter_CTB(), scale_slice(), screenpresso_decode_frame(), selective_color(), seq_decode_op1(), seq_decode_op2(), seq_decode_op3(), seqvideo_decode(), set_frame(), set_processing_window(), sgirle_decode_frame(), shuffleplanes_filter_frame(), skip_check(), smc_decode_stream(), smvjpeg_decode_frame(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), sunrast_decode_frame(), sunrast_encode_frame(), svc_encode_frame(), svq1_decode_frame(), svq1_encode_frame(), svq1_encode_plane(), svq3_decode_frame(), swr_convert_frame(), targa_encode_normal(), targa_encode_rle(), tdsc_decode_frame(), tdsc_decode_jpeg_tile(), tdsc_decode_tiles(), 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(), try_push_frame(), tscc2_decode_slice(), txd_decode_frame(), ulti_convert_yuv(), unpack_yuv(), unrefcount_frame(), update_histogram_diff(), update_histogram_frame(), update_sono_rgb(), update_sono_yuv(), utvideo_encode_frame(), v308_decode_frame(), v308_encode_frame(), v408_decode_frame(), v408_encode_frame(), v410_decode_frame(), v410_encode_frame(), vaapi_map_frame(), vble_restore_plane(), vc1_decode_frame(), vcr1_decode_frame(), vdadec_decode(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), vectorscope16(), vectorscope8(), verify_md5(), vertical_frame_pack(), video_decode(), video_decode_example(), video_encode_example(), video_get_buffer(), videotoolbox_retrieve_data(), vmd_decode(), vp3_draw_horiz_band(), vp7_fade_frame(), vp8_decode(), vp8_encode(), vp8_lossy_decode_alpha(), vp9_decode_frame(), vqa_decode_chunk(), write_palette(), 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(), xbr_filter(), xface_decode_frame(), xface_encode_frame(), 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().

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:
demuxing_decoding.c, filter_audio.c, and transcode_aac.c.

Definition at line 227 of file frame.h.

Referenced by adpcm_decode_frame(), adpcm_encode_frame(), adx_decode_frame(), alac_encode_frame(), amplify_frame(), apply_window_and_mdct(), atrac1_decode_frame(), atrac3_decode_frame(), atrac3p_decode_frame(), audio_decode_frame(), audio_frame_cksum(), audio_get_buffer(), av_buffersink_get_samples(), av_frame_alloc(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_move_ref(), av_frame_ref(), avcodec_decode_audio4(), avcodec_decode_video2(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), buffer_offset(), calc_ptr_alignment(), channelmap_filter_frame(), compand_delay(), compand_nodelay(), compute_frame_rms(), compute_frame_std_dev(), convert_frame(), cook_decode_frame(), copy_input_samples(), decode_element(), decode_frame(), decode_packet(), encode_frame(), fdk_aac_decode_frame(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_twinvq_decode_frame(), ff_video_frame_pool_get(), filter_frame(), filter_frame_fixed(), filter_frame_float(), find_peak_magnitude(), flush_buffer(), flush_frame(), frame_configure_elements(), frame_copy_audio(), get_audio_buffer(), get_frame_defaults(), get_input(), get_video_buffer(), imc_decode_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(), pcm_encode_frame(), perform_compression(), perform_dc_correction(), plot_freqs(), process_output(), push_samples(), read_decode_convert_and_store(), read_from_fifo(), release_delayed_buffers(), request_frame(), return_audio_frame(), run_fft(), send_silence(), shorten_decode_frame(), smvjpeg_decode_frame(), tak_decode_frame(), try_push_frame(), unrefcount_frame(), video_get_buffer(), vorbis_decode_frame(), vorbis_encode_frame(), wavpack_decode_block(), wavpack_encode_frame(), wma_decode_superframe(), and write_to_fifo().

int AVFrame::width

width and height of the video frame

Examples:
decoding_encoding.c, demuxing_decoding.c, filtering_video.c, muxing.c, and qsvdec.c.

Definition at line 232 of file frame.h.

Referenced by acolor(), acolor16(), aflat(), aflat16(), alloc_frame(), alloc_frame_buffer(), alloc_frame_empty(), alloc_out_frame(), alloc_picture(), alpha_inverse_prediction(), apng_do_inverse_blend(), apng_encode_frame(), apply_color_indexing_transform(), apply_color_transform(), apply_filter(), apply_palette(), apply_predictor_transform(), apply_subtract_green_transform(), av_buffersrc_add_frame_internal(), av_frame_copy(), av_frame_get_buffer(), av_frame_make_writable(), av_frame_ref(), avcodec_decode_video2(), avcodec_encode_video2(), blend_frame(), blend_image(), blur(), buffer_needs_copy(), calc_combed_score(), calc_diffs(), chroma(), chroma16(), clear_image(), color(), color16(), color_graticule(), color_graticule16(), compare(), config_input(), convert(), cover_rect(), create_cv_pixel_buffer(), cuda_get_buffer(), cudaupload_filter_frame(), dds_decode(), debug_mean_error(), decimate_frame(), decode_entropy_coded_image(), decode_entropy_image(), decode_frame(), decode_frame_common(), decode_frame_header(), decode_packet(), decode_video(), decode_write_frame(), DEFINE_BLEND8(), describe_frame_to_str(), display_frame(), do_blend(), do_chromakey_slice(), do_colorkey_slice(), do_psnr(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_bar_rgb(), draw_bar_yuv(), draw_frame(), draw_text(), dx2_decode_slice_410(), dx2_decode_slice_420(), dx2_decode_slice_444(), dx2_decode_slice_5x5(), dx2_decode_slice_rgb(), dxva2_retrieve_data(), encode_apng(), encode_frame(), envelope_instant(), envelope_instant16(), envelope_peak(), envelope_peak16(), ff_color_frame(), ff_er_frame_end(), ff_filter_frame(), ff_filter_frame_framed(), ff_get_buffer(), ff_h264_decode_slice_header(), ff_init_buffer_info(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mjpeg_decode_frame(), ff_mpv_encode_init(), ff_snow_get_buffer(), ff_tlog_ref(), ff_video_frame_pool_get(), ff_videotoolbox_alloc_frame(), fill_iplimage_from_frame(), fill_picture_parameters(), filter(), filter_brng(), filter_frame(), filter_rgb(), filter_slice(), filter_slice_alpha(), filter_slice_chroma(), filter_slice_luma(), filter_tout(), filter_vrep(), fixstride(), flat(), frame_copy_props(), frame_copy_video(), get_buffer_internal(), get_buffer_with_edge(), get_pixel_uv(), get_scene_score(), get_scene_score16(), get_video_buffer(), get_video_frame(), get_width(), getpix(), graticule16_green_column(), graticule_green_column(), gray_frame(), green_graticule(), green_graticule16(), h264_decode_frame(), horizontal_frame_pack(), hqx_filter(), hwupload_filter_frame(), init(), init_axis_from_file(), init_axis_from_font(), init_stage(), inter_pred(), inverse_prediction(), lavfi_read_packet(), libkvazaar_encode(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), ljpeg_encode_bgr(), load_palette(), lowpass16(), luma_abs_diff(), mc_chroma_scaled(), mc_luma_scaled(), mediacodec_wrap_buffer(), mismatches_ref(), nppscale_deinterleave(), nppscale_interleave(), output_frame(), output_single_frame(), overlay_ass_image(), parse_transform_color_indexing(), pp_filter_frame(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), queue_picture(), raw_encode(), reget_buffer_internal(), remap_packed(), remap_planar(), scale_vaapi_filter_frame(), selective_color(), sender_thread(), set_processing_window(), show_frame(), shuffleplanes_filter_frame(), smvjpeg_decode_frame(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), svq1_decode_frame(), tdsc_parse_tdsf(), transfer_data_alloc(), unrefcount_frame(), update_frame_pool(), update_histogram_diff(), update_histogram_frame(), update_sono_rgb(), update_sono_yuv(), vaapi_get_buffer(), vaapi_map_frame(), vdpau_get_buffer(), vectorscope16(), vectorscope8(), vertical_frame_pack(), video_encode_example(), video_thread(), videotoolbox_retrieve_data(), vp9_decode_frame(), write_palette(), and xbr_filter().

int AVFrame::height
Examples:
decoding_encoding.c, demuxing_decoding.c, filtering_video.c, muxing.c, and qsvdec.c.

Definition at line 232 of file frame.h.

Referenced by acolor(), acolor16(), aflat(), aflat16(), alloc_frame(), alloc_frame_buffer(), alloc_frame_empty(), alloc_out_frame(), alloc_picture(), alpha_inverse_prediction(), apng_do_inverse_blend(), apng_encode_frame(), apply_color_indexing_transform(), apply_color_transform(), apply_filter(), apply_palette(), apply_predictor_transform(), apply_subtract_green_transform(), av_buffersrc_add_frame_internal(), av_frame_copy(), av_frame_get_buffer(), av_frame_make_writable(), av_frame_ref(), avcodec_decode_video2(), avcodec_encode_video2(), blend_frame(), blend_frames16(), blend_frames8(), blend_image(), blur(), buffer_needs_copy(), calc_combed_score(), calc_diffs(), chroma(), chroma16(), clear_image(), color(), color16(), color_graticule(), color_graticule16(), compare(), config_input(), convert(), cover_rect(), cpia_decode_frame(), create_cv_pixel_buffer(), cuda_get_buffer(), cuda_transfer_data_from(), cuda_transfer_data_to(), cudaupload_filter_frame(), dds_decode(), debug_mean_error(), decimate_frame(), decode_entropy_coded_image(), decode_entropy_image(), decode_frame(), decode_frame_common(), decode_frame_header(), decode_packet(), decode_video(), decode_write_frame(), DEFINE_BLEND8(), describe_frame_to_str(), display_frame(), do_blend(), do_chromakey_slice(), do_colorkey_slice(), do_psnr(), do_swizzle(), downscale(), draw_axis_rgb(), draw_axis_yuv(), draw_frame(), draw_sono(), draw_text(), dxva2_retrieve_data(), encode_apng(), encode_frame(), envelope_instant(), envelope_instant16(), envelope_peak(), envelope_peak16(), ff_color_frame(), ff_er_frame_end(), ff_filter_frame(), ff_filter_frame_framed(), ff_get_buffer(), ff_h263_decode_frame(), ff_h264_decode_slice_header(), ff_init_buffer_info(), ff_libwebp_get_frame(), ff_load_image(), ff_mediacodec_sw_buffer_copy_yuv420_packed_semi_planar_64x32Tile2m8ka(), ff_mjpeg_decode_frame(), ff_mpv_encode_init(), ff_mpv_export_qp_table(), ff_opencl_deshake_process_inout_buf(), ff_opencl_unsharp_process_inout_buf(), ff_snow_get_buffer(), ff_tlog_ref(), ff_video_frame_pool_get(), ff_videotoolbox_alloc_frame(), fill_iplimage_from_frame(), fill_picture_parameters(), filter(), filter_brng(), filter_frame(), filter_slice(), filter_slice_alpha(), filter_slice_chroma(), filter_slice_luma(), filter_slice_rgb(), filter_tout(), filter_vrep(), fixstride(), flat(), flip_swap_frame(), frame_copy_props(), frame_copy_video(), get_buffer_internal(), get_buffer_with_edge(), get_height(), get_pixel_uv(), get_scene_score(), get_scene_score16(), get_video_buffer(), get_video_frame(), getpix(), gif_fill(), gif_read_image(), graticule16_green_row(), graticule_green_row(), gray_frame(), green_graticule(), green_graticule16(), guess_mv(), h264_decode_frame(), horizontal_frame_pack(), hqx_filter(), hwupload_filter_frame(), init(), init_axis_from_file(), init_axis_from_font(), init_stage(), inter_pred(), lavfi_read_packet(), libkvazaar_encode(), libopenjpeg_copy_to_packed16(), libopenjpeg_copy_to_packed8(), ljpeg_encode_bgr(), load_palette(), lowpass16(), luma_abs_diff(), mc_chroma_scaled(), mc_luma_scaled(), mediacodec_wrap_buffer(), mismatches_ref(), nppscale_deinterleave(), nppscale_interleave(), output_frame(), output_single_frame(), overlay_ass_image(), pp_filter_frame(), process_slice_uyvy422(), process_slice_yuv420p(), process_slice_yuv422p(), process_slice_yuv444p(), queue_picture(), raw_encode(), reget_buffer_internal(), remap_packed(), remap_planar(), run_postproc(), scale_vaapi_filter_frame(), selective_color(), sender_thread(), set_processing_window(), show_frame(), shuffleplanes_filter_frame(), smvjpeg_decode_frame(), sub2video_get_blank_frame(), sub2video_update(), submit_frame(), svq1_decode_frame(), tdsc_parse_tdsf(), transfer_data_alloc(), unrefcount_frame(), update_frame_pool(), update_histogram_diff(), update_histogram_frame(), vaapi_get_buffer(), vaapi_map_frame(), vdpau_get_buffer(), vectorscope16(), vectorscope8(), vertical_frame_pack(), video_encode_example(), video_thread(), videotoolbox_retrieve_data(), vp8_encode(), vp9_decode_frame(), write_palette(), and xbr_filter().

int AVFrame::nb_samples

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

Examples:
decoding_encoding.c, demuxing_decoding.c, filter_audio.c, filtering_audio.c, muxing.c, and transcode_aac.c.

Definition at line 237 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(), amplify_frame(), 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(), audio_frame_cksum(), audio_thread(), av_buffersink_get_samples(), av_frame_copy(), av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), avcodec_decode_audio4(), avcodec_encode_audio2(), avcodec_fill_audio_frame(), avresample_convert_frame(), bmv_aud_decode_frame(), buffer_offset(), cinaudio_decode_frame(), cng_decode_frame(), cng_encode_frame(), compand_delay(), compand_drain(), compand_nodelay(), compute_frame_rms(), compute_frame_std_dev(), config_input(), config_output(), convert_frame(), cook_decode_frame(), copy_input_samples(), decode_audio(), decode_element(), decode_frame(), decode_packet(), decode_tag(), decoder_decode_frame(), describe_frame_to_str(), do_audio_out(), dpcm_decode_frame(), dss_sp_decode_frame(), eightsvx_decode_frame(), encode_audio_frame(), encode_frame(), evrc_decode_frame(), Faac_encode_frame(), fdk_aac_decode_frame(), ff_af_queue_add(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_filter_frame(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_tlog_ref(), ff_twinvq_decode_frame(), ffat_decode(), ffat_encode_callback(), filter_frame(), filter_frame_fixed(), filter_frame_float(), find_peak_magnitude(), flac_decode_frame(), flac_encode_frame(), flush(), flush_buffer(), flush_frame(), frame_configure_elements(), frame_copy_audio(), g722_decode_frame(), g722_encode_frame(), g723_1_decode_frame(), g723_1_encode_frame(), get_audio_buffer(), get_input(), gsm_decode_frame(), ilbc_decode_frame(), imc_decode_frame(), lavfi_read_packet(), libcelt_dec_decode(), 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(), oggvorbis_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(), perform_compression(), perform_dc_correction(), plot_freqs(), print_frame(), process_output(), push_frame(), push_samples(), push_single_pic(), qcelp_decode_frame(), qdm2_decode_frame(), ra144_decode_frame(), ra144_encode_frame(), ra288_decode_frame(), read_decode_convert_and_store(), request_frame(), return_audio_frame(), run_test(), s302m_decode_frame(), s302m_encode2_frame(), select_frame(), shorten_decode_frame(), show_frame(), sipr_decode_frame(), smka_decode_frame(), sofalizer_convolute(), sofalizer_fast_convolute(), swr_convert_frame(), synth_superframe(), tak_decode_frame(), truespeech_decode_frame(), try_push_frame(), tta_decode_frame(), tta_encode_frame(), twolame_encode_frame(), unrefcount_frame(), update_frame_pool(), vmdaudio_decode_frame(), vorbis_decode_frame(), vorbis_encode_frame(), wavesynth_decode(), wavpack_decode_block(), wavpack_encode_frame(), wma_decode_superframe(), write_audio_frame(), write_to_fifo(), and ws_snd_decode_frame().

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:
decoding_encoding.c, demuxing_decoding.c, filter_audio.c, and muxing.c.

Definition at line 244 of file frame.h.

Referenced by alloc_audio_frame(), alloc_frame(), alloc_frame_buffer(), alloc_frame_empty(), alloc_picture(), apng_do_inverse_blend(), apng_encode_frame(), audio_decode_frame(), audio_encode_example(), audio_frame_cksum(), audio_thread(), av_buffersrc_add_frame_internal(), av_frame_copy(), av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), available_samples(), avcodec_decode_audio4(), avcodec_decode_video2(), avcodec_encode_video2(), avresample_config(), bmp_decode_frame(), calc_ptr_alignment(), config_changed(), config_input(), config_output(), copy_frame(), create_cv_pixel_buffer(), create_filtergraph(), cuda_get_buffer(), decode_audio(), decode_entropy_coded_image(), decode_frame(), decode_frame_common(), decode_frame_header(), decode_packet(), decode_video(), downscale(), draw_axis_yuv(), draw_bar_yuv(), draw_sono(), dxva2_get_buffer(), encode_apng(), encode_frame(), ff_color_frame(), ff_dca_xll_filter_frame(), ff_default_get_audio_buffer(), ff_er_frame_end(), ff_filter_frame(), ff_filter_frame_framed(), ff_h263_decode_frame(), ff_h264_decode_slice_header(), ff_hevc_output_frame(), ff_init_buffer_info(), ff_jpegls_decode_lse(), ff_libwebp_get_frame(), ff_load_image(), ff_mjpeg_decode_frame(), ff_mpv_encode_init(), ff_snow_common_init_after_header(), ff_video_frame_pool_get(), ff_videotoolbox_alloc_frame(), ffmmal_set_ref(), filter(), filter_frame(), fixstride(), frame_copy_audio(), frame_copy_video(), get_audio_buffer(), get_buffer(), get_cv_pixel_info(), get_frame_defaults(), get_input(), get_video_buffer(), gray_frame(), h264_decode_frame(), handle_p_frame_png(), horizontal_frame_pack(), hwupload_filter_frame(), init(), init_axis_from_file(), init_axis_from_font(), jpeg2000_decode_tile(), lavfi_read_packet(), libkvazaar_encode(), libopenjpeg_copy_to_packed16(), libopenjpeg_copyto16(), mediacodec_wrap_buffer(), mismatches_ref(), movie_push_frame(), mss2_decode_frame(), output_frame(), output_single_frame(), pad_last_frame(), process_output(), queue_picture(), raw_encode(), reget_buffer_internal(), request_frame(), run_test(), scale_vaapi_filter_frame(), sender_thread(), show_frame(), smvjpeg_decode_frame(), sub2video_get_blank_frame(), submit_frame(), swr_config_frame(), tdsc_init(), tiff_unpack_strip(), transfer_data_alloc(), try_push_frame(), unrefcount_frame(), update_frame_pool(), update_sono_yuv(), vaapi_get_buffer(), vaapi_map_frame(), vaapi_transfer_data_from(), vaapi_transfer_data_to(), validate_avframe_allocation(), vdadec_decode(), vdpau_get_buffer(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), verify_md5(), vertical_frame_pack(), video_encode_example(), video_get_buffer(), video_thread(), and videotoolbox_retrieve_data().

int AVFrame::key_frame

1 -> keyframe, 0-> not

Definition at line 249 of file frame.h.

Referenced by aic_decode_frame(), avs_decode_frame(), avui_decode_frame(), bfi_decode_frame(), bmp_decode_frame(), bmp_encode_frame(), cinepak_decode(), cllc_decode_frame(), cmv_decode_frame(), cpia_decode_frame(), dds_decode(), decode_frame(), decode_idat_chunk(), decode_nal_units(), decode_postinit(), decode_slice(), decode_video(), dirac_decode_data_unit(), dnxhd_decode_frame(), dnxhd_encode_init(), do_video_out(), dvvideo_decode_frame(), dvvideo_encode_frame(), dxv_decode(), encode_frame(), encode_init(), encode_init_ls(), encode_picture(), ff_h263_decode_frame(), ff_mjpeg_decode_sof(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_snow_frame_start(), ff_tlog_ref(), ff_vp56_decode_mbs(), fic_decode_block(), fic_decode_frame(), filter_frame(), flashsv_encode_frame(), frame_copy_props(), frame_start(), g2m_decode_frame(), get_frame_defaults(), gif_decode_frame(), gif_encode_init(), h261_decode_frame(), h264_decode_frame(), h264_frame_start(), hap_decode(), hevc_frame_start(), hnm_decode_frame(), hq_hqa_decode_frame(), hqx_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(), output_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(), raw_decode(), request_frame(), rscc_decode_frame(), screenpresso_decode_frame(), select_frame(), show_frame(), storeframe(), svq1_encode_frame(), svq3_decode_frame(), targa_encode_init(), tdsc_decode_frame(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), utvideo_encode_frame(), v308_decode_frame(), v408_decode_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(), y216_decode_frame(), y41p_decode_frame(), yuv4_decode_frame(), zero12v_decode_frame(), and zerocodec_decode_frame().

enum AVPictureType AVFrame::pict_type

Picture type of the frame.

Examples:
transcoding.c.

Definition at line 254 of file frame.h.

Referenced by aic_decode_frame(), avs_decode_frame(), avui_decode_frame(), bfi_decode_frame(), bmp_decode_frame(), bmp_encode_frame(), cavs_decode_frame(), cdxl_decode_frame(), cllc_decode_frame(), cmv_decode_frame(), cpia_decode_frame(), dds_decode(), decode_frame(), decode_idat_chunk(), decode_mb_i(), decode_pic(), decode_postinit(), decode_slice_header(), decode_video(), dirac_decode_data_unit(), dnxhd_decode_frame(), dnxhd_encode_init(), do_video_out(), dvvideo_decode_frame(), dvvideo_encode_frame(), dxv_decode(), 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_execute_ref_pic_marking(), ff_mjpeg_decode_sof(), ff_mpeg4_encode_mb(), ff_mpv_encode_picture(), ff_mpv_frame_start(), ff_print_debug_info2(), ff_tlog_ref(), ff_vc1_parse_frame_header_adv(), ff_vp56_decode_mbs(), fic_decode_block(), fic_decode_frame(), filter_encode_write_frame(), filter_frame(), flashsv_encode_frame(), frame_copy_props(), frame_start(), g2m_decode_frame(), gif_decode_frame(), gif_encode_init(), h261_decode_frame(), hap_decode(), hevc_frame_start(), hnm_decode_frame(), hq_hqa_decode_frame(), hqx_decode_frame(), is_intra_more_likely(), jpeg2000_decode_frame(), libx265_encode_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(), pp_filter_frame(), process_output_surface(), ptx_decode_frame(), qtrle_encode_frame(), queue_picture(), ratecontrol_1pass(), raw_decode(), raw_encode_init(), request_frame(), rscc_decode_frame(), rv10_decode_packet(), screenpresso_decode_frame(), select_frame(), select_input_picture(), set_mv_intra(), show_frame(), storeframe(), sunrast_decode_frame(), svq1_decode_frame(), svq1_decode_frame_header(), svq1_encode_frame(), svq3_decode_frame(), targa_encode_init(), tdsc_decode_frame(), tgq_decode_frame(), tgv_decode_frame(), tmv_decode_frame(), txd_decode_frame(), utvideo_encode_frame(), v308_decode_frame(), v408_decode_frame(), v410_decode_frame(), v410_encode_frame(), vaapi_mpeg4_start_frame(), vble_decode_frame(), vc1_decode_frame(), vcr1_decode_frame(), vp8_encode(), vp8_lossless_decode_frame(), vp9_decode_frame(), X264_frame(), XAVS_frame(), xbm_decode_frame(), xvid_encode_frame(), xwd_decode_frame(), xwd_encode_frame(), y216_decode_frame(), y41p_decode_frame(), yuv4_decode_frame(), zero12v_decode_frame(), and zerocodec_decode_frame().

AVRational AVFrame::sample_aspect_ratio
int64_t AVFrame::pts

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

Examples:
decoding_encoding.c, demuxing_decoding.c, filter_audio.c, filtering_video.c, muxing.c, transcode_aac.c, and transcoding.c.

Definition at line 264 of file frame.h.

Referenced by a64multi_encode_frame(), alloc_out_frame(), amr_wb_encode_frame(), audio_thread(), av_buffersink_get_samples(), av_write_uncoded_frame_internal(), avcodec_encode_audio2(), avcodec_encode_video2(), buffer_offset(), compand_delay(), compand_drain(), create_subcc_packet(), decode_audio(), decode_packet(), decode_video(), decoder_decode_frame(), DEFINE_BLEND8(), describe_frame_to_str(), display_frame(), do_audio_out(), do_blend(), do_qsv_decode(), do_video_out(), draw_text(), encode_apng(), encode_audio_frame(), encode_frame(), encode_superframe(), ff_af_queue_add(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_mpv_encode_picture(), ff_rate_estimate_qscale(), ff_tlog_ref(), filter(), filter_frame(), flac_encode_frame(), flush_frame(), frame_copy_props(), framesync_inject_frame(), g722_encode_frame(), geq_filter_frame(), get_best_frame(), get_frame_defaults(), get_input(), get_palette_frame(), get_video_frame(), gif_decode_frame(), lavfi_read_packet(), libkvazaar_encode(), libschroedinger_encode_frame(), libwebp_anim_encode_frame(), libx265_encode_frame(), load_input_picture(), main(), movie_push_frame(), MPA_encode_frame(), mpeg4_encode_gop_header(), nvenc_encode_frame(), output_frame(), output_single_frame(), plot_cqt(), plot_freqs(), plot_spectrum_column(), process_frame(), process_work_frame(), push_frame(), push_samples(), read_from_fifo(), reap_filters(), request_frame(), return_audio_frame(), return_frame(), roq_dpcm_encode_frame(), scale_vaapi_filter_frame(), select_frame(), send_silence(), set_frame_distances(), set_srce_frame_dest_pts(), set_work_frame_pts(), source_request_frame(), storeframe(), sub2video_push_ref(), submit_frame(), svc_encode_frame(), try_push_frame(), tta_encode_frame(), twolame_encode_frame(), update(), update_context(), video_encode_example(), video_thread(), vorbis_encode_frame(), vp8_encode(), vtenc_frame(), vtenc_send_frame(), wavpack_encode_frame(), write_audio_frame(), X264_frame(), and XAVS_frame().

int64_t AVFrame::pkt_pts
int64_t AVFrame::pkt_dts

DTS copied from the AVPacket that triggered returning this frame.

(if frame threading isn't used) This is also the Presentation time of this AVFrame calculated from only AVPacket.dts values without pts values.

Definition at line 276 of file frame.h.

Referenced by avcodec_decode_audio4(), avcodec_decode_video2(), decoder_decode_frame(), ff_thread_decode_frame(), ffmal_copy_frame(), frame_copy_props(), get_frame_defaults(), gif_decode_frame(), show_frame(), and video_decode_example().

int AVFrame::coded_picture_number
int AVFrame::display_picture_number
int AVFrame::quality
void* AVFrame::opaque

for some private data of the user

Definition at line 295 of file frame.h.

Referenced by ff_print_debug_info2(), and frame_copy_props().

attribute_deprecated uint64_t AVFrame::error[AV_NUM_DATA_POINTERS]
Deprecated:
unused

Definition at line 302 of file frame.h.

Referenced by do_swap(), encode_frame(), frame_copy_props(), frame_end(), and storeframe().

int AVFrame::repeat_pict

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

extra_delay = repeat_pict / (2*fps)

Definition at line 309 of file frame.h.

Referenced by decode_postinit(), do_qsv_decode(), filter_frame(), frame_copy_props(), mpeg_field_start(), show_frame(), submit_frame(), and vc1_decode_frame().

int AVFrame::interlaced_frame
int AVFrame::top_field_first
int AVFrame::palette_has_changed
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 335 of file frame.h.

Referenced by ff_init_buffer_info(), and frame_copy_props().

int AVFrame::sample_rate
uint64_t AVFrame::channel_layout

AVBuffer references backing the data for this frame.

If all elements of this array are NULL, then this frame is not reference counted. This array must be filled contiguously – if buf[i] is non-NULL then buf[j] must also be non-NULL for all j < i.

There may be at most one AVBuffer per data plane, so for video this array always contains all the references. For planar audio with more than AV_NUM_DATA_POINTERS channels, there may be more buffers than can fit in this array. Then the extra AVBufferRef pointers are stored in the extended_buf array.

Examples:
qsvdec.c.

Definition at line 359 of file frame.h.

Referenced by alloc_frame(), audio_get_buffer(), av_buffersrc_add_frame_internal(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_make_writable(), av_frame_ref(), av_frame_unref(), av_hwframe_transfer_data(), avcodec_receive_frame(), avcodec_send_packet(), common_uninit(), cuda_get_buffer(), decode_frame_header(), decode_nal_units(), do_decode(), do_swap(), dxva2_get_buffer(), ff_alloc_picture(), ff_h264_decode_ref_pic_list_reordering(), ff_h264_decode_slice_header(), ff_h264_ref_picture(), ff_h264_remove_all_refs(), 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(), ff_tlog_ref(), ff_video_frame_pool_get(), ff_videotoolbox_alloc_frame(), ff_videotoolbox_buffer_create(), ffmmal_set_ref(), fill_picture_parameters(), find_ref_idx(), frame_needs_copy(), frame_start(), frame_worker_thread(), generate_missing_ref(), get_audio_buffer(), get_buffer(), get_buffer2(), get_video_buffer(), h264_decode_frame(), h264_initialise_ref_list(), hevc_decode_frame(), hevc_update_thread_context(), load_input_picture(), pic_is_unused(), qsv_get_buffer(), raw_decode(), release_unused_pictures(), try_push_frame(), vaapi_get_buffer(), vaapi_map_frame(), vda_old_h264_end_frame(), vdadec_decode(), vdpau_get_buffer(), video_get_buffer(), vp9_decode_frame(), and vp9_decode_free().

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 373 of file frame.h.

Referenced by audio_get_buffer(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_ref(), av_frame_unref(), get_audio_buffer(), and try_push_frame().

int AVFrame::nb_extended_buf

Number of elements in extended_buf.

Definition at line 377 of file frame.h.

Referenced by audio_get_buffer(), av_frame_get_plane_buffer(), av_frame_is_writable(), av_frame_ref(), av_frame_unref(), get_audio_buffer(), and try_push_frame().

AVFrameSideData** AVFrame::side_data
int AVFrame::nb_side_data
int AVFrame::flags

Frame flags, a combination of AV_FRAME_FLAGS.

Definition at line 400 of file frame.h.

Referenced by check_decode_result(), frame_copy_props(), and h264_decode_frame().

enum AVColorRange AVFrame::color_range

MPEG vs JPEG YUV range.

It must be accessed using av_frame_get_color_range() and av_frame_set_color_range().

  • encoding: Set by user
  • decoding: Set by libavcodec

Definition at line 409 of file frame.h.

Referenced by create_filtergraph(), filter_frame(), frame_copy_props(), and get_frame_defaults().

enum AVColorPrimaries AVFrame::color_primaries
enum AVColorTransferCharacteristic AVFrame::color_trc
enum AVColorSpace AVFrame::colorspace

YUV colorspace type.

It must be accessed using av_frame_get_colorspace() and av_frame_set_colorspace().

  • encoding: Set by user
  • decoding: Set by libavcodec

Definition at line 422 of file frame.h.

Referenced by create_filtergraph(), filter_frame(), frame_copy_props(), get_frame_defaults(), and scale_vaapi_filter_frame().

enum AVChromaLocation AVFrame::chroma_location

Definition at line 424 of file frame.h.

Referenced by ff_init_buffer_info(), frame_copy_props(), and get_frame_defaults().

AVBufferRef* AVFrame::hw_frames_ctx

For hwaccel-format frames, this should be a reference to the AVHWFramesContext describing the frame.

Definition at line 430 of file frame.h.

Referenced by av_frame_ref(), av_frame_unref(), av_hwframe_get_buffer(), av_hwframe_transfer_data(), hwdownload_filter_frame(), nppscale_deinterleave(), nppscale_interleave(), nppscale_scale(), and transfer_data_alloc().

int64_t AVFrame::best_effort_timestamp

frame timestamp estimated using various heuristics, in stream time base Code outside libavutil should access this field using: av_frame_get_best_effort_timestamp(frame)

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

Definition at line 439 of file frame.h.

Referenced by frame_copy_props().

int64_t AVFrame::pkt_pos

reordered pos from the last AVPacket that has been input into the decoder Code outside libavutil should access this field using: av_frame_get_pkt_pos(frame)

  • encoding: unused
  • decoding: Read by user.

Definition at line 448 of file frame.h.

Referenced by frame_copy_props().

int64_t AVFrame::pkt_duration

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

Code outside libavutil should access this field using: av_frame_get_pkt_duration(frame)

  • encoding: unused
  • decoding: Read by user.

Definition at line 458 of file frame.h.

Referenced by frame_copy_props().

AVDictionary* AVFrame::metadata

metadata.

Code outside libavutil should access this field using: av_frame_get_metadata(frame)

  • encoding: Set by user.
  • decoding: Set by libavcodec.

Definition at line 467 of file frame.h.

Referenced by av_frame_unref(), avpriv_frame_get_metadatap(), filter_frame(), frame_copy_props(), get_metadata_val(), output_frame(), set_colorquant_ratio_meta(), and update().

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.

Code outside libavutil should access this field using: av_frame_get_decode_error_flags(frame)

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

Definition at line 478 of file frame.h.

Referenced by frame_copy_props().

int AVFrame::channels

number of audio channels, only used for audio.

Code outside libavutil should access this field using: av_frame_get_channels(frame)

  • encoding: unused
  • decoding: Read by user.

Definition at line 489 of file frame.h.

Referenced by av_frame_get_buffer(), av_frame_get_plane_buffer(), av_frame_make_writable(), av_frame_ref(), filter_frame(), frame_copy_audio(), and get_audio_buffer().

int AVFrame::pkt_size

size of the corresponding packet containing the compressed frame.

It must be accessed using av_frame_get_pkt_size() and av_frame_set_pkt_size(). It is set to a negative value if unknown.

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

Definition at line 499 of file frame.h.

Referenced by frame_copy_props().

attribute_deprecated int8_t* AVFrame::qscale_table

QP table Not to be accessed directly from outside libavutil.

Definition at line 507 of file frame.h.

Referenced by av_frame_set_qp_table(), and frame_copy_props().

attribute_deprecated int AVFrame::qstride

QP store stride Not to be accessed directly from outside libavutil.

Definition at line 513 of file frame.h.

Referenced by av_frame_get_qp_table(), av_frame_set_qp_table(), and frame_copy_props().

attribute_deprecated int AVFrame::qscale_type

Definition at line 516 of file frame.h.

Referenced by av_frame_get_qp_table(), av_frame_set_qp_table(), and frame_copy_props().

AVBufferRef* AVFrame::qp_table_buf

Not to be accessed directly from outside libavutil.

Definition at line 521 of file frame.h.

Referenced by av_frame_get_qp_table(), av_frame_set_qp_table(), av_frame_unref(), and frame_copy_props().


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